Files
paperclip/packages/shared/src/workspace-commands.ts
T
Dotta fee514efcb [codex] Improve workspace navigation and runtime UI (#4089)
## Thinking Path

> - Paperclip agents do real work in project and execution workspaces.
> - Operators need workspace state to be visible, navigable, and
copyable without digging through raw run logs.
> - The branch included related workspace cards, navigation, runtime
controls, stale-service handling, and issue-property visibility.
> - These changes share the workspace UI and runtime-control surfaces
and can stand alone from unrelated access/profile work.
> - This pull request groups the workspace experience changes into one
standalone branch.
> - The benefit is a clearer workspace overview, better metadata copy
flows, and more accurate runtime service controls.

## What Changed

- Polished project workspace summary cards and made workspace metadata
copyable.
- Added a workspace navigation overview and extracted reusable project
workspace content.
- Squared and polished the execution workspace configuration page.
- Fixed stale workspace command matching and hid stopped stale services
in runtime controls.
- Showed live workspace service context in issue properties.

## Verification

- `pnpm install --frozen-lockfile`
- `pnpm exec vitest run
ui/src/components/ProjectWorkspaceSummaryCard.test.tsx
ui/src/lib/project-workspaces-tab.test.ts
ui/src/components/Sidebar.test.tsx
ui/src/components/WorkspaceRuntimeControls.test.tsx
ui/src/components/IssueProperties.test.tsx`
- `pnpm exec vitest run packages/shared/src/workspace-commands.test.ts
--config /dev/null` because the root Vitest project config does not
currently include `packages/shared` tests.
- Split integration check: merged after runtime/governance,
dev-infra/backups, and access/profiles with no merge conflicts.
- Confirmed this branch does not include `pnpm-lock.yaml`.

## Risks

- Medium risk: touches workspace navigation, runtime controls, and issue
property rendering.
- Visual layout changes may need browser QA, especially around smaller
screens and dense workspace metadata.
- No database migrations are included.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

- OpenAI Codex, GPT-5.4 tool-enabled coding model, agentic
code-editing/runtime with local shell and GitHub CLI access; exact
context window and reasoning mode are not exposed by the Paperclip
harness.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] If this change affects the UI, I have included before/after
screenshots
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-04-20 06:14:32 -05:00

209 lines
6.7 KiB
TypeScript

import type { WorkspaceCommandDefinition, WorkspaceRuntimeService } from "./types/workspace-runtime.js";
function isRecord(value: unknown): value is Record<string, unknown> {
return typeof value === "object" && value !== null && !Array.isArray(value);
}
function readNonEmptyString(value: unknown): string | null {
if (typeof value !== "string") return null;
const trimmed = value.trim();
return trimmed.length > 0 ? trimmed : null;
}
function slugify(value: string | null | undefined) {
const normalized = (value ?? "")
.trim()
.toLowerCase()
.replace(/[^a-z0-9]+/g, "-")
.replace(/-+/g, "-")
.replace(/^-+|-+$/g, "");
return normalized.length > 0 ? normalized : null;
}
function deriveWorkspaceCommandId(input: {
kind: WorkspaceCommandDefinition["kind"];
explicitId: string | null;
name: string;
index: number;
}) {
const explicitId = slugify(input.explicitId);
if (explicitId) return explicitId;
const nameSlug = slugify(input.name);
return nameSlug ? `${input.kind}:${nameSlug}` : `${input.kind}:${input.index + 1}`;
}
function buildWorkspaceCommandDefinition(input: {
entry: Record<string, unknown>;
kind: WorkspaceCommandDefinition["kind"];
sourceKey: WorkspaceCommandDefinition["source"]["key"];
sourceIndex: number;
serviceIndex: number | null;
fallbackName: string;
}): WorkspaceCommandDefinition {
return {
id: deriveWorkspaceCommandId({
kind: input.kind,
explicitId: readNonEmptyString(input.entry.id),
name:
readNonEmptyString(input.entry.name)
?? readNonEmptyString(input.entry.label)
?? readNonEmptyString(input.entry.title)
?? input.fallbackName,
index: input.sourceIndex,
}),
name:
readNonEmptyString(input.entry.name)
?? readNonEmptyString(input.entry.label)
?? readNonEmptyString(input.entry.title)
?? input.fallbackName,
kind: input.kind,
command: readNonEmptyString(input.entry.command),
cwd: readNonEmptyString(input.entry.cwd),
lifecycle:
input.kind === "service"
? input.entry.lifecycle === "ephemeral"
? "ephemeral"
: "shared"
: null,
serviceIndex: input.serviceIndex,
disabledReason: readNonEmptyString(input.entry.disabledReason),
rawConfig: { ...input.entry },
source: {
type: "paperclip",
key: input.sourceKey,
index: input.sourceIndex,
},
};
}
function uniqueWorkspaceCommandId(
seen: Set<string>,
commandId: string,
sourceKey: WorkspaceCommandDefinition["source"]["key"],
sourceIndex: number,
) {
if (!seen.has(commandId)) {
seen.add(commandId);
return commandId;
}
const fallbackId = `${commandId}-${sourceKey}-${sourceIndex + 1}`;
seen.add(fallbackId);
return fallbackId;
}
function readCommandEntries(
workspaceRuntime: Record<string, unknown> | null | undefined,
key: "commands" | "services" | "jobs",
) {
const raw = workspaceRuntime?.[key];
return Array.isArray(raw) ? raw.filter((entry): entry is Record<string, unknown> => isRecord(entry)) : [];
}
export function listWorkspaceCommandDefinitions(
workspaceRuntime: Record<string, unknown> | null | undefined,
): WorkspaceCommandDefinition[] {
if (!workspaceRuntime) return [];
const commandEntries = readCommandEntries(workspaceRuntime, "commands");
const seenIds = new Set<string>();
let nextServiceIndex = 0;
const finalize = (command: WorkspaceCommandDefinition) => ({
...command,
id: uniqueWorkspaceCommandId(seenIds, command.id, command.source.key, command.source.index),
});
if (commandEntries.length > 0) {
return commandEntries.map((entry, index) =>
finalize(buildWorkspaceCommandDefinition({
entry,
kind: entry.kind === "job" ? "job" : "service",
sourceKey: "commands",
sourceIndex: index,
serviceIndex: entry.kind === "job" ? null : nextServiceIndex++,
fallbackName: entry.kind === "job" ? `Job ${index + 1}` : `Service ${index + 1}`,
})));
}
const serviceDefinitions = readCommandEntries(workspaceRuntime, "services").map((entry, index) =>
finalize(buildWorkspaceCommandDefinition({
entry,
kind: "service",
sourceKey: "services",
sourceIndex: index,
serviceIndex: nextServiceIndex++,
fallbackName: `Service ${index + 1}`,
})));
const jobDefinitions = readCommandEntries(workspaceRuntime, "jobs").map((entry, index) =>
finalize(buildWorkspaceCommandDefinition({
entry,
kind: "job",
sourceKey: "jobs",
sourceIndex: index,
serviceIndex: null,
fallbackName: `Job ${index + 1}`,
})));
return [...serviceDefinitions, ...jobDefinitions];
}
export function listWorkspaceServiceCommandDefinitions(
workspaceRuntime: Record<string, unknown> | null | undefined,
) {
return listWorkspaceCommandDefinitions(workspaceRuntime).filter((command) => command.kind === "service");
}
export function findWorkspaceCommandDefinition(
workspaceRuntime: Record<string, unknown> | null | undefined,
workspaceCommandId: string | null | undefined,
) {
const normalizedId = readNonEmptyString(workspaceCommandId);
if (!normalizedId) return null;
return listWorkspaceCommandDefinitions(workspaceRuntime).find((command) => command.id === normalizedId) ?? null;
}
export function scoreWorkspaceRuntimeServiceMatch(
command: Pick<WorkspaceCommandDefinition, "serviceIndex" | "name" | "command" | "cwd">,
runtimeService: Pick<WorkspaceRuntimeService, "configIndex" | "serviceName" | "command" | "cwd">,
) {
if (command.command && runtimeService.command && runtimeService.command !== command.command) {
return -1;
}
if (command.serviceIndex !== null && runtimeService.configIndex !== null && runtimeService.configIndex !== undefined) {
return runtimeService.configIndex === command.serviceIndex ? 100 : -1;
}
let score = 0;
if (runtimeService.serviceName === command.name) score += 4;
if ((runtimeService.command ?? null) === (command.command ?? null)) score += 4;
if (
command.cwd
&& runtimeService.cwd
&& (runtimeService.cwd === command.cwd || runtimeService.cwd.endsWith(`/${command.cwd}`))
) {
score += 2;
}
return score;
}
export function matchWorkspaceRuntimeServiceToCommand<
T extends Pick<WorkspaceRuntimeService, "configIndex" | "serviceName" | "command" | "cwd">,
>(
command: Pick<WorkspaceCommandDefinition, "serviceIndex" | "name" | "command" | "cwd">,
runtimeServices: T[] | null | undefined,
) {
let bestMatch: T | null = null;
let bestScore = -1;
for (const runtimeService of runtimeServices ?? []) {
const score = scoreWorkspaceRuntimeServiceMatch(command, runtimeService);
if (score > bestScore) {
bestMatch = runtimeService;
bestScore = score;
}
}
return bestScore > 0 ? bestMatch : null;
}