GitLabgitlab-org

cli

main
ply8 git calls223 ms98 KiB6 cachedprotocol v2
173 lines4.5 KiBexecutableRaw
1#!/usr/bin/perl
3use strict;
4use warnings;
5use IPC::Open2;
7# An example hook script to integrate Watchman
8# (https://facebook.github.io/watchman/) with git to speed up detecting
9# new and modified files.
11# The hook is passed a version (currently 2) and last update token
12# formatted as a string and outputs to stdout a new update token and
13# all files that have been modified since the update token. Paths must
14# be relative to the root of the working tree and separated by a single NUL.
16# To enable this hook, rename this file to "query-watchman" and set
17# 'git config core.fsmonitor .git/hooks/query-watchman'
19my ($version, $last_update_token) = @ARGV;
21# Uncomment for debugging
22# print STDERR "$0 $version $last_update_token\n";
24# Check the hook interface version
25if ($version ne 2) {
26 die "Unsupported query-fsmonitor hook version '$version'.\n" .
27 "Falling back to scanning...\n";
30my $git_work_tree = get_working_dir();
32my $retry = 1;
34my $json_pkg;
35eval {
36 require JSON::XS;
37 $json_pkg = "JSON::XS";
38 1;
39} or do {
40 require JSON::PP;
41 $json_pkg = "JSON::PP";
42};
44launch_watchman();
46sub launch_watchman {
47 my $o = watchman_query();
48 if (is_work_tree_watched($o)) {
49 output_result($o->{clock}, @{$o->{files}});
50 }
53sub output_result {
54 my ($clockid, @files) = @_;
56 # Uncomment for debugging watchman output
57 # open (my $fh, ">", ".git/watchman-output.out");
58 # binmode $fh, ":utf8";
59 # print $fh "$clockid\n@files\n";
60 # close $fh;
62 binmode STDOUT, ":utf8";
63 print $clockid;
64 print "\0";
65 local $, = "\0";
66 print @files;
69sub watchman_clock {
70 my $response = qx/watchman clock "$git_work_tree"/;
71 die "Failed to get clock id on '$git_work_tree'.\n" .
72 "Falling back to scanning...\n" if $? != 0;
74 return $json_pkg->new->utf8->decode($response);
77sub watchman_query {
78 my $pid = open2(\*CHLD_OUT, \*CHLD_IN, 'watchman -j --no-pretty')
79 or die "open2() failed: $!\n" .
80 "Falling back to scanning...\n";
82 # In the query expression below we're asking for names of files that
83 # changed since $last_update_token but not from the .git folder.
84 #
85 # To accomplish this, we're using the "since" generator to use the
86 # recency index to select candidate nodes and "fields" to limit the
87 # output to file names only. Then we're using the "expression" term to
88 # further constrain the results.
89 if (substr($last_update_token, 0, 1) eq "c") {
90 $last_update_token = "\"$last_update_token\"";
91 }
92 my $query = <<" END";
93 ["query", "$git_work_tree", {
94 "since": $last_update_token,
95 "fields": ["name"],
96 "expression": ["not", ["dirname", ".git"]]
97 }]
98 END
100 # Uncomment for debugging the watchman query
101 # open (my $fh, ">", ".git/watchman-query.json");
102 # print $fh $query;
103 # close $fh;
105 print CHLD_IN $query;
106 close CHLD_IN;
107 my $response = do {local $/; <CHLD_OUT>};
109 # Uncomment for debugging the watch response
110 # open ($fh, ">", ".git/watchman-response.json");
111 # print $fh $response;
112 # close $fh;
114 die "Watchman: command returned no output.\n" .
115 "Falling back to scanning...\n" if $response eq "";
116 die "Watchman: command returned invalid output: $response\n" .
117 "Falling back to scanning...\n" unless $response =~ /^\{/;
119 return $json_pkg->new->utf8->decode($response);
122sub is_work_tree_watched {
123 my ($output) = @_;
124 my $error = $output->{error};
125 if ($retry > 0 and $error and $error =~ m/unable to resolve root .* directory (.*) is not watched/) {
126 $retry--;
127 my $response = qx/watchman watch "$git_work_tree"/;
128 die "Failed to make watchman watch '$git_work_tree'.\n" .
129 "Falling back to scanning...\n" if $? != 0;
130 $output = $json_pkg->new->utf8->decode($response);
131 $error = $output->{error};
132 die "Watchman: $error.\n" .
133 "Falling back to scanning...\n" if $error;
135 # Uncomment for debugging watchman output
136 # open (my $fh, ">", ".git/watchman-output.out");
137 # close $fh;
139 # Watchman will always return all files on the first query so
140 # return the fast "everything is dirty" flag to git and do the
141 # Watchman query just to get it over with now so we won't pay
142 # the cost in git to look up each individual file.
143 my $o = watchman_clock();
144 $error = $output->{error};
146 die "Watchman: $error.\n" .
147 "Falling back to scanning...\n" if $error;
149 output_result($o->{clock}, ("/"));
150 $last_update_token = $o->{clock};
152 eval { launch_watchman() };
153 return 0;
154 }
156 die "Watchman: $error.\n" .
157 "Falling back to scanning...\n" if $error;
159 return 1;
162sub get_working_dir {
163 my $working_dir;
164 if ($^O =~ 'msys' || $^O =~ 'cygwin') {
165 $working_dir = Win32::GetCwd();
166 $working_dir =~ tr/\\/\//;
167 } else {
168 require Cwd;
169 $working_dir = Cwd::cwd();
170 }
172 return $working_dir;
Diagnostics8 git calls · 223 ms
CallStatusSizeTime0223 ms
discover200185 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=185
git.server.agent=git/2.56.g1891de4-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=185
git.pkt.payload.max=35
ls-refs20058 KiB · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=59849
git.response.cache=HIT
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=731
git.pkt.data=730
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=59849
git.pkt.payload.max=143
git.ls_refs.count=730
git.ls_refs.head=refs/heads/main
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=4
git.response.bytes=4273
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=4273
git.pkt.payload.max=4173
git.sideband.band1.bytes=4173
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=11
git.pack.bytes=4173
git.fetch.wide.objects=11
git.fetch.wide.extra_bytes=3930
git.fetch.wide.blobs=0
fetchtree:0 · deepen 1020032 KiB · hit4 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=32926
git.response.cache=HIT
git.response.duration_ms=4
git.fetch.filter=tree:0
git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=22
git.pkt.data=20
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=32926
git.pkt.payload.max=32046
git.sideband.band1.bytes=32046
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=80
git.pack.bytes=32046
git.pack.ofs_delta=36
git.pack.ref_delta=0
git.pack.chain.max=2
git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91
git.pack.full=44
Open pack map
fetchtree:0200269 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=269
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=03418b1543b5ed53722e5f33e3b74e146f53f68d
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=269
git.pkt.payload.max=242
git.sideband.band1.bytes=242
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=242
git.pack.trailer=026c020e1be62d2b2c6d8f3a03f3525b7a86efd1
Open pack map
fetchtree:0200474 B · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=474
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=7c3f97bfb728c74316598d2bbce58b3fb8dd3080
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=474
git.pkt.payload.max=447
git.sideband.band1.bytes=447
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=447
git.pack.trailer=8479fc10eb7e3b4ab926685ee5a551ec5eb00e71
Open pack map
fetchtree:0200459 B · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=459
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=tree:0
git.fetch.wants=2f6bc382bc7a73c9331b843ccc187e6ce8618d73
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=459
git.pkt.payload.max=432
git.sideband.band1.bytes=432
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=1
git.pack.bytes=432
git.pack.trailer=fc2e9690b01682f106088547b32fb83e09704b92
Open pack map
fetch2001.8 KiB211 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=211
git.response.bytes=1859
git.response.cache=MISS
git.response.duration_ms=211
git.fetch.wants=14ed0aa42de0f291c0f696922110e70544c3dae2
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1859
git.pkt.payload.max=1832
git.sideband.band1.bytes=1832
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://gitlab.com/gitlab-org/cli
Ref
refs/heads/main
Commit
0dd7574dce9e385c5c30540e6c15657adc6bdce9
cf-ray
a5e1de544992ecfa
Request
b770e65d…
Protocol
v2 · sha1
Agent
git/2.56.g1891de4-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format