feat(api): abort signal support for anthropic, anthropic-vertex, xai, minimax

packages/config-eslint/api-provider-hygiene.js

@@ -3,12 +3,17 @@
 // Paths are relative to the `src` package, where this config is loaded.
 
 const sharedAbortHelpers =
-	"mergeAbortSignalAndTimeout|mergeAbortSignals|throwIfAborted|isRequestAborted|createAbortError|rejectOnAbort|resolveModelWithAbort"
+	"mergeAbortSignalAndTimeout|mergeAbortSignals|throwIfAborted|isRequestAborted|createAbortError|rejectOnAbort|resolveModelWithAbort|bridgeExternalAbortSignal|hasUsableTimeout|toSdkTimeoutMs"
 
 // Names that usually hold a secret or an endpoint that can embed credentials.
 // `cacheKey` and `contextTokens` must not match.
 const sensitiveName = "^(url|apiKey|secret|password)$|(Url|URL|ApiKey|Secret|Token)$"
 
+// A per-request `timeoutMs` from CompletePromptOptions. `this.timeoutMs` is the client-level
+// timeout from getApiRequestTimeout, which is already valid, so it must not match.
+const rawRequestTimeout =
+	":matches(Identifier[name='timeoutMs'], MemberExpression[property.name='timeoutMs']:not([object.type='ThisExpression']), ChainExpression[expression.property.name='timeoutMs'])"
+
 export const apiProviderHygieneSelectors = [
 	{
 		selector: `:matches(FunctionDeclaration, VariableDeclarator)[id.name=/^(${sharedAbortHelpers})$/]`,
@@ -20,6 +25,16 @@ export const apiProviderHygieneSelectors = [
 		message:
 			"Use mergeAbortSignalAndTimeout for a variable delay. AbortSignal.timeout throws on Infinity and fractions, and clamps large values to 1 ms.",
 	},
+	{
+		selector: `:matches(Property[key.name='timeout'], AssignmentExpression[left.property.name='timeout']) > ${rawRequestTimeout}`,
+		message:
+			"Do not forward a request timeoutMs as is. A SDK treats 0 as an immediate abort and throws on negative, non-finite or fractional values. Use hasUsableTimeout and toSdkTimeoutMs.",
+	},
+	{
+		selector: "Literal[value=2147483647]",
+		message:
+			"Do not write the maximum timer delay by hand. Use MAX_TIMEOUT_MS or toSdkTimeoutMs from providers/utils/abort-signal.",
+	},
 	{
 		selector: `CallExpression[callee.object.name='console'] TemplateLiteral > :matches(Identifier[name=/${sensitiveName}/], MemberExpression[property.name=/${sensitiveName}/])`,
 		message:
@@ -35,3 +50,12 @@ export const apiProviderHygieneConfig = {
 		"no-restricted-syntax": ["error", ...apiProviderHygieneSelectors],
 	},
 }
+
+// Spec files under src/api. A loop of expects in one test stops at the first failing case and hides the rest.
+export const apiProviderTestSelectors = [
+	{
+		selector: "ForOfStatement[right.type='ArrayExpression']:has(CallExpression[callee.name='expect'])",
+		message:
+			"Use it.each for repeated cases. A loop of expects in one test stops at the first failing case and does not name it.",
+	},
+]

packages/config-eslint/api-provider-hygiene.test.js

@@ -4,7 +4,7 @@ import { describe, it } from "node:test"
 import { Linter } from "eslint"
 import typescriptEslint from "typescript-eslint"
 
-import { apiProviderHygieneConfig } from "./api-provider-hygiene.js"
+import { apiProviderHygieneConfig, apiProviderTestSelectors } from "./api-provider-hygiene.js"
 
 const linter = new Linter({ configType: "flat" })
 const config = [{ files: ["**/*.ts"], languageOptions: { parser: typescriptEslint.parser } }, apiProviderHygieneConfig]
@@ -88,3 +88,89 @@ describe("api provider hygiene: sensitive values in logs", () => {
 		})
 	}
 })
+
+describe("api provider hygiene: request timeout forwarding", () => {
+	for (const code of [
+		"create(body, { timeout: options.timeoutMs })",
+		"create(body, { timeout: options?.timeoutMs })",
+		"create(body, { signal, timeout: timeoutMs })",
+		"requestOptions.timeout = options.timeoutMs",
+		"requestOptions.timeout = timeoutMs",
+	]) {
+		it(`flags: ${code}`, () => {
+			assert.equal(lint(code).length, 1)
+		})
+	}
+
+	for (const code of [
+		"new OpenAI({ timeout: this.timeoutMs })",
+		"requestOptions.timeout = toSdkTimeoutMs(timeoutMs)",
+		"create(body, { timeout: toSdkTimeoutMs(options.timeoutMs) })",
+		"if (hasUsableTimeout(timeoutMs)) requestOptions.timeout = toSdkTimeoutMs(timeoutMs)",
+		"const timeoutMs = options?.timeoutMs",
+		"mergeAbortSignalAndTimeout(signal, options?.timeoutMs)",
+	]) {
+		it(`allows: ${code}`, () => {
+			assert.deepEqual(lint(code), [])
+		})
+	}
+})
+
+describe("api provider hygiene: timeout helpers", () => {
+	for (const code of [
+		"const MAX = 2147483647",
+		"Math.min(Math.ceil(timeoutMs), 2_147_483_647)",
+		"function hasUsableTimeout(t?: number) { return true }",
+		"const toSdkTimeoutMs = (t: number) => t",
+		"function bridgeExternalAbortSignal() {}",
+	]) {
+		it(`flags: ${code}`, () => {
+			assert.equal(lint(code).length, 1)
+		})
+	}
+
+	it("allows importing the timeout helpers", () => {
+		assert.deepEqual(
+			lint('import { hasUsableTimeout, toSdkTimeoutMs } from "./utils/abort-signal"\ntoSdkTimeoutMs(1)'),
+			[],
+		)
+	})
+
+	it("allows the literal in the helper module", () => {
+		assert.deepEqual(lint("export const MAX_TIMEOUT_MS = 2_147_483_647", "api/providers/utils/abort-signal.ts"), [])
+	})
+})
+
+describe("api provider hygiene: spec loops", () => {
+	const testLinter = new Linter({ configType: "flat" })
+	const testConfig = [
+		{ files: ["**/*.ts"], languageOptions: { parser: typescriptEslint.parser } },
+		{
+			files: ["api/**/__tests__/**/*.spec.ts"],
+			rules: { "no-restricted-syntax": ["error", ...apiProviderTestSelectors] },
+		},
+	]
+	const lintSpec = (code) =>
+		testLinter
+			.verify(code, testConfig, { filename: "api/providers/__tests__/example.spec.ts" })
+			.map((m) => m.message)
+
+	for (const code of [
+		"it('x', () => { for (const v of [0, -5]) { expect(f(v)).toBe(1) } })",
+		"it('x', async () => { for (const v of [0, -5]) { await run(v); expect(f(v)).toBe(1) } })",
+	]) {
+		it(`flags a loop of expects over a literal array: ${code}`, () => {
+			assert.equal(lintSpec(code).length, 1)
+		})
+	}
+
+	for (const code of [
+		"it.each([0, -5])('x %s', (v) => { expect(f(v)).toBe(1) })",
+		"it('x', () => { for (const v of [0, -5]) { run(v) } })",
+		"it('x', () => { for (const v of cases) { expect(f(v)).toBe(1) } })",
+	]) {
+		it(`allows: ${code}`, () => {
+			assert.deepEqual(lintSpec(code), [])
+		})
+	}
+})