feat: resolve Phase 1 contract requests and compose every feature

Contracts and core:
- Feature gains auth and stop; FeatureFactory; core composeServer builds the
  context, runs the factories, then the job queue from the union of their jobs
  (R8/R14). startServer uses it; main.ts composes learner, import, studio, AI.
- AppConfig/loadConfig own the layout and settings: courseDirs include
  <dataDir>/courses and <dataDir>/worktrees, studioReposDir, cacheDir,
  importRoots, uploadMaxMb, aiAllowedBaseUrls, transcribeUrl, python.
  resolveConfig derives the same for tests; cachePaths shares the importer's
  cache layout.
- canView: the global author role views every course (R14); the learner,
  studio and AI packages all call it.
- migrate(db, packages): core first, then packages in name order.
- Media: nosniff on every response, a sandbox CSP on svg/html/js; a Range on
  an empty file is 416.
- courseUrl/lessonUrl and the lesson route patterns live in @stc/contracts.

Packages:
- import, studio and AI read AppConfig instead of process.env; the importer
  refuses ids used by studio/repos.
- learner migrations run through core migrate; library covers fall back to
  the importer's cached candidate behind a canView-checked route.
- studio preview renders through the learner LessonView (anchors honoured,
  draft URLs); AI drafts go to the studio draft branch for studio courses (as
  the requesting user) and to <dataDir>/drafts otherwise, and the generator
  page says which.

Web: tsconfig paths for @stc/<feature>/web browser entries; features.ts
imports them by package name; nav.roles hides links by role.

Tests: compose, config, canView, media headers, migrations order, covers,
preview, nav, SPA bundle without server code, and an end-to-end flow on
SQLite and Postgres.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Lucas WintherandClaude Opus 5.5 committed 2026-10-30 15:02:46 +01:00
1 parent 427eda6e93
commit 777ae2cc37
72 files changed
+1066 -244

No files matched your search

+6 -1
View File
@@ -6,12 +6,17 @@ import { serveMedia } from "./media";
type Method = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
export type Routes = Record<string, Partial<Record<Method, (req: Request) => Response | Promise<Response>>>>;
/**
* The one visibility rule (ruling R14). Every package calls this; none keeps a local variant.
* public: everyone; signed-in: any signed-in user; restricted: the owner, the global `author` role, a per-course
* author (`isAuthor`, a course_authors row), or an ACL grant to the user or one of their groups.
*/
export function canView(user: AuthUser | null, course: LoadedCourse, acl: { principal_type: string; principal_id: string }[], isAuthor = false): boolean {
const vis = course.manifest?.visibility ?? "restricted";
if (vis === "public") return true;
if (!user) return false;
if (vis === "signed-in") return true;
if (user.roles.includes("owner") || isAuthor) return true;
if (user.roles.includes("owner") || user.roles.includes("author") || isAuthor) return true;
return acl.some((a) => (a.principal_type === "user" && a.principal_id === user.id) || (a.principal_type === "group" && user.groups.includes(a.principal_id)));
}
+75
View File
@@ -0,0 +1,75 @@
import type { AppConfig, AuthService, Feature, FeatureFactory, JobHandler, JobQueue, ServerContext } from "@stc/contracts";
import { createCourseRepository } from "@stc/course-format";
import { connect, migrate, type PackageMigrations } from "@stc/db";
import { createApp } from "./app";
import { createJobQueue } from "./jobs";
/** Used until a feature supplies an `auth` service (the learner package does). */
const anonymousAuth: AuthService = { userFromRequest: async () => null };
export interface ComposeOptions {
/** Each package's migration folders, keyed by package name; run after core's, in name order. */
migrations?: PackageMigrations;
/** Start polling the job queue (default true). */
startJobs?: boolean;
}
export interface ComposedServer {
ctx: ServerContext;
features: Feature[];
app: ReturnType<typeof createApp>;
stop(): Promise<void>;
}
/**
* Builds the server context and the features (rulings R8/R14). Order:
* 1. connect and migrate (core, then packages);
* 2. load courses from `config.courseDirs`;
* 3. run each factory with the context. `ctx.jobs` already exists as a handle, but it forwards to the real queue,
* which is built in step 4 from the union of the features' `jobs`, so factories may keep it but must not
* enqueue while they run;
* 4. a feature carrying `auth` replaces the anonymous AuthService (at most one may).
*/
export async function composeServer(config: AppConfig, entries: (Feature | FeatureFactory)[], opts: ComposeOptions = {}): Promise<ComposedServer> {
const db = await connect(config.databaseUrl);
try {
await migrate(db, opts.migrations ?? {});
const courses = await createCourseRepository(config.courseDirs);
let queue: (JobQueue & { start(): void; stop(): Promise<void> }) | null = null;
const notYet = (): never => { throw new Error("the job queue is not ready while features are being built"); };
const jobs: JobQueue = {
enqueue: (kind, payload) => (queue ?? notYet()).enqueue(kind, payload),
get: (id) => (queue ?? notYet()).get(id),
list: (kind) => (queue ?? notYet()).list(kind),
};
const ctx: ServerContext = { config, db, courses, jobs, auth: anonymousAuth };
const features = entries.map((f) => (typeof f === "function" ? f(ctx) : f));
const handlers: Record<string, JobHandler> = {};
let authFrom: string | null = null;
for (const f of features) {
for (const [kind, h] of Object.entries(f.jobs ?? {})) {
if (handlers[kind]) throw new Error(`Duplicate job kind "${kind}" (feature "${f.name}")`);
handlers[kind] = h;
}
if (f.auth) {
if (authFrom) throw new Error(`Both "${authFrom}" and "${f.name}" supply an AuthService`);
authFrom = f.name;
ctx.auth = f.auth;
}
}
queue = createJobQueue(db, handlers);
const app = createApp(ctx, features);
if (opts.startJobs !== false) queue.start();
return {
ctx, features, app,
async stop() {
for (const f of features) { try { await f.stop?.(); } catch (e) { console.error(`[stc] stopping ${f.name}`, e); } }
await queue!.stop();
await db.close();
},
};
} catch (e) {
await db.close().catch(() => {});
throw e;
}
}
+72 -3
View File
@@ -1,7 +1,48 @@
import { resolve } from "node:path";
import type { AppConfig } from "@stc/contracts";
const DEV_SECRET = "stc-dev-secret-change-me";
/** The settings a deployment chooses; everything else in AppConfig is derived by `resolveConfig`. */
export type ConfigInput = Pick<AppConfig, "dataDir"> & Partial<Omit<AppConfig, "dataDir">>;
// Path lists are split on ":" only (paths may contain spaces); URL lists are trimmed.
const paths = (raw: string | undefined) => (raw ?? "").split(":").filter(Boolean);
const urls = (raw: string | undefined) => (raw ?? "").split(",").map((s) => s.trim()).filter(Boolean);
/**
* Fills in the derived parts of the configuration. Course discovery always covers the importer's folders and the
* studio's published worktrees, after the configured dirs, without duplicates (compared as absolute paths).
* Tests and dev entries use this to build an AppConfig the same way `loadConfig` does.
*/
export function resolveConfig(input: ConfigInput): AppConfig {
const dataDir = input.dataDir;
const importedCoursesDir = input.importedCoursesDir ?? resolve(dataDir, "courses");
const studioWorktreesDir = input.studioWorktreesDir ?? resolve(dataDir, "worktrees");
const courseDirs: string[] = [];
for (const d of [...(input.courseDirs ?? []), importedCoursesDir, studioWorktreesDir]) {
if (!courseDirs.some((c) => resolve(c) === resolve(d))) courseDirs.push(d);
}
const port = input.port ?? 3000;
return {
port,
databaseUrl: input.databaseUrl ?? "sqlite://./data/stcourses.db",
dataDir,
courseDirs,
secret: input.secret ?? DEV_SECRET,
publicUrl: input.publicUrl ?? `http://localhost:${port}`,
importedCoursesDir,
studioReposDir: input.studioReposDir ?? resolve(dataDir, "studio", "repos"),
studioWorktreesDir,
cacheDir: input.cacheDir ?? resolve(dataDir, "cache"),
importRoots: input.importRoots ?? [resolve(dataDir, "import-inbox")],
uploadMaxMb: input.uploadMaxMb ?? 100,
aiAllowedBaseUrls: input.aiAllowedBaseUrls ?? [],
transcribeUrl: input.transcribeUrl ?? null,
python: input.python ?? "python3",
};
}
export function loadConfig(env: Record<string, string | undefined> = process.env): AppConfig {
const port = env.STC_PORT !== undefined && env.STC_PORT !== "" ? Number(env.STC_PORT) : 3000;
if (!Number.isInteger(port) || port < 0) throw new Error(`Invalid STC_PORT: ${env.STC_PORT}`);
@@ -11,12 +52,40 @@ export function loadConfig(env: Record<string, string | undefined> = process.env
console.warn("[stc] STC_SECRET is not set; using an insecure development default");
secret = DEV_SECRET;
}
return {
let uploadMaxMb = 100;
if (env.STC_UPLOAD_MAX_MB) {
uploadMaxMb = Number(env.STC_UPLOAD_MAX_MB);
if (!Number.isFinite(uploadMaxMb) || uploadMaxMb <= 0) throw new Error(`Invalid STC_UPLOAD_MAX_MB: ${env.STC_UPLOAD_MAX_MB}`);
}
const dataDir = env.STC_DATA_DIR || "./data";
const roots = paths(env.STC_IMPORT_ROOTS);
return resolveConfig({
port,
databaseUrl: env.STC_DATABASE_URL || "sqlite://./data/stcourses.db",
dataDir: env.STC_DATA_DIR || "./data",
courseDirs: (env.STC_COURSE_DIRS || "./overlays:./courses").split(":").filter(Boolean),
dataDir,
courseDirs: paths(env.STC_COURSE_DIRS || "./overlays:./courses"),
secret,
publicUrl: env.STC_PUBLIC_URL || `http://localhost:${port}`,
importRoots: roots.length ? roots.map((r) => resolve(r)) : undefined,
uploadMaxMb,
aiAllowedBaseUrls: urls(env.STC_AI_ALLOWED_BASE_URLS),
transcribeUrl: env.STC_TRANSCRIBE_URL || null,
python: env.STC_PYTHON || "python3",
});
}
/** The importer's derived-file layout under `cacheDir` (decks, cover candidates, transcripts), shared by every package. */
export function cachePaths(config: Pick<AppConfig, "cacheDir">) {
const root = config.cacheDir;
const seg = (s: string) => {
if (!s || s === "." || s === ".." || s.includes("/") || s.includes("\\") || s.includes("\0")) throw new Error(`invalid cache path segment "${s}"`);
return s;
};
return {
root,
deckDir: (courseId: string, deckId: string) => resolve(root, "decks", seg(courseId), seg(deckId)),
coversDir: (courseId: string) => resolve(root, "covers", seg(courseId)),
transcriptFile: (courseId: string, lessonId: string) => resolve(root, "transcripts", seg(courseId), `${seg(lessonId)}.json`),
transcriptsDir: (courseId: string) => resolve(root, "transcripts", seg(courseId)),
};
}
+3 -2
View File
@@ -1,4 +1,5 @@
export { loadConfig } from "./config";
export { loadConfig, resolveConfig, cachePaths, type ConfigInput } from "./config";
export { createJobQueue } from "./jobs";
export { serveMedia, contentType, contentDisposition } from "./media";
export { serveMedia, contentType, contentDisposition, mediaSecurityHeaders, MEDIA_SANDBOX_CSP } from "./media";
export { createApp, canView, type Routes } from "./app";
export { composeServer, type ComposeOptions, type ComposedServer } from "./compose";
+19 -2
View File
@@ -1,9 +1,23 @@
const TYPES: Record<string, string> = {
mp4: "video/mp4", webm: "video/webm", pdf: "application/pdf", png: "image/png", jpg: "image/jpeg", jpeg: "image/jpeg",
svg: "image/svg+xml", md: "text/markdown; charset=utf-8", txt: "text/plain; charset=utf-8", zip: "application/zip",
js: "text/javascript; charset=utf-8", ts: "text/plain; charset=utf-8",
js: "text/javascript; charset=utf-8", mjs: "text/javascript; charset=utf-8", ts: "text/plain; charset=utf-8",
html: "text/html; charset=utf-8", htm: "text/html; charset=utf-8", xhtml: "application/xhtml+xml", xml: "application/xml",
};
/** Types a browser could run script from. Course media is author content on the app origin, so these get a sandbox. */
const ACTIVE = new Set(["svg", "html", "htm", "xhtml", "xml", "js", "mjs"]);
/** Opaque origin, no script, no plugins: an svg still renders as an image, an html page as inert markup. */
export const MEDIA_SANDBOX_CSP = "sandbox; default-src 'none'; img-src 'self' data:; style-src 'unsafe-inline'; media-src 'self'";
/** Headers every media response carries; plus a sandbox CSP for script-capable types. */
export function mediaSecurityHeaders(path: string): Record<string, string> {
const ext = path.slice(path.lastIndexOf(".") + 1).toLowerCase();
const h: Record<string, string> = { "X-Content-Type-Options": "nosniff" };
if (ACTIVE.has(ext)) h["Content-Security-Policy"] = MEDIA_SANDBOX_CSP;
return h;
}
export function contentType(path: string): string {
const ext = path.slice(path.lastIndexOf(".") + 1).toLowerCase();
return TYPES[ext] ?? "application/octet-stream";
@@ -42,11 +56,14 @@ export async function serveMedia(req: Request, absPath: string, opts: { download
const headers: Record<string, string> = {
"Content-Type": contentType(absPath),
"Accept-Ranges": "bytes",
...mediaSecurityHeaders(absPath),
};
if (opts.download) headers["Content-Disposition"] = contentDisposition(name);
const range = req.headers.get("range");
const parsed = range ? parseRange(range, size) : null;
if (parsed === "invalid") return new Response(null, { status: 416, headers: { "Content-Range": `bytes */${size}`, "Accept-Ranges": "bytes" } });
if (parsed === "invalid" || (parsed && size === 0)) {
return new Response(null, { status: 416, headers: { "Content-Range": `bytes */${size}`, "Accept-Ranges": "bytes", "X-Content-Type-Options": "nosniff" } });
}
if (!parsed) {
headers["Content-Length"] = String(size);
return new Response(req.method === "HEAD" ? null : file, { status: 200, headers });
+8
View File
@@ -97,5 +97,13 @@ test("canView matrix", async () => {
const pub = ctx.courses.get("sample")!, priv = ctx.courses.get("secret")!;
expect(canView(null, pub, [])).toBe(true);
expect(canView(null, priv, [])).toBe(false);
const u = (roles: AuthUser["roles"], groups: string[] = []): AuthUser => ({ id: "u1", email: "u@x", name: "U", roles, groups });
expect(canView(u(["learner"]), priv, [])).toBe(false);
expect(canView(u(["owner"]), priv, [])).toBe(true);
expect(canView(u(["author"]), priv, [])).toBe(true); // R14: the global author role views every course
expect(canView(u(["learner"]), priv, [], true)).toBe(true); // per-course author
expect(canView(u(["learner"]), priv, [{ principal_type: "user", principal_id: "u1" }])).toBe(true);
expect(canView(u(["learner"], ["g"]), priv, [{ principal_type: "group", principal_id: "g" }])).toBe(true);
expect(canView(u(["learner"], ["h"]), priv, [{ principal_type: "group", principal_id: "g" }])).toBe(false);
await db.close();
});
+51
View File
@@ -0,0 +1,51 @@
import { expect, test } from "bun:test";
import { mkdtempSync } from "node:fs";
import { tmpdir } from "node:os";
import { join, resolve } from "node:path";
import type { AuthUser, Feature, ServerContext } from "@stc/contracts";
import { composeServer, resolveConfig } from "../src";
const FIXTURES = resolve(import.meta.dir, "../../../fixtures/courses");
const config = () => resolveConfig({ dataDir: mkdtempSync(join(tmpdir(), "stc-compose-")), databaseUrl: "sqlite://:memory:", courseDirs: [FIXTURES] });
test("factories get the context; the queue is built from the union of their jobs; auth and stop are honoured", async () => {
const seen: string[] = [];
let stopped = 0;
const user: AuthUser = { id: "u", email: "u@x", name: "U", roles: ["owner"], groups: [] };
let early: unknown = null;
const a = (ctx: ServerContext): Feature => {
// the handle exists while factories run, but enqueuing must wait for the real queue
try { void ctx.jobs.enqueue("b.work", {}); } catch (e) { early = e; }
return {
name: "a",
routes: { "/api/a": { GET: async (_r, rc) => Response.json({ who: rc.user?.id ?? null, courses: ctx.courses.list().length }) } },
jobs: { "a.work": async (p) => { seen.push(`a:${JSON.stringify(p)}`); return null; } },
auth: { userFromRequest: async () => user },
stop: () => { stopped++; },
};
};
const b = (ctx: ServerContext): Feature => ({
name: "b",
routes: { "/api/b": { POST: async () => Response.json({ id: await ctx.jobs.enqueue("a.work", { n: 1 }) }) } },
jobs: { "b.work": async () => null },
});
const s = await composeServer(config(), [a, b]);
try {
expect(String(early)).toMatch(/not ready/);
expect(await (await s.app.fetch(new Request("http://x/api/a"))).json()).toEqual({ who: "u", courses: 1 });
const { id } = (await (await s.app.fetch(new Request("http://x/api/b", { method: "POST" }))).json()) as { id: string };
for (let i = 0; i < 200 && (await s.ctx.jobs.get(id))?.status !== "done"; i++) await Bun.sleep(10);
expect((await s.ctx.jobs.get(id))?.status).toBe("done");
expect(seen).toEqual(['a:{"n":1}']);
} finally {
await s.stop();
}
expect(stopped).toBe(1);
});
test("duplicate job kinds and two auth services are refused", async () => {
const f = (name: string, extra: Partial<Feature>) => (): Feature => ({ name, routes: {}, ...extra });
await expect(composeServer(config(), [f("x", { jobs: { k: async () => null } }), f("y", { jobs: { k: async () => null } })])).rejects.toThrow(/Duplicate job kind "k"/);
const auth = { userFromRequest: async () => null };
await expect(composeServer(config(), [f("x", { auth }), f("y", { auth })])).rejects.toThrow(/AuthService/);
});
+43 -4
View File
@@ -1,5 +1,6 @@
import { expect, test, spyOn } from "bun:test";
import { loadConfig } from "../src";
import { resolve } from "node:path";
import { cachePaths, loadConfig, resolveConfig } from "../src";
test("defaults", () => {
const warn = spyOn(console, "warn").mockImplementation(() => {});
@@ -7,21 +8,59 @@ test("defaults", () => {
expect(c.port).toBe(3000);
expect(c.databaseUrl).toBe("sqlite://./data/stcourses.db");
expect(c.dataDir).toBe("./data");
expect(c.courseDirs).toEqual(["./overlays", "./courses"]);
// configured dirs first, then the importer's folders and the studio's published worktrees
expect(c.courseDirs).toEqual(["./overlays", "./courses", resolve("./data/courses"), resolve("./data/worktrees")]);
expect(c.importedCoursesDir).toBe(resolve("./data/courses"));
expect(c.studioReposDir).toBe(resolve("./data/studio/repos"));
expect(c.studioWorktreesDir).toBe(resolve("./data/worktrees"));
expect(c.cacheDir).toBe(resolve("./data/cache"));
expect(c.importRoots).toEqual([resolve("./data/import-inbox")]);
expect(c.uploadMaxMb).toBe(100);
expect(c.aiAllowedBaseUrls).toEqual([]);
expect(c.transcribeUrl).toBeNull();
expect(c.python).toBe("python3");
expect(c.publicUrl).toBe("http://localhost:3000");
expect(warn).toHaveBeenCalledTimes(1);
warn.mockRestore();
});
test("colon splitting and overrides", () => {
const c = loadConfig({ STC_PORT: "8080", STC_COURSE_DIRS: "/a b:/c", STC_SECRET: "s", STC_PUBLIC_URL: "https://x.test" });
const c = loadConfig({
STC_PORT: "8080", STC_COURSE_DIRS: "/a b:/c", STC_SECRET: "s", STC_PUBLIC_URL: "https://x.test", STC_DATA_DIR: "/d",
STC_IMPORT_ROOTS: "/in box:/other", STC_UPLOAD_MAX_MB: "5", STC_AI_ALLOWED_BASE_URLS: "http://gw.lan:8080, https://x.test",
STC_TRANSCRIBE_URL: "http://whisper.lan/v1/audio/transcriptions", STC_PYTHON: "/opt/py/bin/python",
});
expect(c.port).toBe(8080);
expect(c.courseDirs).toEqual(["/a b", "/c"]);
expect(c.courseDirs).toEqual(["/a b", "/c", "/d/courses", "/d/worktrees"]);
expect(c.secret).toBe("s");
expect(c.publicUrl).toBe("https://x.test");
expect(c.importRoots).toEqual(["/in box", "/other"]);
expect(c.uploadMaxMb).toBe(5);
expect(c.aiAllowedBaseUrls).toEqual(["http://gw.lan:8080", "https://x.test"]);
expect(c.transcribeUrl).toBe("http://whisper.lan/v1/audio/transcriptions");
expect(c.python).toBe("/opt/py/bin/python");
});
test("configured dirs that already name the derived dirs are not repeated", () => {
const c = loadConfig({ STC_SECRET: "s", STC_DATA_DIR: "/d", STC_COURSE_DIRS: "/d/courses:/x" });
expect(c.courseDirs).toEqual(["/d/courses", "/x", "/d/worktrees"]);
expect(resolveConfig({ dataDir: "/d", courseDirs: ["/d/worktrees/"] }).courseDirs).toEqual(["/d/worktrees/", "/d/courses"]);
});
test("invalid upload cap throws", () => {
expect(() => loadConfig({ STC_SECRET: "s", STC_UPLOAD_MAX_MB: "lots" })).toThrow(/STC_UPLOAD_MAX_MB/);
});
test("production without a secret throws", () => {
expect(() => loadConfig({ NODE_ENV: "production" })).toThrow(/STC_SECRET/);
expect(loadConfig({ NODE_ENV: "production", STC_SECRET: "x" }).secret).toBe("x");
});
test("cachePaths: the importer's layout, no escaping segments", () => {
const p = cachePaths({ cacheDir: "/d/cache" });
expect(p.deckDir("c", "deck1")).toBe("/d/cache/decks/c/deck1");
expect(p.coversDir("c")).toBe("/d/cache/covers/c");
expect(p.transcriptFile("c", "m1-l1")).toBe("/d/cache/transcripts/c/m1-l1.json");
expect(() => p.coversDir("..")).toThrow();
expect(() => p.deckDir("c", "a/b")).toThrow();
});
+33
View File
@@ -57,3 +57,36 @@ test("non-ASCII filename gets a valid filename*", async () => {
test("missing file is 404", async () => {
expect((await serveMedia(req(), join(dir, "nope.mp4"))).status).toBe(404);
});
test("every response is nosniff; script-capable types get a sandbox CSP", async () => {
const d = mkdtempSync(join(tmpdir(), "stc-media-csp-"));
const { MEDIA_SANDBOX_CSP } = await import("../src");
for (const [name, body, sandboxed] of [
["x.svg", "<svg xmlns='http://www.w3.org/2000/svg'><script>alert(1)</script></svg>", true],
["page.html", "<script>alert(1)</script>", true],
["Page.HTM", "<p>x</p>", true],
["code.js", "alert(1)", true],
["mod.mjs", "export {}", true],
["notes.md", "# hi", false],
["clip.mp4", "x", false],
] as const) {
writeFileSync(join(d, name), body);
for (const r of [await serveMedia(req(), join(d, name)), await serveMedia(req("bytes=0-0"), join(d, name))]) {
expect(r.headers.get("x-content-type-options")).toBe("nosniff");
expect([name, r.headers.get("content-security-policy")]).toEqual([name, sandboxed ? MEDIA_SANDBOX_CSP : null]);
}
}
expect(MEDIA_SANDBOX_CSP).toMatch(/^sandbox;/);
expect(MEDIA_SANDBOX_CSP).not.toContain("allow-scripts");
});
test("a range on an empty file is 416, never a negative Content-Range", async () => {
const d = mkdtempSync(join(tmpdir(), "stc-media-empty-"));
writeFileSync(join(d, "empty.txt"), "");
for (const range of ["bytes=0-", "bytes=-5", "bytes=0-0"]) {
const r = await serveMedia(req(range), join(d, "empty.txt"));
expect(r.status).toBe(416);
expect(r.headers.get("content-range")).toBe("bytes */0");
}
expect((await serveMedia(req(), join(d, "empty.txt"))).status).toBe(200);
});