annotate .git/hooks/fsmonitor-watchman.sample @ 863:5a34330bc850

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Tue, 02 Apr 2024 12:29:30 +0900
parents 68904fdaab71
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
781
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
1 #!/usr/bin/perl
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
2
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
3 use strict;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
4 use warnings;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
5 use IPC::Open2;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
6
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
7 # An example hook script to integrate Watchman
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
8 # (https://facebook.github.io/watchman/) with git to speed up detecting
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
9 # new and modified files.
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
10 #
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
11 # The hook is passed a version (currently 1) and a time in nanoseconds
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
12 # formatted as a string and outputs to stdout all files that have been
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
13 # modified since the given time. Paths must be relative to the root of
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
14 # the working tree and separated by a single NUL.
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
15 #
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
16 # To enable this hook, rename this file to "query-watchman" and set
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
17 # 'git config core.fsmonitor .git/hooks/query-watchman'
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
18 #
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
19 my ($version, $time) = @ARGV;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
20
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
21 # Check the hook interface version
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
22
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
23 if ($version == 1) {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
24 # convert nanoseconds to seconds
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
25 $time = int $time / 1000000000;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
26 } else {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
27 die "Unsupported query-fsmonitor hook version '$version'.\n" .
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
28 "Falling back to scanning...\n";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
29 }
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
30
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
31 my $git_work_tree;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
32 if ($^O =~ 'msys' || $^O =~ 'cygwin') {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
33 $git_work_tree = Win32::GetCwd();
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
34 $git_work_tree =~ tr/\\/\//;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
35 } else {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
36 require Cwd;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
37 $git_work_tree = Cwd::cwd();
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
38 }
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
39
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
40 my $retry = 1;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
41
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
42 launch_watchman();
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
43
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
44 sub launch_watchman {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
45
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
46 my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
47 or die "open2() failed: $!\n" .
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
48 "Falling back to scanning...\n";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
49
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
50 # In the query expression below we're asking for names of files that
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
51 # changed since $time but were not transient (ie created after
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
52 # $time but no longer exist).
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
53 #
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
54 # To accomplish this, we're using the "since" generator to use the
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
55 # recency index to select candidate nodes and "fields" to limit the
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
56 # output to file names only. Then we're using the "expression" term to
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
57 # further constrain the results.
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
58 #
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
59 # The category of transient files that we want to ignore will have a
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
60 # creation clock (cclock) newer than $time_t value and will also not
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
61 # currently exist.
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
62
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
63 my $query = <<" END";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
64 ["query", "$git_work_tree", {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
65 "since": $time,
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
66 "fields": ["name"],
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
67 "expression": ["not", ["allof", ["since", $time, "cclock"], ["not", "exists"]]]
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
68 }]
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
69 END
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
70
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
71 print CHLD_IN $query;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
72 close CHLD_IN;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
73 my $response = do {local $/; <CHLD_OUT>};
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
74
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
75 die "Watchman: command returned no output.\n" .
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
76 "Falling back to scanning...\n" if $response eq "";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
77 die "Watchman: command returned invalid output: $response\n" .
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
78 "Falling back to scanning...\n" unless $response =~ /^\{/;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
79
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
80 my $json_pkg;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
81 eval {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
82 require JSON::XS;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
83 $json_pkg = "JSON::XS";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
84 1;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
85 } or do {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
86 require JSON::PP;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
87 $json_pkg = "JSON::PP";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
88 };
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
89
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
90 my $o = $json_pkg->new->utf8->decode($response);
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
91
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
92 if ($retry > 0 and $o->{error} and $o->{error} =~ m/unable to resolve root .* directory (.*) is not watched/) {
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
93 print STDERR "Adding '$git_work_tree' to watchman's watch list.\n";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
94 $retry--;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
95 qx/watchman watch "$git_work_tree"/;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
96 die "Failed to make watchman watch '$git_work_tree'.\n" .
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
97 "Falling back to scanning...\n" if $? != 0;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
98
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
99 # Watchman will always return all files on the first query so
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
100 # return the fast "everything is dirty" flag to git and do the
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
101 # Watchman query just to get it over with now so we won't pay
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
102 # the cost in git to look up each individual file.
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
103 print "/\0";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
104 eval { launch_watchman() };
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
105 exit 0;
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
106 }
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
107
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
108 die "Watchman: $o->{error}.\n" .
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
109 "Falling back to scanning...\n" if $o->{error};
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
110
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
111 binmode STDOUT, ":utf8";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
112 local $, = "\0";
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
113 print @{$o->{files}};
Moririn < Moririn@cr.ie.u-ryukyu.ac.jp>
parents:
diff changeset
114 }