Fix bug when more than one readline instance is used
PATCH 1/1 Fix bug when more than one readline instance is used
The following error was emitted if one issued the command
git send-email --compose 0001-my.patch
Can't locate object method "IN" via package "FakeTerm" at /home/wesleys/libexec/git-core/git-send-email line 997.
After added a warn in the relevant function that created the term it was obvious what happened:
Only one Term::ReadLine::Gnu instance is allowed. at /home/wesleys/libexec/git-core/git-send-email line 981.
When you supply no --to send-email asks you to whom you want to send the email to. This starts a term, the first Term::ReadLine::Gnu instance. The second time it wants to ask the user 'Send this email? ([y]es|[n]o|[e]dit|[q]uit|[a]ll):' and this causes FakeTerm to be loaded, but it doesn't have IN/OUT methods and thus fails.
The fix is to make $term global. If git chooses to drop perl 5.8 support and allows Perl 5.10, we could also use the state feature. Which would solve the problem without making $term global.
More or less the same logic happens in git-svn.perl so I fixed it there as well.
--- git-send-email.perl | 4 +++- git-svn.perl | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-)
git-send-email.perl +3 -1
@@ -971,8 +971,10 @@ sub get_patch_subject { do_edit(@files); } +my $term; sub term { - my $term = eval { + return $term if $term; + $term = eval { require Term::ReadLine; $ENV{"GIT_SEND_EMAIL_NOTTY"} ? Term::ReadLine->new('git-send-email', \*STDIN, \*STDOUT)
git-svn.perl +2 -0
@@ -306,10 +306,12 @@ sub readline { my $self = shift; die "Cannot use readline on FakeTerm: $$self"; } + package main; my $term; sub term_init { + return $term if $term; $term = eval { require Term::ReadLine; $ENV{"GIT_SVN_NOTTY"}
Signature · 1 line
2.42.0.rc0.26.ga73c38ecaa
Quoted 4 lines · Wesley Schwengle
The following error was emitted if one issued the command
git send-email --compose 0001-my.patch
Quoted 8 lines
Can't locate object method "IN" via package "FakeTerm" at
/home/wesleys/libexec/git-core/git-send-emailline 997.After added a warn in the relevant function that created the term it was obvious what happened:
Only one
Term::ReadLine::Gnuinstance is allowed. at/home/wesleys/libexec/git-core/git-send-emailline 981.
I posted a similar fix yesterday, which is currently in 'next' via d42e4ca9f8:
https://lore.kernel.org/git/[email protected]/
However...
Quoted 2 lines
More or less the same logic happens in git-svn.perl so I fixed it there as well.
...I didn't touch git-svn.perl, and I agree it probably has the same problem (I didn't try it in practice, but any time ask() is called twice it will run into the same issue).
Do you want to prepare a patch on top removing the git-svn bits (probably all of FakeTerm, too)?
-Peff
PATCH v2 1/1 ] Fix bug when more than one readline instance is used
A followup[^1] for git-svn.perl on d42e4ca9f8 where this bug was solved for git-send-email.perl
[^1]: https://lore.kernel.org/git/[email protected]/T/#t
--- git-svn.perl | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-)
git-svn.perl +9 -18
@@ -297,27 +297,18 @@ sub _req_svn { {} ], ); -package FakeTerm; -sub new { - my ($class, $reason) = @_; - return bless \$reason, shift; -} -sub readline { - my $self = shift; - die "Cannot use readline on FakeTerm: $$self"; -} package main; -my $term; -sub term_init { - $term = eval { +{ + my $term; + sub term_init { + return $term if $term; require Term::ReadLine; - $ENV{"GIT_SVN_NOTTY"} - ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT - : new Term::ReadLine 'git-svn'; - }; - if ($@) { - $term = new FakeTerm "$@: going non-interactive"; + $term = $ENV{"GIT_SVN_NOTTY"} + ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT + : new Term::ReadLine 'git-svn'; + }; + return $term; } }
Signature · 1 line
2.42.0.rc0.26.ga73c38ecaa
Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Quoted 1 line · Wesley Schwengle
Subject: Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Thanks. Again, our convention is to make sure that, even only with the title, readers would know what the commit is about. The above does not even hint which part of the system the bug was about. By stealing from what Peff already has done, we can call this
Subject: [PATCH v2] git-svn: avoid creating more than one Term::ReadLine object
to mimic c016726c (send-email: avoid creating more than one Term::ReadLine object, 2023-08-08). Also, please do not double the [brackets] around the "PATCH".
Quoted 4 lines
A followup[^1] for git-svn.perl on
d42e4ca9f8where this bug was solved for git-send-email.perl
Once a commit is in 'next', its commit object name will generally be stable, hence, taken as a whole, something like:
git-svn: avoid creating more than one than one Term::ReadLine object
Newer (v1.46) Term::ReadLine::Gnu would not like us to ask it to create multiple readline instances. c016726c (send-email: avoid creating more than one Term::ReadLine object, 2023-08-08) adjusted git-send-email to this change. Make the same adjustment to git-svn.
While at it, drop the same FakeTerm hack, just like dfd46bae (send-email: drop FakeTerm hack, 2023-08-08) did, for exactly the same reason.
I'll queue the patch with the above commit log message for tonight, so unless you have improvements over it, there is no need to resend.
Thanks.
Quoted 45 lines
Signed-off-by Wesley Schwengle <[email protected]>--- git-svn.perl | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-)git-svn.perl +9
-18@@ -297,27 +297,18 @@ sub _req_svn { {} ], ); -package FakeTerm; -sub new { - my ($class, $reason) = @_; - return bless \$reason, shift; -} -sub readline { - my $self = shift; - die "Cannot use readline on FakeTerm: $$self"; -} package main; -my $term; -sub term_init { - $term = eval { +{ + my $term; + sub term_init { + return $term if $term; require Term::ReadLine; - $ENV{"GIT_SVN_NOTTY"} - ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT - : new Term::ReadLine 'git-svn'; - }; - if ($@) { - $term = new FakeTerm "$@: going non-interactive"; + $term = $ENV{"GIT_SVN_NOTTY"} + ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT + : new Term::ReadLine 'git-svn'; + }; + return $term; } }
Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Quoted 10 lines · Junio C Hamano
Quoted 1 line · Wesley Schwengle
Subject: Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Thanks. Again, our convention is to make sure that, even only with the title, readers would know what the commit is about. The above does not even hint which part of the system the bug was about. By stealing from what Peff already has done, we can call this
Subject: [PATCH v2] git-svn: avoid creating more than one
Term::ReadLineobject
Ok. I'll keep that in mind for next time.
Quoted 11 lines
Once a commit is in 'next', its commit object name will generally be stable, hence, taken as a whole, something like:
git-svn: avoid creating more than one than one
Term::ReadLineobjectNewer (v1.46)
Term::ReadLine::Gnuwould not like us to ask it to create multiple readline instances.c016726c(send-email: avoid creating more than oneTerm::ReadLineobject, 2023-08-08) adjusted git-send-email to this change. Make the same adjustment to git-svn.
Quoted 6 lines
While at it, drop the same FakeTerm hack, just like
dfd46bae(send-email: drop FakeTerm hack, 2023-08-08) did, for exactly the same reason.I'll queue the patch with the above commit log message for tonight, so unless you have improvements over it, there is no need to resend.
Thank you for your patience and accepting the patch(es).
Cheers,
Wesley
Signature · 3 lines
Wesley Why not both?
Re: [[PATCH v2]] Fix bug when more than one readline instance is used
In reply to Wesley Schwenglegit-svn.perl
Quoted 11 lines · Wesley Schwengle
git-svn.perl +4
-2- if ($@) { - $term = new FakeTerm "$@: going non-interactive"; + $term = $ENV{"GIT_SVN_NOTTY"} + ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT + : new Term::ReadLine 'git-svn'; + };
This line with "};" on it should not be added, I think.
cf. https://github.com/git/git/actions/runs/5827208598/job/15802787783#step:5:74
git-svn.perl
Quoted 3 lines
git-svn.perl +1
-0+ return $term; } }
git-svn.perl | 1 - 1 file changed, 1 deletion(-)
git-svn.perl +0 -1
@@ -307,7 +307,6 @@ package main; $term = $ENV{"GIT_SVN_NOTTY"} ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT : new Term::ReadLine 'git-svn'; - }; return $term; } }
Signature · 1 line
2.42.0-rc1
Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Quoted 18 lines · Junio C Hamano
Wesley Schwengle <[email protected]> writes:
This line with "};" on it should not be added, I think.
cf. https://github.com/git/git/actions/runs/5827208598/job/15802787783#step:5:74
Review
Quoted 3 lines
(quoted diff) +1
-0+ return $term; } }git-svn.perl | 1 - 1 file changed, 1 deletion(-)git-svn.perl +0
-0
git-svn.perl package main; · line 312
Quoted 7 lines
git-svn.perl +0
-1@@ -307,7 +307,6 @@ package main; $term = $ENV{"GIT_SVN_NOTTY"} ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT : new Term::ReadLine 'git-svn'; - }; return $term; } }
You are 100% correct.
Cheers,
Wesley
Signature · 3 lines
Wesley Why not both?
Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Quoted 16 lines · Wesley
Quoted 15 lines · Junio C Hamano
Wesley Schwengle <[email protected]> writes:
This line with "};" on it should not be added, I think.
cf. https://github.com/git/git/actions/runs/5827208598/job/15802787783#step:5:74Review
Quoted 3 lines
(quoted diff) +1
-0+ return $term; } }git-svn.perl | 1 - 1 file changed, 1 deletion(-)git-svn.perl +0
-0@@ -307,7 +307,6 @@ package main; $term = $ENV{"GIT_SVN_NOTTY"}
Quoted 8 lines
git-svn.perl package main; · line 312
Quoted 6 lines
git-svn.perl +0
-1? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT : new Term::ReadLine 'git-svn'; - }; return $term; } }You are 100% correct.
And embarrassingly, the above is not sufficient, as the way $term is used in git-send-email and git-svn are subtly different.
I think we further need something like this on top, but my Perl is rusty.
git-svn.perl +1 -1
@@ -427,7 +427,7 @@ sub ask { my $default = $arg{default}; my $resp; my $i = 0; - term_init() unless $term; + my $term = term_init(); if ( !( defined($term->IN) && defined( fileno($term->IN) )
Signature · 1 line
2.42.0-rc1
Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Quoted 11 lines · Junio C Hamano
And embarrassingly, the above is not sufficient, as the way $term is used in git-send-email and git-svn are subtly different.
I think we further need something like this on top, but my Perl is rusty.
git-svn.perl +0
-0
git-svn.perl sub ask { · line 433
Quoted 8 lines
git-svn.perl +1
-1@@ -427,7 +427,7 @@ sub ask { my $default = $arg{default}; my $resp; my $i = 0; - term_init() unless $term; + my $term = term_init(); if ( !( defined($term->IN) && defined( fileno($term->IN) )
Hmm. Isn't that an indication that git-svn is OK as-is?
Looking at the version of git-svn.perl on the tip of master, I see we declare a global $term along with the initializer:
my $term;
sub term_init {
$term = eval { ...etc... }And then later in ask we call term_init() only if it's uninitialized:
sub ask {
...
term_init() unless $term;So those are looking at the same $term, and the result should only be initialized once.
It could still benefit from cleaning up FakeTerm, since we lazily init the object since 30d45f798d (git-svn: delay term initialization, 2014-09-14). But I don't think there's a visible bug here with the new version of Term::ReadLine::Gnu.
-Peff
Re: [[PATCH v2]] Fix bug when more than one readline instance is used
Quoted 11 lines · Jeff King
Quoted 11 lines
git-svn.perl +1
-1@@ -427,7 +427,7 @@ sub ask { my $default = $arg{default}; my $resp; my $i = 0; - term_init() unless $term; + my $term = term_init();
Quoted 4 lines
git-svn.perl sub ask { · line 433
Quoted 2 lines
git-svn.perl +0
-0if ( !( defined($term->IN) && defined( fileno($term->IN) )Hmm. Isn't that an indication that git-svn is OK as-is?
Yes. As long as we know they share the same kind of code structure to use the same library function that wants its callers to stick to a singleton instance, there is a value in using the same structure on the side of our callers, but yes, we can rely on the global $term for it being a singleton.
Quoted 4 lines
It could still benefit from cleaning up FakeTerm, since we lazily init the object since
30d45f798d(git-svn: delay term initialization, 2014-09-14). But I don't think there's a visible bug here with the new version ofTerm::ReadLine::Gnu.
True. Let me drop the patch from the 'next down to master fast-track' candidate status.
Thanks.
PATCH 1/1 git-svn: drop FakeTerm hack
Quoted 9 lines · Junio C Hamano
Jeff King <[email protected]> writes:
...Quoted 4 lines
It could still benefit from cleaning up FakeTerm, since we lazily init the object since
30d45f798d(git-svn: delay term initialization, 2014-09-14). But I don't think there's a visible bug here with the new version ofTerm::ReadLine::Gnu.True. Let me drop the patch from the 'next down to master fast-track' candidate status.
We did the above but then everybody seems to have forgotten about it. Let's resurrect the topic. Here is my attempt.
---- >8 ----
From: Wesley Schwengle <[email protected]>
Subject: [PATCH] git-svn: drop FakeTerm hack
Drop the FakeTerm hack, just like dfd46bae (send-email: drop FakeTerm hack, 2023-08-08) did, for exactly the same reason.
--- git-svn.perl | 20 ++------------------ 1 file changed, 2 insertions(+), 18 deletions(-)
git-svn.perl +2 -18
@@ -297,28 +297,12 @@ sub _req_svn { {} ], ); -package FakeTerm; -sub new { - my ($class, $reason) = @_; - return bless \$reason, shift; -} -sub readline { - my $self = shift; - die "Cannot use readline on FakeTerm: $$self"; -} -package main; - my $term; sub term_init { - $term = eval { - require Term::ReadLine; - $ENV{"GIT_SVN_NOTTY"} + require Term::ReadLine; + $term = $ENV{"GIT_SVN_NOTTY"} ? new Term::ReadLine 'git-svn', \*STDIN, \*STDOUT : new Term::ReadLine 'git-svn'; - }; - if ($@) { - $term = new FakeTerm "$@: going non-interactive"; - } } my $cmd;
Re: [PATCH] git-svn: drop FakeTerm hack
Quoted 6 lines · Junio C Hamano
Quoted 2 lines
True. Let me drop the patch from the 'next down to master fast-track' candidate status.
We did the above but then everybody seems to have forgotten about it. Let's resurrect the topic. Here is my attempt.
Quoted 6 lines
---- >8 ----
From: Wesley Schwengle <[email protected]>
Subject: [PATCH] git-svn: drop FakeTerm hackDrop the FakeTerm hack, just like
dfd46bae(send-email: drop FakeTerm hack, 2023-08-08) did, for exactly the same reason.
Yep, it looks good to me.
Optionally you could add this to the commit message:
It has been obsolete in git-svn since 30d45f798d (git-svn: delay term initialization, 2014-09-14). Note that unlike send-email, we already make sure to load Term::ReadLine only once. So this is just a cleanup, and not fixing any bug.
-Peff
Re: [PATCH] git-svn: drop FakeTerm hack
Quoted 6 lines · Jeff King
Optionally you could add this to the commit message:
It has been obsolete in git-svn since
30d45f798d(git-svn: delay term initialization, 2014-09-14). Note that unlike send-email, we already make sure to loadTerm::ReadLineonly once. So this is just a cleanup, and not fixing any bug.
Thanks. That reads extremely well.
Wesley Schwengle <[email protected]> writes:
If I recall correctly, this was fixed by Peff yesterday?
https://lore.kernel.org/git/[email protected]/
Quoted 6 lines
git-send-email.perl +0
-0@@ -971,8 +971,10 @@ sub get_patch_subject { do_edit(@files);
git-send-email.perl sub get_patch_subject { · line 980
Quoted 10 lines
git-send-email.perl +3
-1} +my $term; sub term { - my $term = eval { + return $term if $term; + $term = eval { require Term::ReadLine; $ENV{"GIT_SEND_EMAIL_NOTTY"} ? Term::ReadLine->new('git-send-email', \*STDIN, \*STDOUT)
The patch I queued yesterday wraps this lexical inside another block to hide it from the outside, but otherwise it should achieve the same goal.