tracker

22.3 KB

1. # tracker.worldapi.org
3. The new tracker: a Hybriel app that will track the TV shows (and later movies) the creator
4. follows and watches. **`CONCEPT.md` (the creator's) is the source of truth** — read it first;
5. nothing is built that it does not describe. Built step by step, one ticket per step
6. (tracker.worldapi.org#1, #2, …).
8. **Built so far — step 1 (ticket #1)**: the shell. The header carries the ident login (an
9. identity selector, like calendar/gitoria) and sign-out; the homepage itself stays empty. No
10. design carried over from the old app.
12. **Step 2 (ticket #2)**: the old tracker's MongoDB export is now in `storage/mpackdb/` (new
13. mpackdb ids, every reference re-pointed) — see "Data" and `STATUS.md`. Nothing is shown in the
14. UI yet; the homepage still renders empty. That is a later step, from the creator.
16. **Step 4 (ticket #4)**: the show page, `/shows/:slug` (`components/show.hl`) — poster, title,
17. genre pills, plot, cast (as described in "What it does (step 4)" below), every season with its
18. episodes, and the watch check (episode and season, season bulk-toggles its episodes).
20. **Step 5 (ticket #5)**: `/unwatched` (`components/unwatched.hl`) — every already-released,
21. unwatched episode of a show the signed-in user follows, newest release first (see "What it does
22. (step 5)" below).
24. **Step 6 (ticket #6)**: `/schedule` (`components/schedule.hl`) — every not-yet-released episode
25. of a show the signed-in user follows, soonest first, no check icons (see "What it does (step 6)"
26. below).
28. **Step 7 (ticket #7)**: `/my/shows` (`components/myshows.hl`) — every show the signed-in user
29. follows, newest follow first: small poster, title, last watched episode (`S08E35`) (see "What it
30. does (step 7)" below). The homepage itself is still empty.
32. **Step 8 (ticket #8)**: the personal lists all live under `/my/`: `/my/shows`, `/my/unwatched`,
33. `/my/schedule` (old `/unwatched`, `/schedule` answer 301). Episodes everywhere as `S01E01`, show
34. titles in lists with the year (`Doctor Who (2005)`), "1 episode" singular, and every `/my/` page
35. under 1 s full load on the real data (see "What it does (step 8)" below).
37. Written in **Hybriel** on **hl:web**, same stack and conventions as `ident.worldapi.org`
38. (vendored plugins/binary copied from there, see "Vendored Hybriel").
40. ## Run (dev, Loreana)
42. ```bash
43. cd /media/STORAGE/projects/tracker.worldapi.org
44. TRACKER_PORT=8700 setsid nohup ./bin/hybriel project.hl > server.log 2>&1 < /dev/null & echo $! > server.pid
45. # stop: kill $(cat server.pid)
46. ```
48. * Config (env; the real environment outranks nothing here — there is no `.env` reader in
49. project.hl, unlike ident's SMTP settings — set these in the shell or `docker-compose.yml`):
51. | Variable | Default | |
52. |---|---|---|
53. | `TRACKER_PORT` | 45008 | |
54. | `TRACKER_URL` | `http://127.0.0.1:<port>` | this app's own origin — the ident login button's `return=` is built from it |
55. | `IDENT_URL` | `https://ident.worldapi.org` | |
56. | `TRACKER_KEY` / `TRACKER_SECRET` | `''` | this app's API key + secret, from ident's `/apps` (register once, origin = `TRACKER_URL`) — **not set yet on Byrodin**: the first deploy (architect) registers the app in the live ident and puts these in `.env` next to `docker-compose.yml`, exactly like ident's own `.env` holds its SMTP settings |
57. | `TRACKER_WATCH` | on | `0` = no dev watcher (the container) |
58. | `TRACKER_STORAGE` | `./storage/mpackdb` | the `usersTable` directory |
59. | `TRACKER_SESSIONS` | `./.sessions` (hl:web's own default) | this app's own session store |
60. | `HL_HOST` (or `HOST`) | 0.0.0.0 | interface to bind; `127.0.0.1` on Byrodin |
62. Without `TRACKER_KEY`/`TRACKER_SECRET`, `/` still renders (signed out, the selector and "Log
63. in with ident" show in the header); a login attempt answers `'login is not set up on this
64. server (TRACKER_KEY / TRACKER_SECRET missing)'` instead of exchanging a code — so the app is
65. never a dead 500 while waiting for that one-time setup.
67. ## What it does (step 1)
69. * **Login, copied unchanged from calendar.worldapi.org** (rejected once for a centered
70. sign-in and no header selector — architect, 2026-09-27): ident only, no own passwords
71. (ident's login button flow, ident.worldapi.org README "How apps use ident"), the identity
72. selector (`<ident-selector>`, ident's `/selector.js`) sits in the header
73. (`components/main.hl`, `userBox`), a plain "Log in with ident" link beside it when signed
74. out. Choosing an identity in the selector fires `ident-login` (one-time code); `login.js`
75. (an external-component bridge, allowed per the creator: "login.js is correct, as thats for
76. externals in general") hands the code to a hidden input, whose `change` calls the server
77. face `trackerLogin` (`users.hl` `exchangeCode`, `POST <ident>/api/exchange` — nothing else:
78. ident does not hand over a display name yet, ident#23 done / ident#11 on hold), which makes
79. or finds this app's own user record (`usersTable`, `storage/mpackdb/users.db`) and sets
80. `session.user = { id }`. `/login/callback` is the same exchange as a plain redirect (the
81. login button's return URL) for a client that has no socket yet. "Log out" in the header
82. calls `trackerLogOut`; ident's own login is untouched. This app's own session cookie is
83. `trackersid` (cookies ignore ports, an own name keeps it apart from ident's `identsid` on
84. the same dev host, hybriel#10/#17).
85. * **The empty homepage** (`/`, `components/home.hl`): no content at all, signed in or out —
86. the header alone carries the login state. Nothing else.
87. * **One mpackdb table**: `storage/mpackdb/users.db` (`identity` → this app's user id — no
88. display name, no other per-user data yet). Step 2 (tracker.worldapi.org#2, open) brings the
89. old tracker's data across.
91. ## What it does (step 4)
93. `/shows/:slug` (`components/show.hl`, slug = the migrated `urlSegment`), read-only data from
94. `shows.hl`, per-user watch state from `watches.hl` (both reused as-is by `/unwatched` and
95. `/schedule`, tickets #5/#6 — "reuse, don't copy"):
97. * **Header**: poster on the left (`/posters/<name>`, `project.hl` `posterRoute` — served from
98. `storage/mpackdb/posters/`; the real poster files were never in the Mongo backup, see
99. `DECISIONS.md` "tracker concept" — a placeholder SVG shows until a later TMDB step brings
100. real ones back), title, genre pills (blue, link to `/genre/<slug>`) and the plot summary to
101. its right, the cast below as comma-separated red links to `/person/<slug>`.
102. * **Seasons**, latest first, the latest expanded and every other one collapsed to start; each
103. row: a round check icon (a disc with a check, drawn in SVG/CSS, no icon font), the season
104. title/number, its episode count. Its episodes (number + title, and their own check icon)
105. show once expanded (click the row to toggle).
106. * **The watch check** (signed-in only — signed out, no check icons show at all): clicking an
107. episode's check toggles that one watch; clicking a season's check toggles the season's own
108. watch AND every one of its episodes at once (`watches.hl` `setSeasonWatched`). Every click is
109. a server round trip (`emit server showToggleEpisode` / `showToggleSeason` / `showRows` for
110. collapse/expand) that rebuilds the row list server-side and reassigns it whole — a season has
111. at most a few dozen episodes, cheap. A **Hybriel gap found here** (filed as hybriel#115,
112. reported after this ticket's first attempt): a plain per-instance member function that calls
113. an hl:mpackdb-backed import comes back `null` when called from inside an `on server` face,
114. even though the very same call works as a member's own top-level initializer — the fix is to
115. declare such helpers `static` (the same shape calendar.worldapi.org's `soonOf` already uses).
116. `components/show.hl`'s own helpers (`buildRows`, `genreRowsOf`, …) are `static` for exactly
117. this reason.
118. * **Data fix**: `tools/relink-episode-seasons.hl`, a one-off idempotent tool that links every
119. episode whose `season` was still null in the migrated data (36,194 of them, ticket #2) to its
120. season by matching `(show, seasonNumber)` — never touches an episode whose season is already
121. set, never runs `update()` on the live table (hybriel#113; it rebuilds a fresh episodes table
122. and swaps the files over, the same rule `tools/migrate.hl` follows). Not run against the live
123. data yet — the architect runs it (stop the container first, `storage/mpackdb` is not shared
124. across processes, hybriel#21).
126. ## What it does (step 5)
128. `/unwatched` (`components/unwatched.hl`): every episode of a show the signed-in user follows
129. (`follows.hl`, new) that is already released (`release` ≤ today) and not yet watched
130. (`watches.hl` `isWatched`), newest release first. Creator: "/unwatched lists all unwatched
131. episodes of shows followed in release date desc order"; "check icon is a disc with a check in
132. it" — the SAME icon/class (`watches.hl` `watchClassOf`, moved there from `components/show.hl` so
133. both pages share one definition instead of each declaring its own) and the same
134. `setWatched`/`isWatched` watch logic as the show page (step 4), not copied.
136. * Each row: check icon, the show's title (linking to `/shows/:slug`), "Ep `<number>` ·
137. `<title>`", the release date.
138. * A row only ever shows an unwatched episode, so a click always marks it watched (never toggles
139. back, unlike the show page's checks) — the row leaves the list. Signed out: no rows, a
140. "Sign in to see the shows you follow." message instead.
141. * `follows.hl` (new): read-only per-user follow data (`followedShowIds`), kept apart from
142. `shows.hl`/`watches.hl` the same way, for `/schedule` (ticket #6) to reuse.
144. ## What it does (step 6)
146. `/schedule` (`components/schedule.hl`): every episode of a show the signed-in user follows
147. (`follows.hl`) that is NOT yet released (`release` > today), soonest first. Creator: "/schedule
148. has a similar list without check icons for the upcoming episodes of shows followed" — same row
149. layout as `/unwatched` (show title linking to `/shows/:slug`, "Ep `<number>` · `<title>`", the
150. release date), minus the check icon and minus any click handling: the page is read-only, so it
151. needs no `on server` face at all. Signed out: no rows, the same "Sign in to see the shows you
152. follow." message as `/unwatched`.
154. ## What it does (step 7)
156. `/my/shows` (`components/myshows.hl`): every show the signed-in user follows, ordered by the
157. follow's `at` (epoch ms), newest first. Creator: "trackers /my/shows that just ists the shows in
158. desc order i followed them, small poster, title, last episode like s08e35". Read-only, no `on
159. server` face (like `/schedule`).
161. * Each row: a small poster (2.5rem wide, the same `/posters/<name>` route + placeholder as the show
162. page; a show with no poster name at all gets `/posters/none`, i.e. the route's placeholder), the
163. title linking to `/shows/<slug>`, and the **last watched episode** as `SxxEyy` (zero-padded to
164. two digits) = the HIGHEST season/episode number the user has an episode watch for (architect's
165. reading, in the ticket) — not the most recently watched one; season watches alone don't count.
166. Nothing watched → no episode element at all.
167. * Signed out: no rows, the same "Sign in to see the shows you follow." as `/unwatched`.
168. * Cost: touches only the user's follows + episode watches (one `episodeById` fetch per watch),
169. never all episodes of a followed show — 128 rows in ~0.2 s on a copy of the real data (STATUS.md).
170. * Reuse: `follows.hl` `followsOfUser` (new — the whole follow record, `followedShowIds` now
171. builds on it), `shows.hl` `episodeById` (new, one line), `showById`, `posterName`, `watches.hl`
172. `watchesOfUser`.
174. ## What it does (step 8)
176. * Routes (`project.hl`): `/my/unwatched`, `/my/schedule`; the old `/unwatched`, `/schedule` are
177. function routes answering **301** to them (`movedTo`, no query carried — the pages take none).
178. * `shows.hl` (shared by all lists): `episodeCode(s, e)` → `S01E01` (`/my/shows`, `/my/unwatched`,
179. `/my/schedule` rows: `S01E02 · <title>`), `titleWithYear(show)` → `Doctor Who (2005)` (`year`,
180. else the first 4 chars of `release`, else the bare title — 197 shows have no `year`), `pad2`,
181. `posterUrlOf(show)`. The show page's own `h1` stays without the year (it is not a list).
182. * Show page: season count `1 episode` / `N episodes`.
183. * **Speed** (the creator's real data: 128 follows, 11,692 watches, 831 unwatched rows):
184. * `/unwatched` was ~15 s: `isWatched` scanned all 11,692 watches per episode. Now
185. `watches.hl` `watchedSet(rows)` builds `'<type>:<id>' → true` ONCE; `/my/unwatched` and the
186. show page's `buildRows` look up that map. Now ~0.6 s server render (the rest is fetching
187. every episode of 128 shows; the insertion sort is ~50 ms).
188. * `/my/shows` "25 s full load while data takes 0.2 s": (1) **hl:web serves one request at a
189. time** — measured: a `/my/shows` request made during a 15 s `/unwatched` render waited 13.7 s;
190. every poster request of every visitor queues the same way. Fixing `/unwatched` removes that.
191. (2) 128 rows = 128 different `/posters/<oldId>.jpg` URLs, all answering the same placeholder
192. (no poster files exist yet) — 128 requests per load. `posterUrlOf` now gives rows without a
193. poster FILE the one URL `/posters/none` → 1 request, cached.
194. * How it was measured: see STATUS.md ticket #8 ("Real-data check").
196. ## Test
198. ```bash
199. node tests/browser.mjs # THE GATE: this app's own server + its OWN ident (a copy of
200. # ident's code without .env, codes to a mail sink — no live
201. # ident, no real mail; tests/identkit.mjs, same as calendar's
202. # gate) + a real headless Chrome: signed out (header shows the
203. # selector + "Log in with ident", the page itself is empty) ->
204. # sign in -> header shows "Log out", page still empty -> sign
205. # out -> signed out again -> a reload stays signed out. Also
206. # checks the header has no bottom border and filled buttons
207. # (incl. the ident selector's) have none, while inverted ones
208. # ("Log out") keep theirs.
209. # tracker.worldapi.org#4: a fixture show (tests/seed-show.hl,
210. # written into the gate's own storage before the server starts)
211. # proves /shows/:slug — header renders, no checks signed out;
212. # signed in, click an episode check (turns solid), click a
213. # season check (itself AND its episodes turn solid, proven
214. # after a reload — server-side, not just client state).
215. # tracker.worldapi.org#5: the same fixture (now followed by the
216. # test user) proves /unwatched — signed out, no rows; signed in,
217. # only the two already-released episodes show, newest first, the
218. # far-future one excluded; click a check, the row disappears
219. # (proven server-side after a reload).
220. # tracker.worldapi.org#6: the same fixture proves /schedule —
221. # signed out, no rows; signed in, only the far-future episode
222. # shows (the two already-released ones excluded), no check icons
223. # at all, unaffected by any watch toggle on the other pages.
224. # tracker.worldapi.org#7: the fixture now has a 2nd followed
225. # show (followed later, no poster name, never watched) and
226. # proves /my/shows — signed out, the sign-in message; signed
227. # in, newest follow first, title links, loaded posters (the
228. # placeholder), S01E02 after /unwatched's click, then S02E01
229. # (highest, not most recent) after the show-page checks; the
230. # unwatched show shows no episode.
231. # tracker.worldapi.org#8: the lists moved to /my/unwatched and
232. # /my/schedule (old addresses: 301, and the browser lands on
233. # the new one), rows say S01E02 / S02E01, titles carry the
234. # year ("Gate Test Show (2024)", "Unwatched Gate Show (2025)"
235. # — from `release`, that show has no `year`), the show page
236. # says "1 episode" / "2 episodes", /my/shows gives the show
237. # with a poster FILE (the gate writes posters/sh1.png) its
238. # own URL and the other one /posters/none.
239. # 49 checks. Own servers :8700 (this app) / :8701 (ident copy);
240. # own storage .scratch/gate-store; Chrome on 8702-8709.
241. # Other ports (workers get 8720-8739):
242. # TRACKER_GATE_PORT=8720 TRACKER_GATE_IDENT_PORT=8721 TRACKER_GATE_CHROME=8722-8726 node tests/browser.mjs
243. # TRACKER_GATE_SHOTS=/tmp/x also writes home/show/my-shows/
244. # my-unwatched/my-schedule.png (1280×900) — LOOK at them
245. ps -eo pid,args | grep [h]l-browser-tier # must print nothing afterwards
246. ```
248. ## Deploy (Byrodin)
250. Target: `/CONTAINERS/projects/tracker.worldapi.org` on Byrodin, container
251. `tracker.worldapi.org` (`docker-compose.yml`: debian:12-slim, host network,
252. `HL_HOST=127.0.0.1`, `TRACKER_PORT=45008`, `TRACKER_WATCH=0`, the folder mounted at
253. `/home/tracker`, `./bin/hybriel project.hl`), public https://tracker.worldapi.org/ via
254. nginx (TLS ends there; no baseUrl/tls in the app, like ident/notes).
255. * **First deploy: done by the architect** (folder, nginx vhost with WebSocket Upgrade
256. headers, cert, DNS, **and registering this app in the live ident** — `/apps` → name +
257. origin `https://tracker.worldapi.org` → the API key + secret go into `.env` next to
258. `docker-compose.yml`, `TRACKER_KEY=… TRACKER_SECRET=…`).
259. * **Later: `./deploy.sh`** on Loreana, in this folder: runs the gate (refuses on a failure;
260. `--skip-tests` skips it LOUDLY), rsyncs the code to
261. `[email protected]:/CONTAINERS/projects/tracker.worldapi.org` (never `storage/`,
262. `.sessions/`, `.env`, `.scratch/`, `server.*`, logs — the preview is checked for them; no
263. `--delete`), `docker compose up -d && docker compose restart` over `ssh -F /dev/null`,
264. then waits for https://tracker.worldapi.org/ to answer 200.
265. * `./deploy.sh --dry-run` = the gate + `rsync -n` + the commands it would run (no restart, no
266. URL check). `--target DIR|HOST:DIR` and `--url URL` point it elsewhere (tested against a
267. local directory, see STATUS.md).
269. ## Data
271. `storage/mpackdb/`: `users.db` (`identity` → this app's own user id, `users.hl`) plus, since
272. step 2, the old tracker's data — `genres.db` (27), `persons.db` (15157), `shows.db` (9453),
273. `seasons.db` (6430), `episodes.db` (231584), `follows.db` (128), `watches.db` (11692), all with
274. fresh mpackdb ids and every reference re-pointed (`tools/migrate.hl`); the one old user is this
275. app's user for ident short id `az5b2`. Counts and the referential-integrity proof:
276. `STATUS.md` "ticket #2". Nothing of this is shown in the UI yet.
278. ## Files
280. | File | |
281. |---|---|
282. | `CONCEPT.md` | the creator's concept — do not edit |
283. | `project.hl` | manifest: routes (`/login/callback`, `/login/failed`, `/login.js`, `/posters/:name`, `/shows/:slug`, `/my/shows`, `/my/unwatched`, `/my/schedule`, `/unwatched` + `/schedule` → 301, `/` component Home), the app's own session cookie |
284. | `users.hl` | the ident exchange + the `usersTable`, copied from calendar.worldapi.org's `users.hl` |
285. | `login.js` | bridge between `<ident-selector>`'s `ident-login` event and the shell, copied verbatim from calendar.worldapi.org |
286. | `components/home.hl` | `/`: the empty homepage — no content, signed in or out |
287. | `components/main.hl` | the shell (header: brand, `<ident-selector>`, log in / log out) |
288. | `components/loginfailed.hl` | `/login/failed`: why a login didn't work |
289. | `components/show.hl` | `/shows/:slug`: the show page (header, seasons, episodes, watch check) |
290. | `components/unwatched.hl` | `/my/unwatched`: unwatched, already-released episodes of followed shows, newest first |
291. | `components/schedule.hl` | `/my/schedule`: not-yet-released episodes of followed shows, soonest first, no checks |
292. | `components/myshows.hl` | `/my/shows`: followed shows, newest follow first — small poster, title, last watched `SxxEyy` |
293. | `shows.hl` | read-only data access (shows/seasons/episodes/genres/persons), plus the list labels `episodeCode`/`titleWithYear`/`posterUrlOf` (#8), reused by the `/my/` pages |
294. | `follows.hl` | read-only per-user follow data (`followsOfUser`, `followedShowIds`), reused by `/unwatched`/`/schedule`/`/my/shows` |
295. | `watches.hl` | per-user watch state (episode/season checks, the shared check-icon class `watchClassOf`, `watchedSet` = the user's watches as a map, built once per page), reused by `/unwatched`/`/schedule`/`/my/shows` |
296. | `styles.hl` | all CSS (imports the tokens from `shared/tokens.hl`; accent green `#4ec9b0`) |
297. | `shared/tokens.hl` | the WorldAPI tokens, vendored verbatim from `ident.worldapi.org/shared/tokens.hl` |
298. | `tests/browser.mjs` | the gate (above) |
299. | `tests/seed-show.hl` | writes the gate's fixture show (two seasons, three episodes) and, since ticket #5, a follow of it for the test user (#7: plus a 2nd, later-followed, never-watched show), before the server starts |
300. | `tests/identkit.mjs` | starts a throwaway ident copy for the gate, copied from calendar.worldapi.org's `tests/` |
301. | `tests/cdp.mjs`, `tests/ports.mjs` | the CDP browser driver, copied from `ident.worldapi.org/tests/` |
302. | `docker-compose.yml`, `Dockerfile`, `deploy.sh` | Byrodin container; the deploy from Loreana (section "Deploy") |
303. | `tools/migrate.hl` | one-off: old MongoDB export → `storage/mpackdb/` (step 2, idempotent, see `STATUS.md`) |
304. | `tools/verify.hl` | one-off: proves the migrated data against a COPY of `storage/mpackdb/` (counts, zero dangling references, one show end to end) |
305. | `tools/relink-episode-seasons.hl` | one-off: links episodes with no `season` (step 2 leftovers) by `(show, seasonNumber)` — not run against the live data yet, see "What it does (step 4)" |
307. ## Vendored Hybriel
309. `bin/hybriel` + `plugins/` copied verbatim from `ident.worldapi.org` (2026-09-27), sha256
310. `9e5e95b33680eb68a016e9e48a76c9f92193fd2ffdbdf437c1aab1bda2731a0d` — hybriel master
311. 837fe120 (ident's mission 036), the newest vendored+gated build available locally. No local
312. patch. Re-vendor the same way: copy `bin/hybriel` + `plugins/` from a current worldapi app,
313. run the gate.