docs: Asura build-hash slug rotation spec + URL shape notes
This commit is contained in:
@@ -0,0 +1,158 @@
|
|||||||
|
# AGENTS.md
|
||||||
|
|
||||||
|
Guidance for OpenCode (and Claude Code) working in this repo.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Active. Backend (`backend/`) and userscript (`userscript/manga-bookmark.user.js`) built. Plan `plans/mangaBookmark.md` = original spec, may drift; trust code + design docs in `docs/superpowers/specs/` over plan.
|
||||||
|
|
||||||
|
## What this is
|
||||||
|
|
||||||
|
Manga read-progress tracker for user reading on **asurascans.com** (current domain; asuracomic.net 301s here) and **demonicscans.org** from **Bromite** (mobile Chromium). Userscript injects on-page UI (floating button + slide-in panel), syncs progress to self-hosted Go backend so bookmarks unify across both sites and devices.
|
||||||
|
|
||||||
|
## Hard constraints (drive design — do not violate)
|
||||||
|
|
||||||
|
Bromite uses Chromium's **native** userscript engine, not Tampermonkey:
|
||||||
|
- **No `GM_*` APIs anywhere.** No `GM_setValue`/`GM_getValue` (use page `localStorage`), no `GM_registerMenuCommand` (inject on-page UI), no `GM_xmlhttpRequest` for cross-origin (use plain `fetch()`). GM-free script also runs in desktop Tampermonkey/Violentmonkey for faster iteration.
|
||||||
|
- Cross-origin `fetch()` works **only** against CORS-enabled backend. Manga sites `https://`, so backend **must be HTTPS** (else mixed-content block).
|
||||||
|
- Asura and Demonic = **separate origins, separate `localStorage`** — shared remote store only way to unify bookmarks. Cloud sync required, not optional.
|
||||||
|
- Userscript runs in **isolated world**, so embedded API token safe from site's JS.
|
||||||
|
- Cloudflare's block on manga sites is **IP-reputation-based, not universal — not reliably reproducible.** Verified 2026-07-26: plain `curl` from both CGNAT dev machine *and* deployed VPS got clean 200s w/ real HTML on both asurascans.com and demonicscans.org (homepage, series, chapter pages) — no interactive Turnstile challenge from either IP at test time. Contradicts earlier, untested assumption CGNAT dev IP would be blocked; wasn't, at least this date. Treat "does curl work now" as live, time-varying fact to re-check, not fixed property of machine — Cloudflare bot scoring can flip clean IP without notice. Any backend fetcher still needs graceful-degrade path for when challenged; adapters should be **verified against live pages** (Playwright MCP, on-device devtools, direct probe) before finalizing, not assumed from single earlier test.
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
```
|
||||||
|
Bromite userscript (isolated world, per-site adapters, localStorage cache)
|
||||||
|
-- fetch() HTTPS --> reverse proxy (TLS + CORS) --> Go net/http --> SQLite (volume)
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Backend** (`backend/`): stdlib `net/http` (handful of routes, no framework) + `modernc.org/sqlite` (pure Go, `CGO_ENABLED=0` -> static binary -> distroless/scratch image). Reverse proxy terminates TLS; Go service listens plain `:8080`.
|
||||||
|
- **Single-user store.** One `bookmarks` table keyed `<site>:<series_id>` (`asura`|`demonic`). Sync **last-write-wins**. Schema + endpoint list in plan.
|
||||||
|
- **Endpoints:** `GET /bookmarks`, `PUT /bookmarks/{key}` (upsert; see `updated_at` rule below), `DELETE /bookmarks/{key}`, `GET /healthz` (no auth).
|
||||||
|
- **Web UI:** same binary serves password-gated browser UI on second
|
||||||
|
hostname — `GET /` (list, or login page when no session),
|
||||||
|
`POST /login`, `POST /logout`, `GET /static/*`, htmx fragment endpoints
|
||||||
|
under `/ui/*`. Templates/assets `go:embed`-ed, so `backend/Dockerfile`
|
||||||
|
must copy `templates/` and `static/` plus `*.go`. Sessions = stateless
|
||||||
|
HMAC cookies keyed off `API_TOKEN`; `WEB_PASSWORD` gates them, when empty
|
||||||
|
web routes not registered at all. UI mutations read-modify-write
|
||||||
|
through `Store.Get` + `Store.Upsert` so `updated_at` rule stays one
|
||||||
|
place. See `docs/superpowers/specs/2026-07-25-web-ui-design.md`.
|
||||||
|
- **Latest-chapter poller:** ticker goroutine in same binary re-checks
|
||||||
|
each bookmarked series' newest published chapter from backend's own
|
||||||
|
network access, so `latest_chapter` stays fresh when user not
|
||||||
|
browsing. Second, parallel signal — userscript keeps own
|
||||||
|
`maybeCaptureLatestOnSeriesPage`/`backgroundRefreshLatest` logic unchanged.
|
||||||
|
Two independent clocks: per-bookmark cooldown (`latest_checked_at` column,
|
||||||
|
enforced by `Store.DueForLatestCheck`'s WHERE clause) and wake interval.
|
||||||
|
Row stamped *before* fetch so broken series waits full
|
||||||
|
cooldown instead of retrying every tick; writes go through
|
||||||
|
`Store.Get` + `Store.Upsert` so new chapter never reorders list.
|
||||||
|
Fetches use `bogdanfinn/tls-client` w/ Chrome profile as defence in depth
|
||||||
|
against fingerprint-based blocking; any failure logs and skips. See
|
||||||
|
`docs/superpowers/specs/2026-07-26-server-latest-chapter-polling-design.md`.
|
||||||
|
Poller's `Store.Get` + `Store.Upsert` not wrapped in transaction, so
|
||||||
|
userscript `PUT` committing between the two can be overwritten by
|
||||||
|
poller's stale re-read — reverting read progress and, since stored
|
||||||
|
value now differs, moving `updated_at` and reordering list. Known,
|
||||||
|
accepted limitation for single-user deployment, not bug to fix.
|
||||||
|
- **`updated_at` drives list order, moves only on real reading progress:** server applies timestamp when row new or `last_chapter_num` changes, else keeps stored value — favouriting series or recording newly published chapter must not reorder list. `PUT` therefore returns row **as stored**; clients must adopt that response over own payload. See `plans/2026-07-25-bookmark-list-favorites-design.md` §4.
|
||||||
|
- **Lifecycle buckets:** `status` on each bookmark is `reading` | `archived` |
|
||||||
|
`finished`, orthogonal to `favorite`. Archived and finished appear only in
|
||||||
|
own tab — not All, Updated, Favourites, or recent strip. Poller keeps
|
||||||
|
checking archived series, skips finished ones. `finished` settable only
|
||||||
|
from web UI; `PUT /bookmarks/{key}` rejects it w/ 400.
|
||||||
|
**Empty incoming status means "keep stored one"** — resolved on
|
||||||
|
`VALUES` side of `Store.Upsert`, not conflict clause, since
|
||||||
|
`excluded.*` = post-evaluation row and default applied there'd
|
||||||
|
wipe bucket on every PUT from client predating column. See
|
||||||
|
`docs/superpowers/specs/2026-07-27-status-buckets-design.md`.
|
||||||
|
- **Config via env:** `API_TOKEN`, `ALLOWED_ORIGINS` (comma list), `DB_PATH`
|
||||||
|
(default `/data/bookmarks.db`), `PORT` (default `8080`), `WEB_PASSWORD`
|
||||||
|
(gates browser UI; unset disables it),
|
||||||
|
`LATEST_CHAPTER_POLL_ENABLED`/`_COOLDOWN`/`_INTERVAL`/`_BATCH`/`_STAGGER`
|
||||||
|
(background latest-chapter poller; defaults on, `1h`/`10m`/`14`/`20s`).
|
||||||
|
|
||||||
|
### Userscript structure (single IIFE, `manga-bookmark.user.js`)
|
||||||
|
|
||||||
|
1. **Site adapters** — one per host, `detect(location, document)` returns page `type` + IDs. ID type/IDs from **URL regex** (most stable); pull `title`/`cover` from **`og:title`/`og:image` meta tags**, not CSS classes.
|
||||||
|
2. **API client** — `apiGet/apiPut/apiDelete` w/ bearer header; `localStorage` key `mangabm:cache` for instant render + offline fallback.
|
||||||
|
3. **Progress logic** — auto-upsert `last_chapter` only when `chapterNum >= stored last_chapter_num` (re-reading old chapters must not regress progress; unparseable -> set current). Manual panel override forces any value.
|
||||||
|
4. **Retry queue** — every write goes through `pushBookmark`/`pushDelete`, so
|
||||||
|
failed mutation parked in `localStorage` (`mangabm:queue`) and replayed on
|
||||||
|
next navigation, reconnect, or `refresh()`. Entries are markers
|
||||||
|
(`{key, op, sendStatus, attempts}`), never payloads — body read from
|
||||||
|
cache at send time, so one entry per key gives ordering + coalescing for
|
||||||
|
free. `sendStatus` **sticky**: while archive pending, later writes to
|
||||||
|
that key keep carrying bucket, stops successful
|
||||||
|
in-between write from silently un-archiving series. `refresh()` drains
|
||||||
|
before fetching, overlays anything still pending, so list never
|
||||||
|
flaps. 400 drops entry, 401 aborts pass and keeps queue,
|
||||||
|
transient failures retry to cap of 10. Latest-chapter writes deliberately
|
||||||
|
stay out of queue. See
|
||||||
|
`docs/superpowers/specs/2026-07-27-offline-retry-queue-design.md`.
|
||||||
|
5. **UI** — rendered inside **Shadow DOM** root to isolate from site CSS
|
||||||
|
(critical on mobile). Three tabs (All / Favourites / Archived) + row of
|
||||||
|
link chips to web UI and both manga sites; `WEB_BASE` sits in CONFIG
|
||||||
|
block next to `API_BASE`.
|
||||||
|
6. **SPA navigation** — Asura is Astro, client-routed on comic/chapter pages: patch `history.pushState`/`replaceState` + listen `popstate`, re-run `detect()` on URL change so auto-update fires w/o reload. Demonic uses classic reloads (initial `document-idle` run suffices).
|
||||||
|
|
||||||
|
### Live URL shapes (verified 2026-07-26, may drift — re-check against live pages before trusting)
|
||||||
|
|
||||||
|
- **asurascans.com**: series `/comics/<slug>` (slug carries a trailing
|
||||||
|
site-wide build-hash suffix, e.g. `-059befe1`, that **rotates on every
|
||||||
|
redeploy**), chapter `/comics/<slug>/chapter/<n>`. `seriesId` must strip
|
||||||
|
the hash (`/-[0-9a-f]{8}$/`, `stripBuildHash` in the userscript,
|
||||||
|
`asuraBuildHash` in the backend); URLs keep the full slug — stale-hash
|
||||||
|
URLs 302 to current ones. Astro-rendered; chapter links present in raw
|
||||||
|
server HTML.
|
||||||
|
- **demonicscans.org**: series `/manga/<slug>` (slug may URL-encode punctuation, e.g. `%2527` for `'`), chapter `/title/<slug>/chapter/<n>/<page>` (older `chaptered.php?manga=<id>&chapter=<n>` form still exists as redirect, what series-page chapter-list anchors link through).
|
||||||
|
Encodings (incl. triple-encoded punctuation like `%25252D`) are identical
|
||||||
|
on /manga/ and /title/ pages, so decode-once seriesIds match — verified
|
||||||
|
2026-07-28.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
Backend (`cd backend`):
|
||||||
|
- Test all: `go test ./...`
|
||||||
|
- Single test: `go test -run TestName ./...`
|
||||||
|
- Build static binary: `CGO_ENABLED=0 go build`
|
||||||
|
|
||||||
|
Local stack: `docker compose up` (named volume mounted at `/data`, `restart: unless-stopped`).
|
||||||
|
|
||||||
|
Smoke test: `curl` endpoints w/ `Authorization: Bearer <token>`; confirm `OPTIONS` preflight returns CORS headers and `/healthz` returns 200.
|
||||||
|
|
||||||
|
## Forge: Gitea, not GitHub
|
||||||
|
|
||||||
|
`origin` = self-hosted Gitea instance (`gitea.violetcrown.my.id`), so **`gh` doesn't work here — use `tea` (Gitea CLI) for anything past plain git.** Common ones:
|
||||||
|
|
||||||
|
- Open PR: `tea pr create --head <branch> --base main --title "..." --description "..."`
|
||||||
|
- List / view / check out: `tea pr list`, `tea pr <n>`, `tea pr checkout <n>`
|
||||||
|
- Issues: `tea issue create`, `tea issue list`
|
||||||
|
- Auth lives in `tea login`, not `GH_TOKEN` env var.
|
||||||
|
|
||||||
|
`tea` prints output as rendered boxes not plain text; PR URL lands on last line.
|
||||||
|
|
||||||
|
## Security invariants
|
||||||
|
|
||||||
|
- Auth on `/bookmarks*`: require `Authorization: Bearer <API_TOKEN>`, **constant-time compare**, 401 otherwise.
|
||||||
|
- CORS: reflect `Origin` only when in `ALLOWED_ORIGINS`; allow `GET,PUT,DELETE,OPTIONS` + headers `Authorization,Content-Type`; answer preflight `OPTIONS` w/ `204`.
|
||||||
|
|
||||||
|
## Relevant skills
|
||||||
|
|
||||||
|
`multi-stage-dockerfile` and `docker-compose-orchestration` for container work (referenced in plan).
|
||||||
|
|
||||||
|
## graphify
|
||||||
|
|
||||||
|
Project has knowledge graph at graphify-out/ w/ god nodes, community structure, cross-file relationships.
|
||||||
|
|
||||||
|
Rules:
|
||||||
|
- For codebase questions, first run `graphify query "<question>"` when graphify-out/graph.json exists. Use `graphify path "<A>" "<B>"` for relationships, `graphify explain "<concept>"` for focused concepts. Return scoped subgraph, usually much smaller than GRAPH_REPORT.md or raw grep output.
|
||||||
|
- If graphify-out/wiki/index.md exists, use for broad navigation instead of raw source browsing.
|
||||||
|
- Read graphify-out/GRAPH_REPORT.md only for broad architecture review or when query/path/explain don't surface enough context.
|
||||||
|
- After modifying code, run `graphify update .` to keep graph current (AST-only, no API cost).
|
||||||
|
|
||||||
|
## OpenCode-specific
|
||||||
|
|
||||||
|
- Caveman mode active by default (`/home/tan/.config/opencode/AGENTS.md`). Keep comms terse — drop articles, fluff, pleasantries. Code/commits/security written normal.
|
||||||
|
- `.superpowers/` and `.agents/` dirs hold skill definitions. Gitea at `gitea.violetcrown.my.id`.
|
||||||
Reference in New Issue
Block a user