* [PATCH] fsmonitor: query watchman with right valid json
@ 2022-06-07 7:54 Son Luong Ngoc
2022-06-07 8:40 ` Ævar Arnfjörð Bjarmason
0 siblings, 1 reply; 6+ messages in thread
From: Son Luong Ngoc @ 2022-06-07 7:54 UTC (permalink / raw)
To: git; +Cc: Son Luong Ngoc
In rare circumstances where the current git index does not carry the
last_update_token, the fsmonitor v2 hook will be invoked with an
empty string which would caused the final rendered json to be invalid.
["query", "/path/to/my/git/repository/", {
"since": ,
"fields": ["name"],
"expression": ["not", ["dirname", ".git"]]
}]
Which will left user with the following error message
> git status
failed to parse command from stdin: line 2, column 13, position 67: unexpected token near ','
Watchman: command returned no output.
Falling back to scanning...
Hide the "since" field in json query when "last_update_token" is empty.
Signed-off-by: Son Luong Ngoc <sluongng@gmail.com>
---
templates/hooks--fsmonitor-watchman.sample | 21 +++++++++++++--------
1 file changed, 13 insertions(+), 8 deletions(-)
diff --git a/templates/hooks--fsmonitor-watchman.sample b/templates/hooks--fsmonitor-watchman.sample
index 14ed0aa42d..b4ee86dfc4 100755
--- a/templates/hooks--fsmonitor-watchman.sample
+++ b/templates/hooks--fsmonitor-watchman.sample
@@ -79,6 +79,12 @@ sub watchman_query {
or die "open2() failed: $!\n" .
"Falling back to scanning...\n";
+ my $query = <<" END";
+ ["query", "$git_work_tree", {
+ "fields": ["name"],
+ "expression": ["not", ["dirname", ".git"]]
+ }]
+ END
# In the query expression below we're asking for names of files that
# changed since $last_update_token but not from the .git folder.
#
@@ -87,15 +93,14 @@ sub watchman_query {
# output to file names only. Then we're using the "expression" term to
# further constrain the results.
if (substr($last_update_token, 0, 1) eq "c") {
- $last_update_token = "\"$last_update_token\"";
+ $query = <<" END";
+ ["query", "$git_work_tree", {
+ "since": "$last_update_token",
+ "fields": ["name"],
+ "expression": ["not", ["dirname", ".git"]]
+ }]
+ END
}
- my $query = <<" END";
- ["query", "$git_work_tree", {
- "since": $last_update_token,
- "fields": ["name"],
- "expression": ["not", ["dirname", ".git"]]
- }]
- END
# Uncomment for debugging the watchman query
# open (my $fh, ">", ".git/watchman-query.json");
--
2.36.1.231.g6924ef9a07
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH] fsmonitor: query watchman with right valid json
2022-06-07 7:54 [PATCH] fsmonitor: query watchman with right valid json Son Luong Ngoc
@ 2022-06-07 8:40 ` Ævar Arnfjörð Bjarmason
2022-06-07 10:56 ` Son Luong Ngoc
0 siblings, 1 reply; 6+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2022-06-07 8:40 UTC (permalink / raw)
To: Son Luong Ngoc; +Cc: git
On Tue, Jun 07 2022, Son Luong Ngoc wrote:
> In rare circumstances where the current git index does not carry the
> last_update_token, the fsmonitor v2 hook will be invoked with an
> empty string which would caused the final rendered json to be invalid.
>
> ["query", "/path/to/my/git/repository/", {
> "since": ,
> "fields": ["name"],
> "expression": ["not", ["dirname", ".git"]]
> }]
>
> Which will left user with the following error message
>
> > git status
> failed to parse command from stdin: line 2, column 13, position 67: unexpected token near ','
> Watchman: command returned no output.
> Falling back to scanning...
>
> Hide the "since" field in json query when "last_update_token" is empty.
>
> Signed-off-by: Son Luong Ngoc <sluongng@gmail.com>
> ---
> templates/hooks--fsmonitor-watchman.sample | 21 +++++++++++++--------
> 1 file changed, 13 insertions(+), 8 deletions(-)
>
> diff --git a/templates/hooks--fsmonitor-watchman.sample b/templates/hooks--fsmonitor-watchman.sample
> index 14ed0aa42d..b4ee86dfc4 100755
> --- a/templates/hooks--fsmonitor-watchman.sample
> +++ b/templates/hooks--fsmonitor-watchman.sample
> @@ -79,6 +79,12 @@ sub watchman_query {
> or die "open2() failed: $!\n" .
> "Falling back to scanning...\n";
>
> + my $query = <<" END";
> + ["query", "$git_work_tree", {
> + "fields": ["name"],
> + "expression": ["not", ["dirname", ".git"]]
> + }]
> + END
Wouldn't a more minimal & obvious patch here be....
> # In the query expression below we're asking for names of files that
> # changed since $last_update_token but not from the .git folder.
> #
> @@ -87,15 +93,14 @@ sub watchman_query {
> # output to file names only. Then we're using the "expression" term to
> # further constrain the results.
> if (substr($last_update_token, 0, 1) eq "c") {
> - $last_update_token = "\"$last_update_token\"";
To just change this to be:
# same as now:
$last_update_token = "\"$last_update_token\"";
$last_update_line = qq["since": $last_update_token,];
Of course having declared the new $last_update_line variable earlier, then:
> + $query = <<" END";
> + ["query", "$git_work_tree", {
> + "since": "$last_update_token",
> + "fields": ["name"],
> + "expression": ["not", ["dirname", ".git"]]
> + }]
> + END
> }
> - my $query = <<" END";
> - ["query", "$git_work_tree", {
> - "since": $last_update_token,
Just change this line to:
$last_update_line
I.e. you don't need to duplicate the whole query just to omit/include a
single line in it, or am I missing something?
(This suggestion *would* include a redundant line, but I'm assuming
JSON/watchman deals with that just fine...).
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH] fsmonitor: query watchman with right valid json
2022-06-07 8:40 ` Ævar Arnfjörð Bjarmason
@ 2022-06-07 10:56 ` Son Luong Ngoc
2022-06-07 11:14 ` [PATCH v2] " Son Luong Ngoc
0 siblings, 1 reply; 6+ messages in thread
From: Son Luong Ngoc @ 2022-06-07 10:56 UTC (permalink / raw)
To: Ævar Arnfjörð Bjarmason; +Cc: git
Hi Ævar,
On Tue, Jun 7, 2022 at 10:42 AM Ævar Arnfjörð Bjarmason
<avarab@gmail.com> wrote:
>
>
> On Tue, Jun 07 2022, Son Luong Ngoc wrote:
>
> > In rare circumstances where the current git index does not carry the
> > last_update_token, the fsmonitor v2 hook will be invoked with an
> > empty string which would caused the final rendered json to be invalid.
> >
> > ["query", "/path/to/my/git/repository/", {
> > "since": ,
> > "fields": ["name"],
> > "expression": ["not", ["dirname", ".git"]]
> > }]
> >
> > Which will left user with the following error message
> >
> > > git status
> > failed to parse command from stdin: line 2, column 13, position 67: unexpected token near ','
> > Watchman: command returned no output.
> > Falling back to scanning...
> >
> > Hide the "since" field in json query when "last_update_token" is empty.
> >
> > Signed-off-by: Son Luong Ngoc <sluongng@gmail.com>
> > ---
> > templates/hooks--fsmonitor-watchman.sample | 21 +++++++++++++--------
> > 1 file changed, 13 insertions(+), 8 deletions(-)
> >
> > diff --git a/templates/hooks--fsmonitor-watchman.sample b/templates/hooks--fsmonitor-watchman.sample
> > index 14ed0aa42d..b4ee86dfc4 100755
> > --- a/templates/hooks--fsmonitor-watchman.sample
> > +++ b/templates/hooks--fsmonitor-watchman.sample
> > @@ -79,6 +79,12 @@ sub watchman_query {
> > or die "open2() failed: $!\n" .
> > "Falling back to scanning...\n";
> >
> > + my $query = <<" END";
> > + ["query", "$git_work_tree", {
> > + "fields": ["name"],
> > + "expression": ["not", ["dirname", ".git"]]
> > + }]
> > + END
>
> Wouldn't a more minimal & obvious patch here be....
>
> > # In the query expression below we're asking for names of files that
> > # changed since $last_update_token but not from the .git folder.
> > #
> > @@ -87,15 +93,14 @@ sub watchman_query {
> > # output to file names only. Then we're using the "expression" term to
> > # further constrain the results.
> > if (substr($last_update_token, 0, 1) eq "c") {
> > - $last_update_token = "\"$last_update_token\"";
>
> To just change this to be:
>
> # same as now:
> $last_update_token = "\"$last_update_token\"";
> $last_update_line = qq["since": $last_update_token,];
>
> Of course having declared the new $last_update_line variable earlier, then:
>
Yup, I think this is a sensible suggestion.
I will fixup and send a V2 shortly.
> > + $query = <<" END";
> > + ["query", "$git_work_tree", {
> > + "since": "$last_update_token",
> > + "fields": ["name"],
> > + "expression": ["not", ["dirname", ".git"]]
> > + }]
> > + END
> > }
> > - my $query = <<" END";
> > - ["query", "$git_work_tree", {
> > - "since": $last_update_token,
>
> Just change this line to:
>
> $last_update_line
>
> I.e. you don't need to duplicate the whole query just to omit/include a
> single line in it, or am I missing something?
>
> (This suggestion *would* include a redundant line, but I'm assuming
> JSON/watchman deals with that just fine...).
I think we can remove that redundant line by adding '\n' before
$last_update_line.
I will be including this into the next version.
Thanks,
Son Luong.
^ permalink raw reply [flat|nested] 6+ messages in thread* [PATCH v2] fsmonitor: query watchman with right valid json
2022-06-07 10:56 ` Son Luong Ngoc
@ 2022-06-07 11:14 ` Son Luong Ngoc
2022-06-07 14:39 ` Ævar Arnfjörð Bjarmason
2022-06-07 17:00 ` Junio C Hamano
0 siblings, 2 replies; 6+ messages in thread
From: Son Luong Ngoc @ 2022-06-07 11:14 UTC (permalink / raw)
To: git; +Cc: Son Luong Ngoc, Ævar Arnfjörð Bjarmason
In rare circumstances where the current git index does not carry the
last_update_token, the fsmonitor v2 hook will be invoked with an
empty string which would caused the final rendered json to be invalid.
["query", "/path/to/my/git/repository/", {
"since": ,
"fields": ["name"],
"expression": ["not", ["dirname", ".git"]]
}]
Which will left user with the following error message
> git status
failed to parse command from stdin: line 2, column 13, position 67: unexpected token near ','
Watchman: command returned no output.
Falling back to scanning...
Hide the "since" field in json query when "last_update_token" is empty.
Co-authored-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Son Luong Ngoc <sluongng@gmail.com>
---
templates/hooks--fsmonitor-watchman.sample | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/templates/hooks--fsmonitor-watchman.sample b/templates/hooks--fsmonitor-watchman.sample
index 14ed0aa42d..23e856f5de 100755
--- a/templates/hooks--fsmonitor-watchman.sample
+++ b/templates/hooks--fsmonitor-watchman.sample
@@ -86,12 +86,13 @@ sub watchman_query {
# recency index to select candidate nodes and "fields" to limit the
# output to file names only. Then we're using the "expression" term to
# further constrain the results.
+ my $last_update_line = "";
if (substr($last_update_token, 0, 1) eq "c") {
$last_update_token = "\"$last_update_token\"";
+ $last_update_line = qq[\n"since": $last_update_token,];
}
my $query = <<" END";
- ["query", "$git_work_tree", {
- "since": $last_update_token,
+ ["query", "$git_work_tree", {$last_update_line
"fields": ["name"],
"expression": ["not", ["dirname", ".git"]]
}]
--
2.36.1.476.g0c4daa206d
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH v2] fsmonitor: query watchman with right valid json
2022-06-07 11:14 ` [PATCH v2] " Son Luong Ngoc
@ 2022-06-07 14:39 ` Ævar Arnfjörð Bjarmason
2022-06-07 17:00 ` Junio C Hamano
1 sibling, 0 replies; 6+ messages in thread
From: Ævar Arnfjörð Bjarmason @ 2022-06-07 14:39 UTC (permalink / raw)
To: Son Luong Ngoc; +Cc: git
On Tue, Jun 07 2022, Son Luong Ngoc wrote:
> In rare circumstances where the current git index does not carry the
> last_update_token, the fsmonitor v2 hook will be invoked with an
> empty string which would caused the final rendered json to be invalid.
>
> ["query", "/path/to/my/git/repository/", {
> "since": ,
> "fields": ["name"],
> "expression": ["not", ["dirname", ".git"]]
> }]
>
> Which will left user with the following error message
>
> > git status
> failed to parse command from stdin: line 2, column 13, position 67: unexpected token near ','
> Watchman: command returned no output.
> Falling back to scanning...
>
> Hide the "since" field in json query when "last_update_token" is empty.
>
> Co-authored-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
> Signed-off-by: Son Luong Ngoc <sluongng@gmail.com>
Thanks for the quick turnaround.
> templates/hooks--fsmonitor-watchman.sample | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/templates/hooks--fsmonitor-watchman.sample b/templates/hooks--fsmonitor-watchman.sample
> index 14ed0aa42d..23e856f5de 100755
> --- a/templates/hooks--fsmonitor-watchman.sample
> +++ b/templates/hooks--fsmonitor-watchman.sample
> @@ -86,12 +86,13 @@ sub watchman_query {
> # recency index to select candidate nodes and "fields" to limit the
> # output to file names only. Then we're using the "expression" term to
> # further constrain the results.
> + my $last_update_line = "";
> if (substr($last_update_token, 0, 1) eq "c") {
> $last_update_token = "\"$last_update_token\"";
> + $last_update_line = qq[\n"since": $last_update_token,];
> }
This LGTM, just a note...
> my $query = <<" END";
> - ["query", "$git_work_tree", {
> - "since": $last_update_token,
> + ["query", "$git_work_tree", {$last_update_line
...doesn't really need a re-roll, but doesn't this trade "we don't have
too many \n" for not indenting the query properly anymore?
I think skipping both is fine, but between the two I think having
indenting is better than having a redundant \n some of the time.
FWIW you could just add the variable on its own line, and then do this
instead:
(my $query = <<" END") =~ s/(?<=\n)\t*\n//s;
To post-hoc fix the extra \n in this case :)
But I think this is also fine as-is, thanks!
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH v2] fsmonitor: query watchman with right valid json
2022-06-07 11:14 ` [PATCH v2] " Son Luong Ngoc
2022-06-07 14:39 ` Ævar Arnfjörð Bjarmason
@ 2022-06-07 17:00 ` Junio C Hamano
1 sibling, 0 replies; 6+ messages in thread
From: Junio C Hamano @ 2022-06-07 17:00 UTC (permalink / raw)
To: Son Luong Ngoc; +Cc: git, Ævar Arnfjörð Bjarmason
Son Luong Ngoc <sluongng@gmail.com> writes:
> In rare circumstances where the current git index does not carry the
> last_update_token, the fsmonitor v2 hook will be invoked with an
> empty string which would caused the final rendered json to be invalid.
>
> ["query", "/path/to/my/git/repository/", {
> "since": ,
> "fields": ["name"],
> "expression": ["not", ["dirname", ".git"]]
> }]
>
> Which will left user with the following error message
"left" -> "leave" (or "give")
> > git status
> failed to parse command from stdin: line 2, column 13, position 67: unexpected token near ','
> Watchman: command returned no output.
> Falling back to scanning...
>
> Hide the "since" field in json query when "last_update_token" is empty.
>
> Co-authored-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
It looked more like Helped-by to me, but I dunno.
> Signed-off-by: Son Luong Ngoc <sluongng@gmail.com>
> ---
> templates/hooks--fsmonitor-watchman.sample | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/templates/hooks--fsmonitor-watchman.sample b/templates/hooks--fsmonitor-watchman.sample
> index 14ed0aa42d..23e856f5de 100755
> --- a/templates/hooks--fsmonitor-watchman.sample
> +++ b/templates/hooks--fsmonitor-watchman.sample
> @@ -86,12 +86,13 @@ sub watchman_query {
> # recency index to select candidate nodes and "fields" to limit the
> # output to file names only. Then we're using the "expression" term to
> # further constrain the results.
> + my $last_update_line = "";
> if (substr($last_update_token, 0, 1) eq "c") {
> $last_update_token = "\"$last_update_token\"";
> + $last_update_line = qq[\n"since": $last_update_token,];
> }
> my $query = <<" END";
> - ["query", "$git_work_tree", {
> - "since": $last_update_token,
> + ["query", "$git_work_tree", {$last_update_line
> "fields": ["name"],
> "expression": ["not", ["dirname", ".git"]]
> }]
OK. Compared to v1, this looks much more reasonable.
This is totally unrelated to the "hide invalid since" topic, but I
wonder if $git_work_tree needs a bit more careful quoting. It comes
directly from get_working_dir() but can it contain say a double quote
character, to make the resulting string in the variable $query not
quite well formed?
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2022-06-07 17:00 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-06-07 7:54 [PATCH] fsmonitor: query watchman with right valid json Son Luong Ngoc
2022-06-07 8:40 ` Ævar Arnfjörð Bjarmason
2022-06-07 10:56 ` Son Luong Ngoc
2022-06-07 11:14 ` [PATCH v2] " Son Luong Ngoc
2022-06-07 14:39 ` Ævar Arnfjörð Bjarmason
2022-06-07 17:00 ` Junio C Hamano
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).