Skip to content

armgit / cindy

Public Imported from GitHub
0

Consider it done. The open-source AI agent that works out of the box · 想到,就能做到。开源、开箱即用的 AI Agent。

fix(provider-diagnostics): 「测试连接」失败在主进程留痕,日志不再无迹可循(#4954) (#4963)

FicoWang1c3290a2f57a
diff --git a/apps/desktop/src/main/maker-host/__tests__/providerDiagnostics.test.ts b/apps/desktop/src/main/maker-host/__tests__/providerDiagnostics.test.ts
index c08affd17c..018b71d3c9 100644
--- a/apps/desktop/src/main/maker-host/__tests__/providerDiagnostics.test.ts
+++ b/apps/desktop/src/main/maker-host/__tests__/providerDiagnostics.test.ts
@@ -11,6 +11,11 @@
import { describe, it, expect, afterEach, vi } from 'vitest';
+const probeLog = vi.hoisted(() => ({ warn: vi.fn(), info: vi.fn(), debug: vi.fn(), trace: vi.fn(), error: vi.fn() }));
+vi.mock('../logger-adapter', () => ({
+ createMakerLogger: () => ({ ...probeLog, child: () => probeLog }),
+}));
+
import { BUNDLED_CATALOG, buildUserProvider, PROVIDER_MODEL_CATALOG, providerPresetOAuth } from '@cindy/model-providers';
import { classifyProviderError } from '../../../shared/providerErrors.js';
@@ -27,6 +32,7 @@ import { setCustomProviders } from '../active-catalog.js';
afterEach(() => {
setCustomProviders([]);
setDiagnosticsKeyReader(() => null);
+ probeLog.warn.mockClear();
});
describe('classifyProviderError', () => {
@@ -326,6 +332,57 @@ describe('runProviderProbe(注入 fetch,不联网)', () => {
expect(r).toMatchObject({ ok: false, code: 'UPSTREAM_UNREACHABLE' });
});
+ it('失败探测在主进程留痕:字段含 agent/model/上游 origin/status/分类码/脱敏摘要,不含路径与凭证(#4954)', async () => {
+ const r = await runProviderProbe(
+ { agent: 'codex', baseUrl: 'https://opencode.example/zen/go/v1?token=secret-q', modelId: 'kimi-k2', apiKey: 'sk-live-abcdef123456', wireProtocol: 'openai-chat' },
+ async () => fakeResponse(400, '{"error":{"message":"model kimi-k2 is not served by this endpoint","authorization":"Bearer sk-live-abcdef123456"}}'),
+ );
+ expect(r).toMatchObject({ ok: false, code: 'UNKNOWN', status: 400 });
+ expect(probeLog.warn).toHaveBeenCalledTimes(1);
+ const [msg, ctx] = probeLog.warn.mock.calls[0] as [string, Record<string, unknown>];
+ expect(msg).toBe('provider connection probe failed');
+ expect(ctx).toMatchObject({ agent: 'codex', model: 'kimi-k2', upstream: 'https://opencode.example', wireProtocol: 'openai-chat', status: 400, code: 'UNKNOWN' });
+ expect(typeof ctx.latencyMs).toBe('number');
+ expect(String(ctx.detail)).toContain('not served by this endpoint');
+ // 路径、query 与凭证不得进入日志。
+ const serialized = JSON.stringify(ctx);
+ expect(serialized).not.toContain('/zen/go/v1');
+ expect(serialized).not.toContain('secret-q');
+ expect(serialized).not.toContain('sk-live-abcdef123456');
+ });
+
+ it('拿到 SSE 响应头后读首帧中断:异常照常抛出,但主进程已留痕(#4963 review)', async () => {
+ const body = new ReadableStream<Uint8Array>({
+ pull(controller) { controller.error(new Error('socket hang up')); },
+ });
+ await expect(runProviderProbe(
+ { agent: 'codex', baseUrl: 'https://x.example/v1', modelId: 'm', apiKey: 'k', wireProtocol: 'openai-chat' },
+ async () => new Response(body, { status: 200, headers: { 'content-type': 'text/event-stream' } }),
+ )).rejects.toThrow('socket hang up');
+ expect(probeLog.warn).toHaveBeenCalledTimes(1);
+ expect(probeLog.warn.mock.calls[0][1]).toMatchObject({ code: 'UNKNOWN', model: 'm', upstream: 'https://x.example' });
+ expect(String((probeLog.warn.mock.calls[0][1] as Record<string, unknown>).detail)).toContain('socket hang up');
+ });
+
+ it('成功探测不写 warn 日志', async () => {
+ await runProviderProbe(
+ { agent: 'claude-code', baseUrl: 'https://x.example', modelId: 'm', apiKey: 'k' },
+ async () => fakeResponse(200, '{}'),
+ );
+ expect(probeLog.warn).not.toHaveBeenCalled();
+ });
+
+ it('网络层失败同样留痕(无 status,带分类码)', async () => {
+ const err = new Error('fetch failed');
+ (err as Error & { cause?: { code: string } }).cause = { code: 'ECONNREFUSED' };
+ await runProviderProbe(
+ { agent: 'codex', baseUrl: 'https://nope.example', modelId: 'm' },
+ async () => { throw err; },
+ );
+ expect(probeLog.warn).toHaveBeenCalledTimes(1);
+ expect(probeLog.warn.mock.calls[0][1]).toMatchObject({ code: 'UPSTREAM_UNREACHABLE', upstream: 'https://nope.example', status: undefined });
+ });
+
it('openai-chat 探测:200 text/event-stream → ok', async () => {
const r = await runProviderProbe(
{
diff --git a/apps/desktop/src/main/maker-host/provider-diagnostics.ts b/apps/desktop/src/main/maker-host/provider-diagnostics.ts
index a1c100379a..481380022c 100644
--- a/apps/desktop/src/main/maker-host/provider-diagnostics.ts
+++ b/apps/desktop/src/main/maker-host/provider-diagnostics.ts
@@ -34,10 +34,13 @@ import {
type ProviderErrorCode,
} from '../../shared/providerErrors.js';
import { getActiveCatalog } from './active-catalog.js';
+import { createMakerLogger } from './logger-adapter.js';
import { outboundFetch } from './outbound-fetch.js';
import { hostCredentialEndpointAllowed, invocationModelRecord, probePiProvider, requiresNativeProviderAuth } from './pi-provider-transport.js';
import { buildRouteDecision, providerRoutingForModel } from './provider-route.js';
+const log = createMakerLogger('provider-probe');
+
/** 探测请求超时。 */
const PROBE_TIMEOUT_MS = 10_000;
/** 失败响应体最多读取的字节数(分类只看前几 KB)。 */
@@ -272,11 +275,67 @@ function networkErrorCode(err: unknown): string {
return 'UNKNOWN_NETWORK_ERROR';
}
-/** 跑一次探测请求并分类结果。fetch 可注入(单测)。 */
+/** 上游 origin(协议 + host + 端口),不带路径 / query / 凭证——只用于日志定位。 */
+function probeUpstreamOrigin(baseUrl: string): string {
+ try {
+ return new URL(baseUrl).origin;
+ } catch {
+ return '<invalid-url>';
+ }
+}
+
+/** 进日志的摘要上限;分类器给出的 detail 已经过 redactSensitiveText,这里只再兜一层凭证头形态与长度。 */
+const PROBE_DETAIL_MAX_CHARS = 512;
+function sanitizeProbeDetail(detail: string | undefined): string | undefined {
+ if (!detail) return undefined;
+ return detail
+ .replace(/(authorization|x-api-key|x-goog-api-key)(["'\s:=]+)[^\s"',}]+/gi, '$1$2<redacted>')
+ .slice(0, PROBE_DETAIL_MAX_CHARS);
+}
+
+/**
+ * 「测试连接」失败在主进程留痕(#4954):渲染层只拿到分类码,非鉴权 / 非网络类的 4xx 会落成
+ * 「未知错误,请查看日志」,而此前主进程一行都不写,日志里无迹可循。字段不含路径 / query / 凭证。
+ */
+function logProbeFailure(spec: ProviderProbeSpec, result: ProviderTestResult): ProviderTestResult {
+ if (result.ok) return result;
+ const detail = sanitizeProbeDetail(result.detail);
+ log.warn('provider connection probe failed', {
+ agent: spec.agent,
+ provider: spec.catalogPresetId ?? 'custom',
+ model: spec.modelId,
+ upstream: probeUpstreamOrigin(spec.baseUrl),
+ wireProtocol: spec.wireProtocol ?? spec.api ?? 'default',
+ status: result.status,
+ code: result.code,
+ latencyMs: result.latencyMs,
+ detail,
+ });
+ return detail === result.detail ? result : { ...result, detail };
+}
+
+/** 跑一次探测请求并分类结果。fetch 可注入(单测)。失败一律经 logProbeFailure 留痕。 */
export async function runProviderProbe(
spec: ProviderProbeSpec,
// 默认吃系统代理:探测必须与真实会话同口径,否则代理用户会被误判成「连不通」。
fetchImpl: typeof fetch = outboundFetch,
+): Promise<ProviderTestResult> {
+ const start = Date.now();
+ try {
+ return logProbeFailure(spec, await runProviderProbeUnlogged(spec, fetchImpl));
+ } catch (err) {
+ // 拿到响应头后读首帧时连接中断(readFirstSsePayload 抛错)、请求装配抛错等异常路径
+ // 同样要留痕,否则仍是「未知错误、日志无迹」;异常本身原样抛给 IPC,不改变错误语义。
+ const message = err instanceof Error ? `${err.name}: ${err.message}` : String(err);
+ logProbeFailure(spec, { ok: false, code: 'UNKNOWN', latencyMs: Date.now() - start,
+ detail: `probe threw before classification: ${message}` });
+ throw err;
+ }
+}
+
+async function runProviderProbeUnlogged(
+ spec: ProviderProbeSpec,
+ fetchImpl: typeof fetch,
): Promise<ProviderTestResult> {
if (spec.authMethod === 'none' && !isLoopbackProviderUrl(spec.baseUrl)) {
throw new TypeError('no-auth provider probes require a loopback URL');