Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .agents/skills/verify-dms-api/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ $C journey "$RUN" overview [journey-id...]

- Each feature file in [features/](features/README.md) lists its source globs (`covers:`), its docs pages (`docs:`) and its journeys; the journeys are in `e2e/journeys/<feature>.mjs` (the `journeys` folder of `verify.config.ts`), with the helpers they share in `e2e/`: `api.mjs` (requests, checks, traffic, settings, members), `seed.mjs` (aged rows written to the run's MongoDB, which the module cannot be made to age), `guard.mjs` (environment loss) and `clock.cjs` (the backend's clock set ahead, so the hourly prune fires within seconds). [coverage/](coverage) holds one table per feature: every documented behaviour, its catching journey and check, or `Not driven` with the reason.
- A journey starts on an empty database with the administrator onboarded and the backend restarted on it. It reads every mutation back through a second view: the API, a reload, the stored documents, or a backend restart.
- A journey may set `tag` (Playwright tags such as `"@smoke"`, the set the full CI tier runs) and `knownFailures`, which maps the name of each check that fails today to the finding that makes it fail. A listed check that fails is `known` and does not fail the journey. A listed check that passes is `fixed` and fails the journey until the entry is removed.
- The same journeys run as the Playwright suite of `e2e/`, which CI runs (`@smoke` on a ready pull request to `main`, a push to `next` and a manual run, every journey nightly): `TZ=UTC pnpm e2e` prepares and starts a run, runs every journey on it and stops it; `pnpm e2e -g <feature or journey id>` or `--grep @smoke` narrows it. `DMS_E2E_PREBUILT=1` skips the prepare commands, and `DMS_E2E_RUN=$RUN` drives a run you started with `up`, which it leaves running. The report attaches each failed step's screenshot and ARIA snapshot and the backend log.
- A journey may set `tag` (Playwright tags such as `"@smoke"`, the set CI runs on a pull request) and `knownFailures`, which maps the name of each check that fails today to the finding that makes it fail. A listed check that fails is `known` and does not fail the journey. A listed check that passes is `fixed` and fails the journey until the entry is removed.
- The same journeys run as the Playwright suite of `e2e/`, which CI runs (`@smoke` on a ready pull request, every journey in the merge queue, nightly, on a manual run and on a pull request labelled `ci:full`): `TZ=UTC pnpm e2e` prepares and starts a run, runs every journey on it and stops it; `pnpm e2e -g <feature or journey id>` or `--grep @smoke` narrows it. `DMS_E2E_PREBUILT=1` skips the prepare commands, and `DMS_E2E_RUN=$RUN` drives a run you started with `up`, which it leaves running. The report attaches each failed step's screenshot and ARIA snapshot and the backend log.
- Statistics and health are written behind the response: journeys wait with `settled` before reading them.
- `withConfig(ctx, { statisticsLifetime: … }, body)` restarts the backend with module options set and restarts it again without them.
- To look at the product yourself: `$C onboard "$RUN"`, `$C browser "$RUN" login`, `goto --path`, `snapshot`, `click --role --name`, `fill`, `press`, `screenshot`, `$C api "$RUN" <method> <path> [--as anon] [--body <json>]`, `$C reset "$RUN"`. Each writes its evidence under `$RUN/evidence/`.
Expand Down Expand Up @@ -89,11 +89,10 @@ State the verdict in your own reply. Start it with the result, then the doors, t

List these as not verified in every verdict. The per-feature reasons are in [coverage/](coverage).

- Copy, Copy cURL and Copy the URL buttons: they write to the clipboard.
- The Tester's Copy cURL and the Copy buttons beside a value (the request's URL, ID and error message): no journey presses them yet. The clipboard can be read, as `copy-curl-copies-the-open-request-as-a-command` does.
- The automation runtime: the playground does not load `@antelopejs/dms-automation`. The fixture module stands in for its provider, so the `automation` journeys drive the three nodes' `execute` and `activate`, and the election that runs `api.route-unhealthy` on one node is not driven.
- A second instance behind one console sharing `testerSourceSecret`: the run has one backend.
- Pointer drag of the drawer's edge and the persisted drawer width.
- Keyboard shortcuts `L`, `/` and `?`, the Tester's History, Headers for all routes and the form's editors, and a Tester call's forwarding limits.
- The Tester form's query and body editors, and the 30 s timeout of the Tester's forwarding route.

## Feature map

Expand Down
4 changes: 2 additions & 2 deletions .agents/skills/verify-dms-api/coverage/access.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
| docs/5.extending.md (Access) | Each route is guarded with `@AuthUserWithPermission(<block>)` for the block it feeds | `every-console-route-needs-a-session-and-the-block-it-serves` | all 28 routes answer 401 without a session and 403 naming the missing permission to a member with none |
| docs/5.extending.md (Access) | The console is for the owner only: a role cannot be given the console or any block of it | `the-console-is-the-owners-and-a-role-holding-a-block-is-refused` | a role holding the logs table's permission and a role holding the Tester's are refused on every route; the owner opens `GET /logs` and `GET /tester/source` |
| docs/5.extending.md (Access) | The settings summary is for the owner | `every-console-route-needs-a-session-and-the-block-it-serves` | `GET /settings/summary` is 403 for a member and passes for the owner |
| docs/4.usage/4.settings.md (intro) | Module pages are the owner's | Not driven: the pages' own redirect for a member is not asserted; the routes' answers are |
| src/services/request-log/access.ts (TSDoc) | A panel opened from one table reads only a request that table can list; a request out of reach is a 404 | Not driven: needs a member with the Overview's recent-requests permission and an out-of-scope request |
| docs/4.usage/4.settings.md (intro) | Module pages are the owner's | `a-member-without-the-modules-permissions-is-sent-to-their-settings` | the owner stays on each of the four pages and sees its heading; the member is sent to `/settings` from each page and from `/modules/api`, sees the `Settings` heading and none of the console's; the routes' answers are asserted by `every-console-route-needs-a-session-and-the-block-it-serves` |
| src/services/request-log/access.ts (TSDoc) | A panel opened from one table reads only a request that table can list; a request out of reach is a 404 | `a-panel-opened-from-one-table-reads-only-a-request-that-table-can-list` | with the scope on the project's routes: a module's request reads 200 on the Request logs panel and 404 on the Overview's, the Routes page's and the Tester's; one the Tester sent reads 200 on the Tester's panel too; the project's request reads 200 everywhere; the refusal answers like an id nothing holds. HTTP only, as the owner: a member holding a table's permission is refused before the panel's rule applies |
| docs/5.extending.md (Access) | The 403 names that block's permission id | `every-console-route-needs-a-session-and-the-block-it-serves` | each of the 27 routes refuses a member with the exact permission id of its own block (`modules.api.monitor.logs.requests`, `...explore.routes.explorer.tabs.tester` for `/logs/tester` and `/tester/source`, `...configure.settings.form` for the settings routes, and so on); `/settings/summary` answers `Owner-only` |
8 changes: 4 additions & 4 deletions .agents/skills/verify-dms-api/coverage/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,23 @@
| docs/4.usage/2.request-logs.md (Filter) | Tabs All, 2xx, 4xx, 5xx with counts | `the-tabs-the-filters-and-the-search-narrow-the-list` | API totals per class and the tab buttons `All 11`, `2xx 7`, `4xx 2`, `5xx 2`; the 4xx tab shows only the 404s and hides the 500s |
| docs/4.usage/2.request-logs.md (Filter) | Method and Slow narrow the table; the slow filter follows the slow threshold | same | `a method`, `two methods`, `slow follows the threshold`, button `Slow (≥ 50 ms)` then only `/fx/slow` |
| docs/4.usage/2.request-logs.md (Filter) | The period selector adds All time (ALL) and compares nothing | `counts-are-grouped-and-all-time-compares-nothing`; `the-histogram-bars-follow-the-period` | on `?api.period=all` the All time radio is on, no `Comparison:` control and no previous-period text show; `Requests per 6 h · all kept logs` |
| docs/4.usage/2.request-logs.md (Filter) | `/` opens the search; `?` lists the shortcuts | Not driven: keyboard shortcuts; the search itself is driven through the API (`the search matches error words`, `the search matches path words`) |
| docs/4.usage/2.request-logs.md (Filter) | `/` opens the search; `?` lists the shortcuts | `slash-opens-the-request-search-and-question-mark-lists-the-shortcuts` | `the question mark` (the `Keyboard shortcuts` dialog and its five lines), `Escape` closes it, `the focused field` is the search after `/` and not before, `typing without a click` narrows the table to `/fx/missing`; the search itself is also driven through the API (`the search matches error words`, `the search matches path words`) |
| docs/4.usage/2.request-logs.md (Open a request) | A click on a row opens the drawer titled with its method and path | `a-request-opens-in-a-drawer-that-steps-through-the-list` | `the newest request` |
| docs/4.usage/2.request-logs.md (Open a request) | Its position over the whole result (`3 of 26,120`); J steps to the next request and K to the previous one | same | `1 of 6`, `Next` to `2 of 6`, `J steps to the next request` (`3 of 6`), `K steps back` |
| docs/4.usage/2.request-logs.md (Open a request) | The URL names it (`?record=<id>`); a link or a reload opens it again | same | `the URL names the record`, `a reload` |
| docs/4.usage/2.request-logs.md (Open a request) | Drag its left edge to widen it: it opens again at that width | Not driven: pointer drag |
| docs/4.usage/2.request-logs.md (Open a request) | Drag its left edge to widen it: it opens again at that width | `dragging-the-drawers-left-edge-widens-it-and-it-opens-again-at-that-width` | `the drawer is wider after the drag` (600 px to 760 px for a 160 px drag with the real pointer), `its edge reports the width`, `opened again` and `after a reload` at the same width |
| docs/4.usage/2.request-logs.md (Open a request) | Summary: the error and its stack, the general facts, the timing against the route's p50 and p95, the path parameters | same | `Summary`: error message, Route, User agent, Request ID, `500 Internal Server Error`, `Slow threshold 1,000 ms, as set now.` |
| docs/4.usage/2.request-logs.md (Open a request) | Request: the captured headers, query string and body | same | `Request`: `limit 5`, `content-type application/json`, the body |
| docs/4.usage/2.request-logs.md (Open a request) | Response: the status, headers and body | same | `Response` |
| docs/4.usage/2.request-logs.md (Open a request) | Replay in tester opens the route's Tester filled with the request | same | `Replay in tester`: URL `tab=tester&replay=`, the path parameter box, the body |
| docs/4.usage/2.request-logs.md (Open a request) | Copy cURL copies it as a command | Not driven: clipboard |
| docs/4.usage/2.request-logs.md (Open a request) | Copy cURL copies it as a command | `copy-curl-copies-the-open-request-as-a-command` | the clipboard (read with the context's clipboard permission) holds a `curl -X POST` command with the API origin, `/fx/orders/shop1/lines?limit=5`, the captured content type and the body; the toast `cURL copied` |
| docs/4.usage/2.request-logs.md (Open a request) | Same error lists the other requests that failed the same way | same | `Same error`: URL route and error, `All 2` |
| docs/4.usage/2.request-logs.md (note) | Bodies above the cap are stored truncated and flagged; secret-looking values are stored as `[REDACTED]` | feature capture | see coverage/capture.md |
| docs/5.extending.md (Link to the console) | `/modules/api/logs?record=<requestId>` opens a request; `?since=&until=` the requests of a range; `?api.period=` and `?live=0` | `a-request-opens-in-a-drawer-that-steps-through-the-list`; `a-link-names-a-range-with-since-and-until`; `the-period-and-the-comparison-are-kept-in-the-url-and-shared-by-the-pages` | `a reload`; `All 3` and `5xx 0` for a range holding 3 of 5 requests, `All 5` without it; `?live=0` |
| src/services/request-log/list.ts (TSDoc) | The route filter names the route's method, not the request's; the path filter is the raw path; the error filter is read whole | `the-tabs-the-filters-and-the-search-narrow-the-list` | `the route filter names the route, not the path`, `the path filter is the raw path`, `the error filter` |
| src/services/request-log/list.ts | The list pages by 50 and keeps the total; sorts by time, status and duration | `the-list-is-newest-first-sorts-and-pages` | `the first page holds 50 rows`, `the second page holds the other 10`, `status ascending`, `status descending` |
| src/services/request-log/list.ts | Sorting by duration | `the-list-sorts-by-duration-both-ways` | four seeded durations (0.4, 12, 999, 1234.5 ms) come back in order ascending and descending; the table writes `0 ms`, `12 ms`, `999 ms`, `1,235 ms` and the slow flag follows the 1 s default |
| docs/4.usage/1.overview.md (Live mode) | "Table on hold · search active" while one row is open or a search is active | Not driven: the hold wording is not asserted |
| docs/4.usage/1.overview.md (Live mode) | "Table on hold · search active" while one row is open or a search is active | `an-open-row-or-an-active-search-holds-the-table-and-says-why` | no notice with nothing open; `page shows /Table on hold · search active/` while a search is typed with `/` and no notice once it is cleared; `an open request says the table is on hold, row open` is listed in `knownFailures`: the request panel is a modal `drawer` target and the DMS names the `row open` hold only for a docked `sidePanel` target, so an open request holds the table without saying why |
| docs/4.usage/2.request-logs.md (Filter) | Method and Slow narrow the table further, together with the status tabs and a route | `filters-combine-with-the-status-tab` | nine combinations with their totals and paths: 2xx and POST 2, 2xx and GET 4, 4xx and GET 1, 4xx and POST 0, 5xx and slow 0, 2xx and slow 1, slow and POST 0, 2xx and a route 2, 5xx and a route 0 |
| docs/4.usage/2.request-logs.md (Filter) | The Slow button names the threshold (Slow (≥ 1 s)) | `the-slow-labels-follow-the-threshold-in-seconds-or-milliseconds` | `1 s` by default, `1.05 s`, `2 s`, `950 ms`, `50 ms`, `600 s`; the Overview line `1 slow route (≥ 1 s)` |
| docs/4.usage/2.request-logs.md (Open a request) | Summary shows the URL, date, route, client IP, user agent, request ID and the path parameters | `a-request-opens-in-a-drawer-that-steps-through-the-list` | `URL` with the full address and query, `Date` with milliseconds, `Route`, `Client IP`, `User agent`, `Request ID` (36 characters), `PATH PARAMETERS shop shop1`, `201 Created`, body size `JSON · 25 B` |
Expand Down
2 changes: 1 addition & 1 deletion .agents/skills/verify-dms-api/coverage/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
| docs/4.usage/1.overview.md | Paused: nothing is read; the toggle says what was missed; tables offer "N new requests · M in 5xx · Show"; resuming reads once | `pause-holds-the-table-and-counts-what-was-missed` (logs) | `paused`, `shown` |
| docs/4.usage/1.overview.md | The page pauses by itself while the tab is hidden and while typing in the Tester; a table holds its rows while one is open | Not driven: visibility and typing focus are not set by the harness |
| docs/4.usage/1.overview.md | `?live=0` opens a page paused | `the-period-and-the-comparison-are-kept-in-the-url-and-shared-by-the-pages` | `?live=0` |
| docs/4.usage/1.overview.md | `L` toggles Live/Pause | Not driven: the keyboard shortcut is checked by no journey |
| docs/4.usage/1.overview.md | `L` toggles Live/Pause | `l-switches-the-page-between-live-and-pause` | `L pauses` (`Pause` is on), `the paused page counts what it did not read` (`Paused · 3 new requests · 1 in 5xx`), the Routes page and the Request logs page open paused, `L makes it live again` and the Overview is live |
| docs/4.usage/1.overview.md | Needs attention flags a route at 5% client errors from 20 calls, a slow route, and not fewer | `a-route-is-flagged-at-the-documented-edges-whatever-the-period` | 19 calls all 404 not flagged; 20 calls with 1 client error flagged at 5%; 25 calls with 1 (4%) not flagged; 19 slow calls not flagged |
| docs/4.usage/1.overview.md | The hero shows the 5xx rate, p95 latency, traffic in requests per minute and the 4xx rate over 15 minutes, with the slow threshold | `a-route-is-flagged-at-the-documented-edges-whatever-the-period` | `0%`, `25.3%`, `5.5 req/min`, `Slow from 50 ms` for 83 calls |
| docs/2.installation.md | `/modules/api` redirects to the Overview; the menu lists Monitor, Explore and Configure | `the-module-path-redirects-to-the-overview` | the path after the redirect, the heading, the four links and their sections |
Expand Down
Loading
Loading