fix(settings): stabilize websearch and quota checks

This commit is contained in:
Tam Nhu Tran
2026-03-25 16:31:55 -04:00
parent a97fc42b10
commit 3ea9d2fc34
5 changed files with 149 additions and 163 deletions
+59 -102
View File
@@ -1,126 +1,83 @@
import { afterEach, beforeEach, describe, expect, it } from 'bun:test';
import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import { getWebSearchReadiness } from '../../../../src/utils/websearch/status';
import { describe, expect, it } from 'bun:test';
import { buildWebSearchReadiness } from '../../../../src/utils/websearch/status';
import type { WebSearchCliInfo } from '../../../../src/utils/websearch/types';
function writeWebSearchConfig(tempRoot: string, lines: string[]): void {
fs.writeFileSync(path.join(tempRoot, '.ccs', 'config.yaml'), lines.join('\n'), 'utf8');
function provider(overrides: Partial<WebSearchCliInfo> & Pick<WebSearchCliInfo, 'id' | 'name'>): WebSearchCliInfo {
return {
id: overrides.id,
kind: overrides.kind ?? 'backend',
name: overrides.name,
enabled: overrides.enabled ?? false,
available: overrides.available ?? false,
version: overrides.version ?? null,
requiresApiKey: overrides.requiresApiKey ?? false,
description: overrides.description ?? '',
detail: overrides.detail ?? '',
...overrides,
};
}
describe('websearch readiness', () => {
const originalCcsHome = process.env.CCS_HOME;
const originalBraveKey = process.env.BRAVE_API_KEY;
const originalExaKey = process.env.EXA_API_KEY;
const originalTavilyKey = process.env.TAVILY_API_KEY;
let tempRoot = '';
beforeEach(() => {
tempRoot = fs.mkdtempSync(path.join(os.tmpdir(), 'ccs-websearch-status-'));
process.env.CCS_HOME = tempRoot;
delete process.env.BRAVE_API_KEY;
delete process.env.EXA_API_KEY;
delete process.env.TAVILY_API_KEY;
fs.mkdirSync(path.join(tempRoot, '.ccs'), { recursive: true });
});
afterEach(() => {
if (originalCcsHome !== undefined) process.env.CCS_HOME = originalCcsHome;
else delete process.env.CCS_HOME;
if (originalBraveKey !== undefined) process.env.BRAVE_API_KEY = originalBraveKey;
else delete process.env.BRAVE_API_KEY;
if (originalExaKey !== undefined) process.env.EXA_API_KEY = originalExaKey;
else delete process.env.EXA_API_KEY;
if (originalTavilyKey !== undefined) process.env.TAVILY_API_KEY = originalTavilyKey;
else delete process.env.TAVILY_API_KEY;
fs.rmSync(tempRoot, { recursive: true, force: true });
});
it('is ready by default because DuckDuckGo is enabled', () => {
const readiness = getWebSearchReadiness();
const readiness = buildWebSearchReadiness(true, [
provider({
id: 'duckduckgo',
name: 'DuckDuckGo',
enabled: true,
available: true,
detail: 'Built-in (5 results)',
}),
]);
expect(readiness.readiness).toBe('ready');
expect(readiness.message).toContain('DuckDuckGo');
});
it('reports setup required when only Tavily is enabled without an API key', () => {
writeWebSearchConfig(tempRoot, [
'version: 10',
'websearch:',
' enabled: true',
' providers:',
' exa:',
' enabled: false',
' max_results: 5',
' tavily:',
' enabled: true',
' max_results: 5',
' duckduckgo:',
' enabled: false',
' max_results: 5',
' brave:',
' enabled: false',
' max_results: 5',
' gemini:',
' enabled: false',
' model: "gemini-2.5-flash"',
' timeout: 55',
' opencode:',
' enabled: false',
' model: "opencode/grok-code"',
' timeout: 90',
' grok:',
' enabled: false',
' timeout: 55',
'',
const readiness = buildWebSearchReadiness(true, [
provider({
id: 'tavily',
name: 'Tavily',
enabled: true,
available: false,
requiresApiKey: true,
apiKeyEnvVar: 'TAVILY_API_KEY',
detail: 'Set TAVILY_API_KEY',
}),
provider({
id: 'duckduckgo',
name: 'DuckDuckGo',
enabled: false,
available: false,
detail: 'Built-in (5 results)',
}),
]);
const readiness = getWebSearchReadiness();
expect(readiness.readiness).toBe('needs_setup');
expect(readiness.message).toContain('Tavily');
expect(readiness.message).toContain('TAVILY_API_KEY');
});
it('prefers API-backed readiness when Exa is enabled and configured', () => {
process.env.EXA_API_KEY = 'exa-test-key';
writeWebSearchConfig(tempRoot, [
'version: 10',
'websearch:',
' enabled: true',
' providers:',
' exa:',
' enabled: true',
' max_results: 5',
' tavily:',
' enabled: false',
' max_results: 5',
' duckduckgo:',
' enabled: false',
' max_results: 5',
' brave:',
' enabled: false',
' max_results: 5',
' gemini:',
' enabled: false',
' model: "gemini-2.5-flash"',
' timeout: 55',
' opencode:',
' enabled: false',
' model: "opencode/grok-code"',
' timeout: 90',
' grok:',
' enabled: false',
' timeout: 55',
'',
const readiness = buildWebSearchReadiness(true, [
provider({
id: 'exa',
name: 'Exa',
enabled: true,
available: true,
requiresApiKey: true,
apiKeyEnvVar: 'EXA_API_KEY',
detail: 'API key detected (5 results)',
}),
provider({
id: 'duckduckgo',
name: 'DuckDuckGo',
enabled: false,
available: false,
detail: 'Built-in (5 results)',
}),
]);
const readiness = getWebSearchReadiness();
expect(readiness.readiness).toBe('ready');
expect(readiness.message).toContain('Exa');
});