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

Fix/spa fallback status code

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

@@ -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

@@ -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

@@ -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:v3
+    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

packages/backend/Cargo.lock

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

packages/backend/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cryptgeon"
-version = "3.0.0-rc.3"
+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)
@@ -66,4 +72,4 @@ async fn main() {
     axum::serve(listener, ServiceExt::<Request>::into_make_service(app))
         .await
         .unwrap();
-}
+}

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cryptgeon",
-  "version": "3.0.0-rc.3",
+  "version": "3.0.0",
   "homepage": "https://github.com/cupcakearmy/cryptgeon",
   "repository": {
     "type": "git",

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/worker/worker.ts

@@ -8,11 +8,7 @@ const contract: WorkerConract = {
 		return transfer(content, [content.data.buffer, content.extra.buffer, content.key.buffer])
 	},
 	unpack(data, key) {
-		const content = unpackContent(data, key)
+		return unpackContent(data, key)
-		return transfer(
-			content,
-			typeof content.data === 'string' ? [] : content.data.map((f) => f.data.buffer)
-		)
 	},
 }
 

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);
+  });
+});