Josh Creek 4af33709a3 test: make the suite's assertions falsifiable and its state isolated
Several assertions could not fail:

- "the catch update remains saved" was `caught.isChecked() || notes.includes(...)`
  shared by two scenarios, so either half satisfied both. Split into two steps
  that each assert the outcome their own scenario is about.
- The token-refresh check read a global counter with `> 0` and asserted an upload
  had happened `some(...)`, both already satisfied by the preceding scenario. It
  now asserts exactly one refresh, ordered before the upload.
- The box step ignored its box argument and asserted on the first N entries on
  the page; it now scopes to that box and checks its full contents.
- The filter step asserted on whichever entry was first after filtering; it now
  records the caught entry beforehand and names it, and checks the filter did not
  exclude everything.
- The empty-state precondition asserted emptiness instead of establishing it,
  which a fresh user satisfies for free.
- Offline coverage was `caches.keys().length > 0`. It now checks the precache
  contract: one workbox cache holding the shell and a revisioned web manifest,
  with _app/immutable assets cached without a revision query. The scenario that
  claimed to test a trailing slash did not; it is replaced with real offline
  client-side navigation.

The mock provider kept recorded requests, its refresh counter and the
fail-uploads switch in one process-wide object that only one step reset, so
scenario order was load-bearing and the failing-upload scenario poisoned
everything after it. An auto fixture now resets it per scenario, and the mock no
longer records its own control-plane calls. That reset is why the suite stays on
a single worker, which is now documented.

Coverage was gated at 90% per file over an allowlist of exactly the five files
that had tests, so new code was invisible to it permanently. It now measures all
of src/lib with global thresholds at the measured baseline, and no longer runs
the unit tests twice.

Also: a global teardown removes the users each run creates, the Supabase wrapper
distinguishes a stopped stack from a broken CLI call and detects an unseeded
database, the sign-in rate limit is raised above what one serial run needs, and
the integration suite no longer falls back to a hard-coded anon key that would
mask a misconfigured run.

The password-reset scenarios are renamed to what they actually cover: following a
real recovery link bounces to /signin, because the browser client persists no
cookies and so cannot keep the session it parses out of the URL. The helper for
the real flow is left in place and the gap is documented.
2026-09-13 17:38:42 +01:00

Living Dex Tracker

A web app to track completion of a living Pokédex.

Developing

  1. Clone the repository

  2. Install the dependencies with npm install

  3. Ensure that Docker is running

  4. An example .env file is provided in the repository. You will need to copy .env.example to .env and fill in the values with your own credentials. For local development with Supabase running in Docker, you can use the following values:

    • The PUBLIC_SUPABASE_URL will be "http://127.0.0.1:54321"
    • The PUBLIC_SUPABASE_ANON_KEY will be the 'Publishable' authentication key displayed when you run Supabase in the terminal
    • The SUPABASE_SERVICE_ROLE_KEY will be the 'Secret' authentication key displayed when you run Supabase in the terminal
  5. Start local Supabase and a development server with npm run dev:supabase

  6. The Pokédex data is automatically seeded via database migrations when Supabase starts

  7. Create an account using the sign-up form and access the email it sends in MailPit to verify your email address. N.B. All local emails are captured by MailPit when running Supabase in Docker.

  8. You can now use the app.

Reference Data Updates

The seed data lives in supabase/migrations/20260118001000_seed_reference_data.sql. Update that migration directly when new data is added. You can access a local copy of Supabase to check it.

Building

To create a production version:

npm run build

Testing

The test suite is split by responsibility so a failure points to the correct layer:

  • tests/unit contains fast, isolated tests for utilities, repositories, and services.
  • tests/data validates the tracked Pokémon, game, region, dex, and sprite reference files.
  • tests/integration checks the migrated Supabase schema, views, constraints, RLS, and repositories.
  • tests/bdd/features is the executable Gherkin specification for user-visible behaviour. Step definitions and browser fixtures live beside it under tests/bdd.
  • tests/build verifies generated service-worker and manifest artifacts after each supported build.

Run the offline suites while developing. test:fast includes the coverage run, so there is no need to run both:

npm run test:fast

Coverage is measured across all of src/lib (excluding type-only models and the browser-only store/action modules) with global thresholds set to the current baseline, so new untested code lowers the number instead of being invisible to the gate. Ratchet the thresholds in vitest.config.mts up as coverage grows, never down.

Database and BDD tests require Docker and the local Supabase stack. The wrappers read the local keys from supabase status at run time, so no keys are hard-coded in the test files; the local stack's well-known demo keys do appear in .env.local.example, and no real credentials are committed:

npm run supabase:start
npm run supabase:reset
npm run test:integration
npm run test:bdd

npm test runs the complete CI-equivalent sequence and fails with setup instructions when Supabase is not available. Individual layers are available as test:unit, test:data, test:integration, test:build, and test:bdd.

Gherkin describes outcomes in domain language. Keep selectors, API calls, test-user provisioning, and provider mocks in step definitions or support fixtures. @product-review marks a rule that should be reviewed with product stakeholders, but does not skip it. Missing or ambiguous steps fail generation.

Google Drive and Dropbox scenarios use a local provider server (scripts/mock-provider-server.mjs) and never contact real provider accounts. The endpoint overrides that point at it are refused unless ALLOW_PROVIDER_ENDPOINT_OVERRIDES=true and the override is a loopback URL - these endpoints receive the OAuth client secret and refresh token, so they must not be redirectable in a deployed environment. npm run test:bdd sets the flag; nothing else should.

The mock's recorded requests, refresh counter and fail-uploads switch are reset before every scenario by an auto fixture in tests/bdd/fixtures.ts. That reset is also why the suite runs with a single worker: the mock is one shared process, so parallel scenarios would reset each other's state. A global teardown deletes the users each run creates, so repeated local runs do not need a database reset.

Chromium is the only configured browser project. Playwright traces and screenshots are retained on failure under test-results.

Known gap: the password-reset scenarios use an ordinary signed-in session rather than a recovery link, because following a real recovery link currently bounces to /signin - the browser client in src/routes/+layout.ts has no cookie set/remove method, so it cannot persist the session it parses out of the URL. createRecoveryLink in tests/bdd/support/app.ts is ready for when that is fixed.

The current National Dex maximum is deliberately asserted as 1025. When adding a new generation, update that expectation together with Pokémon data, the corresponding game/dex files, database seed, and sprites. Data tests print the exact conflicting identities or broken references.

You can preview the production build with npm run preview.

Sprites

The app uses WebP sprites from static/sprites-small. During builds we generate this folder from the full-resolution PNGs in static/sprites:

npm run sprites:build

If you want to serve sprites locally, set PUBLIC_USE_LOCAL_POKEMON_SPRITE_FOLDER="true" in .env. Otherwise the app defaults to GitHub raw for static/sprites-small.

Hosting

The app is hosted on Netlify at pokedex.jcreek.co.uk.

The Pokédex data is stored in a Supabase database.

User authentication is handled by Supabase Auth.

Dependencies

The living dex tracker's sprite collection is derived from PokéAPI Sprites and converted to smaller WebP files in static/sprites-small. PokéAPI sprites are licensed under the Creative Commons CC0 1.0 Universal license.

S
Description
No description provided
Readme GPL-3.0 436 MiB
Languages
TypeScript 54.2%
Svelte 30.2%
JavaScript 6.7%
PLpgSQL 6.6%
Gherkin 1.9%
Other 0.4%