Some checks failed
* feat(runtime): add `disableOAuth` connect option (cache-friendly OAuth suppression) Closes #197. Long-running headless callers (daemons, scheduled jobs, CI workers) need to suppress the interactive OAuth flow without losing connection caching. The only existing knob — `maxOAuthAttempts: 0` — couples those two concerns because `useCache` is gated on `options.maxOAuthAttempts === undefined`. Daemons that wrap `connect` to force `maxOAuthAttempts: 0` end up spawning a fresh transport per `callTool`/`listTools` and `runtime.close()` cannot reap any of them. Add an additive `disableOAuth: boolean` option that suppresses OAuth at the transport layer (short-circuits `shouldEstablishOAuth` and `maybePromoteHttpDefinition`) but preserves caching. The cache entry metadata gains a `disableOAuth` field so connections established with the flag don't share a slot with connections that could refresh into an OAuth flow — switching the flag between calls evicts and re-establishes, mirroring the existing `allowCachedAuth` mismatch path. Backward compatibility: * `maxOAuthAttempts: 0` keeps its legacy escape-the-cache contract unchanged. Existing callers see no behavior change. * `skipCache: true` keeps its behavior unchanged. * `disableOAuth` defaults to undefined; only opt-in changes behavior. Also export `ConnectOptions` from `runtime.ts` and add the parameter to the `Runtime.connect` interface signature — the implementation already accepted options at runtime but the interface only exposed `connect(server)`, so callers couldn't pass options through the type system. (Pre-existing gap surfaced by adding the new test coverage.) Tests added to `tests/runtime-integration.test.ts`: * `reuses cached connection when disableOAuth: true is passed` — two calls return the same ClientContext, `close()` reaps it. * `maxOAuthAttempts: 0 still bypasses the cache (existing contract preserved)` — regression guard. * `evicts and re-establishes the cached client when disableOAuth flag changes` — the core eviction semantic. `pnpm test` (709 pass / 3 skip), `pnpm lint`, `pnpm typecheck` all green. * fix(runtime): preserve disableOAuth across helper calls * fix(daemon): forward disableOAuth through keep-alive paths * feat(cli): expose disableOAuth for headless commands * fix(runtime): preserve cached slot across connect(disableOAuth) → callTool/listTools Addresses PR #198 review comment r3366238654. The documented headless setup is: await runtime.connect(server, { disableOAuth: true }); await runtime.callTool(server, 'foo', { ... }); The first call stored the cache slot with `allowCachedAuth: undefined`, but `callTool()` internally calls `this.connect(server, { allowCachedAuth: true, disableOAuth: <effective>: true })` and the cache-match check treated the two options shapes as structurally different: existing.allowCachedAuth (undefined) !== options.allowCachedAuth (true) && options.allowCachedAuth !== undefined => MISMATCH => evict + reopen transport Every first callTool / listTools after a pre-connect spawned a fresh transport, defeating the pooling guarantee that motivated the disableOAuth option in the first place. Same shape affected `listTools` (which defaults `allowCachedAuth: options.allowCachedAuth ?? true`). Fix: normalize at the connect() entrypoint. A `disableOAuth: true` caller has no path to interactive OAuth, so cached-token application is the only auth they can ever use — default `allowCachedAuth: true` when the caller didn't pick a side. Explicit `false` is honored (header-only / anonymous callers). The normalized value flows through both the cache lookup and the cache write so subsequent internal callers compose without eviction. Two regression tests added to `tests/runtime-integration.test.ts`: - `preserves the cached client across connect(disableOAuth:true) → callTool() (no implicit eviction)` - `preserves the cached client across connect(disableOAuth:true) → listTools() (no implicit eviction)` Both call `runtime.connect(disableOAuth:true)`, then invoke the internal-cached path (callTool or listTools), then re-call `runtime.connect(disableOAuth:true)` and assert the resulting ClientContext is `=== ` the first one. Both tests fail without this fix (the second connect returns a new ClientContext because the first was evicted). `pnpm test` 723 pass / 3 skip / 0 fail. `pnpm lint` + `pnpm typecheck` clean. No push. * docs(examples): add headless-pooling-demo for disableOAuth verification Demonstrates the three patterns under the new `disableOAuth` option against a local mock MCP server (no real auth). Reproducible artifact for PR #198 review proof. Patterns demonstrated: * Legacy `maxOAuthAttempts: 0` (uncached): 5 connect() calls produce 5 distinct ClientContexts. Existing contract preserved. * `disableOAuth: true` on every connect: 5 calls produce 1 ClientContext. Cache reuse under cache-friendly suppression. * Documented headless setup — pre-connect(disableOAuth: true) + 5 callTool() — proves the pre-connected slot survives the implicit internal connect path. Directly demonstrates the fix from b0e3e2e. Run: `pnpm tsx examples/headless-pooling-demo.ts` Sample output is intentionally redacted to no PII / no secrets: a local http://127.0.0.1:<random-port>/mcp server with a public `add` tool. * style(examples): oxfmt headless-pooling-demo (CI fix) * fix(server-proxy): thread disableOAuth through schema-discovery listTools Addresses PR #198 review comment r3366307210 (clawsweeper proxy gap). The Proxy returned by `createServerProxy` calls `ensureMetadata()` on every tool invocation, which fires `runtime.listTools(server, { includeSchema: true })` for schema discovery. That call ran BEFORE the proxy parsed the caller's options bag, so a `proxy.tool({ ... }, { disableOAuth: true })` invocation on an OAuth server with no cached schema could still trigger an interactive OAuth flow during metadata fetch — defeating the no-browser guarantee the option was meant to provide. Fix: * Pre-scan callArgs once for `disableOAuth: true` before invoking `ensureMetadata`. The scan is a single linear pass over the already-present argument list and short-circuits on the first match. * Extend `ensureMetadata(toolName, { disableOAuth? })` and forward the flag to the underlying `runtime.listTools(serverName, { includeSchema: true, disableOAuth: true })` call. * The schema-fetch path that was vulnerable now inherits the same no-OAuth posture as the eventual `runtime.callTool` invocation. End- to-end no-browser guarantee is preserved across the proxy interface. Regression test in `tests/server-proxy.test.ts`: > threads disableOAuth through schema discovery so > proxy.tool({disableOAuth:true}) cannot trigger OAuth during > metadata fetch Asserts BOTH: - `runtime.listTools` called with `{ includeSchema: true, disableOAuth: true }` - `runtime.callTool` called with the eventual tool args and `disableOAuth: true` Locks the contract on both halves so a future refactor that re-introduces the gap on either side will fail loudly. Full suite: 724 pass / 3 skipped / 0 fail. `pnpm check` (format + lint + typecheck) clean. * refactor(cli): drop --disable-oauth alias; keep only --no-oauth The PR originally exposed two CLI names for the same intent: --disable-oauth (mirroring the JS option `disableOAuth: true`) and --no-oauth (the GNU-style boolean opt-out). Two names for one behavior is noise — documentation has to mention both, users have to learn both, and they invite drift. --no-oauth is the right shape for a per-invocation boolean opt-out: - Matches the dominant unix convention (git --no-verify, npm --no-save, bun --no-cache, curl --no-progress-meter). - Shorter to type. - Composes naturally with other flags in scripts. The JS option name stays `disableOAuth: boolean` — that's the right shape for a JS option (verb+noun, no Boolean-negation prefix ambiguity), and the JS and CLI naming conventions are genuinely different domains. Removed CLI registrations + help text + internal forwarding for --disable-oauth across: - src/cli/call-arguments.ts (FLAG_HANDLERS registration) - src/cli/call-command.ts (internal listArgs forwarding, 2 sites) - src/cli/call-help.ts (help text) - src/cli/list-command.ts (help text) - src/cli/list-flags.ts (token check) - src/cli/resource-command.ts (token check + help text) - docs/cli-reference.md (3 references) Renamed test cases that exclusively exercised --disable-oauth to exercise --no-oauth instead, preserving regression coverage: - tests/call-arguments.test.ts - tests/cli-list-flags.test.ts - tests/cli-resource-command.test.ts The internal cache-key fragment `disable-oauth:` in src/cli/tool-cache.ts is kept — it mirrors the JS option name (which stays `disableOAuth`), not the CLI flag. Tests: 724 passed, 3 skipped, 0 failed. Lint: 0 warnings, 0 errors. Typecheck: clean. * fix(runtime): forward disableOAuth through callOnce * chore: update dependencies * fix(server-proxy): preserve schema-owned option fields * fix(runtime): isolate OAuth cache variants safely * fix(server-proxy): isolate schema discovery posture * fix(server-proxy): preserve OAuth posture during discovery --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
196 lines
7.1 KiB
TypeScript
196 lines
7.1 KiB
TypeScript
import fs from 'node:fs';
|
|
import { describe, expect, it, vi } from 'vitest';
|
|
import { parseCallArguments } from '../src/cli/call-arguments.js';
|
|
|
|
describe('parseCallArguments', () => {
|
|
it('parses legacy selector + key=value pairs', () => {
|
|
const args = ['linear.list_documents', 'limit=5', 'format=json'];
|
|
const parsed = parseCallArguments([...args]);
|
|
expect(parsed.selector).toBe('linear.list_documents');
|
|
expect(parsed.tool).toBeUndefined();
|
|
expect(parsed.args.limit).toBe(5);
|
|
expect(parsed.args.format).toBe('json');
|
|
});
|
|
|
|
it.each(['--server', '--mcp'] as const)('captures %s as server override', (flag) => {
|
|
const parsed = parseCallArguments([flag, 'linear', 'list_documents']);
|
|
expect(parsed.server).toBe('linear');
|
|
expect(parsed.tool).toBe('list_documents');
|
|
});
|
|
|
|
it('consumes function-style call expressions with HTTP selectors', () => {
|
|
const call = 'https://example.com/mcp.getComponents(limit: 3, projectId: "123")';
|
|
const parsed = parseCallArguments([call]);
|
|
expect(parsed.server).toBe('https://example.com/mcp');
|
|
expect(parsed.tool).toBe('getComponents');
|
|
expect(parsed.args.limit).toBe(3);
|
|
expect(parsed.args.projectId).toBe('123');
|
|
});
|
|
|
|
it('merges --args JSON blobs with positional fragments', () => {
|
|
const parsed = parseCallArguments([
|
|
'--args',
|
|
'{"query":"open issues"}',
|
|
'linear',
|
|
'list_documents',
|
|
'orderBy=updatedAt',
|
|
]);
|
|
expect(parsed.selector).toBe('linear');
|
|
expect(parsed.tool).toBe('list_documents');
|
|
expect(parsed.args.query).toBe('open issues');
|
|
expect(parsed.args.orderBy).toBe('updatedAt');
|
|
});
|
|
|
|
it('parses generic --key value flags as named tool arguments', () => {
|
|
const parsed = parseCallArguments([
|
|
'email.send_email',
|
|
'--to',
|
|
'["miguel@example.com"]',
|
|
'--subject',
|
|
'Test',
|
|
'--save-to-drafts',
|
|
'true',
|
|
'--limit=5',
|
|
]);
|
|
expect(parsed.args).toEqual({
|
|
to: ['miguel@example.com'],
|
|
subject: 'Test',
|
|
saveToDrafts: true,
|
|
limit: 5,
|
|
});
|
|
expect(parsed.schemaStringCoercionCandidates).toEqual({ limit: '5' });
|
|
});
|
|
|
|
it('merges --json object payloads as an alias for --args', () => {
|
|
const parsed = parseCallArguments([
|
|
'email.send_email',
|
|
'--json',
|
|
'{"to":["miguel@example.com"],"subject":"Test","saveToDrafts":true}',
|
|
'--text',
|
|
'Hello',
|
|
]);
|
|
expect(parsed.args).toEqual({
|
|
to: ['miguel@example.com'],
|
|
subject: 'Test',
|
|
saveToDrafts: true,
|
|
text: 'Hello',
|
|
});
|
|
});
|
|
|
|
it('reads JSON object payloads from stdin when --json - is used', () => {
|
|
const readFileSync = vi
|
|
.spyOn(fs, 'readFileSync')
|
|
.mockReturnValueOnce('{"to":["miguel@example.com"],"subject":"Test"}');
|
|
try {
|
|
const parsed = parseCallArguments(['email.send_email', '--json', '-']);
|
|
expect(parsed.args).toEqual({
|
|
to: ['miguel@example.com'],
|
|
subject: 'Test',
|
|
});
|
|
expect(readFileSync).toHaveBeenCalledWith(0, 'utf8');
|
|
} finally {
|
|
readFileSync.mockRestore();
|
|
}
|
|
});
|
|
|
|
it('throws when generic long flags are missing a value', () => {
|
|
expect(() => parseCallArguments(['server.tool', '--source'])).toThrow("Flag '--source' requires a value.");
|
|
});
|
|
|
|
it('treats values after -- as literal positional arguments', () => {
|
|
const parsed = parseCallArguments(['server.tool', '--', '--source', 'import', '--raw=true']);
|
|
expect(parsed.selector).toBe('server.tool');
|
|
expect(parsed.positionalArgs).toEqual(['--source', 'import', '--raw=true']);
|
|
});
|
|
|
|
it('throws when flags conflict with call expression content', () => {
|
|
expect(() => parseCallArguments(['--server', 'linear', 'cursor.list_documents(limit:1)'])).toThrow(
|
|
/Conflicting server names/
|
|
);
|
|
});
|
|
|
|
it('treats key:=value as an alias for key=value without keeping a trailing colon', () => {
|
|
const parsed = parseCallArguments(['schwab.placeOrder', 'price:=5.20', 'quantity:=0', 'limit:=10']);
|
|
expect(parsed.args.price).toBe('5.20');
|
|
expect(parsed.args.quantity).toBe(0);
|
|
expect(parsed.args.limit).toBe(10);
|
|
expect(parsed.schemaStringCoercionCandidates).toEqual({ quantity: '0', limit: '10' });
|
|
expect(parsed.args).not.toHaveProperty('price:');
|
|
});
|
|
|
|
it('leaves := inside values untouched', () => {
|
|
const parsed = parseCallArguments(['server.tool', 'expr=value:=x']);
|
|
expect(parsed.args.expr).toBe('value:=x');
|
|
expect(parsed.args).not.toHaveProperty('expr:');
|
|
});
|
|
|
|
it('warns when colon-style arguments omit a value', () => {
|
|
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
|
|
const parsed = parseCallArguments(['iterm-mcp.write_to_terminal', 'command:']);
|
|
expect(parsed.args.command).toBe('');
|
|
expect(warnSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining("[mcporter] Argument 'command' was provided without a value.")
|
|
);
|
|
warnSpy.mockRestore();
|
|
});
|
|
|
|
it.each([
|
|
['default', [], 123456, 'number'],
|
|
['raw-strings', ['--raw-strings'], '123456', 'string'],
|
|
['no-coerce', ['--no-coerce'], '123456', 'string'],
|
|
] as const)('handles numeric coercion in %s mode', (_mode, flags, expected, expectedType) => {
|
|
const parsed = parseCallArguments([...flags, 'server.tool', 'code=123456']);
|
|
expect(parsed.args.code).toBe(expected);
|
|
expect(typeof parsed.args.code).toBe(expectedType);
|
|
});
|
|
|
|
it('preserves leading zeros when --raw-strings flag is used', () => {
|
|
const parsed = parseCallArguments(['--raw-strings', 'server.tool', 'pin=000123']);
|
|
expect(parsed.args.pin).toBe('000123');
|
|
expect(typeof parsed.args.pin).toBe('string');
|
|
});
|
|
|
|
it('still coerces booleans, nulls, and JSON with --raw-strings', () => {
|
|
const parsed = parseCallArguments(['--raw-strings', 'server.tool', 'enabled=true', 'value=null', 'meta={"a":1}']);
|
|
expect(parsed.args.enabled).toBe(true);
|
|
expect(parsed.args.value).toBeNull();
|
|
expect(parsed.args.meta).toEqual({ a: 1 });
|
|
});
|
|
|
|
it('keeps every value as a string when --no-coerce alias is used', () => {
|
|
const parsed = parseCallArguments([
|
|
'--no-coerce',
|
|
'server.tool',
|
|
'id=007',
|
|
'enabled=true',
|
|
'value=null',
|
|
'meta={"a":1}',
|
|
'123',
|
|
]);
|
|
expect(parsed.args.id).toBe('007');
|
|
expect(parsed.args.enabled).toBe('true');
|
|
expect(parsed.args.value).toBe('null');
|
|
expect(parsed.args.meta).toBe('{"a":1}');
|
|
expect(typeof parsed.args.id).toBe('string');
|
|
expect(parsed.positionalArgs).toEqual(['123']);
|
|
});
|
|
|
|
it('captures --no-oauth as a runtime flag instead of a tool argument', () => {
|
|
const parsed = parseCallArguments(['server.tool', '--no-oauth', 'limit=5']);
|
|
expect(parsed.disableOAuth).toBe(true);
|
|
expect(parsed.args).toEqual({ limit: 5 });
|
|
});
|
|
|
|
it('captures --save-images output directory', () => {
|
|
const parsed = parseCallArguments(['--save-images', './tmp/images', 'server.tool']);
|
|
expect(parsed.saveImagesDir).toBe('./tmp/images');
|
|
});
|
|
|
|
it.each([
|
|
['--save-images', /--save-images requires a directory path/],
|
|
['--args', /--args requires a JSON value/],
|
|
] as const)('throws when %s is missing a value', (flag, expectedError) => {
|
|
expect(() => parseCallArguments([flag])).toThrow(expectedError);
|
|
});
|
|
});
|