Skip to content

Commit 0360bc2

Browse files
committed
fix(opencode): record discovery failures in existing telemetry
1 parent c963d4c commit 0360bc2

4 files changed

Lines changed: 151 additions & 3 deletions

File tree

‎packages/provider-opencode/src/server/driver.test.ts‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ import * as Deferred from "effect/Deferred";
1212
import * as Effect from "effect/Effect";
1313
import * as Fiber from "effect/Fiber";
1414
import * as Layer from "effect/Layer";
15+
import * as Logger from "effect/Logger";
16+
import * as References from "effect/References";
1517
import * as Stream from "effect/Stream";
1618
import * as TestClock from "effect/testing/TestClock";
1719
import * as HttpClient from "effect/http/HttpClient";
@@ -104,6 +106,12 @@ it.layer(layer)("OpenCodeDriver runtime selection", (it) => {
104106
(initialCatalog) =>
105107
Effect.gen(function* () {
106108
const releaseCatalog = yield* Deferred.make<void>();
109+
const discoveryLogs: Array<Record<string, unknown>> = [];
110+
const logger = Logger.make(({ message, fiber }) => {
111+
if (Array.isArray(message) && message.includes("OpenCode discovery failed")) {
112+
discoveryLogs.push({ ...fiber.getRef(References.CurrentLogAnnotations) });
113+
}
114+
});
107115
let catalogAvailable = false;
108116
let modelReads = 0;
109117
const replies = {
@@ -176,7 +184,7 @@ it.layer(layer)("OpenCodeDriver runtime selection", (it) => {
176184
const instance = yield* create(
177185
{ serverUrl: "http://127.0.0.1:4096", serverPassword: "secret" },
178186
server,
179-
);
187+
).pipe(Effect.provide(Logger.layer([logger], { mergeWithExisting: false })));
180188
const initial = yield* instance.snapshot.streamChanges.pipe(
181189
Stream.filter(
182190
(snapshot) =>
@@ -194,6 +202,13 @@ it.layer(layer)("OpenCodeDriver runtime selection", (it) => {
194202
assert.strictEqual(failed?.auth.status, "unknown");
195203
assert.deepStrictEqual(failed?.models, []);
196204
if (initialCatalog === "probe") assert.strictEqual(failed?.version, null);
205+
assert.strictEqual(discoveryLogs.length, 1);
206+
assert.strictEqual(discoveryLogs[0]?.providerInstanceId, "opencode-test");
207+
assert.strictEqual(discoveryLogs[0]?.serverMode, "external");
208+
assert.strictEqual(
209+
discoveryLogs[0]?.phase,
210+
initialCatalog === "probe" ? "version" : "models",
211+
);
197212

198213
catalogAvailable = true;
199214
const recovered = yield* instance.snapshot.streamChanges.pipe(
@@ -214,6 +229,7 @@ it.layer(layer)("OpenCodeDriver runtime selection", (it) => {
214229
const readsAfterRecovery = modelReads;
215230
yield* TestClock.adjust("15 minutes");
216231
assert.strictEqual(modelReads, readsAfterRecovery);
232+
assert.strictEqual(discoveryLogs.length, 1);
217233
}).pipe(Effect.scoped, Effect.provide(TestClock.layer())),
218234
);
219235

‎packages/provider-opencode/src/server/driver.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,9 @@ export const OpenCodeDriver: ProviderDriver<
350350
host.paths.cwd,
351351
runtimeProbe.refresh,
352352
loadOpenCode2Models,
353+
).pipe(
354+
Effect.annotateLogs({ providerInstanceId: instanceId }),
355+
Effect.annotateSpans({ providerInstanceId: instanceId }),
353356
),
354357
usageLimits: readOpenCodeGoUsageLimits({
355358
enabled: effectiveConfig.enabled,

‎packages/provider-opencode/src/server/status.test.ts‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ import * as Effect from "effect/Effect";
88
import * as Fiber from "effect/Fiber";
99
import * as FileSystem from "effect/FileSystem";
1010
import * as Layer from "effect/Layer";
11+
import * as Logger from "effect/Logger";
1112
import * as Schema from "effect/Schema";
13+
import * as Tracer from "effect/Tracer";
1214
import * as HttpClient from "effect/http/HttpClient";
1315
import * as HttpClientResponse from "effect/http/HttpClientResponse";
1416
import { beforeEach } from "vite-plus/test";
@@ -462,6 +464,83 @@ const checkProvider = Effect.fn("checkProvider")(function* (
462464
});
463465

464466
it.layer(layerTest)("checkOpenCodeProviderStatus", (it) => {
467+
it.effect.each(["version", "inventory", "models", "empty-v1", "empty-v2"] as const)(
468+
"records %s discovery failures in the existing trace and logger",
469+
(failure) =>
470+
Effect.gen(function* () {
471+
const cause = new Error("discovery connection reset");
472+
const v2 = failure === "models" || failure === "empty-v2";
473+
runtimeMock.state.versionStdout = v2 ? "opencode v2.0.18\n" : DEFAULT_VERSION_STDOUT;
474+
if (failure === "version") runtimeMock.state.runVersionError = cause;
475+
if (failure === "inventory") runtimeMock.state.inventoryError = cause;
476+
if (failure === "empty-v1") {
477+
runtimeMock.state.inventory = {
478+
providerList: {
479+
connected: ["openai"],
480+
all: [{ id: "openai", name: "OpenAI", models: {} }],
481+
default: {},
482+
},
483+
agents: [],
484+
skills: [],
485+
};
486+
}
487+
const spans: Array<Tracer.NativeSpan> = [];
488+
yield* checkProvider(
489+
makeOpenCodeSettings({ serverPassword: "private-password" }),
490+
process.cwd(),
491+
undefined,
492+
undefined,
493+
failure === "models"
494+
? Effect.fail(
495+
new OpenCodeRuntime.OpenCodeRuntimeError({
496+
operation: "model.list",
497+
detail: "model list failed",
498+
cause,
499+
}),
500+
)
501+
: Effect.succeed([]),
502+
).pipe(
503+
Effect.provideService(
504+
Tracer.Tracer,
505+
Tracer.make({
506+
span: (options) => {
507+
const span = new Tracer.NativeSpan(options);
508+
spans.push(span);
509+
return span;
510+
},
511+
}),
512+
),
513+
Effect.provide(Logger.layer([Logger.tracerLogger], { mergeWithExisting: false })),
514+
);
515+
516+
const diagnostics = spans.flatMap((span) =>
517+
span.events
518+
.filter(([name]) => name === "OpenCode discovery failed")
519+
.map((event) => ({ span, event })),
520+
);
521+
NodeAssert.equal(diagnostics.length, 1);
522+
const {
523+
span,
524+
event: [, timestamp, attributes],
525+
} = diagnostics[0]!;
526+
NodeAssert.equal(attributes.provider, "opencode");
527+
NodeAssert.equal(
528+
attributes.phase,
529+
failure.startsWith("empty") ? (v2 ? "models" : "inventory") : failure,
530+
);
531+
NodeAssert.equal(attributes.outcome, failure.startsWith("empty") ? "empty" : "failed");
532+
NodeAssert.equal(attributes.serverMode, "managed");
533+
NodeAssert.equal(attributes["effect.logLevel"], "WARN");
534+
NodeAssert.ok(timestamp >= 0n);
535+
NodeAssert.ok(span.traceId.length > 0);
536+
NodeAssert.equal(span.attributes.get("discovery.outcome"), attributes.outcome);
537+
if (!failure.startsWith("empty")) {
538+
NodeAssert.match(String(attributes["effect.cause"]), /discovery connection reset/);
539+
}
540+
NodeAssert.ok(!JSON.stringify(attributes).includes("private-password"));
541+
}),
542+
);
543+
465544
it.effect("keeps an empty legacy catalog retryable until connected providers list models", () =>
466545
Effect.gen(function* () {
467546
const upstream = { id: "openai", name: "OpenAI", models: {} };

‎packages/provider-opencode/src/server/status.ts‎

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,32 @@ function formatOpenCodeProbeError(input: {
143143
};
144144
}
145145

146+
// The status check owns the span; keep handled failures visible without adding another span.
147+
const logDiscoveryFailure = Effect.fnUntraced(function* (input: {
148+
readonly phase: "version" | "inventory" | "models";
149+
readonly isExternalServer: boolean;
150+
readonly version?: string;
151+
readonly cause?: Cause.Cause<unknown>;
152+
}) {
153+
const outcome = input.cause ? "failed" : "empty";
154+
const attributes = {
155+
provider: "opencode",
156+
phase: input.phase,
157+
outcome,
158+
serverMode: input.isExternalServer ? "external" : "managed",
159+
...(input.version === undefined ? {} : { version: input.version }),
160+
};
161+
yield* Effect.annotateCurrentSpan({
162+
"discovery.phase": input.phase,
163+
"discovery.outcome": outcome,
164+
});
165+
yield* (
166+
input.cause
167+
? Effect.logWarning("OpenCode discovery failed", input.cause)
168+
: Effect.logWarning("OpenCode discovery failed")
169+
).pipe(Effect.annotateLogs(attributes));
170+
});
171+
146172
function titleCaseSlug(value: string): string {
147173
const segments: Array<string> = [];
148174
for (const segment of value.split(/[-_/]+/)) {
@@ -598,7 +624,12 @@ const checkOpenCode2 = Effect.fn("checkOpenCode2")(function* (
598624
message,
599625
});
600626
if (result._tag === "Failure") {
601-
yield* Effect.logWarning("OpenCode 2 model list failed", result.cause);
627+
yield* logDiscoveryFailure({
628+
phase: "models",
629+
isExternalServer: settings.serverUrl.trim().length > 0,
630+
version,
631+
cause: result.cause,
632+
});
602633
return buildServerProvider({
603634
presentation: OPENCODE_2_PRESENTATION,
604635
enabled: true,
@@ -612,6 +643,13 @@ const checkOpenCode2 = Effect.fn("checkOpenCode2")(function* (
612643
probe: probe("error", "OpenCode could not load its model list."),
613644
});
614645
}
646+
if (result.value.length === 0) {
647+
yield* logDiscoveryFailure({
648+
phase: "models",
649+
isExternalServer: settings.serverUrl.trim().length > 0,
650+
version,
651+
});
652+
}
615653
const models = providerModelsFromSettings(
616654
markOpenCodeLegacy(
617655
result.value.map((model) => {
@@ -721,7 +759,10 @@ export const checkOpenCodeProviderStatus = Effect.fn("checkOpenCodeProviderStatu
721759
),
722760
),
723761
);
724-
if (probedExit._tag === "Failure") return fallback(Cause.squash(probedExit.cause));
762+
if (probedExit._tag === "Failure") {
763+
yield* logDiscoveryFailure({ phase: "version", isExternalServer, cause: probedExit.cause });
764+
return fallback(Cause.squash(probedExit.cause));
765+
}
725766
const probed = probedExit.value;
726767
if (probed.generation === "v2") {
727768
return yield* checkOpenCode2(openCodeSettings, probed.version, checkedAt, loadOpenCode2Models);
@@ -783,6 +824,12 @@ export const checkOpenCodeProviderStatus = Effect.fn("checkOpenCodeProviderStatu
783824
),
784825
);
785826
if (inventoryExit._tag === "Failure") {
827+
yield* logDiscoveryFailure({
828+
phase: "inventory",
829+
isExternalServer,
830+
version,
831+
cause: inventoryExit.cause,
832+
});
786833
return {
787834
...fallback(Cause.squash(inventoryExit.cause), version, "inventory"),
788835
...installedVersion,
@@ -798,6 +845,9 @@ export const checkOpenCodeProviderStatus = Effect.fn("checkOpenCodeProviderStatu
798845
const skills = openCodeSkillsToServerProviderSkills(inventoryExit.value.skills);
799846
const connectedCount = inventoryExit.value.providerList.connected.length;
800847
const catalogReady = connectedCount > 0 && inventoryModels.length > 0;
848+
if (connectedCount > 0 && inventoryModels.length === 0) {
849+
yield* logDiscoveryFailure({ phase: "inventory", isExternalServer, version });
850+
}
801851
return {
802852
...buildServerProvider({
803853
presentation: OPENCODE_PRESENTATION,

0 commit comments

Comments
 (0)