From 3b2ba76530067cada1c5c45fdf7bf59ff3aa6854 Mon Sep 17 00:00:00 2001 From: lilleman Date: Sun, 14 Jun 2026 19:41:19 +0200 Subject: [PATCH] =?UTF-8?q?Add=20403=20+=20500=20error=20templates=20(todo?= =?UTF-8?q?=20=C2=A70);=20render=20500=20via=20app=20error=20handler?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- src/app.test.ts | 35 ++++++++++++++++++++++++++++++++++- src/app.ts | 24 +++++++++++++++++------- todo.md | 38 +++++++++++++++++++++++++++++++------- views/403.ejs | 16 ++++++++++++++++ views/500.ejs | 16 ++++++++++++++++ 6 files changed, 115 insertions(+), 16 deletions(-) create mode 100644 views/403.ejs create mode 100644 views/500.ejs diff --git a/README.md b/README.md index caa1c30..e361fea 100644 --- a/README.md +++ b/README.md @@ -340,7 +340,7 @@ src/jwt.ts JWS signature verify via node:crypto, no jose; claims+JWKS src/cookie.ts Cookie parse + secure Set-Cookie build (session/CSRF cookies, §4) src/context.ts RequestContext handed to handlers + buildContext() src/plugin.ts definePlugin() + the host's plugin discovery/router (planned) -views/ Core EJS templates (index, 404, partials/) +views/ Core EJS templates (index, 403/404/500, partials/) public/ Static assets under /public/ (css/, favicon, robots.txt) config/menu.ts Central menu override + branding (planned) plugins/ Drop-in plugin folders, auto-discovered (planned) diff --git a/src/app.test.ts b/src/app.test.ts index 143c21d..9fe0077 100644 --- a/src/app.test.ts +++ b/src/app.test.ts @@ -1,9 +1,16 @@ import assert from "node:assert/strict"; +import { cpSync, mkdtempSync, rmSync, writeFileSync } from "node:fs"; import type { AddressInfo } from "node:net"; +import { tmpdir } from "node:os"; +import { dirname, join } from "node:path"; import { after, before, test } from "node:test"; +import { fileURLToPath } from "node:url"; +import * as ejs from "ejs"; import { createApp } from "./app.ts"; import { contentTypeFor, resolveStaticPath } from "./static.ts"; +const viewsDir = join(dirname(fileURLToPath(import.meta.url)), "..", "views"); + const server = createApp(); let base = ""; @@ -27,9 +34,35 @@ test("serves static CSS", async () => { assert.match(res.headers.get("content-type") ?? "", /text\/css/); }); -test("returns 404 for unknown routes", async () => { +test("returns the 404 HTML page for unknown routes", async () => { const res = await fetch(base + "/missing"); assert.equal(res.status, 404); + assert.match(res.headers.get("content-type") ?? "", /text\/html/); + assert.match(await res.text(), /404/); +}); + +test("renders the 500 HTML page when a handler throws", async () => { + const dir = mkdtempSync(join(tmpdir(), "pp-views-")); + writeFileSync(join(dir, "index.ejs"), "<% throw new Error('boom'); %>"); + cpSync(join(viewsDir, "500.ejs"), join(dir, "500.ejs")); + const app = createApp({ viewsDir: dir }); + try { + await new Promise((resolve) => app.listen(0, resolve)); + const res = await fetch(`http://localhost:${(app.address() as AddressInfo).port}/`); + assert.equal(res.status, 500); + assert.match(res.headers.get("content-type") ?? "", /text\/html/); + assert.match(await res.text(), /500/); + } finally { + app.close(); + rmSync(dir, { force: true, recursive: true }); + } +}); + +// 403 has no first-party route yet (guards land in §4), so assert the template renders. +test("renders the 403 error page as HTML", async () => { + const html = await ejs.renderFile(join(viewsDir, "403.ejs"), { title: "Forbidden" }); + assert.match(html, /403/); + assert.match(html, /style\.css/); }); test("blocks encoded path traversal out of /public/ with 403", async () => { diff --git a/src/app.ts b/src/app.ts index b8db1e3..aef8b79 100644 --- a/src/app.ts +++ b/src/app.ts @@ -1,4 +1,4 @@ -import { createServer, type Server } from "node:http"; +import { createServer, type Server, type ServerResponse } from "node:http"; import { dirname, join } from "node:path"; import { fileURLToPath } from "node:url"; import * as ejs from "ejs"; @@ -18,6 +18,11 @@ export function createApp(options: AppOptions = {}): Server { const render = (view: string, data: Record): Promise => ejs.renderFile(join(viewsDir, `${view}.ejs`), data); + const sendHtml = (res: ServerResponse, status: number, html: string): void => { + res.writeHead(status, { "content-type": "text/html; charset=utf-8" }); + res.end(html); + }; + return createServer(async (req, res) => { try { if (req.method !== "GET" && req.method !== "HEAD") { @@ -33,17 +38,22 @@ export function createApp(options: AppOptions = {}): Server { } if (pathname === "/") { - res.writeHead(200, { "content-type": "text/html; charset=utf-8" }); - res.end(await render("index", { title: "Plainpages" })); + sendHtml(res, 200, await render("index", { title: "Plainpages" })); return; } - res.writeHead(404, { "content-type": "text/html; charset=utf-8" }); - res.end(await render("404", { title: "Not found" })); + sendHtml(res, 404, await render("404", { title: "Not found" })); } catch (err) { console.error(err); - if (!res.headersSent) res.writeHead(500, { "content-type": "text/plain; charset=utf-8" }); - res.end("Internal Server Error"); + if (res.headersSent) return void res.end(); // a partial body is already on the wire + try { + // Render first: if the error page itself fails, headers stay unsent and we + // fall back to plain text below rather than emit a half-written response. + sendHtml(res, 500, await render("500", { title: "Server error" })); + } catch (renderErr) { + console.error(renderErr); + res.writeHead(500, { "content-type": "text/plain; charset=utf-8" }).end("Internal Server Error"); + } } }); } diff --git a/todo.md b/todo.md index 093c108..6b6d3e1 100644 --- a/todo.md +++ b/todo.md @@ -15,8 +15,11 @@ everything via Docker. - [x] Decide JWT verify approach: `node:crypto` (RS256/ES256 via `createPublicKey({format:"jwk"})`) vs add `jose` — justify if adding. → `node:crypto` (no new dep); `src/jwt.ts` verifies JWS signatures. - [x] Cookie helpers: parse `Cookie` header, build `Set-Cookie` (HttpOnly, Secure, SameSite). → `src/cookie.ts` (`parseCookies`/`serializeCookie`); stdlib-only, injection/pollution-safe. - [x] Request context type threaded to handlers: `{ req, res, url, params, query, user|null, roles }`. → `src/context.ts` (`RequestContext` + `buildContext`); `roles` mirror `user.roles`, the §2 router/§4 JWT middleware supply `params`/`user`. -- [ ] Error templates: add 403 + 500 (404 exists). +- [x] Error templates: add 403 + 500 (404 exists). → `views/403.ejs` + `views/500.ejs`; 500 wired into `app.ts` error handler (HTML, plain-text fallback). - [ ] Config/env loader: Ory endpoints, cookie/CSRF secret, JWKS location, ports. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 1. Building blocks — extract from `html-css-foundation/` (no Ory needed; render mock data) - [ ] Move `styles.css` + `auth.css` into `public/css/`; remove existing `style.css`. @@ -31,9 +34,11 @@ everything via Docker. - [ ] Helper `composeNav(fragments, override, roles)` → merged, permission-filtered tree. - [ ] Helper `parseListQuery(url)` → `{ q, filters, sort, page, pageSize }`. - [ ] Helper `paginate(total, page, pageSize)` → page model. -- [ ] Unit tests for all helpers (first). - [ ] Replace placeholder `index` with the app-shell dashboard. - [ ] Go over all HTML and CSS and make adjust it to be as sematic as we can, css classes, ids html elements and all, then add semantic DOM as a priority in this project. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 2. Plugin host - [ ] **Specify the plugin contract** (big job, do first — it's the product's main API surface). Write it down as the authoritative reference: the full manifest shape; the `RequestContext` handed to handlers and what's guaranteed stable; **contract versioning** (a `apiVersion`/`engines`-style field so a plugin declares the host it targets, and the host refuses or warns on mismatch); **conflict rules** (two plugins claiming the same `basePath`, nav slot, or `permission` name → defined, loud resolution, not last-write-wins); the **local dev/test story** (how an author runs + tests one plugin in isolation against the host). Audience is experienced devs: optimise for a powerful, predictable, clearly-documented API. Crash-isolation (a bad plugin can't take down the host) is a *nice-to-have*, not a blocker — fail loud at boot/discovery over sandboxing at runtime. @@ -43,7 +48,9 @@ everything via Docker. - [ ] Per-plugin static serving: `plugins//public/` → `/public//`. - [ ] `config/menu.ts` central override: reorder/rename/hide/group + branding (app name, logo, default theme). - [ ] Wire branding into the app shell. -- [ ] Tests: discovery, routing, param matching, permission gate, nav merge + filter. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 3. Ory stack — compose + config - [ ] `postgres` service (pinned tag); separate DB/schema per Kratos/Keto/Hydra. @@ -59,6 +66,9 @@ everything via Docker. - [ ] **One-command bootstrap** (the MVP bar): `docker compose up` brings up web + all Ory services + Postgres with *zero* manual prep. Commit working default Ory configs; auto-run migrations on first boot; auto-generate the JWKS signing key if absent; seed an admin identity + its Keto roles + a demo password (`admin`/`admin`) idempotently. Land an `OPL`/namespace bootstrap so Keto answers checks out of the box. - [ ] First-run banner / log line printing the login URL + seeded admin creds, with a clear "change these before production" warning. - [ ] Document the *only* things that can't be auto-generated: third-party **SSO provider** client id/secret (optional — password login works without them) and **production secrets** (real cookie/CSRF secret + signing key, supplied via env, replacing the dev throwaways). Everything else must work from a clean clone. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 4. Auth — identity, session JWT, guards - [ ] Kratos public client (fetch): init/get/submit flows, `whoami`, `whoami?tokenize_as=plainpages`. @@ -73,30 +83,41 @@ everything via Docker. - [ ] Session re-mint on TTL expiry (re-read roles from Keto). - [ ] Logout: revoke Kratos session + clear cookie. - [ ] Secure cookie flags; CSRF for our own POST forms. -- [ ] Tests: JWT verify (valid/expired/bad-sig), guard behavior, login→projection→tokenize flow (Ory mocked). +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 5. Built-in admin screens (writes go only to Keto/Kratos) - [ ] Users: list (Kratos identities) with filter/sort/pagination; create/edit/deactivate/delete; trigger recovery. - [ ] Groups: Keto subject sets — list/create/delete + membership management. - [ ] Roles & permissions: Keto relations — assign roles to users/groups; "effective access" view via Keto expand. - [ ] Wire into the menu (admin section, permission-gated). -- [ ] Tests: CRUD flows (Ory mocked) + permission gating. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 6. Hydra — OAuth2/OIDC provider (can ship after the rest) - [ ] Login-challenge handler: authenticate via Kratos session, accept/reject. - [ ] Consent-challenge handler: show / auto-accept first-party, grant scopes, accept/reject. - [ ] OAuth2 client registration (admin UI or CLI). -- [ ] Tests: authorization-code login+consent happy path; token + refresh. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 7. Example plugin (reference) - [ ] Reference plugin (e.g. people directory or scheduling): list page fetching upstream data, a form that forwards writes upstream, permission-gated nav. - [ ] Verify the full plugin contract end-to-end against the README. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 8. Testing & CI - [ ] node --test units across helpers / router / nav / auth (tests-first throughout). - [ ] **Playwright full E2E**: login (password + mocked SSO), menu filtering by role, users/groups/permissions CRUD, a plugin page, logout. - [ ] E2E harness: bring up the full compose stack, seed Keto roles + a test identity, **tear down after**. -- [ ] Typecheck + tests green in Docker (`docker compose run --rm web …`). +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. ## 9. Production, security, ops - [ ] `compose.yml` prod: Ory + Postgres, secrets via env, no source mount. @@ -105,4 +126,7 @@ everything via Docker. - [ ] Structured logging / basic observability. use @larvit/log for OTLP compability - but add subtasks and stuff for supporting incoming trace id etc from a reverse-proxy etc. - [ ] JWT signing-key rotation runbook. - [ ] Refresh README `Layout` + drop `_(planned)_` markers as pieces land. +- [ ] Run the architecture _and_ the stability reviewer agents on the _whole_ project, not just the latest changes, and address their issues. +- [ ] Go over all comments in the code and the README and try to make it shorter and more information dense. Remove not strictly needed stuff. +- [ ] Go over all tests and combine/unify ones that cover the same stuff or are very related and could be combined in a good way. Remove tests that aren't helping, we only want tests that are actually helpful to us. diff --git a/views/403.ejs b/views/403.ejs new file mode 100644 index 0000000..e9a0688 --- /dev/null +++ b/views/403.ejs @@ -0,0 +1,16 @@ + + + + + + <%= title %> + + + +
+

403

+

You don't have access to that.

+

Back home

+
+ + diff --git a/views/500.ejs b/views/500.ejs new file mode 100644 index 0000000..828bfdd --- /dev/null +++ b/views/500.ejs @@ -0,0 +1,16 @@ + + + + + + <%= title %> + + + +
+

500

+

Something went wrong on our end.

+

Back home

+
+ +