dckc
0cfa9d204e
vitest, @cloudflare/vitest-plugin, and typescript are devDependencies here instead of being borrowed from diigo-bookmarks through hand-made node_modules symlinks and a deep-path import. - lint: wrangler types, then tsc over src/ and tests/ (Cloudflare's documented typecheck shape: regenerate types, then tsc) - test: vitest run - tests/tsconfig.json per the vitest-plugin docs; the dangling typecheck script (tsconfig.check.json never existed) is gone Generated-by: Claude Opus 5.5
103 lines
4.5 KiB
Markdown
103 lines
4.5 KiB
Markdown
# diigo-cache
|
|
|
|
Cloudflare Worker cache over [the webapp factory](../webapp/README.md):
|
|
session-cookie reads of diigo bookmarks, cached in Durable-Object SQLite
|
|
storage. Evolved from the diigo-dump worker (provenance:
|
|
[mm-diigo `projects/diigo-bak/`](https://github.com/dckc/mm-diigo)); the
|
|
static API-key path is dead (see [the capsite checklist](../capsite-checklist.md),
|
|
goal 2 preamble).
|
|
|
|
## What it holds
|
|
|
|
- **The create flow, on one port**: `/_connect` renders webapp's own
|
|
mint form (diigo-prefilled, cookie blank) — wrangler multi-config dev
|
|
doesn't serve aux workers' HTTP, so `/_mint` relays the form opaquely
|
|
into the WEBAPP binding (the cookie crosses; nothing on this side opens
|
|
or logs it). Mint → `/_wire` (webapp id pre-filled, mode
|
|
public|private) → the created page, where the user saves the ids.
|
|
- **Two independent page caches** (`src/cache.ts`), one behavior: a
|
|
page hit is served from storage with no diigo call; a miss asks the
|
|
webapp instance in the cache's wiring and etches the page.
|
|
- `DiigoCache` (binding `CACHE_DO`): every item. Addressed by its
|
|
cache id.
|
|
- `PublicCache` (binding `PUBLIC_DO`): shared items only — private
|
|
rows are dropped *before* etching (`publicOnly`), so its storage
|
|
holds nothing private. Same cookie webapp as the private cache.
|
|
Public page n is diigo page n, filtered (may show fewer than 24).
|
|
`/public/<username>` resolves through the `idFromName("index")`
|
|
registry.
|
|
- **Pages**: home's dump form (cache id + page number, POST) shows raw
|
|
dump rows; `/public/<username>?page=n` shows an HTML list with a page
|
|
form (JSON for `Accept: application/json`). Both say `cache: HIT` or
|
|
`MISS`; every page read also logs `{event: "cache", kind, page,
|
|
outcome}`.
|
|
- **Publish later**: `POST /_publish` (cache id in the body) wires a
|
|
public companion to a private-only cache.
|
|
- The `DiigoBridge` entrypoint for other workers (its cache-id source is
|
|
the goal-2 wiring TODO).
|
|
|
|
## State surface
|
|
|
|
Ids are **webkeys** ([the pattern](../docs/webkeys.md)): 256-bit bearer
|
|
secrets that never ride URLs — not query strings, not path segments.
|
|
Forms carry them in POST bodies; logs and pages show only a fingerprint
|
|
(a prefix of the id's one-way hash).
|
|
|
|
- **The cache id**: the cache's read capability (bearer; not logged).
|
|
Held by the user — saved to the password manager under a petname they
|
|
choose (the username field; never sent to the server) — and passed
|
|
per POST.
|
|
- **The webapp instance id**: the diigo-read capability; lives in each
|
|
cache DO's wiring, arrives from the mint step.
|
|
- **The cookie**: lives **only in webapp's DO storage**; crosses the
|
|
wire once, at mint time, as an opaque relay.
|
|
- **The public cache**: no capability — `/public/<username>` is public
|
|
by design (a guessable URL; hiding the link doesn't hide the page).
|
|
|
|
Stored state is meant to be durable: see the breaking-change rule in
|
|
[capsite AGENTS.md](../AGENTS.md).
|
|
|
|
## Deployment concern: public pages spend your diigo session
|
|
|
|
Anyone who can reach `/public/<username>` can make the cache fetch from
|
|
diigo through *your* cookie session: each request may spend up to
|
|
`FETCH_BUDGET` (40) diigo fetches on uncached pages (goal 1d), paced at
|
|
`MS_PER_CALL`. Cached pages cost nothing. Before exposing a deployment:
|
|
|
|
- rate-limit the public routes — on Cloudflare, the
|
|
[Workers rate-limit binding](https://developers.cloudflare.com/workers/runtime-apis/bindings/rate-limit/)
|
|
(keyed by client and/or username); on other workerd hosts, a rate
|
|
limit in the proxy in front;
|
|
- run the fill job (goal 1e) so most pages are cached before strangers
|
|
arrive.
|
|
|
|
## RPC use (from another worker, same account)
|
|
|
|
```jsonc
|
|
// wrangler.jsonc of the caller
|
|
"services": [{ "binding": "DIIGO", "service": "diigo-cache", "entrypoint": "DiigoBridge" }]
|
|
```
|
|
|
|
```ts
|
|
// cache ids ride goal-2's wiring; see the capsite checklist
|
|
const ndjson = await env.DIIGO.dumpNdjson(4, 24);
|
|
```
|
|
|
|
## Test
|
|
|
|
pnpm types # regenerate worker-configuration.d.ts (after wrangler.jsonc changes)
|
|
pnpm lint # fails if those types are stale; tsc over src/ and tests/
|
|
pnpm test # vitest
|
|
|
|
Tests run the real worker and both DOs in the vitest pool, with
|
|
`WEBAPP` bound to [a fake webapp](tests/fake-webapp.js) serving
|
|
diigo-shaped items (`wrangler.tests.jsonc`).
|
|
|
|
## Run, deploy
|
|
|
|
[How to run / connect / deploy is maintained in the capsite checklist](../capsite-checklist.md)
|
|
(single source; this README keeps only worker-level facts).
|
|
|
|
Status: create, dump, publish, and public pages exercised against live
|
|
diigo in dev (2026-10-07); not yet deployed.
|