A response-contract-exempt comment counted any handler as covered, whatever it returned, so one comment line let a JSON handler past the ratchet. The marker now counts only on a handler taking @Res() or @Next(). The five vacay holiday proxies return the provider's JSON, so they lose their markers and are counted again until they declare a schema.
47 KiB
CLAUDE.md
Scope: the @trek/server workspace. See the repo-root CLAUDE.md for the monorepo picture and the philosophy. This file holds the server's commands, invariants and pitfalls; the code and src/nest/README.md hold the inventory.
Commands (run from server/)
npm run dev # scripts/dev.mjs: tsc -w then node --watch dist/index.js (server on :3001)
npm run build # scripts/build.mjs — emits even on type errors (see below)
npm run typecheck # tsc --noEmit — the real type gate
npm run typecheck:tests # tsc over tests/ — CI runs this too; vitest green does NOT mean typed mocks compile
npm run lint # eslint, no fix
npm run lint:fix # eslint --fix
npm run lint:warnings # eslint errors fail, warnings per rule may only shrink (CI gate, scripts/eslint-baseline.json)
npm run lint:format # Prettier over src/ and tests/ outside scripts/format-baseline.json, which only shrinks (CI gate)
npm run lint:strict # strict type errors (strictNullChecks + noImplicitAny) per file may only shrink; a new file has none (CI gate)
npm run test # vitest run; also test:unit / test:integration / test:ws / test:e2e
npm run test:coverage # istanbul coverage; per-domain ratchet over src/nest/**
npm run gen:plugin-facts # regenerate the plugin-protocol tables into plugin-sdk/ + shared/
npm run check:plugin-facts # CI gate — fails if the generated copies drifted
npm run gen:db-types # regenerate the Kysely table types in src/db/kysely/ from the migrated schema
npm run check:db-types # CI gate: fails when src/db/kysely/ no longer matches the migrations
node scripts/coverage-thresholds.mjs # after test:coverage — prints the ratchet block for vitest.config.ts
npm run db:call-graph -- --sync --tx [--domains nest/days,…] # sync DB-touching methods + transaction sites (exit 1 if any)
npm run lint:size # no file in src/ or scripts/ past 1000 lines, none in tests/ past 2000, longer ones only shrink (CI gate)
npm run lint:boundaries # import cycles and cross-domain reach-ins may only shrink (CI gate)
npm run lint:dialect # SQLite-only SQL spellings under src/ may only shrink (CI gate)
npm run probe:pg # dialect helpers + the repository statements it reaches against Postgres (CI job postgres-probe; needs TREK_PG_PROBE_URL)
npm run lint:tx # methods writing more than once outside one transaction may only shrink (CI gate)
npm run lint:test-sql # raw better-sqlite3 statements in tests/ may only shrink (CI gate)
npm run lint:test-mocks # vi.mock of src/config, src/nest/realtime and src/db in tests/ may only shrink (CI gate)
npm run lint:test-new-service # new XService(/new XRepository( in tests/ may only shrink; zero-argument classes are allowed (CI gate)
npm run lint:query-api # MikroORM QueryBuilder calls in the repositories may only shrink (CI gate)
npm run lint:mcp-zod # inline z. calls per *.mcp.ts may only shrink; tool fields derive from @trek/shared (CI gate)
npm run lint:service-http # error-envelope idioms (status: 4xx in domain files, branches on result.error in callers) may only shrink (CI gate)
npm run lint:response-contracts # route handlers without @ResponseContract may only shrink (CI gate)
npm run contracts:dto-open # open shapes in the createZodDto schemas may only shrink (runs in the unit tests)
lint:boundaries (scripts/import-boundaries.mjs) parses every import under src/ and holds seven lists (src/nest-rpc, src/nest-mcp and src/mcp count as one domain each, so moving a file out of src/nest does not take its edges out of the count) in scripts/import-boundaries-baseline.json: load-time file cycles (type-only and lazy imports, and the MikroORM entity relations, do not count), dependencies between two nest/<domain> folders that already depend on each other, shared-kernel files (nest/common, nest/database, nest/app-config, nest/auth-core) importing a domain, a domain importing another domain's internals, src/db importing src/nest, a file under a domain's providers/ folder importing that domain's orchestrator (<domain>.service.ts) or MapsService (a provider knows how to ask one source; the orchestrator decides which one answers), and a domain reaching (@InjectRepository(X) or em.getRepository(X)) the repository of an entity another domain owns (foreignRepositories; the owner of every injected entity is listed in scripts/repository-owners.json, and an entity missing there stops the run). For trip visibility, inject TripAccessService (trip-membership) instead of TripsRepository. A domain's public surface is its *.module, *.service, *.guard, *.decorator, *.types, *.interface, *.contract, *.constants and *.logger files plus the short PUBLIC_FILES list in the script; anything else is an internal. A new entry fails the check, and so does a baseline entry that no longer occurs, so the fix lands with npm run lint:boundaries -- --update, which drops such entries and never adds one.
contracts:dto-open (tests/unit/contracts/dto-open-shapes.test.ts, wrapped by scripts/dto-open-shapes.mjs) finds every export class X extends createZodDto(...) under src/, imports it and counts the open shapes (loose object, record of unknown, z.unknown()/z.any(), z.custom()) in the schema the Zod pipe validates, with shared's contracts:open walk. Each DTO class is held to its entry in scripts/dto-open-shapes-baseline.json, and a new one may hold none, whatever its schema is called and wherever it is declared. A createZodDto call that is not an exported class, or two DTO classes with one name, fail the check. After narrowing a schema, npm run contracts:dto-open -- --update lowers the baseline (it never raises or adds an entry). It needs shared/ built.
lint:tx (scripts/tx-writes.mjs) reads every class under src/ and counts, per method, the writes it issues outside a .transactional(...) callback: a repository call that builds an INSERT/UPDATE/DELETE, a call to a method that writes (of its own class or of a constructor-injected one), a transaction holding writes as one. A write in a loop counts twice, of two branches only the larger counts, and a helper whose every call sits inside a transaction is not reported. A method at two or more is held to its entry in scripts/tx-writes-baseline.json; a new one fails, and so does an entry above what its method holds now, so a fix lands with npm run lint:tx -- --update (it never raises or adds an entry). --explain lists the line of every call that counted. Two JSDoc tags mark the deliberate cases, each with its reason in the tag text: @txStandalone on a method whose write stands on its own whatever its caller does (an audit row, a notification, a non-fatal derived refresh, an idempotent lazy provision) makes it count for nothing at its callers, and @txIndependent on a method whose writes are complete one by one on purpose (network I/O between them, a retention sweep in passes, one transaction per item of a batch) keeps it out of the report.
lint:size (scripts/size-lint.mjs) counts a line longer than 120 columns once per 120 columns it spans, so joining lines does not make room. Files under tests/ are held the same way at 2000 lines against scripts/test-size-baseline.json. Files that were already longer are held at their length in scripts/size-baseline.json; a file that needs to grow past its entry is split by concern instead. An entry above what its file holds now, or for a file that is gone, fails as well, so after a split npm run lint:size -- --update lowers the baseline in the same change (it never raises or adds an entry).
lint:strict (scripts/strict-lint.mjs) runs tsc over tsconfig.strict.json, the build config with strictNullChecks and noImplicitAny on, and counts the errors per file against scripts/strict-baseline.json. A file may hold at most its entry and a file without one, a new file in particular, none; an entry above what its file holds now, or for a file that is gone, fails as well, so the change that fixes errors runs npm run lint:strict -- --update (it never raises or adds an entry). It is a ratchet only: the build stays on strict: false until the baseline is empty.
lint:test-sql (scripts/test-sql-ratchet.mjs) counts every .prepare( under tests/ per file against scripts/test-sql-baseline.json: a file may hold at most its entry, a file without one none. Growth fails, and so does an entry above what its file holds now, so a conversion lands with npm run lint:test-sql -- --update (it only lowers and drops entries). Files whose subject is raw SQL (the dialect functions, PRAGMA introspection, the legacy upgrade fixtures) sit in the baseline's exempt list with a reason; a single statement that must stay raw carries a test-sql-allow: <reason> comment on its line or the line above. tests/unit/scripts/test-sql-ratchet.test.ts also runs it on the tree.
lint:test-mocks (scripts/test-mocks-ratchet.mjs) and lint:test-new-service (scripts/test-new-service-ratchet.mjs) share the count rules of scripts/lib/count-ratchet.mjs (scripts/test-mocks-baseline.json, scripts/test-new-service-baseline.json). The first counts every vi.mock/vi.doMock of src/config, src/nest/realtime/** and src/db/** per file under tests/: the setup file fixes the config (tests/helpers/test-config.ts, overrideTestConfig), broadcasts go to a FakeRealtimeService or spyOnRealtime(app). The second counts new <X>Service( and new <X>Repository( under tests/, leaving out classes whose constructor takes nothing (derived from src/ and tests/helpers/); a suite takes its subject from createTestModule (tests/helpers/test-module.ts) or from a booted container (tests/helpers/test-app.ts).
lint:query-api (scripts/query-api-ratchet.mjs) counts every .qb( and createQueryBuilder( under src/db/repositories/ per file (the TrekRepository base that defines qb is left out) against scripts/query-api-baseline.json: a file may hold at most its entry, a file without one none, and an entry above what its file holds now fails until npm run lint:query-api -- --update lowers it (it never raises or adds one). The rule it holds is "Which query API" under SQL dialect below.
lint:mcp-zod (scripts/mcp-inline-zod.mjs) and lint:service-http (scripts/service-http-ratchet.mjs) share the per-file count rules of scripts/lib/count-ratchet.mjs: a file may hold at most its entry in its baseline (scripts/mcp-inline-zod-baseline.json, scripts/service-http-baseline.json), a file without one none, and an entry above what its file holds now fails until -- --update lowers it (never raises or adds). lint:mcp-zod counts every z. in a *.mcp.ts: a tool field derives from the request schema in @trek/shared or a shared primitive (idSchema); a bound REST deliberately lacks stays inline and counted. lint:service-http counts, in every file under src/nest but the HTTP layer (controllers, guards, pipes, filters, interceptors, DTOs and domain-error.ts itself), the status: 4xx/5xx literals of a returned { error, status } and every new HttpException(, and in a *.controller.ts, *.mcp.ts or *.rpc.ts every branch on a returned error (if (result.error), if (!r.error), 'error' in r, r.error === 'not_found', r?.error && ..., r.error ? a : b). A service refuses by throwing a DomainError (src/nest/common/domain-error.ts) instead; src/nest/README.md ("Refusals") has the shape.
lint:response-contracts (scripts/response-contract-ratchet.mjs) reads every class under src/nest/ with the TypeScript parser and counts, per file, the route handlers (@Get/@Post/@Put/@Patch/@Delete/@All/@Head/@Options) that carry no @ResponseContract(...) against scripts/response-contract-baseline.json: a file may hold at most its entry, a file without one none, and an entry above what its file holds now fails until npm run lint:response-contracts -- --update lowers it (it never raises or adds one). A handler that writes through @Res() (a stream, a redirect) has no return value to check and is marked with a response-contract-exempt: <reason> comment above it instead; the marker excuses only such a handler, so one that returns a body, a third party's answer passed through included, stays counted until it declares a schema. The run prints the covered share.
Single test: npx vitest run tests/unit/nest/weather.controller.test.ts, or npx vitest run -t "returns 401 without cookie".
Build emits even with type errors (scripts/build.mjs catches tsc failures and warns). npm run build succeeding does not mean the code typechecks — run npm run typecheck.
lint:dialect (scripts/dialect-lint.mjs) reads every string and template literal under src/ (comments do not count) and every .insertId read, and counts the SQLite-only spellings per file and rule: INSERT OR IGNORE/REPLACE, datetime()/julianday()/unixepoch() (also as the bare name handed to eb.fn), strftime, json_extract and its siblings, GLOB, last_insert_rowid, AUTOINCREMENT, a PRAGMA statement outside the src/db/*.ts lifecycle files and the migrations, and || concatenation in SQL. The counts are held to scripts/dialect-baseline.json; a new hit fails, and so does an entry above what its file holds now, so the change that removes one runs npm run lint:dialect -- --update (it never raises or adds an entry). The dialect layer src/db/dialect/ is not scanned, and neither are the migrations up to FROZEN_MIGRATIONS_THROUGH in the script; a newer migration is held to the DML rules, while its DDL stays engine specific.
probe:pg (scripts/pg-probe.ts, CI job postgres-probe) measures what of the SQL runs on Postgres. Given an empty database (TREK_PG_PROBE_URL, or --url=; it refuses one holding tables it did not create) it derives a Postgres schema from the entities with MikroORM's schema generator (timestamps stay TEXT, SQLite-only defaults and COLLATE NOCASE get their Postgres spelling, no foreign keys), runs every dialect helper on an in-memory SQLite and on Postgres and checks both against the same expectation (scripts/pg-probe/helper-cases.ts; every case must pass), then calls every public method of every class in src/db/repositories/*.ts once. The arguments come from the parameter types, read with the TypeScript checker (pg-probe/arg-samples.ts), and the calls go through a MikroORM Postgres driver that runs each statement alone in a rolled-back transaction with a statement timeout and records whether Postgres accepted it (pg-probe/recorder.ts), so every statement meets empty tables and nothing persists. What it measures is the statements each method reaches with those sample arguments against empty tables, not every statement the code can send. The distinct statements Postgres refuses as SQL (SQLSTATE class 42 or 0A: syntax, an unknown function or column, a datatype mismatch, an unsupported feature) are held per Class.method to failing in scripts/pg-probe-baseline.json: a method may fail no more than its entry, and an entry above what it fails now fails too. A refusal over a sample value (class 22, say a probe string in a date column) or the empty tables is reported in the log and the step summary but not held, so renaming a parameter cannot turn a sample into dialect debt. The methods whose SQL the probe did not see (it could not build their arguments, they sent no SQL because they threw first or never reach the database, or they timed out) are held to the same file's uncovered list: a method outside the list that goes unmeasured fails the run, and so does a listed method that is measured now or gone, so the list only shrinks and a new method the sampler cannot reach does not land unchecked. Fix such a method by giving it parameters the sampler can build or by making it reach its SQL with sample values. The job uploads the measured baseline and a JSON report (pg-probe-baseline artifact), so the change that fixes a statement copies the lowered baseline from there or runs npm run probe:pg -- --update against a local Postgres (docker run --rm -p 5432:5432 -e POSTGRES_PASSWORD=probe postgres:17); --update never raises or adds an entry in either part. While the baseline's failing or uncovered is null it has never been measured, and the run fails (outside --update) until the first measurement from the artifact is committed, so the gate cannot land on dev holding nothing. A run that called no repository method fails too, so a broken plan can neither pass nor seed an empty baseline. The unit tests under tests/unit/scripts/pg-probe/ cover the probe's logic, including every helper case on SQLite.
Architecture invariants
Nest owns everything. Every domain is a DI module under src/nest/<domain>/ (controller + service + module, registered in src/nest/app.module.ts); business logic lives in the injectable .service.ts, pure halves in .helpers.ts, SQL in a .repository.ts where one exists. There is no legacy service layer — ESLint errors on any services/ import. weather/ is the reference module shape; collections.controller.ts is the reference for body validation and enumeration-safe access checks.
src/bootstrap.ts—buildApp()is the single builder for production and the test harness. Everything on the raw Express instance (global middleware, uploads, discovery metadata, statics, the namedjsonParser/urlencodedParserwrappers) is registered beforeapp.init(), because Nest throwsNotFoundExceptionon unmatched routes and nothing after init is reachable. The wrappers exempt/mcpso the MCP SDK reads the raw stream — never@Body()a/mcproute. Don't add routes to that pre-init shell; it bypasses every global guard, interceptor and filter.- Realtime:
/wsis a Nest gateway insrc/nest/realtime/. InjectRealtimeService; tests hand in aFakeRealtimeService(tests/helpers/fake-realtime.ts) or spy on the container's instance instead of mocking the transport module. Trip mutations forwardX-Socket-Idso the originating client doesn't echo its own change. - MCP:
src/nest-mcp/is the decorator/registry layer (@McpController/@Tool/@Resource/@Prompt; see itsREADME.md); tools live in<domain>.mcp.tsfiles beside each module; the HTTP transport issrc/nest/mcp-transport/;src/mcp/holds process-wide state only (scopes, session manager, boot policy). Every tool invocation writes an audit row through the registry'sonInvokeseam. The demo-mode write block is the registry'stoolGate(trekDemoToolGate): every tool not annotated read-only refuses a demo account there (except the write tools inDEMO_UNGATED_WRITE_TOOLS, which never had a demo check), so a tool never checks demo mode itself (ESLint refuses it in*.mcp.ts). MCP tools are adapters over the same services and permission checks as REST — a change on one side lands on the other in the same change. - Scheduling:
src/nest/scheduling/(CronRegistrarService) is the one way to schedule a cron. Jobs are*.job.tsproviders in their owning domain. The registrar refuses to schedule underNODE_ENV=test(an integration test pins it). Never use a@Crondecorator: it bypasses that gate. Every tick first takes the job's row inscheduler_leases(SchedulerLeasesRepository.acquire, one conditional upsert that decides the race), renews it while it runs and keeps it for a short settle window afterwards, so two processes on one database never run the same tick; a job needs nothing of its own for this. Claims on individual rows (the reminder jobs'claimReminder) stay where they are: the lease decides who runs a tick, the claim what a tick may send. - Plugins (
src/nest/plugins/): the child-process runtime (supervisor/,runtime/plugin-host-entry.ts,protocol/envelope.ts) is intentionally not Nest; it is the security boundary.host/rpc-host.tsregisters an RPC method at spawn only if the plugin holds the unlocking permission (registration = authorization). Install-time gates live ininstall/; the manifest'strekversion range fails closed, andTREK_PLUGINS_IGNORE_TREK_RANGEdowngrades that to a warning. The protocol tables inprotocol/envelope.ts(+src/plugin-event-sink.ts) are generated intoplugin-sdk/andshared/: rungen:plugin-factsafter touching them and commit the output. What a plugin gets back isprotocol/output-contract.ts: every wire method has an entry, and an entity result (trips.getById,todos.list,vacay.mine, ...) is cut down to its published fields inrpc-host.tson the way out, together with every child row it carries whose field is listed inPLUGIN_ENTITY_NESTED(a day'snotes_items, a reservation'sendpoints). A new column on any whole-row table behind those entities, child tables included, failstests/unit/plugins/output-contract.schema.test.tsuntil it is listed as published or withheld (the SDK'sPLUGIN_ENTITY_FIELDSandPLUGIN_ENTITY_NESTEDare generated from it); a method left asreadModelmust return a value built field by field from named columns. A plugin's own SQL (host/plugin-data.service.ts) is held to a row cap, andquery,txand anexecscript to a time budget checked between rows and statements (migrateis deliberately not timed).runtime/egress-policy.tsis a hand-kept mirror guarded by a parity test inplugin-sdk/; change both sides together. - Storage:
src/nest/storage/is the upload driver abstraction (local / S3 / mirror behind one interface, with an admin surface and a usage job). Domain services never touch the filesystem or the S3 SDK directly. Where the data lives (data/,uploads/, backups, logs, key files, the DB file) is resolved in one place,src/app-config/data-paths.ts; a provider that reads one injectsDataPathsService, plain helper modules shared with code outside the container callresolveDataPaths()(the list is insrc/app-config/README.md), and nothing anchors a data path on its own__dirnameor onprocess.cwd(). - DB (
src/db/):better-sqlite3, WAL, FK on.database.tsonly holds the connection and applies pragmas. It does not build a schema, and importing it opens nothing (the first reader does). The connection's lifecycle belongs to theDatabaseLifecycleprovider (nest/database/database-lifecycle.service.ts):buildApp()opens it throughopen()(which binds the ORM to later swaps and runs the schema bootstrap below), the shutdown closes it throughclose(), and a restore or the demo reset swaps the file only through the database backup port,DATABASE_BACKUP(nest/database/database-backup.interface.ts; the SQLite implementation isnest/backup/sqlite-database-backup.ts:VACUUM INTOsnapshot, close, atomic file swap,reopen()). The port works onDatabaseLifecycle.file, the one resolved path (TREK_DB_FILEordata/travel.db), and a snapshot that fails fails the backup rather than archiving the live file.MaintenanceRepositoryis provided only byMaintenanceModule's factory and injected everywhere else; no consumer constructs it. A provider that has to follow every reopen (the demo reset job saves the first demo baseline after a restore's re-bootstrap seeded the example trips) registers withDatabaseLifecycle.onReopened(), which runs after the reopen's schema bootstrap; a listener contains its own failures, since one that throws fails the reopen. MikroORM's migrations (db/migrations/) are the only schema source, including for tests: the hand-keptschema.ts/migrations.ts/seeds.tsbuilders and the parity test that guarded them are gone. Seeding is the MikroORM seeders indb/seeders/, applied bydb/orm.tsfrombuildApp()before anything reads. An install the retired positional runner migrated (aschema_versionrow, nomikro_orm_migrationsrows) is baselined bydb/legacy-baseline.ts: the migrations whoseLegacy migration step Ndocstring is ≤ its version are recorded as executed (never replayed) in the same transaction as the migrator run, while the baseline migration itself still runs first, as the legacy runner'screateTables()did on every boot; anything it cannot map refuses the boot. Before a boot applies pending migrations to a file database that holds anything,db/pre-migrate-snapshot.tswrites aVACUUM INTOcopy next to it (pre-migrate-<schema>-<time>.db,<schema>beinglegacy-<schema_version>or the last recorded migration's timestamp; the newestTREK_DB_PRE_MIGRATE_SNAPSHOT_KEEPstay) and the newer-database refusal names the matching copy; a copy that cannot be written refuses the boot unlessTREK_DB_PRE_MIGRATE_SNAPSHOT=false. It is off underNODE_ENV=testunless a suite sets that variable to true, and a restore's re-bootstrap skips it (the archive is the copy). After the migrator,db/email-case-index.tscreates the case-insensitive unique index onusers.emailthat its migration had to defer on an install holding two accounts whose emails differ only in case (flagemail_case_index_pending).db/orm-driver.tsbinds the ORM to that same connection instead of opening a second one — with:memory:under test, a second connection is a second, empty database. Kysely statements (this.kysely<...>()) type againstDBfromdb/kysely/db.ts, narrowed withPick<DB, 'trips' | 'days'>; those files are generated from the migrated schema byscripts/generate-db-types.ts, so a migration that adds or changes a column is followed bynpm run gen:db-types, never by a hand-written table interface. Every read and write goes through a repository indb/repositories/(each extends the sharedTrekRepositorybase indb/repositories/_shared/, which validates the request context before delegating to MikroORM) and, for multi-statement writes,UnitOfWork.transactional(...)(nest/database/unit-of-work.ts, provided by the globalOrmModule) — there is noDatabaseService/DatabaseModuleto inject any more. Entrypoints outside an HTTP request — an MCP tool call, a plugin RPC dispatch, a WebSocket message, a cron job, boot-time seeding, a backup restore — open one explicitly withwithRequestContext()(nest/database/request-context.ts), since only the pathlessmikroOrmRequestContextmiddlewarebuildApp()mounts (with@mikro-orm/nestjs's ownregisterRequestContextturned off inapp.module.ts, UPLOADS-P16) forks anEntityManagerper HTTP request.NODE_ENV=test⇒ isolated:memory:DB per vitest worker, opened from a snapshottests/global-setup.tsmigrates once per run;TREK_DB_FILE⇒ explicit file DB (Playwright harness).
Rules for new code
- Thin controller → injectable provider. Never resurrect a plain function-module service; don't grow god services — split a domain into several modules when it outgrows one class (trips and auth already are).
- Inject, don't reach for module globals. No imports of the global
dbproxy fromnest/layers at all any more — the last production importer converted onto a repository, and the export now survives only so ~190 test files'vi.mock('…/db/database', …)factories keep typechecking; no new code depending on thewssingleton or event-sink globals. There is noDatabaseServiceto inject either — take the repository(ies) you need plusUnitOfWorkfor transactions. Modules must be importable without side effects. - Transactions are not optional. Multi-statement writes go in
await this.uow.transactional(async () => …)(UnitOfWorkfromnest/database, provided by the globalOrmModule); never hand-rollBEGIN/COMMITand never calldb.transaction()(the Phase 1 async sweep removes it). The sequence lives in the service, never in a controller, MCP tool or RPC handler, so every surface calls the one method that holds the transaction (ReservationsService.createWithCostis the shape: side effects such as broadcasts come back to the caller and go out after the commit). A position or id taken asMAX(...) + 1is read inside the same transaction as the insert that uses it: the transaction holds the connection, so two requests at once cannot read the same MAX.lint:txholds the rest. Every DB-touching method isasync;@typescript-eslint/no-floating-promisesandno-misused-promisesare errors, so an unawaited call or aPromisein a condition fails lint. Bind values with?; identifiers only via a literal allow-list. Insrc/db/repositories/andsrc/db/seeders/, ESLint refuses raw SQL in any spelling:raw(), thesqltag, and SQL text handed toexecute/run/all/get. Build the statement with the query builder;MaintenanceRepository,AdminSeederandCategorySeederare the named exceptions ineslint.config.mjs, andtests/unit/eslint-rules/restricted-syntax-selectors.test.tspins how many SQL strings each still holds, so they can only lose SQL, never gain it. An insert that needs the new id reads it with.returning('id'):InsertResult.insertIdis SQLite'slast_insert_rowidand undefined on Postgres, and ESLint refuses it insrc/db/repositories/andsrc/db/seeders/. - Migrations are append-only. A migration is identified by its class name in
mikro_orm_migrations, and files sort by the timestamp in that name. Never rename or delete one that has shipped, and never edit its body; add a new one. No env interpolation in SQL. (The old positionalschema_versionarray and the hand-keptdb/migrations.tstest builder are both gone; the numbered migrations are the only schema history, for tests too.) A new foreign key comes with an index that leads with its column(s), or deleting the parent scans the child table (a partial index counts only when its WHERE clause isIS NOT NULLon those columns);tests/unit/db/foreign-key-indexes.test.tsfails on one without. - Every write endpoint validates through the Zod pipe with a schema from
@trek/shared— noRecord<string, unknown>+ ad-hoc checks. Also verify every referenced id exists and belongs to the same trip. - Every outbound
fetchgets a timeout, a response-size cap and boundary validation: noas-casting provider responses, no silentcatch → null. User-influenced URLs go through the SSRF guard. Never fall back to another user's API key. ESLint requires an init with asignalonfetch,safeFetch,safeFetchFollowandsafeFetchAdminConfiguredalike, or a literaltimeoutMsin the options object ofsafeFetch/safeFetchFollow; an init spelledundefined,nullorvoid 0counts as none (safeFetchLlmtakesLLM_TIMEOUT_MSinside). Behind that, the guarded wrappers (utils/ssrfGuard.ts) cap every body atDEFAULT_MAX_RESPONSE_BYTES(64 MB) and, for a call without a signal, waitDEFAULT_RESPONSE_TIMEOUT_MS(30 s) for the headers. Pass a tightermaxByteswhen you buffer a small answer,timeoutMsfor a deadline over the whole exchange, andmaxBytes: nullonly where the body is streamed on or counted by the caller (pipeAsset, the doc-sync transfers, the Ollama pull). - Fail closed. Unrecognized flag values mean OFF; sandbox/permission opt-outs refuse in production; never pick a less-safe path based on the absence of a file. GET handlers must not write.
- Don't fork canonical paths. Auth verification is
verifyJwtAndLoadUser(with thepassword_versiongate and the session gate); reuse it. A session token is minted only bySessionsService.issue(nest/sessions/, reached throughAuthService.generateToken), which writes theuser_sessionsrow itsjtinames; a token signed anywhere else carries no session and cannot be listed or revoked. An action that should sign a user out everywhere callsSessionsService.revokeAllinside the same transaction as the write that warrants it. - Money: integer cents; largest-remainder splits (
splitEqualSharesin@trek/shared(shared/src/money/) is the reference, withtoMinor/sumMinorfor every sum and comparison); FX frozen at entry; explicit flags, never sentinel values; custom splits must reconcile to zero before persisting.
SQL dialect
SQLite is the engine today and Postgres is the planned second one. Code under src/ is written so that a Postgres port only adds a branch to the dialect layer, never a sweep through the repositories:
- Build statements, don't spell them. Use the entity methods or
this.kysely<Pick<DB, ...>>()on the generated table types. Repositories and seeders may not hold SQL text at all (ESLint), andlint:dialectholds every other file to its baseline. - Which query API. New repository code picks by the shape of the statement, not by what the file already uses:
- Kysely (
this.kysely<Pick<DB, ...>>()) for every read that joins, aggregates, groups or projects columns across tables, and for set-based writes (a statement over many rows, a subquery,RETURNING). Its types come from the migrated schema, so a renamed column failstsc. - The entity methods (
findOne/find/count/insert/nativeUpdate/nativeDelete/upsert) for single-table CRUD by key or by a plain filter. They carry theTrekRepositoryrequest-context check and the identity-map default. - No MikroORM QueryBuilder (
this.qb(...),createQueryBuilder(...)) in new code. The existing calls stay until their method is touched for another reason, then move to one of the two above; there is no sweep.lint:query-apiholds the count per file.
- Kysely (
- Insert or ignore / upsert:
.onConflict((oc) => oc.columns([...]).doNothing())or.doUpdateSet({...}), orem.upsert. Name the conflict target where there is one. NeverINSERT OR IGNORE/INSERT OR REPLACE. - The new id:
.returning('id').executeTakeFirstOrThrow(). NeverInsertResult.insertIdorlast_insert_rowid(); both are SQLite's rowid and undefined on Postgres. - Time:
currentTimestamp/currentTimestampKysely,nowMinusDays,nowMinusHours,nowPlusSeconds/nowPlusSecondsKysely,nowDateOffset,dateOf,dateAdd,unixEpochToIsoKyselyfromsrc/db/dialect/sql-functions.ts(the MikroORMraw()helpers) andsrc/db/dialect/kysely-functions.ts(their Kysely-expression twins). Neverdatetime('now'),strftimeorjulianday. - Strings and casts:
concat/concatKyselyinstead of||,substring/substringKysely,lower/lowerTrim,collateNoCase,castInteger/castIntegerKysely, andstartsWithIsoDate/startsWithIsoDateKyselyinstead ofGLOB. - JSON columns are read whole and parsed in the service; no
json_extractin SQL. Each one is declared once insrc/db/json-columns.ts(its Zod shape and the fallback a reader gets for an empty or broken row) and read withdecodeJson/decodeJsonResult, written from a server-built value withencodeJson(src/utils/json-column.ts), never with a bareJSON.parseat the call site: one column, one answer to a broken row, logged. - Timestamps in a DATETIME column are the canonical
YYYY-MM-DD HH:MM:SSUTC text, nevertoISOString(): in SQL the two spellings do not compare. A value written from JS is aDbTimestampfromdbNow()(src/db/types), and a stored value is read back as an instant withparseDbTimestamp()(a barenew Date()reads the canonical text as local time). Where a response has always carried the ISO spelling, convert on the way out (utcSuffix), not in the column. - PRAGMA belongs to the
src/db/lifecycle files (database.ts,connection.ts,durability.ts, the migrations).MaintenanceRepositoryis the baselined SQLite maintenance adapter (wal_checkpoint,VACUUM INTO). - A missing helper goes into
sql-functions.ts(orkysely-functions.tsfor a Kysely expression), dispatching on the live platform throughsrc/db/dialect/platform.ts: a SQLite branch and a Postgres branch (one spelling underisKnownPlatformwhere both engines read it alike),unsupported(platform)for anything else. The Postgres branch keeps the SQLite storage model, so a clock helper renders the sameYYYY-MM-DD HH:MM:SSUTC text. Pin the Postgres text intests/unit/db/dialect/sql-functions.postgres.test.tsand add a case toscripts/pg-probe/helper-cases.tsso the probe runs it on both engines.src/db/dialect/is the only place allowed to spell an engine's own SQL. - Migrations that have shipped are frozen as they are. A new migration's data statements follow the rules above; its DDL is written for the engine it runs on.
- Storage model: the generated Kysely types describe what SQLite stores (0/1 integers for flags, TEXT timestamps, JSON in TEXT). Convert at the service boundary, as the contracts already require.
- MySQL/MariaDB are out of scope. The repositories rely on
INSERT ... ON CONFLICT(Kysely'sonConflict, often a target-lessdoNothing()) and onRETURNING, and MySQL has neither: it would need an insert-ignore/upsert wrapper in the dialect layer and a different way to read new ids before it could be considered.
Configuration (app-config)
Never read process.env in src/** — ESLint errors on it. All env access goes through src/app-config/:
- Every variable has exactly one owner. Nest classes inject a boot-stable namespace token from
src/nest/app-config/(httpConfig,storageConfig,transitConfig,kitineraryConfig) for values frozen per app build, or useRuntimeEnvService/readEnv()for everything else (DEMO_MODE, NODE_ENV, OIDC_*, ...). A token-owned variable is derived inboot-derive.tsand never byreadEnv();tests/unit/app-config/config-ownership.test.tsfails on a variable read through both, and on a token nothing injects. server/.env.exampledocuments every variableenv.schema.tsvalidates;env-reference.test.tsfails on drift either way.- Everything else calls
readEnv()— live, uncached, per call. - Validation is fail-fast at boot only (
boot-validate.ts, imported byindex.tsright after dotenv): malformed values abort startup; unset/blank defaults. Never wire validation intobuildApp()orConfigModule.forRoot, and nevercache/snapshot a runtime-toggled value (it breaks the env-mutating tests). - Booleans go through
parseBool(true/1/on/yes vs false/0/off/no). Everything else pins its exact legacy coercion — quirks and the ESLint exemption list are insrc/app-config/README.md. - Instance settings (
app_settings) are named through the typed registersrc/nest/common/app-settings.registry.ts: one entry per key with its Zod shape, default, environment override and flags (admin form, masked, encrypted, managed-locked, public config). Read withreadAppSetting(repo, key)(the stored text, exactly whatgetValueanswers) orresolveAppSetting(repo, key)(a non-empty environment value first); askisOidcConfigured()rather than spelling the issuer/client-id check. The admin form's key lists derive from the flags. ESLint refusesgetValue('<literal>')outside the register; a key built from parts (admin_notif_pref_*) is a family the register does not list.
Cross-cutting pieces
src/nest/common/: the global exception filter (error envelope), the Zod validation pipe, the idempotency interceptor (X-Idempotency-Keyreplay), andvalidate-route-guards.ts(boot-time ratchet refusing any public route not on its allow-list).- Response contracts (
src/nest/common/response-contract.ts):@ResponseContract(schema)names the@trek/sharedresponse schema a handler answers with. UnderNODE_ENV=testit adds an interceptor that parses every response of that handler against the schema and turns a body the schema does not describe into a logged 500 naming the handler and the first issues, so every e2e and integration test that reaches the route is a drift check; in production it only records the schema and adds nothing to the request path. The parse never replaces the body. When a check fails, fix the schema to describe what the route really sends, or the test stub to return what the service really returns, never the response. Rows keep their storage spelling in these schemas (0/1 flags, TEXT or epoch times) wherever the route has always answered that way. - Auth is default-deny: the global auth guard and the MFA policy guard run as
APP_GUARDs, followed by the managed-install guard (managed.guard.ts), which refuses the routes a centrally administered install withholds from its own admin — it runs last so strangers still get a 401, never a route-revealing 403. Routes opt out with@Public()/@OptionalAuth(). The global guard stands down for routes declaring their own guard chain, so@UseGuards(JwtAuthGuard, TripAccessGuard)+@RequirePermissionstacks work. Session is a cookie (trek_session);@CurrentUser()reads the user. Every session token carries ajtinaming itsuser_sessionsrow, andverifyJwtAndLoadUserrefuses one whose row is revoked, expired or gone (logout,/api/auth/sessions, a password change or reset, an MFA disable all end rows;session-purge.job.tsdeletes the expired ones nightly; a revoked row waits for its own expiry, because for a session renewed from a pre-jtitoken, whose id is derived from that token, the revoked row is all that keeps the token from inserting it again). A token without ajtipredates the table and passes until it expires, so an upgrade signs nobody out. Thetokenfield in the login-type JSON bodies and in the SSO exchange (GET /api/auth/oidc/exchange, which also answerssuccess: true) is deprecated: kept for API clients, read by nothing of ours. Never gate a multipart upload with a guard — guards run before the parser and the client sees ECONNRESET instead of your 403; check in the handler. - Logging:
src/nest/audit/audit-log.logger.ts(logInfo/logWarn/logError/logDebug) prints each line to the console and queues it fordata/logs/trek.log, whichlog-file.tsappends in batches off the event loop and rotates at 10 MB over five files;index.tsflushes what is queued on exit. Never write the log file synchronously from a request path. - Request correlation (
src/nest/common/request-correlation.ts): every HTTP request runs under an id (a well-formed incomingX-Request-Id, else a fresh UUID) that the response carries inX-Request-Id, and every log line written inside it is tagged[http <id>]. The exception filter leaves a 5xx onres.localsso the access log writes the request line and the stack as one entry. The other entry points (MCP tool/resource/prompt calls via the registry'saroundseam, WebSocket messages inTrekWsAdapter, plugin RPC dispatches in the supervisor, cron ticks inCronRegistrarService) each run under their own id throughtraceEntry()(nest/audit/entry-trace.logger.ts), which logs one line per call: debug on success, debug asskippedwhen the call declines its work on purpose (a cron tick whose lease another process holds), warn or error with the reason on failure. A new entry point goes throughtraceEntry()too. - Process safety nets (
src/index.ts,src/shutdown.ts):unhandledRejectionanduncaughtExceptionare logged to trek.log and end in the same orderly shutdown as SIGTERM, with exit code 1; a second fatal error during it exits at once. A shutdown first marksReadinessService(nest/health/) as draining, so/api/health/readyanswers 503 for the whole drain. The HTTP server keeps idle keep-alive connections forHTTP_KEEP_ALIVE_TIMEOUT_MS(95 s, above the 60 s of nginx and the 90 s of Traefik) with the headers timeout one second above it (applyProxyTimeoutsinbootstrap.ts). - Process-local state sits behind injectable ports, each with an in-memory implementation that keeps today's behaviour:
RateLimitStore(nest/common/rate-limit.store.ts, provided byRateLimitModule),PendingCodeStore(nest/oauth/oauth.pending-codes.ts),OidcFlowStore(nest/oidc/oidc-flow.store.ts),PermissionsCacheStore(nest/permissions/permissions-cache.ts) andRoomRegistry(nest/realtime/ws-state.ts). The owning module provides the implementation. Every port a shared store could back returns promises (a store in the database or on the network is async);RoomRegistrystays synchronous because membership holds live sockets, and several processes would need a fan-out in front ofbroadcast()instead. The process-wide ports (PendingCodeStore,PermissionsCacheStore,RoomRegistry) also have readers outside the container (the pending-code sweep, the backup restore's cache flush, the broadcast functions, hand-built consumers), so their module installs the store the container resolved in aProcessStoreSlot(nest/common/process-store-slot.ts) those readers use: overriding the provider changes every reader. New process-local state follows the same shape; TREK still runs as one process. src/middleware/globalMiddleware.tsis the only Express middleware left (helmet/CSP, CORS, HSTS, forced-HTTPS, logging, cookies).
Tests
tests/ is split into unit/ (mirrors src/), integration/, e2e/ (one <domain>.e2e.test.ts per module, booting the real guards against a temp DB via tests/e2e/harness.ts) and websocket/; helpers in tests/helpers/, fixtures in tests/fixtures/.
-
Seed and read through the ORM factories in
tests/helpers/factories/(makeUser,makeTrip,makePlace, … plus the typedfindRow/findRows/countRows/updateRows/deleteRowsreaders), handed the app's ORM (app.get(MikroORM)) or acreateTestOrm(db). They go through MikroORM in a request context of their own, the way the app does, instead of raw SQLite on the sync handle; the README there has the before/after patterns. The rawtests/helpers/factories.tsand the.prepare()fixtures are legacy thatlint:test-sqlonly lets shrink. -
Upgrade fixtures:
tests/fixtures/legacy/legacy-v*.sqlare databases the retired positional runner built;tests/integration/legacy-upgrade-v*.test.tsbootbuildApp()on each.legacy-v244is the v4.3.3 release with rows across the main tables, rebuilt reproducibly bynode scripts/build-legacy-fixture-v244.mjs(archives the tag into a temp dir, boots that release's runner, seeds, pins timestamps, dumps). -
vitest uses the SWC plugin, not esbuild, because Nest's DI needs emitted decorator metadata. Keep that in
vitest.config.ts. Pool isforks(isolated DB per worker). The config also aliases@modelcontextprotocol/sdk/*to its CJS dist because the SDK's exports map is unresolvable. -
Coverage is a per-domain ratchet over
src/nest/**(≥80% floor, most domains pinned higher). Regenerate the block withscripts/coverage-thresholds.mjswhen coverage rises; never lower a threshold to land a change. Every folder undersrc/nest/needs its own entry (a new domain too):tests/unit/coverage-thresholds.test.tsfails on one that falls through to the pooledsrc/nest/**catch-all. -
CI also runs SonarCloud on the PR's new lines — see the root
CLAUDE.md.
Parity discipline (when adding or changing routes)
Routes are byte-identical for the client: same URL, method, query/body, status, Set-Cookie and JSON body, including bespoke error strings reproduced in the controller. Nest defaults POST to 201 — add @HttpCode(200) where the contract returns 200. Declare static sub-routes (/reorder, /in-app/all) before :id param routes. Trip-scoped handlers verify trip access (404) and permission (403).