Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"dev": "tsx watch src/index.ts",
"build": "tsc -p tsconfig.build.json",
"lint": "biome lint .",
"test": "node ../../scripts/test/run.mjs --test-isolation=none 'src/**/*.test.ts' 'tests/**/*.test.ts' && node ../../scripts/test/run.mjs --experimental-test-module-mocks --disable-warning=ExperimentalWarning tests/sandbox-auth.integration.ts tests/decisions.integration.ts tests/space-fs-remote.integration.ts tests/space-fs-stale-stat.integration.ts tests/space-fs-symlink.integration.ts tests/fs-pagination.integration.ts tests/referrals.integration.ts tests/space-invitations.integration.ts tests/slug-history.integration.ts tests/space-turns.integration.ts tests/runtime-approvals.integration.ts",
"test": "node ../../scripts/test/run.mjs --test-isolation=none 'src/**/*.test.ts' 'tests/**/*.test.ts' && node ../../scripts/test/run.mjs --experimental-test-module-mocks --disable-warning=ExperimentalWarning tests/sandbox-auth.integration.ts tests/decisions.integration.ts tests/space-fs-remote.integration.ts tests/space-fs-stale-stat.integration.ts tests/space-fs-symlink.integration.ts tests/fs-pagination.integration.ts tests/checkpoint-meta-visibility.integration.ts tests/referrals.integration.ts tests/space-invitations.integration.ts tests/slug-history.integration.ts tests/space-turns.integration.ts tests/runtime-approvals.integration.ts",
"test:runtime:archives": "node --experimental-test-module-mocks --disable-warning=ExperimentalWarning --import tsx --test tests/runtime-archives.integration.mjs",
"test:runtime:native-sync": "node --experimental-test-module-mocks --disable-warning=ExperimentalWarning --import tsx --test tests/native-turns.integration.mjs",
"lint:fix": "biome lint --write .",
Expand Down
23 changes: 23 additions & 0 deletions apps/api/src/checkpoint-fs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,10 @@ import { checkpoints, spaces } from "@cohub/db";
import { createLogger } from "@cohub/infra/logging";
import { getTracer } from "@cohub/infra/tracing/propagator";
import { isTextMime, mimeTypeForPath, type SpaceFsEntry, type SpaceFsFileResponse, type SpaceFsTreeResponse } from "@cohub/protocol/fs";
import { createSpaceGitignoreFilter, type SpaceFsVisibility, type SpaceGitignoreFilter } from "@cohub/core/space-fs";
import { config } from "./config.js";
import { db } from "./db/index.js";
import { getSpaceRoot } from "./space-fs.js";
import { createPresignedGetObjectUrl } from "./object-presign.js";
import { CheckpointObjectsUnavailableError } from "@cohub/core/checkpoint/storage";
import { ensureCheckpointObjects } from "./checkpoint-storage.js";
Expand Down Expand Up @@ -703,6 +705,11 @@ async function getCachedTree(key: string) {
}
}

// Uses the workspace .gitignore read per request, so a rule added later also hides older checkpoints.
export async function createCheckpointVisibilityFilter(spaceId: string, visibility: SpaceFsVisibility): Promise<SpaceGitignoreFilter | null> {
return visibility === "filtered" ? await createSpaceGitignoreFilter(getSpaceRoot(spaceId)) : null;
}

export async function listCheckpointDirectory(input: { spaceId: string; checkpointId: string; path?: string; pagination?: SpaceFsListOptions }) {
return await observeCheckpointFs("tree", input, async (observation) => {
const path = await observeStage(
Expand Down Expand Up @@ -878,3 +885,19 @@ export function checkpointFsJsonError(error: unknown) {
const message = error instanceof Error ? error.message : "Checkpoint file operation failed.";
return { status: 500, body: { code: "checkpoint_fs_error", message } };
}

// Drops hidden paths and server storage details from a row's meta unless the viewer has the full file view.
// `diffs` is dropped, not filtered: its stats and per-file maps are unfiltered; the filtered /fs/diff routes serve that data.
export async function redactCheckpointForView<T extends { spaceId: string; meta: unknown }>(checkpoint: T, visibility: SpaceFsVisibility | null): Promise<T> {
if (visibility === "full" || !checkpoint.meta || typeof checkpoint.meta !== "object") return checkpoint;
const filter = visibility === "filtered" ? await createCheckpointVisibilityFilter(checkpoint.spaceId, visibility) : null;
const visible = (path: string) => filter !== null && !filter.isIgnored(path);
const meta: Record<string, unknown> = { ...(checkpoint.meta as Record<string, unknown>) };
delete meta.diffs;
delete meta.paths;
delete meta.storage;
if (Array.isArray(meta.warnings)) {
meta.warnings = meta.warnings.filter((warning) => typeof warning?.path !== "string" || visible(warning.path));
}
return { ...checkpoint, meta };
}
8 changes: 8 additions & 0 deletions apps/api/src/permissions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { apps, appViewerGrants, spaceMembers, spaces, type SpaceRole } from "@co
import type { Permission, AccessPolicy, PermissionAccess } from "@cohub/core/permissions";
import type { PreviewSessionPrincipal } from "./preview-sessions.js";
import { hasPreviewSessionPermission } from "./preview-sessions.js";
import type { SpaceFsVisibility } from "@cohub/core/space-fs";
import type { AppSessionPrincipal } from "./app-sessions.js";
import { and, eq } from "drizzle-orm";

Expand Down Expand Up @@ -328,6 +329,13 @@ export async function hasPermission(
});
}

/** Which file view the caller gets: full, filtered by the workspace .gitignore, or none. */
export async function resolveFileViewVisibility(user: AuthUserProfile | null, spaceId: string): Promise<SpaceFsVisibility | null> {
if (await hasPermission(user, "file.view", { spaceId })) return "full";
if (await hasPermission(user, "file.view.filtered", { spaceId })) return "filtered";
return null;
}

export async function getRoleForSpaceUser(spaceId: string, userId: string): Promise<SpaceRole | null> {
return getSpaceMemberRole(spaceId, userId);
}
Expand Down
8 changes: 1 addition & 7 deletions apps/api/src/routes/spaces/fs.route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { FS_CDN_DOWNLOAD_WAIT_TIMEOUT_MS } from "../../space-fs-cdn-constants.js
import { cdnDownloadUrl } from "../../space-fs-cdn-policy.js";
import { getOptionalAuth, useAuth, requireValidId, authzDenied } from "../../lib/middleware.js";
import { jsonWithEtag } from "../../lib/json-etag.js";
import { hasPermission } from "../../permissions.js";
import { hasPermission, resolveFileViewVisibility } from "../../permissions.js";
import { getSpacePendingDiffFile, getSpacePendingDiffSummary } from "../../checkpoint-pending-diff.js";
import { checkpointFsJsonError } from "../../checkpoint-fs.js";
import {
Expand Down Expand Up @@ -151,12 +151,6 @@ const buildUploadDestinationRoot = (destination: SpaceUploadDestination, uploadI
return destination.targetDir ? `/workspace/${destination.targetDir}` : "/workspace";
};

async function resolveFileViewVisibility(user: ReturnType<typeof getOptionalAuth>, spaceId: string): Promise<SpaceFsVisibility | null> {
if (await hasPermission(user, "file.view", { spaceId })) return "full";
if (await hasPermission(user, "file.view.filtered", { spaceId })) return "filtered";
return null;
}

const MAX_COPY_SOURCES = 1000;

type CopyRequest = {
Expand Down
19 changes: 16 additions & 3 deletions apps/api/src/routes/spaces/spaces.route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ import { RUN_COMMAND_TASK_TYPE } from "@cohub/core/commands";
import { normalizeContentBlocks } from "@cohub/core/content/normalize";
import { sanitizePostgresJsonValue } from "@cohub/core/content/sanitize";
import { assignLabelsToSession, parseLabelRefs, parseSessionArchiveFilter, resolveLabelPaths, resolveOrCreateLabelPaths } from "@cohub/core/labels";
import { asAccountIdentity, hasPermission, getSpaceMemberRole, filterSessionsByPermission, isSpaceMember, resolvePermissionAccess } from "../../permissions.js";
import { asAccountIdentity, hasPermission, getSpaceMemberRole, filterSessionsByPermission, isSpaceMember, resolveFileViewVisibility, resolvePermissionAccess } from "../../permissions.js";
import { checkpoints } from "@cohub/db";
import { LogtoUserRequiredError } from "../../user-profiles.js";
import { publicSpacePath, recordSpaceSlugChange, redirectTarget, resolvePublicSpace } from "../../slug-history.js";
Expand All @@ -75,7 +75,9 @@ import {
getCheckpointDiffSummary,
} from "../../checkpoint-diff.js";
import { parseFsPagination } from "../../fs-pagination.js";
import { checkpointFsJsonError, listCheckpointDirectory, readCheckpointFile } from "../../checkpoint-fs.js";
import { checkpointFsJsonError, listCheckpointDirectory, readCheckpointFile, redactCheckpointForView } from "../../checkpoint-fs.js";
import { isLocalSpace } from "../../space-fs-backend.js";
import type { SpaceFsVisibility } from "@cohub/core/space-fs";
import type { AuthUser } from "../../lib/middleware.js";
import { submitSessionPrompt } from "../../session-prompts.js";
import { recordSessionNote } from "../../session-notes.js";
Expand Down Expand Up @@ -1616,9 +1618,20 @@ router.get("/:id/checkpoints/:checkpointId", async (c) => {

if (!checkpoint) return c.json({ message: "checkpoint not found" }, 404);

return c.json({ checkpoint });
// Non-full views lose diff and path metadata; see redactCheckpointForView.
const visibility = await resolveCheckpointFsVisibility(user, spaceId);
return c.json({ checkpoint: await redactCheckpointForView(checkpoint, visibility) });
});

// Checkpoint file views apply the same visibility as the workspace file routes. Filtered views need the
// workspace .gitignore on this server, which local sandboxes do not provide, so those are denied.
async function resolveCheckpointFsVisibility(user: AuthUser | null, spaceId: string): Promise<SpaceFsVisibility | null> {
if (!(await hasPermission(user, "checkpoint.view", { spaceId }))) return null;
const visibility = await resolveFileViewVisibility(user, spaceId);
if (visibility === "filtered" && await isLocalSpace(spaceId)) return null;
return visibility;
}

// In production, these checkpoints/fs routes are routed to fs-api by the gateway.
// This remains a local/non-split fallback.
router.get("/:id/checkpoints/:checkpointId/fs/tree", async (c) => {
Expand Down
109 changes: 109 additions & 0 deletions apps/api/tests/checkpoint-meta-visibility.integration.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
import assert from "node:assert/strict";
import { mkdtemp, mkdir, rm, writeFile } from "node:fs/promises";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { after, mock, test } from "node:test";

process.env.LOG_LEVEL = "silent";
const root = await mkdtemp(join(tmpdir(), "cohub-checkpoint-meta-test-"));
const spaceId = "space";
const workspace = join(root, spaceId, "workspace");
const HIDDEN = ".env";
const VISIBLE = "src/app.ts";
const PATCH_TEXT = "SECRET_PATCH_LINE";
let rows: unknown[] = [];
const mocks = [
mock.module("../src/config.js", { exports: { config: { spaceStorageRoot: root, spaceSystemRoot: root } } }),
mock.module("../src/db/index.js", { exports: { db: {
select: () => ({ from: () => ({ where: () => ({ limit: async () => rows }) }) }),
} } }),
mock.module("../src/redis.js", { exports: { redisCommandClient: {
get: async () => null,
set: async () => undefined,
} } }),
mock.module("../src/object-presign.js", { exports: { createPresignedGetObjectUrl: () => {} } }),
mock.module("../src/checkpoint-storage.js", { exports: { ensureCheckpointObjects: async () => undefined } }),
];
after(async () => { for (const item of mocks.reverse()) item.restore(); await rm(root, { recursive: true, force: true }); });

const summaryFile = (path: string) => ({ path, oldPath: null, status: "A", kind: "text", binary: false, asset: false, additions: 1, deletions: 0, truncated: false, oldSize: null, newSize: 3 });
const patchFile = (path: string) => ({
version: 1,
delivery: "inline",
patch: { ...summaryFile(path), lines: [{ type: "add", text: PATCH_TEXT }] },
});
const checkpoint = {
id: "checkpoint",
spaceId,
commitHash: "a".repeat(40),
description: "save",
parentCheckpointId: null,
rootCheckpointId: null,
forkCount: 0,
createdAt: new Date(0),
meta: {
stats: { changedFileCount: 2 },
paths: { latestSubPath: "cache/space/latest" },
storage: { seq: 3 },
diffs: {
parent: {
version: 1,
kind: "parent",
delivery: "inline",
summary: {
baseCheckpointId: null,
baseCommitHash: null,
headCheckpointId: "checkpoint",
headCommitHash: "a".repeat(40),
files: [summaryFile(HIDDEN), summaryFile(VISIBLE)],
truncated: false,
stats: { changedFileCount: 2, addedFileCount: 2, modifiedFileCount: 0, deletedFileCount: 0, renamedFileCount: 0, copiedFileCount: 0, additions: 2, deletions: 0 },
precomputed: true,
delivery: "inline",
},
files: { [HIDDEN]: patchFile(HIDDEN), [VISIBLE]: patchFile(VISIBLE) },
},
},
warnings: [{ path: HIDDEN, type: "unsupported" }, { path: VISIBLE, type: "unsupported" }, { type: "git_remote" }],
},
};

await mkdir(join(workspace, "src"), { recursive: true });
await writeFile(join(workspace, ".gitignore"), `${HIDDEN}\n`);

const { redactCheckpointForView } = await import("../src/checkpoint-fs.js");
const { getCheckpointDiffSummary } = await import("../src/checkpoint-diff.js");

test("checkpoint row keeps diff patch text only for the full file view", async () => {
assert.deepEqual((await redactCheckpointForView(checkpoint, "full")).meta, checkpoint.meta);
for (const visibility of ["filtered", null] as const) {
const row = await redactCheckpointForView(checkpoint, visibility);
const payload = JSON.stringify(row);
assert.equal(payload.includes(PATCH_TEXT), false);
assert.equal(payload.includes(HIDDEN), false);
assert.equal("diffs" in (row.meta as object), false);
assert.equal("paths" in (row.meta as object), false);
assert.equal("storage" in (row.meta as object), false);
}
assert.deepEqual((await redactCheckpointForView(checkpoint, "filtered")).meta, {
stats: { changedFileCount: 2 },
warnings: [{ path: VISIBLE, type: "unsupported" }, { type: "git_remote" }],
});
assert.deepEqual((await redactCheckpointForView(checkpoint, null)).meta, {
stats: { changedFileCount: 2 },
warnings: [{ type: "git_remote" }],
});
});

test("diff summary payload has paths, status and sizes, never patch lines", async () => {
rows = [checkpoint];
const summary = await getCheckpointDiffSummary({ spaceId, checkpointId: checkpoint.id });
const payload = JSON.stringify(summary);
assert.equal(payload.includes(PATCH_TEXT), false);
assert.equal(payload.includes('"lines"'), false);
assert.equal(summary.precomputed, true);
assert.deepEqual(summary.files.map((file) => file.path), [HIDDEN, VISIBLE]);
for (const file of summary.files) {
assert.deepEqual(Object.keys(file).sort(), ["additions", "asset", "binary", "deletions", "kind", "newSize", "oldPath", "oldSize", "path", "status", "truncated"]);
}
});
Loading