Merge pull request #221 from cupcakearmy/fix/spa-fallback-status-code

Fix/spa fallback status code

.github/workflows/release.yml

@@ -29,7 +29,7 @@ jobs:
           if [[ "${GITHUB_REF_NAME}" == *"-"* ]]; then
             DIST_TAG=rc
           fi
-          pnpm publish --filter cryptgeon --tag "${DIST_TAG}"
+          pnpm publish --filter cryptgeon --tag "${DIST_TAG}" --no-git-checks
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 

.github/workflows/test.yaml

@@ -34,6 +34,9 @@ jobs:
       - name: Shared tests
         run: pnpm --filter @cryptgeon/shared test
 
+      - name: Frontend type check
+        run: pnpm --filter @cryptgeon/web check
+
       - name: Run your tests
         run: pnpm test
 

CHANGELOG.md

@@ -11,15 +11,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - New shared TypeScript package `@cryptgeon/shared` as single source of truth for crypto, content codec and API client (crypto + compression + payload + types).
 - Shared payload codec: `packContent` / `unpackContent` (encode → LZ4 → XChaCha20-Poly1305 and reverse).
-- New `pg`-backend storage of note hashes in the cache.
+- Cache-backed note storage using hashes (valkey/redis) with atomic view counting.
 
 ### Changed
 
 - Encryption from AES to **XChaCha20-Poly1305** (client-side); dropped `occulto`.
 - All API bodies switched to **MessagePack**.
-- Frontend migrated to SvelteKit + `@cryptgeon/shared`.
+- Frontend uses `@cryptgeon/shared` for crypto + payload codec (replacing the previous local `cryptgeon/shared`); heavy pack/unpack runs in a web worker.
 - CLI rebuilt with `vite-plus` (bundles all deps) and imports from `@cryptgeon/shared`.
 
+### Fixed
+
+- SPA fallback now serves the app (200) for client-side routes such as `/about` and `/note/<id>`, while unmatched `/api/*` paths still return 404.
+
 ### Breaking changes
 
 - Endpoints moved to `/api/v3/notes/` and `/api/v3/status`; health check to `/healthz`.

README.md

@@ -115,7 +115,7 @@ services:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:v3
     depends_on:
       - cache
     environment:
@@ -169,6 +169,10 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 Please refer to the security section [here](./SECURITY.md).
 
+## Usage of LLMs
+
+Starting from V3, I used LLMs heavily to implement _my own ideas_. This means that the direction and architecture choices are human. A lot of the implementation that derives from that, is automated with an LLM.
+
 ---
 
 _Attributions_

README_ES.md

@@ -103,7 +103,7 @@ services:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:v3
     depends_on:
       - cache
     environment:
@@ -151,6 +151,10 @@ Ver [CONTRIBUTING.md](./CONTRIBUTING.md).
 
 Por favor dirígete a la sección de seguridad [aquí](./SECURITY.md).
 
+## Uso de LLMs
+
+A partir de la V3, utilicé LLMs de forma intensiva para implementar _mis propias ideas_. Esto significa que la dirección y las decisiones de arquitectura son humanas. Gran parte de la implementación que deriva de eso está automatizada con un LLM.
+
 ---
 
 _Atribuciones_

README_zh-CN.md

@@ -91,7 +91,7 @@ services:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:v3
     depends_on:
       - cache
     environment:
@@ -131,7 +131,7 @@ services:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:v3
     restart: unless-stopped
     depends_on:
       - cache
@@ -149,6 +149,10 @@ services:
 
 参见 [CONTRIBUTING.md](./CONTRIBUTING.md)。
 
+## LLM 的使用
+
+从 V3 开始，我大量使用 LLM 来实现_我自己的想法_。这意味着项目的方向和架构选择均由人类决定。由此衍生的大部分实现由 LLM 自动完成。
+
 ###### Attributions
 
 - 测试数据:

docker-compose.yaml

@@ -1,17 +1,17 @@
 services:
   cache:
-    image: valkey/valkey:7-alpine
+    image: valkey/valkey:9-alpine
     # This is required to stay in RAM only.
     command: valkey-server --save "" --appendonly no
     # Set a size limit. See link below on how to customise.
-    # https://valkey.io/docs/latest/operate/rs/databases/memory-performance/eviction-policy/
+    # https://valkey.io/topics/lru-cache/
-    # --maxmemory 1gb --maxmemory-policy allkeys-lrulpine
+    # --maxmemory 1gb --maxmemory-policy allkeys-lru
     # This prevents the creation of an anonymous volume.
     tmpfs:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:3
     depends_on:
       - cache
     environment:
@@ -19,11 +19,9 @@ services:
       SIZE_LIMIT: 4 MiB
     ports:
       - 80:8000
-
+    healthcheck:
-    # Optional health checks
+      test: ["CMD", "curl", "--fail", "http://127.0.0.1:8000/healthz"]
-    # healthcheck:
+      interval: 1m
-    #   test: ["CMD", "curl", "--fail", "http://127.0.0.1:8000/healthz"]
+      timeout: 3s
-    #   interval: 1m
+      retries: 2
-    #   timeout: 3s
+      start_period: 5s
-    #   retries: 2
-    #   start_period: 5s

docs/roadmap.md

@@ -2,11 +2,9 @@
 
 ## Todo
 
-- Localize i18n readmes: `README_ES.md`, `README_zh-CN.md` still reference `REDIS` / `/api/v1`-era endpoint names — align to `CACHE` / `/healthz` (also sweep `CONTRIBUTING.md`, `examples/*`, postman collection).
 - Add remaining shared tooling to the pnpm catalog (`vite`, `tsdown`).
 - Move formatting, linting and type-checking + git hooks onto `vite-plus` (oxlint, oxfmt, vitest).
 - Re-add CSP (`Content-Security-Policy`) wired into the axum router (was in `csp.rs`, removed as unused).
-- Move all CLI deps to `devDependencies` — they bundle into the single output file anyway.
 
 ## Unified payload (drop the text/file union)
 

examples/nginx/docker-compose.yaml

@@ -12,7 +12,7 @@ services:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:v3
     depends_on:
       - cache
 

examples/scratch/README.md

@@ -116,7 +116,7 @@ services:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:v3
     restart: unless-stopped
     depends_on:
       - cache

examples/traefik/README.md

@@ -26,7 +26,7 @@ services:
       - /data
 
   app:
-    image: cupcakearmy/cryptgeon:latest
+    image: cupcakearmy/cryptgeon:v3
     restart: unless-stopped
     depends_on:
       - cache
@@ -70,7 +70,7 @@ services:
       - /data
 
   cryptgeon:
-    image: cupcakearmy/cryptgeon
+    image: cupcakearmy/cryptgeon:v3
     depends_on:
       - cache
     labels:

packages/backend/Cargo.lock

@@ -252,7 +252,7 @@ dependencies = [
 
 [[package]]
 name = "cryptgeon"
-version = "3.0.0-rc.0"
+version = "3.0.0"
 dependencies = [
  "axum",
  "bs62",

packages/backend/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cryptgeon"
-version = "3.0.0-rc.0"
+version = "3.0.0"
 authors = ["cupcakearmy <hi@nicco.io>"]
 edition = "2024"
 rust-version = "1.95"

packages/backend/src/main.rs

@@ -20,6 +20,10 @@ mod note;
 mod status;
 mod store;
 
+async fn api_not_found() -> axum::http::StatusCode {
+    axum::http::StatusCode::NOT_FOUND
+}
+
 #[tokio::main]
 async fn main() {
     dotenv().ok();
@@ -39,11 +43,13 @@ async fn main() {
         .nest("/notes", notes_routes)
         .merge(status_routes);
 
-    let api_routes = Router::new().nest("/v3", v3_routes);
+    let api_routes = Router::new()
+        .nest("/v3", v3_routes)
+        .fallback(api_not_found);
 
     let index = format!("{}{}", config::FRONTEND_PATH.to_string(), "/index.html");
     let serve_dir =
-        ServeDir::new(config::FRONTEND_PATH.to_string()).not_found_service(ServeFile::new(index));
+        ServeDir::new(config::FRONTEND_PATH.to_string()).fallback(ServeFile::new(index));
     let app = Router::new()
         .nest("/api", api_routes)
         .merge(health_routes)

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cryptgeon",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.0",
   "homepage": "https://github.com/cupcakearmy/cryptgeon",
   "repository": {
     "type": "git",
@@ -21,19 +21,19 @@
   "scripts": {
     "build": "vp pack",
     "dev": "vp pack --watch",
-    "prepublishOnly": "run-s build"
+    "prepublishOnly": "pnpm run build"
   },
   "devDependencies": {
+    "@commander-js/extra-typings": "^15.0.0",
     "@cryptgeon/shared": "workspace:*",
     "@msgpack/msgpack": "^3.1.3",
-    "@commander-js/extra-typings": "^12.1.0",
     "@tsconfig/strictest": "catalog:",
-    "@types/inquirer": "^9.0.9",
+    "@types/inquirer": "^9.0.10",
-    "@types/node": "^22.15.3",
+    "@types/node": "^22.20.1",
-    "commander": "^12.1.0",
+    "commander": "^15.0.0",
-    "inquirer": "^9.3.8",
+    "inquirer": "^14.2.1",
     "mime": "^4.1.0",
-    "pretty-bytes": "^6.1.1",
+    "pretty-bytes": "^7.1.3",
     "typescript": "catalog:",
     "vite-plus": "catalog:"
   },

packages/frontend/package.json

@@ -13,21 +13,22 @@
 	"type": "module",
 	"devDependencies": {
 		"@sveltejs/adapter-static": "^3.0.10",
-		"@sveltejs/kit": "^2.61.1",
+		"@sveltejs/kit": "^2.70.3",
-		"@sveltejs/vite-plugin-svelte": "^7.1.2",
+		"@sveltejs/vite-plugin-svelte": "^7.3.0",
 		"@zerodevx/svelte-toast": "^0.9.6",
 		"license-checker-rseidelsohn": "^5.0.1",
-		"svelte": "^5.55.9",
+		"svelte": "^5.57.0",
-		"svelte-check": "^4.4.8",
+		"svelte-check": "^4.7.6",
 		"svelte-intl-precompile": "^0.12.3",
 		"tslib": "^2.8.1",
 		"typescript": "^6.0.3",
-		"vite": "^8.0.14"
+		"vite": "^8.2.2"
 	},
 	"dependencies": {
 		"@cryptgeon/shared": "workspace:*",
-		"@fontsource/fira-mono": "^5.2.7",
+		"@fontsource/fira-mono": "^5.3.0",
-		"pretty-bytes": "^7.1.0",
+		"comlink": "^4.4.2",
+		"pretty-bytes": "^7.1.3",
 		"uqr": "^0.1.3"
 	}
 }

packages/frontend/src/lib/ui/ShowNote.svelte

@@ -46,11 +46,11 @@ async function downloadFile(file: FileDTO) {
 			files = note.contents
 		}
 	})
-	let download = $derived(() => {
+	function downloadAll() {
 		for (const file of files) {
 			downloadFile(file)
 		}
-	})
+	}
 	let links = $derived(typeof note.contents === 'string' ? note.contents.match(RE_URL) : [])
 </script>
 
@@ -92,7 +92,7 @@ async function downloadFile(file: FileDTO) {
 				{/key}
 			{/if}
 		{/each}
-		<Button onclick={download}>{$t('show.download_all')}</Button>
+		<Button onclick={downloadAll}>{$t('show.download_all')}</Button>
 	{/if}
 </div>
 

packages/frontend/src/lib/views/Create.svelte

@@ -1,12 +1,15 @@
 <script lang="ts">
 	import {
-		bytesToHex,
 		create as apiCreate,
+		bytesToHex,
 		packContent,
-		type ServerNote
+		type FileDTO,
+		type NoteInput,
+		type ServerNote,
 	} from '@cryptgeon/shared'
 	import { t } from 'svelte-intl-precompile'
 	import { blur } from 'svelte/transition'
+	import { transfer } from 'comlink'
 
 	import { status } from '$lib/stores/status'
 	import { notify } from '$lib/toast'
@@ -15,10 +18,12 @@
 	import FileUpload from '$lib/ui/FileUpload.svelte'
 	import Loader from '$lib/ui/Loader.svelte'
 	import MaxSize from '$lib/ui/MaxSize.svelte'
-	import PastedFilesPreview from '$lib/ui/PastedFilesPreview.svelte'
 	import Result, { type NoteResult } from '$lib/ui/NoteResult.svelte'
+	import PastedFilesPreview from '$lib/ui/PastedFilesPreview.svelte'
 	import Switch from '$lib/ui/Switch.svelte'
 	import TextArea from '$lib/ui/TextArea.svelte'
+	import { createWorker } from '$lib/worker'
+	import { onMount } from 'svelte'
 
 	let note: { views: number; expiration: number } = $state({ views: 1, expiration: 60 })
 	let files: FileDTO[] = $state([])
@@ -53,6 +58,8 @@
 		if (!isFile) textContent = ''
 	})
 
+	const worker = createWorker()
+
 	async function handlePaste(e: ClipboardEvent) {
 		const data = e.clipboardData
 		if (!data) return
@@ -123,13 +130,21 @@
 				throw new EmptyContentError()
 			}
 
-			const payload = packContent(
+			const noteInput: NoteInput = isFile
-				isFile ? { type: 'files', files } : { type: 'text', text: textContent },
+				? transfer(
-				customPassword || undefined
+						{
-			)
+							type: 'files',
+							files: $state.snapshot(files),
+						},
+						files.map((f) => f.data.buffer)
+					)
+				: { type: 'text', text: textContent }
+			const payload = await worker.pack(noteInput, customPassword || undefined)
 			const serverNote: ServerNote = {
 				meta: {
-					...(timeExpiration ? { expiration: parseInt(note.expiration as any) } : { views: parseInt(note.views as any) }),
+					...(timeExpiration
+						? { expiration: parseInt(note.expiration as any) }
+						: { views: parseInt(note.views as any) }),
 					extra: payload.extra,
 				},
 				data: payload.data,

packages/frontend/src/lib/worker/index.ts

@@ -0,0 +1,14 @@
+import { wrap } from 'comlink'
+
+import CryptWorker from './worker?worker'
+import type { packContent, unpackContent } from '@cryptgeon/shared'
+
+export function createWorker() {
+	const worker = new CryptWorker()
+	return wrap<WorkerConract>(worker)
+}
+
+export type WorkerConract = {
+	pack: typeof packContent
+	unpack: typeof unpackContent
+}

packages/frontend/src/lib/worker/worker.ts

@@ -0,0 +1,15 @@
+import type { WorkerConract } from '$lib/worker'
+import { packContent, unpackContent } from '@cryptgeon/shared'
+import { expose, transfer } from 'comlink'
+
+const contract: WorkerConract = {
+	pack(input, password) {
+		const content = packContent(input, password)
+		return transfer(content, [content.data.buffer, content.extra.buffer, content.key.buffer])
+	},
+	unpack(data, key) {
+		return unpackContent(data, key)
+	},
+}
+
+expose(contract)

packages/frontend/src/routes/note/[id]/+page.svelte

@@ -1,5 +1,13 @@
 <script lang="ts">
-	import { deriveKey, hexToBytes, decode, info, get as apiGet, unpackContent, type FileDTO } from '@cryptgeon/shared'
+	import {
+		deriveKey,
+		hexToBytes,
+		decode,
+		info,
+		get as apiGet,
+		unpackContent,
+		type FileDTO,
+	} from '@cryptgeon/shared'
 	import { onMount } from 'svelte'
 	import { t } from 'svelte-intl-precompile'
 
@@ -8,6 +16,7 @@
 	import ShowNote, { type DecryptedNote } from '$lib/ui/ShowNote.svelte'
 	import TextInput from '$lib/ui/TextInput.svelte'
 	import type { PageData } from './$types'
+	import { createWorker } from '$lib/worker'
 
 	interface Props {
 		data: PageData
@@ -44,6 +53,8 @@
 		}
 	})
 
+	const worker = createWorker()
+
 	async function show(e: SubmitEvent) {
 		e.preventDefault()
 		try {
@@ -69,7 +80,7 @@
 				key = hexToBytes(password!)
 			}
 
-		const content = unpackContent(serverNote.data, key)
+			const content = await worker.unpack(serverNote.data, key)
 
 			switch (content.type) {
 				case 'text':
@@ -78,16 +89,16 @@
 						contents: content.data,
 					}
 					break
-case 'files':
+				case 'files':
-    const files = (content.data as any[]).map((f: any) => ({
+					const files = (content.data as any[]).map((f: any) => ({
-        ...f,
+						...f,
-        data: f.data instanceof Uint8Array ? f.data : new Uint8Array(f.data as any),
+						data: f.data instanceof Uint8Array ? f.data : new Uint8Array(f.data as any),
-    }))
+					}))
-    note = {
+					note = {
-        meta: { type: 'file' },
+						meta: { type: 'file' },
-        contents: files,
+						contents: files,
-    }
+					}
-break
+					break
 				default:
 					error = $t('show.errors.unsupported_type')
 					return

test/web/spa-fallback.spec.ts

@@ -0,0 +1,15 @@
+import { expect, test } from "@playwright/test";
+
+test.describe("@web", () => {
+  for (const path of ["/", "/about", "/note/does-not-exist"]) {
+    test(`serves ${path} with status 200`, async ({ request }) => {
+      const response = await request.get(path);
+      expect(response.status()).toBe(200);
+    });
+  }
+
+  test("api still reports a missing note as 404", async ({ request }) => {
+    const response = await request.get("/api/notes/does-not-exist");
+    expect(response.status()).toBe(404);
+  });
+});