Dailiness is guessed from the source's wording, which is a weak signal and wrong in both directions. Guessing on a reader's behalf and hoping they notice is the wrong default for a checklist they may build a streak on, so `detectDaily` now starts false and the control carries an Experimental tag saying what it does and doesn't know. The default applies to new readers only — a stored `prefs` keeps its value, because switching it off under someone who has been ticking auto-detected checklists would pull those chips out of the strip with no explanation. Nothing is deleted either way. Co-Authored-By: Claude Opus 5 (1M context) <[email protected]>
14 KiB
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
What this is
A web app that aggregates live and upcoming events across popular gacha games, plots them on a calendar, sorts them by end date or by what the reader is partway through, tracks day-by-day progress on events that repeat daily, and lets a user mark events completed.
Status: working app, refreshing itself on a schedule. Schema, two parsers, seven sources across
six games, the full interface, offline support, a static server, a Docker image and CI all exist and
are tested. The refresh runner (bun run refresh) fetches, caches raw snapshots and rebuilds the
feed; .github/workflows/refresh.yml runs it twice a day and commits only when a page actually
changed. The SQLite layer and the review queue are still specified in docs/ but not built, so the
feed is a static JSON file built from snapshots, falling back to checked-in fixtures.
Three constraints that shape everything
- No accounts, no logins, no user records. Completion state lives in the browser's
localStorage, keyed by event ID. There is no user table and no session. Any request implying "sync across devices" is solved with export/import JSON, not a server-side user. - No LLM in the pipeline. Event data is extracted by deterministic code-based parsers only.
There is no Anthropic dependency, no API key, and no per-run inference cost. A source that
cannot be parsed deterministically does not get an adapter — see
docs/INGESTION.md§ No LLM. - A server is allowed (Bun) and owns fetching, parsing, and SQLite. The client only ever calls
this app's own
/api/*.
Stack
| Layer | Choice |
|---|---|
| Runtime / server / bundler / test runner | Bun 1.3 (Bun.serve, bun:sqlite, bun test, bun build) |
| UI | React 19 + TypeScript (strict) + Tailwind |
| Storage | SQLite via bun:sqlite (gitignored — *.sqlite) |
| Validation | Zod — one schema module shared by server and client |
The only runtime dependency is zod. Do not add a bundler, test runner, HTTP client, or HTML
parsing library — Bun covers all four. tsconfig.json runs strict plus
noUncheckedIndexedAccess and exactOptionalPropertyTypes.
Commands
bun install
bun test # full suite, offline, no network, no build needed
bun run typecheck # tsc --noEmit
bun run dev # build then serve on :3000
bun run build # feed + css + js + static into public/
# Fetch sources and refresh the snapshots. Makes real requests — see § Scraping
# conduct before running it, and prefer --dry-run.
bun run refresh --dry-run
bun run refresh --only genshin-game8-events
# Run one source against its fixture (offline, free)
bun run parse genshin-game8-events fixtures/genshin/game8-events-2026-08-14.html
bun run parse endfield-wikigg-events fixtures/endfield/wikigg-events-2026-08-15.html --json
# Single test file / single test
bun test test/dates.test.ts
bun test --test-name-pattern "year-less"
# Hosting under a subpath (GitHub Pages)
BASE_PATH=/gacha-event-tracker/ bun run build
Tests must never need build output. They run before bun run build in CI; anything reading
public/ must create its own fixture tree instead.
bun run parse ... --json is also how .expected.json fixtures are regenerated after an
intentional parser change. Regenerating them makes the test self-consistent, not correct — always
re-verify a sample against the live page afterward.
Current state of the code
src/shared/ schema.ts (the contract), time.ts, daily.ts, effort.ts, games.ts, feed.ts
src/ingest/ html.ts, dates.ts (six formats), merge.ts, sanitize.ts, robots.ts, snapshots.ts
parsers/ game8.ts, wikigg.ts — keyed by SITE, not game
adapters/ index.ts — SOURCES registry binding url+game+parser, and the sanitize seam
src/client/ React app, service worker, manifest
state/ progress, daily log, ignores, prefs, sort — all localStorage
lens.ts — who sees which rows (focus, outstanding, next-to-expire); pure
scripts/ build-feed.ts, parse-fixture.ts (offline), refresh-sources.ts (fetches)
serve.ts static server + /api/health
test/ 318 tests
fixtures/<game>/ raw HTML + .expected.json per source — pinned, kept forever
snapshots/ current page per source, rewritten by refresh — see its README
Not yet built: the SQLite layer and the review UI. Everything upstream of them runs as files on disk.
Domain rules that are not obvious from the code
These come from how gacha games actually schedule things, and they cause most bugs here:
- Store every timestamp as UTC ISO 8601. Sources publish in a mix of UTC+8, server-local, and "after maintenance".
- Banner ends are usually global and simultaneous; event ends are usually per-region. Character
banners end at one instant worldwide; story/login events end at each region's daily reset (Asia /
America / Europe differ by hours).
regionScopedandregionEndsexist for this — do not collapse them into one timestamp. endsAt: nullis a correct, expected value. An event whose end is genuinely unannounced getsendsAt: nullandendPrecision: "unknown". Never invent a plausible date to satisfy a non-null type. This is the worst failure mode this codebase has, because the user's entire reason for visiting is trusting the end date.- Patch cycles are ~6 weeks. Any event over 180 days is a parse error, not a long event. The validator and the tests both reject it.
Working on parsers
- Parsers are pure. No network, no
Date.now(), no randomness — time arrives asctx.now. This is what makes fixture tests meaningful; a parser that reads the clock cannot be tested. - Skip, never guess. Every function in
dates.tsreturnsnullrather than inferring a missing year, month, or end.readColumnTabledrops a row it cannot date. An omitted event is a recoverable disappointment; a confidently wrong date is the failure this product exists to prevent. - Parsers are keyed by site, not game. One
game8parser serves six sources;wikiggserves one. Adding a source for a known site is oneSOURCESentry; a new site is a parser module. - Game8 has no single template. Five shapes are known and a page may mix them: label/value
detail tables, column tables, image-grid schedules (unsupportable), combined label+range+blurb
cells, and rowspan Start/End pairs. Full table in
docs/INGESTION.md. Before assuming a new Game8 page will work, dump its structure and check every table — Endfield was written off as undatable on a pass that only inspected itsDurationrows, and its real events were further down the page. - Prefer a source that states machine-readable times. wiki.gg emits ISO timestamps with a timer
per server region, which is the only reason
regionEndscarries real data anywhere. - Silent drops are the dangerous failure. A date format the parser does not recognise makes
events vanish with no error. Abbreviated months (
Apr. 29 - May 13, 2026) are supported for exactly this reason. When adding a source, compare the parser's event count against an independent count of the page.
Event IDs are localStorage keys
`${game}:${slugify(title)}:${startsAt.slice(0, 10)}`
→ "genshin:mutual-aid-in-bloom-into-the-frostlands:2026-08-12"
Changing slugify or eventId in src/shared/schema.ts — including seemingly cosmetic changes to
the slug rules — silently orphans every completion mark every user has, with no server-side
recovery, because the server never had the data. If it must change, ship a client-side migration
that remaps old keys and keep it for at least a year. Use the schema-guardian agent on any such
change.
Two more key spaces have the same property, for the same reason:
dailies:<game>(dailiesIdinsrc/shared/daily.ts) keys a game's standing daily chore. Two segments, so it cannot collide with an event ID.- Game-day keys (
dayKey) areYYYY-MM-DDin server-reset space, not UTC — the day rolls at 04:00 local server time. They are storage keys and they are compared with<and sorted, so the format is fixed. Changing the reset hour or the offsets moves every reader's streak by a day. A game whose server map differs lists the affected regions inresetOffsets(games.ts) — Endfield serves Europe off the Americas machine, soeuropeis UTC-5 there and its reset is 09:00 UTC, not 03:00. Keep that override per region: a blanket per-game offset drags the regions that do have their own server onto someone else's clock. Every day-key function takes an optionalgame— anything reading or writing a tick must pass it, or it writes under one clock and reads under another. A day that drops out ofdailyDaysrenders no pip, so a tick on it becomes unreachable; check real fixture windows before changing an offset.
The sanitizer at the ingest boundary recomputes an event ID only when a sanitized title actually changed and the ID was minted the standard way. If a change to it starts moving IDs on real fixtures, that is a data-loss bug, not a diff to regenerate.
Scraping conduct
Sources are community wikis. Treat them as a guest would:
- Honor
robots.txt; set a descriptiveUser-Agentwith a contact URL. - One request per source per refresh cycle, minimum 6 hours apart.
- Send
If-None-Match/If-Modified-Since; treat304as "skip, unchanged". - Cache raw snapshots so re-parsing never re-fetches. Iterate against fixtures, not the network.
- Record
sourceUrlon every event and surface attribution in the UI.
Note that game8.co disallows GPTBot and Google-Extended in robots.txt — it has opted out of
AI-training crawlers. Our use is a low-rate personal aggregator with attribution and no model
training, and no User-agent: * rule applies to our paths. Keep it that way: do not raise the fetch
rate, and do not add an LLM that consumes page content.
A source whose ToS forbids automated access does not get an adapter. Flag it and ask.
scripts/refresh-sources.ts enforces all of the above in code — the 6h floor, one request, no
retries, conditional headers, robots (failing closed when robots.txt cannot be read). Anything
that would make it fetch more often is a change to this section first.
Untrusted input
Every string on an event came from a page we do not control. src/ingest/sanitize.ts is the trust
boundary and it is wired into toAdapter() in src/ingest/adapters/index.ts, which is the single
seam every source passes through — do not sanitize inside a parser, and do not add a code path
that reaches parser.parse directly. Parsers stay pure readers of one site's markup.
The sanitizer never touches a date, cleans rather than drops (a title that sanitizes to nothing is
the only drop), and logs every repair and drop by default. See docs/INGESTION.md § Stage 2.5.
Events that repeat daily
Some events are twenty small jobs on twenty deadlines, not one job with an end date, and a missed
day is unrecoverable. src/shared/daily.ts decides dailiness from what the source published —
type: "login", or "daily"/"check-in"/"7-day" wording — and never from a game's habits or an
event's length. It adds no schema field, so the feed contract is untouched.
- The day rolls at 04:00 server time (
RESET_HOUR_LOCAL), per region. Getting this wrong ticks the wrong box for four hours every night. - An unannounced end yields no checklist, not a checklist of guessed length — the
endsAt: nullrule applies here exactly as it does to a countdown. - A tick is never removed except by the reader, including ticks outside the window the feed now claims. A source quietly moving a date must not erase a fortnight's streak that exists nowhere else.
- A repeating event the reader marked done leaves the strip. They have said there is nothing left to do; keeping a tickable chip for it is the app arguing with them. Their logged days are untouched, so unmarking it brings the chip and the streak straight back.
- Detection is a guess, not a verdict — and it ships off.
prefs.detectDailydefaults tofalseand the control is labelled experimental: wording is a weak signal and gets it wrong in both directions, so a new reader opts in rather than out. The default moves nothing for an existing reader, whose storedprefswins. The reader can mark any event as repeating, or unmark one detection got wrong (progress.daily, resolved byresolveDaily), whether the guessing is on or off. Store an override only when it disagrees with detection — recording agreement would freeze today's guess and stop a better parser from ever reaching that event. Neither control ever deletes a mark or a logged day, so both are reversible.
Conventions
- Zod schemas are the single source of truth for types. Derive with
z.infer<>; never hand-write an interface that duplicates a schema. - Every adapter ships a fixture in
fixtures/<game>/and a test asserting parsed output. This is how a source silently changing shape gets caught. - Keep old fixtures when a source changes shape — the old one is the regression test proving the
parser still handles the previous format. Fixtures are pinned and permanent;
snapshots/is the current page and gets overwritten. Do not conflate them. - A list row is one target. The event row opens the event and does nothing else — status, effort, notes and the daily checklist all live in the detail sheet. A second control inside a full-bleed row target is a mis-tap waiting to happen, and a decorative chevron says "this opens" without adding a second stop for keyboard and screen-reader users.
- Sorting groups, it never reorders within a group. Every mode falls back to
endingSoonestFirst, so choosing one can never cost the reader the deadline order the product exists for. - Telling the reader to do something is not the same as showing it to them.
showCompletedandshowIgnoreddecide what they can look at; the "next to expire" headline and the dailies strip are instructions, so both drop anything done or ignored regardless (outstandinginsrc/client/state/lens.ts). Being pointed at a job you already finished is the bug either way. For the same reason "next to expire" reads the minimum end date rather than the head of the list, which under "doing first" is a different event entirely.