@matheusbsbs / matheus-bagliano / commits / a082345372

hook API: fix v2.36.0 regression: hooks should be connected to a TTY

Fix a regression reported[1] against f443246b9f2 (commit: convert {pre-commit,prepare-commit-msg} hook to hook.h, 2021-12-22): Due to using the run_process_parallel() API in the earlier 96e7225b310 (hook: add 'run' subcommand, 2021-12-22) we'd capture the hook's stderr and stdout, and thus lose the connection to the TTY in the case of e.g. the "pre-commit" hook. As a preceding commit notes GNU parallel's similar --ungroup option also has it emit output faster. While we're unlikely to have hooks that emit truly massive amounts of output (or where the performance thereof matters) it's still informative to measure the overhead. In a similar "seq" test we're now ~30% faster: $ cat .git/hooks/seq-hook; git hyperfine -L rev origin/master,HEAD~0 -s 'make CFLAGS=-O3' './git hook run seq-hook' #!/bin/sh seq 100000000 Benchmark 1: ./git hook run seq-hook' in 'origin/master Time (mean ± σ): 787.1 ms ± 13.6 ms [User: 701.6 ms, System: 534.4 ms] Range (min … max): 773.2 ms … 806.3 ms 10 runs Benchmark 2: ./git hook run seq-hook' in 'HEAD~0 Time (mean ± σ): 603.4 ms ± 1.6 ms [User: 573.1 ms, System: 30.3 ms] Range (min … max): 601.0 ms … 606.2 ms 10 runs Summary './git hook run seq-hook' in 'HEAD~0' ran 1.30 ± 0.02 times faster than './git hook run seq-hook' in 'origin/master' 1. https://lore.kernel.org/git/CA+dzEBn108QoMA28f0nC8K21XT+Afua0V2Qv8XkR8rAeqUCCZw@mail.gmail.com/ Reported-by: Anthony Sottile <asottile@umich.edu> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> [jc: minor fix-up to tests for consistency] Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ævar Arnfjörð Bjarmason committed Jun 7, 2022 at 10:48 UTC a082345372e14ecd30a84a790eda0c38154e4602

2 files changed +32

hook.c

@@ -144,6 +144,7 @@ int run_hooks_opt(const char *hook_name, struct run_hooks_opt *options)

144 cb_data.hook_path = abs_path.buf;

145 }

146

147 + run_processes_parallel_ungroup = 1;

148 run_processes_parallel_tr2(jobs,

149 pick_next_hook,

150 notify_start_failure,

t/t1800-hook.sh

+31

@@ -4,6 +4,7 @@ test_description='git-hook command'

5 TEST_PASSES_SANITIZE_LEAK=true

6 . ./test-lib.sh

7 +. "$TEST_DIRECTORY"/lib-terminal.sh

9 test_expect_success 'git hook usage' '

10 test_expect_code 129 git hook &&

@@ -120,4 +121,34 @@ test_expect_success 'git -c core.hooksPath=<PATH> hook run' '

121 test_cmp expect actual

122 '

123

124 +test_hook_tty () {

125 + cat >expect <<-\EOF

126 + STDOUT TTY

127 + STDERR TTY

128 + EOF

129 +

130 + test_when_finished "rm -rf repo" &&

131 + git init repo &&

132 +

133 + test_commit -C repo A &&

134 + test_commit -C repo B &&

135 + git -C repo reset --soft HEAD^ &&

136 +

137 + test_hook -C repo pre-commit <<-EOF &&

138 + test -t 1 && echo STDOUT TTY >>actual || echo STDOUT NO TTY >>actual &&

139 + test -t 2 && echo STDERR TTY >>actual || echo STDERR NO TTY >>actual

140 + EOF

141 +

142 + test_terminal git -C repo "$@" &&

143 + test_cmp expect repo/actual

144 +}

145 +

146 +test_expect_success TTY 'git hook run: stdout and stderr are connected to a TTY' '

147 + test_hook_tty hook run pre-commit

148 +'

149 +

150 +test_expect_success TTY 'git commit: stdout and stderr are connected to a TTY' '

151 + test_hook_tty commit -m"B.new"

152 +'

153 +

154 test_done