Skip to content

Commit ab0b36c

Browse files
docs(server): document the OpenCode status-check generator
CodeRabbit docstring coverage on PR #14575 was 50.00% (threshold 80%, two functions across four files). The status-check JSDoc sat above the export, so it did not cover the function* passed to Effect.fn. That comment now precedes the generator. No runtime behavior change. Verification (Node v24.13.1): ./node_modules/.bin/vp test run apps/server/src/provider/Layers/ProviderRegistry.test.ts apps/server/src/provider/Layers/OpenCodeProvider.test.ts Test Files 2 passed (2) Tests 79 passed (79) Duration 3.79s ./node_modules/.bin/vp lint --report-unused-disable-directives apps/server/src/provider/Layers/OpenCodeProvider.ts apps/server/src/provider/Layers/ProviderRegistry.ts exit 0 ./node_modules/.bin/vp fmt --check apps/server/src/provider/Layers/OpenCodeProvider.ts exit 0 (all matched files use the correct format) ./node_modules/.bin/vp run --filter t3 typecheck exit 0 (pre-existing suggestions only in CodexInstallation.ts, CodexAdapter.test.ts, CodexProvider.ts, and ws.ts; none in these files) Model: Grok 4.7 via Cursor cloud agent Co-authored-by: maco <[email protected]>
1 parent 3170be9 commit ab0b36c

1 file changed

Lines changed: 182 additions & 177 deletions

File tree

‎apps/server/src/provider/Layers/OpenCodeProvider.ts‎

Lines changed: 182 additions & 177 deletions
Original file line numberDiff line numberDiff line change
@@ -488,197 +488,202 @@ export const makePendingOpenCodeProvider = (
488488
});
489489
});
490490

491-
/**
492-
* Checks OpenCode once and returns its provider snapshot. A local install
493-
* runs `--version` under `resolveOpenCodeVersionProbeTimeout` before loading
494-
* inventory; a timeout is reported with `openCodeVersionProbeTimeoutDetail`.
495-
* A configured server URL skips that CLI probe and connects directly.
496-
*/
497-
export const checkOpenCodeProviderStatus = Effect.fn("checkOpenCodeProviderStatus")(function* (
498-
openCodeSettings: OpenCodeSettings,
499-
cwd: string,
500-
environment?: NodeJS.ProcessEnv,
501-
): Effect.fn.Return<
502-
ServerProviderDraft,
503-
never,
504-
OpenCodeRuntime | OpenCodeServerOwner.OpenCodeServerOwner
505-
> {
506-
const openCodeRuntime = yield* OpenCodeRuntime;
507-
const serverOwner = yield* OpenCodeServerOwner.OpenCodeServerOwner;
508-
const resolvedEnvironment = environment ?? process.env;
509-
const versionProbeTimeout = resolveOpenCodeVersionProbeTimeout(resolvedEnvironment);
510-
const versionProbeTimeoutLabel = formatOpenCodeVersionProbeTimeout(versionProbeTimeout);
511-
const checkedAt = DateTime.formatIso(yield* DateTime.now);
512-
const customModels = openCodeSettings.customModels;
513-
const isExternalServer = openCodeSettings.serverUrl.trim().length > 0;
514-
515-
const fallback = (
516-
cause: unknown,
517-
version: string | null = null,
518-
phase: "version" | "inventory" = "version",
519-
) => {
520-
const failure = formatOpenCodeProbeError({
521-
cause,
522-
isExternalServer,
523-
phase,
524-
serverUrl: openCodeSettings.serverUrl,
525-
});
526-
return buildServerProvider({
527-
presentation: OPENCODE_PRESENTATION,
528-
enabled: openCodeSettings.enabled,
529-
checkedAt,
530-
models: providerModelsFromSettings([], customModels, DEFAULT_OPENCODE_MODEL_CAPABILITIES),
531-
probe: {
532-
installed: failure.installed,
533-
version,
534-
status: "error",
535-
auth: { status: "unknown" },
536-
message: failure.message,
537-
},
538-
});
539-
};
540-
541-
if (!openCodeSettings.enabled) {
542-
return buildServerProvider({
543-
presentation: OPENCODE_PRESENTATION,
544-
enabled: false,
545-
checkedAt,
546-
models: providerModelsFromSettings([], customModels, DEFAULT_OPENCODE_MODEL_CAPABILITIES),
547-
probe: {
548-
installed: false,
549-
version: null,
550-
status: "warning",
551-
auth: { status: "unknown" },
552-
message: isExternalServer
553-
? "OpenCode is disabled in T3 Code settings. A server URL is configured."
554-
: "OpenCode is disabled in T3 Code settings.",
555-
},
556-
});
557-
}
558-
559-
let version: string | null = null;
560-
if (!isExternalServer) {
561-
const versionExit = yield* Effect.exit(
562-
openCodeRuntime
563-
.runOpenCodeCommand({
564-
binaryPath: openCodeSettings.binaryPath,
565-
args: ["--version"],
566-
environment: resolvedEnvironment,
567-
})
568-
.pipe(
569-
Effect.mapError(
570-
(cause) => new OpenCodeProbeError({ cause, detail: openCodeRuntimeErrorDetail(cause) }),
571-
),
572-
Effect.timeoutOrElse({
573-
duration: versionProbeTimeout,
574-
orElse: () =>
575-
Effect.fail(
576-
new OpenCodeProbeError({
577-
detail: openCodeVersionProbeTimeoutDetail(versionProbeTimeoutLabel),
578-
}),
579-
),
580-
}),
581-
),
582-
);
583-
if (versionExit._tag === "Failure") {
584-
return fallback(Cause.squash(versionExit.cause));
585-
}
586-
version = parseGenericCliVersion(versionExit.value.stdout) ?? null;
587-
588-
if (!version) {
589-
return fallback(
590-
new Error(
591-
`Unable to determine OpenCode version from \`opencode --version\` output. T3 Code requires OpenCode v${MINIMUM_OPENCODE_VERSION} or newer.`,
592-
),
593-
null,
594-
);
595-
}
596-
if (compareSemverVersions(version, MINIMUM_OPENCODE_VERSION) < 0) {
491+
export const checkOpenCodeProviderStatus = Effect.fn("checkOpenCodeProviderStatus")(
492+
/**
493+
* Checks OpenCode once and returns its provider snapshot. A local install
494+
* runs `--version` under `resolveOpenCodeVersionProbeTimeout` before loading
495+
* inventory; a timeout is reported with `openCodeVersionProbeTimeoutDetail`.
496+
* A configured server URL skips that CLI probe and connects directly.
497+
*/
498+
function* (
499+
openCodeSettings: OpenCodeSettings,
500+
cwd: string,
501+
environment?: NodeJS.ProcessEnv,
502+
): Effect.fn.Return<
503+
ServerProviderDraft,
504+
never,
505+
OpenCodeRuntime | OpenCodeServerOwner.OpenCodeServerOwner
506+
> {
507+
const openCodeRuntime = yield* OpenCodeRuntime;
508+
const serverOwner = yield* OpenCodeServerOwner.OpenCodeServerOwner;
509+
const resolvedEnvironment = environment ?? process.env;
510+
const versionProbeTimeout = resolveOpenCodeVersionProbeTimeout(resolvedEnvironment);
511+
const versionProbeTimeoutLabel = formatOpenCodeVersionProbeTimeout(versionProbeTimeout);
512+
const checkedAt = DateTime.formatIso(yield* DateTime.now);
513+
const customModels = openCodeSettings.customModels;
514+
const isExternalServer = openCodeSettings.serverUrl.trim().length > 0;
515+
516+
const fallback = (
517+
cause: unknown,
518+
version: string | null = null,
519+
phase: "version" | "inventory" = "version",
520+
) => {
521+
const failure = formatOpenCodeProbeError({
522+
cause,
523+
isExternalServer,
524+
phase,
525+
serverUrl: openCodeSettings.serverUrl,
526+
});
597527
return buildServerProvider({
598528
presentation: OPENCODE_PRESENTATION,
599529
enabled: openCodeSettings.enabled,
600530
checkedAt,
601531
models: providerModelsFromSettings([], customModels, DEFAULT_OPENCODE_MODEL_CAPABILITIES),
602532
probe: {
603-
installed: true,
533+
installed: failure.installed,
604534
version,
605535
status: "error",
606536
auth: { status: "unknown" },
607-
message: `OpenCode v${version} is too old. Upgrade to v${MINIMUM_OPENCODE_VERSION} or newer.`,
537+
message: failure.message,
538+
},
539+
});
540+
};
541+
542+
if (!openCodeSettings.enabled) {
543+
return buildServerProvider({
544+
presentation: OPENCODE_PRESENTATION,
545+
enabled: false,
546+
checkedAt,
547+
models: providerModelsFromSettings([], customModels, DEFAULT_OPENCODE_MODEL_CAPABILITIES),
548+
probe: {
549+
installed: false,
550+
version: null,
551+
status: "warning",
552+
auth: { status: "unknown" },
553+
message: isExternalServer
554+
? "OpenCode is disabled in T3 Code settings. A server URL is configured."
555+
: "OpenCode is disabled in T3 Code settings.",
608556
},
609557
});
610558
}
611-
}
612559

613-
const loadInventory = (server: {
614-
readonly url: string;
615-
readonly serverPassword?: string;
616-
readonly version: string;
617-
}) =>
618-
openCodeRuntime
619-
.loadOpenCodeInventory(
620-
openCodeRuntime.createOpenCodeSdkClient({
621-
baseUrl: server.url,
622-
directory: cwd,
623-
...(server.serverPassword !== undefined ? { serverPassword: server.serverPassword } : {}),
624-
}),
625-
)
626-
.pipe(Effect.map((inventory) => ({ inventory, version: server.version })));
627-
const inventoryEffect = isExternalServer
628-
? openCodeRuntime
629-
.connectToOpenCodeServer({
630-
binaryPath: openCodeSettings.binaryPath,
631-
directory: cwd,
632-
serverUrl: openCodeSettings.serverUrl,
633-
...(openCodeSettings.serverPassword
634-
? { serverPassword: openCodeSettings.serverPassword }
635-
: {}),
636-
})
637-
.pipe(Effect.flatMap(loadInventory), Effect.scoped)
638-
: serverOwner.withServer(loadInventory);
639-
const inventoryExit = yield* Effect.exit(
640-
inventoryEffect.pipe(
641-
Effect.mapError(
642-
(cause) => new OpenCodeProbeError({ cause, detail: openCodeRuntimeErrorDetail(cause) }),
560+
let version: string | null = null;
561+
if (!isExternalServer) {
562+
const versionExit = yield* Effect.exit(
563+
openCodeRuntime
564+
.runOpenCodeCommand({
565+
binaryPath: openCodeSettings.binaryPath,
566+
args: ["--version"],
567+
environment: resolvedEnvironment,
568+
})
569+
.pipe(
570+
Effect.mapError(
571+
(cause) =>
572+
new OpenCodeProbeError({ cause, detail: openCodeRuntimeErrorDetail(cause) }),
573+
),
574+
Effect.timeoutOrElse({
575+
duration: versionProbeTimeout,
576+
orElse: () =>
577+
Effect.fail(
578+
new OpenCodeProbeError({
579+
detail: openCodeVersionProbeTimeoutDetail(versionProbeTimeoutLabel),
580+
}),
581+
),
582+
}),
583+
),
584+
);
585+
if (versionExit._tag === "Failure") {
586+
return fallback(Cause.squash(versionExit.cause));
587+
}
588+
version = parseGenericCliVersion(versionExit.value.stdout) ?? null;
589+
590+
if (!version) {
591+
return fallback(
592+
new Error(
593+
`Unable to determine OpenCode version from \`opencode --version\` output. T3 Code requires OpenCode v${MINIMUM_OPENCODE_VERSION} or newer.`,
594+
),
595+
null,
596+
);
597+
}
598+
if (compareSemverVersions(version, MINIMUM_OPENCODE_VERSION) < 0) {
599+
return buildServerProvider({
600+
presentation: OPENCODE_PRESENTATION,
601+
enabled: openCodeSettings.enabled,
602+
checkedAt,
603+
models: providerModelsFromSettings([], customModels, DEFAULT_OPENCODE_MODEL_CAPABILITIES),
604+
probe: {
605+
installed: true,
606+
version,
607+
status: "error",
608+
auth: { status: "unknown" },
609+
message: `OpenCode v${version} is too old. Upgrade to v${MINIMUM_OPENCODE_VERSION} or newer.`,
610+
},
611+
});
612+
}
613+
}
614+
615+
const loadInventory = (server: {
616+
readonly url: string;
617+
readonly serverPassword?: string;
618+
readonly version: string;
619+
}) =>
620+
openCodeRuntime
621+
.loadOpenCodeInventory(
622+
openCodeRuntime.createOpenCodeSdkClient({
623+
baseUrl: server.url,
624+
directory: cwd,
625+
...(server.serverPassword !== undefined
626+
? { serverPassword: server.serverPassword }
627+
: {}),
628+
}),
629+
)
630+
.pipe(Effect.map((inventory) => ({ inventory, version: server.version })));
631+
const inventoryEffect = isExternalServer
632+
? openCodeRuntime
633+
.connectToOpenCodeServer({
634+
binaryPath: openCodeSettings.binaryPath,
635+
directory: cwd,
636+
serverUrl: openCodeSettings.serverUrl,
637+
...(openCodeSettings.serverPassword
638+
? { serverPassword: openCodeSettings.serverPassword }
639+
: {}),
640+
})
641+
.pipe(Effect.flatMap(loadInventory), Effect.scoped)
642+
: serverOwner.withServer(loadInventory);
643+
const inventoryExit = yield* Effect.exit(
644+
inventoryEffect.pipe(
645+
Effect.mapError(
646+
(cause) => new OpenCodeProbeError({ cause, detail: openCodeRuntimeErrorDetail(cause) }),
647+
),
643648
),
644-
),
645-
);
646-
if (inventoryExit._tag === "Failure") {
647-
return fallback(Cause.squash(inventoryExit.cause), version, "inventory");
648-
}
649+
);
650+
if (inventoryExit._tag === "Failure") {
651+
return fallback(Cause.squash(inventoryExit.cause), version, "inventory");
652+
}
649653

650-
version = inventoryExit.value.version;
654+
version = inventoryExit.value.version;
651655

652-
const models = providerModelsFromSettings(
653-
flattenOpenCodeModels(inventoryExit.value.inventory),
654-
customModels,
655-
DEFAULT_OPENCODE_MODEL_CAPABILITIES,
656-
);
657-
const skills = openCodeSkillsToServerProviderSkills(inventoryExit.value.inventory.skills);
658-
const connectedCount = inventoryExit.value.inventory.providerList.connected.length;
659-
return buildServerProvider({
660-
presentation: OPENCODE_PRESENTATION,
661-
enabled: true,
662-
checkedAt,
663-
models,
664-
skills,
665-
slashCommands: openCodeCommandsToServerProviderSlashCommands(
666-
inventoryExit.value.inventory.commands,
667-
),
668-
probe: {
669-
installed: true,
670-
version,
671-
status: connectedCount > 0 ? "ready" : "warning",
672-
auth: {
673-
status: connectedCount > 0 ? "authenticated" : "unknown",
674-
type: "opencode",
656+
const models = providerModelsFromSettings(
657+
flattenOpenCodeModels(inventoryExit.value.inventory),
658+
customModels,
659+
DEFAULT_OPENCODE_MODEL_CAPABILITIES,
660+
);
661+
const skills = openCodeSkillsToServerProviderSkills(inventoryExit.value.inventory.skills);
662+
const connectedCount = inventoryExit.value.inventory.providerList.connected.length;
663+
return buildServerProvider({
664+
presentation: OPENCODE_PRESENTATION,
665+
enabled: true,
666+
checkedAt,
667+
models,
668+
skills,
669+
slashCommands: openCodeCommandsToServerProviderSlashCommands(
670+
inventoryExit.value.inventory.commands,
671+
),
672+
probe: {
673+
installed: true,
674+
version,
675+
status: connectedCount > 0 ? "ready" : "warning",
676+
auth: {
677+
status: connectedCount > 0 ? "authenticated" : "unknown",
678+
type: "opencode",
679+
},
680+
message:
681+
connectedCount > 0
682+
? `${connectedCount} upstream provider${connectedCount === 1 ? "" : "s"} connected through ${isExternalServer ? "the configured OpenCode server" : "OpenCode"}.`
683+
: isExternalServer
684+
? "Connected to the configured OpenCode server, but it did not report any connected upstream providers."
685+
: "OpenCode is available, but it did not report any connected upstream providers.",
675686
},
676-
message:
677-
connectedCount > 0
678-
? `${connectedCount} upstream provider${connectedCount === 1 ? "" : "s"} connected through ${isExternalServer ? "the configured OpenCode server" : "OpenCode"}.`
679-
: isExternalServer
680-
? "Connected to the configured OpenCode server, but it did not report any connected upstream providers."
681-
: "OpenCode is available, but it did not report any connected upstream providers.",
682-
},
683-
});
684-
});
687+
});
688+
},
689+
);

0 commit comments

Comments
 (0)