Files
msd-core/sdk/src/query/config-query.ts
Tom Boucher 7032f44633 fix(#2544): exit 1 on missing key in config-get (#2588)
The configGet query handler previously threw GSDError with
ErrorClassification.Validation, which maps to exit code 10. Callers
using `if ! gsd-sdk query config-get key; then fallback; fi` could
not detect missing keys through the exit code alone, because exit 10
is still truthy-failure but the intent (and documented UNIX
convention — cf. `git config --get`) is exit 1 for absent key.

Change the classification for the two 'Key not found' throw sites to
ErrorClassification.Execution so the CLI exits 1 on missing key.
Usage/schema errors (no key argument, malformed JSON, missing
config.json) remain Validation.

Closes #2544
2026-04-22 12:04:03 -04:00

193 lines
8.5 KiB
TypeScript

/**
* Config-get and resolve-model query handlers.
*
* Ported from get-shit-done/bin/lib/config.cjs and commands.cjs.
* Provides raw config.json traversal and model profile resolution.
*
* @example
* ```typescript
* import { configGet, resolveModel } from './config-query.js';
*
* const result = await configGet(['workflow.auto_advance'], '/project');
* // { data: true }
*
* const model = await resolveModel(['gsd-planner'], '/project');
* // { data: { model: 'opus', profile: 'balanced' } }
* ```
*/
import { readFile } from 'node:fs/promises';
import { GSDError, ErrorClassification } from '../errors.js';
import { loadConfig } from '../config.js';
import { planningPaths } from './helpers.js';
import type { QueryHandler } from './utils.js';
// ─── MODEL_PROFILES ─────────────────────────────────────────────────────────
/**
* Mapping of GSD agent type to model alias for each profile tier.
*
* Ported from get-shit-done/bin/lib/model-profiles.cjs.
*/
export const MODEL_PROFILES: Record<string, Record<string, string>> = {
'gsd-planner': { quality: 'opus', balanced: 'opus', budget: 'sonnet', adaptive: 'opus' },
'gsd-roadmapper': { quality: 'opus', balanced: 'sonnet', budget: 'sonnet', adaptive: 'sonnet' },
'gsd-executor': { quality: 'opus', balanced: 'sonnet', budget: 'sonnet', adaptive: 'sonnet' },
'gsd-phase-researcher': { quality: 'opus', balanced: 'sonnet', budget: 'haiku', adaptive: 'sonnet' },
'gsd-project-researcher': { quality: 'opus', balanced: 'sonnet', budget: 'haiku', adaptive: 'sonnet' },
'gsd-research-synthesizer': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
'gsd-debugger': { quality: 'opus', balanced: 'sonnet', budget: 'sonnet', adaptive: 'opus' },
'gsd-codebase-mapper': { quality: 'sonnet', balanced: 'haiku', budget: 'haiku', adaptive: 'haiku' },
'gsd-verifier': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'sonnet' },
'gsd-plan-checker': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
'gsd-integration-checker': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
'gsd-nyquist-auditor': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
'gsd-pattern-mapper': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
'gsd-ui-researcher': { quality: 'opus', balanced: 'sonnet', budget: 'haiku', adaptive: 'sonnet' },
'gsd-ui-checker': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
'gsd-ui-auditor': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
'gsd-doc-writer': { quality: 'opus', balanced: 'sonnet', budget: 'haiku', adaptive: 'sonnet' },
'gsd-doc-verifier': { quality: 'sonnet', balanced: 'sonnet', budget: 'haiku', adaptive: 'haiku' },
};
/** Valid model profile names. */
export const VALID_PROFILES: string[] = Object.keys(MODEL_PROFILES['gsd-planner']);
/**
* Flat map of agent name → model alias for one profile tier (matches `model-profiles.cjs`).
*/
export function getAgentToModelMapForProfile(normalizedProfile: string): Record<string, string> {
const profile = VALID_PROFILES.includes(normalizedProfile) ? normalizedProfile : 'balanced';
const agentToModelMap: Record<string, string> = {};
for (const [agent, profileToModelMap] of Object.entries(MODEL_PROFILES)) {
const mapped = profileToModelMap[profile] ?? profileToModelMap.balanced;
agentToModelMap[agent] = mapped ?? 'sonnet';
}
return agentToModelMap;
}
// ─── configGet ──────────────────────────────────────────────────────────────
/**
* Query handler for config-get command.
*
* Reads raw .planning/config.json and traverses dot-notation key paths.
* Does NOT merge with defaults (matches gsd-tools.cjs behavior).
*
* @param args - args[0] is the dot-notation key path (e.g., 'workflow.auto_advance')
* @param projectDir - Project root directory
* @returns QueryResult with the config value at the given path
* @throws GSDError with Validation classification if key missing or not found
*/
export const configGet: QueryHandler = async (args, projectDir, _workstream) => {
const keyPath = args[0];
if (!keyPath) {
throw new GSDError('Usage: config-get <key.path>', ErrorClassification.Validation);
}
const paths = planningPaths(projectDir);
let raw: string;
try {
raw = await readFile(paths.config, 'utf-8');
} catch {
throw new GSDError(`No config.json found at ${paths.config}`, ErrorClassification.Validation);
}
let config: Record<string, unknown>;
try {
config = JSON.parse(raw) as Record<string, unknown>;
} catch {
throw new GSDError(`Malformed config.json at ${paths.config}`, ErrorClassification.Validation);
}
const keys = keyPath.split('.');
let current: unknown = config;
for (const key of keys) {
if (current === undefined || current === null || typeof current !== 'object') {
// UNIX convention (cf. `git config --get`): missing key exits 1, not 10.
// See issue #2544 — callers use `if ! gsd-sdk query config-get k; then` patterns.
throw new GSDError(`Key not found: ${keyPath}`, ErrorClassification.Execution);
}
current = (current as Record<string, unknown>)[key];
}
if (current === undefined) {
throw new GSDError(`Key not found: ${keyPath}`, ErrorClassification.Execution);
}
return { data: current };
};
// ─── configPath ─────────────────────────────────────────────────────────────
/**
* Query handler for config-path — resolved `.planning/config.json` path (workstream-aware via cwd).
*
* Port of `cmdConfigPath` from `config.cjs`. The JSON query API returns `{ path }`; the CJS CLI
* emits the path as plain text for shell substitution.
*
* @param _args - Unused
* @param projectDir - Project root directory
* @returns QueryResult with `{ path: string }` absolute or project-relative resolution via planningPaths
*/
export const configPath: QueryHandler = async (_args, projectDir, _workstream) => {
const paths = planningPaths(projectDir);
return { data: { path: paths.config } };
};
// ─── resolveModel ───────────────────────────────────────────────────────────
/**
* Query handler for resolve-model command.
*
* Resolves the model alias for a given agent type based on the current profile.
* Uses loadConfig (with defaults) and MODEL_PROFILES for lookup.
*
* @param args - args[0] is the agent type (e.g., 'gsd-planner')
* @param projectDir - Project root directory
* @returns QueryResult with { model, profile } or { model, profile, unknown_agent: true }
* @throws GSDError with Validation classification if agent type not provided
*/
export const resolveModel: QueryHandler = async (args, projectDir) => {
const agentType = args[0];
if (!agentType) {
throw new GSDError('agent-type required', ErrorClassification.Validation);
}
const config = await loadConfig(projectDir);
const profile = String(config.model_profile || 'balanced').toLowerCase();
// Check per-agent override first
const overrides = (config as Record<string, unknown>).model_overrides as Record<string, string> | undefined;
const override = overrides?.[agentType];
if (override) {
const agentModels = MODEL_PROFILES[agentType];
const result = agentModels
? { model: override, profile }
: { model: override, profile, unknown_agent: true };
return { data: result };
}
// resolve_model_ids: "omit" -- return empty string
const resolveModelIds = (config as Record<string, unknown>).resolve_model_ids;
if (resolveModelIds === 'omit') {
const agentModels = MODEL_PROFILES[agentType];
const result = agentModels
? { model: '', profile }
: { model: '', profile, unknown_agent: true };
return { data: result };
}
// Fall back to profile lookup
const agentModels = MODEL_PROFILES[agentType];
if (!agentModels) {
return { data: { model: 'sonnet', profile, unknown_agent: true } };
}
if (profile === 'inherit') {
return { data: { model: 'inherit', profile } };
}
const alias = agentModels[profile] || agentModels['balanced'] || 'sonnet';
return { data: { model: alias, profile } };
};