Files
gstack/test/codex-web-search-flag.test.ts
T
Garry TanandClaude Fable 5 a9ca914f43 fix(codex): retire deprecated web-search flag behind one CODEX_WEB_SEARCH_FLAG constant (#2525)
codex >=0.144 deprecates the legacy --enable-based web_search_cached
spelling (web search is on by default; --enable <FEATURE> now means
-c features.<name>=true, verified against codex 0.147.0's exec --help).
Every gstack codex invocation now passes -c 'web_search="cached"' instead.

The flag previously lived inline at 19 raw sites. Per ENG-OV11a the 10
template-inline sites (autoplan/SKILL.md.tmpl x4, codex/SKILL.md.tmpl x6)
convert to a shared {{CODEX_WEB_SEARCH_FLAG}} token first, so ONE resolver
constant (CODEX_WEB_SEARCH_FLAG in scripts/resolvers/constants.ts) now
covers all sites: review.ts x5, design.ts x3, the token resolver in
utility.ts, and the tool-map helper comment.

codex/SKILL.md.tmpl's web-search prose guarantee is corrected: the -c form
explicitly overrides a top-level web_search config (the legacy flag yielded
to it), and native codex review disables web search regardless of
configuration, so the flag is a no-op on the default Review path.

test/codex-web-search-flag.test.ts is the safety net: repo-wide grep
tripwires assert NO rendered SKILL.md/section/golden and NO source file
carries the deprecated spelling, and that the token resolves in rendered
output.

Fixes #2525

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-16 10:59:34 -07:00

63 lines
2.5 KiB
TypeScript

/**
* Deprecated codex web-search flag tripwire (#2525).
*
* codex >=0.144 deprecates `--enable web_search_cached` (its `--enable
* <FEATURE>` surface now means `-c features.<name>=true`); the replacement
* is `-c 'web_search="cached"'`, owned by ONE constant:
* CODEX_WEB_SEARCH_FLAG in scripts/resolvers/constants.ts. Resolvers
* interpolate it; templates reference {{CODEX_WEB_SEARCH_FLAG}}.
*
* These tests fail CI if the deprecated spelling re-enters any source
* (resolver, template, helper) or any rendered SKILL.md / section / golden.
*/
import { describe, test, expect } from 'bun:test';
import { execSync } from 'child_process';
import * as fs from 'fs';
import * as path from 'path';
import { CODEX_WEB_SEARCH_FLAG } from '../scripts/resolvers/constants';
const ROOT = path.join(import.meta.dir, '..');
const DEPRECATED = '--enable web_search_cached';
function grepRepo(pattern: string, includes: string[]): string[] {
const includeArgs = includes.map((i) => `--include='${i}'`).join(' ');
const out = execSync(
`grep -rln ${includeArgs} -e '${pattern}' "${ROOT}" || true`,
{ encoding: 'utf-8' },
);
return out
.split('\n')
.filter(Boolean)
.filter((f) => !f.includes('node_modules'))
.filter((f) => !f.endsWith('test/codex-web-search-flag.test.ts'));
}
describe('deprecated codex web-search flag is gone (#2525)', () => {
test('the replacement flag has exactly the documented shape', () => {
expect(CODEX_WEB_SEARCH_FLAG).toBe(`-c 'web_search="cached"'`);
});
test('no rendered SKILL.md or section carries the deprecated flag', () => {
const hits = grepRepo(DEPRECATED, ['SKILL.md', '*.md']);
expect(hits).toEqual([]);
});
test('no source file (resolver, template, helper) carries the deprecated flag', () => {
const hits = grepRepo(DEPRECATED, ['*.ts', '*.tmpl']);
expect(hits).toEqual([]);
});
test('rendered codex skill actually resolves the token to the live flag', () => {
const rendered = fs.readFileSync(path.join(ROOT, 'codex', 'SKILL.md'), 'utf-8');
expect(rendered).toContain(CODEX_WEB_SEARCH_FLAG);
expect(rendered).not.toContain('{{CODEX_WEB_SEARCH_FLAG}}');
});
test('rendered autoplan skill resolves the token at every inline site', () => {
const rendered = fs.readFileSync(path.join(ROOT, 'autoplan', 'SKILL.md'), 'utf-8');
const count = rendered.split(CODEX_WEB_SEARCH_FLAG).length - 1;
expect(count).toBeGreaterThanOrEqual(4);
expect(rendered).not.toContain('{{CODEX_WEB_SEARCH_FLAG}}');
});
});