Files
gstack/test/team-init-hook-shell-neutral.test.ts
T
6f1b4cad0f fix(team-init): make the required-mode hook shell-neutral (node CommonJS, no shell variables)
Rewrite of #2217. Required team mode wrote a bash check-gstack.sh and
registered it as "$CLAUDE_PROJECT_DIR/.claude/hooks/check-gstack.sh", which
only works when the hook runner is a POSIX shell. Under cmd.exe or PowerShell
(Windows, Copilot CLI) the variable is not expanded and the .sh cannot run, so
an intended allow or deny became a hook error.

- The hook is now .claude/hooks/check-gstack.cjs: the same root search
  (GSTACK_ROOT, every host's global root, the migrated repo), with the home
  directory from HOME, then USERPROFILE, then os.homedir(). It prints {} when
  gstack resolves and the PreToolUse deny JSON with exit 2 when not.
- The registered command is `node -e "require(require('path').resolve(
  process.env.CLAUDE_PROJECT_DIR || '.', '.claude', 'hooks',
  'check-gstack.cjs'))"`: no `$` or `%`, so sh, cmd.exe and PowerShell all
  pass it through unchanged.
- An existing check-gstack registration (matcher Skill or Skill|skill) is
  replaced in place; duplicates are dropped and unrelated hooks in the same
  entry kept. The legacy .sh is deleted only after the settings write
  succeeds (a tracked one joins the suggested git add), and is kept when bun
  is missing or the write fails, which now reports instead of claiming success.

Tests: team-mode and the hook-schema test run the command as registered;
test/team-init-hook-shell-neutral.test.ts runs it through the platform's
default shell (cmd.exe on the Windows lane, which curates it in) and through
PowerShell when installed (verified here in the pwsh 7 container). The
routing-probe check for the bash `_GSTACK_ROOT` gate now pins the same
contract in the .cjs: every host root probed, block only when none resolves.

Co-authored-by: neallee2012 <1499497+neallee2012@users.noreply.github.com>
Co-authored-by: capy-ai[bot] <230910855+capy-ai[bot]@users.noreply.github.com>
2026-10-08 06:29:09 +00:00

83 lines
4.2 KiB
TypeScript

/**
* Required team mode registers its PreToolUse hook as a command string that
* the hook runner hands to whatever shell it uses: sh on macOS and Linux,
* cmd.exe or PowerShell on Windows and under Copilot CLI. The old
* `"$CLAUDE_PROJECT_DIR/.claude/hooks/check-gstack.sh"` only worked in a POSIX
* shell, so on Windows an intended allow or deny became a hook error (#2217).
*
* This reads the hook source and the registered command straight out of
* bin/gstack-team-init (no bash needed) and runs the command through the
* platform's default shell (`shell: true`: /bin/sh here, cmd.exe on Windows),
* plus PowerShell when one is installed, from a project path with a space.
*/
import { afterAll, describe, expect, test } from 'bun:test';
import { spawnSync } from 'node:child_process';
import * as fs from 'node:fs';
import * as os from 'node:os';
import * as path from 'node:path';
const TEAM_INIT = fs.readFileSync(new URL('../bin/gstack-team-init', import.meta.url), 'utf-8');
const HOOK_START = 'cat > "$HOOKS_DIR/check-gstack.cjs" << \'HOOK_EOF\'\n';
const hookSource = TEAM_INIT.slice(TEAM_INIT.indexOf(HOOK_START) + HOOK_START.length, TEAM_INIT.indexOf('\nHOOK_EOF\n'));
const commandLiteral = TEAM_INIT.match(/^\s*HOOK_COMMAND="((?:[^"\\]|\\.)*)"$/m)?.[1] ?? '';
const command = commandLiteral.replace(/\\(["\\$`])/g, '$1');
const base = fs.mkdtempSync(path.join(os.tmpdir(), 'team-hook-neutral-'));
afterAll(() => fs.rmSync(base, { recursive: true, force: true }));
const project = path.join(base, 'my project');
fs.mkdirSync(path.join(project, '.claude', 'hooks'), { recursive: true });
fs.writeFileSync(path.join(project, '.claude', 'hooks', 'check-gstack.cjs'), hookSource);
const elsewhere = path.join(base, 'elsewhere');
fs.mkdirSync(elsewhere);
function hookEnv(home: Record<string, string>): NodeJS.ProcessEnv {
const env: NodeJS.ProcessEnv = { ...process.env, CLAUDE_PROJECT_DIR: project, ...home };
delete env.GSTACK_ROOT;
if (!('HOME' in home)) delete env.HOME;
return env;
}
type Runner = (env: NodeJS.ProcessEnv) => { status: number | null; stdout: string; stderr: string };
const viaDefaultShell: Runner = (env) => spawnSync(command, { shell: true, cwd: elsewhere, env, encoding: 'utf-8', timeout: 20_000 });
const powershell = process.platform === 'win32' ? 'powershell' : Bun.which('pwsh');
const viaPowerShell: Runner = (env) =>
spawnSync(powershell!, ['-NoProfile', '-NonInteractive', '-Command', command], { cwd: elsewhere, env, encoding: 'utf-8', timeout: 30_000 });
describe('required team hook: shell-neutral registration', () => {
test('the extracted command is a node launcher with no shell variable syntax', () => {
expect(hookSource).toContain("'use strict';");
expect(command).toStartWith('node -e "');
expect(command).toContain('process.env.CLAUDE_PROJECT_DIR');
expect(commandLiteral).not.toContain('$');
expect(command).not.toContain('%');
});
// `powershell -Command` reports a failing native command as exit 1, so only
// the default shell sees the hook's own exit 2; the deny JSON is the same.
for (const [name, runner, enabled, denyStatus] of [
['the default shell', viaDefaultShell, true, 2],
['PowerShell', viaPowerShell, Boolean(powershell), 1],
] as const) {
test.skipIf(!enabled)(`through ${name}: deny with exit 2 when no install resolves, {} when one does`, () => {
const home = path.join(base, `home-${name.replace(/\W+/g, '-')}`);
fs.mkdirSync(home, { recursive: true });
const denied = runner(hookEnv({ HOME: home, USERPROFILE: home }));
expect(denied.status).toBe(denyStatus);
expect(JSON.parse(denied.stdout.trim()).hookSpecificOutput).toMatchObject({ hookEventName: 'PreToolUse', permissionDecision: 'deny' });
expect(denied.stderr).toContain('BLOCKED: gstack is not installed globally.');
fs.mkdirSync(path.join(home, '.claude/skills/gstack/bin'), { recursive: true });
const allowed = runner(hookEnv({ HOME: home, USERPROFILE: home }));
expect(allowed.stderr).toBe('');
expect(allowed.stdout.trim()).toBe('{}');
expect(allowed.status).toBe(0);
const viaProfile = runner(hookEnv({ USERPROFILE: home }));
expect(viaProfile.stdout.trim()).toBe('{}');
expect(viaProfile.status).toBe(0);
});
}
});