Hare/yoi
1
1
Fork 0
Code Actions Packages Releases Activity

feat: add client-hosted external workdirs

Browse Source
This commit is contained in:
Hare
2026-09-22 06:49:15 +09:00
parent dc135ee1de
commit ce9534f3a2
45 changed files with 6024 additions and 311 deletions
Download Patch File Download Diff File Expand all files Collapse all files
web/workspace/src/lib/generated/workdir-api.ts
+5 -3
View File
@@ -5,7 +5,7 @@ export type DiagnosticSeverity = "info" | "warning" | "error";
export type Diagnostic = { code: string, severity: DiagnosticSeverity, message: string, };
export type WorkingDirectoryMaterializerKind = "runtime_git_clone";
export type WorkingDirectoryMaterializerKind = "runtime_git_clone" | "client_hosted_external";
export type WorkingDirectoryStatusKind = "active" | "cleanup_pending" | "corrupted" | "not_found" | "unknown";
@@ -13,11 +13,13 @@ export type WorkingDirectoryCleanupTarget = { kind: string, working_directory_id
export type WorkingDirectoryOccupancy = { runtime_id: string, worker_id: string, display_name: string, linked_at: string, };
export type WorkingDirectorySource = { "kind": "repository", repository_key: string, } | { "kind": "external_grant", grant_id: string, };
export type WorkingDirectorySummary = { working_directory_id: string,
/**
* Optional human-facing label, never a routing key.
*/
display_name?: string | null, repository_key: string, creation_selector?: string | null, creation_ref?: string | null, creation_tree?: string | null, current_selector?: string | null, current_ref?: string | null, current_tree?: string | null, observed_at_epoch_seconds?: number | null, materializer_kind: WorkingDirectoryMaterializerKind, cleanup_target?: WorkingDirectoryCleanupTarget | null, status: WorkingDirectoryStatusKind, cleanliness?: string | null, occupied_by?: WorkingDirectoryOccupancy | null, };
display_name?: string | null, source: WorkingDirectorySource, creation_selector?: string | null, creation_ref?: string | null, creation_tree?: string | null, current_selector?: string | null, current_ref?: string | null, current_tree?: string | null, observed_at_epoch_seconds?: number | null, materializer_kind: WorkingDirectoryMaterializerKind, cleanup_target?: WorkingDirectoryCleanupTarget | null, status: WorkingDirectoryStatusKind, cleanliness?: string | null, occupied_by?: WorkingDirectoryOccupancy | null, };
export type WorkingDirectoryCreateRequest = { runtime_id?: string | null,
/**
@@ -27,6 +29,6 @@ display_name?: string | null, repository_key: string, selector?: string | null,
export type WorkingDirectoryListResponse = { workspace_id: string, items: Array<WorkingDirectorySummary>, diagnostics: Array<Diagnostic>, };
export type WorkingDirectoryDetailResponse = { workspace_id: string, runtime_id: string, item: WorkingDirectorySummary, diagnostics: Array<Diagnostic>, };
export type WorkingDirectoryDetailResponse = { workspace_id: string, runtime_id?: string | null, item: WorkingDirectorySummary, diagnostics: Array<Diagnostic>, };
export type WorkingDirectoryCreateResponse = { workspace_id: string, runtime_id: string, item: WorkingDirectorySummary, diagnostics: Array<Diagnostic>, };
web/workspace/src/lib/generated/worker-launch-api.ts
+4 -2
View File
@@ -7,7 +7,7 @@ export type DiagnosticSeverity = "info" | "warning" | "error";
export type Diagnostic = { code: string, severity: DiagnosticSeverity, message: string, };
export type WorkingDirectoryMaterializerKind = "runtime_git_clone";
export type WorkingDirectoryMaterializerKind = "runtime_git_clone" | "client_hosted_external";
export type WorkingDirectoryStatusKind = "active" | "cleanup_pending" | "corrupted" | "not_found" | "unknown";
@@ -23,11 +23,13 @@ display_name?: string | null, repository_id: string, creation_selector?: string
export type WorkingDirectoryOccupancy = { runtime_id: string, worker_id: string, display_name: string, linked_at: string, };
export type WorkingDirectorySource = { "kind": "repository", repository_key: string, } | { "kind": "external_grant", grant_id: string, };
export type WorkingDirectorySummary = { working_directory_id: string,
/**
* Optional human-facing label, never a routing key.
*/
display_name?: string | null, repository_key: string, creation_selector?: string | null, creation_ref?: string | null, creation_tree?: string | null, current_selector?: string | null, current_ref?: string | null, current_tree?: string | null, observed_at_epoch_seconds?: number | null, materializer_kind: WorkingDirectoryMaterializerKind, cleanup_target?: WorkingDirectoryCleanupTarget | null, status: WorkingDirectoryStatusKind, cleanliness?: string | null, occupied_by?: WorkingDirectoryOccupancy | null, };
display_name?: string | null, source: WorkingDirectorySource, creation_selector?: string | null, creation_ref?: string | null, creation_tree?: string | null, current_selector?: string | null, current_ref?: string | null, current_tree?: string | null, observed_at_epoch_seconds?: number | null, materializer_kind: WorkingDirectoryMaterializerKind, cleanup_target?: WorkingDirectoryCleanupTarget | null, status: WorkingDirectoryStatusKind, cleanliness?: string | null, occupied_by?: WorkingDirectoryOccupancy | null, };
export type WorkerWorkspaceSummary = { visibility: string, identity: string, workspace_id?: string | null, };
web/workspace/src/lib/workspace/api/workdirs.ts
+56 -13
View File
@@ -6,13 +6,14 @@ import type {
WorkingDirectoryDetailResponse,
WorkingDirectoryListResponse,
WorkingDirectoryOccupancy,
WorkingDirectorySource,
WorkingDirectorySummary,
} from "../../generated/workdir-api";
const SUMMARY_KEYS = new Set([
"working_directory_id",
"display_name",
"repository_key",
"source",
"creation_selector",
"creation_ref",
"creation_tree",
@@ -64,13 +65,30 @@ export function parseWorkingDirectoryListResponse(
export function parseWorkingDirectoryDetailResponse(
value: unknown,
): WorkingDirectoryDetailResponse {
return parseDetailLike(value, "Workdir detail response");
const record = parseDetailRecord(value, "Workdir detail response");
const response: WorkingDirectoryDetailResponse = {
workspace_id: stringField(record, "workspace_id"),
item: parseWorkingDirectorySummary(record.item),
diagnostics: arrayField(record, "diagnostics").map(parseDiagnostic),
};
if (record.runtime_id !== undefined) {
response.runtime_id = record.runtime_id === null
? null
: stringField(record, "runtime_id");
}
return response;
}
export function parseWorkingDirectoryCreateResponse(
value: unknown,
): WorkingDirectoryCreateResponse {
return parseDetailLike(value, "Workdir create response");
const record = parseDetailRecord(value, "Workdir create response");
return {
workspace_id: stringField(record, "workspace_id"),
runtime_id: stringField(record, "runtime_id"),
item: parseWorkingDirectorySummary(record.item),
diagnostics: arrayField(record, "diagnostics").map(parseDiagnostic),
};
}
export function validateWorkingDirectoryCreateRequest(
@@ -91,21 +109,15 @@ export function validateWorkingDirectoryCreateRequest(
return request;
}
function parseDetailLike(
function parseDetailRecord(
value: unknown,
label: string,
): WorkingDirectoryDetailResponse {
const record = exactRecord(
): Record<string, unknown> {
return exactRecord(
value,
new Set(["workspace_id", "runtime_id", "item", "diagnostics"]),
label,
);
return {
workspace_id: stringField(record, "workspace_id"),
runtime_id: stringField(record, "runtime_id"),
item: parseWorkingDirectorySummary(record.item),
diagnostics: arrayField(record, "diagnostics").map(parseDiagnostic),
};
}
export function parseWorkingDirectorySummary(
@@ -114,9 +126,10 @@ export function parseWorkingDirectorySummary(
const record = exactRecord(value, SUMMARY_KEYS, "Workdir summary");
const summary: WorkingDirectorySummary = {
working_directory_id: stringField(record, "working_directory_id"),
repository_key: stringField(record, "repository_key"),
source: parseWorkingDirectorySource(record.source),
materializer_kind: enumField(record, "materializer_kind", [
"runtime_git_clone",
"client_hosted_external",
]),
status: enumField(record, "status", [
"active",
@@ -160,6 +173,36 @@ export function parseWorkingDirectorySummary(
return summary;
}
function parseWorkingDirectorySource(value: unknown): WorkingDirectorySource {
const source = exactRecord(
value,
new Set(["kind", "repository_key", "grant_id"]),
"Workdir source",
);
const kind = stringField(source, "kind");
if (kind === "repository") {
if (source.grant_id !== undefined) {
throw new Error("Repository Workdir source must not contain grant_id");
}
return {
kind,
repository_key: stringField(source, "repository_key"),
};
}
if (kind === "external_grant") {
if (source.repository_key !== undefined) {
throw new Error(
"External Workdir source must not contain repository_key",
);
}
return {
kind,
grant_id: stringField(source, "grant_id"),
};
}
throw new Error("Workdir source.kind has an unsupported value");
}
function parseCleanupTarget(value: unknown): WorkingDirectoryCleanupTarget {
const record = exactRecord(
value,
web/workspace/src/lib/workspace/settings/workdir-revision.test.ts
+1 -1
View File
@@ -17,7 +17,7 @@ function workdir(
): WorkingDirectorySummary {
return {
working_directory_id: "workdir-1",
repository_key: "repository-1",
source: { kind: "repository", repository_key: "repository-1" },
current_selector,
current_ref,
materializer_kind: "runtime_git_clone",
web/workspace/src/lib/workspace/sidebar/worker-launch.test.ts
+29 -2
View File
@@ -28,6 +28,33 @@ Deno.test("defaultWorkerLaunchForm uses the Backend-published defaults and initi
assertEquals(form.working_directory_selector, "HEAD");
});
Deno.test("defaultWorkerLaunchForm preserves an available read-only External Workdir", () => {
const external = {
working_directory_id: "external-1",
display_name: "Session analysis",
source: { kind: "external_grant" as const, grant_id: "grant-1" },
materializer_kind: "client_hosted_external" as const,
status: "active" as const,
cleanliness: "unknown",
};
const form = defaultWorkerLaunchForm(
{ ...options, working_directories: [external] },
emptyForm({
workdir_attachments: [{
alias: "sessions",
working_directory_id: "external-1",
relative_cwd: "",
}],
}),
);
assertEquals(form.workdir_attachments, [{
alias: "sessions",
working_directory_id: "external-1",
relative_cwd: "",
}]);
});
Deno.test("defaultWorkerLaunchForm preserves an available Ticket role profile", () => {
const reviewerOptions = {
...options,
@@ -87,7 +114,7 @@ Deno.test("defaultWorkerLaunchForm preserves a Ticket repository target", () =>
{
...options.working_directories[0],
working_directory_id: "ticket-workdir",
repository_key: "ticket-repo",
source: { kind: "repository", repository_key: "ticket-repo" },
creation_selector: "work/ticket",
},
],
@@ -318,7 +345,7 @@ const options: WorkerLaunchOptionsResponse = {
working_directories: [
{
working_directory_id: "wd-1-repo",
repository_key: "repo",
source: { kind: "repository", repository_key: "repo" },
creation_selector: "HEAD",
creation_ref: "0123456789abcdef",
current_selector: null,
web/workspace/src/lib/workspace/sidebar/worker-launch.ts
+8 -3
View File
@@ -40,7 +40,8 @@ export function defaultWorkerLaunchForm(
const availableWorkingDirectories =
options?.working_directories.filter((directory) =>
directory.status === "active" &&
directory.cleanliness === "clean" &&
(directory.source.kind === "external_grant" ||
directory.cleanliness === "clean") &&
directory.occupied_by == null
) ?? [];
const selectedRuntime = current.runtime_id
@@ -54,13 +55,17 @@ export function defaultWorkerLaunchForm(
? undefined
: availableWorkingDirectories.find((directory) =>
Boolean(current.working_directory_repository_key) &&
directory.repository_key === current.working_directory_repository_key &&
directory.source.kind === "repository" &&
directory.source.repository_key ===
current.working_directory_repository_key &&
(!current.working_directory_selector ||
(directory.current_selector ?? directory.creation_selector) ===
current.working_directory_selector)
) ?? availableWorkingDirectories.find((directory) =>
Boolean(current.working_directory_repository_key) &&
directory.repository_key === current.working_directory_repository_key
directory.source.kind === "repository" &&
directory.source.repository_key ===
current.working_directory_repository_key
) ?? (current.working_directory_repository_key
? undefined
: availableWorkingDirectories[0]);
web/workspace/src/lib/workspace/sidebar/worker-workdir-meta.test.ts
+23 -4
View File
@@ -25,7 +25,7 @@ function workdir(
): WorkingDirectorySummary {
return {
working_directory_id: "workdir-1234567890abcdef",
repository_key: "main",
source: { kind: "repository", repository_key: "main" },
materializer_kind: "runtime_git_clone",
status: "active",
...overrides,
@@ -39,7 +39,9 @@ function attachment(
const workingDirectory = workdir(overrides);
return {
alias,
repository_key: workingDirectory.repository_key,
repository_key: workingDirectory.source.kind === "repository"
? workingDirectory.source.repository_key
: null,
working_directory_id: workingDirectory.working_directory_id,
working_directory: workingDirectory,
};
@@ -105,13 +107,30 @@ Deno.test("Worker sidebar Workdir label has an explicit unavailable-projection f
assertEquals(meta.text, "main:unknown@workdir-1234");
});
Deno.test("Worker sidebar Workdir label uses an External Workdir display name without fake repository metadata", () => {
const meta = sidebarWorkdirMeta([
attachment("sessions", {
display_name: "Session analysis",
source: { kind: "external_grant", grant_id: "grant-1" },
materializer_kind: "client_hosted_external",
cleanliness: "unknown",
}),
]);
assertEquals(meta.text, "Session analysis");
assert(
meta.details.includes("sessions — Session analysis"),
"alias should remain visible",
);
});
Deno.test("Worker sidebar Workdir metadata preserves long names for truncated display details", () => {
const repository = "repository-with-a-name-that-exceeds-the-sidebar-width";
const branch =
"feature/workdir-label-with-a-name-that-also-exceeds-the-sidebar-width";
const meta = sidebarWorkdirMeta([
attachment("long-checkout", {
repository_key: repository,
source: { kind: "repository", repository_key: repository },
current_selector: branch,
}),
]);
@@ -128,7 +147,7 @@ Deno.test("Worker sidebar Workdir metadata keeps multiple attachments distinguis
attachment("frontend", { current_selector: "develop" }),
attachment("backend", {
working_directory_id: "workdir-fedcba0987654321",
repository_key: "server",
source: { kind: "repository", repository_key: "server" },
current_selector: "release",
}),
]);
web/workspace/src/lib/workspace/sidebar/worker-workdir-meta.ts
+7 -3
View File
@@ -27,9 +27,13 @@ export function sidebarWorkdirMeta(
function attachmentLabel(attachment: SidebarWorkdirAttachment): string {
const workdir = attachment.working_directory;
const repository = clean(workdir?.repository_key) ??
clean(attachment.repository_key) ?? "unknown-repo";
return `${repository}:${revisionLabel(attachment)}`;
if (workdir?.source.kind === "external_grant") {
return clean(workdir.display_name) ?? "external";
}
const repository = workdir?.source.kind === "repository"
? clean(workdir.source.repository_key)
: clean(attachment.repository_key);
return `${repository ?? "unknown-repo"}:${revisionLabel(attachment)}`;
}
function revisionLabel(attachment: SidebarWorkdirAttachment): string {
web/workspace/src/routes/w/[workspaceId]/settings/runtimes/[runtimeId]/workdirs/+page.svelte
+9 -3
View File
@@ -24,9 +24,15 @@
workdirs = data.workdirs?.items ?? [];
});
function repositoryKey(workdir: WorkingDirectorySummary): string | null {
return workdir.source.kind === 'repository' ? workdir.source.repository_key : null;
}
function repositoryProvider(workdir: WorkingDirectorySummary): string | null {
return data.repositories?.items.find((repository) => repository.repository_key === workdir.repository_key)
?.provider ?? null;
const key = repositoryKey(workdir);
return key
? data.repositories?.items.find((repository) => repository.repository_key === key)?.provider ?? null
: null;
}
function currentRevision(workdir: WorkingDirectorySummary): string {
@@ -142,7 +148,7 @@
<span>{workdir.display_name ?? '—'}</span>
<small><code>{workdir.working_directory_id}</code></small>
</td>
<td>{workdir.repository_key}</td>
<td>{repositoryKey(workdir) ?? 'External'}</td>
<td><code>{currentRevision(workdir)}</code></td>
<td>{workdir.status}</td>
<td>{workdir.cleanliness ?? 'unknown'}</td>
web/workspace/src/routes/w/[workspaceId]/workers/+page.svelte
+7 -3
View File
@@ -148,9 +148,13 @@
const attachments = worker.workdir_attachments ?? [];
if (attachments.length === 0) return '—';
return attachments.map(({ alias, working_directory: directory }) => {
const provider = data.repositories?.items.find((repository) => repository.repository_key === directory.repository_key)
?.provider;
const label = directory.display_name ?? directory.repository_key;
const repositoryKey = directory.source.kind === 'repository'
? directory.source.repository_key
: null;
const provider = repositoryKey
? data.repositories?.items.find((repository) => repository.repository_key === repositoryKey)?.provider
: null;
const label = directory.display_name ?? repositoryKey ?? 'External Workdir';
return `${alias}: ${label} · ${formatCurrentWorkdirRevision(directory, provider)}`;
}).join(', ');
}
web/workspace/src/routes/w/[workspaceId]/workers/new/+page.svelte
+8 -4
View File
@@ -36,9 +36,13 @@
};
function workdirOptionLabel(directory: WorkingDirectorySummary): string {
const provider = data.repositories?.items.find((repository) => repository.repository_key === directory.repository_key)
?.provider;
const label = directory.display_name ?? directory.repository_key;
const repositoryKey = directory.source.kind === 'repository'
? directory.source.repository_key
: null;
const provider = repositoryKey
? data.repositories?.items.find((repository) => repository.repository_key === repositoryKey)?.provider
: null;
const label = directory.display_name ?? repositoryKey ?? 'External Workdir';
return `${label} · ${formatCurrentWorkdirRevision(directory, provider)}`;
}
@@ -83,7 +87,7 @@
? []
: (options?.working_directories ?? []).filter((directory) =>
directory.status === 'active' &&
directory.cleanliness === 'clean' &&
(directory.source.kind === 'external_grant' || directory.cleanliness === 'clean') &&
directory.occupied_by == null
),
);
web/workspace/tests/workdir-api.test.ts
+23 -1
View File
@@ -4,6 +4,7 @@ declare const Deno: {
import {
parseWorkingDirectoryCreateResponse,
parseWorkingDirectoryDetailResponse,
parseWorkingDirectoryListResponse,
validateWorkingDirectoryCreateRequest,
} from "../src/lib/workspace/api/workdirs.ts";
@@ -11,7 +12,7 @@ import {
const summary = {
working_directory_id: "workdir-1",
display_name: "Checkout",
repository_key: "main",
source: { kind: "repository", repository_key: "main" },
materializer_kind: "runtime_git_clone",
status: "active",
occupied_by: {
@@ -46,6 +47,27 @@ Deno.test("Workdir REST validation accepts the generated list and create contrac
}
});
Deno.test("Workdir REST validation accepts External grant sources without Runtime identity", () => {
const detail = parseWorkingDirectoryDetailResponse({
workspace_id: "workspace-a",
item: {
working_directory_id: "external-1",
display_name: "Session analysis",
source: { kind: "external_grant", grant_id: "grant-1" },
materializer_kind: "client_hosted_external",
status: "active",
cleanliness: "unknown",
},
diagnostics: [],
});
if (detail.runtime_id !== undefined) {
throw new Error("External Workdir acquired a fake Runtime identity");
}
if (detail.item.source.kind !== "external_grant") {
throw new Error("External Workdir source was not preserved");
}
});
Deno.test("Workdir REST validation rejects stale response JSON", () => {
let rejected = false;
try {