james/carol
james/carol
1
1
Fork 0
Code Issues 44 Pull requests 7 Projects Releases 25 Packages 1 Wiki Activity Actions

PWA configuration (manifest, service worker, offline shell) (#18) #40

Merged
james merged 1 commit from 18-pwa-configuration into main 2026-06-14 01:49:22 +00:00
Conversation 0 Commits 1 Files changed 20 +1102 -79
james commented 2026-06-14 01:31:40 +00:00
Owner
Copy link

Closes #18.

Summary

  • Web app manifest at /manifest.webmanifest via app/manifest.ts, plus PNG (192/512) and SVG icons rendered from public/icon.svg by scripts/render-icons.mjs.
  • Service worker via @serwist/next: precaches the build manifest, runtime caches with Serwist's defaultCache, falls back to /offline for any document navigation that misses cache. Registered from a client component (app/sw-register.tsx) on idle, mounted in the root layout.
  • Static /offline page (force-static) for the offline shell.
  • PWA-essential routes added to the public allowlist (/, /offline, /manifest.webmanifest, /sw.js, icons, /workbox- prefix) with reasoning inline in lib/auth/public-routes.ts.
  • Service worker has its own TS config (tsconfig.sw.json) targeting WebWorker libs so app/sw.ts typechecks against worker globals; npm run typecheck runs both passes.
  • next.config.mjs wraps the config with withSerwist and adds a webpack externals matcher that externalises both Node-only DB packages (pg/libsql family) and the node: URI scheme — needed because Next.js's instrumentation compile follows the dynamic import from instrumentation.ts into db/client.ts, which has top-level import fs from "node:fs". Without externalising node: URIs, npm run dev errors with UnhandledSchemeError: Reading from "node:fs" is not handled by plugins.
  • Middleware test (tests/middleware.test.ts) extended to assert the new PWA-essential public routes.

Test plan

  • npm run typecheck — passes both app and SW configs.
  • npm run lint — clean.
  • npm test — 61 passed / 20 skipped.
  • npm run build — succeeds, service worker bundled, 11 routes generated.
  • npm run dev — starts clean, no node:fs error.
  • Curl probes: /, /manifest.webmanifest, /offline, /icon-192.png, /sw.js → 200; /dashboard → 401 (default-deny intact).
  • Manual (browser): Lighthouse PWA audit — installability + offline.
  • Manual (browser): Install as standalone app from a modern browser.
  • Manual (browser): Kill network after first load and confirm the shell + /offline fallback render without a network round-trip.

The three manual browser checks above are the issue's acceptance criteria and need a real browser to verify.

🤖 Generated with Claude Code

Closes #18. ## Summary - Web app manifest at `/manifest.webmanifest` via `app/manifest.ts`, plus PNG (192/512) and SVG icons rendered from `public/icon.svg` by `scripts/render-icons.mjs`. - Service worker via `@serwist/next`: precaches the build manifest, runtime caches with Serwist's `defaultCache`, falls back to `/offline` for any document navigation that misses cache. Registered from a client component (`app/sw-register.tsx`) on idle, mounted in the root layout. - Static `/offline` page (`force-static`) for the offline shell. - PWA-essential routes added to the public allowlist (`/`, `/offline`, `/manifest.webmanifest`, `/sw.js`, icons, `/workbox-` prefix) with reasoning inline in `lib/auth/public-routes.ts`. - Service worker has its own TS config (`tsconfig.sw.json`) targeting `WebWorker` libs so `app/sw.ts` typechecks against worker globals; `npm run typecheck` runs both passes. - `next.config.mjs` wraps the config with `withSerwist` and adds a webpack externals matcher that externalises both Node-only DB packages (pg/libsql family) and the `node:` URI scheme — needed because Next.js's instrumentation compile follows the dynamic import from `instrumentation.ts` into `db/client.ts`, which has top-level `import fs from "node:fs"`. Without externalising `node:` URIs, `npm run dev` errors with `UnhandledSchemeError: Reading from "node:fs" is not handled by plugins`. - Middleware test (`tests/middleware.test.ts`) extended to assert the new PWA-essential public routes. ## Test plan - [x] `npm run typecheck` — passes both app and SW configs. - [x] `npm run lint` — clean. - [x] `npm test` — 61 passed / 20 skipped. - [x] `npm run build` — succeeds, service worker bundled, 11 routes generated. - [x] `npm run dev` — starts clean, no `node:fs` error. - [x] Curl probes: `/`, `/manifest.webmanifest`, `/offline`, `/icon-192.png`, `/sw.js` → 200; `/dashboard` → 401 (default-deny intact). - [ ] **Manual (browser):** Lighthouse PWA audit — installability + offline. - [ ] **Manual (browser):** Install as standalone app from a modern browser. - [ ] **Manual (browser):** Kill network after first load and confirm the shell + `/offline` fallback render without a network round-trip. The three manual browser checks above are the issue's acceptance criteria and need a real browser to verify. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
PWA configuration (manifest, service worker, offline shell) (#18)
Some checks failed
PR / Lint (pull_request) Successful in 29s
Details
PR / Typecheck (pull_request) Successful in 35s
Details
PR / Test (sqlite) (pull_request) Successful in 38s
Details
PR / Build (pull_request) Successful in 55s
Details
PR / Test (postgres) (pull_request) Failing after 2m0s
Details
4266ea0704 
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
james force-pushed 18-pwa-configuration from 4266ea0704
Some checks failed
PR / Lint (pull_request) Successful in 29s
Details
PR / Typecheck (pull_request) Successful in 35s
Details
PR / Test (sqlite) (pull_request) Successful in 38s
Details
PR / Build (pull_request) Successful in 55s
Details
PR / Test (postgres) (pull_request) Failing after 2m0s
Details
to cf9337fdc3
All checks were successful
PR / OSV-Scanner (pull_request) Successful in 30s
Details
PR / Test (postgres) (pull_request) Successful in 1m39s
Details
PR / Test (sqlite) (pull_request) Successful in 1m51s
Details
PR / npm audit (pull_request) Successful in 3m10s
Details
PR / Build (pull_request) Successful in 3m14s
Details
PR / Lint (pull_request) Successful in 3m21s
Details
PR / Typecheck (pull_request) Successful in 3m25s
Details
PR / Trivy (image) (pull_request) Successful in 3m38s
Details
2026-06-14 01:44:30 +00:00 Compare
james merged commit 35fc772713 into main 2026-06-14 01:49:22 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
area:auth
Authentication and authorization

  
area:ci
Forgejo Actions, build, test, security, release

  
area:db
Database abstraction, migrations, persistence

  
area:infra
Containerization, deployment, foundational tooling

  
area:native
React Native app (Android + Linux Flatpak)

  
area:pwa
PWA / web frontend

  
area:service
Backend service, API routes, persistence

  
epic
High-level tracker; links several feature tickets

  
feature
A user-facing feature

  
foundation
Foundational work that other tickets build on

No labels
area:auth
area:ci
area:db
area:infra
area:native
area:pwa
area:service
epic
feature
foundation
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
james/carol!40
No description provided.