Compare commits
40
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d7476f0fe8 | ||
|
|
75bb0af9fd | ||
|
|
0c11e11c27 | ||
|
|
c1924060eb | ||
|
|
28dfce246a | ||
|
|
a0624789ce | ||
|
|
a8d00056ff | ||
|
|
639b80f468 | ||
|
|
718a12c2f4 | ||
|
|
4e55d14599 | ||
|
|
0f84db57f1 | ||
|
|
959b3b70c9 | ||
|
|
2281a8729b | ||
|
|
e3c2c0cebb | ||
|
|
daecf3d539 | ||
|
|
71259bc11d | ||
|
|
d085ea3ded | ||
|
|
1273491eee | ||
|
|
6cba785e2f | ||
|
|
5152fffe82 | ||
|
|
9df8a652dc | ||
|
|
e577ee8683 | ||
|
|
0e998333e0 | ||
|
|
2840df68b2 | ||
|
|
0341fc2201 | ||
|
|
bba6eb2f94 | ||
|
|
531754c3fa | ||
|
|
cafc126d1b | ||
|
|
f24a1b7dd5 | ||
|
|
63c2df96f1 | ||
|
|
23fa302b25 | ||
|
|
f43d902297 | ||
|
|
2129708819 | ||
|
|
6e9b99e415 | ||
|
|
8aadbd25fb | ||
|
|
9f341719ef | ||
|
|
5de9272281 | ||
|
|
a6d468bd2c | ||
|
|
b0f2c72b5f | ||
|
|
e586ab9bd9 |
No files matched your search
+41
-21
@@ -1,26 +1,46 @@
|
|||||||
NODE_ENV=development
|
## Optional overrides: copy to .env and uncomment the settings you need.
|
||||||
PORT=3000
|
## Every setting has a default (shown below), so liqa runs without a .env file.
|
||||||
|
##
|
||||||
|
## Lines starting with "##" are descriptions.
|
||||||
|
## Lines starting with "# " are settings: remove the "# " to enable one.
|
||||||
|
|
||||||
# Directory (relative to cwd) containing *.json key descriptors
|
## production in the Docker image; also selects the default CORS origins
|
||||||
KEYS_DIR=keys
|
# NODE_ENV=development
|
||||||
|
# PORT=3000
|
||||||
|
|
||||||
# SQLite database path
|
## Origins allowed to call the API cross-origin (comma separated). Default: the
|
||||||
DB_PATH=data/sessions.db
|
## Vite dev server (http://localhost:5173) in development, the compose port
|
||||||
|
## (http://localhost:13000) in production
|
||||||
|
# CORS_ORIGINS=http://localhost:5173,http://127.0.0.1:5173
|
||||||
|
|
||||||
# Chromium binary to use instead of Playwright's own (not needed in Docker,
|
## SQLite database path
|
||||||
# which ships Playwright's chromium-headless-shell)
|
# DB_PATH=data/liqa.db
|
||||||
|
|
||||||
|
## Stored scenario files and run artifacts (downloads, failure dumps, traces)
|
||||||
|
# FILES_DIR=data/files
|
||||||
|
## Days to keep run artifacts before they are deleted
|
||||||
|
# FILE_RUN_EXPIRATION_DAYS=7
|
||||||
|
## When expired files are deleted (cron expression)
|
||||||
|
# FILE_CLEANUP_CRON=0 3 * * *
|
||||||
|
|
||||||
|
## Close open sessions that have been idle for longer than this many minutes
|
||||||
|
# SESSION_IDLE_TIMEOUT_MINUTES=30
|
||||||
|
## Delete closed sessions whose updatedAt is older than this many days
|
||||||
|
# SESSION_DELETE_CLOSED_DAYS=7
|
||||||
|
|
||||||
|
## Playwright trace recording for scenario runs: on | retain-on-failure | off
|
||||||
|
## (traces often reach ~10 MB per run; can be overridden per run in the run modal)
|
||||||
|
# PLAYWRIGHT_TRACE_MODE=off
|
||||||
|
|
||||||
|
## Run log data blocks whose pretty-printed JSON exceeds either limit start
|
||||||
|
## collapsed in the UI (bytes, lines); served to the client via /manifest.json
|
||||||
|
# RUN_LOG_DATA_COLLAPSE_BYTES=256
|
||||||
|
# RUN_LOG_DATA_COLLAPSE_LINES=5
|
||||||
|
|
||||||
|
## Chromium binary to use instead of Playwright's own (not needed in Docker,
|
||||||
|
## which ships Playwright's chromium-headless-shell)
|
||||||
# PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH=/usr/bin/chromium
|
# PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH=/usr/bin/chromium
|
||||||
|
|
||||||
# Session lifecycle
|
## Directory with the built client to serve at / (the Docker image sets it to
|
||||||
# Close open sessions that have been idle for longer than this many minutes
|
## "client"; leave unset to not serve the UI, e.g. when using the Vite dev server)
|
||||||
SESSION_IDLE_TIMEOUT_MINUTES=30
|
# CLIENT_DIR=client
|
||||||
# Delete closed sessions whose updatedAt is older than this many days
|
|
||||||
SESSION_DELETE_CLOSED_DAYS=7
|
|
||||||
|
|
||||||
# Playwright trace recording for scenario runs: on | retain-on-failure | off
|
|
||||||
# (traces often reach ~10 MB per run; can be overridden per run in the run modal)
|
|
||||||
PLAYWRIGHT_TRACE_MODE=off
|
|
||||||
|
|
||||||
# Directory with the built client to serve at / (set to "client" in the Docker image;
|
|
||||||
# leave empty to not serve the UI, e.g. when using the Vite dev server)
|
|
||||||
# CLIENT_DIR=
|
|
||||||
@@ -0,0 +1,120 @@
|
|||||||
|
# Code quality checks on master and pull requests. The server and client jobs
|
||||||
|
# only run when their directory (or shared root files) changed. On a release
|
||||||
|
# tag push (vX.Y.Z), runs both jobs unconditionally and then builds the Docker
|
||||||
|
# image and pushes it to this Gitea instance's container registry, tagged with
|
||||||
|
# the version and `latest`. The tag must match the root package.json version.
|
||||||
|
#
|
||||||
|
# Needs a repository (or owner) secret REGISTRY_TOKEN: a Gitea access token
|
||||||
|
# with package write access for the repository owner. The registry host is
|
||||||
|
# set explicitly below rather than taken from the server URL, which is the
|
||||||
|
# address the runner was registered with and may be internal-only.
|
||||||
|
|
||||||
|
name: CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [master]
|
||||||
|
tags: ['v[0-9]+.[0-9]+.[0-9]+']
|
||||||
|
pull_request:
|
||||||
|
|
||||||
|
env:
|
||||||
|
REGISTRY: git.hq.ars9.space
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Not needed on tag pushes: server and client always run there
|
||||||
|
changes:
|
||||||
|
if: ${{ !startsWith(github.ref, 'refs/tags/') }}
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
server: ${{ steps.filter.outputs.server }}
|
||||||
|
client: ${{ steps.filter.outputs.client }}
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: dorny/paths-filter@v3
|
||||||
|
id: filter
|
||||||
|
with:
|
||||||
|
filters: |
|
||||||
|
server:
|
||||||
|
- 'server/**'
|
||||||
|
- 'package.json'
|
||||||
|
- 'package-lock.json'
|
||||||
|
- '.gitea/workflows/ci.yml'
|
||||||
|
client:
|
||||||
|
- 'client/**'
|
||||||
|
- 'package.json'
|
||||||
|
- 'package-lock.json'
|
||||||
|
- '.gitea/workflows/ci.yml'
|
||||||
|
|
||||||
|
server:
|
||||||
|
needs: changes
|
||||||
|
# changes is skipped on tag pushes, hence !cancelled()
|
||||||
|
if: |
|
||||||
|
!cancelled() &&
|
||||||
|
(startsWith(github.ref, 'refs/tags/') || needs.changes.outputs.server == 'true')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 24
|
||||||
|
cache: npm
|
||||||
|
- run: npm ci -w server
|
||||||
|
- name: Lint
|
||||||
|
run: npm run -w server lint -- --max-warnings=0
|
||||||
|
- name: Type-check
|
||||||
|
run: npx tsc --noEmit -p server/tsconfig.json
|
||||||
|
- name: Test
|
||||||
|
run: npm test -w server
|
||||||
|
- name: Build
|
||||||
|
run: npm run -w server build
|
||||||
|
|
||||||
|
client:
|
||||||
|
needs: changes
|
||||||
|
# changes is skipped on tag pushes, hence !cancelled()
|
||||||
|
if: |
|
||||||
|
!cancelled() &&
|
||||||
|
(startsWith(github.ref, 'refs/tags/') || needs.changes.outputs.client == 'true')
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: 24
|
||||||
|
cache: npm
|
||||||
|
- run: npm ci -w client
|
||||||
|
- name: Lint
|
||||||
|
run: npm run -w client lint -- --max-warnings=0
|
||||||
|
- name: Build
|
||||||
|
run: npm run -w client build
|
||||||
|
- name: Install headless Chromium for Storybook tests
|
||||||
|
run: npx playwright install --with-deps --only-shell chromium
|
||||||
|
- name: Storybook tests
|
||||||
|
run: npm run -w client test:storybook
|
||||||
|
|
||||||
|
image:
|
||||||
|
needs: [server, client]
|
||||||
|
if: ${{ !failure() && !cancelled() && startsWith(github.ref, 'refs/tags/') }}
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Check the tag matches package.json
|
||||||
|
run: |
|
||||||
|
version=$(node -p "require('./package.json').version")
|
||||||
|
if [ "${GITHUB_REF_NAME}" != "v${version}" ]; then
|
||||||
|
echo "tag ${GITHUB_REF_NAME} does not match package.json version ${version}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "VERSION=${version}" >> "$GITHUB_ENV"
|
||||||
|
- name: Log in to the registry
|
||||||
|
env:
|
||||||
|
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||||
|
OWNER: ${{ github.repository_owner }}
|
||||||
|
run: |
|
||||||
|
echo "IMAGE=${REGISTRY}/$(echo "${GITHUB_REPOSITORY}" | tr '[:upper:]' '[:lower:]')" >> "$GITHUB_ENV"
|
||||||
|
echo "$REGISTRY_TOKEN" | docker login "$REGISTRY" -u "$OWNER" --password-stdin
|
||||||
|
- name: Build
|
||||||
|
run: docker build --build-arg VERSION="${VERSION}" -t "${IMAGE}:${VERSION}" -t "${IMAGE}:latest" .
|
||||||
|
- name: Push
|
||||||
|
run: |
|
||||||
|
docker push "${IMAGE}:${VERSION}"
|
||||||
|
docker push "${IMAGE}:latest"
|
||||||
+196
@@ -2,6 +2,202 @@
|
|||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## 1.24.3 - 2026-10-02
|
||||||
|
|
||||||
|
Changes since 1.24.2:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- `examples/` directory with ready-to-import example resources. The first one, `examples/self-test`, is a scenario that tests the liqa instance it runs on: it creates a temporary scenario through the REST API, runs it, checks the run and its page in the UI, and cleans up. It uses an environment, a credential, snippets and assertions.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- CI builds and pushes the Docker image only when a `vX.Y.Z` release tag is pushed, not on every merge to `master`.
|
||||||
|
|
||||||
|
## 1.24.2 - 2026-10-02
|
||||||
|
|
||||||
|
Changes since 1.24.1:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Large run log data blocks start collapsed behind a "Show data (size, lines)" toggle: data whose pretty-printed JSON is over `RUN_LOG_DATA_COLLAPSE_BYTES` (default 256) bytes or `RUN_LOG_DATA_COLLAPSE_LINES` (default 5) lines. An "Expand data" / "Collapse data" button next to the Logs heading opens or closes all of them.
|
||||||
|
- "Copy logs" button on the run page: copies the currently filtered logs to the clipboard as plain text, with every data block expanded.
|
||||||
|
- `GET /manifest.json`: public client configuration served by the server - the app name and version, and the run log data limits. The UI caches it in `localStorage` and revalidates it on page load and when the tab is refocused after a while.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- The sidebar footer shows the server's version (from `/manifest.json`); its tooltip suggests reloading the page when it differs from the version the UI was built with.
|
||||||
|
- Run log data blocks are aligned with the context/message column instead of the level column.
|
||||||
|
|
||||||
|
## 1.24.1 - 2026-10-02
|
||||||
|
|
||||||
|
Changes since 1.24.0:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- `context.assert(fn, description, details?)`: optional `details` argument. On failure, the `assertion:fail` log entry stores `{ details, error }` as data (`error` is the exception message when `fn` threw), so large diagnostics such as a response body can stay out of the message. The exported e2e runtime accepts and prints it too.
|
||||||
|
- The "Step N passed" log entry carries the step's return value as data.
|
||||||
|
- File names in the run Artifacts and scenario Files tables link to the file content, opening it in a new tab (shown inline when the browser can display it).
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- For assertion failures, the "Step N failed" and "Snippet X failed" log entries name only the assertion (`Assertion failed: <description>`) instead of repeating the failure details. The step run's description keeps the full message.
|
||||||
|
- Log output shows elapsed time in whole seconds (`+14s`), matching the stored timestamp resolution.
|
||||||
|
|
||||||
|
## 1.24.0 - 2026-10-01
|
||||||
|
|
||||||
|
Changes since 1.23.0:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Code reference in the UI: a (?) button next to the Code label on the step and snippet create/edit pages opens a modal documenting the script runtime - the globals (`context`, `expect`, `console`, and `args` in snippets) and every `context` member with examples, including pitfalls such as awaiting `getStepOutput()` and `assert()`, and `downloadFile()` not sending the browser's cookies.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- `Modal` UI component: new `size="lg"` for long, document-like content. Dialogs are now capped to the viewport height and their body scrolls, instead of overflowing the screen.
|
||||||
|
|
||||||
|
## 1.23.0 - 2026-10-01
|
||||||
|
|
||||||
|
Changes since 1.22.2:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Run log entries now carry a `context` (where the message was generated: `step:<N>`, `snippet:<alias>`, `assertion:pass`/`fail`, or `run`) and a `data` field: `context.log`/`warn`/`error` and `console.*` split their arguments so strings join into `message` while object/array arguments are kept separate as `data` (JSON), instead of being `JSON.stringify`'d into the message text.
|
||||||
|
- Added a `debug` log level (`context.debug()`, `console.debug()`), alongside `log`/`warn`/`error`.
|
||||||
|
- New `LogOutput` UI component: a terminal-style log viewer on the run detail page, color-coded by level, with an elapsed-time-since-start column, a context tag, and `data` rendered pretty-printed in a separate block below the message. The full log list is shown (no more pagination), capped to a scrollable block.
|
||||||
|
- Run log CSV/Markdown export (`GET /scenarios/:id/runs/:runId/export`) include the new `context` and `data` columns/blocks; the logs search (`?q=`) also matches `context`.
|
||||||
|
|
||||||
|
## 1.22.2 - 2026-10-01
|
||||||
|
|
||||||
|
Changes since 1.22.1:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- MIT license (`LICENSE`), declared in all `package.json` files and the README.
|
||||||
|
- The Docker image includes the license notices of everything it ships: `scripts/third-party-licenses.mjs` collects the license of every production dependency of the client and server, the Node.js license is added, and the result is served at `/licenses.txt`, linked as "Licenses" in the sidebar footer.
|
||||||
|
- OCI image labels for title, version, license and source; CI passes the version as the `VERSION` build arg.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- The Docker image keeps packages' `LICENSE.md`/`NOTICE.md` files, which the 1.22.1 slimming step deleted along with other Markdown files.
|
||||||
|
|
||||||
|
## 1.22.1 - 2026-10-01
|
||||||
|
|
||||||
|
Changes since 1.22.0:
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- The Docker image is about 20% smaller (1.09 GB → 876 MB on disk, 251 MB → 220 MB compressed). Production dependencies and Chromium are installed in a separate stage that drops files nothing loads at runtime (source maps, TypeScript sources and declarations, docs, TypeORM's browser build, better-sqlite3's C sources, Playwright's ffmpeg). The runtime image is `debian:bookworm-slim` with only the `node` binary, so it no longer contains `npm`, `npx`, `yarn` or `corepack`.
|
||||||
|
|
||||||
|
## 1.22.0 - 2026-10-01
|
||||||
|
|
||||||
|
Changes since 1.21.1:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- The Export Scenario dialog lists the snippets the scenario uses (including ones used only through other snippets), all checked by default. A selected snippet is exported once per version the scenario uses: the latest for `runSnippet("alias")`, plus each version pinned with `alias@N`. `GET /scenarios/:id/export` takes the new `snippetIds` query parameter for this.
|
||||||
|
- The Export Scenario dialog shows the scenario version next to its name and id.
|
||||||
|
|
||||||
|
## 1.21.1 - 2026-10-01
|
||||||
|
|
||||||
|
Changes since 1.21.0:
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- The credential page hides the credential data when it opens; a Reveal button shows it and Hide hides it again. The data is not rendered on the page until revealed.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- A `RevealableCodeBlock` UI component (a CodeBlock that starts hidden behind a Reveal/Hide button), with a Storybook story.
|
||||||
|
|
||||||
|
## 1.21.0 - 2026-10-01
|
||||||
|
|
||||||
|
Changes since 1.20.2:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- UUID badges show a small colored circle in front of the short id. Its color comes from the first 6 hex digits of the UUID, so the same id always gets the same color, and its border uses the badge text color to stay visible in both themes.
|
||||||
|
- UUID badges get lighter on hover to show they can be clicked.
|
||||||
|
- `Badge` accepts an optional `className`.
|
||||||
|
- A Storybook "Colors" story for UuidBadge with six sample ids and a button to randomize them.
|
||||||
|
|
||||||
|
## 1.20.2 - 2026-09-30
|
||||||
|
|
||||||
|
Changes since 1.20.1:
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Text contrast now meets WCAG AA (4.5:1) in both themes:
|
||||||
|
- the "Live" refresh label and the table sort icon use a new `--color-primary-text` token (dark lime in the light theme) instead of the light lime brand color;
|
||||||
|
- the idle refresh label is no longer dimmed with opacity;
|
||||||
|
- the light theme's danger button is a little darker, and the dark theme's danger hover is lighter so its dark text stays readable;
|
||||||
|
- syntax highlighting colors are defined per theme (`--hl-*` tokens), darker in the light theme;
|
||||||
|
- muted text is slightly darker in the light theme.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- A Storybook "Accessibility / Contrast" page that measures the contrast of the most contrast-prone components in both themes.
|
||||||
|
- Storybook accessibility checks now fail the tests on violations (`a11y.test: 'error'`). The Colors story shows each token's current value per theme and includes the syntax colors.
|
||||||
|
|
||||||
|
## 1.20.1 - 2026-09-30
|
||||||
|
|
||||||
|
Changes since 1.20.0:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Storybook stories for AutoRefreshIndicator, CodeBlock, CodeEditor, MarkdownContent, Modal, Notification, Search, Textarea, Toast and UuidBadge, with interaction tests where the component has behavior. The DescriptionList story covers all four layouts.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Updated all client and server dependencies to the latest versions within their ranges, including React 19.3, Storybook 10.6, NestJS 11.2, TypeORM 0.3.31 and Playwright 1.63 (the Docker image now ships HeadlessChrome 153).
|
||||||
|
- The Storybook tests are part of the pre-commit checks.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Code flagged by the stricter React hooks lint rules: the runs list no longer writes refs during render, and the scenario list, scenario files and sessions list no longer set state synchronously inside effects.
|
||||||
|
|
||||||
|
## 1.20.0 - 2026-09-30
|
||||||
|
|
||||||
|
Changes since 1.19.3:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Database migrations: the SQLite schema is now managed by TypeORM migrations (`server/src/database/migrations/`) instead of `synchronize`. The Docker container applies pending migrations before starting the server, and the server refuses to start while migrations are pending.
|
||||||
|
- `npm -w server run migration:run`, `migration:show` and `migration:generate` scripts; the workflow for schema changes is described in `docs/development.md`.
|
||||||
|
- A test that fails when an entity changes without a matching migration.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Databases created before migrations (by `synchronize`) are adopted automatically: the initial migration is recorded as applied without changing them.
|
||||||
|
- Tests now build their database from the migrations instead of `synchronize`.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Startup failures were logged but the process exited with code 0; they now exit with code 1.
|
||||||
|
|
||||||
|
## 1.19.3 - 2026-09-30
|
||||||
|
|
||||||
|
Changes since 1.19.2:
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- The Docker image runs with `NODE_ENV=production`.
|
||||||
|
- The origins allowed to call the API cross-origin depend on `NODE_ENV`: the Vite dev server (`http://localhost:5173`, `http://127.0.0.1:5173`) in development, the compose port (`http://localhost:13000`, `http://127.0.0.1:13000`) in production. The new `CORS_ORIGINS` setting (comma separated) overrides both. A `NODE_ENV=development` in `.env` overrides the image's production mode.
|
||||||
|
- `.env` is optional: compose loads it only when it exists, and every setting in `.env.example` is commented out and shows its default.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
|
||||||
|
- The unused `KEYS_DIR` setting and the `./keys` mount in `compose.yaml`.
|
||||||
|
|
||||||
|
## 1.19.2 - 2026-09-30
|
||||||
|
|
||||||
|
Changes since 1.19.1:
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Running a scenario from its detail page could preselect the first environment in the list instead of the scenario's default environment, depending on whether the environment list or the scenario loaded first. The default environment is now chosen when the run modal opens.
|
||||||
|
- Made the run status filter test deterministic; it could fail when the scheduler picked up the test's pending run mid-test.
|
||||||
|
|
||||||
## 1.19.1 - 2026-09-30
|
## 1.19.1 - 2026-09-30
|
||||||
|
|
||||||
Changes since 1.19.0:
|
Changes since 1.19.0:
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
# liqa
|
# liqa
|
||||||
|
|
||||||
liqa (liquio-qa-bot) is a QA automation service for Liquio environments. It stores **scenarios** (ordered Playwright steps), **snippets** (reusable code run via `context.runSnippet`), **environments**, **credentials** and **sessions**, and runs scenarios in headless Chromium. Scenarios and snippets are versioned; each run records the scenario version it executed.
|
liqa is a browser automation and QA service for web applications. It stores **scenarios** (ordered Playwright steps), **snippets** (reusable code run via `context.runSnippet`), **environments**, **credentials** and **sessions**, and runs scenarios in headless Chromium. Scenarios and snippets are versioned; each run records the scenario version it executed.
|
||||||
|
|
||||||
It is an npm workspace with two packages:
|
It is an npm workspace with two packages:
|
||||||
|
|
||||||
- `server/` - NestJS API + scheduler + MCP server, SQLite via TypeORM (`synchronize: true`, so entity changes alter the schema on startup - there are no migrations). REST API under `/api/v1`, Swagger UI at `/docs`, MCP at `/mcp`, health at `/health`.
|
- `server/` - NestJS API + scheduler + MCP server, SQLite via TypeORM; the schema is managed by migrations in `server/src/database/migrations/` (see "Database migrations" in `docs/development.md`). Any entity change needs a generated migration - `test/migrations.spec.ts` fails otherwise. REST API under `/api/v1`, Swagger UI at `/docs`, MCP at `/mcp`, health at `/health`, public client configuration at `/manifest.json`.
|
||||||
- `client/` - React 19 + Vite SPA (i18n strings in `client/src/i18n/locales/en.json`).
|
- `client/` - React 19 + Vite SPA (i18n strings in `client/src/i18n/locales/en.json`).
|
||||||
|
|
||||||
## Docs
|
## Docs
|
||||||
@@ -14,17 +14,24 @@ It is an npm workspace with two packages:
|
|||||||
- [docs/development.md](docs/development.md) - local setup, running, testing, Docker
|
- [docs/development.md](docs/development.md) - local setup, running, testing, Docker
|
||||||
- [docs/scenario.md](docs/scenario.md) - scenario execution, script `context` API, versioning, export/import, Playwright traces
|
- [docs/scenario.md](docs/scenario.md) - scenario execution, script `context` API, versioning, export/import, Playwright traces
|
||||||
- [docs/mcp.md](docs/mcp.md) - MCP tool reference
|
- [docs/mcp.md](docs/mcp.md) - MCP tool reference
|
||||||
|
- [examples/](examples/README.md) - ready-to-import example resources (YAML); `server/test/examples.spec.ts` imports each file, so keep them in sync with the import format
|
||||||
- [CHANGELOG.md](CHANGELOG.md) - release notes per version
|
- [CHANGELOG.md](CHANGELOG.md) - release notes per version
|
||||||
- [Dockerfile](Dockerfile) - single image: builds client and server, runtime serves both
|
- [Dockerfile](Dockerfile) - single image: builds client and server, runtime serves both
|
||||||
- [.env.example](.env.example) - all configuration variables (validated in `server/src/config/app.config.ts`)
|
- [.env.example](.env.example) - all configuration variables (validated in `server/src/config/app.config.ts`)
|
||||||
|
|
||||||
## Default deployment (docker compose)
|
## Default deployment (docker compose)
|
||||||
|
|
||||||
`compose.yaml` at the repo root runs a single `liqa` container, built from the root `Dockerfile`, at http://localhost:13000. The server serves everything: the UI at `/` (the built client, via `CLIENT_DIR`), the REST API at `/api/v1`, MCP at `/mcp`, Swagger at `/docs`. It reads `.env` and mounts `./data` (SQLite DB `data/liqa.db` + stored files) and `./keys`.
|
`compose.yaml` at the repo root runs a single `liqa` container, built from the root `Dockerfile`, at http://localhost:13000. The server serves everything: the UI at `/` (the built client, via `CLIENT_DIR`), the REST API at `/api/v1`, MCP at `/mcp`, Swagger at `/docs`. It reads `.env` if present (optional - every setting has a default) and mounts `./data` (SQLite DB `data/liqa.db` + stored files).
|
||||||
|
|
||||||
Rebuild and restart: `docker compose up -d --build`. Check with `docker compose ps`, `curl localhost:13000/health` and `docker compose logs liqa`.
|
Rebuild and restart: `docker compose up -d --build`. Check with `docker compose ps`, `curl localhost:13000/health` and `docker compose logs liqa`.
|
||||||
|
|
||||||
The live database is `data/liqa.db`. Because the schema is synced on startup, back it up before deploying entity changes.
|
The live database is `data/liqa.db`. The container applies pending migrations before starting the server, so back it up before deploying a release with new migrations.
|
||||||
|
|
||||||
|
## Branching
|
||||||
|
|
||||||
|
Never commit directly to `master` when implementing a feature, chore or bug fix: create a separate branch for the work first, forked from `master`. These commits don't change the version or `CHANGELOG.md`; the branch is merged back to `master` through a pull request. Only release commits (see "Releasing a new version") are made on `master`.
|
||||||
|
|
||||||
|
When committing on a work branch, also update the docs affected by the change (`docs/*.md`, `README.md`, `.env.example`, MCP tool descriptions) in the same branch.
|
||||||
|
|
||||||
## Code quality
|
## Code quality
|
||||||
|
|
||||||
@@ -34,22 +41,33 @@ Before committing, run and pass all of these (and report the results):
|
|||||||
# server
|
# server
|
||||||
cd server && npm run lint && npx tsc --noEmit -p tsconfig.json && npm test && npm run build
|
cd server && npm run lint && npx tsc --noEmit -p tsconfig.json && npm test && npm run build
|
||||||
# client
|
# client
|
||||||
cd client && npm run lint && npm run build
|
cd client && npm run lint && npm run build && npm run test:storybook
|
||||||
```
|
```
|
||||||
|
|
||||||
- Lint must stay clean in both packages (no errors, no warnings).
|
- Lint must stay clean in both packages (no errors, no warnings).
|
||||||
|
- `test:storybook` runs every story in `client/.storybook/stories/` in headless Chromium (needs `npx playwright install --only-shell chromium` once, and again after Playwright updates). Add or update a story when adding or changing a `client/src/ui/` component.
|
||||||
- Don't run prettier over whole existing files; several aren't prettier-clean and it produces unrelated diffs. Format only new files or the lines you changed.
|
- Don't run prettier over whole existing files; several aren't prettier-clean and it produces unrelated diffs. Format only new files or the lines you changed.
|
||||||
- Server tests use an in-memory DB, a Playwright mock (`server/test/__mocks__/playwright.ts`), and a temporary files directory per test app (see `server/test/app.harness.ts`).
|
- Server tests use an in-memory DB, a Playwright mock (`server/test/__mocks__/playwright.ts`), and a temporary files directory per test app (see `server/test/app.harness.ts`).
|
||||||
- Import Node.js built-in modules with the `node:` prefix (`node:fs`, `node:path`, `node:crypto`, ...).
|
- Import Node.js built-in modules with the `node:` prefix (`node:fs`, `node:path`, `node:crypto`, ...).
|
||||||
|
|
||||||
## Committing a new version
|
## Releasing a new version
|
||||||
|
|
||||||
When asked to commit:
|
A release is cut on `master` after one or more work branches have been merged (their pull request checks are already green). CI builds and pushes the Docker image only when a `vX.Y.Z` tag is pushed, not on merges.
|
||||||
|
|
||||||
1. **Ask which version to bump** - major, minor or patch - and propose a sensible default based on the changes: patch for fixes and small behavior/default tweaks, minor for new features, major for breaking changes (e.g. changed API or export/import formats that old clients or files can't use).
|
When asked to release:
|
||||||
2. Run the code quality checks above.
|
|
||||||
|
1. Make sure you're on an up-to-date, clean `master` (`git switch master && git pull`), and collect the changes since the last release: `git log --oneline "$(git describe --tags --abbrev=0)"..HEAD`.
|
||||||
|
2. **Ask which version to bump** - major, minor or patch - and propose a sensible default based on those changes: patch for fixes and small behavior/default tweaks, minor for new features, major for breaking changes (e.g. changed API or export/import formats that old clients or files can't use).
|
||||||
3. Bump `version` in the root `package.json` and in both places at the top of `package-lock.json` (the root entry and `packages[""]`). `server/package.json` and `client/package.json` keep their own versions; don't bump them.
|
3. Bump `version` in the root `package.json` and in both places at the top of `package-lock.json` (the root entry and `packages[""]`). `server/package.json` and `client/package.json` keep their own versions; don't bump them.
|
||||||
4. Add a `## <version> - <YYYY-MM-DD>` entry at the top of `CHANGELOG.md` ("Changes since <previous version>:", then `### Added` / `### Changed` / `### Fixed`). Mark breaking changes with **Breaking:**.
|
4. Add a `## <version> - <YYYY-MM-DD>` entry at the top of `CHANGELOG.md` ("Changes since <previous version>:", then `### Added` / `### Changed` / `### Fixed`). Mark breaking changes with **Breaking:**.
|
||||||
5. Update the docs affected by the change (`docs/*.md`, `README.md`, `.env.example`, MCP tool descriptions).
|
5. Commit only these release changes on `master`. Build the commit message with the `/git-commit` skill if it is available, following its format and rules. Otherwise use a conventional commit message (`type(scope): subject`, then a bullet list body). Either way, put the version bump in the body as a bullet (e.g. `- bump version to <version>`), not in the subject line. This overrides the skill's rule of putting versions in the subject.
|
||||||
6. Build the commit message with the `/git-commit` skill if it is available, following its format and rules. Otherwise use a conventional commit message (`type(scope): subject`, then a bullet list body). Either way, put the version bump in the body as a bullet (e.g. `- bump version to <version>`), not in the subject line. This overrides the skill's rule of putting versions in the subject. Then make the commit with that message.
|
6. **Tag the release commit** with an annotated tag `v<version>` whose message is that version's `CHANGELOG.md` entry, verbatim (from its `## <version>` heading up to the next version's heading). `--cleanup=whitespace` is required: the default cleanup strips lines starting with `#`, which would drop the entry's headings:
|
||||||
7. **After committing, ask the user whether to rebuild and restart the docker compose containers** (`docker compose up -d --build`); don't do it without confirmation.
|
|
||||||
|
```bash
|
||||||
|
v=<version>
|
||||||
|
awk -v v="$v" 'index($0, "## " v " ") == 1 {p = 1; print; next} p && /^## / {exit} p' CHANGELOG.md \
|
||||||
|
| git tag -a "v$v" --cleanup=whitespace -F -
|
||||||
|
```
|
||||||
|
|
||||||
|
7. **Ask the user before pushing**, then push the commit and the tag together with `git push --follow-tags` (it also pushes annotated tags). The tag push triggers the image build; it fails if the tag doesn't match the `package.json` version.
|
||||||
|
8. **Ask the user whether to rebuild and restart the docker compose containers** (`docker compose up -d --build`); don't do it without confirmation.
|
||||||
+79
-9
@@ -28,8 +28,73 @@ COPY server/tsconfig*.json ./server/
|
|||||||
COPY server/src ./server/src
|
COPY server/src ./server/src
|
||||||
RUN npm run -w server build
|
RUN npm run -w server build
|
||||||
|
|
||||||
|
# ── Runtime dependencies ──────────────────────────────────────────────────────
|
||||||
|
FROM node:24-slim AS runtime-deps
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY package*.json ./
|
||||||
|
COPY server/package.json ./server/
|
||||||
|
|
||||||
|
# Production dependencies and Playwright's headless-only Chromium build,
|
||||||
|
# matching the installed Playwright version. All browser launches are
|
||||||
|
# headless, so the full desktop Chromium (GTK, Mesa/LLVM, icon themes) isn't
|
||||||
|
# needed, and neither is ffmpeg (only used for video recording).
|
||||||
|
#
|
||||||
|
# Then drop what nothing loads at runtime: source maps, TypeScript sources and
|
||||||
|
# declarations, docs (but not license files), TypeORM's browser build and
|
||||||
|
# better-sqlite3's C sources (the addon is already compiled).
|
||||||
|
ENV PLAYWRIGHT_BROWSERS_PATH=/ms-playwright
|
||||||
|
RUN npm ci --omit=dev -w server \
|
||||||
|
&& npx playwright install --only-shell chromium \
|
||||||
|
&& rm -rf /ms-playwright/ffmpeg-* \
|
||||||
|
&& find node_modules -type f \( \
|
||||||
|
-name '*.map' -o -name '*.ts' -o -name '*.mts' -o -name '*.cts' \
|
||||||
|
-o \( \( -iname '*.md' -o -iname '*.markdown' \) \
|
||||||
|
! -iname 'licen[cs]e*' ! -iname 'notice*' ! -iname 'copying*' \) \
|
||||||
|
\) -delete \
|
||||||
|
&& rm -rf node_modules/typeorm/browser \
|
||||||
|
node_modules/better-sqlite3/deps \
|
||||||
|
node_modules/better-sqlite3/src
|
||||||
|
|
||||||
|
# ── License notices ───────────────────────────────────────────────────────────
|
||||||
|
# One file with the project's LICENSE and the license of everything the image
|
||||||
|
# ships: the production dependencies of both workspaces (the client's are
|
||||||
|
# bundled into its build, so their license files aren't in the image
|
||||||
|
# otherwise) and the Node.js binary, whose LICENSE the node image doesn't
|
||||||
|
# include.
|
||||||
|
FROM node:24-slim AS licenses
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY package*.json LICENSE ./
|
||||||
|
COPY client/package.json ./client/
|
||||||
|
COPY server/package.json ./server/
|
||||||
|
COPY scripts/third-party-licenses.mjs ./scripts/
|
||||||
|
RUN npm ci --omit=dev --ignore-scripts \
|
||||||
|
&& node scripts/third-party-licenses.mjs > licenses.txt \
|
||||||
|
&& node -e ' \
|
||||||
|
const url = `https://raw.githubusercontent.com/nodejs/node/v${process.versions.node}/LICENSE`; \
|
||||||
|
fetch(url).then(async (r) => { \
|
||||||
|
if (!r.ok) throw new Error(`${url}: ${r.status}`); \
|
||||||
|
const rule = "-".repeat(79); \
|
||||||
|
process.stdout.write(`\n${rule}\n\nnode@${process.versions.node}\nLicense: MIT\n\n${(await r.text()).trim()}\n`); \
|
||||||
|
}).catch((e) => { console.error(e.message); process.exit(1); });' >> licenses.txt
|
||||||
|
|
||||||
# ── Runtime ───────────────────────────────────────────────────────────────────
|
# ── Runtime ───────────────────────────────────────────────────────────────────
|
||||||
FROM node:24-slim AS runtime
|
# Plain Debian with just the node binary: npm, yarn, corepack and the C
|
||||||
|
# headers that come with the node image aren't needed to run the app.
|
||||||
|
FROM debian:bookworm-slim AS runtime
|
||||||
|
|
||||||
|
# Set by CI from the root package.json version
|
||||||
|
ARG VERSION=dev
|
||||||
|
LABEL org.opencontainers.image.title="liqa" \
|
||||||
|
org.opencontainers.image.version="${VERSION}" \
|
||||||
|
org.opencontainers.image.licenses="MIT" \
|
||||||
|
org.opencontainers.image.source="https://git.hq.ars9.space/ars9/liqa"
|
||||||
|
|
||||||
|
# Runtime only: in the build stages it would make npm ci skip devDependencies
|
||||||
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
# Shared libraries chrome-headless-shell links against (from `ldd`), plus
|
# Shared libraries chrome-headless-shell links against (from `ldd`), plus
|
||||||
# fontconfig and basic fonts for text rendering. Playwright's `--with-deps`
|
# fontconfig and basic fonts for text rendering. Playwright's `--with-deps`
|
||||||
@@ -60,28 +125,33 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
|
|||||||
libxrandr2 \
|
libxrandr2 \
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
|
||||||
|
COPY --from=runtime-deps /usr/local/bin/node /usr/local/bin/node
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
COPY package*.json ./
|
COPY package*.json ./
|
||||||
COPY server/package.json ./server/
|
COPY server/package.json ./server/
|
||||||
|
|
||||||
# Playwright's headless-only Chromium build, matching the installed Playwright
|
|
||||||
# version. All browser launches are headless, so the full desktop Chromium
|
|
||||||
# (GTK, Mesa/LLVM, icon themes) isn't needed.
|
|
||||||
ENV PLAYWRIGHT_BROWSERS_PATH=/ms-playwright
|
ENV PLAYWRIGHT_BROWSERS_PATH=/ms-playwright
|
||||||
RUN npm ci --omit=dev -w server \
|
COPY --from=runtime-deps /ms-playwright /ms-playwright
|
||||||
&& npx playwright install --only-shell chromium \
|
COPY --from=runtime-deps /app/node_modules ./node_modules
|
||||||
&& npm cache clean --force
|
|
||||||
|
|
||||||
COPY --from=server-build /app/server/dist ./dist
|
COPY --from=server-build /app/server/dist ./dist
|
||||||
COPY --from=client-build /app/client/dist ./client
|
COPY --from=client-build /app/client/dist ./client
|
||||||
|
|
||||||
|
# The project's license, and every shipped component's license notices (also
|
||||||
|
# served by the app at /licenses.txt)
|
||||||
|
COPY LICENSE ./
|
||||||
|
COPY --from=licenses /app/licenses.txt ./client/licenses.txt
|
||||||
|
|
||||||
# Serve the built client at / (see server/src/common/client-static.ts)
|
# Serve the built client at / (see server/src/common/client-static.ts)
|
||||||
ENV CLIENT_DIR=client
|
ENV CLIENT_DIR=client
|
||||||
|
|
||||||
# Runtime directories (keys and SQLite DB mounted via volumes)
|
# Runtime directory (SQLite DB and stored files, mounted as a volume)
|
||||||
RUN mkdir -p data
|
RUN mkdir -p data
|
||||||
|
|
||||||
EXPOSE 3000
|
EXPOSE 3000
|
||||||
|
|
||||||
CMD ["node", "dist/main"]
|
# Apply pending database migrations, then start the server (which refuses to
|
||||||
|
# start while migrations are pending)
|
||||||
|
CMD ["sh", "-c", "node dist/database/migrate && exec node dist/main"]
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 Andrii Arsenin
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -1,46 +1,63 @@
|
|||||||
# liquio-qa-bot
|
# liqa
|
||||||
|
|
||||||
A headless QA automation service for Liquio environments. Exposes an **MCP (Model Context Protocol)** server that lets AI agents define, run, and monitor multi-step browser test scenarios using [Playwright](https://playwright.dev/).
|
A browser automation and QA service for web applications. It stores multi-step browser scenarios, runs them with [Playwright](https://playwright.dev/) in headless Chromium, and keeps their results, logs and artifacts. Scenarios are managed from a web UI, a REST API, or an **MCP (Model Context Protocol)** server that lets AI agents define, run and debug them.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker compose up -d --build
|
||||||
|
```
|
||||||
|
|
||||||
|
No configuration is needed: every setting has a default. To override one, copy `.env.example` to `.env` and uncomment it.
|
||||||
|
|
||||||
|
Everything is served from one container at **http://localhost:13000**: the UI at `/`, the REST API at `/api/v1`, MCP at `/mcp`, Swagger at `/docs`. Data is kept in `./data/`.
|
||||||
|
|
||||||
|
To see it work, import and run the [self-test example](examples/self-test/): a scenario that tests liqa itself using an environment, a credential and snippets.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To install liqa from the published image, without cloning this repo:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://git.hq.ars9.space/ars9/liqa/raw/branch/master/scripts/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
This asks for an install directory, a port and a version (latest by default), then writes a `compose.yaml` and a `data/` directory there. Start it with `docker compose up -d` in that directory.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The bot manages four core concepts:
|
|
||||||
|
|
||||||
| Concept | Description |
|
| Concept | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| **Environment** | A named set of URLs for a deployment target (e.g. `liquio-diia-stg`) |
|
| **Scenario** | An ordered list of steps (async Playwright JS) that run in sequence in one browser. Versioned: every content change creates a new version |
|
||||||
| **Key** | A JSON descriptor in `keys/` that points to an EDS key file + password |
|
| **Run** | One execution of a scenario version in an environment, with per-step status and output, logs, and run files (downloads, failure screenshots, Playwright traces) |
|
||||||
| **Session** | Saved browser state (cookies + localStorage) produced by a login |
|
| **Snippet** | Reusable, versioned code called from steps with `context.runSnippet("alias")` (or `"alias@N"` for a specific version) |
|
||||||
| **Scenario** | An ordered list of steps that run in sequence against a shared browser instance |
|
| **Environment** | A named set of key/value settings for a deployment target (URLs etc.), read with `context.getEnv(key)` |
|
||||||
|
| **Credential** | Secret data (e.g. a key file and password), assigned to scenarios under an alias and read with `context.getCredential(alias)` |
|
||||||
|
| **Session** | Saved browser state (cookies + localStorage), e.g. kept from a run with "save session" |
|
||||||
|
|
||||||
|
Scenarios, snippets, environments and credentials can be exported as YAML and imported back (one file may hold several of them).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture
|
## Documentation
|
||||||
|
|
||||||
See [docs/architecture.md](docs/architecture.md).
|
- [docs/architecture.md](docs/architecture.md) - components, data model, client
|
||||||
|
- [docs/scenario.md](docs/scenario.md) - runs, the script `context` API, versioning, import/export, Playwright traces
|
||||||
|
- [docs/mcp.md](docs/mcp.md) - MCP tool reference
|
||||||
|
- [docs/development.md](docs/development.md) - setup, configuration, running, testing, linting, Docker
|
||||||
|
- [examples/](examples/) - ready-to-import example scenarios
|
||||||
|
- [CHANGELOG.md](CHANGELOG.md) - release notes
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Key descriptors
|
## License
|
||||||
|
|
||||||
See [docs/key-descriptors.md](docs/key-descriptors.md).
|
[MIT](LICENSE) © 2026 Andrii Arsenin
|
||||||
|
|
||||||
---
|
Third-party packages keep their own licenses. The Docker image includes all their notices, and the app serves them at `/licenses.txt` (linked as "Licenses" in the sidebar footer). See [docs/development.md](docs/development.md#licenses).
|
||||||
|
|
||||||
## MCP tools
|
|
||||||
|
|
||||||
See [docs/mcp.md](docs/mcp.md).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Scenario execution
|
|
||||||
|
|
||||||
See [docs/scenario.md](docs/scenario.md).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
See [docs/development.md](docs/development.md) for setup, running, testing, linting, and Docker instructions.
|
|
||||||
@@ -12,7 +12,7 @@ function getAbsolutePath(value: string) {
|
|||||||
return dirname(fileURLToPath(import.meta.resolve(`${value}/package.json`)));
|
return dirname(fileURLToPath(import.meta.resolve(`${value}/package.json`)));
|
||||||
}
|
}
|
||||||
const config: StorybookConfig = {
|
const config: StorybookConfig = {
|
||||||
stories: ['./stories/**/*.mdx', './stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
|
stories: ['./stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
|
||||||
addons: [
|
addons: [
|
||||||
getAbsolutePath('@storybook/addon-vitest'),
|
getAbsolutePath('@storybook/addon-vitest'),
|
||||||
getAbsolutePath('@storybook/addon-a11y'),
|
getAbsolutePath('@storybook/addon-a11y'),
|
||||||
|
|||||||
@@ -37,7 +37,8 @@ const preview: Preview = {
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
a11y: {
|
a11y: {
|
||||||
test: 'todo',
|
// Accessibility violations (e.g. color contrast) fail the story's test
|
||||||
|
test: 'error',
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -0,0 +1,25 @@
|
|||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, fn, userEvent, within } from 'storybook/test';
|
||||||
|
import { AutoRefreshIndicator } from '../../src/ui/AutoRefreshIndicator/AutoRefreshIndicator';
|
||||||
|
|
||||||
|
const meta: Meta<typeof AutoRefreshIndicator> = {
|
||||||
|
title: 'UI/AutoRefreshIndicator',
|
||||||
|
component: AutoRefreshIndicator,
|
||||||
|
parameters: { layout: 'centered' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
args: { onClick: fn() },
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof AutoRefreshIndicator>;
|
||||||
|
|
||||||
|
export const Active: Story = { args: { active: true, pulseKey: 1 } };
|
||||||
|
export const Idle: Story = { args: { active: false } };
|
||||||
|
export const Errored: Story = { args: { active: false, error: true } };
|
||||||
|
|
||||||
|
export const ClickToRefresh: Story = {
|
||||||
|
args: { active: false },
|
||||||
|
play: async ({ args, canvasElement }) => {
|
||||||
|
await userEvent.click(within(canvasElement).getByRole('button'));
|
||||||
|
await expect(args.onClick).toHaveBeenCalled();
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect } from 'storybook/test';
|
||||||
|
import { CodeBlock } from '../../src/ui/CodeBlock/CodeBlock';
|
||||||
|
|
||||||
|
const meta: Meta<typeof CodeBlock> = {
|
||||||
|
title: 'UI/CodeBlock',
|
||||||
|
component: CodeBlock,
|
||||||
|
parameters: { layout: 'padded' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof CodeBlock>;
|
||||||
|
|
||||||
|
export const JavaScript: Story = {
|
||||||
|
args: {
|
||||||
|
language: 'javascript',
|
||||||
|
code: "const url = context.getEnv('BASE_URL');\nawait context.page.goto(url);\nreturn await context.page.title();",
|
||||||
|
},
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
// Highlighting splits the code into many spans: check the whole text and
|
||||||
|
// that highlighting actually happened
|
||||||
|
const code = canvasElement.querySelector('code');
|
||||||
|
await expect(code).toHaveTextContent('await context.page.goto(url);');
|
||||||
|
await expect(code?.querySelector('.hljs-keyword')).not.toBeNull();
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Json: Story = {
|
||||||
|
args: {
|
||||||
|
language: 'json',
|
||||||
|
code: JSON.stringify({ status: 'pass', output: { title: 'Dashboard' } }, null, 2),
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
import React, { useState } from 'react';
|
||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { CodeEditor, type CodeEditorProps } from '../../src/ui/CodeEditor/CodeEditor';
|
||||||
|
|
||||||
|
// Monaco is loaded from a CDN at runtime, so these stories only check that the
|
||||||
|
// editor mounts; they have no interaction tests.
|
||||||
|
function ControlledEditor(
|
||||||
|
props: Omit<CodeEditorProps, 'value' | 'onChange'> & { initial: string },
|
||||||
|
) {
|
||||||
|
const { initial, ...rest } = props;
|
||||||
|
const [value, setValue] = useState(initial);
|
||||||
|
return <CodeEditor {...rest} value={value} onChange={setValue} />;
|
||||||
|
}
|
||||||
|
|
||||||
|
const meta: Meta<typeof ControlledEditor> = {
|
||||||
|
title: 'UI/CodeEditor',
|
||||||
|
component: ControlledEditor,
|
||||||
|
parameters: { layout: 'padded' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof ControlledEditor>;
|
||||||
|
|
||||||
|
export const JavaScript: Story = {
|
||||||
|
args: {
|
||||||
|
language: 'javascript',
|
||||||
|
rows: 8,
|
||||||
|
initial:
|
||||||
|
"await context.page.goto(context.getEnv('BASE_URL'));\nreturn await context.page.title();",
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const WithError: Story = {
|
||||||
|
args: { language: 'javascript', rows: 4, error: true, initial: 'await context.page.goto(' },
|
||||||
|
};
|
||||||
@@ -1,10 +1,16 @@
|
|||||||
import React from 'react';
|
import React, { useLayoutEffect, useRef, useState } from 'react';
|
||||||
import type { Meta, StoryObj } from '@storybook/react-vite';
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
|
||||||
const palette = [
|
const palette = [
|
||||||
{ name: 'Atlantis', token: '--color-primary', hex: '#9DD341', role: 'Primary / Action' },
|
{ name: 'Atlantis', token: '--color-primary', hex: '#9DD341', role: 'Primary / Action' },
|
||||||
|
{
|
||||||
|
name: 'Atlantis text',
|
||||||
|
token: '--color-primary-text',
|
||||||
|
hex: '#496904',
|
||||||
|
role: 'Primary as text / icon',
|
||||||
|
},
|
||||||
{ name: 'Outer Space', token: '--color-text', hex: '#2D3339', role: 'Text / Surface' },
|
{ name: 'Outer Space', token: '--color-text', hex: '#2D3339', role: 'Text / Surface' },
|
||||||
{ name: 'Kimberly', token: '--color-text-muted', hex: '#6650C0', role: 'Muted text / Info' },
|
{ name: 'Kimberly', token: '--color-text-muted', hex: '#634DBD', role: 'Muted text / Info' },
|
||||||
{ name: 'Powder Ash', token: '--color-border', hex: '#AFBFB9', role: 'Border / Neutral' },
|
{ name: 'Powder Ash', token: '--color-border', hex: '#AFBFB9', role: 'Border / Neutral' },
|
||||||
];
|
];
|
||||||
|
|
||||||
@@ -23,12 +29,23 @@ const semanticColors = [
|
|||||||
{ name: 'Running fg', token: '--color-running-fg', hex: '#6B4A00' },
|
{ name: 'Running fg', token: '--color-running-fg', hex: '#6B4A00' },
|
||||||
];
|
];
|
||||||
|
|
||||||
|
const syntaxColors = [
|
||||||
|
{ name: 'Comment', token: '--hl-comment', hex: '#4F6557' },
|
||||||
|
{ name: 'Keyword', token: '--hl-keyword', hex: '#764E99' },
|
||||||
|
{ name: 'String / title', token: '--hl-string', hex: '#4F6821' },
|
||||||
|
{ name: 'Number', token: '--hl-number', hex: '#895403' },
|
||||||
|
{ name: 'Function', token: '--hl-function', hex: '#056980' },
|
||||||
|
{ name: 'Variable / params', token: '--hl-variable', hex: '#815354' },
|
||||||
|
{ name: 'Property', token: '--hl-property', hex: '#1D6971' },
|
||||||
|
{ name: 'Meta', token: '--hl-meta', hex: '#615B7E' },
|
||||||
|
];
|
||||||
|
|
||||||
const surfaceColors = [
|
const surfaceColors = [
|
||||||
{ name: 'Background', token: '--color-bg', hex: '#E6EDEA' },
|
{ name: 'Background', token: '--color-bg', hex: '#E6EDEA' },
|
||||||
{ name: 'Background subtle', token: '--color-bg-subtle', hex: '#D8E2DE' },
|
{ name: 'Background subtle', token: '--color-bg-subtle', hex: '#D8E2DE' },
|
||||||
{ name: 'Secondary', token: '--color-secondary', hex: '#EDF1EF' },
|
{ name: 'Secondary', token: '--color-secondary', hex: '#EDF1EF' },
|
||||||
{ name: 'Secondary hover', token: '--color-secondary-hover', hex: '#DFE6E3' },
|
{ name: 'Secondary hover', token: '--color-secondary-hover', hex: '#DFE6E3' },
|
||||||
{ name: 'Danger', token: '--color-danger', hex: '#D94F4F' },
|
{ name: 'Danger', token: '--color-danger', hex: '#CE4546' },
|
||||||
{ name: 'Primary fg', token: '--color-primary-fg', hex: '#2D3339' },
|
{ name: 'Primary fg', token: '--color-primary-fg', hex: '#2D3339' },
|
||||||
];
|
];
|
||||||
|
|
||||||
@@ -43,8 +60,27 @@ function Swatch({
|
|||||||
hex: string;
|
hex: string;
|
||||||
role?: string;
|
role?: string;
|
||||||
}) {
|
}) {
|
||||||
|
// Show the token's current value (per theme) rather than a hard-coded copy
|
||||||
|
const ref = useRef<HTMLDivElement>(null);
|
||||||
|
const [value, setValue] = useState(hex);
|
||||||
|
useLayoutEffect(() => {
|
||||||
|
const read = () => {
|
||||||
|
if (!ref.current) return;
|
||||||
|
const resolved = getComputedStyle(ref.current).getPropertyValue(token).trim();
|
||||||
|
if (resolved) setValue(resolved.toUpperCase());
|
||||||
|
};
|
||||||
|
read();
|
||||||
|
// Re-read when the theme toolbar switches data-theme on <html>
|
||||||
|
const observer = new MutationObserver(read);
|
||||||
|
observer.observe(document.documentElement, {
|
||||||
|
attributes: true,
|
||||||
|
attributeFilter: ['data-theme'],
|
||||||
|
});
|
||||||
|
return () => observer.disconnect();
|
||||||
|
}, [token]);
|
||||||
return (
|
return (
|
||||||
<div
|
<div
|
||||||
|
ref={ref}
|
||||||
style={{
|
style={{
|
||||||
display: 'flex',
|
display: 'flex',
|
||||||
flexDirection: 'column',
|
flexDirection: 'column',
|
||||||
@@ -72,7 +108,7 @@ function Swatch({
|
|||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
<div style={{ fontSize: 11, fontFamily: 'monospace', color: 'var(--color-text-muted)' }}>
|
<div style={{ fontSize: 11, fontFamily: 'monospace', color: 'var(--color-text-muted)' }}>
|
||||||
{hex}
|
{value}
|
||||||
</div>
|
</div>
|
||||||
<div style={{ fontSize: 11, fontFamily: 'monospace', color: 'var(--color-text-muted)' }}>
|
<div style={{ fontSize: 11, fontFamily: 'monospace', color: 'var(--color-text-muted)' }}>
|
||||||
{token}
|
{token}
|
||||||
@@ -128,6 +164,11 @@ function ColorPalette() {
|
|||||||
<Swatch key={c.token} {...c} />
|
<Swatch key={c.token} {...c} />
|
||||||
))}
|
))}
|
||||||
</Section>
|
</Section>
|
||||||
|
<Section title="Syntax highlighting">
|
||||||
|
{syntaxColors.map((c) => (
|
||||||
|
<Swatch key={c.token} {...c} />
|
||||||
|
))}
|
||||||
|
</Section>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ export default meta;
|
|||||||
type Story = StoryObj<typeof ContextMenu>;
|
type Story = StoryObj<typeof ContextMenu>;
|
||||||
|
|
||||||
const trigger = (
|
const trigger = (
|
||||||
<Button variant="ghost" size="sm">
|
<Button variant="ghost" size="sm" aria-label="Actions">
|
||||||
<Settings size={16} />
|
<Settings size={16} />
|
||||||
</Button>
|
</Button>
|
||||||
);
|
);
|
||||||
|
|||||||
@@ -0,0 +1,330 @@
|
|||||||
|
import React, { useLayoutEffect, useRef, useState } from 'react';
|
||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { AutoRefreshIndicator } from '../../src/ui/AutoRefreshIndicator/AutoRefreshIndicator';
|
||||||
|
import { Button } from '../../src/ui/Button/Button';
|
||||||
|
import { CodeBlock } from '../../src/ui/CodeBlock/CodeBlock';
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Text contrast review page (WCAG AA: 4.5:1 for normal text, 3:1 for large
|
||||||
|
* text) for the components where contrast is easiest to get wrong: light
|
||||||
|
* brand colors used as text, dimmed labels, colored buttons and syntax
|
||||||
|
* highlighting. Every sample is the real component, shown in both themes, and
|
||||||
|
* the contrast of each piece of text is measured live from the rendered
|
||||||
|
* colors - so this page stays accurate as the design tokens change.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// ── Contrast measurement ─────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
type Rgba = [number, number, number, number];
|
||||||
|
|
||||||
|
function parseColor(value: string): Rgba {
|
||||||
|
const parts = value.match(/[\d.]+/g)?.map(Number) ?? [0, 0, 0];
|
||||||
|
return [parts[0], parts[1], parts[2], parts[3] ?? 1];
|
||||||
|
}
|
||||||
|
|
||||||
|
function luminance([r, g, b]: Rgba): number {
|
||||||
|
const channel = (c: number) => {
|
||||||
|
const s = c / 255;
|
||||||
|
return s <= 0.03928 ? s / 12.92 : ((s + 0.055) / 1.055) ** 2.4;
|
||||||
|
};
|
||||||
|
return 0.2126 * channel(r) + 0.7152 * channel(g) + 0.0722 * channel(b);
|
||||||
|
}
|
||||||
|
|
||||||
|
function contrast(a: Rgba, b: Rgba): number {
|
||||||
|
const [hi, lo] = [luminance(a), luminance(b)].sort((x, y) => y - x);
|
||||||
|
return (hi + 0.05) / (lo + 0.05);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Blends `top` over an opaque `bottom`. */
|
||||||
|
function blend(top: Rgba, bottom: Rgba): Rgba {
|
||||||
|
const a = top[3];
|
||||||
|
return [0, 1, 2].map((i) => top[i] * a + bottom[i] * (1 - a)).concat(1) as Rgba;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Product of the `opacity` of `el` and its ancestors (e.g. a dimmed idle label). */
|
||||||
|
function opacityChain(el: Element): number {
|
||||||
|
let opacity = 1;
|
||||||
|
for (let node: Element | null = el; node; node = node.parentElement) {
|
||||||
|
opacity *= parseFloat(getComputedStyle(node).opacity);
|
||||||
|
}
|
||||||
|
return opacity;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The opaque color behind `el`, from its own and its ancestors' backgrounds. */
|
||||||
|
function effectiveBackground(el: Element): Rgba {
|
||||||
|
const layers: Rgba[] = [];
|
||||||
|
for (let node: Element | null = el; node; node = node.parentElement) {
|
||||||
|
const bg = parseColor(getComputedStyle(node).backgroundColor);
|
||||||
|
bg[3] *= opacityChain(node);
|
||||||
|
if (bg[3] > 0) layers.push(bg);
|
||||||
|
if (bg[3] >= 1) break;
|
||||||
|
}
|
||||||
|
return layers.reduceRight<Rgba>((under, layer) => blend(layer, under), [255, 255, 255, 1]);
|
||||||
|
}
|
||||||
|
|
||||||
|
const hex = ([r, g, b]: Rgba) =>
|
||||||
|
'#' + [r, g, b].map((c) => Math.round(c).toString(16).padStart(2, '0')).join('');
|
||||||
|
|
||||||
|
interface Measurement {
|
||||||
|
text: string;
|
||||||
|
fg: string;
|
||||||
|
bg: string;
|
||||||
|
ratio: number;
|
||||||
|
required: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Measures every element that directly contains visible text. */
|
||||||
|
function measure(root: HTMLElement): Measurement[] {
|
||||||
|
const seen = new Set<string>();
|
||||||
|
const results: Measurement[] = [];
|
||||||
|
for (const el of Array.from(root.querySelectorAll<HTMLElement>('*'))) {
|
||||||
|
const text = Array.from(el.childNodes)
|
||||||
|
.filter((n) => n.nodeType === Node.TEXT_NODE)
|
||||||
|
.map((n) => n.textContent ?? '')
|
||||||
|
.join('')
|
||||||
|
.trim();
|
||||||
|
if (!text || el.closest('[aria-hidden="true"]')) continue;
|
||||||
|
const style = getComputedStyle(el);
|
||||||
|
const fontSize = parseFloat(style.fontSize);
|
||||||
|
const bold = Number(style.fontWeight) >= 700;
|
||||||
|
// WCAG "large text": at least 24px, or 18.66px bold
|
||||||
|
const required = fontSize >= 24 || (bold && fontSize >= 18.66) ? 3 : 4.5;
|
||||||
|
const bgColor = effectiveBackground(el);
|
||||||
|
const fg = parseColor(style.color);
|
||||||
|
fg[3] *= opacityChain(el);
|
||||||
|
const fgColor = blend(fg, bgColor);
|
||||||
|
const key = `${hex(fgColor)}|${hex(bgColor)}|${required}`;
|
||||||
|
if (seen.has(key)) continue;
|
||||||
|
seen.add(key);
|
||||||
|
results.push({
|
||||||
|
text: text.length > 28 ? `${text.slice(0, 28)}…` : text,
|
||||||
|
fg: hex(fgColor),
|
||||||
|
bg: hex(bgColor),
|
||||||
|
ratio: contrast(fgColor, bgColor),
|
||||||
|
required,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return results.sort((a, b) => a.ratio / a.required - b.ratio / b.required);
|
||||||
|
}
|
||||||
|
|
||||||
|
function Readout({ items }: { items: Measurement[] }) {
|
||||||
|
return (
|
||||||
|
<table style={{ width: '100%', borderCollapse: 'collapse', fontSize: 12, marginTop: 8 }}>
|
||||||
|
<tbody>
|
||||||
|
{items.map((m) => {
|
||||||
|
const pass = m.ratio >= m.required;
|
||||||
|
return (
|
||||||
|
<tr
|
||||||
|
key={`${m.fg}${m.bg}${m.required}`}
|
||||||
|
style={{ borderTop: '1px solid var(--color-border)' }}
|
||||||
|
>
|
||||||
|
<td style={{ padding: '4px 6px' }}>
|
||||||
|
<span
|
||||||
|
style={{
|
||||||
|
display: 'inline-block',
|
||||||
|
padding: '1px 6px',
|
||||||
|
borderRadius: 3,
|
||||||
|
background: m.bg,
|
||||||
|
color: m.fg,
|
||||||
|
fontFamily: 'monospace',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{m.text}
|
||||||
|
</span>
|
||||||
|
</td>
|
||||||
|
<td
|
||||||
|
style={{
|
||||||
|
padding: '4px 6px',
|
||||||
|
fontFamily: 'monospace',
|
||||||
|
color: 'var(--color-text-muted)',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{m.fg} on {m.bg}
|
||||||
|
</td>
|
||||||
|
<td
|
||||||
|
style={{
|
||||||
|
padding: '4px 6px',
|
||||||
|
textAlign: 'right',
|
||||||
|
fontWeight: 700,
|
||||||
|
whiteSpace: 'nowrap',
|
||||||
|
color: pass ? 'var(--color-text)' : 'var(--color-danger)',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{m.ratio.toFixed(2)}:1 {pass ? '✓' : `✗ needs ${m.required}:1`}
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Renders a sample and measures its text contrast after layout. */
|
||||||
|
function Sample({ children }: { children: React.ReactNode }) {
|
||||||
|
const ref = useRef<HTMLDivElement>(null);
|
||||||
|
const [items, setItems] = useState<Measurement[]>([]);
|
||||||
|
useLayoutEffect(() => {
|
||||||
|
const el = ref.current;
|
||||||
|
if (!el) return;
|
||||||
|
// Measure after the theme/styles have applied
|
||||||
|
const frame = requestAnimationFrame(() => setItems(measure(el)));
|
||||||
|
return () => cancelAnimationFrame(frame);
|
||||||
|
}, []);
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<div ref={ref}>{children}</div>
|
||||||
|
<Readout items={items} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Page ─────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
// Covers every syntax color: comment, keyword, string, number, function
|
||||||
|
// (title), params, property
|
||||||
|
const JS_CODE = [
|
||||||
|
'// Open the app and wait for the dashboard',
|
||||||
|
'async function openDashboard(context, timeoutMs) {',
|
||||||
|
" const url = context.getEnv('BASE_URL');",
|
||||||
|
' await context.page.goto(url, { timeout: timeoutMs ?? 30000 });',
|
||||||
|
' return context.page.title();',
|
||||||
|
'}',
|
||||||
|
].join('\n');
|
||||||
|
const JSON_CODE = JSON.stringify(
|
||||||
|
{ status: 'pass', attempts: 2, cached: false, output: { title: 'Dashboard' } },
|
||||||
|
null,
|
||||||
|
2,
|
||||||
|
);
|
||||||
|
|
||||||
|
interface Issue {
|
||||||
|
title: string;
|
||||||
|
note: string;
|
||||||
|
render: () => React.ReactNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
const ISSUES: Issue[] = [
|
||||||
|
{
|
||||||
|
title: 'AutoRefreshIndicator label',
|
||||||
|
note: 'Active ("Live", --color-primary-text), idle and error labels (runs pages).',
|
||||||
|
render: () => (
|
||||||
|
<div style={{ display: 'flex', gap: 12, flexWrap: 'wrap' }}>
|
||||||
|
<AutoRefreshIndicator active pulseKey={1} />
|
||||||
|
<AutoRefreshIndicator active={false} />
|
||||||
|
<AutoRefreshIndicator active={false} error />
|
||||||
|
</div>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Danger button',
|
||||||
|
note: 'Danger, primary and secondary buttons (text on colored backgrounds).',
|
||||||
|
render: () => (
|
||||||
|
<div style={{ display: 'flex', gap: 8, flexWrap: 'wrap' }}>
|
||||||
|
<Button variant="danger">Delete</Button>
|
||||||
|
<Button variant="danger" size="sm">
|
||||||
|
Delete
|
||||||
|
</Button>
|
||||||
|
<Button variant="primary">Run</Button>
|
||||||
|
<Button variant="secondary">Cancel</Button>
|
||||||
|
</div>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Code highlighting - JavaScript',
|
||||||
|
note: 'All --hl-* syntax colors on the page background (step code, snippets).',
|
||||||
|
render: () => <CodeBlock language="javascript" code={JS_CODE} />,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Code highlighting - JSON',
|
||||||
|
note: 'Keys, strings, numbers and literals in JSON step outputs.',
|
||||||
|
render: () => <CodeBlock language="json" code={JSON_CODE} />,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: 'Muted text',
|
||||||
|
note: '--color-text-muted on both background shades (hints, table headers, descriptions).',
|
||||||
|
render: () => (
|
||||||
|
<div style={{ display: 'flex', gap: 8 }}>
|
||||||
|
{['var(--color-bg)', 'var(--color-bg-subtle)'].map((bg) => (
|
||||||
|
<span
|
||||||
|
key={bg}
|
||||||
|
style={{
|
||||||
|
background: bg,
|
||||||
|
color: 'var(--color-text-muted)',
|
||||||
|
padding: '4px 8px',
|
||||||
|
fontSize: 13,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
Last run 2 minutes ago
|
||||||
|
</span>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
function Panel({ theme }: { theme: 'light' | 'dark' }) {
|
||||||
|
return (
|
||||||
|
<section
|
||||||
|
// The dark tokens apply under [data-theme="dark"]; light is the page default
|
||||||
|
data-theme={theme === 'dark' ? 'dark' : undefined}
|
||||||
|
style={{
|
||||||
|
flex: '1 1 420px',
|
||||||
|
minWidth: 0,
|
||||||
|
padding: 16,
|
||||||
|
borderRadius: 8,
|
||||||
|
background: 'var(--color-bg)',
|
||||||
|
color: 'var(--color-text)',
|
||||||
|
border: '1px solid var(--color-border)',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<h2 style={{ margin: '0 0 12px', fontSize: 16 }}>
|
||||||
|
{theme === 'dark' ? 'Dark theme' : 'Light theme'}
|
||||||
|
</h2>
|
||||||
|
{ISSUES.map((issue) => (
|
||||||
|
<div key={issue.title} style={{ marginBottom: 24 }}>
|
||||||
|
<h3 style={{ margin: '0 0 2px', fontSize: 14 }}>{issue.title}</h3>
|
||||||
|
<p style={{ margin: '0 0 8px', fontSize: 12, color: 'var(--color-text-muted)' }}>
|
||||||
|
{issue.note}
|
||||||
|
</p>
|
||||||
|
<Sample>{issue.render()}</Sample>
|
||||||
|
</div>
|
||||||
|
))}
|
||||||
|
</section>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ContrastPage() {
|
||||||
|
return (
|
||||||
|
<div style={{ padding: 16 }}>
|
||||||
|
<p
|
||||||
|
style={{
|
||||||
|
margin: '0 0 16px',
|
||||||
|
fontSize: 13,
|
||||||
|
color: 'var(--color-text-muted)',
|
||||||
|
maxWidth: 820,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
Text contrast of the components where it's easiest to get wrong (WCAG AA: 4.5:1 for normal
|
||||||
|
text, 3:1 for large text). Each row is a piece of text in the sample, measured from its
|
||||||
|
rendered colors, worst first.
|
||||||
|
</p>
|
||||||
|
<div style={{ display: 'flex', gap: 16, flexWrap: 'wrap', alignItems: 'flex-start' }}>
|
||||||
|
<Panel theme="light" />
|
||||||
|
<Panel theme="dark" />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const meta: Meta<typeof ContrastPage> = {
|
||||||
|
title: 'Accessibility/Contrast',
|
||||||
|
component: ContrastPage,
|
||||||
|
// a11y checks use the project default ('error' in preview.tsx)
|
||||||
|
parameters: { layout: 'fullscreen' },
|
||||||
|
// The light panel relies on the page default (light) theme
|
||||||
|
globals: { theme: 'light' },
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof ContrastPage>;
|
||||||
|
|
||||||
|
export const Overview: Story = {};
|
||||||
@@ -15,7 +15,7 @@ const meta: Meta<typeof DescriptionList> = {
|
|||||||
),
|
),
|
||||||
],
|
],
|
||||||
argTypes: {
|
argTypes: {
|
||||||
layout: { control: 'select', options: ['inline', 'compact'] },
|
layout: { control: 'select', options: ['inline', 'compact', 'comfortable', 'grid'] },
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -35,6 +35,14 @@ export const Compact: Story = {
|
|||||||
args: { items: urlItems, layout: 'compact' },
|
args: { items: urlItems, layout: 'compact' },
|
||||||
};
|
};
|
||||||
|
|
||||||
|
export const Comfortable: Story = {
|
||||||
|
args: { items: urlItems, layout: 'comfortable' },
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Grid: Story = {
|
||||||
|
args: { items: urlItems, layout: 'grid' },
|
||||||
|
};
|
||||||
|
|
||||||
export const WithLinks: Story = {
|
export const WithLinks: Story = {
|
||||||
args: {
|
args: {
|
||||||
layout: 'inline',
|
layout: 'inline',
|
||||||
|
|||||||
@@ -0,0 +1,197 @@
|
|||||||
|
import { useState } from 'react';
|
||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, userEvent, within } from 'storybook/test';
|
||||||
|
import { LogOutput, type LogOutputEntry } from '../../src/ui/LogOutput/LogOutput';
|
||||||
|
import { formatLogText } from '../../src/ui/LogOutput/logText';
|
||||||
|
|
||||||
|
const meta: Meta<typeof LogOutput> = {
|
||||||
|
title: 'UI/LogOutput',
|
||||||
|
component: LogOutput,
|
||||||
|
tags: ['autodocs'],
|
||||||
|
parameters: { layout: 'padded' },
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
|
||||||
|
type Story = StoryObj<typeof LogOutput>;
|
||||||
|
|
||||||
|
const secondsAgo = (n: number) => new Date(Date.now() - n * 1000).toISOString();
|
||||||
|
|
||||||
|
export const Default: Story = {
|
||||||
|
args: {
|
||||||
|
startTime: secondsAgo(60),
|
||||||
|
entries: [
|
||||||
|
{
|
||||||
|
id: 0,
|
||||||
|
level: 'debug',
|
||||||
|
context: 'step:1',
|
||||||
|
message: 'Resolved credential alias "sdJwtKey" to a file credential',
|
||||||
|
createdAt: secondsAgo(61),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 1,
|
||||||
|
level: 'log',
|
||||||
|
context: 'step:1',
|
||||||
|
message: 'Step 1 started: Login with PKCS',
|
||||||
|
createdAt: secondsAgo(60),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 2,
|
||||||
|
level: 'log',
|
||||||
|
context: 'snippet:loginWithPkcs',
|
||||||
|
message: 'Snippet "loginWithPkcs" started',
|
||||||
|
createdAt: secondsAgo(58),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 3,
|
||||||
|
level: 'log',
|
||||||
|
context: 'snippet:loginWithPkcs',
|
||||||
|
message: 'Saved credential as run file:',
|
||||||
|
data: JSON.stringify({
|
||||||
|
id: '181d8ae2-4aee-4f33-a657-210efe7fe668',
|
||||||
|
name: 'credential.sd-jwt',
|
||||||
|
mimeType: 'application/octet-stream',
|
||||||
|
size: 1657,
|
||||||
|
sha256: '9c4226999c700a39bda30279907e4479a5b3920ccde5c75771ea0e264c638c0',
|
||||||
|
path: 'data/files/18/181d/181d8ae2-4aee-4f33-a657-210efe7fe668',
|
||||||
|
}),
|
||||||
|
createdAt: secondsAgo(57),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 4,
|
||||||
|
level: 'log',
|
||||||
|
context: 'snippet:loginWithPkcs',
|
||||||
|
message: 'Navigating to ID login: https://id.example.com',
|
||||||
|
createdAt: secondsAgo(57),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 5,
|
||||||
|
level: 'log',
|
||||||
|
context: 'assertion:pass',
|
||||||
|
message: 'Assertion passed: page must have redirected to cabinet URL',
|
||||||
|
createdAt: secondsAgo(40),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 6,
|
||||||
|
level: 'warn',
|
||||||
|
context: 'snippet:loginWithPkcs',
|
||||||
|
message: 'Retrying file upload after a transient error',
|
||||||
|
createdAt: secondsAgo(39),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 7,
|
||||||
|
level: 'log',
|
||||||
|
context: 'step:1',
|
||||||
|
message: 'Step 1 passed',
|
||||||
|
createdAt: secondsAgo(30),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 8,
|
||||||
|
level: 'error',
|
||||||
|
context: 'assertion:fail',
|
||||||
|
message: 'Assertion failed: Document validation must pass (got 422)',
|
||||||
|
createdAt: secondsAgo(10),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 9,
|
||||||
|
level: 'error',
|
||||||
|
context: 'step:2',
|
||||||
|
message: 'Step 2 failed: Document validation must pass (got 422)',
|
||||||
|
createdAt: secondsAgo(9),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Scrollable: Story = {
|
||||||
|
args: {
|
||||||
|
maxHeight: 160,
|
||||||
|
startTime: secondsAgo(60),
|
||||||
|
entries: Array.from({ length: 30 }, (_, i) => ({
|
||||||
|
id: i,
|
||||||
|
level: (['log', 'log', 'log', 'warn', 'error'] as const)[i % 5],
|
||||||
|
context: `step:${Math.floor(i / 6) + 1}`,
|
||||||
|
message: `Log entry ${i + 1}`,
|
||||||
|
createdAt: secondsAgo(60 - i * 2),
|
||||||
|
})),
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const largeDataEntries: LogOutputEntry[] = [
|
||||||
|
{
|
||||||
|
id: 0,
|
||||||
|
level: 'log',
|
||||||
|
context: 'step:1',
|
||||||
|
message: 'Small payload:',
|
||||||
|
data: JSON.stringify({ status: 200 }),
|
||||||
|
createdAt: secondsAgo(20),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 1,
|
||||||
|
level: 'log',
|
||||||
|
context: 'step:1',
|
||||||
|
message: 'Large payload:',
|
||||||
|
data: JSON.stringify({
|
||||||
|
user: { id: 42, name: 'Jane Doe', roles: ['admin', 'qa'] },
|
||||||
|
token: 'eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiI0MiJ9',
|
||||||
|
}),
|
||||||
|
createdAt: secondsAgo(18),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
id: 2,
|
||||||
|
level: 'warn',
|
||||||
|
context: 'step:2',
|
||||||
|
message: 'Another large payload:',
|
||||||
|
data: JSON.stringify(Array.from({ length: 8 }, (_, i) => ({ row: i }))),
|
||||||
|
createdAt: secondsAgo(10),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
function LargeDataLog() {
|
||||||
|
const [expanded, setExpanded] = useState(false);
|
||||||
|
return (
|
||||||
|
<div style={{ display: 'flex', flexDirection: 'column', gap: 8, alignItems: 'flex-start' }}>
|
||||||
|
<button type="button" onClick={() => setExpanded((v) => !v)}>
|
||||||
|
{expanded ? 'Collapse all' : 'Expand all'}
|
||||||
|
</button>
|
||||||
|
<LogOutput startTime={secondsAgo(20)} entries={largeDataEntries} dataExpanded={expanded} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Data blocks over the default limits (256 bytes, 5 lines) start collapsed. */
|
||||||
|
export const LargeData: Story = {
|
||||||
|
render: () => <LargeDataLog />,
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
// Data blocks are syntax-highlighted into separate tokens, so check the log's text
|
||||||
|
const log = canvas.getByRole('log');
|
||||||
|
// Only the small payload is visible initially
|
||||||
|
await expect(log).toHaveTextContent('"status": 200');
|
||||||
|
await expect(log).not.toHaveTextContent('Jane Doe');
|
||||||
|
const toggles = canvas.getAllByRole('button', { name: /^Show data/ });
|
||||||
|
await expect(toggles).toHaveLength(2);
|
||||||
|
|
||||||
|
await userEvent.click(toggles[0]);
|
||||||
|
await expect(log).toHaveTextContent('Jane Doe');
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Hide data' }));
|
||||||
|
await expect(log).not.toHaveTextContent('Jane Doe');
|
||||||
|
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Expand all' }));
|
||||||
|
await expect(log).toHaveTextContent('Jane Doe');
|
||||||
|
await expect(canvas.getAllByRole('button', { name: 'Hide data' })).toHaveLength(2);
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Collapse all' }));
|
||||||
|
await expect(log).not.toHaveTextContent('Jane Doe');
|
||||||
|
|
||||||
|
// The plain-text form always includes every data block
|
||||||
|
const text = formatLogText(largeDataEntries, largeDataEntries[0].createdAt);
|
||||||
|
await expect(text).toContain('[step:1] Large payload:\n {');
|
||||||
|
await expect(text).toContain('"name": "Jane Doe"');
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Empty: Story = {
|
||||||
|
args: {
|
||||||
|
entries: [],
|
||||||
|
emptyMessage: 'No logs yet.',
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, within } from 'storybook/test';
|
||||||
|
import { MarkdownContent } from '../../src/ui/MarkdownContent/MarkdownContent';
|
||||||
|
|
||||||
|
const meta: Meta<typeof MarkdownContent> = {
|
||||||
|
title: 'UI/MarkdownContent',
|
||||||
|
component: MarkdownContent,
|
||||||
|
parameters: { layout: 'padded' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof MarkdownContent>;
|
||||||
|
|
||||||
|
export const Description: Story = {
|
||||||
|
args: {
|
||||||
|
content: [
|
||||||
|
'## Login flow',
|
||||||
|
'',
|
||||||
|
'Logs in with the **test user** and checks the dashboard.',
|
||||||
|
'',
|
||||||
|
'- Uses the `BASE_URL` environment value',
|
||||||
|
'- Needs the `user` credential alias',
|
||||||
|
'',
|
||||||
|
'```js',
|
||||||
|
"await context.page.goto(context.getEnv('BASE_URL'));",
|
||||||
|
'```',
|
||||||
|
].join('\n'),
|
||||||
|
},
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
await expect(canvas.getByRole('heading', { name: 'Login flow' })).toBeInTheDocument();
|
||||||
|
await expect(canvas.getByText('test user').tagName).toBe('STRONG');
|
||||||
|
await expect(canvas.getAllByRole('listitem')).toHaveLength(2);
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
import React, { useState } from 'react';
|
||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, userEvent, within } from 'storybook/test';
|
||||||
|
import { Modal } from '../../src/ui/Modal/Modal';
|
||||||
|
import { Button } from '../../src/ui/Button/Button';
|
||||||
|
|
||||||
|
function ModalDemo({
|
||||||
|
title,
|
||||||
|
body,
|
||||||
|
size,
|
||||||
|
}: {
|
||||||
|
title: string;
|
||||||
|
body: React.ReactNode;
|
||||||
|
size?: 'md' | 'lg';
|
||||||
|
}) {
|
||||||
|
const [open, setOpen] = useState(false);
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<Button onClick={() => setOpen(true)}>Open modal</Button>
|
||||||
|
<Modal
|
||||||
|
open={open}
|
||||||
|
size={size}
|
||||||
|
title={title}
|
||||||
|
onClose={() => setOpen(false)}
|
||||||
|
footer={
|
||||||
|
<>
|
||||||
|
<Button variant="secondary" onClick={() => setOpen(false)}>
|
||||||
|
Cancel
|
||||||
|
</Button>
|
||||||
|
<Button onClick={() => setOpen(false)}>Confirm</Button>
|
||||||
|
</>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
{body}
|
||||||
|
</Modal>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const meta: Meta<typeof ModalDemo> = {
|
||||||
|
title: 'UI/Modal',
|
||||||
|
component: ModalDemo,
|
||||||
|
parameters: { layout: 'centered' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
args: { title: 'Delete scenario', body: 'This deletes the scenario, its versions and its runs.' },
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof ModalDemo>;
|
||||||
|
|
||||||
|
export const Default: Story = {
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Open modal' }));
|
||||||
|
const dialog = canvas.getByRole('dialog', { name: 'Delete scenario' });
|
||||||
|
await expect(dialog).toHaveTextContent('its versions and its runs');
|
||||||
|
await userEvent.click(within(dialog).getByRole('button', { name: 'Cancel' }));
|
||||||
|
await expect(canvas.queryByRole('dialog')).not.toBeInTheDocument();
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const ClosesOnEscapeAndBackdrop: Story = {
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Open modal' }));
|
||||||
|
await userEvent.keyboard('{Escape}');
|
||||||
|
await expect(canvas.queryByRole('dialog')).not.toBeInTheDocument();
|
||||||
|
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Open modal' }));
|
||||||
|
await userEvent.click(canvas.getByRole('presentation'));
|
||||||
|
await expect(canvas.queryByRole('dialog')).not.toBeInTheDocument();
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
export const Large: Story = {
|
||||||
|
args: {
|
||||||
|
title: 'Code reference',
|
||||||
|
size: 'lg',
|
||||||
|
body: (
|
||||||
|
<>
|
||||||
|
{Array.from({ length: 60 }, (_, i) => (
|
||||||
|
<p key={i}>Paragraph {i + 1} of a long, document-like modal body.</p>
|
||||||
|
))}
|
||||||
|
</>
|
||||||
|
),
|
||||||
|
},
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Open modal' }));
|
||||||
|
const dialog = canvas.getByRole('dialog', { name: 'Code reference' });
|
||||||
|
// The dialog stays within the viewport; its body scrolls instead.
|
||||||
|
await expect(dialog.getBoundingClientRect().height).toBeLessThanOrEqual(window.innerHeight);
|
||||||
|
const body = within(dialog).getByText(
|
||||||
|
'Paragraph 1 of a long, document-like modal body.',
|
||||||
|
).parentElement!;
|
||||||
|
await expect(body.scrollHeight).toBeGreaterThan(body.clientHeight);
|
||||||
|
await expect(within(dialog).getByRole('button', { name: 'Confirm' })).toBeVisible();
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { Notification } from '../../src/ui/Notification/Notification';
|
||||||
|
|
||||||
|
const meta: Meta<typeof Notification> = {
|
||||||
|
title: 'UI/Notification',
|
||||||
|
component: Notification,
|
||||||
|
parameters: { layout: 'padded' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
argTypes: {
|
||||||
|
variant: { control: 'select', options: ['info', 'success', 'error', 'warning', 'note'] },
|
||||||
|
},
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof Notification>;
|
||||||
|
|
||||||
|
export const Info: Story = {
|
||||||
|
args: {
|
||||||
|
variant: 'info',
|
||||||
|
title: 'Traces are off',
|
||||||
|
children: 'Enable them per run in the run modal.',
|
||||||
|
},
|
||||||
|
};
|
||||||
|
export const Success: Story = { args: { variant: 'success', children: 'Scenario imported.' } };
|
||||||
|
export const Error: Story = {
|
||||||
|
args: { variant: 'error', title: 'Run failed', children: 'Step 2 timed out after 60s.' },
|
||||||
|
};
|
||||||
|
export const Warning: Story = {
|
||||||
|
args: { variant: 'warning', children: 'The environment of this run no longer exists.' },
|
||||||
|
};
|
||||||
|
export const Note: Story = { args: { variant: 'note', children: 'Pinned snippet version: v3.' } };
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, userEvent, within } from 'storybook/test';
|
||||||
|
import { RevealableCodeBlock } from '../../src/ui/RevealableCodeBlock/RevealableCodeBlock';
|
||||||
|
|
||||||
|
const meta: Meta<typeof RevealableCodeBlock> = {
|
||||||
|
title: 'UI/RevealableCodeBlock',
|
||||||
|
component: RevealableCodeBlock,
|
||||||
|
parameters: { layout: 'padded' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof RevealableCodeBlock>;
|
||||||
|
|
||||||
|
export const Default: Story = {
|
||||||
|
args: {
|
||||||
|
language: 'json',
|
||||||
|
code: JSON.stringify({ username: 'admin', password: 's3cr3t-p4ss' }, null, 2),
|
||||||
|
},
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
// The code is not rendered until revealed, and hidden again on the second click
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
const toggle = canvas.getByRole('button');
|
||||||
|
await expect(canvasElement).not.toHaveTextContent('s3cr3t-p4ss');
|
||||||
|
await expect(toggle).toHaveAttribute('aria-expanded', 'false');
|
||||||
|
|
||||||
|
await userEvent.click(toggle);
|
||||||
|
await expect(canvasElement.querySelector('code')).toHaveTextContent('s3cr3t-p4ss');
|
||||||
|
await expect(toggle).toHaveAttribute('aria-expanded', 'true');
|
||||||
|
|
||||||
|
await userEvent.click(toggle);
|
||||||
|
await expect(canvasElement).not.toHaveTextContent('s3cr3t-p4ss');
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
import React, { useState } from 'react';
|
||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, userEvent, within } from 'storybook/test';
|
||||||
|
import { Search } from '../../src/ui/Search/Search';
|
||||||
|
|
||||||
|
function ControlledSearch({ placeholder }: { placeholder?: string }) {
|
||||||
|
const [value, setValue] = useState('');
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
<Search value={value} onChange={setValue} placeholder={placeholder} />
|
||||||
|
<p data-testid="query">{value}</p>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const meta: Meta<typeof ControlledSearch> = {
|
||||||
|
title: 'UI/Search',
|
||||||
|
component: ControlledSearch,
|
||||||
|
parameters: { layout: 'centered' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof ControlledSearch>;
|
||||||
|
|
||||||
|
export const Default: Story = {};
|
||||||
|
|
||||||
|
export const Typing: Story = {
|
||||||
|
args: { placeholder: 'Filter logs…' },
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
await userEvent.type(canvas.getByPlaceholderText('Filter logs…'), 'timeout');
|
||||||
|
await expect(canvas.getByTestId('query')).toHaveTextContent('timeout');
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, within } from 'storybook/test';
|
||||||
|
import { Textarea } from '../../src/ui/Textarea/Textarea';
|
||||||
|
|
||||||
|
const meta: Meta<typeof Textarea> = {
|
||||||
|
title: 'UI/Textarea',
|
||||||
|
component: Textarea,
|
||||||
|
parameters: { layout: 'centered' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
decorators: [
|
||||||
|
(Story) => (
|
||||||
|
<div style={{ width: 360 }}>
|
||||||
|
<Story />
|
||||||
|
</div>
|
||||||
|
),
|
||||||
|
],
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof Textarea>;
|
||||||
|
|
||||||
|
export const Default: Story = {
|
||||||
|
args: { label: 'Description', placeholder: 'Describe this scenario', rows: 4 },
|
||||||
|
};
|
||||||
|
|
||||||
|
export const WithHint: Story = {
|
||||||
|
args: { label: 'Description', hint: 'Markdown is supported.', rows: 4 },
|
||||||
|
};
|
||||||
|
|
||||||
|
export const WithError: Story = {
|
||||||
|
args: { label: 'Description', error: 'Description is too long.', rows: 4 },
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
const textarea = canvas.getByLabelText('Description');
|
||||||
|
await expect(textarea).toHaveAttribute('aria-invalid', 'true');
|
||||||
|
await expect(canvas.getByRole('alert')).toHaveTextContent('Description is too long.');
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
import React from 'react';
|
||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { expect, userEvent, within } from 'storybook/test';
|
||||||
|
import { ToastProvider } from '../../src/ui/Toast/ToastProvider';
|
||||||
|
import { useToast } from '../../src/ui/Toast/useToast';
|
||||||
|
import { Button } from '../../src/ui/Button/Button';
|
||||||
|
|
||||||
|
function ToastButtons() {
|
||||||
|
const toast = useToast();
|
||||||
|
return (
|
||||||
|
<div style={{ display: 'flex', gap: 8 }}>
|
||||||
|
<Button onClick={() => toast.success('Scenario run started')}>Success</Button>
|
||||||
|
<Button variant="danger" onClick={() => toast.error('Environment not found')}>
|
||||||
|
Error
|
||||||
|
</Button>
|
||||||
|
<Button variant="secondary" onClick={() => toast.info('Traces are off')}>
|
||||||
|
Info
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const meta: Meta<typeof ToastProvider> = {
|
||||||
|
title: 'UI/Toast',
|
||||||
|
component: ToastProvider,
|
||||||
|
parameters: { layout: 'centered' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
args: { durationMs: 3500, children: <ToastButtons /> },
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof ToastProvider>;
|
||||||
|
|
||||||
|
export const Default: Story = {};
|
||||||
|
|
||||||
|
export const ShowsToast: Story = {
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
await userEvent.click(canvas.getByRole('button', { name: 'Success' }));
|
||||||
|
await expect(await within(document.body).findByText('Scenario run started')).toBeVisible();
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||||
|
import { useState } from 'react';
|
||||||
|
import { expect, within } from 'storybook/test';
|
||||||
|
import { Button } from '../../src/ui/Button/Button';
|
||||||
|
import { UuidBadge } from '../../src/ui/UuidBadge/UuidBadge';
|
||||||
|
|
||||||
|
const meta: Meta<typeof UuidBadge> = {
|
||||||
|
title: 'UI/UuidBadge',
|
||||||
|
component: UuidBadge,
|
||||||
|
parameters: { layout: 'centered' },
|
||||||
|
tags: ['autodocs'],
|
||||||
|
};
|
||||||
|
export default meta;
|
||||||
|
type Story = StoryObj<typeof UuidBadge>;
|
||||||
|
|
||||||
|
export const Default: Story = {
|
||||||
|
args: { id: '61d2b1c2-7664-4dca-974f-436c2ee90b2e' },
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
// Shows a shortened id and keeps the full one in the tooltip
|
||||||
|
const badge = within(canvasElement).getByTitle('61d2b1c2-7664-4dca-974f-436c2ee90b2e');
|
||||||
|
await expect(badge).toHaveTextContent('61d2…0b2e');
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const SAMPLE_IDS = [
|
||||||
|
'61d2b1c2-7664-4dca-974f-436c2ee90b2e',
|
||||||
|
'e83f0a5d-1b9c-4f27-8d6e-2a4c9b7f1e03',
|
||||||
|
'0c7a94f1-3e52-4b8d-a1f6-9d2e5c8b4a70',
|
||||||
|
'f4b21e8c-9a07-4c63-b5d2-7e1f0a3c6d98',
|
||||||
|
'8d5e3a10-c4f7-4e29-9b81-5f6a2d0c7e14',
|
||||||
|
'2a9fc067-58d3-4a1e-86b4-c3e7f19d5b2a',
|
||||||
|
];
|
||||||
|
|
||||||
|
function Gallery() {
|
||||||
|
const [ids, setIds] = useState(SAMPLE_IDS);
|
||||||
|
return (
|
||||||
|
<div style={{ display: 'flex', flexDirection: 'column', alignItems: 'flex-start', gap: 12 }}>
|
||||||
|
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 16 }}>
|
||||||
|
{ids.map((id) => (
|
||||||
|
<UuidBadge key={id} id={id} />
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
<Button
|
||||||
|
size="sm"
|
||||||
|
variant="secondary"
|
||||||
|
onClick={() => setIds(ids.map(() => crypto.randomUUID()))}
|
||||||
|
>
|
||||||
|
Randomize
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
export const Colors: Story = {
|
||||||
|
render: () => <Gallery />,
|
||||||
|
play: async ({ canvasElement }) => {
|
||||||
|
// Each sample id gets its own badge
|
||||||
|
const canvas = within(canvasElement);
|
||||||
|
for (const id of SAMPLE_IDS) {
|
||||||
|
await expect(canvas.getByTitle(id)).toBeInTheDocument();
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
{
|
{
|
||||||
"name": "liqa-client",
|
"name": "liqa-client",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"author": "Andrii Arsenin",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev": "vite",
|
"dev": "vite",
|
||||||
|
|||||||
@@ -52,6 +52,16 @@
|
|||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.versionLink {
|
||||||
|
color: inherit;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.versionLink:hover,
|
||||||
|
.versionLink:focus-visible {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
|
||||||
.navItem {
|
.navItem {
|
||||||
display: flex;
|
display: flex;
|
||||||
align-items: center;
|
align-items: center;
|
||||||
|
|||||||
+22
-1
@@ -6,6 +6,7 @@ import type { LucideIcon } from 'lucide-react';
|
|||||||
import styles from './App.module.css';
|
import styles from './App.module.css';
|
||||||
import { SidePanel, ThemeSwitcher } from './ui';
|
import { SidePanel, ThemeSwitcher } from './ui';
|
||||||
import liqaLogo from './assets/liqa.svg';
|
import liqaLogo from './assets/liqa.svg';
|
||||||
|
import { useManifest } from './hooks/useManifest';
|
||||||
|
|
||||||
const EnvironmentsPage = lazy(() =>
|
const EnvironmentsPage = lazy(() =>
|
||||||
import('./pages/environment/EnvironmentsPage').then((m) => ({ default: m.EnvironmentsPage })),
|
import('./pages/environment/EnvironmentsPage').then((m) => ({ default: m.EnvironmentsPage })),
|
||||||
@@ -107,6 +108,7 @@ const NAV: ({ path: string; labelKey: string; Icon: LucideIcon } | { separator:
|
|||||||
|
|
||||||
export default function App() {
|
export default function App() {
|
||||||
const { t } = useTranslation();
|
const { t } = useTranslation();
|
||||||
|
const { version } = useManifest();
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={styles.shell}>
|
<div className={styles.shell}>
|
||||||
@@ -140,7 +142,26 @@ export default function App() {
|
|||||||
|
|
||||||
<div className={styles.sideFooter}>
|
<div className={styles.sideFooter}>
|
||||||
<ThemeSwitcher />
|
<ThemeSwitcher />
|
||||||
<div className={styles.version}>v{__APP_VERSION__}</div>
|
<div className={styles.version}>
|
||||||
|
<span
|
||||||
|
title={
|
||||||
|
version !== __APP_VERSION__
|
||||||
|
? t('nav.version_mismatch', { client: __APP_VERSION__ })
|
||||||
|
: undefined
|
||||||
|
}
|
||||||
|
>
|
||||||
|
v{version}
|
||||||
|
</span>{' '}
|
||||||
|
·{' '}
|
||||||
|
<a
|
||||||
|
className={styles.versionLink}
|
||||||
|
href="/licenses.txt"
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
>
|
||||||
|
{t('nav.licenses')}
|
||||||
|
</a>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</SidePanel>
|
</SidePanel>
|
||||||
|
|||||||
@@ -247,9 +247,10 @@ export const scenarios = {
|
|||||||
},
|
},
|
||||||
exportScenario(
|
exportScenario(
|
||||||
id: string,
|
id: string,
|
||||||
options: { includeEnvironment: boolean; credentialIds: string[] } = {
|
options: { includeEnvironment: boolean; credentialIds: string[]; snippetIds: string[] } = {
|
||||||
includeEnvironment: false,
|
includeEnvironment: false,
|
||||||
credentialIds: [],
|
credentialIds: [],
|
||||||
|
snippetIds: [],
|
||||||
},
|
},
|
||||||
): Promise<string> {
|
): Promise<string> {
|
||||||
const params = new URLSearchParams();
|
const params = new URLSearchParams();
|
||||||
@@ -257,6 +258,9 @@ export const scenarios = {
|
|||||||
for (const cid of options.credentialIds) {
|
for (const cid of options.credentialIds) {
|
||||||
params.append('credentialIds', cid);
|
params.append('credentialIds', cid);
|
||||||
}
|
}
|
||||||
|
for (const sid of options.snippetIds) {
|
||||||
|
params.append('snippetIds', sid);
|
||||||
|
}
|
||||||
return request(`/scenarios/${id}/export?${params.toString()}`);
|
return request(`/scenarios/${id}/export?${params.toString()}`);
|
||||||
},
|
},
|
||||||
exportE2eTestUrl(id: string): string {
|
exportE2eTestUrl(id: string): string {
|
||||||
|
|||||||
@@ -147,7 +147,7 @@ export interface RunDefaults {
|
|||||||
|
|
||||||
export type RunStepStatus = 'waiting' | 'pending' | 'in_progress' | 'pass' | 'fail' | 'cancelled';
|
export type RunStepStatus = 'waiting' | 'pending' | 'in_progress' | 'pass' | 'fail' | 'cancelled';
|
||||||
|
|
||||||
export type LogLevel = 'log' | 'warn' | 'error';
|
export type LogLevel = 'debug' | 'log' | 'warn' | 'error';
|
||||||
|
|
||||||
export interface ScenarioRun {
|
export interface ScenarioRun {
|
||||||
id: string;
|
id: string;
|
||||||
@@ -189,7 +189,11 @@ export interface ScenarioRunLog {
|
|||||||
runId: string;
|
runId: string;
|
||||||
stepRunId: string | null;
|
stepRunId: string | null;
|
||||||
level: LogLevel;
|
level: LogLevel;
|
||||||
|
/** Where the message was generated, e.g. "step:2", "snippet:login", "assertion:pass". */
|
||||||
|
context: string | null;
|
||||||
message: string;
|
message: string;
|
||||||
|
/** JSON payload attached to the message (e.g. a created file's metadata), as a raw string. */
|
||||||
|
data: string | null;
|
||||||
createdAt: string;
|
createdAt: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
.helpButton {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
justify-content: center;
|
||||||
|
padding: 2px;
|
||||||
|
border: none;
|
||||||
|
border-radius: var(--radius-sm);
|
||||||
|
background: none;
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.helpButton:hover {
|
||||||
|
color: var(--color-primary);
|
||||||
|
}
|
||||||
|
|
||||||
|
.helpButton:focus-visible {
|
||||||
|
outline: none;
|
||||||
|
box-shadow: 0 0 0 3px rgba(59, 130, 246, 0.35);
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
import { useState } from 'react';
|
||||||
|
import { useTranslation } from 'react-i18next';
|
||||||
|
import { CircleHelp, X } from 'lucide-react';
|
||||||
|
import { Modal, Button, MarkdownContent } from '../../ui';
|
||||||
|
import content from './code-help.md?raw';
|
||||||
|
import styles from './CodeHelpModal.module.css';
|
||||||
|
|
||||||
|
export interface CodeHelpModalProps {
|
||||||
|
open: boolean;
|
||||||
|
onClose: () => void;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Reference for the script runtime (`context`, `expect`, ...) available to step and snippet code. */
|
||||||
|
export function CodeHelpModal({ open, onClose }: CodeHelpModalProps) {
|
||||||
|
const { t } = useTranslation();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<Modal
|
||||||
|
open={open}
|
||||||
|
size="lg"
|
||||||
|
title={t('code_help.title')}
|
||||||
|
onClose={onClose}
|
||||||
|
footer={
|
||||||
|
<Button variant="secondary" onClick={onClose}>
|
||||||
|
<X size={14} />
|
||||||
|
{t('code_help.close')}
|
||||||
|
</Button>
|
||||||
|
}
|
||||||
|
>
|
||||||
|
<MarkdownContent content={content} />
|
||||||
|
</Modal>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A (?) button that opens the {@link CodeHelpModal}; place it next to a code field label. */
|
||||||
|
export function CodeHelpButton() {
|
||||||
|
const { t } = useTranslation();
|
||||||
|
const [open, setOpen] = useState(false);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={styles.helpButton}
|
||||||
|
onClick={() => setOpen(true)}
|
||||||
|
aria-label={t('code_help.open')}
|
||||||
|
title={t('code_help.open')}
|
||||||
|
>
|
||||||
|
<CircleHelp size={16} />
|
||||||
|
</button>
|
||||||
|
<CodeHelpModal open={open} onClose={() => setOpen(false)} />
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -61,3 +61,8 @@
|
|||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
accent-color: var(--color-primary);
|
accent-color: var(--color-primary);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.versions {
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
font-size: var(--font-size-xs);
|
||||||
|
}
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
import { useTranslation } from 'react-i18next';
|
import { useTranslation } from 'react-i18next';
|
||||||
import { X, Upload } from 'lucide-react';
|
import { X, Upload } from 'lucide-react';
|
||||||
import { Modal, Button, UuidBadge } from '../../ui';
|
import { Modal, Button, UuidBadge } from '../../ui';
|
||||||
import type { Scenario, ScenarioCredential } from '../../api';
|
import type { Scenario, ScenarioCredential, UsedSnippet } from '../../api';
|
||||||
import styles from './ExportScenarioModal.module.css';
|
import styles from './ExportScenarioModal.module.css';
|
||||||
|
|
||||||
export interface ExportScenarioModalProps {
|
export interface ExportScenarioModalProps {
|
||||||
@@ -13,6 +13,9 @@ export interface ExportScenarioModalProps {
|
|||||||
onIncludeEnvironmentChange: (v: boolean) => void;
|
onIncludeEnvironmentChange: (v: boolean) => void;
|
||||||
includedCredentialIds: Set<string>;
|
includedCredentialIds: Set<string>;
|
||||||
onCredentialToggle: (id: string, checked: boolean) => void;
|
onCredentialToggle: (id: string, checked: boolean) => void;
|
||||||
|
usedSnippets: UsedSnippet[];
|
||||||
|
includedSnippetIds: Set<string>;
|
||||||
|
onSnippetToggle: (id: string, checked: boolean) => void;
|
||||||
onClose: () => void;
|
onClose: () => void;
|
||||||
onExport: () => void;
|
onExport: () => void;
|
||||||
isExporting: boolean;
|
isExporting: boolean;
|
||||||
@@ -27,12 +30,24 @@ export function ExportScenarioModal({
|
|||||||
onIncludeEnvironmentChange,
|
onIncludeEnvironmentChange,
|
||||||
includedCredentialIds,
|
includedCredentialIds,
|
||||||
onCredentialToggle,
|
onCredentialToggle,
|
||||||
|
usedSnippets,
|
||||||
|
includedSnippetIds,
|
||||||
|
onSnippetToggle,
|
||||||
onClose,
|
onClose,
|
||||||
onExport,
|
onExport,
|
||||||
isExporting,
|
isExporting,
|
||||||
}: ExportScenarioModalProps) {
|
}: ExportScenarioModalProps) {
|
||||||
const { t } = useTranslation();
|
const { t } = useTranslation();
|
||||||
|
|
||||||
|
// One row per snippet, listing every version the scenario uses (latest or pinned)
|
||||||
|
const snippetRows = new Map<string, { alias: string; versions: number[] }>();
|
||||||
|
for (const s of usedSnippets) {
|
||||||
|
const row = snippetRows.get(s.id) ?? { alias: s.alias, versions: [] };
|
||||||
|
const version = s.pinnedVersion ?? s.version;
|
||||||
|
if (!row.versions.includes(version)) row.versions.push(version);
|
||||||
|
snippetRows.set(s.id, row);
|
||||||
|
}
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Modal
|
<Modal
|
||||||
open={open}
|
open={open}
|
||||||
@@ -64,6 +79,10 @@ export function ExportScenarioModal({
|
|||||||
<UuidBadge id={scenario.id} />
|
<UuidBadge id={scenario.id} />
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
|
<div className={styles.metaRow}>
|
||||||
|
<span className={styles.metaLabel}>{t('scenarios.field_version')}</span>
|
||||||
|
<span className={styles.metaValue}>v{scenario.version}</span>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{environment && (
|
{environment && (
|
||||||
@@ -95,6 +114,25 @@ export function ExportScenarioModal({
|
|||||||
))}
|
))}
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
|
{snippetRows.size > 0 && (
|
||||||
|
<div className={styles.section}>
|
||||||
|
<h4 className={styles.sectionTitle}>{t('scenarios.export_include_snippets')}</h4>
|
||||||
|
{[...snippetRows].map(([snippetId, row]) => (
|
||||||
|
<label key={snippetId} className={styles.checkboxRow}>
|
||||||
|
<input
|
||||||
|
type="checkbox"
|
||||||
|
checked={includedSnippetIds.has(snippetId)}
|
||||||
|
onChange={(e) => onSnippetToggle(snippetId, e.target.checked)}
|
||||||
|
/>
|
||||||
|
<span>{row.alias}</span>
|
||||||
|
<span className={styles.versions}>
|
||||||
|
{row.versions.map((v) => `v${v}`).join(', ')}
|
||||||
|
</span>
|
||||||
|
</label>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
</Modal>
|
</Modal>
|
||||||
|
|||||||
@@ -0,0 +1,195 @@
|
|||||||
|
Step code and snippet code are the **body of an async function**. Use `await` freely; whatever you `return` becomes the step (or snippet) output.
|
||||||
|
|
||||||
|
```js
|
||||||
|
async (context) => {
|
||||||
|
// your code here
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
All steps of a run share one browser, one browser context and one page, so state carries over from step to step: the current URL, cookies, local storage, open dialogs.
|
||||||
|
|
||||||
|
A step **passes** when its code returns, and **fails** when it throws or exceeds its timeout. When a step fails, the remaining steps are cancelled, and a screenshot and the page HTML are saved to the run's files.
|
||||||
|
|
||||||
|
## Globals
|
||||||
|
|
||||||
|
| Name | Description |
|
||||||
|
| --- | --- |
|
||||||
|
| `context` | The run context, described below. |
|
||||||
|
| `expect` | Playwright's [`expect`](https://playwright.dev/docs/test-assertions), with auto-retrying web assertions. |
|
||||||
|
| `console` | Writes to the run log: `log`/`info` → `log`, plus `warn`, `error` and `debug`. |
|
||||||
|
| `args` | **Snippets only.** The extra arguments passed to `context.runSnippet(name, ...args)`. |
|
||||||
|
|
||||||
|
Code runs in the server process with Node.js. It is trusted code, not sandboxed.
|
||||||
|
|
||||||
|
## Browser
|
||||||
|
|
||||||
|
### `context.page`
|
||||||
|
|
||||||
|
The Playwright [`Page`](https://playwright.dev/docs/api/class-page) of the run.
|
||||||
|
|
||||||
|
```js
|
||||||
|
await context.page.goto(context.getEnv("base_url"));
|
||||||
|
await context.page.getByRole("button", { name: "Sign in" }).click();
|
||||||
|
await expect(context.page.locator("h1")).toHaveText("Dashboard");
|
||||||
|
```
|
||||||
|
|
||||||
|
### `context.browser`
|
||||||
|
|
||||||
|
The Playwright [`BrowserContext`](https://playwright.dev/docs/api/class-browsercontext) the page belongs to. Use it for cookies, storage state, extra pages and HTTP requests that share the browser's cookies.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const cookies = await context.browser.cookies();
|
||||||
|
const res = await context.browser.request.get(context.getEnv("api_url") + "/me");
|
||||||
|
```
|
||||||
|
|
||||||
|
### `context.dumpDom(selector?)` → `Promise<DomNode>`
|
||||||
|
|
||||||
|
Returns a simplified tree of the live DOM, starting at `selector` (default `"body"`). Decorative and layout elements are filtered out. The tree keeps landmarks, interactive elements, and elements with `role`, `data-testid`, `data-qa`, `data-action` or `data-element-id`. Each node has `tag` and `children`, plus `role`, `testid`, `id`, `name`, `type`, `text`, `href`, `checked`, `disabled`, etc. when they are present. This is useful for finding selectors without a screenshot.
|
||||||
|
|
||||||
|
If nothing matches `selector`, it returns a node with `tag: "ERROR"` instead of throwing.
|
||||||
|
|
||||||
|
```js
|
||||||
|
context.log("Login form:", await context.dumpDom("form"));
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment
|
||||||
|
|
||||||
|
### `context.env`
|
||||||
|
|
||||||
|
A copy of the selected environment's key/value map, `{}` when there is none. A missing key reads as `undefined`.
|
||||||
|
|
||||||
|
### `context.getEnv(key)` → `string`
|
||||||
|
|
||||||
|
Returns the environment value for `key`, and **throws** if it is not defined. Prefer it over `context.env[key]` for required settings: the step then fails with a clear message.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const baseUrl = context.getEnv("base_url");
|
||||||
|
const locale = context.env.locale ?? "en";
|
||||||
|
```
|
||||||
|
|
||||||
|
## Credentials
|
||||||
|
|
||||||
|
### `context.getCredential(alias)` → `unknown`
|
||||||
|
|
||||||
|
Returns the payload of the credential assigned to this scenario under `alias` (see **Credentials** on the scenario page). JSON data is returned parsed, anything else as a string. **Throws** if no credential has that alias.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const { username, password } = context.getCredential("admin");
|
||||||
|
await context.page.getByLabel("Username").fill(username);
|
||||||
|
await context.page.getByLabel("Password").fill(password);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Step outputs
|
||||||
|
|
||||||
|
### `context.getStepOutput(order)` → `Promise<unknown>`
|
||||||
|
|
||||||
|
Returns the output (the return value) of another step in the same run. **It is async, so `await` it.**
|
||||||
|
|
||||||
|
- A positive `order` is absolute: `1` is the first step.
|
||||||
|
- A negative `order` is relative: `-1` is the previous step.
|
||||||
|
|
||||||
|
Returns `null` if that step does not exist, has not run, or returned nothing. A step's output is stored as JSON, so only JSON-serializable values come back as they were returned (no functions, `Date` becomes a string, Playwright objects are not usable).
|
||||||
|
|
||||||
|
```js
|
||||||
|
// step 2
|
||||||
|
return { orderId: await context.page.locator("#order-id").textContent() };
|
||||||
|
|
||||||
|
// step 3
|
||||||
|
const { orderId } = await context.getStepOutput(-1);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Logging
|
||||||
|
|
||||||
|
### `context.log(...args)`, `context.warn(...args)`, `context.error(...args)`, `context.debug(...args)`
|
||||||
|
|
||||||
|
Write an entry with that level to the run log. `console.*` does the same. Strings, numbers and booleans are joined with spaces into the message. Objects and arrays are kept separate as structured **data**, shown pretty-printed under the message: one object is stored as is, several are stored as an array.
|
||||||
|
|
||||||
|
```js
|
||||||
|
context.log("Created user", user.id, user); // message "Created user 42", data = user
|
||||||
|
```
|
||||||
|
|
||||||
|
Every entry is tagged with where it came from: `step:<N>`, or `snippet:<alias>` while a snippet runs.
|
||||||
|
|
||||||
|
## Assertions
|
||||||
|
|
||||||
|
### `context.assert(fn, description, details?)` → `Promise<void>`
|
||||||
|
|
||||||
|
Runs `fn` (sync or async) and requires it to return exactly `true`.
|
||||||
|
|
||||||
|
- On success, it logs `description` (tagged `assertion:pass`).
|
||||||
|
- If `fn` returns anything else or throws, it logs `Assertion failed: <description>` as an error (tagged `assertion:fail`) and throws, which fails the step. The entry's data holds `details` (if given) and the exception message as `error` (if `fn` threw).
|
||||||
|
|
||||||
|
Await it, or a failure will not stop the step.
|
||||||
|
|
||||||
|
```js
|
||||||
|
await context.assert(
|
||||||
|
async () => (await context.page.locator(".cart-item").count()) === 3,
|
||||||
|
"Cart contains 3 items",
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
Pass large diagnostics (e.g. a response body) as `details` rather than in `description`, so the message stays short:
|
||||||
|
|
||||||
|
```js
|
||||||
|
await context.assert(() => response.ok(), "Validation must pass", {
|
||||||
|
status: response.status(),
|
||||||
|
body: await response.json(),
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Use `expect` instead for assertions that wait and retry until the page matches, e.g. `await expect(locator).toBeVisible()`.
|
||||||
|
|
||||||
|
## Snippets
|
||||||
|
|
||||||
|
### `context.runSnippet(name, ...args)` → `Promise<unknown>`
|
||||||
|
|
||||||
|
Runs a stored snippet with the same `context` (same page, environment and credentials) and returns the snippet's return value. Extra arguments are available inside the snippet as `args`.
|
||||||
|
|
||||||
|
- `name` is the snippet alias, which runs its latest version.
|
||||||
|
- `alias@<version>` (e.g. `login@3`) pins a specific version.
|
||||||
|
|
||||||
|
Start, finish and failure are logged. If the snippet throws, the error propagates and fails the calling step unless you catch it. Snippets can call other snippets.
|
||||||
|
|
||||||
|
```js
|
||||||
|
// step code
|
||||||
|
const user = await context.runSnippet("login", "admin", { remember: true });
|
||||||
|
|
||||||
|
// snippet "login"
|
||||||
|
const [alias, opts] = args;
|
||||||
|
const { username, password } = context.getCredential(alias);
|
||||||
|
// ...
|
||||||
|
return { username };
|
||||||
|
```
|
||||||
|
|
||||||
|
## Files
|
||||||
|
|
||||||
|
### `context.getScenarioFiles(opts?)` → `Promise<{ items, total }>`
|
||||||
|
|
||||||
|
Lists the files uploaded to this scenario (see **Files** on the scenario page). `opts` takes `limit` and `offset` for paging. Each item has `id`, `name`, `mimeType`, `size`, `sha256` and `path`, the absolute path on the server's disk, which you can pass to Playwright:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const { items } = await context.getScenarioFiles();
|
||||||
|
const doc = items.find((f) => f.name === "contract.pdf");
|
||||||
|
await context.page.locator("input[type=file]").setInputFiles(doc.path);
|
||||||
|
```
|
||||||
|
|
||||||
|
### `context.downloadFile(url, opts?)` → `Promise<FileInfo>`
|
||||||
|
|
||||||
|
Fetches `url` on the server and saves the response as a file of the current run. It returns the same fields as a scenario file (`id`, `name`, `mimeType`, `size`, `sha256`, `path`).
|
||||||
|
|
||||||
|
- `opts`: `method`, `headers`, `body` (a string) and `filename`. Without `filename`, the last segment of the URL path is used, and the MIME type is derived from the file extension.
|
||||||
|
- Redirects are followed. Any final status other than 200 throws. The limits are 100 MB and a 30 s timeout.
|
||||||
|
- `url` may be a `data:` URI (`data:<type>;base64,<data>` or `data:<type>,<percent-encoded>`), which saves content generated in the script without a network request. Pass `filename` in this case.
|
||||||
|
- Only works during a real scenario run. It throws in ad-hoc execution such as the `exec_code` MCP tool.
|
||||||
|
- This is a server-side request: it does **not** send the browser's cookies. Pass them in `headers` if the URL needs a session.
|
||||||
|
|
||||||
|
```js
|
||||||
|
await context.downloadFile(
|
||||||
|
"data:application/json;base64," + btoa(JSON.stringify(report)),
|
||||||
|
{ filename: "report.json" },
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Timeouts
|
||||||
|
|
||||||
|
Each step has its own timeout, or else the scenario's timeout, or else 60 s. The whole run fails once it exceeds the scenario's timeout (600 s by default). That check happens between steps.
|
||||||
@@ -6,3 +6,5 @@ export { RunScenarioModal } from './RunScenarioModal';
|
|||||||
export type { RunScenarioModalProps } from './RunScenarioModal';
|
export type { RunScenarioModalProps } from './RunScenarioModal';
|
||||||
export { ExportLogsModal } from './ExportLogsModal';
|
export { ExportLogsModal } from './ExportLogsModal';
|
||||||
export type { ExportLogsModalProps, LogExportFormat } from './ExportLogsModal';
|
export type { ExportLogsModalProps, LogExportFormat } from './ExportLogsModal';
|
||||||
|
export { CodeHelpModal, CodeHelpButton } from './CodeHelpModal';
|
||||||
|
export type { CodeHelpModalProps } from './CodeHelpModal';
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
import { useSyncExternalStore } from 'react';
|
||||||
|
import { getManifest, subscribeManifest, type Manifest } from '../lib/manifest';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Public client configuration from the server's /manifest.json: the cached
|
||||||
|
* copy (or defaults) at first, updated once the fresh one arrives.
|
||||||
|
*/
|
||||||
|
export function useManifest(): Manifest {
|
||||||
|
return useSyncExternalStore(subscribeManifest, getManifest);
|
||||||
|
}
|
||||||
@@ -12,6 +12,11 @@
|
|||||||
"confirm_remove_credential": "Are you sure you want to remove this credential from scenario?",
|
"confirm_remove_credential": "Are you sure you want to remove this credential from scenario?",
|
||||||
"save_session": "Save session"
|
"save_session": "Save session"
|
||||||
},
|
},
|
||||||
|
"code_help": {
|
||||||
|
"open": "Code reference",
|
||||||
|
"title": "Code reference",
|
||||||
|
"close": "Close"
|
||||||
|
},
|
||||||
"errors": {
|
"errors": {
|
||||||
"not_found": "Not found",
|
"not_found": "Not found",
|
||||||
"not_found_session": "Session {{id}} does not exist or has been deleted.",
|
"not_found_session": "Session {{id}} does not exist or has been deleted.",
|
||||||
@@ -22,6 +27,8 @@
|
|||||||
"generic": "Something went wrong. Please try again."
|
"generic": "Something went wrong. Please try again."
|
||||||
},
|
},
|
||||||
"nav": {
|
"nav": {
|
||||||
|
"licenses": "Licenses",
|
||||||
|
"version_mismatch": "Server version; this page was built for v{{client}}. Reload to update.",
|
||||||
"environments": "Environments",
|
"environments": "Environments",
|
||||||
"credentials": "Credentials",
|
"credentials": "Credentials",
|
||||||
"snippets": "Snippets",
|
"snippets": "Snippets",
|
||||||
@@ -217,11 +224,10 @@
|
|||||||
"export_modal_title": "Export Scenario",
|
"export_modal_title": "Export Scenario",
|
||||||
"export_include_environment": "Include Environment",
|
"export_include_environment": "Include Environment",
|
||||||
"export_include_credentials": "Include Credentials",
|
"export_include_credentials": "Include Credentials",
|
||||||
|
"export_include_snippets": "Include Snippets",
|
||||||
"form_timeout": "Scenario Timeout (seconds)",
|
"form_timeout": "Scenario Timeout (seconds)",
|
||||||
"form_timeout_placeholder": "Default: 600",
|
"form_timeout_placeholder": "Default: 600",
|
||||||
"form_timeout_hint": "Max seconds for the entire scenario run (default: 600)",
|
"form_timeout_hint": "Max seconds for the entire scenario run (default: 600)"
|
||||||
"field_name": "Name",
|
|
||||||
"field_id": "ID"
|
|
||||||
},
|
},
|
||||||
"theme": {
|
"theme": {
|
||||||
"switch_to_light": "Switch to light theme",
|
"switch_to_light": "Switch to light theme",
|
||||||
@@ -229,6 +235,11 @@
|
|||||||
"light_mode": "Light mode",
|
"light_mode": "Light mode",
|
||||||
"dark_mode": "Dark mode"
|
"dark_mode": "Dark mode"
|
||||||
},
|
},
|
||||||
|
"revealable": {
|
||||||
|
"hidden": "Hidden so secrets aren't exposed on screen.",
|
||||||
|
"reveal": "Reveal",
|
||||||
|
"hide": "Hide"
|
||||||
|
},
|
||||||
"pagination": {
|
"pagination": {
|
||||||
"prev": "Previous page",
|
"prev": "Previous page",
|
||||||
"next": "Next page",
|
"next": "Next page",
|
||||||
@@ -293,6 +304,14 @@
|
|||||||
"log_message": "Message",
|
"log_message": "Message",
|
||||||
"log_time": "Time",
|
"log_time": "Time",
|
||||||
"action_download_logs": "Download logs",
|
"action_download_logs": "Download logs",
|
||||||
|
"action_copy_logs": "Copy logs",
|
||||||
|
"logs_copied": "Logs copied to clipboard",
|
||||||
|
"logs_copy_failed": "Could not copy logs to clipboard",
|
||||||
|
"logs_expand_data": "Expand data",
|
||||||
|
"logs_collapse_data": "Collapse data",
|
||||||
|
"logs_show_data_one": "Show data ({{size}}, {{count}} line)",
|
||||||
|
"logs_show_data_other": "Show data ({{size}}, {{count}} lines)",
|
||||||
|
"logs_hide_data": "Hide data",
|
||||||
"action_repeat": "Repeat run",
|
"action_repeat": "Repeat run",
|
||||||
"repeat_no_environment": "The environment used by this run no longer exists",
|
"repeat_no_environment": "The environment used by this run no longer exists",
|
||||||
"export_logs_modal_title": "Export logs",
|
"export_logs_modal_title": "Export logs",
|
||||||
|
|||||||
@@ -0,0 +1,122 @@
|
|||||||
|
import { DEFAULT_LOG_DATA_LIMITS, type LogDataLimits } from '../ui/LogOutput/logText';
|
||||||
|
|
||||||
|
/** Public client configuration served by the server at /manifest.json. */
|
||||||
|
export interface Manifest {
|
||||||
|
name: string;
|
||||||
|
/** Server version; can differ from the client build's __APP_VERSION__ until the page is reloaded. */
|
||||||
|
version: string;
|
||||||
|
runLogs: {
|
||||||
|
dataLimits: LogDataLimits;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_MANIFEST: Manifest = {
|
||||||
|
name: 'liqa',
|
||||||
|
version: __APP_VERSION__,
|
||||||
|
runLogs: { dataLimits: DEFAULT_LOG_DATA_LIMITS },
|
||||||
|
};
|
||||||
|
|
||||||
|
const STORAGE_KEY = 'liqa-manifest';
|
||||||
|
/** A tab coming back into view refetches the manifest if it is older than this. */
|
||||||
|
const REFRESH_AFTER_MS = 5 * 60 * 1000;
|
||||||
|
|
||||||
|
// Served next to the API's /api/v1 (so "/manifest.json" by default, or on
|
||||||
|
// VITE_API_URL's origin when the client talks to another server)
|
||||||
|
const MANIFEST_URL = new URL(
|
||||||
|
'../../manifest.json',
|
||||||
|
new URL(
|
||||||
|
`${(import.meta.env.VITE_API_URL ?? '/api/v1').replace(/\/$/, '')}/`,
|
||||||
|
window.location.href,
|
||||||
|
),
|
||||||
|
).toString();
|
||||||
|
|
||||||
|
/** Fills fields missing from `raw` (e.g. a manifest cached by an older version) with defaults. */
|
||||||
|
function normalize(raw: unknown): Manifest | null {
|
||||||
|
if (typeof raw !== 'object' || raw === null) return null;
|
||||||
|
const m = raw as Partial<Manifest>;
|
||||||
|
const limits: Partial<LogDataLimits> = m.runLogs?.dataLimits ?? {};
|
||||||
|
const num = (v: unknown, fallback: number) => (typeof v === 'number' && v >= 0 ? v : fallback);
|
||||||
|
return {
|
||||||
|
name: typeof m.name === 'string' ? m.name : DEFAULT_MANIFEST.name,
|
||||||
|
version: typeof m.version === 'string' ? m.version : DEFAULT_MANIFEST.version,
|
||||||
|
runLogs: {
|
||||||
|
dataLimits: {
|
||||||
|
bytes: num(limits.bytes, DEFAULT_LOG_DATA_LIMITS.bytes),
|
||||||
|
lines: num(limits.lines, DEFAULT_LOG_DATA_LIMITS.lines),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Storage can be unavailable (private mode, blocked site data): the manifest
|
||||||
|
// then just comes from the network on every page load
|
||||||
|
function readCache(): Manifest | null {
|
||||||
|
try {
|
||||||
|
const stored = localStorage.getItem(STORAGE_KEY);
|
||||||
|
return stored ? normalize(JSON.parse(stored)) : null;
|
||||||
|
} catch {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function writeCache(manifest: Manifest) {
|
||||||
|
try {
|
||||||
|
localStorage.setItem(STORAGE_KEY, JSON.stringify(manifest));
|
||||||
|
} catch {
|
||||||
|
// ignore, see readCache
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let current: Manifest = readCache() ?? DEFAULT_MANIFEST;
|
||||||
|
let fetchedAt = 0;
|
||||||
|
let inFlight: Promise<void> | null = null;
|
||||||
|
const listeners = new Set<() => void>();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fetches the manifest and notifies subscribers if it changed. Failures are
|
||||||
|
* silent: the cached (or default) manifest stays in use.
|
||||||
|
*/
|
||||||
|
export function refreshManifest(): Promise<void> {
|
||||||
|
inFlight ??= fetch(MANIFEST_URL, { headers: { Accept: 'application/json' } })
|
||||||
|
.then((res) => (res.ok ? res.json() : null))
|
||||||
|
.then((raw: unknown) => {
|
||||||
|
const next = normalize(raw);
|
||||||
|
if (!next) return;
|
||||||
|
fetchedAt = Date.now();
|
||||||
|
writeCache(next);
|
||||||
|
if (JSON.stringify(next) !== JSON.stringify(current)) {
|
||||||
|
current = next;
|
||||||
|
listeners.forEach((l) => l());
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.catch(() => undefined)
|
||||||
|
.finally(() => {
|
||||||
|
inFlight = null;
|
||||||
|
});
|
||||||
|
return inFlight;
|
||||||
|
}
|
||||||
|
|
||||||
|
function onVisibilityChange() {
|
||||||
|
if (document.visibilityState === 'visible' && Date.now() - fetchedAt > REFRESH_AFTER_MS) {
|
||||||
|
void refreshManifest();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stale-while-revalidate: subscribers get the localStorage copy right away,
|
||||||
|
* and the manifest is refetched once per page load (the server answers 304
|
||||||
|
* while it is unchanged) and when the tab becomes visible again after a while.
|
||||||
|
*/
|
||||||
|
export function subscribeManifest(listener: () => void): () => void {
|
||||||
|
if (listeners.size === 0) document.addEventListener('visibilitychange', onVisibilityChange);
|
||||||
|
listeners.add(listener);
|
||||||
|
if (fetchedAt === 0) void refreshManifest();
|
||||||
|
return () => {
|
||||||
|
listeners.delete(listener);
|
||||||
|
if (listeners.size === 0) document.removeEventListener('visibilitychange', onVisibilityChange);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getManifest(): Manifest {
|
||||||
|
return current;
|
||||||
|
}
|
||||||
@@ -255,6 +255,12 @@
|
|||||||
color: var(--color-text);
|
color: var(--color-text);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.labelRow {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: var(--space-1);
|
||||||
|
}
|
||||||
|
|
||||||
.textarea {
|
.textarea {
|
||||||
width: 100%;
|
width: 100%;
|
||||||
padding: var(--space-2) var(--space-3);
|
padding: var(--space-2) var(--space-3);
|
||||||
|
|||||||
@@ -3,11 +3,18 @@ import { useNavigate, useParams } from 'react-router-dom';
|
|||||||
import { useTranslation } from 'react-i18next';
|
import { useTranslation } from 'react-i18next';
|
||||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||||
import { Upload, Pencil, Trash2, KeyRound } from 'lucide-react';
|
import { Upload, Pencil, Trash2, KeyRound } from 'lucide-react';
|
||||||
import { CodeBlock } from '../../ui';
|
|
||||||
import { stringify as yamlStringify } from 'yaml';
|
import { stringify as yamlStringify } from 'yaml';
|
||||||
import { credentials } from '../../api';
|
import { credentials } from '../../api';
|
||||||
import type { Credential } from '../../api';
|
import type { Credential } from '../../api';
|
||||||
import { Breadcrumbs, Button, Card, DescriptionList, Timestamp, UuidBadge } from '../../ui';
|
import {
|
||||||
|
Breadcrumbs,
|
||||||
|
Button,
|
||||||
|
Card,
|
||||||
|
DescriptionList,
|
||||||
|
RevealableCodeBlock,
|
||||||
|
Timestamp,
|
||||||
|
UuidBadge,
|
||||||
|
} from '../../ui';
|
||||||
import { DeleteConfirmationModal } from '../../components/modals';
|
import { DeleteConfirmationModal } from '../../components/modals';
|
||||||
import styles from '../Page.module.css';
|
import styles from '../Page.module.css';
|
||||||
|
|
||||||
@@ -117,7 +124,8 @@ export function CredentialDetailPage() {
|
|||||||
<div className={styles.stepsSection}>
|
<div className={styles.stepsSection}>
|
||||||
<h2 className={styles.sectionHeading}>{t('credentials.section_data')}</h2>
|
<h2 className={styles.sectionHeading}>{t('credentials.section_data')}</h2>
|
||||||
<Card>
|
<Card>
|
||||||
<CodeBlock
|
<RevealableCodeBlock
|
||||||
|
key={credential.id}
|
||||||
language="json"
|
language="json"
|
||||||
code={(() => {
|
code={(() => {
|
||||||
try {
|
try {
|
||||||
|
|||||||
@@ -1,16 +1,15 @@
|
|||||||
import { useEffect, useRef, useState, useCallback } from 'react';
|
import { useEffect, useMemo, useRef, useState, useCallback } from 'react';
|
||||||
import { useNavigate, useParams, Link } from 'react-router-dom';
|
import { useNavigate, useParams, Link } from 'react-router-dom';
|
||||||
import { useTranslation } from 'react-i18next';
|
import { useTranslation } from 'react-i18next';
|
||||||
|
import { useManifest } from '../../hooks/useManifest';
|
||||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||||
import { runs, runFiles } from '../../api';
|
import { runs, runFiles } from '../../api';
|
||||||
import type {
|
import type {
|
||||||
Scenario,
|
Scenario,
|
||||||
ScenarioRunDetail,
|
ScenarioRunDetail,
|
||||||
ScenarioRunStep,
|
ScenarioRunStep,
|
||||||
ScenarioRunLog,
|
|
||||||
ScenarioRunStatus,
|
ScenarioRunStatus,
|
||||||
RunStepStatus,
|
RunStepStatus,
|
||||||
LogLevel,
|
|
||||||
FileMetadata,
|
FileMetadata,
|
||||||
} from '../../api';
|
} from '../../api';
|
||||||
import { scenarios } from '../../api';
|
import { scenarios } from '../../api';
|
||||||
@@ -27,7 +26,9 @@ import {
|
|||||||
Card,
|
Card,
|
||||||
CodeBlock,
|
CodeBlock,
|
||||||
DescriptionList,
|
DescriptionList,
|
||||||
Pagination,
|
formatLogText,
|
||||||
|
hasLargeData,
|
||||||
|
LogOutput,
|
||||||
Search,
|
Search,
|
||||||
Table,
|
Table,
|
||||||
Timestamp,
|
Timestamp,
|
||||||
@@ -40,6 +41,7 @@ import {
|
|||||||
ChevronDown,
|
ChevronDown,
|
||||||
ChevronRight,
|
ChevronRight,
|
||||||
ClipboardList,
|
ClipboardList,
|
||||||
|
Copy,
|
||||||
Activity,
|
Activity,
|
||||||
Download,
|
Download,
|
||||||
Trash2,
|
Trash2,
|
||||||
@@ -70,12 +72,6 @@ const STEP_STATUS_VARIANT: Record<RunStepStatus, BadgeVariant> = {
|
|||||||
cancelled: 'warning',
|
cancelled: 'warning',
|
||||||
};
|
};
|
||||||
|
|
||||||
const LOG_LEVEL_VARIANT: Record<LogLevel, BadgeVariant> = {
|
|
||||||
log: 'neutral',
|
|
||||||
warn: 'warning',
|
|
||||||
error: 'error',
|
|
||||||
};
|
|
||||||
|
|
||||||
const FINAL: ScenarioRunStatus[] = ['pass', 'fail'];
|
const FINAL: ScenarioRunStatus[] = ['pass', 'fail'];
|
||||||
|
|
||||||
export function RunDetailPage() {
|
export function RunDetailPage() {
|
||||||
@@ -89,6 +85,7 @@ function RunDetail() {
|
|||||||
const { id, runId } = useParams<{ id: string; runId: string }>();
|
const { id, runId } = useParams<{ id: string; runId: string }>();
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const toast = useToast();
|
const toast = useToast();
|
||||||
|
const logDataLimits = useManifest().runLogs.dataLimits;
|
||||||
|
|
||||||
const [scenario, setScenario] = useState<Scenario | null>(null);
|
const [scenario, setScenario] = useState<Scenario | null>(null);
|
||||||
const [run, setRun] = useState<ScenarioRunDetail | null>(null);
|
const [run, setRun] = useState<ScenarioRunDetail | null>(null);
|
||||||
@@ -97,7 +94,6 @@ function RunDetail() {
|
|||||||
const [error, setError] = useState<string | null>(null);
|
const [error, setError] = useState<string | null>(null);
|
||||||
const [polling, setPolling] = useState(false);
|
const [polling, setPolling] = useState(false);
|
||||||
const [pulseKey, setPulseKey] = useState(0);
|
const [pulseKey, setPulseKey] = useState(0);
|
||||||
const [logPage, setLogPage] = useState(1);
|
|
||||||
const [logSearch, setLogSearch] = useState('');
|
const [logSearch, setLogSearch] = useState('');
|
||||||
const [debouncedSearch, setDebouncedSearch] = useState('');
|
const [debouncedSearch, setDebouncedSearch] = useState('');
|
||||||
const [expandAll, setExpandAll] = useState(false);
|
const [expandAll, setExpandAll] = useState(false);
|
||||||
@@ -111,8 +107,8 @@ function RunDetail() {
|
|||||||
const [pendingDeleteFile, setPendingDeleteFile] = useState<FileMetadata | null>(null);
|
const [pendingDeleteFile, setPendingDeleteFile] = useState<FileMetadata | null>(null);
|
||||||
const [deletingFile, setDeletingFile] = useState(false);
|
const [deletingFile, setDeletingFile] = useState(false);
|
||||||
const [repeating, setRepeating] = useState(false);
|
const [repeating, setRepeating] = useState(false);
|
||||||
|
const [logDataExpanded, setLogDataExpanded] = useState(false);
|
||||||
const logSearchRef = useRef('');
|
const logSearchRef = useRef('');
|
||||||
const LOG_PAGE_SIZE = 25;
|
|
||||||
const pollRef = useRef<ReturnType<typeof setInterval> | null>(null);
|
const pollRef = useRef<ReturnType<typeof setInterval> | null>(null);
|
||||||
|
|
||||||
const stopPolling = () => {
|
const stopPolling = () => {
|
||||||
@@ -154,6 +150,33 @@ function RunDetail() {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
const logEntries = useMemo(
|
||||||
|
() =>
|
||||||
|
(run?.logs ?? []).map((l) => ({
|
||||||
|
id: l.id,
|
||||||
|
level: l.level,
|
||||||
|
context: l.context,
|
||||||
|
message: l.message,
|
||||||
|
data: l.data,
|
||||||
|
createdAt: l.createdAt,
|
||||||
|
})),
|
||||||
|
[run?.logs],
|
||||||
|
);
|
||||||
|
const logsHaveLargeData = useMemo(
|
||||||
|
() => hasLargeData(logEntries, logDataLimits),
|
||||||
|
[logEntries, logDataLimits],
|
||||||
|
);
|
||||||
|
|
||||||
|
// Copies the (filtered) logs as plain text with every data block expanded
|
||||||
|
const handleCopyLogs = async () => {
|
||||||
|
try {
|
||||||
|
await navigator.clipboard.writeText(formatLogText(logEntries, run?.createdAt));
|
||||||
|
toast.success(t('runs.logs_copied'));
|
||||||
|
} catch {
|
||||||
|
toast.error(t('runs.logs_copy_failed'));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
const handleRepeatRun = async () => {
|
const handleRepeatRun = async () => {
|
||||||
if (!id || !run?.environmentId) return;
|
if (!id || !run?.environmentId) return;
|
||||||
setRepeating(true);
|
setRepeating(true);
|
||||||
@@ -221,7 +244,6 @@ function RunDetail() {
|
|||||||
const t = setTimeout(() => {
|
const t = setTimeout(() => {
|
||||||
setDebouncedSearch(logSearch);
|
setDebouncedSearch(logSearch);
|
||||||
logSearchRef.current = logSearch;
|
logSearchRef.current = logSearch;
|
||||||
setLogPage(1);
|
|
||||||
}, 300);
|
}, 300);
|
||||||
return () => clearTimeout(t);
|
return () => clearTimeout(t);
|
||||||
}, [logSearch]);
|
}, [logSearch]);
|
||||||
@@ -400,26 +422,6 @@ function RunDetail() {
|
|||||||
},
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
const logColumns: TableColumn<ScenarioRunLog>[] = [
|
|
||||||
{
|
|
||||||
key: 'level',
|
|
||||||
header: t('runs.log_level'),
|
|
||||||
width: 70,
|
|
||||||
render: (l) => <Badge variant={LOG_LEVEL_VARIANT[l.level]}>{l.level}</Badge>,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
key: 'message',
|
|
||||||
header: t('runs.log_message'),
|
|
||||||
render: (l) => <code style={{ wordBreak: 'break-word' }}>{l.message}</code>,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
key: 'time',
|
|
||||||
header: t('runs.log_time'),
|
|
||||||
width: 160,
|
|
||||||
render: (l) => <Timestamp value={l.createdAt} />,
|
|
||||||
},
|
|
||||||
];
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div>
|
<div>
|
||||||
<div className={styles.pageToolbar}>
|
<div className={styles.pageToolbar}>
|
||||||
@@ -547,7 +549,22 @@ function RunDetail() {
|
|||||||
{run.logs.length > 0 && (
|
{run.logs.length > 0 && (
|
||||||
<div className={styles.stepsSection}>
|
<div className={styles.stepsSection}>
|
||||||
<div className={styles.sectionHeadingRow}>
|
<div className={styles.sectionHeadingRow}>
|
||||||
<h2 className={styles.sectionHeading}>{t('runs.logs_heading')}</h2>
|
<div style={{ display: 'flex', alignItems: 'center', gap: '8px' }}>
|
||||||
|
<h2 className={styles.sectionHeading} style={{ margin: 0 }}>
|
||||||
|
{t('runs.logs_heading')}
|
||||||
|
</h2>
|
||||||
|
{logsHaveLargeData && (
|
||||||
|
<Button
|
||||||
|
variant="ghost"
|
||||||
|
size="sm"
|
||||||
|
aria-expanded={logDataExpanded}
|
||||||
|
onClick={() => setLogDataExpanded((v) => !v)}
|
||||||
|
>
|
||||||
|
{logDataExpanded ? <ChevronDown size={14} /> : <ChevronRight size={14} />}
|
||||||
|
{logDataExpanded ? t('runs.logs_collapse_data') : t('runs.logs_expand_data')}
|
||||||
|
</Button>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
<div style={{ display: 'flex', alignItems: 'center', gap: '8px' }}>
|
<div style={{ display: 'flex', alignItems: 'center', gap: '8px' }}>
|
||||||
<Search
|
<Search
|
||||||
value={logSearch}
|
value={logSearch}
|
||||||
@@ -558,23 +575,27 @@ function RunDetail() {
|
|||||||
<Download size={14} />
|
<Download size={14} />
|
||||||
{t('runs.action_download_logs')}
|
{t('runs.action_download_logs')}
|
||||||
</Button>
|
</Button>
|
||||||
|
<Button variant="secondary" size="sm" onClick={handleCopyLogs}>
|
||||||
|
<Copy size={14} />
|
||||||
|
{t('runs.action_copy_logs')}
|
||||||
|
</Button>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<Table
|
<LogOutput
|
||||||
columns={logColumns}
|
startTime={run.createdAt}
|
||||||
data={run.logs.slice((logPage - 1) * LOG_PAGE_SIZE, logPage * LOG_PAGE_SIZE)}
|
maxHeight={480}
|
||||||
rowKey={(l) => l.id}
|
entries={logEntries}
|
||||||
loading={false}
|
dataLimits={logDataLimits}
|
||||||
|
dataExpanded={logDataExpanded}
|
||||||
|
showDataLabel={({ bytes, lines }) =>
|
||||||
|
t('runs.logs_show_data', {
|
||||||
|
size: bytes < 1024 ? `${bytes} B` : `${(bytes / 1024).toFixed(1)} KB`,
|
||||||
|
count: lines,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
hideDataLabel={t('runs.logs_hide_data')}
|
||||||
emptyMessage=""
|
emptyMessage=""
|
||||||
/>
|
/>
|
||||||
{run.logs.length > LOG_PAGE_SIZE && (
|
|
||||||
<Pagination
|
|
||||||
page={logPage}
|
|
||||||
pageSize={LOG_PAGE_SIZE}
|
|
||||||
total={run.logs.length}
|
|
||||||
onPageChange={setLogPage}
|
|
||||||
/>
|
|
||||||
)}
|
|
||||||
</div>
|
</div>
|
||||||
)}
|
)}
|
||||||
|
|
||||||
@@ -587,7 +608,23 @@ function RunDetail() {
|
|||||||
rowKey={(f) => f.id}
|
rowKey={(f) => f.id}
|
||||||
columns={
|
columns={
|
||||||
[
|
[
|
||||||
{ key: 'name', header: t('files.name'), render: (f) => f.name },
|
{
|
||||||
|
key: 'name',
|
||||||
|
header: t('files.name'),
|
||||||
|
// Served inline, so the browser shows what it can (images, text, PDF).
|
||||||
|
render: (f) =>
|
||||||
|
isFileExpired(f) ? (
|
||||||
|
f.name
|
||||||
|
) : (
|
||||||
|
<a
|
||||||
|
href={runFiles.contentUrl(id!, runId!, f.id)}
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
>
|
||||||
|
{f.name}
|
||||||
|
</a>
|
||||||
|
),
|
||||||
|
},
|
||||||
{
|
{
|
||||||
key: 'mimeType',
|
key: 'mimeType',
|
||||||
header: t('files.mimeType'),
|
header: t('files.mimeType'),
|
||||||
|
|||||||
@@ -68,10 +68,12 @@ export function RunsPage() {
|
|||||||
const sortDirRef = useRef(sortDir);
|
const sortDirRef = useRef(sortDir);
|
||||||
const pageRef = useRef(page);
|
const pageRef = useRef(page);
|
||||||
const pageSizeRef = useRef(pageSize);
|
const pageSizeRef = useRef(pageSize);
|
||||||
sortByRef.current = sortBy;
|
useEffect(() => {
|
||||||
sortDirRef.current = sortDir;
|
sortByRef.current = sortBy;
|
||||||
pageRef.current = page;
|
sortDirRef.current = sortDir;
|
||||||
pageSizeRef.current = pageSize;
|
pageRef.current = page;
|
||||||
|
pageSizeRef.current = pageSize;
|
||||||
|
}, [sortBy, sortDir, page, pageSize]);
|
||||||
|
|
||||||
const load = useCallback(
|
const load = useCallback(
|
||||||
(orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
(orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import { X, Save, ClipboardList } from 'lucide-react';
|
|||||||
import { scenarios, steps } from '../../api';
|
import { scenarios, steps } from '../../api';
|
||||||
import type { Scenario } from '../../api';
|
import type { Scenario } from '../../api';
|
||||||
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
||||||
|
import { CodeHelpButton } from '../../components/modals';
|
||||||
import styles from '../Page.module.css';
|
import styles from '../Page.module.css';
|
||||||
|
|
||||||
export function CreateStepPage() {
|
export function CreateStepPage() {
|
||||||
@@ -77,7 +78,10 @@ export function CreateStepPage() {
|
|||||||
onChange={(e) => setTitle(e.target.value)}
|
onChange={(e) => setTitle(e.target.value)}
|
||||||
/>
|
/>
|
||||||
<div className={styles.formField}>
|
<div className={styles.formField}>
|
||||||
<label className={styles.fieldLabel}>{t('steps.form_exec_code')}</label>
|
<div className={styles.labelRow}>
|
||||||
|
<label className={styles.fieldLabel}>{t('steps.form_exec_code')}</label>
|
||||||
|
<CodeHelpButton />
|
||||||
|
</div>
|
||||||
<CodeEditor value={execCode} onChange={setExecCode} rows={6} />
|
<CodeEditor value={execCode} onChange={setExecCode} rows={6} />
|
||||||
</div>
|
</div>
|
||||||
<Input
|
<Input
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import { X, Save, ClipboardList } from 'lucide-react';
|
|||||||
import { scenarios, steps } from '../../api';
|
import { scenarios, steps } from '../../api';
|
||||||
import type { Scenario, ScenarioStep } from '../../api';
|
import type { Scenario, ScenarioStep } from '../../api';
|
||||||
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
||||||
|
import { CodeHelpButton } from '../../components/modals';
|
||||||
import styles from '../Page.module.css';
|
import styles from '../Page.module.css';
|
||||||
|
|
||||||
export function EditStepPage() {
|
export function EditStepPage() {
|
||||||
@@ -89,7 +90,10 @@ export function EditStepPage() {
|
|||||||
onChange={(e) => setTitle(e.target.value)}
|
onChange={(e) => setTitle(e.target.value)}
|
||||||
/>
|
/>
|
||||||
<div className={styles.formField}>
|
<div className={styles.formField}>
|
||||||
<label className={styles.fieldLabel}>{t('steps.form_exec_code')}</label>
|
<div className={styles.labelRow}>
|
||||||
|
<label className={styles.fieldLabel}>{t('steps.form_exec_code')}</label>
|
||||||
|
<CodeHelpButton />
|
||||||
|
</div>
|
||||||
<CodeEditor value={execCode} onChange={setExecCode} rows={6} />
|
<CodeEditor value={execCode} onChange={setExecCode} rows={6} />
|
||||||
</div>
|
</div>
|
||||||
<Input
|
<Input
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { useEffect, useRef, useState, useCallback, SubmitEvent } from 'react';
|
import { useEffect, useState, useCallback, SubmitEvent } from 'react';
|
||||||
import { useNavigate, useParams } from 'react-router-dom';
|
import { useNavigate, useParams } from 'react-router-dom';
|
||||||
import { useTranslation } from 'react-i18next';
|
import { useTranslation } from 'react-i18next';
|
||||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||||
@@ -85,7 +85,6 @@ export function ScenarioDetailPage() {
|
|||||||
const traceMode = traceModeOverride ?? runDefaults?.traceMode ?? 'off';
|
const traceMode = traceModeOverride ?? runDefaults?.traceMode ?? 'off';
|
||||||
const [envs, setEnvs] = useState<Environment[]>([]);
|
const [envs, setEnvs] = useState<Environment[]>([]);
|
||||||
const [selectedEnvId, setSelectedEnvId] = useState('');
|
const [selectedEnvId, setSelectedEnvId] = useState('');
|
||||||
const envInitRef = useRef(false);
|
|
||||||
const [pendingDelete, setPendingDelete] = useState<
|
const [pendingDelete, setPendingDelete] = useState<
|
||||||
{ type: 'scenario' } | { type: 'step'; id: string } | { type: 'credential'; id: string } | null
|
{ type: 'scenario' } | { type: 'step'; id: string } | { type: 'credential'; id: string } | null
|
||||||
>(null);
|
>(null);
|
||||||
@@ -95,11 +94,12 @@ export function ScenarioDetailPage() {
|
|||||||
const [exportModalOpen, setExportModalOpen] = useState(false);
|
const [exportModalOpen, setExportModalOpen] = useState(false);
|
||||||
const [includeEnvironment, setIncludeEnvironment] = useState(true);
|
const [includeEnvironment, setIncludeEnvironment] = useState(true);
|
||||||
const [includedCredentialIds, setIncludedCredentialIds] = useState<Set<string>>(new Set());
|
const [includedCredentialIds, setIncludedCredentialIds] = useState<Set<string>>(new Set());
|
||||||
|
const [includedSnippetIds, setIncludedSnippetIds] = useState<Set<string>>(new Set());
|
||||||
const [isExporting, setIsExporting] = useState(false);
|
const [isExporting, setIsExporting] = useState(false);
|
||||||
|
|
||||||
// Files state
|
// Files state
|
||||||
const [files, setFiles] = useState<FileMetadata[]>([]);
|
const [files, setFiles] = useState<FileMetadata[]>([]);
|
||||||
const [filesLoading, setFilesLoading] = useState(false);
|
const [filesLoading, setFilesLoading] = useState(true);
|
||||||
const [uploadOpen, setUploadOpen] = useState(false);
|
const [uploadOpen, setUploadOpen] = useState(false);
|
||||||
const [uploadFile, setUploadFile] = useState<File | null>(null);
|
const [uploadFile, setUploadFile] = useState<File | null>(null);
|
||||||
const [uploadExpiresAt, setUploadExpiresAt] = useState('');
|
const [uploadExpiresAt, setUploadExpiresAt] = useState('');
|
||||||
@@ -107,9 +107,10 @@ export function ScenarioDetailPage() {
|
|||||||
|
|
||||||
const [usedSnippets, setUsedSnippets] = useState<UsedSnippet[]>([]);
|
const [usedSnippets, setUsedSnippets] = useState<UsedSnippet[]>([]);
|
||||||
|
|
||||||
const loadFiles = useCallback(async () => {
|
// Fetches the files; `filesLoading` starts as true for the fetch from the
|
||||||
|
// load effect, and `loadFiles` sets it for reloads (e.g. after an upload)
|
||||||
|
const fetchFiles = useCallback(async () => {
|
||||||
if (!id) return;
|
if (!id) return;
|
||||||
setFilesLoading(true);
|
|
||||||
try {
|
try {
|
||||||
const result = await scenarioFiles.list(id);
|
const result = await scenarioFiles.list(id);
|
||||||
setFiles(result.items);
|
setFiles(result.items);
|
||||||
@@ -118,6 +119,11 @@ export function ScenarioDetailPage() {
|
|||||||
}
|
}
|
||||||
}, [id]);
|
}, [id]);
|
||||||
|
|
||||||
|
const loadFiles = async () => {
|
||||||
|
setFilesLoading(true);
|
||||||
|
await fetchFiles();
|
||||||
|
};
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!id) return;
|
if (!id) return;
|
||||||
void scenarios
|
void scenarios
|
||||||
@@ -127,7 +133,7 @@ export function ScenarioDetailPage() {
|
|||||||
setScenarioCreds(s.scenarioCredentials ?? []);
|
setScenarioCreds(s.scenarioCredentials ?? []);
|
||||||
})
|
})
|
||||||
.finally(() => setLoading(false));
|
.finally(() => setLoading(false));
|
||||||
void loadFiles();
|
void fetchFiles();
|
||||||
scenarios
|
scenarios
|
||||||
.usedSnippets(id)
|
.usedSnippets(id)
|
||||||
.then(setUsedSnippets)
|
.then(setUsedSnippets)
|
||||||
@@ -142,16 +148,25 @@ export function ScenarioDetailPage() {
|
|||||||
setEnvs(r.data);
|
setEnvs(r.data);
|
||||||
})
|
})
|
||||||
.catch(() => {});
|
.catch(() => {});
|
||||||
}, [id, loadFiles]);
|
}, [id, fetchFiles]);
|
||||||
|
|
||||||
// Default selected env to scenario's linked environment (or first env) once both are loaded
|
const openRunModal = () => {
|
||||||
useEffect(() => {
|
// Preselect the scenario's default environment (or the first one) when the
|
||||||
if (envInitRef.current || envs.length === 0) return;
|
// modal opens: by then both are loaded, and it follows default env edits
|
||||||
envInitRef.current = true;
|
|
||||||
const preferred = scenario?.environmentId ?? null;
|
const preferred = scenario?.environmentId ?? null;
|
||||||
const exists = preferred ? envs.some((e) => e.id === preferred) : false;
|
const exists = preferred ? envs.some((e) => e.id === preferred) : false;
|
||||||
setSelectedEnvId(exists ? preferred! : envs[0].id);
|
setSelectedEnvId(exists ? preferred! : (envs[0]?.id ?? ''));
|
||||||
}, [scenario, envs]);
|
setTraceModeOverride(null);
|
||||||
|
setRunVersion(null);
|
||||||
|
setRunVersions([]);
|
||||||
|
if (id) {
|
||||||
|
scenarios
|
||||||
|
.versions(id)
|
||||||
|
.then(setRunVersions)
|
||||||
|
.catch(() => undefined);
|
||||||
|
}
|
||||||
|
setRunModalOpen(true);
|
||||||
|
};
|
||||||
|
|
||||||
const reloadScenario = async () => {
|
const reloadScenario = async () => {
|
||||||
if (!id) return;
|
if (!id) return;
|
||||||
@@ -198,8 +213,9 @@ export function ScenarioDetailPage() {
|
|||||||
|
|
||||||
const handleOpenExportModal = () => {
|
const handleOpenExportModal = () => {
|
||||||
if (!scenario) return;
|
if (!scenario) return;
|
||||||
// Initialise all credential checkboxes to checked
|
// Initialise all credential and snippet checkboxes to checked
|
||||||
setIncludedCredentialIds(new Set(scenarioCreds.map((sc) => sc.credentialId)));
|
setIncludedCredentialIds(new Set(scenarioCreds.map((sc) => sc.credentialId)));
|
||||||
|
setIncludedSnippetIds(new Set(usedSnippets.map((s) => s.id)));
|
||||||
setIncludeEnvironment(true);
|
setIncludeEnvironment(true);
|
||||||
setExportModalOpen(true);
|
setExportModalOpen(true);
|
||||||
};
|
};
|
||||||
@@ -212,6 +228,7 @@ export function ScenarioDetailPage() {
|
|||||||
const yamlContent = await scenarios.exportScenario(scenario.id, {
|
const yamlContent = await scenarios.exportScenario(scenario.id, {
|
||||||
includeEnvironment,
|
includeEnvironment,
|
||||||
credentialIds: credIds,
|
credentialIds: credIds,
|
||||||
|
snippetIds: Array.from(includedSnippetIds),
|
||||||
});
|
});
|
||||||
const blob = new Blob([yamlContent], { type: 'application/yaml' });
|
const blob = new Blob([yamlContent], { type: 'application/yaml' });
|
||||||
const url = URL.createObjectURL(blob);
|
const url = URL.createObjectURL(blob);
|
||||||
@@ -470,21 +487,7 @@ export function ScenarioDetailPage() {
|
|||||||
/>
|
/>
|
||||||
{scenario && (
|
{scenario && (
|
||||||
<div className={styles.toolbarActions}>
|
<div className={styles.toolbarActions}>
|
||||||
<Button
|
<Button size="sm" onClick={openRunModal}>
|
||||||
size="sm"
|
|
||||||
onClick={() => {
|
|
||||||
setTraceModeOverride(null);
|
|
||||||
setRunVersion(null);
|
|
||||||
setRunVersions([]);
|
|
||||||
if (id) {
|
|
||||||
scenarios
|
|
||||||
.versions(id)
|
|
||||||
.then(setRunVersions)
|
|
||||||
.catch(() => undefined);
|
|
||||||
}
|
|
||||||
setRunModalOpen(true);
|
|
||||||
}}
|
|
||||||
>
|
|
||||||
<Play size={14} />
|
<Play size={14} />
|
||||||
{t('scenarios.action_run')}
|
{t('scenarios.action_run')}
|
||||||
</Button>
|
</Button>
|
||||||
@@ -758,7 +761,19 @@ export function ScenarioDetailPage() {
|
|||||||
{
|
{
|
||||||
key: 'name',
|
key: 'name',
|
||||||
header: t('files.name'),
|
header: t('files.name'),
|
||||||
render: (f) => f.name,
|
// Served inline, so the browser shows what it can (images, text, PDF).
|
||||||
|
render: (f) =>
|
||||||
|
isFileExpired(f) ? (
|
||||||
|
f.name
|
||||||
|
) : (
|
||||||
|
<a
|
||||||
|
href={scenarioFiles.contentUrl(id!, f.id)}
|
||||||
|
target="_blank"
|
||||||
|
rel="noopener noreferrer"
|
||||||
|
>
|
||||||
|
{f.name}
|
||||||
|
</a>
|
||||||
|
),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
key: 'mimeType',
|
key: 'mimeType',
|
||||||
@@ -899,6 +914,16 @@ export function ScenarioDetailPage() {
|
|||||||
return next;
|
return next;
|
||||||
});
|
});
|
||||||
}}
|
}}
|
||||||
|
usedSnippets={usedSnippets}
|
||||||
|
includedSnippetIds={includedSnippetIds}
|
||||||
|
onSnippetToggle={(snippetId, checked) => {
|
||||||
|
setIncludedSnippetIds((prev) => {
|
||||||
|
const next = new Set(prev);
|
||||||
|
if (checked) next.add(snippetId);
|
||||||
|
else next.delete(snippetId);
|
||||||
|
return next;
|
||||||
|
});
|
||||||
|
}}
|
||||||
onClose={() => setExportModalOpen(false)}
|
onClose={() => setExportModalOpen(false)}
|
||||||
onExport={handleExport}
|
onExport={handleExport}
|
||||||
isExporting={isExporting}
|
isExporting={isExporting}
|
||||||
|
|||||||
@@ -68,9 +68,10 @@ export function ScenariosPage() {
|
|||||||
const [pageSize, setPageSize] = useState(10);
|
const [pageSize, setPageSize] = useState(10);
|
||||||
const [total, setTotal] = useState(0);
|
const [total, setTotal] = useState(0);
|
||||||
|
|
||||||
const load = useCallback(
|
// Fetches a page; `loading` starts as true for the initial fetch from the
|
||||||
|
// effect, and `load` sets it for later ones (no setState inside the effect)
|
||||||
|
const fetchPage = useCallback(
|
||||||
(orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
(orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
||||||
setLoading(true);
|
|
||||||
Promise.all([
|
Promise.all([
|
||||||
scenarios.list(p, limit, orderBy, orderDir === 'asc' ? 'ASC' : 'DESC'),
|
scenarios.list(p, limit, orderBy, orderDir === 'asc' ? 'ASC' : 'DESC'),
|
||||||
environments.list(1, 200),
|
environments.list(1, 200),
|
||||||
@@ -88,9 +89,14 @@ export function ScenariosPage() {
|
|||||||
[toast],
|
[toast],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
const load = (orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
||||||
|
setLoading(true);
|
||||||
|
fetchPage(orderBy, orderDir, p, limit);
|
||||||
|
};
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
load('updatedAt', 'desc', 1, 10);
|
fetchPage('updatedAt', 'desc', 1, 10);
|
||||||
}, [load]);
|
}, [fetchPage]);
|
||||||
|
|
||||||
const handleSort = (key: string, dir: SortDirection) => {
|
const handleSort = (key: string, dir: SortDirection) => {
|
||||||
setSortBy(key);
|
setSortBy(key);
|
||||||
|
|||||||
@@ -23,7 +23,9 @@ export function SessionsPage() {
|
|||||||
usePageTitle(t('sessions.title'));
|
usePageTitle(t('sessions.title'));
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const [items, setItems] = useState<Session[]>([]);
|
const [items, setItems] = useState<Session[]>([]);
|
||||||
const [loading, setLoading] = useState(true);
|
// Loading until the current query's result has arrived (derived, so the
|
||||||
|
// loading effect doesn't have to set state synchronously)
|
||||||
|
const [loadedQuery, setLoadedQuery] = useState<string | null>(null);
|
||||||
const [deleteId, setDeleteId] = useState<string | null>(null);
|
const [deleteId, setDeleteId] = useState<string | null>(null);
|
||||||
const [deleting, setDeleting] = useState(false);
|
const [deleting, setDeleting] = useState(false);
|
||||||
const [sortBy, setSortBy] = useState('id');
|
const [sortBy, setSortBy] = useState('id');
|
||||||
@@ -32,15 +34,18 @@ export function SessionsPage() {
|
|||||||
const [pageSize, setPageSize] = useState(10);
|
const [pageSize, setPageSize] = useState(10);
|
||||||
const [total, setTotal] = useState(0);
|
const [total, setTotal] = useState(0);
|
||||||
|
|
||||||
|
const query = `${sortBy}|${sortDir}|${page}|${pageSize}`;
|
||||||
|
const loading = loadedQuery !== query;
|
||||||
|
|
||||||
const load = useCallback((orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
const load = useCallback((orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
||||||
setLoading(true);
|
const key = `${orderBy}|${orderDir}|${p}|${limit}`;
|
||||||
sessions
|
sessions
|
||||||
.list(p, limit, orderBy, orderDir === 'asc' ? 'ASC' : 'DESC')
|
.list(p, limit, orderBy, orderDir === 'asc' ? 'ASC' : 'DESC')
|
||||||
.then((res) => {
|
.then((res) => {
|
||||||
setItems(res.data);
|
setItems(res.data);
|
||||||
setTotal(res.total);
|
setTotal(res.total);
|
||||||
})
|
})
|
||||||
.finally(() => setLoading(false));
|
.finally(() => setLoadedQuery(key));
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import { usePageTitle } from '../../hooks/usePageTitle';
|
|||||||
import { X, Save, Braces } from 'lucide-react';
|
import { X, Save, Braces } from 'lucide-react';
|
||||||
import { snippets } from '../../api';
|
import { snippets } from '../../api';
|
||||||
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
||||||
|
import { CodeHelpButton } from '../../components/modals';
|
||||||
import styles from '../Page.module.css';
|
import styles from '../Page.module.css';
|
||||||
|
|
||||||
export function CreateSnippetPage() {
|
export function CreateSnippetPage() {
|
||||||
@@ -107,10 +108,13 @@ export function CreateSnippetPage() {
|
|||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
<div className={styles.formField}>
|
<div className={styles.formField}>
|
||||||
<label className={styles.fieldLabel}>
|
<div className={styles.labelRow}>
|
||||||
{t('snippets.form_code')}
|
<label className={styles.fieldLabel}>
|
||||||
<span className={styles.requiredMark}> *</span>
|
{t('snippets.form_code')}
|
||||||
</label>
|
<span className={styles.requiredMark}> *</span>
|
||||||
|
</label>
|
||||||
|
<CodeHelpButton />
|
||||||
|
</div>
|
||||||
<CodeEditor
|
<CodeEditor
|
||||||
value={code}
|
value={code}
|
||||||
onChange={(v) => {
|
onChange={(v) => {
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import { X, Save, Braces } from 'lucide-react';
|
|||||||
import { snippets } from '../../api';
|
import { snippets } from '../../api';
|
||||||
import type { Snippet } from '../../api';
|
import type { Snippet } from '../../api';
|
||||||
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
import { Breadcrumbs, Button, Card, Input, CodeEditor, useToast } from '../../ui';
|
||||||
|
import { CodeHelpButton } from '../../components/modals';
|
||||||
import styles from '../Page.module.css';
|
import styles from '../Page.module.css';
|
||||||
|
|
||||||
export function EditSnippetPage() {
|
export function EditSnippetPage() {
|
||||||
@@ -134,10 +135,13 @@ export function EditSnippetPage() {
|
|||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
<div className={styles.formField}>
|
<div className={styles.formField}>
|
||||||
<label className={styles.fieldLabel}>
|
<div className={styles.labelRow}>
|
||||||
{t('snippets.form_code')}
|
<label className={styles.fieldLabel}>
|
||||||
<span className={styles.requiredMark}> *</span>
|
{t('snippets.form_code')}
|
||||||
</label>
|
<span className={styles.requiredMark}> *</span>
|
||||||
|
</label>
|
||||||
|
<CodeHelpButton />
|
||||||
|
</div>
|
||||||
<CodeEditor
|
<CodeEditor
|
||||||
value={code}
|
value={code}
|
||||||
onChange={(v) => {
|
onChange={(v) => {
|
||||||
|
|||||||
@@ -71,7 +71,7 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
.active .label {
|
.active .label {
|
||||||
color: var(--color-primary);
|
color: var(--color-primary-text);
|
||||||
font-weight: 600;
|
font-weight: 600;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -83,8 +83,8 @@
|
|||||||
}
|
}
|
||||||
|
|
||||||
.inactive .label {
|
.inactive .label {
|
||||||
|
/* Not dimmed with opacity: muted text already reads as inactive and keeps 4.5:1 */
|
||||||
color: var(--color-text-muted);
|
color: var(--color-text-muted);
|
||||||
opacity: 0.5;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/* ── Error state ──────────────────────────────────────────── */
|
/* ── Error state ──────────────────────────────────────────── */
|
||||||
|
|||||||
@@ -6,12 +6,13 @@ export type BadgeVariant = 'success' | 'error' | 'warning' | 'info' | 'neutral'
|
|||||||
export interface BadgeProps {
|
export interface BadgeProps {
|
||||||
variant?: BadgeVariant;
|
variant?: BadgeVariant;
|
||||||
dot?: boolean;
|
dot?: boolean;
|
||||||
|
className?: string;
|
||||||
children: React.ReactNode;
|
children: React.ReactNode;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function Badge({ variant = 'neutral', dot = false, children }: BadgeProps) {
|
export function Badge({ variant = 'neutral', dot = false, className, children }: BadgeProps) {
|
||||||
return (
|
return (
|
||||||
<span className={[styles.badge, styles[variant]].join(' ')}>
|
<span className={[styles.badge, styles[variant], className].filter(Boolean).join(' ')}>
|
||||||
{dot && <span className={styles.dot} aria-hidden="true" />}
|
{dot && <span className={styles.dot} aria-hidden="true" />}
|
||||||
{children}
|
{children}
|
||||||
</span>
|
</span>
|
||||||
|
|||||||
@@ -18,7 +18,7 @@
|
|||||||
|
|
||||||
.code :global(.hljs-comment),
|
.code :global(.hljs-comment),
|
||||||
.code :global(.hljs-quote) {
|
.code :global(.hljs-quote) {
|
||||||
color: var(--hl-comment, #6A8072);
|
color: var(--hl-comment);
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -27,7 +27,7 @@
|
|||||||
.code :global(.hljs-built_in),
|
.code :global(.hljs-built_in),
|
||||||
.code :global(.hljs-name),
|
.code :global(.hljs-name),
|
||||||
.code :global(.hljs-tag) {
|
.code :global(.hljs-tag) {
|
||||||
color: var(--hl-keyword, #A67DCC);
|
color: var(--hl-keyword);
|
||||||
}
|
}
|
||||||
|
|
||||||
.code :global(.hljs-string),
|
.code :global(.hljs-string),
|
||||||
@@ -39,32 +39,32 @@
|
|||||||
.code :global(.hljs-template-variable),
|
.code :global(.hljs-template-variable),
|
||||||
.code :global(.hljs-type),
|
.code :global(.hljs-type),
|
||||||
.code :global(.hljs-addition) {
|
.code :global(.hljs-addition) {
|
||||||
color: var(--hl-string, #9BB870);
|
color: var(--hl-string);
|
||||||
}
|
}
|
||||||
|
|
||||||
.code :global(.hljs-number),
|
.code :global(.hljs-number),
|
||||||
.code :global(.hljs-regexp),
|
.code :global(.hljs-regexp),
|
||||||
.code :global(.hljs-link) {
|
.code :global(.hljs-link) {
|
||||||
color: var(--hl-number, #E8A85F);
|
color: var(--hl-number);
|
||||||
}
|
}
|
||||||
|
|
||||||
.code :global(.hljs-function),
|
.code :global(.hljs-function),
|
||||||
.code :global(.hljs-title.hljs-function_) {
|
.code :global(.hljs-title.hljs-function_) {
|
||||||
color: var(--hl-function, #5BB8D4);
|
color: var(--hl-function);
|
||||||
}
|
}
|
||||||
|
|
||||||
.code :global(.hljs-variable),
|
.code :global(.hljs-variable),
|
||||||
.code :global(.hljs-params) {
|
.code :global(.hljs-params) {
|
||||||
color: var(--hl-variable, #D4A0A0);
|
color: var(--hl-variable);
|
||||||
}
|
}
|
||||||
|
|
||||||
.code :global(.hljs-property) {
|
.code :global(.hljs-property) {
|
||||||
color: var(--hl-property, #79C0C8);
|
color: var(--hl-property);
|
||||||
}
|
}
|
||||||
|
|
||||||
.code :global(.hljs-deletion),
|
.code :global(.hljs-deletion),
|
||||||
.code :global(.hljs-meta) {
|
.code :global(.hljs-meta) {
|
||||||
color: var(--hl-meta, #A9A3C9);
|
color: var(--hl-meta);
|
||||||
}
|
}
|
||||||
|
|
||||||
.code :global(.hljs-emphasis) {
|
.code :global(.hljs-emphasis) {
|
||||||
|
|||||||
@@ -0,0 +1,147 @@
|
|||||||
|
.root {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
background: var(--color-bg-subtle);
|
||||||
|
border: var(--border-width) solid var(--color-border);
|
||||||
|
border-radius: var(--radius-md);
|
||||||
|
overflow: auto;
|
||||||
|
font-family: var(--font-mono, ui-monospace, 'Cascadia Code', 'Fira Code', monospace);
|
||||||
|
font-size: var(--font-size-xs);
|
||||||
|
/* Where the context/message column starts: timestamp + level + their gaps */
|
||||||
|
--log-body-offset: calc(7em + 4.5em + 2 * var(--space-2));
|
||||||
|
}
|
||||||
|
|
||||||
|
.empty {
|
||||||
|
padding: var(--space-4);
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
font-size: var(--font-size-sm);
|
||||||
|
}
|
||||||
|
|
||||||
|
.line {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: var(--space-1);
|
||||||
|
padding: var(--space-1) var(--space-3);
|
||||||
|
border-left: 3px solid transparent;
|
||||||
|
border-bottom: 1px solid var(--color-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
.line:last-child {
|
||||||
|
border-bottom: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.lineHeader {
|
||||||
|
display: flex;
|
||||||
|
align-items: baseline;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
gap: var(--space-2);
|
||||||
|
}
|
||||||
|
|
||||||
|
.data {
|
||||||
|
margin: 0 0 var(--space-1) var(--log-body-offset);
|
||||||
|
border: var(--border-width) solid var(--color-border);
|
||||||
|
border-radius: var(--radius-sm);
|
||||||
|
background: var(--color-bg);
|
||||||
|
max-width: 100%;
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.data > * {
|
||||||
|
margin: 0;
|
||||||
|
padding: var(--space-2) var(--space-3);
|
||||||
|
}
|
||||||
|
|
||||||
|
.timestamp {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
min-width: 7em;
|
||||||
|
text-align: right;
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
.level {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
width: 4.5em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
font-weight: 700;
|
||||||
|
}
|
||||||
|
|
||||||
|
.context {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
color: var(--color-secondary-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.context::before {
|
||||||
|
content: '[';
|
||||||
|
}
|
||||||
|
|
||||||
|
.context::after {
|
||||||
|
content: ']';
|
||||||
|
}
|
||||||
|
|
||||||
|
.message {
|
||||||
|
flex: 1 1 320px;
|
||||||
|
color: var(--color-text);
|
||||||
|
white-space: pre-wrap;
|
||||||
|
word-break: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
.debug {
|
||||||
|
border-left-color: var(--color-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
.debug .level,
|
||||||
|
.debug .message,
|
||||||
|
.debug .timestamp,
|
||||||
|
.debug .context {
|
||||||
|
color: var(--color-text-faint);
|
||||||
|
}
|
||||||
|
|
||||||
|
.log {
|
||||||
|
border-left-color: var(--color-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
.log .level {
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
}
|
||||||
|
|
||||||
|
.warn {
|
||||||
|
border-left-color: var(--color-warning-fg);
|
||||||
|
background: var(--color-warning-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.warn .level {
|
||||||
|
color: var(--color-warning-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.error {
|
||||||
|
border-left-color: var(--color-error-fg);
|
||||||
|
background: var(--color-error-bg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.error .level {
|
||||||
|
color: var(--color-error-fg);
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataToggle {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: var(--space-1);
|
||||||
|
align-self: flex-start;
|
||||||
|
margin-left: var(--log-body-offset);
|
||||||
|
padding: 0;
|
||||||
|
border: none;
|
||||||
|
background: none;
|
||||||
|
font: inherit;
|
||||||
|
color: var(--color-text);
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataToggle svg {
|
||||||
|
flex: 0 0 auto;
|
||||||
|
color: var(--color-primary-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.dataToggle:hover {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
@@ -0,0 +1,147 @@
|
|||||||
|
import { useMemo, useState } from 'react';
|
||||||
|
import { ChevronDown, ChevronRight } from 'lucide-react';
|
||||||
|
import { CodeBlock } from '../CodeBlock/CodeBlock';
|
||||||
|
import {
|
||||||
|
DEFAULT_LOG_DATA_LIMITS,
|
||||||
|
exceedsLimits,
|
||||||
|
formatElapsed,
|
||||||
|
measureData,
|
||||||
|
prettyData,
|
||||||
|
type LogDataLimits,
|
||||||
|
} from './logText';
|
||||||
|
import styles from './LogOutput.module.css';
|
||||||
|
|
||||||
|
export type LogOutputLevel = 'debug' | 'log' | 'warn' | 'error';
|
||||||
|
|
||||||
|
export interface LogOutputEntry {
|
||||||
|
id: string | number;
|
||||||
|
level: LogOutputLevel;
|
||||||
|
/** Where the message was generated, e.g. "step:2", "snippet:login", "assertion:pass". */
|
||||||
|
context?: string | null;
|
||||||
|
message: string;
|
||||||
|
/** JSON payload attached to the message, as a raw string; rendered pretty-printed, separately from the message. */
|
||||||
|
data?: string | null;
|
||||||
|
createdAt: string | number | Date;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface LogOutputProps {
|
||||||
|
entries: LogOutputEntry[];
|
||||||
|
/** Reference point for the elapsed-time column; defaults to the first entry's timestamp. */
|
||||||
|
startTime?: string | number | Date;
|
||||||
|
/** Caps the block's height (e.g. "400px"), scrolling once entries overflow it. */
|
||||||
|
maxHeight?: string | number;
|
||||||
|
emptyMessage?: string;
|
||||||
|
className?: string;
|
||||||
|
/** Data blocks whose pretty-printed JSON exceeds either limit start collapsed behind a toggle. */
|
||||||
|
dataLimits?: LogDataLimits;
|
||||||
|
/**
|
||||||
|
* Expands (true) or collapses (false) every large data block. Changing it
|
||||||
|
* discards the per-entry toggles made since the last change.
|
||||||
|
*/
|
||||||
|
dataExpanded?: boolean;
|
||||||
|
/** Label of a collapsed data block's toggle, e.g. "Show data (1.2 KB, 40 lines)". */
|
||||||
|
showDataLabel?: (size: { bytes: number; lines: number }) => string;
|
||||||
|
hideDataLabel?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatBytes(bytes: number): string {
|
||||||
|
return bytes < 1024 ? `${bytes} B` : `${(bytes / 1024).toFixed(1)} KB`;
|
||||||
|
}
|
||||||
|
|
||||||
|
const defaultShowDataLabel = ({ bytes, lines }: { bytes: number; lines: number }) =>
|
||||||
|
`Show data (${formatBytes(bytes)}, ${lines} ${lines === 1 ? 'line' : 'lines'})`;
|
||||||
|
|
||||||
|
/** Terminal-style log viewer: one line per entry, color-coded by level. */
|
||||||
|
export function LogOutput({
|
||||||
|
entries,
|
||||||
|
startTime,
|
||||||
|
maxHeight,
|
||||||
|
emptyMessage = 'No logs.',
|
||||||
|
className,
|
||||||
|
dataLimits = DEFAULT_LOG_DATA_LIMITS,
|
||||||
|
dataExpanded = false,
|
||||||
|
showDataLabel = defaultShowDataLabel,
|
||||||
|
hideDataLabel = 'Hide data',
|
||||||
|
}: LogOutputProps) {
|
||||||
|
// Per-entry toggles, reset whenever dataExpanded changes
|
||||||
|
const [toggled, setToggled] = useState<Set<LogOutputEntry['id']>>(() => new Set());
|
||||||
|
const [prevDataExpanded, setPrevDataExpanded] = useState(dataExpanded);
|
||||||
|
if (prevDataExpanded !== dataExpanded) {
|
||||||
|
setPrevDataExpanded(dataExpanded);
|
||||||
|
setToggled(new Set());
|
||||||
|
}
|
||||||
|
|
||||||
|
const dataBlocks = useMemo(() => {
|
||||||
|
const blocks = new Map<
|
||||||
|
LogOutputEntry['id'],
|
||||||
|
{ pretty: string; bytes: number; lines: number }
|
||||||
|
>();
|
||||||
|
for (const entry of entries) {
|
||||||
|
if (!entry.data) continue;
|
||||||
|
const pretty = prettyData(entry.data);
|
||||||
|
blocks.set(entry.id, { pretty, ...measureData(pretty) });
|
||||||
|
}
|
||||||
|
return blocks;
|
||||||
|
}, [entries]);
|
||||||
|
|
||||||
|
const toggle = (id: LogOutputEntry['id']) =>
|
||||||
|
setToggled((prev) => {
|
||||||
|
const next = new Set(prev);
|
||||||
|
if (!next.delete(id)) next.add(id);
|
||||||
|
return next;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (entries.length === 0) {
|
||||||
|
return <div className={styles.empty}>{emptyMessage}</div>;
|
||||||
|
}
|
||||||
|
|
||||||
|
const startMs = new Date(startTime ?? entries[0].createdAt).getTime();
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
className={[styles.root, className].filter(Boolean).join(' ')}
|
||||||
|
style={maxHeight !== undefined ? { maxHeight } : undefined}
|
||||||
|
role="log"
|
||||||
|
tabIndex={0}
|
||||||
|
>
|
||||||
|
{entries.map((entry) => {
|
||||||
|
const entryMs = new Date(entry.createdAt).getTime();
|
||||||
|
const block = dataBlocks.get(entry.id);
|
||||||
|
const large = block != null && exceedsLimits(block, dataLimits);
|
||||||
|
const open = !large || dataExpanded !== toggled.has(entry.id);
|
||||||
|
return (
|
||||||
|
<div key={entry.id} className={[styles.line, styles[entry.level]].join(' ')}>
|
||||||
|
<div className={styles.lineHeader}>
|
||||||
|
<span className={styles.timestamp} title={new Date(entryMs).toISOString()}>
|
||||||
|
{formatElapsed(entryMs - startMs)}
|
||||||
|
</span>
|
||||||
|
<span className={styles.level}>{entry.level}</span>
|
||||||
|
{entry.context && <span className={styles.context}>{entry.context}</span>}
|
||||||
|
<span className={styles.message}>{entry.message}</span>
|
||||||
|
</div>
|
||||||
|
{block && large && (
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
className={styles.dataToggle}
|
||||||
|
aria-expanded={open}
|
||||||
|
onClick={() => toggle(entry.id)}
|
||||||
|
>
|
||||||
|
{open ? (
|
||||||
|
<ChevronDown size={14} strokeWidth={3} aria-hidden="true" />
|
||||||
|
) : (
|
||||||
|
<ChevronRight size={14} strokeWidth={3} aria-hidden="true" />
|
||||||
|
)}
|
||||||
|
{open ? hideDataLabel : showDataLabel(block)}
|
||||||
|
</button>
|
||||||
|
)}
|
||||||
|
{block && open && (
|
||||||
|
<div className={styles.data}>
|
||||||
|
<CodeBlock code={block.pretty} language="json" />
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
import type { LogOutputEntry } from './LogOutput';
|
||||||
|
|
||||||
|
/** Data blocks above either limit start collapsed. */
|
||||||
|
export interface LogDataLimits {
|
||||||
|
/** UTF-8 byte size of the pretty-printed data. */
|
||||||
|
bytes: number;
|
||||||
|
/** Line count of the pretty-printed data. */
|
||||||
|
lines: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const DEFAULT_LOG_DATA_LIMITS: LogDataLimits = { bytes: 256, lines: 5 };
|
||||||
|
|
||||||
|
const encoder = new TextEncoder();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* "+12s" (or "-" if before startTime, e.g. clock skew). Log timestamps are
|
||||||
|
* stored with second resolution, so fractions would be noise.
|
||||||
|
*/
|
||||||
|
export function formatElapsed(deltaMs: number): string {
|
||||||
|
const sign = deltaMs < 0 ? '-' : '+';
|
||||||
|
return `${sign}${Math.round(Math.abs(deltaMs) / 1000)}s`;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Pretty-prints `data` if it's valid JSON, otherwise returns it as-is. */
|
||||||
|
export function prettyData(data: string): string {
|
||||||
|
try {
|
||||||
|
return JSON.stringify(JSON.parse(data), null, 2);
|
||||||
|
} catch {
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Byte size and line count of an already pretty-printed data block. */
|
||||||
|
export function measureData(pretty: string): { bytes: number; lines: number } {
|
||||||
|
return { bytes: encoder.encode(pretty).length, lines: pretty.split('\n').length };
|
||||||
|
}
|
||||||
|
|
||||||
|
export function exceedsLimits(size: { bytes: number; lines: number }, limits: LogDataLimits) {
|
||||||
|
return size.bytes > limits.bytes || size.lines > limits.lines;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** True if any entry's data block exceeds the limits (i.e. renders collapsed by default). */
|
||||||
|
export function hasLargeData(
|
||||||
|
entries: Pick<LogOutputEntry, 'data'>[],
|
||||||
|
limits: LogDataLimits = DEFAULT_LOG_DATA_LIMITS,
|
||||||
|
): boolean {
|
||||||
|
return entries.some((e) => e.data && exceedsLimits(measureData(prettyData(e.data)), limits));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Plain-text rendering of the log, one entry per line with every data block
|
||||||
|
* pretty-printed and indented below its line (e.g. for copying to the clipboard).
|
||||||
|
*/
|
||||||
|
export function formatLogText(
|
||||||
|
entries: LogOutputEntry[],
|
||||||
|
startTime?: string | number | Date,
|
||||||
|
): string {
|
||||||
|
if (entries.length === 0) return '';
|
||||||
|
const startMs = new Date(startTime ?? entries[0].createdAt).getTime();
|
||||||
|
return entries
|
||||||
|
.map((entry) => {
|
||||||
|
const elapsed = formatElapsed(new Date(entry.createdAt).getTime() - startMs);
|
||||||
|
const context = entry.context ? ` [${entry.context}]` : '';
|
||||||
|
const header = `${elapsed.padStart(6)} ${entry.level.toUpperCase().padEnd(5)}${context} ${entry.message}`;
|
||||||
|
if (!entry.data) return header;
|
||||||
|
const data = prettyData(entry.data)
|
||||||
|
.split('\n')
|
||||||
|
.map((line) => ` ${line}`)
|
||||||
|
.join('\n');
|
||||||
|
return `${header}\n${data}`;
|
||||||
|
})
|
||||||
|
.join('\n');
|
||||||
|
}
|
||||||
@@ -16,6 +16,13 @@
|
|||||||
border-radius: var(--radius-lg);
|
border-radius: var(--radius-lg);
|
||||||
box-shadow: 0 20px 48px color-mix(in srgb, #000 28%, transparent);
|
box-shadow: 0 20px 48px color-mix(in srgb, #000 28%, transparent);
|
||||||
overflow: hidden;
|
overflow: hidden;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
max-height: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.lg {
|
||||||
|
width: min(880px, 100%);
|
||||||
}
|
}
|
||||||
|
|
||||||
.header {
|
.header {
|
||||||
@@ -31,6 +38,7 @@
|
|||||||
.body {
|
.body {
|
||||||
padding: var(--space-2) var(--space-5) var(--space-4);
|
padding: var(--space-2) var(--space-5) var(--space-4);
|
||||||
color: var(--color-text-muted);
|
color: var(--color-text-muted);
|
||||||
|
overflow-y: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
.footer {
|
.footer {
|
||||||
|
|||||||
@@ -7,9 +7,11 @@ export interface ModalProps {
|
|||||||
children?: React.ReactNode;
|
children?: React.ReactNode;
|
||||||
onClose: () => void;
|
onClose: () => void;
|
||||||
footer?: React.ReactNode;
|
footer?: React.ReactNode;
|
||||||
|
/** `lg` widens the dialog for long, document-like content. */
|
||||||
|
size?: 'md' | 'lg';
|
||||||
}
|
}
|
||||||
|
|
||||||
export function Modal({ open, title, children, onClose, footer }: ModalProps) {
|
export function Modal({ open, title, children, onClose, footer, size = 'md' }: ModalProps) {
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (!open) return;
|
if (!open) return;
|
||||||
const onKeyDown = (event: KeyboardEvent) => {
|
const onKeyDown = (event: KeyboardEvent) => {
|
||||||
@@ -24,7 +26,7 @@ export function Modal({ open, title, children, onClose, footer }: ModalProps) {
|
|||||||
return (
|
return (
|
||||||
<div className={styles.overlay} role="presentation" onClick={onClose}>
|
<div className={styles.overlay} role="presentation" onClick={onClose}>
|
||||||
<div
|
<div
|
||||||
className={styles.dialog}
|
className={size === 'lg' ? `${styles.dialog} ${styles.lg}` : styles.dialog}
|
||||||
role="dialog"
|
role="dialog"
|
||||||
aria-modal="true"
|
aria-modal="true"
|
||||||
aria-label={title}
|
aria-label={title}
|
||||||
@@ -33,7 +35,10 @@ export function Modal({ open, title, children, onClose, footer }: ModalProps) {
|
|||||||
<div className={styles.header}>
|
<div className={styles.header}>
|
||||||
<h3 className={styles.title}>{title}</h3>
|
<h3 className={styles.title}>{title}</h3>
|
||||||
</div>
|
</div>
|
||||||
<div className={styles.body}>{children}</div>
|
{/* Long (lg) content scrolls; make it focusable so the keyboard can scroll it. */}
|
||||||
|
<div className={styles.body} tabIndex={size === 'lg' ? 0 : undefined}>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
{footer && <div className={styles.footer}>{footer}</div>}
|
{footer && <div className={styles.footer}>{footer}</div>}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
.wrapper {
|
||||||
|
display: flex;
|
||||||
|
align-items: flex-start;
|
||||||
|
gap: var(--space-3);
|
||||||
|
}
|
||||||
|
|
||||||
|
.content {
|
||||||
|
flex: 1;
|
||||||
|
min-width: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.placeholder {
|
||||||
|
margin: 0;
|
||||||
|
color: var(--color-text-muted);
|
||||||
|
font-size: var(--font-size-sm);
|
||||||
|
line-height: 1.6;
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
import { useState } from 'react';
|
||||||
|
import { useTranslation } from 'react-i18next';
|
||||||
|
import { Eye, EyeOff } from 'lucide-react';
|
||||||
|
import { Button } from '../Button/Button';
|
||||||
|
import { CodeBlock } from '../CodeBlock/CodeBlock';
|
||||||
|
import styles from './RevealableCodeBlock.module.css';
|
||||||
|
|
||||||
|
export interface RevealableCodeBlockProps {
|
||||||
|
code: string;
|
||||||
|
language?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A CodeBlock that starts hidden; the code is only rendered after the user reveals it. */
|
||||||
|
export function RevealableCodeBlock({ code, language }: RevealableCodeBlockProps) {
|
||||||
|
const { t } = useTranslation();
|
||||||
|
const [revealed, setRevealed] = useState(false);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className={styles.wrapper}>
|
||||||
|
<div className={styles.content}>
|
||||||
|
{revealed ? (
|
||||||
|
<CodeBlock code={code} language={language} />
|
||||||
|
) : (
|
||||||
|
<p className={styles.placeholder}>{t('revealable.hidden')}</p>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
<Button
|
||||||
|
variant="secondary"
|
||||||
|
size="sm"
|
||||||
|
aria-expanded={revealed}
|
||||||
|
onClick={() => setRevealed((r) => !r)}
|
||||||
|
>
|
||||||
|
{revealed ? <EyeOff size={14} /> : <Eye size={14} />}
|
||||||
|
{revealed ? t('revealable.hide') : t('revealable.reveal')}
|
||||||
|
</Button>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -49,7 +49,7 @@
|
|||||||
|
|
||||||
.sortIconActive {
|
.sortIconActive {
|
||||||
opacity: 1;
|
opacity: 1;
|
||||||
color: var(--color-primary);
|
color: var(--color-primary-text);
|
||||||
}
|
}
|
||||||
|
|
||||||
[data-theme="dark"] .th {
|
[data-theme="dark"] .th {
|
||||||
|
|||||||
@@ -4,6 +4,23 @@
|
|||||||
position: relative;
|
position: relative;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.badge {
|
||||||
|
transition: background var(--transition);
|
||||||
|
}
|
||||||
|
|
||||||
|
.badge:hover {
|
||||||
|
background: color-mix(in srgb, var(--color-neutral-bg) 85%, white);
|
||||||
|
}
|
||||||
|
|
||||||
|
.swatch {
|
||||||
|
width: 8px;
|
||||||
|
height: 8px;
|
||||||
|
border-radius: 50%;
|
||||||
|
border: 1px solid currentColor;
|
||||||
|
box-sizing: border-box;
|
||||||
|
flex-shrink: 0;
|
||||||
|
}
|
||||||
|
|
||||||
.button {
|
.button {
|
||||||
all: unset;
|
all: unset;
|
||||||
cursor: pointer;
|
cursor: pointer;
|
||||||
|
|||||||
@@ -7,9 +7,15 @@ export interface UuidBadgeProps {
|
|||||||
id: string;
|
id: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function uuidColor(id: string): string | null {
|
||||||
|
const hex = id.replace(/-/g, '').slice(0, 6);
|
||||||
|
return /^[0-9a-f]{6}$/i.test(hex) ? `#${hex}` : null;
|
||||||
|
}
|
||||||
|
|
||||||
export function UuidBadge({ id }: UuidBadgeProps) {
|
export function UuidBadge({ id }: UuidBadgeProps) {
|
||||||
const [copied, setCopied] = useState(false);
|
const [copied, setCopied] = useState(false);
|
||||||
const short = `${id.slice(0, 4)}…${id.slice(-4)}`;
|
const short = `${id.slice(0, 4)}…${id.slice(-4)}`;
|
||||||
|
const color = uuidColor(id);
|
||||||
|
|
||||||
const handleClick = (e: React.MouseEvent) => {
|
const handleClick = (e: React.MouseEvent) => {
|
||||||
e.stopPropagation();
|
e.stopPropagation();
|
||||||
@@ -21,7 +27,10 @@ export function UuidBadge({ id }: UuidBadgeProps) {
|
|||||||
|
|
||||||
return (
|
return (
|
||||||
<span className={styles.wrapper} title={copied ? 'Copied!' : id}>
|
<span className={styles.wrapper} title={copied ? 'Copied!' : id}>
|
||||||
<Badge variant="neutral">
|
<Badge variant="neutral" className={styles.badge}>
|
||||||
|
{color && (
|
||||||
|
<span className={styles.swatch} style={{ background: color }} aria-hidden="true" />
|
||||||
|
)}
|
||||||
<button type="button" className={styles.button} onClick={handleClick}>
|
<button type="button" className={styles.button} onClick={handleClick}>
|
||||||
{short}
|
{short}
|
||||||
</button>
|
</button>
|
||||||
|
|||||||
@@ -43,6 +43,9 @@ export type { SearchProps } from './Search/Search';
|
|||||||
export { CodeBlock } from './CodeBlock/CodeBlock';
|
export { CodeBlock } from './CodeBlock/CodeBlock';
|
||||||
export type { CodeBlockProps } from './CodeBlock/CodeBlock';
|
export type { CodeBlockProps } from './CodeBlock/CodeBlock';
|
||||||
|
|
||||||
|
export { RevealableCodeBlock } from './RevealableCodeBlock/RevealableCodeBlock';
|
||||||
|
export type { RevealableCodeBlockProps } from './RevealableCodeBlock/RevealableCodeBlock';
|
||||||
|
|
||||||
export { CodeEditor } from './CodeEditor/CodeEditor';
|
export { CodeEditor } from './CodeEditor/CodeEditor';
|
||||||
export type { CodeEditorProps } from './CodeEditor/CodeEditor';
|
export type { CodeEditorProps } from './CodeEditor/CodeEditor';
|
||||||
|
|
||||||
@@ -66,3 +69,8 @@ export type { TableProps, TableColumn, SortDirection } from './Table/Table';
|
|||||||
|
|
||||||
export { UuidBadge } from './UuidBadge/UuidBadge';
|
export { UuidBadge } from './UuidBadge/UuidBadge';
|
||||||
export type { UuidBadgeProps } from './UuidBadge/UuidBadge';
|
export type { UuidBadgeProps } from './UuidBadge/UuidBadge';
|
||||||
|
|
||||||
|
export { LogOutput } from './LogOutput/LogOutput';
|
||||||
|
export type { LogOutputProps, LogOutputEntry, LogOutputLevel } from './LogOutput/LogOutput';
|
||||||
|
export { DEFAULT_LOG_DATA_LIMITS, formatLogText, hasLargeData } from './LogOutput/logText';
|
||||||
|
export type { LogDataLimits } from './LogOutput/logText';
|
||||||
@@ -11,6 +11,8 @@
|
|||||||
--color-primary-hover: #8ABD2E;
|
--color-primary-hover: #8ABD2E;
|
||||||
--color-primary-active: #77A320;
|
--color-primary-active: #77A320;
|
||||||
--color-primary-fg: #2D3339; /* Outer Space on bright green */
|
--color-primary-fg: #2D3339; /* Outer Space on bright green */
|
||||||
|
/* Primary as text/icon color on light surfaces (Atlantis is too light for text) */
|
||||||
|
--color-primary-text: #496904;
|
||||||
|
|
||||||
/* Secondary — Kimberly tint */
|
/* Secondary — Kimberly tint */
|
||||||
--color-secondary: #EDEAF8;
|
--color-secondary: #EDEAF8;
|
||||||
@@ -19,8 +21,8 @@
|
|||||||
--color-secondary-fg: #6650C0; /* Kimberly */
|
--color-secondary-fg: #6650C0; /* Kimberly */
|
||||||
--color-secondary-border: #B8B0E0;
|
--color-secondary-border: #B8B0E0;
|
||||||
|
|
||||||
/* Danger */
|
/* Danger (white text needs >= 4.5:1) */
|
||||||
--color-danger: #D94F4F;
|
--color-danger: #CE4546;
|
||||||
--color-danger-hover: #C03A3A;
|
--color-danger-hover: #C03A3A;
|
||||||
--color-danger-fg: #ffffff;
|
--color-danger-fg: #ffffff;
|
||||||
|
|
||||||
@@ -43,11 +45,22 @@
|
|||||||
--color-link-hover: #3D2F80;
|
--color-link-hover: #3D2F80;
|
||||||
|
|
||||||
--color-text: #2D3339;
|
--color-text: #2D3339;
|
||||||
--color-text-muted: #6650C0; /* Kimberly */
|
--color-text-muted: #634DBD; /* Kimberly, a touch darker for 4.5:1 on bg-subtle */
|
||||||
|
--color-text-faint: #5C6063; /* desaturated grey, ~4.5:1 on bg-subtle - as washed out as WCAG AA allows */
|
||||||
--color-border: #AFBFB9; /* Powder Ash */
|
--color-border: #AFBFB9; /* Powder Ash */
|
||||||
--color-bg: #E6EDEA; /* Powder Ash tint */
|
--color-bg: #E6EDEA; /* Powder Ash tint */
|
||||||
--color-bg-subtle: #D8E2DE; /* Powder Ash tint, 1 step darker */
|
--color-bg-subtle: #D8E2DE; /* Powder Ash tint, 1 step darker */
|
||||||
|
|
||||||
|
/* Syntax highlighting (CodeBlock); each >= 4.5:1 on bg and bg-subtle */
|
||||||
|
--hl-comment: #4F6557;
|
||||||
|
--hl-keyword: #764E99;
|
||||||
|
--hl-string: #4F6821;
|
||||||
|
--hl-number: #895403;
|
||||||
|
--hl-function: #056980;
|
||||||
|
--hl-variable: #815354;
|
||||||
|
--hl-property: #1D6971;
|
||||||
|
--hl-meta: #615B7E;
|
||||||
|
|
||||||
/* Spacing */
|
/* Spacing */
|
||||||
--space-1: 4px;
|
--space-1: 4px;
|
||||||
--space-2: 8px;
|
--space-2: 8px;
|
||||||
@@ -112,6 +125,7 @@ a:hover {
|
|||||||
--color-primary-hover: #AEDE55;
|
--color-primary-hover: #AEDE55;
|
||||||
--color-primary-active: #8ABD2E;
|
--color-primary-active: #8ABD2E;
|
||||||
--color-primary-fg: #1A1F24;
|
--color-primary-fg: #1A1F24;
|
||||||
|
--color-primary-text: #9DD341;
|
||||||
|
|
||||||
/* Secondary — dark Kimberly tint */
|
/* Secondary — dark Kimberly tint */
|
||||||
--color-secondary: #2A2548;
|
--color-secondary: #2A2548;
|
||||||
@@ -122,7 +136,7 @@ a:hover {
|
|||||||
|
|
||||||
/* Danger */
|
/* Danger */
|
||||||
--color-danger: #E06060;
|
--color-danger: #E06060;
|
||||||
--color-danger-hover: #CC4A4A;
|
--color-danger-hover: #F06E6D; /* lighter, so the dark text keeps >= 4.5:1 */
|
||||||
--color-danger-fg: #1A1F24;
|
--color-danger-fg: #1A1F24;
|
||||||
|
|
||||||
/* Semantic */
|
/* Semantic */
|
||||||
@@ -145,7 +159,18 @@ a:hover {
|
|||||||
|
|
||||||
--color-text: #E2EAE6;
|
--color-text: #E2EAE6;
|
||||||
--color-text-muted: #A9A3C9; /* lightened Kimberly */
|
--color-text-muted: #A9A3C9; /* lightened Kimberly */
|
||||||
|
--color-text-faint: #9A9A9A; /* desaturated grey, ~4.5:1 on dark bg-subtle - as washed out as WCAG AA allows */
|
||||||
--color-border: #3D4850;
|
--color-border: #3D4850;
|
||||||
--color-bg: #1A1F24; /* deeper than Outer Space */
|
--color-bg: #1A1F24; /* deeper than Outer Space */
|
||||||
--color-bg-subtle: #2D3339; /* Outer Space */
|
--color-bg-subtle: #2D3339; /* Outer Space */
|
||||||
|
|
||||||
|
/* Syntax highlighting (CodeBlock); each >= 4.5:1 on bg and bg-subtle */
|
||||||
|
--hl-comment: #8AA192;
|
||||||
|
--hl-keyword: #B38ADA;
|
||||||
|
--hl-string: #9BB870;
|
||||||
|
--hl-number: #E8A85F;
|
||||||
|
--hl-function: #5BB8D4;
|
||||||
|
--hl-variable: #D4A0A0;
|
||||||
|
--hl-property: #79C0C8;
|
||||||
|
--hl-meta: #A9A3C9;
|
||||||
}
|
}
|
||||||
+6
-4
@@ -3,13 +3,15 @@ services:
|
|||||||
build:
|
build:
|
||||||
context: .
|
context: .
|
||||||
ports:
|
ports:
|
||||||
# UI, REST API (/api/v1), MCP (/mcp) and Swagger (/docs)
|
# UI, REST API (/api/v1), MCP (/mcp) and Swagger (/docs).
|
||||||
|
# The production CORS origins (server/src/common/cors.ts) use this port;
|
||||||
|
# set CORS_ORIGINS in .env when publishing it elsewhere.
|
||||||
- "13000:3000"
|
- "13000:3000"
|
||||||
|
# Optional overrides (see .env.example); every setting has a default
|
||||||
env_file:
|
env_file:
|
||||||
- .env
|
- path: .env
|
||||||
|
required: false
|
||||||
volumes:
|
volumes:
|
||||||
# persist SQLite database across restarts
|
# persist SQLite database across restarts
|
||||||
- ./data:/app/data
|
- ./data:/app/data
|
||||||
# mount key files into the container
|
|
||||||
- ./keys:/app/keys
|
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
+70
-38
@@ -1,50 +1,82 @@
|
|||||||
# Architecture
|
# Architecture
|
||||||
|
|
||||||
```
|
```
|
||||||
┌──────────────────────────────────────────────────────┐
|
Browser (React SPA) MCP client (AI agent, IDE)
|
||||||
│ Browser (React SPA - client/) │
|
│ / and /api/v1 │ /mcp (Streamable HTTP)
|
||||||
│ │
|
└──────────────┬──────────────────┘
|
||||||
│ Environments Credentials Snippets │
|
▼
|
||||||
│ Sessions Scenarios Runs │
|
┌─────────────────────────────────────────────────────────────┐
|
||||||
└─────────────────────────────┬────────────────────────┘
|
│ liqa container (:13000 → 3000) NestJS app, server/src/ │
|
||||||
│ HTTP REST (:13000)
|
│ │
|
||||||
│
|
│ Routes / built client (ServeStaticModule) │
|
||||||
MCP client (AI agent / VS Code Copilot)
|
│ /api/v1 REST API /docs Swagger UI │
|
||||||
│ HTTP /mcp (Streamable MCP)
|
│ /mcp MCP tools /health health check │
|
||||||
▼
|
│ /manifest.json public client configuration │
|
||||||
┌──────────────────────────────────────────────────────┐
|
│ │
|
||||||
│ NestJS app (server/src/) │
|
│ McpService MCP tools → services below │
|
||||||
│ │
|
│ ScenarioService scenarios, steps, versions, runs │
|
||||||
│ McpService all MCP tools │
|
│ ScenarioSchedulerService @Interval(1 s) run worker │
|
||||||
│ SessionService session persistence │
|
│ E2eExportService standalone Playwright test zip │
|
||||||
│ SessionContextService live browser contexts │
|
│ SnippetService snippets + versions │
|
||||||
│ EnvironmentService environment CRUD + import │
|
│ EnvironmentService environments │
|
||||||
│ CredentialService credential CRUD + import │
|
│ CredentialService credentials │
|
||||||
│ SnippetService snippet CRUD + import │
|
│ ImportService central YAML import │
|
||||||
│ BrowserService ad-hoc open/exec │
|
│ FileStorageService scenario files + run artifacts │
|
||||||
│ CodeExecutorService sandboxed JS runtime │
|
│ SessionService saved browser sessions │
|
||||||
│ ScenarioService scenarios/steps/runs CRUD │
|
│ SessionContextService live Playwright contexts │
|
||||||
│ ScenarioSchedulerService @Interval(1 s) run worker │
|
│ SessionSchedulerService @Interval(60 s) session cleanup │
|
||||||
└───────────────────────┬──────────────────────────────┘
|
│ BrowserService ad-hoc open / exec │
|
||||||
│ better-sqlite3 (TypeORM)
|
│ CodeExecutorService runs step / snippet JS │
|
||||||
▼
|
└───────────────┬─────────────────────────────┬───────────────┘
|
||||||
data/sessions.db
|
│ TypeORM (better-sqlite3) │ Playwright
|
||||||
|
▼ ▼
|
||||||
|
data/liqa.db, data/files/ chromium-headless-shell
|
||||||
```
|
```
|
||||||
|
|
||||||
- **McpService** registers MCP tools and delegates to session, environment, browser, and scenario services.
|
Everything runs in one container built from the root `Dockerfile`: the server serves the API, MCP and Swagger, and also the built client. See [development.md](development.md) for running it.
|
||||||
- **SessionService** persists session records in SQLite. **SessionContextService** manages live Playwright contexts for open sessions.
|
|
||||||
- **EnvironmentService**, **CredentialService**, and **SnippetService** provide CRUD plus import/export upserts.
|
## Server components (`server/src/`)
|
||||||
- **BrowserService** handles stateless ad-hoc automation (`/open`, `/exec`) and session-aware browsing.
|
|
||||||
- **CodeExecutorService** validates and executes user JS with `page`, `context`, and helper APIs.
|
- **McpService** (`mcp/`) registers the MCP tools and delegates to the services below. Each request gets a fresh MCP server over the Streamable HTTP transport.
|
||||||
- **ScenarioService** manages scenarios, steps, credential aliases, runs, logs, and scenario import/export.
|
- **ScenarioService** (`scenario/`) manages scenarios, steps, credential aliases, versions, runs, run logs, scenario/run files, and scenario export/import.
|
||||||
- **ScenarioSchedulerService** polls pending runs every second and executes step runs to completion.
|
- **ScenarioSchedulerService** picks up pending runs every second (up to 10 in parallel) and executes their steps in order in one Playwright browser per run. It handles step and scenario timeouts, failure page dumps (screenshot + HTML), Playwright traces, and saving the browser as a session (`saveSession`).
|
||||||
|
- **E2eExportService** builds a standalone Playwright test project (zip) from a scenario, bundling the snippets, credentials and files it uses.
|
||||||
|
- **SnippetService** (`snippet/`), **EnvironmentService** (`environment/`) and **CredentialService** (`credential/`) provide CRUD plus export/import.
|
||||||
|
- **ImportService** (`import/`) implements `POST /import`: validates a YAML stream of mixed items, then imports them in dependency order (environments, credentials, snippets, scenarios).
|
||||||
|
- **FileStorageService** (`file/`) stores uploaded scenario files and run artifacts under `FILES_DIR`, and deletes expired files on a cron schedule (`FILE_CLEANUP_CRON`).
|
||||||
|
- **SessionService** (`session/`) persists saved sessions (cookies, localStorage); **SessionContextService** keeps their live Playwright contexts; **SessionSchedulerService** closes idle sessions and deletes old closed ones every minute.
|
||||||
|
- **BrowserService** (`browser/`) handles ad-hoc automation (`POST /api/v1/open`, `POST /api/v1/exec`, and the `open_url` / `exec_code` MCP tools), optionally in a saved session.
|
||||||
|
- **CodeExecutorService** (`code-executor/`) checks step and snippet code with acorn, then runs it with the `context` API (page, environment values, credentials, snippets, files, assertions, logs). It is not a security sandbox: step code is trusted.
|
||||||
|
|
||||||
|
Cross-cutting pieces:
|
||||||
|
|
||||||
|
- `config/app.config.ts` - all settings, validated at startup (see `.env.example`).
|
||||||
|
- `database/` - the entity list, TypeORM data source options (shared by the app, the migration runner and the TypeORM CLI), the migration runner and the migrations.
|
||||||
|
- `common/app-package.ts` - app name and version, read from the workspace root `package.json`.
|
||||||
|
- `common/client-static.ts` - serving the built client, with the `index.html` fallback for client-side routes.
|
||||||
|
- `common/body-parsers.ts` - YAML request bodies (`application/yaml`) for the import endpoint.
|
||||||
|
- `interceptors/` - a trace id per request (kept in `AsyncLocalStorage` and added to log lines) and request/response logging; `filters/` - consistent error responses.
|
||||||
|
|
||||||
|
## Data
|
||||||
|
|
||||||
|
SQLite via TypeORM. The schema is managed by migrations (`server/src/database/migrations/`, registered in `migrations/index.ts`); `synchronize` is off. The Docker container applies pending migrations (`node dist/database/migrate`) before starting the server, and the server refuses to start while migrations are pending. See "Database migrations" in [development.md](development.md). The main tables:
|
||||||
|
|
||||||
|
- `scenarios` / `scenario_steps` hold the **latest** version of each scenario; `scenario_versions` holds a snapshot of every version (content + steps).
|
||||||
|
- `snippets` holds the latest version of each snippet; `snippet_versions` holds every version. Step code pins a version with `runSnippet("alias@N")`.
|
||||||
|
- `scenario_runs` record the scenario version, environment, trace mode and status; `scenario_run_steps` keep their own copy of each step's code, so a run always shows what it executed; `scenario_run_logs` hold ordered run logs.
|
||||||
|
- `files` + `scenario_files` / `scenario_run_files` map stored files to scenarios and runs.
|
||||||
|
- `environments`, `credentials`, `scenario_credentials` (alias → credential per scenario), `sessions`.
|
||||||
|
|
||||||
|
See [scenario.md](scenario.md) for versioning, runs and import/export rules.
|
||||||
|
|
||||||
## Client (`client/`)
|
## Client (`client/`)
|
||||||
|
|
||||||
A React 19 + TypeScript SPA served by the Vite dev server during development. In the Docker image the server serves the built client itself (`ServeStaticModule`, see `server/src/common/client-static.ts`), from the same origin as the API.
|
A React 19 + TypeScript SPA. During development it's served by the Vite dev server; in the Docker image the server serves the built client from the same origin as the API.
|
||||||
|
|
||||||
The client calls the server REST endpoints directly — there is no separate BFF layer. Routing uses `BrowserRouter`; the server answers any GET outside `/api`, `/mcp`, `/docs` and `/health` with the client's `index.html`, so client-side routes survive a page refresh.
|
The client calls the server REST endpoints directly — there is no separate BFF layer. Routing uses `BrowserRouter`; the server answers any GET outside `/api`, `/mcp`, `/docs`, `/health` and `/manifest.json` with the client's `index.html`, so client-side routes survive a page refresh.
|
||||||
|
|
||||||
The sidebar footer contains the theme switcher and the app version (injected from the workspace root `package.json` at build time).
|
Pages: scenarios (with steps, versions, credentials, used snippets and files), runs, snippets, credentials, environments, sessions, and the central import page. The sidebar footer contains the theme switcher and the app version.
|
||||||
|
|
||||||
|
`GET /manifest.json` is the server's public configuration for the client: the app `name` and `version`, and settings the UI needs (currently `runLogs.dataLimits`, from `RUN_LOG_DATA_COLLAPSE_BYTES` / `RUN_LOG_DATA_COLLAPSE_LINES`). The client reads it through `client/src/lib/manifest.ts` and the `useManifest()` hook, stale-while-revalidate: the copy cached in `localStorage` (or built-in defaults on first visit) is used right away, and the manifest is refetched once per page load and when the tab becomes visible again after 5 minutes. The server sends it with `Cache-Control: no-cache` and an ETag, so an unchanged manifest costs a 304. Add new client-facing settings to the manifest (`server/src/manifest/`) rather than as build-time Vite variables.
|
||||||
|
|
||||||
See [development.md](development.md) for the full client tech stack and directory layout.
|
See [development.md](development.md) for the full client tech stack and directory layout.
|
||||||
+113
-30
@@ -16,20 +16,29 @@ Install all dependencies from the repo root:
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm install
|
||||||
npx playwright install chromium # first time only (server)
|
npx playwright install --only-shell chromium # first time only: headless Chromium for the server
|
||||||
```
|
```
|
||||||
|
|
||||||
Copy `.env.example` to `.env` and fill in the required values before running.
|
No `.env` is needed: every setting below has a default. To override settings, copy `.env.example` to `.env` and uncomment the ones you need. Docker Compose loads `.env` when it exists.
|
||||||
|
|
||||||
### Environment variables (server)
|
### Environment variables (server)
|
||||||
|
|
||||||
|
All settings are validated at startup by `server/src/config/app.config.ts`.
|
||||||
|
|
||||||
| Variable | Default | Description |
|
| Variable | Default | Description |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
|
| `NODE_ENV` | `development` | `production` in the Docker image. Shown in the startup log, and selects the default CORS origins |
|
||||||
|
| `CORS_ORIGINS` | *(empty)* | Comma-separated origins allowed to call the API cross-origin. When empty: the Vite dev server (`http://localhost:5173`, `http://127.0.0.1:5173`) unless `NODE_ENV=production`, then the compose port (`http://localhost:13000`, `http://127.0.0.1:13000`) |
|
||||||
| `PORT` | `3000` | HTTP port |
|
| `PORT` | `3000` | HTTP port |
|
||||||
| `KEYS_DIR` | `keys` | Directory for key material used by credential/snippet workflows |
|
| `DB_PATH` | `data/liqa.db` | SQLite database file |
|
||||||
| `DB_PATH` | `data/sessions.db` | SQLite database file |
|
| `FILES_DIR` | `data/files` | Where scenario files and run artifacts are stored |
|
||||||
|
| `FILE_RUN_EXPIRATION_DAYS` | `7` | How long run artifacts (downloads, failure dumps, traces) are kept |
|
||||||
|
| `FILE_CLEANUP_CRON` | `0 3 * * *` | When expired files are deleted |
|
||||||
| `SESSION_IDLE_TIMEOUT_MINUTES` | `30` | Idle timeout before open sessions are closed |
|
| `SESSION_IDLE_TIMEOUT_MINUTES` | `30` | Idle timeout before open sessions are closed |
|
||||||
| `SESSION_DELETE_CLOSED_DAYS` | `7` | Retention period for closed sessions |
|
| `SESSION_DELETE_CLOSED_DAYS` | `7` | Retention period for closed sessions |
|
||||||
|
| `PLAYWRIGHT_TRACE_MODE` | `off` | Default Playwright trace mode for runs: `on`, `retain-on-failure` or `off` (see [scenario.md](scenario.md)) |
|
||||||
|
| `RUN_LOG_DATA_COLLAPSE_BYTES` | `256` | Run log `data` blocks whose pretty-printed JSON is over this many bytes start collapsed in the UI (exposed via `/manifest.json`) |
|
||||||
|
| `RUN_LOG_DATA_COLLAPSE_LINES` | `5` | Same, for the number of lines |
|
||||||
| `CLIENT_DIR` | *(empty)* | Directory with the built client to serve at `/` (the Docker image sets it to `client`); empty means the server doesn't serve the UI |
|
| `CLIENT_DIR` | *(empty)* | Directory with the built client to serve at `/` (the Docker image sets it to `client`); empty means the server doesn't serve the UI |
|
||||||
| `PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH` | _(Playwright default)_ | Path to a Chromium binary to use instead of Playwright's own. Not set in Docker: the image ships Playwright's `chromium-headless-shell` (matching the Playwright version) under `PLAYWRIGHT_BROWSERS_PATH=/ms-playwright`. |
|
| `PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH` | _(Playwright default)_ | Path to a Chromium binary to use instead of Playwright's own. Not set in Docker: the image ships Playwright's `chromium-headless-shell` (matching the Playwright version) under `PLAYWRIGHT_BROWSERS_PATH=/ms-playwright`. |
|
||||||
|
|
||||||
@@ -62,13 +71,12 @@ The server listens on port **3000** by default.
|
|||||||
npm -w client run dev
|
npm -w client run dev
|
||||||
```
|
```
|
||||||
|
|
||||||
The Vite dev server runs on **http://localhost:5173** and proxies these API prefixes to `localhost:13000` (or `localhost:3000` when running server locally):
|
The Vite dev server runs on **http://localhost:5173**. It has no API proxy: the client calls `VITE_API_URL` (default `/api/v1` on its own origin), and the server allows CORS from `http://localhost:5173`. So point it at a running server:
|
||||||
|
|
||||||
- `/environments`
|
```bash
|
||||||
- `/credentials`
|
npm -w client run dev:compose-api # API of the compose container (localhost:13000)
|
||||||
- `/snippets`
|
VITE_API_URL=http://localhost:3000/api/v1 npm -w client run dev # API of a locally started server
|
||||||
- `/sessions`
|
```
|
||||||
- `/scenarios`
|
|
||||||
|
|
||||||
**Production build**:
|
**Production build**:
|
||||||
|
|
||||||
@@ -80,6 +88,36 @@ The built files are emitted to `client/dist/`.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Database migrations
|
||||||
|
|
||||||
|
The SQLite schema is managed by TypeORM migrations in `server/src/database/migrations/`; `synchronize` is off.
|
||||||
|
|
||||||
|
- **Docker:** the container applies pending migrations before starting the server.
|
||||||
|
- **Locally:** build, then apply them before starting the server (it refuses to start while migrations are pending):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm -w server run build
|
||||||
|
npm -w server run migration:run # apply pending migrations to DB_PATH
|
||||||
|
npm -w server run migration:show # list migrations and whether they're applied
|
||||||
|
```
|
||||||
|
|
||||||
|
The scripts run from `server/`, so `DB_PATH` (default `data/liqa.db`) is relative to it, and they read `server/.env` if present, like the server does.
|
||||||
|
|
||||||
|
**Changing the schema** (adding or changing an entity):
|
||||||
|
|
||||||
|
1. Change the entity and build (`npm -w server run build`).
|
||||||
|
2. Make sure your local database is on the latest migration (`migration:run`).
|
||||||
|
3. Generate a migration from the difference between the entities and that database:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm -w server run migration:generate -- src/database/migrations/AddSomething
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Review the generated file, then add its class to `MIGRATIONS` in `src/database/migrations/index.ts` (they're listed explicitly, oldest first).
|
||||||
|
5. Run the tests: `test/migrations.spec.ts` checks that the migrations produce exactly the schema the entities describe, and fails if an entity change has no migration.
|
||||||
|
|
||||||
|
The initial migration (`Initial…`) adopts databases created before migrations existed (by `synchronize`): if the tables already exist, it's only recorded as applied.
|
||||||
|
|
||||||
## Running tests
|
## Running tests
|
||||||
|
|
||||||
### Server (Jest)
|
### Server (Jest)
|
||||||
@@ -100,7 +138,7 @@ Watch mode:
|
|||||||
npm -w server run test:watch
|
npm -w server run test:watch
|
||||||
```
|
```
|
||||||
|
|
||||||
Enable verbose NestJS log output during tests:
|
Print the NestJS logs of the test app (they're silenced by default; `DEBUG=test`):
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm -w server run test:debug
|
npm -w server run test:debug
|
||||||
@@ -168,6 +206,8 @@ The root `Dockerfile` builds a single image with the whole application: it build
|
|||||||
|
|
||||||
The runtime image uses Playwright's headless-only Chromium build (`chromium-headless-shell`) with just the shared libraries it links against, plus DejaVu and Liberation fonts (Liberation is metric-compatible with Arial/Times, so pages lay out as they would with those fonts). All browser launches are headless, so the full desktop Chromium isn't installed. If a new Playwright version needs another library, `ldd` on the `chrome-headless-shell` binary in the image lists what's missing.
|
The runtime image uses Playwright's headless-only Chromium build (`chromium-headless-shell`) with just the shared libraries it links against, plus DejaVu and Liberation fonts (Liberation is metric-compatible with Arial/Times, so pages lay out as they would with those fonts). All browser launches are headless, so the full desktop Chromium isn't installed. If a new Playwright version needs another library, `ldd` on the `chrome-headless-shell` binary in the image lists what's missing.
|
||||||
|
|
||||||
|
To keep the image small, production dependencies and the browser are installed in a separate `runtime-deps` stage, which drops what nothing loads at runtime (source maps, TypeScript sources and declarations, docs, TypeORM's browser build, better-sqlite3's C sources, and Playwright's ffmpeg, which is only used for video recording). The runtime stage is plain `debian:bookworm-slim` with only the `node` binary copied in, so the image has no `npm`, `npx`, `yarn` or `corepack`. If a package starts failing in the image only, check whether it reads one of the deleted file types at runtime.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose build
|
docker compose build
|
||||||
```
|
```
|
||||||
@@ -180,6 +220,44 @@ docker compose build --no-cache
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Licenses
|
||||||
|
|
||||||
|
The project is MIT-licensed ([LICENSE](../LICENSE)); the `license` field in all three `package.json` files says the same.
|
||||||
|
|
||||||
|
The image ships third-party code: the server's production dependencies, the client's production dependencies (bundled into its build), the Node.js binary, Chromium and Debian packages. Their notices are in the image as follows:
|
||||||
|
|
||||||
|
- **npm packages and Node.js**: the `licenses` stage of the Dockerfile runs `scripts/third-party-licenses.mjs`, which writes the project's LICENSE followed by every production dependency of both workspaces with its license files (or, for the few packages that ship none, the declared license, author and source). Node.js's LICENSE for the exact version in the image is fetched from GitHub and appended. The result is `/app/client/licenses.txt`, which the app serves at `/licenses.txt`. The build fails if a package has no license information at all.
|
||||||
|
- **Server packages' own license files** stay in `node_modules`: the slimming step deletes Markdown files except `LICENSE*`, `NOTICE*` and `COPYING*`.
|
||||||
|
- **Chromium**: `LICENSE.headless_shell` next to the binary under `/ms-playwright`.
|
||||||
|
- **Debian packages**: `/usr/share/doc/*/copyright`.
|
||||||
|
|
||||||
|
The image also has the OCI labels `org.opencontainers.image.licenses=MIT`, `source`, `title` and `version` (CI passes the version as the `VERSION` build arg).
|
||||||
|
|
||||||
|
To check the notices locally, or to review a new dependency's license, run from the repository root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node scripts/third-party-licenses.mjs > /tmp/licenses.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Before adding a dependency, check its license is compatible with MIT distribution (permissive licenses such as MIT, ISC, BSD, Apache-2.0 are; copyleft ones such as GPL or AGPL need a closer look).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## CI (Gitea Actions)
|
||||||
|
|
||||||
|
`.gitea/workflows/ci.yml` runs on pushes to `master`, on pull requests and on release tags (`vX.Y.Z`):
|
||||||
|
|
||||||
|
- **changes** (not on tags): detects which of `server/` and `client/` changed (via `dorny/paths-filter`), also treating root `package.json`/`package-lock.json` and the workflow file itself as affecting both.
|
||||||
|
- **server** (skipped if nothing under `server/` changed; always runs on tags): lint (no warnings allowed), type-check, tests, build.
|
||||||
|
- **client** (skipped if nothing under `client/` changed; always runs on tags): lint (no warnings allowed), build, Storybook tests in headless Chromium.
|
||||||
|
- **image** (release tags only): after the server and client jobs pass, checks that the tag matches the root `package.json` version (`v<version>`), builds the Docker image and pushes it to the Gitea container registry set by `REGISTRY` at the top of the workflow (`git.hq.ars9.space`) as `<registry>/<owner>/<repo>:<version>` and `:latest`. Merges to `master` don't build images.
|
||||||
|
|
||||||
|
The image job logs in as the repository owner with the `REGISTRY_TOKEN` secret: a Gitea access token with package write access (Settings → Applications → token with `write:package`), added under the repository's Settings → Actions → Secrets. It runs `docker` on the runner, so the runner must give jobs access to a Docker daemon (act_runner mounts the host's Docker socket into job containers by default).
|
||||||
|
|
||||||
|
Jobs clone the repository from the address the runner was registered with. If that's an internal hostname (such as `http://gitea:3000` from Gitea's compose network), job containers can't resolve it: either register the runner with the public URL, or set `container.network` in the act_runner config to Gitea's Docker network so jobs join it.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Running with Docker Compose
|
## Running with Docker Compose
|
||||||
|
|
||||||
Start (detached):
|
Start (detached):
|
||||||
@@ -194,11 +272,11 @@ Build and start in one step:
|
|||||||
docker compose up -d --build
|
docker compose up -d --build
|
||||||
```
|
```
|
||||||
|
|
||||||
Everything is served by the single `liqa` container at **http://localhost:13000**: the UI at `/`, the REST API at `/api/v1`, MCP at `/mcp`, Swagger at `/docs` and health at `/health`. Unknown paths outside those routes get the client's `index.html`, so client-side routes survive a page refresh.
|
Everything is served by the single `liqa` container at **http://localhost:13000**: the UI at `/`, the REST API at `/api/v1`, MCP at `/mcp`, Swagger at `/docs`, health at `/health` and the client's public configuration at `/manifest.json`. Unknown paths outside those routes get the client's `index.html`, so client-side routes survive a page refresh.
|
||||||
|
|
||||||
When switching from the old two-container setup (`server` + `client`), remove the old containers with `docker compose up -d --build --remove-orphans`.
|
When switching from the old two-container setup (`server` + `client`), remove the old containers with `docker compose up -d --build --remove-orphans`.
|
||||||
|
|
||||||
SQLite data is persisted in `./data/` and key files are mounted from `./keys/` — both directories are volume-mounted into the container.
|
The SQLite database and stored files are persisted in `./data/`, which is volume-mounted into the container.
|
||||||
|
|
||||||
Stop and remove containers:
|
Stop and remove containers:
|
||||||
|
|
||||||
@@ -216,7 +294,7 @@ docker compose logs -f
|
|||||||
|
|
||||||
## Client overview
|
## Client overview
|
||||||
|
|
||||||
The client (`client/`) is a React 19 + TypeScript SPA built with Vite. It provides a browser UI for managing environments, credentials, snippets, sessions, scenarios, and runs.
|
The client (`client/`) is a React 19 + TypeScript SPA built with Vite. It provides a browser UI for managing scenarios, runs, snippets, credentials, environments and sessions, and for importing exported YAML.
|
||||||
|
|
||||||
### Tech stack
|
### Tech stack
|
||||||
|
|
||||||
@@ -224,9 +302,13 @@ The client (`client/`) is a React 19 + TypeScript SPA built with Vite. It provid
|
|||||||
|---|---|
|
|---|---|
|
||||||
| React 19 + TypeScript | UI framework |
|
| React 19 + TypeScript | UI framework |
|
||||||
| Vite 6 | Dev server and bundler |
|
| Vite 6 | Dev server and bundler |
|
||||||
| react-router-dom (HashRouter) | Client-side routing |
|
| react-router-dom 7 (`BrowserRouter`) | Client-side routing |
|
||||||
|
| @tanstack/react-query | Data fetching (cross-scenario runs list) |
|
||||||
| i18next + react-i18next | Internationalisation |
|
| i18next + react-i18next | Internationalisation |
|
||||||
| lucide-react | Icon library |
|
| lucide-react | Icon library |
|
||||||
|
| @monaco-editor/react | Code editor for steps and snippets |
|
||||||
|
| react-markdown + highlight.js | Markdown descriptions and code highlighting |
|
||||||
|
| yaml | YAML export of entities |
|
||||||
| moment | Relative timestamp formatting |
|
| moment | Relative timestamp formatting |
|
||||||
| ESLint 10 + Prettier | Linting and formatting |
|
| ESLint 10 + Prettier | Linting and formatting |
|
||||||
| Storybook 10 + Vitest | Component development and testing |
|
| Storybook 10 + Vitest | Component development and testing |
|
||||||
@@ -236,32 +318,33 @@ The client (`client/`) is a React 19 + TypeScript SPA built with Vite. It provid
|
|||||||
```
|
```
|
||||||
client/
|
client/
|
||||||
src/
|
src/
|
||||||
api/ API client modules (environments, credentials, snippets, sessions, scenarios)
|
api/ API client (client.ts) and types (types.ts)
|
||||||
hooks/ useTheme (light/dark persistence)
|
components/ modals/ - run, export, export logs and delete confirmation modals
|
||||||
|
hooks/ useTheme, usePageTitle, useRunDefaults, useImportFile
|
||||||
i18n/ i18next bootstrap + locales/en.json
|
i18n/ i18next bootstrap + locales/en.json
|
||||||
pages/ Environment/Credential/Snippet/Session/Scenario/Run pages
|
lib/ highlight.js setup, API error toast events
|
||||||
ui/ Reusable component library
|
pages/ scenario/, run/, snippet/, credential/, environment/, session/, import/
|
||||||
Badge, Breadcrumbs, Button, Card, Input, Select,
|
ui/ Reusable component library (Badge, Button, Card, CodeEditor, Modal,
|
||||||
SidePanel, Table, ThemeSwitcher, Timestamp
|
Select, SidePanel, Table, Toast, ... - see ui/index.ts)
|
||||||
.storybook/
|
.storybook/
|
||||||
stories/ *.stories.tsx for all ui/ components
|
stories/ *.stories.tsx for ui/ components
|
||||||
```
|
```
|
||||||
|
|
||||||
### Routing
|
### Routing
|
||||||
|
|
||||||
Hash-based routing (`/#/path`) avoids conflicts with the Vite dev-server proxy. Default route redirects to `/#/scenarios`.
|
`BrowserRouter` with plain paths. The root and unknown paths redirect to `/scenarios`. The server answers these paths with the client's `index.html` (see [architecture.md](architecture.md)), so they work on refresh.
|
||||||
|
|
||||||
| Route | Page |
|
| Route | Page |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `/#/environments` | Environment list |
|
| `/scenarios` | Scenario list |
|
||||||
| `/#/credentials` | Credential list |
|
| `/scenarios/:id` | Scenario details (steps, versions, credentials, used snippets, files) |
|
||||||
| `/#/snippets` | Snippet list |
|
| `/scenarios/:id/runs`, `/scenarios/:id/runs/:runId` | Runs of a scenario, run details |
|
||||||
| `/#/sessions` | Session list |
|
| `/runs` | Cross-scenario runs list |
|
||||||
| `/#/scenarios` | Scenario list |
|
| `/snippets`, `/credentials`, `/environments`, `/sessions` | Entity lists (plus `/:id`, `/new`, `/:id/edit` where applicable) |
|
||||||
| `/#/runs` | Cross-scenario runs list |
|
| `/import` | Central import |
|
||||||
|
|
||||||
### Theming
|
### Theming
|
||||||
|
|
||||||
Light/dark theme is toggled by the `ThemeSwitcher` button in the sidebar footer. The selection is persisted to `localStorage` and applied as `data-theme` on `<html>` before React mounts (anti-FOUC inline script in `index.html`).
|
Light/dark theme is toggled by the `ThemeSwitcher` button in the sidebar footer. The selection is persisted to `localStorage` and applied as `data-theme` on `<html>` before React mounts (anti-FOUC inline script in `index.html`).
|
||||||
|
|
||||||
The sidebar footer also shows the app version read from the workspace root `package.json` and injected via Vite `define`.
|
The sidebar footer also shows the server's app version from `/manifest.json` (see [architecture.md](architecture.md#client-client)), falling back to the client build's version (read from the workspace root `package.json` and injected via Vite `define`). If the two differ, the version's tooltip suggests reloading the page.
|
||||||
+66
-44
@@ -1,94 +1,116 @@
|
|||||||
# MCP tools
|
# MCP tools
|
||||||
|
|
||||||
The MCP endpoint is exposed at `/mcp` (Streamable HTTP transport).
|
The MCP endpoint is exposed at `/mcp` (Streamable HTTP transport), e.g. `http://localhost:13000/mcp` with the compose setup. Each request is served by a fresh MCP server, so there is no MCP session state between calls.
|
||||||
|
|
||||||
The server currently registers the following tools.
|
The server registers the following tools. All entity IDs are UUIDs; list tools are paginated (`page`, `limit`, and where noted `orderBy` / `orderDir`). Errors are returned as MCP tool errors (`isError: true`) with the message as text.
|
||||||
|
|
||||||
## Sessions
|
## Sessions
|
||||||
|
|
||||||
| Tool | Description |
|
| Tool | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `list_sessions` | List stored sessions (paginated) |
|
| `list_sessions` | List saved browser sessions (`orderBy`/`orderDir`) |
|
||||||
| `delete_session` | Delete a session by UUID |
|
| `delete_session` | Delete a session by `id` |
|
||||||
|
|
||||||
## Environments
|
## Environments
|
||||||
|
|
||||||
| Tool | Description |
|
| Tool | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `list_environments` | List environments (paginated) |
|
| `list_environments` | List environments (`orderBy`/`orderDir`) |
|
||||||
| `get_environment` | Get one environment by UUID |
|
| `get_environment` | Get one environment by `id` |
|
||||||
| `create_environment` | Create environment (`name`, `urls`) |
|
| `create_environment` | Create an environment: `name`, optional `description`, `data` |
|
||||||
| `update_environment` | Update environment (`id`, optional `name`/`urls`) |
|
| `update_environment` | Update `name`, `description` and/or `data` of environment `id` |
|
||||||
| `delete_environment` | Delete environment by UUID |
|
| `delete_environment` | Delete an environment by `id` |
|
||||||
|
|
||||||
`urls` is a free-form key/value map. Common keys: `id_url`, `cabinet_url`, `admin_url`.
|
`data` is a free-form map of string keys to string values, read in step code with `context.getEnv(key)`.
|
||||||
|
|
||||||
|
## Credentials
|
||||||
|
|
||||||
|
| Tool | Description |
|
||||||
|
|---|---|
|
||||||
|
| `list_credentials` | List credentials (`orderBy`/`orderDir`). Returns the full `data`, secrets included |
|
||||||
|
| `get_credential` | Get one credential by `id` (full `data`) |
|
||||||
|
| `create_credential` | Create a credential: `name`, optional `data` (JSON-encoded string) |
|
||||||
|
| `update_credential` | Update `name` and/or `data`; omitted fields are left unchanged |
|
||||||
|
| `delete_credential` | Delete a credential; also removes it from scenarios it's assigned to |
|
||||||
|
|
||||||
## Browser (ad-hoc)
|
## Browser (ad-hoc)
|
||||||
|
|
||||||
| Tool | Description |
|
| Tool | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `open_url` | Open URL with optional `sessionName`, return page/title/content |
|
| `open_url` | Open `url`, optionally in saved session `sessionName`; returns title and content (`readerMode` for readable text, `selector` to limit to one element) |
|
||||||
| `exec_code` | Execute Playwright JS — script receives a single `context` argument (see `scenario.md`). Optional `environmentId` (UUID) resolves environment from DB for `context.getEnv()`. Optional `credentials` (`{ alias: credentialUUID }`) resolves credentials from DB for `context.getCredential(alias)`. |
|
| `exec_code` | Run Playwright JS that receives a single `context` argument (see [scenario.md](scenario.md)), optionally after opening `url` and/or in session `sessionName`. `environmentId` loads an environment for `context.getEnv()`; `credentials` (`{ alias: credentialId }`) loads credentials for `context.getCredential(alias)` |
|
||||||
|
|
||||||
## Scenarios
|
## Scenarios
|
||||||
|
|
||||||
| Tool | Description |
|
| Tool | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `list_scenarios` | List scenarios (paginated) |
|
| `list_scenarios` | List scenarios (`orderBy`/`orderDir`) |
|
||||||
| `get_scenario` | Get scenario with steps |
|
| `get_scenario` | Get a scenario (latest version) with its steps |
|
||||||
| `create_scenario` | Create scenario by `name` |
|
| `create_scenario` | Create a scenario: `name`, optional `description`, `environmentId` (default environment), `timeoutSeconds` |
|
||||||
| `update_scenario` | Rename scenario |
|
| `update_scenario` | Update scenario fields; bumps the version when content changes |
|
||||||
| `delete_scenario` | Delete scenario |
|
| `delete_scenario` | Delete a scenario with its steps, versions and runs |
|
||||||
| `create_scenario_step` | Add step to scenario |
|
| `create_scenario_step` | Append a step: `execCode`, optional `title` and `timeoutSeconds`. The schema also requires `order` and `type`, but both are ignored: new steps always go last (use `update_scenario_step` with `order` to move one) |
|
||||||
| `get_scenario_step` | Get one step |
|
| `get_scenario_step` | Get one step |
|
||||||
| `update_scenario_step` | Update step fields |
|
| `update_scenario_step` | Update step fields (including `order` to move it) |
|
||||||
| `delete_scenario_step` | Delete step |
|
| `delete_scenario_step` | Delete a step |
|
||||||
| `list_scenario_runs` | List runs for a scenario |
|
|
||||||
| `list_scenario_versions` | List a scenario's versions, newest first |
|
| `list_scenario_versions` | List a scenario's versions, newest first |
|
||||||
| `get_scenario_version` | Get one scenario version with its steps |
|
| `get_scenario_version` | Get one scenario version with its steps |
|
||||||
| `run_scenario` | Trigger run for scenario; optional `version` (defaults to latest) and `traceMode` |
|
| `list_scenario_credentials` | List credentials assigned to a scenario (alias → credential) |
|
||||||
| `get_scenario_run` | Get run with step runs and logs |
|
| `add_scenario_credential` | Assign credential `credentialId` to a scenario under `alias` |
|
||||||
| `wait_for_scenario_run` | Wait until run is `pass` or `fail` |
|
| `remove_scenario_credential` | Remove an assignment by `scenarioCredentialId` (the assignment id, not the credential id) |
|
||||||
| `export_scenario` | Export one scenario version (optional `version`, defaults to latest) |
|
| `export_scenario` | Export one scenario version (optional `version`, defaults to the latest) |
|
||||||
| `import_scenario` | Import one scenario version; `version` is required (see "Versioning" in `scenario.md`) |
|
| `import_scenario` | Import one scenario version; `version` is required (see "Versioning" in [scenario.md](scenario.md)) |
|
||||||
| `import_yaml` | Import any mix of environments, credentials, snippets and scenarios from YAML (see "Import" in `scenario.md`) |
|
| `import_yaml` | Import any mix of environments, credentials, snippets and scenarios from YAML (see "Import" in [scenario.md](scenario.md)) |
|
||||||
|
| `export_e2e_test` | Export a scenario as a standalone Playwright test project (zip, base64) |
|
||||||
|
|
||||||
|
Changes to scenario content (fields and steps) create a new scenario version; credential assignments and files are not versioned.
|
||||||
|
|
||||||
|
## Runs
|
||||||
|
|
||||||
|
| Tool | Description |
|
||||||
|
|---|---|
|
||||||
|
| `run_scenario` | Start a run of scenario `id` in `environmentId`; optional `version` (defaults to the latest), `saveSession`, `traceMode` (`on`, `retain-on-failure`, `off`; defaults to `PLAYWRIGHT_TRACE_MODE`) |
|
||||||
|
| `list_scenario_runs` | List runs of a scenario, optionally filtered by `status` |
|
||||||
|
| `list_all_runs` | List runs across all scenarios, optionally filtered by `status` |
|
||||||
|
| `get_scenario_run` | Get a run with its step runs (outputs) and logs |
|
||||||
|
| `wait_for_scenario_run` | Wait until a run is `pass` or `fail` (up to 5 minutes), then return it |
|
||||||
|
|
||||||
## Snippets
|
## Snippets
|
||||||
|
|
||||||
| Tool | Description |
|
| Tool | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `list_snippets` | List snippets (paginated) |
|
| `list_snippets` | List snippets (`orderBy`/`orderDir`) |
|
||||||
| `get_snippet` | Get one snippet (latest version) |
|
| `get_snippet` | Get one snippet (latest version) |
|
||||||
| `create_snippet` | Create snippet (`alias`, `title`, `code`) |
|
| `create_snippet` | Create a snippet: `alias`, `title`, `code`, optional `description` |
|
||||||
| `update_snippet` | Update snippet fields; bumps its version when content changes |
|
| `update_snippet` | Update snippet fields; bumps its version when content changes |
|
||||||
| `delete_snippet` | Delete snippet and all its versions |
|
| `delete_snippet` | Delete a snippet and all its versions |
|
||||||
| `list_snippet_versions` | List a snippet's versions, newest first |
|
| `list_snippet_versions` | List a snippet's versions, newest first |
|
||||||
| `get_snippet_version` | Get one snippet version |
|
| `get_snippet_version` | Get one snippet version |
|
||||||
|
|
||||||
## Scenario Files
|
Step code runs a snippet with `context.runSnippet("alias", ...args)` (latest version) or `context.runSnippet("alias@3", ...args)` (version 3).
|
||||||
|
|
||||||
|
## Scenario files
|
||||||
|
|
||||||
| Tool | Description |
|
| Tool | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `upload_scenario_file` | Upload a file to a scenario; accepts optional `expiresAt` (ISO 8601 date string) |
|
| `upload_scenario_file` | Upload a file to a scenario: `name`, base64 `contentBase64`, optional `mimeType` and `expiresAt` (ISO 8601) |
|
||||||
| `list_scenario_files` | List scenario files (paginated) |
|
| `list_scenario_files` | List a scenario's files (`limit`, `offset`) |
|
||||||
| `get_scenario_file_content` | Retrieve file content as base64 with metadata |
|
| `get_scenario_file_content` | Get a file's content as base64, with metadata |
|
||||||
|
|
||||||
## Run Artifact Files
|
## Run files
|
||||||
|
|
||||||
| Tool | Description |
|
| Tool | Description |
|
||||||
|---|---|
|
|---|---|
|
||||||
| `list_run_files` | List files (artifacts) created during a scenario run (paginated) |
|
| `list_run_files` | List files created during a run (`limit`, `offset`): downloads, failure screenshots/HTML, `trace.zip` |
|
||||||
| `get_run_file_content` | Retrieve run artifact content as base64 with metadata; run artifact content can't be modified and inherits expiry from the run artifact subsystem |
|
| `get_run_file_content` | Get a run file's content as base64, with metadata |
|
||||||
| `delete_run_file` | Delete a file from a run; the stored file is removed once no scenario or run references it (also `DELETE /scenarios/:id/runs/:runId/files/:fileId` and the delete button on the run detail page) |
|
| `delete_run_file` | Delete a file from a run; the stored file is removed once no scenario or run references it (also `DELETE /api/v1/scenarios/:id/runs/:runId/files/:fileId` and the delete button on the run detail page) |
|
||||||
|
|
||||||
## Binary Content Handling
|
## Binary content handling
|
||||||
|
|
||||||
File tools transport binary payloads as base64-encoded strings in a `contentBase64` field with an accompanying `encoding: "base64"` marker in the response. When retrieving file content via `get_scenario_file_content` or `get_run_file_content`, decode the base64 to recover the original bytes.
|
File tools carry binary content as base64 strings in a `contentBase64` field, with `encoding: "base64"` in the response. Decode it to get the original bytes.
|
||||||
|
|
||||||
Scenario files uploaded via `upload_scenario_file` must have their content pre-encoded as base64. Run artifacts are created implicitly through scenario execution (via `context.downloadFile()` during step execution) and cannot be uploaded via MCP.
|
Content for `upload_scenario_file` must be base64-encoded. Run files are only created by runs themselves (`context.downloadFile()`, failure page dumps, traces) and can't be uploaded.
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- Tool IDs and entity IDs are UUIDs.
|
- The step `type` field (`login`, `exec`, `sign`) in `create_scenario_step`, `update_scenario_step` and `import_scenario` is a legacy field kept for compatibility; it's ignored, and every step runs its `execCode`.
|
||||||
- `create_scenario_step` schema still accepts legacy `type`/`sessionName` fields for compatibility. Current scheduler executes `execCode` plus optional `validateCode` and does not branch by step type.
|
|
||||||
|
|
||||||
+50
-44
@@ -1,23 +1,23 @@
|
|||||||
# Scenario execution
|
# Scenario execution
|
||||||
|
|
||||||
When a scenario run is created, the server creates one `ScenarioRunStep` per scenario step.
|
API paths below are relative to the REST prefix `/api/v1` (e.g. `POST /api/v1/scenarios/:id/run`).
|
||||||
|
|
||||||
- Step runs are ordered by `step.order`.
|
## Runs
|
||||||
- First step run starts as `pending`; the rest start as `waiting`.
|
|
||||||
- Scheduler tick (`@Interval(1000)`) picks pending runs and processes steps in order.
|
|
||||||
- Steps in the same run share one Playwright browser/context/page.
|
|
||||||
|
|
||||||
## Execution model
|
Creating a run (`POST /scenarios/:id/run`, the Run button, or the `run_scenario` MCP tool) takes an environment, and optionally a scenario version (latest by default), `saveSession` and a trace mode.
|
||||||
|
|
||||||
Current scheduler behavior is exec-centric:
|
- The run gets one step run per step of that scenario version, each with its own copy of the step's title, code and timeout. Editing or deleting steps later doesn't change existing runs.
|
||||||
|
- The first step run starts as `pending`, the rest as `waiting`.
|
||||||
- `execCode` is required for a step to pass.
|
- A scheduler tick (`@Interval(1000)`) picks up pending runs (up to 10 at a time) and executes their steps in order. All steps of a run share one Playwright browser, context and page.
|
||||||
- `validateCode` is optional and runs after `execCode`.
|
- A step passes when its code returns, and fails when it throws or times out. Its return value is stored as the step output (JSON) and is available to later steps via `context.getStepOutput()`.
|
||||||
- Legacy step type metadata may still appear in MCP payloads, but run execution is not branched by step type.
|
- When a step fails, the run is marked `fail`, the remaining steps are `cancelled`, and a screenshot and the page HTML are saved to the run's files (`step-<order>-failure.png` / `.html`).
|
||||||
|
- Timeouts: each step gets its own `timeoutSeconds`, otherwise the scenario's `timeoutSeconds`, otherwise 60 s. The run as a whole fails once it has run longer than the scenario's `timeoutSeconds` (default 600 s); this is checked before each step.
|
||||||
|
- With `saveSession`, the run's browser is kept after the run as a saved session named `run-<runId>` (see Sessions in the UI), instead of being closed.
|
||||||
|
- Runs left `in_progress` when the server stops are marked `fail` on the next start.
|
||||||
|
|
||||||
## Script runtime
|
## Script runtime
|
||||||
|
|
||||||
`execCode` and `validateCode` execute as async JavaScript with a single `context` argument:
|
Step code (`execCode`) and snippet code run as an async JavaScript function body with a single `context` argument:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
async (context) => {
|
async (context) => {
|
||||||
@@ -25,23 +25,44 @@ async (context) => {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Available in scope:
|
Available on `context`:
|
||||||
|
|
||||||
- `context.page`: Playwright `Page`
|
- `context.page`: Playwright `Page`
|
||||||
- `context.browser`: Playwright `BrowserContext`
|
- `context.browser`: Playwright `BrowserContext`
|
||||||
- `context.env`: shallow copy of environment key/value map
|
- `context.env`: shallow copy of the environment's key/value map
|
||||||
- `context.getEnv(key)`: required environment value lookup (throws if missing)
|
- `context.getEnv(key)`: environment value lookup (throws if missing)
|
||||||
- `context.getCredential(alias)`: credential payload assigned to the scenario alias
|
- `context.getCredential(alias)`: payload of the credential assigned to the scenario under `alias` (parsed JSON when the data is JSON; throws if missing)
|
||||||
- `context.getStepOutput(order)`: prior step output by absolute order (`1`, `2`, ...) or relative (`-1` = previous step)
|
- `context.getStepOutput(order)`: async (`await` it); output of a previous step by absolute order (`1`, `2`, ...) or relative (`-1` = previous step); `null` if there is none
|
||||||
- `context.dumpDom(selector?)`: simplified DOM snapshot
|
- `context.dumpDom(selector?)`: simplified DOM snapshot of the page (or of one element)
|
||||||
- `context.log(...args)`, `context.warn(...args)`, `context.error(...args)`: structured step logs
|
- `context.log(...args)`, `context.warn(...args)`, `context.error(...args)`, `context.debug(...args)`: run log entries
|
||||||
- `context.assert(() => boolean, description)`: runs the arrow function and requires it to return `true`. Logs `description` (as a `log` entry on success, as an `error` entry on failure or exception), then throws to stop the step if the function returned anything other than `true` or threw
|
- `context.assert(() => boolean, description, details?)`: runs the arrow function and requires it to return `true`. Logs `description` (as a `log` entry on success, as an `error` entry on failure or exception), then throws to stop the step if the function returned anything other than `true` or threw. On failure, the log entry's data holds `details` (if given) and the exception message (as `error`, if the function threw)
|
||||||
- `context.runSnippet(name, ...args)`: execute stored snippet code with the same context. `name` is the snippet alias for its latest version, or `alias@<version>` (e.g. `login@3`) to pin a specific version
|
- `context.runSnippet(name, ...args)`: runs stored snippet code with the same context; the snippet receives the extra arguments as `...args`. `name` is the snippet alias for its latest version, or `alias@<version>` (e.g. `login@3`) to pin a specific version. Snippet start/finish/failure is logged
|
||||||
- `context.getScenarioFiles(opts?)`: list files uploaded to the scenario (`limit`, `offset`)
|
- `context.getScenarioFiles(opts?)`: list files uploaded to the scenario (`limit`, `offset`), including their path on disk
|
||||||
- `context.downloadFile(url, opts?)`: fetch `url` and save the result as a run artifact (requires a real scenario run — throws when invoked ad hoc, e.g. via the `exec_code` MCP tool). `opts` may include `method`, `headers`, `body`, `filename`. `url` also accepts a `data:` URI (`data:<mediaType>;base64,<data>` or `data:<mediaType>,<percent-encoded data>`) to save content generated in-script (e.g. a credential JWT) directly, without an actual network fetch.
|
- `context.downloadFile(url, opts?)`: fetch `url` and save the result as a run file (requires a real scenario run — throws when invoked ad hoc, e.g. via the `exec_code` MCP tool). `opts` may include `method`, `headers`, `body`, `filename`. `url` also accepts a `data:` URI (`data:<mediaType>;base64,<data>` or `data:<mediaType>,<percent-encoded data>`) to save content generated in-script (e.g. a credential JWT) directly, without an actual network fetch.
|
||||||
- `console`: proxied to run logs (`log`, `warn`, `error`, etc.)
|
|
||||||
|
|
||||||
`validateCode` additionally receives `result` in scope, which is the value returned by `execCode`.
|
Also in scope:
|
||||||
|
|
||||||
|
- `console`: proxied to run logs (`log`/`info` → `log`, `warn`, `error`, `debug`)
|
||||||
|
- `expect`: Playwright's `expect` (e.g. `await expect(context.page.locator("h1")).toHaveText("Done")`)
|
||||||
|
|
||||||
|
Code is syntax-checked before it runs, and executes in the server process: it's trusted code, not sandboxed.
|
||||||
|
|
||||||
|
The step and snippet editors have a (?) button next to the Code label that opens a reference of this runtime in the UI. Its content is [client/src/components/modals/code-help.md](../client/src/components/modals/code-help.md): keep it in sync with this section when the `context` API changes.
|
||||||
|
|
||||||
|
## Run logs
|
||||||
|
|
||||||
|
Each run log entry (`level`, `message`, `createdAt`) also carries a `context`: where the message was generated. Contexts:
|
||||||
|
|
||||||
|
- `step:<N>`: the step a log entry belongs to, including the automatic "Step N started / passed / failed" entries ("Step N passed" carries the step's return value as `data`; "Step N failed" for an assertion failure names only the assertion, whose details are in the `assertion:fail` entry)
|
||||||
|
- `snippet:<alias>`: entries logged while `context.runSnippet(alias, ...)` is running, including its own automatic "started"/"finished"/"failed" entries. A snippet calling another snippet tags entries with the innermost running snippet's alias
|
||||||
|
- `assertion:pass` / `assertion:fail`: `context.assert()`'s own log entry
|
||||||
|
- `run`: run-level entries not tied to a step (e.g. a scenario timeout, or the Playwright trace upload notice)
|
||||||
|
|
||||||
|
`context.log`/`warn`/`error` (and `console.log`/etc.) split their arguments: strings/numbers/booleans are joined into `message`, while object/array arguments are kept out of it and stored as `data` (JSON), so `message` stays a stable string regardless of an object's shape. With one object argument `data` is that object; with more than one, `data` is an array of them. E.g. `context.log("Saved credential as run file:", fileMeta)` logs `message: "Saved credential as run file:"` with `fileMeta` as `data`, shown pretty-printed and separately from the message in the UI.
|
||||||
|
|
||||||
|
On the run page, a `data` block whose pretty-printed JSON is over 256 bytes or 5 lines starts collapsed behind a "Show data" toggle (set by `RUN_LOG_DATA_COLLAPSE_BYTES` / `RUN_LOG_DATA_COLLAPSE_LINES` and passed to the UI via `/manifest.json`). The "Expand data" / "Collapse data" button next to the Logs heading opens or closes all of them. "Copy logs" copies the currently filtered logs to the clipboard as plain text, with every `data` block expanded.
|
||||||
|
|
||||||
|
`GET /scenarios/:id/runs/:runId?q=...` and the exported CSV/Markdown logs (`GET /scenarios/:id/runs/:runId/export`) match `q` against both `message` and `context`.
|
||||||
|
|
||||||
## Versioning
|
## Versioning
|
||||||
|
|
||||||
@@ -71,7 +92,7 @@ Exports hold exactly one version and always include its `version` number (the la
|
|||||||
- Items are imported in dependency order - environments, credentials, snippets, scenarios - regardless of their order in the file, so a scenario can reference an environment or credential from the same file.
|
- Items are imported in dependency order - environments, credentials, snippets, scenarios - regardless of their order in the file, so a scenario can reference an environment or credential from the same file.
|
||||||
- The response lists what was imported: `{ imported: [{ kind, id, name, version? }] }`.
|
- The response lists what was imported: `{ imported: [{ kind, id, name, version? }] }`.
|
||||||
|
|
||||||
A scenario export (`GET /scenarios/:id/export`, optionally with its environment and credentials) is in this format, one document per entity, and can be imported back as is.
|
A scenario export (`GET /scenarios/:id/export`, optionally with its environment, credentials and used snippets) is in this format, one document per entity, and can be imported back as is. Query parameters: `includeEnvironment=true`, `credentialIds` and `snippetIds` (repeat the parameter or separate ids with commas) and `version`. A selected snippet is exported once per version the scenario uses: the latest for plain `runSnippet("alias")` calls, plus each version pinned with `alias@N`. Snippets used only through other snippets count as used.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
---
|
---
|
||||||
@@ -107,23 +128,6 @@ Traces are off by default because they often reach ~10 MB per run.
|
|||||||
|
|
||||||
Traces are run artifacts, so they expire after `FILE_RUN_EXPIRATION_DAYS` like other run files.
|
Traces are run artifacts, so they expire after `FILE_RUN_EXPIRATION_DAYS` like other run files.
|
||||||
|
|
||||||
## Validation contract
|
|
||||||
|
|
||||||
`validateCode` may return:
|
|
||||||
|
|
||||||
```js
|
|
||||||
return { success: true, description: 'ok' };
|
|
||||||
// or
|
|
||||||
return false;
|
|
||||||
```
|
|
||||||
|
|
||||||
Interpretation:
|
|
||||||
|
|
||||||
- Boolean: `true` = pass, `false` = fail
|
|
||||||
- Object: `success` controls pass/fail; `description` is persisted as step description
|
|
||||||
|
|
||||||
On validation failure, the step fails and the run is marked `fail`.
|
|
||||||
|
|
||||||
## Statuses
|
## Statuses
|
||||||
|
|
||||||
Run status:
|
Run status:
|
||||||
@@ -147,7 +151,9 @@ Run-step status:
|
|||||||
1. Create environment
|
1. Create environment
|
||||||
2. Create credentials and snippets (optional but common)
|
2. Create credentials and snippets (optional but common)
|
||||||
3. Create scenario
|
3. Create scenario
|
||||||
4. Add ordered steps (`execCode`, optional `validateCode`)
|
4. Add ordered steps (`execCode`, optional `title` and `timeoutSeconds`)
|
||||||
5. Assign credentials to scenario aliases when needed
|
5. Assign credentials to scenario aliases when needed
|
||||||
6. Run scenario
|
6. Run scenario
|
||||||
7. Wait for run completion and inspect run logs/outputs
|
7. Wait for run completion and inspect run logs/outputs
|
||||||
|
|
||||||
|
The [self-test example](../examples/self-test/) follows these steps through the REST API, and can be imported as a complete, working scenario.
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Examples
|
||||||
|
|
||||||
|
Ready-to-import liqa resources. Each example is a directory with a YAML file to import (the Import page in the UI, `POST /api/v1/import`, or the `import_yaml` MCP tool; see [Import](../docs/scenario.md#import)) and a README on how to run it.
|
||||||
|
|
||||||
|
| Example | What it shows |
|
||||||
|
|---|---|
|
||||||
|
| [self-test](self-test/) | A scenario that tests the liqa instance it runs on: creates a scenario through the REST API, runs it, checks the run and its page in the UI, and cleans up. Uses an environment, a credential, snippets and assertions |
|
||||||
|
|
||||||
|
`server/test/examples.spec.ts` imports every YAML file in this directory and checks that its code parses, so the examples keep up with the import format.
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
# Self-test
|
||||||
|
|
||||||
|
A scenario that tests the liqa instance it runs on. It drives liqa through its own REST API and web UI: it creates a small scenario, runs it, checks the result and deletes it again. It shows the main liqa features in one place:
|
||||||
|
|
||||||
|
- an **environment** with the URLs and test values the steps read with `context.getEnv()`
|
||||||
|
- a **credential**, assigned to the scenario as `fixture` and read with `context.getCredential()`
|
||||||
|
- three **snippets**, called with `context.runSnippet()`, one of them from the other two
|
||||||
|
- **assertions** (`context.assert()` and Playwright's `expect`), step outputs (`context.getStepOutput()`) and run logs
|
||||||
|
|
||||||
|
Everything is in [self-test.yaml](self-test.yaml).
|
||||||
|
|
||||||
|
## Run it
|
||||||
|
|
||||||
|
1. Start liqa with the default docker compose deployment (`docker compose up -d --build` at the repo root). It's served at http://localhost:13000.
|
||||||
|
2. Import [self-test.yaml](self-test.yaml): open **Import** in the UI and pick the file, or run
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -X POST http://localhost:13000/api/v1/import \
|
||||||
|
-H 'Content-Type: application/yaml' \
|
||||||
|
--data-binary @examples/self-test/self-test.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
Every item has a fixed id, so importing the file again updates the same resources instead of adding copies.
|
||||||
|
3. Open the **liqa self-test** scenario and click **Run**. Its default environment, `liqa-self-test`, is preselected.
|
||||||
|
|
||||||
|
The run takes a few seconds. The run page shows every assertion as a log entry, and the target scenario's run while it exists.
|
||||||
|
|
||||||
|
## What's in the file
|
||||||
|
|
||||||
|
| Kind | Name | Purpose |
|
||||||
|
|---|---|---|
|
||||||
|
| Environment | `liqa-self-test` | `liqa_url` (REST API base), `ui_url` (web UI base), `temp_prefix` (name prefix of the temporary resources), `greeting` (test value) |
|
||||||
|
| Credential | `liqa-self-test-fixture` | Test data (`username`, `token`) that the self-test passes on to the scenario it creates. It's not a real secret |
|
||||||
|
| Snippet | `liqa-api` | `runSnippet("liqa-api", method, path, body?)`: calls `liqa_url` + `/api/v1` + `path`, returns the parsed JSON and throws on an error status |
|
||||||
|
| Snippet | `liqa-run-and-wait` | `runSnippet("liqa-run-and-wait", scenarioId, environmentId)`: starts a run and returns it once it has finished. Uses `liqa-api` |
|
||||||
|
| Snippet | `self-test-cleanup` | Deletes every scenario, credential and environment whose name starts with `temp_prefix` and returns how many it deleted. Uses `liqa-api` |
|
||||||
|
| Scenario | `liqa self-test` | The self-test itself (below) |
|
||||||
|
|
||||||
|
The scenario's steps:
|
||||||
|
|
||||||
|
1. **Check the instance is up**: checks `GET /health`, then runs `self-test-cleanup` to remove anything a failed earlier run left behind (and logs a warning if it found some).
|
||||||
|
2. **Create the target scenario**: creates a temporary environment, a temporary credential (holding the `fixture` credential's data) and the target scenario `[self-test] target scenario`, and assigns the credential to it as `secret`. The target has two steps: one reads `greeting` and the `secret` token, the other renders the greeting on a page and checks it with `expect`.
|
||||||
|
3. **Run the target scenario**: runs it with `liqa-run-and-wait` and checks the result: the run and both steps passed, the step outputs hold the greeting and the token's length, and the target logged its passing assertion.
|
||||||
|
4. **Check the run in the UI**: opens the target's run page at `ui_url` and checks that it shows the scenario name and the assertion.
|
||||||
|
5. **Clean up**: runs `self-test-cleanup` again, and checks that it deleted the three temporary resources and that the target scenario is gone.
|
||||||
|
|
||||||
|
## Addresses
|
||||||
|
|
||||||
|
Steps run inside the liqa server, so `liqa_url` and `ui_url` are addresses as seen from the server, not from your machine. In the docker compose deployment the server listens on port 3000 inside the container, published as 13000 on the host, so both are `http://localhost:3000`.
|
||||||
|
|
||||||
|
When running the server locally (`npm run start:dev`, see [docs/development.md](../../docs/development.md)), `liqa_url` stays `http://localhost:3000`. The UI is then served by the Vite dev server: set `ui_url` to `http://localhost:5173`.
|
||||||
|
|
||||||
|
## When it fails
|
||||||
|
|
||||||
|
A failed step stops the run, so the temporary resources (named `[self-test] ...`) are left in place to inspect. The next self-test run deletes them in its first step.
|
||||||
@@ -0,0 +1,280 @@
|
|||||||
|
# liqa self-test example: a scenario that tests the liqa instance it runs on.
|
||||||
|
#
|
||||||
|
# Import this file (Import page in the UI, POST /api/v1/import with
|
||||||
|
# Content-Type: application/yaml, or the import_yaml MCP tool), then run the
|
||||||
|
# "liqa self-test" scenario. See README.md next to this file.
|
||||||
|
#
|
||||||
|
# Every item has a fixed id, so importing the file again updates the same
|
||||||
|
# resources instead of creating duplicates.
|
||||||
|
---
|
||||||
|
# Environment: where the liqa under test is reachable from the liqa server
|
||||||
|
kind: environment
|
||||||
|
id: 418eacb0-ab16-4ad6-ab50-c0274fdc49f1
|
||||||
|
name: liqa-self-test
|
||||||
|
description: >-
|
||||||
|
The liqa instance the self-test scenario runs against. Steps run inside the
|
||||||
|
liqa server (the Docker container), so the compose deployment published at
|
||||||
|
http://localhost:13000 is reached at its in-container port 3000.
|
||||||
|
data:
|
||||||
|
# REST API base (without /api/v1)
|
||||||
|
liqa_url: http://localhost:3000
|
||||||
|
# Web UI base; use http://localhost:5173 with the Vite dev server
|
||||||
|
ui_url: http://localhost:3000
|
||||||
|
# Name prefix of the temporary resources the self-test creates and deletes
|
||||||
|
temp_prefix: "[self-test] "
|
||||||
|
# Value the target scenario reads from its own (temporary) environment
|
||||||
|
greeting: Hello from the liqa self-test
|
||||||
|
---
|
||||||
|
# Credential: test data handed over to the temporary target scenario
|
||||||
|
kind: credential
|
||||||
|
id: b0c9ccab-6743-4ac1-9017-d99e0f5d7474
|
||||||
|
name: liqa-self-test-fixture
|
||||||
|
data: '{"username":"self-test-user","token":"not-a-real-secret-0123456789"}'
|
||||||
|
---
|
||||||
|
# Snippet: liqa-api
|
||||||
|
kind: snippet
|
||||||
|
id: f9d2612c-266c-411a-9483-5d860599f208
|
||||||
|
version: 1
|
||||||
|
alias: liqa-api
|
||||||
|
title: Call the liqa REST API
|
||||||
|
description: >-
|
||||||
|
`context.runSnippet("liqa-api", method, path, body?)` sends a request to
|
||||||
|
`liqa_url` + `/api/v1` + path and returns the parsed JSON response (`null`
|
||||||
|
for an empty body). Throws on a non-2xx status.
|
||||||
|
code: |
|
||||||
|
const [method, path, body] = args;
|
||||||
|
const url = context.getEnv("liqa_url") + "/api/v1" + path;
|
||||||
|
const response = await context.page.request.fetch(url, {
|
||||||
|
method,
|
||||||
|
data: body,
|
||||||
|
// POST /scenarios/:id/run/:runId/wait blocks until the run finishes
|
||||||
|
timeout: 120_000,
|
||||||
|
failOnStatusCode: false,
|
||||||
|
});
|
||||||
|
const text = await response.text();
|
||||||
|
if (!response.ok()) {
|
||||||
|
throw new Error(`${method} ${path} returned ${response.status()}: ${text}`);
|
||||||
|
}
|
||||||
|
return text ? JSON.parse(text) : null;
|
||||||
|
---
|
||||||
|
# Snippet: liqa-run-and-wait
|
||||||
|
kind: snippet
|
||||||
|
id: b36c1075-2700-421f-a2e7-ab1a80adb7e7
|
||||||
|
version: 1
|
||||||
|
alias: liqa-run-and-wait
|
||||||
|
title: Run a scenario and wait for it
|
||||||
|
description: >-
|
||||||
|
`context.runSnippet("liqa-run-and-wait", scenarioId, environmentId)` starts
|
||||||
|
a run of the scenario's latest version and returns the finished run (with
|
||||||
|
its step runs and logs). Uses the liqa-api snippet.
|
||||||
|
code: |
|
||||||
|
const [scenarioId, environmentId] = args;
|
||||||
|
const run = await context.runSnippet(
|
||||||
|
"liqa-api",
|
||||||
|
"POST",
|
||||||
|
`/scenarios/${scenarioId}/run`,
|
||||||
|
{ environmentId },
|
||||||
|
);
|
||||||
|
context.log(`Started run ${run.id}, waiting for it to finish`);
|
||||||
|
return context.runSnippet(
|
||||||
|
"liqa-api",
|
||||||
|
"POST",
|
||||||
|
`/scenarios/${scenarioId}/run/${run.id}/wait`,
|
||||||
|
);
|
||||||
|
---
|
||||||
|
# Snippet: self-test-cleanup
|
||||||
|
kind: snippet
|
||||||
|
id: f99e3b17-d28d-4a80-8ae4-f7e8252e0be5
|
||||||
|
version: 1
|
||||||
|
alias: self-test-cleanup
|
||||||
|
title: Delete temporary self-test resources
|
||||||
|
description: >-
|
||||||
|
Deletes every scenario, credential and environment whose name starts with
|
||||||
|
the `temp_prefix` environment value, and returns how many were deleted.
|
||||||
|
Uses the liqa-api snippet.
|
||||||
|
code: |
|
||||||
|
const prefix = context.getEnv("temp_prefix");
|
||||||
|
let deleted = 0;
|
||||||
|
// Scenarios first: they reference the credentials and environments
|
||||||
|
for (const path of ["/scenarios", "/credentials", "/environments"]) {
|
||||||
|
const page = await context.runSnippet("liqa-api", "GET", `${path}?limit=1000`);
|
||||||
|
for (const item of page.data.filter((i) => i.name.startsWith(prefix))) {
|
||||||
|
await context.runSnippet("liqa-api", "DELETE", `${path}/${item.id}`);
|
||||||
|
context.log(`Deleted ${path.slice(1, -1)} "${item.name}"`);
|
||||||
|
deleted += 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return deleted;
|
||||||
|
---
|
||||||
|
# Scenario: liqa self-test
|
||||||
|
kind: scenario
|
||||||
|
id: 571b2894-dacc-4428-b459-4e3fefac5908
|
||||||
|
version: 1
|
||||||
|
name: liqa self-test
|
||||||
|
description: |
|
||||||
|
Tests the liqa instance it runs on, through its REST API and web UI:
|
||||||
|
|
||||||
|
1. checks that the instance is up and removes leftovers of earlier runs
|
||||||
|
2. creates a temporary environment, credential and two-step target scenario
|
||||||
|
3. runs the target scenario, waits for it and checks its step outputs and logs
|
||||||
|
4. opens the finished run in the web UI
|
||||||
|
5. deletes the temporary resources
|
||||||
|
|
||||||
|
Uses the `liqa-api`, `liqa-run-and-wait` and `self-test-cleanup` snippets and
|
||||||
|
the `fixture` credential. See `examples/self-test/README.md`.
|
||||||
|
environmentId: 418eacb0-ab16-4ad6-ab50-c0274fdc49f1
|
||||||
|
timeoutSeconds: 300
|
||||||
|
credentials:
|
||||||
|
- credentialId: b0c9ccab-6743-4ac1-9017-d99e0f5d7474
|
||||||
|
alias: fixture
|
||||||
|
steps:
|
||||||
|
- title: Check the instance is up
|
||||||
|
execCode: |
|
||||||
|
const response = await context.page.request.get(
|
||||||
|
context.getEnv("liqa_url") + "/health",
|
||||||
|
);
|
||||||
|
const health = await response.json();
|
||||||
|
context.assert(() => response.ok(), "Health endpoint responds", {
|
||||||
|
status: response.status(),
|
||||||
|
});
|
||||||
|
context.assert(() => health.status === "ok", "Health status is ok", health);
|
||||||
|
|
||||||
|
// A failed earlier run may have left its temporary resources behind
|
||||||
|
const deleted = await context.runSnippet("self-test-cleanup");
|
||||||
|
if (deleted > 0) {
|
||||||
|
context.warn(`Deleted ${deleted} leftover resource(s) of an earlier run`);
|
||||||
|
}
|
||||||
|
return health;
|
||||||
|
- title: Create the target scenario
|
||||||
|
execCode: |
|
||||||
|
const prefix = context.getEnv("temp_prefix");
|
||||||
|
const api = (method, path, body) =>
|
||||||
|
context.runSnippet("liqa-api", method, path, body);
|
||||||
|
|
||||||
|
const environment = await api("POST", "/environments", {
|
||||||
|
name: `${prefix}environment`,
|
||||||
|
data: { greeting: context.getEnv("greeting") },
|
||||||
|
});
|
||||||
|
// Hand the fixture credential over to the target scenario
|
||||||
|
const fixture = context.getCredential("fixture");
|
||||||
|
const credential = await api("POST", "/credentials", {
|
||||||
|
name: `${prefix}credential`,
|
||||||
|
data: JSON.stringify(fixture),
|
||||||
|
});
|
||||||
|
const scenario = await api("POST", "/scenarios", {
|
||||||
|
name: `${prefix}target scenario`,
|
||||||
|
description: "Temporary scenario created by the liqa self-test",
|
||||||
|
environmentId: environment.id,
|
||||||
|
timeoutSeconds: 60,
|
||||||
|
});
|
||||||
|
await api("POST", `/scenarios/${scenario.id}/credentials`, {
|
||||||
|
credentialId: credential.id,
|
||||||
|
alias: "secret",
|
||||||
|
});
|
||||||
|
|
||||||
|
await api("POST", `/scenarios/${scenario.id}/steps`, {
|
||||||
|
title: "Read the environment and credential",
|
||||||
|
execCode: `
|
||||||
|
const secret = context.getCredential("secret");
|
||||||
|
context.assert(() => typeof secret.token === "string", "Credential has a token");
|
||||||
|
// Return the token length, not the token: step outputs are not secret
|
||||||
|
return { greeting: context.getEnv("greeting"), tokenLength: secret.token.length };
|
||||||
|
`,
|
||||||
|
});
|
||||||
|
await api("POST", `/scenarios/${scenario.id}/steps`, {
|
||||||
|
title: "Render the greeting",
|
||||||
|
execCode: `
|
||||||
|
const { greeting } = await context.getStepOutput(-1);
|
||||||
|
await context.page.setContent("<h1>" + greeting + "</h1>");
|
||||||
|
await expect(context.page.locator("h1")).toHaveText(greeting);
|
||||||
|
return { heading: await context.page.locator("h1").textContent() };
|
||||||
|
`,
|
||||||
|
});
|
||||||
|
|
||||||
|
const created = await api("GET", `/scenarios/${scenario.id}`);
|
||||||
|
context.assert(
|
||||||
|
() => created.steps.length === 2,
|
||||||
|
"Target scenario has 2 steps",
|
||||||
|
{ steps: created.steps.length },
|
||||||
|
);
|
||||||
|
context.log(`Created target scenario ${scenario.id}`);
|
||||||
|
return {
|
||||||
|
scenarioId: scenario.id,
|
||||||
|
scenarioName: scenario.name,
|
||||||
|
environmentId: environment.id,
|
||||||
|
credentialId: credential.id,
|
||||||
|
};
|
||||||
|
- title: Run the target scenario
|
||||||
|
timeoutSeconds: 150
|
||||||
|
execCode: |
|
||||||
|
const { scenarioId, environmentId } = await context.getStepOutput(-1);
|
||||||
|
const run = await context.runSnippet(
|
||||||
|
"liqa-run-and-wait",
|
||||||
|
scenarioId,
|
||||||
|
environmentId,
|
||||||
|
);
|
||||||
|
context.assert(() => run.status === "pass", "Target run passed", {
|
||||||
|
status: run.status,
|
||||||
|
errors: run.logs.filter((l) => l.level === "error").map((l) => l.message),
|
||||||
|
});
|
||||||
|
context.assert(
|
||||||
|
() => run.stepRuns.every((s) => s.status === "pass"),
|
||||||
|
"All target steps passed",
|
||||||
|
run.stepRuns.map((s) => ({ order: s.order, status: s.status })),
|
||||||
|
);
|
||||||
|
|
||||||
|
const [read, render] = run.stepRuns.map((s) => JSON.parse(s.output));
|
||||||
|
const greeting = context.getEnv("greeting");
|
||||||
|
context.assert(
|
||||||
|
() => read.greeting === greeting,
|
||||||
|
"Target read the greeting from its environment",
|
||||||
|
read,
|
||||||
|
);
|
||||||
|
context.assert(
|
||||||
|
() => read.tokenLength === context.getCredential("fixture").token.length,
|
||||||
|
"Target read the token from its credential",
|
||||||
|
);
|
||||||
|
context.assert(
|
||||||
|
() => render.heading === greeting,
|
||||||
|
"Target rendered the greeting",
|
||||||
|
render,
|
||||||
|
);
|
||||||
|
context.assert(
|
||||||
|
() =>
|
||||||
|
run.logs.some(
|
||||||
|
(l) =>
|
||||||
|
l.context === "assertion:pass" &&
|
||||||
|
l.message === "Credential has a token",
|
||||||
|
),
|
||||||
|
"Target logged its passed assertion",
|
||||||
|
);
|
||||||
|
return { runId: run.id };
|
||||||
|
- title: Check the run in the UI
|
||||||
|
execCode: |
|
||||||
|
const { scenarioId, scenarioName } = await context.getStepOutput(2);
|
||||||
|
const { runId } = await context.getStepOutput(3);
|
||||||
|
const page = context.page;
|
||||||
|
await page.goto(
|
||||||
|
`${context.getEnv("ui_url")}/scenarios/${scenarioId}/runs/${runId}`,
|
||||||
|
);
|
||||||
|
await expect(page.getByText(scenarioName).first()).toBeVisible();
|
||||||
|
await expect(page.getByText("Credential has a token").first()).toBeVisible();
|
||||||
|
context.log(`Run page checked: ${page.url()}`);
|
||||||
|
return { url: page.url() };
|
||||||
|
- title: Clean up
|
||||||
|
execCode: |
|
||||||
|
const { scenarioId } = await context.getStepOutput(2);
|
||||||
|
const deleted = await context.runSnippet("self-test-cleanup");
|
||||||
|
context.assert(() => deleted === 3, "Deleted the 3 temporary resources", {
|
||||||
|
deleted,
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await context.page.request.get(
|
||||||
|
`${context.getEnv("liqa_url")}/api/v1/scenarios/${scenarioId}`,
|
||||||
|
);
|
||||||
|
context.assert(
|
||||||
|
() => response.status() === 404,
|
||||||
|
"Target scenario is gone",
|
||||||
|
{ status: response.status() },
|
||||||
|
);
|
||||||
|
return { deleted };
|
||||||
Generated
+4037
-3493
File diff suppressed because it is too large.
Load diff
+3
-1
@@ -1,7 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "liqa",
|
"name": "liqa",
|
||||||
"version": "1.19.1",
|
"version": "1.24.3",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"license": "MIT",
|
||||||
|
"author": "Andrii Arsenin",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=24"
|
"node": ">=24"
|
||||||
},
|
},
|
||||||
|
|||||||
Executable
+78
@@ -0,0 +1,78 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Installs liqa into a target directory: writes a compose.yaml pulling the
|
||||||
|
# published image (git.hq.ars9.space/ars9/liqa) and creates ./data for the
|
||||||
|
# SQLite database, so the install directory needs no copy of this repo.
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
REGISTRY_IMAGE="git.hq.ars9.space/ars9/liqa"
|
||||||
|
|
||||||
|
# Prompt on the terminal, not stdin: under `curl ... | bash` stdin is the
|
||||||
|
# script itself, so a plain `read` would consume the script's own lines.
|
||||||
|
# Without a terminal, the default is used.
|
||||||
|
ask() {
|
||||||
|
local prompt="$1" default="$2" answer=""
|
||||||
|
if { : </dev/tty; } 2>/dev/null; then
|
||||||
|
read -rp "$prompt [$default]: " answer </dev/tty
|
||||||
|
fi
|
||||||
|
echo "${answer:-$default}"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_dir="$(ask "Install directory" "./liqa")"
|
||||||
|
port="$(ask "Port to expose" "13000")"
|
||||||
|
version="$(ask "Version to install" "latest")"
|
||||||
|
|
||||||
|
mkdir -p "$install_dir/data"
|
||||||
|
|
||||||
|
compose_file="$install_dir/compose.yaml"
|
||||||
|
cat > "$compose_file" <<EOF
|
||||||
|
services:
|
||||||
|
liqa:
|
||||||
|
image: ${REGISTRY_IMAGE}:${version}
|
||||||
|
ports:
|
||||||
|
- "${port}:3000"
|
||||||
|
env_file:
|
||||||
|
- path: .env
|
||||||
|
required: false
|
||||||
|
volumes:
|
||||||
|
- ./data:/app/data
|
||||||
|
restart: unless-stopped
|
||||||
|
EOF
|
||||||
|
|
||||||
|
echo "Wrote $compose_file"
|
||||||
|
echo "Created $install_dir/data"
|
||||||
|
echo
|
||||||
|
|
||||||
|
start_hint() {
|
||||||
|
echo "Once that is fixed, start liqa with:" >&2
|
||||||
|
echo " cd $install_dir && docker compose up -d" >&2
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
if ! command -v docker >/dev/null 2>&1; then
|
||||||
|
echo "Error: docker is not installed. Install Docker Engine with the Compose plugin:" >&2
|
||||||
|
echo " https://docs.docker.com/engine/install/" >&2
|
||||||
|
start_hint
|
||||||
|
elif ! docker compose version >/dev/null 2>&1; then
|
||||||
|
echo "Error: the Docker Compose plugin (docker compose) is not available. Install it:" >&2
|
||||||
|
echo " https://docs.docker.com/compose/install/linux/" >&2
|
||||||
|
start_hint
|
||||||
|
elif ! docker compose -f "$compose_file" config --quiet >/dev/null 2>&1; then
|
||||||
|
echo "Error: docker compose rejected $compose_file:" >&2
|
||||||
|
docker compose -f "$compose_file" config --quiet >&2 || true
|
||||||
|
start_hint
|
||||||
|
elif ! docker info >/dev/null 2>&1; then
|
||||||
|
echo "Error: can't reach the Docker daemon. Make sure it is running and that" >&2
|
||||||
|
echo "your user may use it (e.g. is in the docker group), or use sudo." >&2
|
||||||
|
start_hint
|
||||||
|
fi
|
||||||
|
|
||||||
|
cd "$install_dir"
|
||||||
|
if ! docker compose up -d; then
|
||||||
|
echo >&2
|
||||||
|
echo "Error: docker compose up failed." >&2
|
||||||
|
start_hint
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "liqa is running at http://localhost:$port"
|
||||||
|
echo "Manage it from $install_dir with docker compose (ps, logs, down, pull)."
|
||||||
@@ -0,0 +1,118 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
// Writes the license notices for everything the app ships to stdout: the
|
||||||
|
// project's own LICENSE, then every production dependency of the client and
|
||||||
|
// server workspaces with its license text, as installed in node_modules.
|
||||||
|
//
|
||||||
|
// node scripts/third-party-licenses.mjs > licenses.txt
|
||||||
|
//
|
||||||
|
// Run it from the repository root after `npm ci` (dev dependencies may be
|
||||||
|
// installed too; only production dependencies are listed). Exits non-zero
|
||||||
|
// when a package's license can't be determined.
|
||||||
|
|
||||||
|
import { execFileSync } from "node:child_process";
|
||||||
|
import * as fs from "node:fs";
|
||||||
|
import * as path from "node:path";
|
||||||
|
|
||||||
|
const ROOT = process.cwd();
|
||||||
|
const LICENSE_FILE = /^(licen[cs]e|copying|notice)(\.|-|$)/i;
|
||||||
|
|
||||||
|
const tree = JSON.parse(
|
||||||
|
execFileSync("npm", ["ls", "--omit=dev", "--all", "--long", "--json"], {
|
||||||
|
cwd: ROOT,
|
||||||
|
encoding: "utf8",
|
||||||
|
maxBuffer: 256 * 1024 * 1024,
|
||||||
|
// npm ls exits non-zero on unmet optional peers; the JSON is still complete
|
||||||
|
stdio: ["ignore", "pipe", "ignore"],
|
||||||
|
}).toString() || "{}",
|
||||||
|
);
|
||||||
|
|
||||||
|
const workspaces = new Set(
|
||||||
|
(
|
||||||
|
JSON.parse(fs.readFileSync(path.join(ROOT, "package.json"), "utf8"))
|
||||||
|
.workspaces ?? []
|
||||||
|
).map((w) => path.resolve(ROOT, w)),
|
||||||
|
);
|
||||||
|
|
||||||
|
/** name@version → { name, version, license, dir } */
|
||||||
|
const packages = new Map();
|
||||||
|
const walk = (node) => {
|
||||||
|
for (const [name, dep] of Object.entries(node.dependencies ?? {})) {
|
||||||
|
// Unmet optional peers have no path
|
||||||
|
if (!dep.path) continue;
|
||||||
|
// Workspace packages are our own code: list only their dependencies
|
||||||
|
if (!workspaces.has(fs.realpathSync(dep.path))) {
|
||||||
|
const key = `${name}@${dep.version}`;
|
||||||
|
if (packages.has(key)) continue;
|
||||||
|
packages.set(key, { name, version: dep.version, dir: dep.path });
|
||||||
|
}
|
||||||
|
walk(dep);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
walk(tree);
|
||||||
|
|
||||||
|
const manifestOf = (pkg) =>
|
||||||
|
JSON.parse(fs.readFileSync(path.join(pkg.dir, "package.json"), "utf8"));
|
||||||
|
|
||||||
|
const licenseOf = (pkg) => {
|
||||||
|
const manifest = manifestOf(pkg);
|
||||||
|
const field = manifest.license ?? manifest.licenses;
|
||||||
|
if (typeof field === "string") return field;
|
||||||
|
if (Array.isArray(field)) return field.map((l) => l.type ?? l).join(" OR ");
|
||||||
|
if (field?.type) return field.type;
|
||||||
|
return null;
|
||||||
|
};
|
||||||
|
|
||||||
|
const licenseTexts = (pkg) =>
|
||||||
|
fs
|
||||||
|
.readdirSync(pkg.dir)
|
||||||
|
.filter(
|
||||||
|
(f) =>
|
||||||
|
LICENSE_FILE.test(f) && fs.statSync(path.join(pkg.dir, f)).isFile(),
|
||||||
|
)
|
||||||
|
.sort()
|
||||||
|
.map((f) => fs.readFileSync(path.join(pkg.dir, f), "utf8").trim());
|
||||||
|
|
||||||
|
// For packages that ship no license file, record who to attribute and where
|
||||||
|
// the full terms are
|
||||||
|
const withoutLicenseFile = (pkg, license) => {
|
||||||
|
const { author, repository, homepage } = manifestOf(pkg);
|
||||||
|
const authorName = typeof author === "string" ? author : author?.name;
|
||||||
|
const repo = typeof repository === "string" ? repository : repository?.url;
|
||||||
|
return [
|
||||||
|
`The package ships no license file; its package.json declares ${license}.`,
|
||||||
|
authorName && `Author: ${authorName}`,
|
||||||
|
(repo || homepage) && `Source: ${repo || homepage}`,
|
||||||
|
]
|
||||||
|
.filter(Boolean)
|
||||||
|
.join("\n");
|
||||||
|
};
|
||||||
|
|
||||||
|
const missing = [];
|
||||||
|
const sections = [...packages.values()]
|
||||||
|
.sort(
|
||||||
|
(a, b) =>
|
||||||
|
a.name.localeCompare(b.name) || a.version.localeCompare(b.version),
|
||||||
|
)
|
||||||
|
.map((pkg) => {
|
||||||
|
const license = licenseOf(pkg);
|
||||||
|
const texts = licenseTexts(pkg);
|
||||||
|
if (!license && texts.length === 0)
|
||||||
|
missing.push(`${pkg.name}@${pkg.version}`);
|
||||||
|
const body =
|
||||||
|
texts.length > 0 ? texts.join("\n\n") : withoutLicenseFile(pkg, license);
|
||||||
|
return `${pkg.name}@${pkg.version}\nLicense: ${license ?? "see below"}\n\n${body}`;
|
||||||
|
});
|
||||||
|
|
||||||
|
if (missing.length > 0) {
|
||||||
|
console.error(`No license information for: ${missing.join(", ")}`);
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
const rule = "-".repeat(79);
|
||||||
|
process.stdout.write(
|
||||||
|
[
|
||||||
|
fs.readFileSync(path.join(ROOT, "LICENSE"), "utf8").trim(),
|
||||||
|
`${"=".repeat(79)}\n\nThird-party software\n\nThis application includes the following third-party packages (${sections.length}),\nunder their own licenses:`,
|
||||||
|
...sections,
|
||||||
|
].join(`\n\n${rule}\n\n`) + "\n",
|
||||||
|
);
|
||||||
@@ -12,4 +12,8 @@ module.exports = {
|
|||||||
'^@mozilla/readability$': '<rootDir>/test/__mocks__/readability.ts',
|
'^@mozilla/readability$': '<rootDir>/test/__mocks__/readability.ts',
|
||||||
},
|
},
|
||||||
testEnvironment: 'node',
|
testEnvironment: 'node',
|
||||||
|
// Each suite builds a full Nest app in beforeAll. That takes well under a
|
||||||
|
// second on an idle machine, but several seconds when every suite starts at
|
||||||
|
// once on a busy CI runner, past Jest's default 5 s.
|
||||||
|
testTimeout: 30_000,
|
||||||
};
|
};
|
||||||
+5
-2
@@ -7,6 +7,9 @@
|
|||||||
"start": "nest start",
|
"start": "nest start",
|
||||||
"start:dev": "nest start --watch",
|
"start:dev": "nest start --watch",
|
||||||
"start:prod": "node dist/main",
|
"start:prod": "node dist/main",
|
||||||
|
"migration:run": "node dist/database/migrate",
|
||||||
|
"migration:show": "typeorm migration:show -d dist/database/data-source.js",
|
||||||
|
"migration:generate": "typeorm migration:generate -d dist/database/data-source.js",
|
||||||
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
|
"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
|
||||||
"lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
|
"lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
|
||||||
"lint:fix": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\"",
|
"lint:fix": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\"",
|
||||||
@@ -15,8 +18,8 @@
|
|||||||
"test:watch": "jest --watch"
|
"test:watch": "jest --watch"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "",
|
"author": "Andrii Arsenin",
|
||||||
"license": "ISC",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@modelcontextprotocol/sdk": "^1.29.0",
|
"@modelcontextprotocol/sdk": "^1.29.0",
|
||||||
"@mozilla/readability": "^0.6.0",
|
"@mozilla/readability": "^0.6.0",
|
||||||
|
|||||||
@@ -5,29 +5,16 @@ import { ServeStaticModule } from "@nestjs/serve-static";
|
|||||||
import { TypeOrmModule } from "@nestjs/typeorm";
|
import { TypeOrmModule } from "@nestjs/typeorm";
|
||||||
import { BrowserModule } from "./browser/browser.module";
|
import { BrowserModule } from "./browser/browser.module";
|
||||||
import { clientStaticOptions } from "./common/client-static";
|
import { clientStaticOptions } from "./common/client-static";
|
||||||
|
import { dataSourceOptions } from "./database/data-source";
|
||||||
import { AppConfig, validateAppConfig } from "./config/app.config";
|
import { AppConfig, validateAppConfig } from "./config/app.config";
|
||||||
import { CredentialEntity } from "./credential/credential.entity";
|
|
||||||
import { CredentialModule } from "./credential/credential.module";
|
import { CredentialModule } from "./credential/credential.module";
|
||||||
import { EnvironmentEntity } from "./environment/environment.entity";
|
|
||||||
import { EnvironmentModule } from "./environment/environment.module";
|
import { EnvironmentModule } from "./environment/environment.module";
|
||||||
import { FileEntity } from "./file/file.entity";
|
|
||||||
import { FileModule } from "./file/file.module";
|
import { FileModule } from "./file/file.module";
|
||||||
import { ScenarioFileEntity } from "./file/scenario-file.entity";
|
|
||||||
import { ScenarioRunFileEntity } from "./file/scenario-run-file.entity";
|
|
||||||
import { HealthModule } from "./health/health.module";
|
import { HealthModule } from "./health/health.module";
|
||||||
import { ImportModule } from "./import/import.module";
|
import { ImportModule } from "./import/import.module";
|
||||||
|
import { ManifestModule } from "./manifest/manifest.module";
|
||||||
import { McpModule } from "./mcp/mcp.module";
|
import { McpModule } from "./mcp/mcp.module";
|
||||||
import { ScenarioCredentialEntity } from "./scenario/scenario-credential.entity";
|
|
||||||
import { ScenarioRunLogEntity } from "./scenario/scenario-run-log.entity";
|
|
||||||
import { ScenarioRunStepEntity } from "./scenario/scenario-run-step.entity";
|
|
||||||
import { ScenarioRunEntity } from "./scenario/scenario-run.entity";
|
|
||||||
import { ScenarioStepEntity } from "./scenario/scenario-step.entity";
|
|
||||||
import { ScenarioVersionEntity } from "./scenario/scenario-version.entity";
|
|
||||||
import { SnippetVersionEntity } from "./snippet/snippet-version.entity";
|
|
||||||
import { ScenarioEntity } from "./scenario/scenario.entity";
|
|
||||||
import { ScenarioModule } from "./scenario/scenario.module";
|
import { ScenarioModule } from "./scenario/scenario.module";
|
||||||
import { SessionEntity } from "./session/session.entity";
|
|
||||||
import { SnippetEntity } from "./snippet/snippet.entity";
|
|
||||||
import { SnippetModule } from "./snippet/snippet.module";
|
import { SnippetModule } from "./snippet/snippet.module";
|
||||||
|
|
||||||
@Module({
|
@Module({
|
||||||
@@ -45,28 +32,8 @@ import { SnippetModule } from "./snippet/snippet.module";
|
|||||||
}),
|
}),
|
||||||
TypeOrmModule.forRootAsync({
|
TypeOrmModule.forRootAsync({
|
||||||
inject: [ConfigService],
|
inject: [ConfigService],
|
||||||
useFactory: (config: ConfigService<AppConfig, true>) => ({
|
useFactory: (config: ConfigService<AppConfig, true>) =>
|
||||||
type: "better-sqlite3",
|
dataSourceOptions(config.get("DB_PATH")),
|
||||||
database: config.get("DB_PATH"),
|
|
||||||
entities: [
|
|
||||||
SessionEntity,
|
|
||||||
EnvironmentEntity,
|
|
||||||
CredentialEntity,
|
|
||||||
ScenarioEntity,
|
|
||||||
ScenarioStepEntity,
|
|
||||||
ScenarioVersionEntity,
|
|
||||||
ScenarioRunEntity,
|
|
||||||
ScenarioRunStepEntity,
|
|
||||||
ScenarioRunLogEntity,
|
|
||||||
ScenarioCredentialEntity,
|
|
||||||
SnippetEntity,
|
|
||||||
SnippetVersionEntity,
|
|
||||||
FileEntity,
|
|
||||||
ScenarioFileEntity,
|
|
||||||
ScenarioRunFileEntity,
|
|
||||||
],
|
|
||||||
synchronize: true,
|
|
||||||
}),
|
|
||||||
}),
|
}),
|
||||||
BrowserModule,
|
BrowserModule,
|
||||||
EnvironmentModule,
|
EnvironmentModule,
|
||||||
@@ -77,6 +44,7 @@ import { SnippetModule } from "./snippet/snippet.module";
|
|||||||
ImportModule,
|
ImportModule,
|
||||||
McpModule,
|
McpModule,
|
||||||
HealthModule,
|
HealthModule,
|
||||||
|
ManifestModule,
|
||||||
],
|
],
|
||||||
})
|
})
|
||||||
export class AppModule {}
|
export class AppModule {}
|
||||||
@@ -18,9 +18,38 @@ export interface ExecResult {
|
|||||||
result: unknown;
|
result: unknown;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Thrown by `context.assert`. Its `message` includes the failure reason;
|
||||||
|
* `summary` doesn't, so failure reports that follow the `assertion:fail` log
|
||||||
|
* entry (which already holds the details) can stay short.
|
||||||
|
*/
|
||||||
|
export class AssertionFailedError extends Error {
|
||||||
|
constructor(
|
||||||
|
message: string,
|
||||||
|
readonly summary: string,
|
||||||
|
) {
|
||||||
|
super(message);
|
||||||
|
this.name = "AssertionFailedError";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The `AssertionFailedError` behind `err` (directly or via `cause`), if any. */
|
||||||
|
export function findAssertionFailure(
|
||||||
|
err: unknown,
|
||||||
|
): AssertionFailedError | null {
|
||||||
|
for (let e = err; e instanceof Error; e = (e as { cause?: unknown }).cause) {
|
||||||
|
if (e instanceof AssertionFailedError) return e;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
export type ScriptLogger = (
|
export type ScriptLogger = (
|
||||||
level: "log" | "warn" | "error",
|
level: "debug" | "log" | "warn" | "error",
|
||||||
message: string,
|
message: string,
|
||||||
|
/** Where the message was generated, e.g. "step:2", "snippet:login", "assertion:pass". */
|
||||||
|
context?: string | null,
|
||||||
|
/** Structured payload attached to the message (e.g. a created file's metadata). */
|
||||||
|
data?: unknown,
|
||||||
) => void;
|
) => void;
|
||||||
|
|
||||||
/** The `context` object available inside user scripts as the sole argument. */
|
/** The `context` object available inside user scripts as the sole argument. */
|
||||||
@@ -42,14 +71,17 @@ export interface ScriptContext {
|
|||||||
log: (...args: unknown[]) => void;
|
log: (...args: unknown[]) => void;
|
||||||
warn: (...args: unknown[]) => void;
|
warn: (...args: unknown[]) => void;
|
||||||
error: (...args: unknown[]) => void;
|
error: (...args: unknown[]) => void;
|
||||||
|
debug: (...args: unknown[]) => void;
|
||||||
/**
|
/**
|
||||||
* Runs `fn` and requires it to return `true`. Logs the outcome under
|
* Runs `fn` and requires it to return `true`. Logs the outcome under
|
||||||
* `description`, then throws if `fn` returned anything other than `true`
|
* `description`, then throws if `fn` returned anything other than `true`
|
||||||
* or threw an exception.
|
* or threw an exception. On failure, `details` (and the exception message,
|
||||||
|
* if any) are stored as the log entry's data.
|
||||||
*/
|
*/
|
||||||
assert: (
|
assert: (
|
||||||
fn: () => boolean | Promise<boolean>,
|
fn: () => boolean | Promise<boolean>,
|
||||||
description: string,
|
description: string,
|
||||||
|
details?: unknown,
|
||||||
) => Promise<void>;
|
) => Promise<void>;
|
||||||
/** Runs a named snippet with the same context, plus any extra positional args. */
|
/** Runs a named snippet with the same context, plus any extra positional args. */
|
||||||
runSnippet: (alias: string, ...args: unknown[]) => Promise<unknown>;
|
runSnippet: (alias: string, ...args: unknown[]) => Promise<unknown>;
|
||||||
@@ -70,11 +102,12 @@ export interface ExecContext {
|
|||||||
browser: BrowserContext;
|
browser: BrowserContext;
|
||||||
code: string;
|
code: string;
|
||||||
log?: ScriptLogger;
|
log?: ScriptLogger;
|
||||||
|
/** Base log context for this execution, e.g. "step:2". */
|
||||||
|
logContext?: string | null;
|
||||||
getStepOutput?: (order: number) => Promise<unknown>;
|
getStepOutput?: (order: number) => Promise<unknown>;
|
||||||
credentials?: Record<string, unknown>;
|
credentials?: Record<string, unknown>;
|
||||||
environment?: EnvironmentData | null;
|
environment?: EnvironmentData | null;
|
||||||
snippets?: Record<string, string> | null;
|
snippets?: Record<string, string> | null;
|
||||||
result?: unknown;
|
|
||||||
scenarioId?: string;
|
scenarioId?: string;
|
||||||
runId?: string;
|
runId?: string;
|
||||||
fileService?: FileStorageService;
|
fileService?: FileStorageService;
|
||||||
@@ -111,21 +144,55 @@ export class CodeExecutorService {
|
|||||||
browser,
|
browser,
|
||||||
code,
|
code,
|
||||||
log,
|
log,
|
||||||
|
logContext,
|
||||||
getStepOutput,
|
getStepOutput,
|
||||||
credentials,
|
credentials,
|
||||||
environment,
|
environment,
|
||||||
snippets,
|
snippets,
|
||||||
result,
|
|
||||||
scenarioId,
|
scenarioId,
|
||||||
runId,
|
runId,
|
||||||
fileService,
|
fileService,
|
||||||
} = ctx;
|
} = ctx;
|
||||||
const scriptLog: ScriptLogger =
|
const scriptLog: ScriptLogger =
|
||||||
log ?? ((level, msg) => this.logger[level](msg));
|
log ?? ((level, msg) => this.logger[level](msg));
|
||||||
const toStr = (args: unknown[]) =>
|
|
||||||
args
|
// Splits console/log args into a plain-text message (strings, numbers, ...)
|
||||||
.map((a) => (typeof a === "object" ? JSON.stringify(a) : String(a)))
|
// and a structured data payload (objects/arrays), logged separately so the
|
||||||
.join(" ");
|
// message stays a stable string regardless of the object's shape.
|
||||||
|
const splitLogArgs = (
|
||||||
|
args: unknown[],
|
||||||
|
): { message: string; data: unknown } => {
|
||||||
|
const strings: string[] = [];
|
||||||
|
const objects: unknown[] = [];
|
||||||
|
for (const a of args) {
|
||||||
|
if (a !== null && typeof a === "object") {
|
||||||
|
objects.push(a);
|
||||||
|
} else {
|
||||||
|
strings.push(String(a));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return {
|
||||||
|
message: strings.join(" "),
|
||||||
|
data: objects.length === 0 ? null : objects.length === 1 ? objects[0] : objects,
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
// Innermost running snippet (if any) tags log entries; falls back to
|
||||||
|
// logContext (e.g. the current step) outside of any runSnippet call.
|
||||||
|
const contextStack: string[] = logContext ? [logContext] : [];
|
||||||
|
const currentContext = (): string | null =>
|
||||||
|
contextStack.length > 0 ? contextStack[contextStack.length - 1] : null;
|
||||||
|
const emit = (
|
||||||
|
level: "debug" | "log" | "warn" | "error",
|
||||||
|
message: string,
|
||||||
|
contextOverride?: string,
|
||||||
|
data?: unknown,
|
||||||
|
): void =>
|
||||||
|
scriptLog(level, message, contextOverride ?? currentContext(), data);
|
||||||
|
const emitArgs = (level: "debug" | "log" | "warn" | "error", args: unknown[]): void => {
|
||||||
|
const { message, data } = splitLogArgs(args);
|
||||||
|
emit(level, message, undefined, data);
|
||||||
|
};
|
||||||
|
|
||||||
const credMap: Record<string, unknown> = credentials ?? {};
|
const credMap: Record<string, unknown> = credentials ?? {};
|
||||||
const envData: EnvironmentData = environment ?? {};
|
const envData: EnvironmentData = environment ?? {};
|
||||||
@@ -135,11 +202,11 @@ export class CodeExecutorService {
|
|||||||
let scriptContext: ScriptContext;
|
let scriptContext: ScriptContext;
|
||||||
|
|
||||||
const fakeConsole = {
|
const fakeConsole = {
|
||||||
log: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
log: (...args: unknown[]) => emitArgs("log", args),
|
||||||
warn: (...args: unknown[]) => scriptLog("warn", toStr(args)),
|
warn: (...args: unknown[]) => emitArgs("warn", args),
|
||||||
error: (...args: unknown[]) => scriptLog("error", toStr(args)),
|
error: (...args: unknown[]) => emitArgs("error", args),
|
||||||
info: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
info: (...args: unknown[]) => emitArgs("log", args),
|
||||||
debug: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
debug: (...args: unknown[]) => emitArgs("debug", args),
|
||||||
};
|
};
|
||||||
|
|
||||||
try {
|
try {
|
||||||
@@ -147,12 +214,14 @@ export class CodeExecutorService {
|
|||||||
page,
|
page,
|
||||||
browser,
|
browser,
|
||||||
dumpDom: (selector?: string) => dumpDom(page, selector),
|
dumpDom: (selector?: string) => dumpDom(page, selector),
|
||||||
log: (...args: unknown[]) => scriptLog("log", toStr(args)),
|
log: (...args: unknown[]) => emitArgs("log", args),
|
||||||
warn: (...args: unknown[]) => scriptLog("warn", toStr(args)),
|
warn: (...args: unknown[]) => emitArgs("warn", args),
|
||||||
error: (...args: unknown[]) => scriptLog("error", toStr(args)),
|
error: (...args: unknown[]) => emitArgs("error", args),
|
||||||
|
debug: (...args: unknown[]) => emitArgs("debug", args),
|
||||||
assert: async (
|
assert: async (
|
||||||
fn: () => boolean | Promise<boolean>,
|
fn: () => boolean | Promise<boolean>,
|
||||||
description: string,
|
description: string,
|
||||||
|
details?: unknown,
|
||||||
): Promise<void> => {
|
): Promise<void> => {
|
||||||
let passed: boolean;
|
let passed: boolean;
|
||||||
let failureReason: string | undefined;
|
let failureReason: string | undefined;
|
||||||
@@ -163,14 +232,24 @@ export class CodeExecutorService {
|
|||||||
failureReason = (err as Error).message;
|
failureReason = (err as Error).message;
|
||||||
}
|
}
|
||||||
if (passed) {
|
if (passed) {
|
||||||
scriptLog("log", `Assertion passed: ${description}`);
|
emit("log", description, "assertion:pass");
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
const message = failureReason
|
const message = failureReason
|
||||||
? `Assertion failed: ${description} (${failureReason})`
|
? `Assertion failed: ${description} (${failureReason})`
|
||||||
: `Assertion failed: ${description}`;
|
: `Assertion failed: ${description}`;
|
||||||
scriptLog("error", message);
|
const failureData =
|
||||||
throw new Error(message);
|
failureReason !== undefined || details !== undefined
|
||||||
|
? {
|
||||||
|
...(failureReason !== undefined && { error: failureReason }),
|
||||||
|
...(details !== undefined && { details }),
|
||||||
|
}
|
||||||
|
: undefined;
|
||||||
|
emit("error", message, "assertion:fail", failureData);
|
||||||
|
throw new AssertionFailedError(
|
||||||
|
message,
|
||||||
|
`Assertion failed: ${description}`,
|
||||||
|
);
|
||||||
},
|
},
|
||||||
getStepOutput: getStepOutput ?? (() => Promise.resolve(null)),
|
getStepOutput: getStepOutput ?? (() => Promise.resolve(null)),
|
||||||
getCredential: (alias: string): unknown => {
|
getCredential: (alias: string): unknown => {
|
||||||
@@ -199,7 +278,9 @@ export class CodeExecutorService {
|
|||||||
if (snippetCode == null) {
|
if (snippetCode == null) {
|
||||||
throw new Error(`Snippet alias "${alias}" not found`);
|
throw new Error(`Snippet alias "${alias}" not found`);
|
||||||
}
|
}
|
||||||
scriptLog("log", `Snippet "${alias}" started`);
|
const snippetContext = `snippet:${alias}`;
|
||||||
|
contextStack.push(snippetContext);
|
||||||
|
emit("log", `Snippet "${alias}" started`, snippetContext);
|
||||||
const snippetFn = new Function(
|
const snippetFn = new Function(
|
||||||
"context",
|
"context",
|
||||||
"console",
|
"console",
|
||||||
@@ -214,14 +295,17 @@ export class CodeExecutorService {
|
|||||||
args,
|
args,
|
||||||
playwrightExpect,
|
playwrightExpect,
|
||||||
);
|
);
|
||||||
scriptLog("log", `Snippet "${alias}" finished`);
|
emit("log", `Snippet "${alias}" finished`, snippetContext);
|
||||||
return snippetResult;
|
return snippetResult;
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
scriptLog(
|
emit(
|
||||||
"error",
|
"error",
|
||||||
`Snippet "${alias}" failed: ${(err as Error).message}`,
|
`Snippet "${alias}" failed: ${findAssertionFailure(err)?.summary ?? (err as Error).message}`,
|
||||||
|
snippetContext,
|
||||||
);
|
);
|
||||||
throw err;
|
throw err;
|
||||||
|
} finally {
|
||||||
|
contextStack.pop();
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
getScenarioFiles: async (opts?: { limit?: number; offset?: number }) => {
|
getScenarioFiles: async (opts?: { limit?: number; offset?: number }) => {
|
||||||
@@ -278,12 +362,11 @@ export class CodeExecutorService {
|
|||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
// `console`, `result`, and `expect` are injected as named parameters so
|
// `console` and `expect` are injected as named parameters so scripts
|
||||||
// existing scripts that reference them directly still work.
|
// can reference them directly.
|
||||||
const fn = new Function(
|
const fn = new Function(
|
||||||
"context",
|
"context",
|
||||||
"console",
|
"console",
|
||||||
"result",
|
|
||||||
"expect",
|
"expect",
|
||||||
`return (async (context) => { ${code} })(context)`,
|
`return (async (context) => { ${code} })(context)`,
|
||||||
);
|
);
|
||||||
@@ -291,7 +374,6 @@ export class CodeExecutorService {
|
|||||||
const execResult = await fn(
|
const execResult = await fn(
|
||||||
scriptContext,
|
scriptContext,
|
||||||
fakeConsole,
|
fakeConsole,
|
||||||
result,
|
|
||||||
playwrightExpect,
|
playwrightExpect,
|
||||||
);
|
);
|
||||||
return { result: execResult };
|
return { result: execResult };
|
||||||
|
|||||||
@@ -26,6 +26,11 @@ export class ExecContextBuilder {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
logContext(logContext: string): this {
|
||||||
|
this.ctx.logContext = logContext;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
getStepOutput(fn: (order: number) => Promise<unknown>): this {
|
getStepOutput(fn: (order: number) => Promise<unknown>): this {
|
||||||
this.ctx.getStepOutput = fn;
|
this.ctx.getStepOutput = fn;
|
||||||
return this;
|
return this;
|
||||||
@@ -46,11 +51,6 @@ export class ExecContextBuilder {
|
|||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
result(result: unknown): this {
|
|
||||||
this.ctx.result = result;
|
|
||||||
return this;
|
|
||||||
}
|
|
||||||
|
|
||||||
scenarioId(scenarioId: string): this {
|
scenarioId(scenarioId: string): this {
|
||||||
this.ctx.scenarioId = scenarioId;
|
this.ctx.scenarioId = scenarioId;
|
||||||
return this;
|
return this;
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ const SERVER_ROUTES = [
|
|||||||
"/docs{*path}",
|
"/docs{*path}",
|
||||||
"/health",
|
"/health",
|
||||||
"/healthz",
|
"/healthz",
|
||||||
|
"/manifest.json",
|
||||||
];
|
];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
/** Vite dev server (`npm -w client run dev`), calling the API cross-origin. */
|
||||||
|
const DEV_ORIGINS = ["http://localhost:5173", "http://127.0.0.1:5173"];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The port compose.yaml publishes. The UI is served from the same origin in
|
||||||
|
* production, so these only matter for other tools calling the API from a
|
||||||
|
* page on that origin; keep in sync with compose.yaml.
|
||||||
|
*/
|
||||||
|
const PRODUCTION_ORIGINS = ["http://localhost:13000", "http://127.0.0.1:13000"];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Origins allowed to call the API cross-origin. `CORS_ORIGINS` (comma
|
||||||
|
* separated) overrides the defaults, which depend on NODE_ENV: the compose
|
||||||
|
* port in production, the Vite dev server otherwise.
|
||||||
|
*/
|
||||||
|
export function corsOrigins(nodeEnv: string, override: string): string[] {
|
||||||
|
const configured = override
|
||||||
|
.split(",")
|
||||||
|
.map((origin) => origin.trim())
|
||||||
|
.filter(Boolean);
|
||||||
|
if (configured.length > 0) return configured;
|
||||||
|
return nodeEnv === "production" ? PRODUCTION_ORIGINS : DEV_ORIGINS;
|
||||||
|
}
|
||||||
@@ -17,9 +17,14 @@ export enum TraceMode {
|
|||||||
}
|
}
|
||||||
|
|
||||||
export class AppConfig {
|
export class AppConfig {
|
||||||
|
/** `production` in the Docker image; also selects the default CORS origins. */
|
||||||
@IsString()
|
@IsString()
|
||||||
NODE_ENV: string = "development";
|
NODE_ENV: string = "development";
|
||||||
|
|
||||||
|
/** Comma-separated origins allowed to call the API cross-origin; empty = default for NODE_ENV. */
|
||||||
|
@IsString()
|
||||||
|
CORS_ORIGINS: string = "";
|
||||||
|
|
||||||
@IsInt()
|
@IsInt()
|
||||||
@Min(1)
|
@Min(1)
|
||||||
@Max(65535)
|
@Max(65535)
|
||||||
@@ -31,9 +36,6 @@ export class AppConfig {
|
|||||||
@IsString()
|
@IsString()
|
||||||
APP_VERSION: string = appPackage().version;
|
APP_VERSION: string = appPackage().version;
|
||||||
|
|
||||||
@IsString()
|
|
||||||
KEYS_DIR: string = "keys";
|
|
||||||
|
|
||||||
@IsString()
|
@IsString()
|
||||||
DB_PATH: string = "data/liqa.db";
|
DB_PATH: string = "data/liqa.db";
|
||||||
|
|
||||||
@@ -62,6 +64,16 @@ export class AppConfig {
|
|||||||
@IsEnum(TraceMode)
|
@IsEnum(TraceMode)
|
||||||
// Off by default: traces with screenshots and snapshots easily reach ~10 MB per run
|
// Off by default: traces with screenshots and snapshots easily reach ~10 MB per run
|
||||||
PLAYWRIGHT_TRACE_MODE: TraceMode = TraceMode.Off;
|
PLAYWRIGHT_TRACE_MODE: TraceMode = TraceMode.Off;
|
||||||
|
|
||||||
|
/** Run log data blocks over this many bytes (pretty-printed) start collapsed in the UI. */
|
||||||
|
@IsInt()
|
||||||
|
@Min(0)
|
||||||
|
RUN_LOG_DATA_COLLAPSE_BYTES: number = 256;
|
||||||
|
|
||||||
|
/** Run log data blocks over this many lines (pretty-printed) start collapsed in the UI. */
|
||||||
|
@IsInt()
|
||||||
|
@Min(0)
|
||||||
|
RUN_LOG_DATA_COLLAPSE_LINES: number = 5;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function validateAppConfig(config: Record<string, unknown>): AppConfig {
|
export function validateAppConfig(config: Record<string, unknown>): AppConfig {
|
||||||
|
|||||||
@@ -0,0 +1,31 @@
|
|||||||
|
import * as fs from "node:fs";
|
||||||
|
import { DataSource, type DataSourceOptions } from "typeorm";
|
||||||
|
import { validateAppConfig } from "../config/app.config";
|
||||||
|
import { ENTITIES } from "./entities";
|
||||||
|
import { MIGRATIONS } from "./migrations";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TypeORM options shared by the app, the migration runner and the TypeORM
|
||||||
|
* CLI. The schema is managed by migrations only (`synchronize: false`).
|
||||||
|
*/
|
||||||
|
export function dataSourceOptions(database: string): DataSourceOptions {
|
||||||
|
return {
|
||||||
|
type: "better-sqlite3",
|
||||||
|
database,
|
||||||
|
entities: ENTITIES,
|
||||||
|
migrations: MIGRATIONS,
|
||||||
|
synchronize: false,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Outside Nest (migration runner, TypeORM CLI) nothing loads .env; load it
|
||||||
|
// like ConfigModule does: optional, and without overriding set variables
|
||||||
|
if (fs.existsSync(".env")) process.loadEnvFile(".env");
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Data source for the TypeORM CLI and `migrate.ts`, using DB_PATH from the
|
||||||
|
* environment or .env (default `data/liqa.db`).
|
||||||
|
*/
|
||||||
|
export default new DataSource(
|
||||||
|
dataSourceOptions(validateAppConfig(process.env).DB_PATH),
|
||||||
|
);
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
import { CredentialEntity } from "../credential/credential.entity";
|
||||||
|
import { EnvironmentEntity } from "../environment/environment.entity";
|
||||||
|
import { FileEntity } from "../file/file.entity";
|
||||||
|
import { ScenarioFileEntity } from "../file/scenario-file.entity";
|
||||||
|
import { ScenarioRunFileEntity } from "../file/scenario-run-file.entity";
|
||||||
|
import { ScenarioCredentialEntity } from "../scenario/scenario-credential.entity";
|
||||||
|
import { ScenarioRunLogEntity } from "../scenario/scenario-run-log.entity";
|
||||||
|
import { ScenarioRunStepEntity } from "../scenario/scenario-run-step.entity";
|
||||||
|
import { ScenarioRunEntity } from "../scenario/scenario-run.entity";
|
||||||
|
import { ScenarioStepEntity } from "../scenario/scenario-step.entity";
|
||||||
|
import { ScenarioVersionEntity } from "../scenario/scenario-version.entity";
|
||||||
|
import { ScenarioEntity } from "../scenario/scenario.entity";
|
||||||
|
import { SessionEntity } from "../session/session.entity";
|
||||||
|
import { SnippetVersionEntity } from "../snippet/snippet-version.entity";
|
||||||
|
import { SnippetEntity } from "../snippet/snippet.entity";
|
||||||
|
|
||||||
|
/** Every TypeORM entity of the app (used by the app, the migrations CLI and tests). */
|
||||||
|
export const ENTITIES = [
|
||||||
|
SessionEntity,
|
||||||
|
EnvironmentEntity,
|
||||||
|
CredentialEntity,
|
||||||
|
ScenarioEntity,
|
||||||
|
ScenarioStepEntity,
|
||||||
|
ScenarioVersionEntity,
|
||||||
|
ScenarioRunEntity,
|
||||||
|
ScenarioRunStepEntity,
|
||||||
|
ScenarioRunLogEntity,
|
||||||
|
ScenarioCredentialEntity,
|
||||||
|
SnippetEntity,
|
||||||
|
SnippetVersionEntity,
|
||||||
|
FileEntity,
|
||||||
|
ScenarioFileEntity,
|
||||||
|
ScenarioRunFileEntity,
|
||||||
|
];
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
import dataSource from "./data-source";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Applies pending migrations to the database at DB_PATH, then exits. Runs
|
||||||
|
* before the server in the Docker image (`node dist/database/migrate`).
|
||||||
|
*/
|
||||||
|
async function migrate(): Promise<void> {
|
||||||
|
await dataSource.initialize();
|
||||||
|
try {
|
||||||
|
const applied = await dataSource.runMigrations({ transaction: "each" });
|
||||||
|
console.log(
|
||||||
|
applied.length > 0
|
||||||
|
? `Applied ${applied.length} migration(s): ${applied.map((m) => m.name).join(", ")}`
|
||||||
|
: "Database schema is up to date",
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
await dataSource.destroy();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
migrate().catch((err: unknown) => {
|
||||||
|
console.error("Migration failed:", err);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
@@ -0,0 +1,277 @@
|
|||||||
|
import { MigrationInterface, QueryRunner } from "typeorm";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initial schema. Databases created before migrations existed (by TypeORM
|
||||||
|
* `synchronize`) already have this schema: for them this migration only gets
|
||||||
|
* recorded as applied, and later migrations run from there.
|
||||||
|
*/
|
||||||
|
export class Initial1790793447827 implements MigrationInterface {
|
||||||
|
name = "Initial1790793447827";
|
||||||
|
|
||||||
|
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
if (await queryRunner.hasTable("scenarios")) return;
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "credentials" ("id" varchar PRIMARY KEY NOT NULL, "name" varchar NOT NULL, "data" text, "lastUsedAt" datetime, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "environments" ("id" varchar PRIMARY KEY NOT NULL, "name" varchar NOT NULL, "description" text, "data" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_9d00da4836959b86d7590f60c57" UNIQUE ("name"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "files" ("id" varchar PRIMARY KEY NOT NULL, "originalName" varchar NOT NULL, "mimeType" varchar NOT NULL, "size" integer NOT NULL, "sha256" varchar NOT NULL, "filePath" varchar NOT NULL, "expiresAt" datetime, "createdAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_credentials" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "credentialId" varchar NOT NULL, "alias" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_02756536236c408dbb58b3fc964" UNIQUE ("scenarioId", "alias"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_steps" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "order" integer NOT NULL DEFAULT (0), "title" text, "execCode" text, "timeoutSeconds" integer, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenarios" ("id" varchar PRIMARY KEY NOT NULL, "name" varchar NOT NULL, "description" text, "environmentId" varchar, "timeoutSeconds" integer, "version" integer NOT NULL DEFAULT (1), "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_files" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "fileId" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "sessions" ("id" varchar PRIMARY KEY NOT NULL, "sessionName" varchar NOT NULL, "token" text NOT NULL, "cookies" text NOT NULL, "localStorage" text NOT NULL DEFAULT ('{}'), "status" varchar NOT NULL DEFAULT ('closed'), "lastUsedAt" datetime, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_b8f17f1ce30f015f494188c50bb" UNIQUE ("sessionName"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_steps" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "scenarioStepId" varchar, "title" text, "execCode" text, "timeoutSeconds" integer, "status" text NOT NULL DEFAULT ('waiting'), "order" integer NOT NULL DEFAULT (0), "description" text, "output" text, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_runs" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "environmentId" varchar, "sessionId" varchar, "scenarioVersion" integer, "status" text NOT NULL DEFAULT ('pending'), "saveSession" boolean NOT NULL DEFAULT (0), "traceMode" text, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_files" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "fileId" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "seq" integer NOT NULL DEFAULT (0), "createdAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_versions" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "version" integer NOT NULL, "name" varchar NOT NULL, "description" text, "environmentId" text, "timeoutSeconds" integer, "steps" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_e1a56dce2b7e0379bb5bbdf8c1f" UNIQUE ("scenarioId", "version"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "snippets" ("id" varchar PRIMARY KEY NOT NULL, "alias" varchar, "title" varchar NOT NULL DEFAULT (''), "description" text, "code" text NOT NULL, "version" integer NOT NULL DEFAULT (1), "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_bd062c68591ae917b720eb3427c" UNIQUE ("alias"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "snippet_versions" ("id" varchar PRIMARY KEY NOT NULL, "snippetId" varchar NOT NULL, "version" integer NOT NULL, "alias" varchar NOT NULL, "title" varchar NOT NULL DEFAULT (''), "description" text, "code" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_2487f4aabeb20c4192ee30e09a2" UNIQUE ("snippetId", "version"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_credentials" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "credentialId" varchar NOT NULL, "alias" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_02756536236c408dbb58b3fc964" UNIQUE ("scenarioId", "alias"), CONSTRAINT "FK_37f19dadd8e524b22a807ece1a9" FOREIGN KEY ("scenarioId") REFERENCES "scenarios" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_96676b988693d5ca2923782530c" FOREIGN KEY ("credentialId") REFERENCES "credentials" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_credentials"("id", "scenarioId", "credentialId", "alias", "createdAt") SELECT "id", "scenarioId", "credentialId", "alias", "createdAt" FROM "scenario_credentials"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_credentials"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_credentials" RENAME TO "scenario_credentials"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_steps" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "order" integer NOT NULL DEFAULT (0), "title" text, "execCode" text, "timeoutSeconds" integer, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "FK_4bab3637cc3bf37677bb01c7446" FOREIGN KEY ("scenarioId") REFERENCES "scenarios" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_steps"("id", "scenarioId", "order", "title", "execCode", "timeoutSeconds", "createdAt", "updatedAt") SELECT "id", "scenarioId", "order", "title", "execCode", "timeoutSeconds", "createdAt", "updatedAt" FROM "scenario_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_steps"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_steps" RENAME TO "scenario_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenarios" ("id" varchar PRIMARY KEY NOT NULL, "name" varchar NOT NULL, "description" text, "environmentId" varchar, "timeoutSeconds" integer, "version" integer NOT NULL DEFAULT (1), "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "FK_ffdcf9186d95114f0dab068e20a" FOREIGN KEY ("environmentId") REFERENCES "environments" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenarios"("id", "name", "description", "environmentId", "timeoutSeconds", "version", "createdAt", "updatedAt") SELECT "id", "name", "description", "environmentId", "timeoutSeconds", "version", "createdAt", "updatedAt" FROM "scenarios"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenarios"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenarios" RENAME TO "scenarios"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_files" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "fileId" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "FK_c41719984235f8984d1c6b92ef5" FOREIGN KEY ("scenarioId") REFERENCES "scenarios" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_67013a49e7948fb530a7d956e2b" FOREIGN KEY ("fileId") REFERENCES "files" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_files"("id", "scenarioId", "fileId", "createdAt") SELECT "id", "scenarioId", "fileId", "createdAt" FROM "scenario_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_files"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_files" RENAME TO "scenario_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_run_steps" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "scenarioStepId" varchar, "title" text, "execCode" text, "timeoutSeconds" integer, "status" text NOT NULL DEFAULT ('waiting'), "order" integer NOT NULL DEFAULT (0), "description" text, "output" text, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "FK_213c27405af3433011121babb58" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_e84cd4c7725bdc5dfd09d18d92f" FOREIGN KEY ("scenarioStepId") REFERENCES "scenario_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_run_steps"("id", "runId", "scenarioStepId", "title", "execCode", "timeoutSeconds", "status", "order", "description", "output", "createdAt", "updatedAt") SELECT "id", "runId", "scenarioStepId", "title", "execCode", "timeoutSeconds", "status", "order", "description", "output", "createdAt", "updatedAt" FROM "scenario_run_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_steps"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_run_steps" RENAME TO "scenario_run_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_runs" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "environmentId" varchar, "sessionId" varchar, "scenarioVersion" integer, "status" text NOT NULL DEFAULT ('pending'), "saveSession" boolean NOT NULL DEFAULT (0), "traceMode" text, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "FK_1d2c2595dfff133de062f9c692a" FOREIGN KEY ("scenarioId") REFERENCES "scenarios" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_5076ffbd1b4fa71f5de011eba1f" FOREIGN KEY ("environmentId") REFERENCES "environments" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_068b01cdfa49095433f245d6708" FOREIGN KEY ("sessionId") REFERENCES "sessions" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_runs"("id", "scenarioId", "environmentId", "sessionId", "scenarioVersion", "status", "saveSession", "traceMode", "createdAt", "updatedAt") SELECT "id", "scenarioId", "environmentId", "sessionId", "scenarioVersion", "status", "saveSession", "traceMode", "createdAt", "updatedAt" FROM "scenario_runs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_runs"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_runs" RENAME TO "scenario_runs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_run_files" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "fileId" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "FK_5fc35a4bfc42d7566a0f7706902" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_637619025bdb0b6a89fae6e178d" FOREIGN KEY ("fileId") REFERENCES "files" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_run_files"("id", "runId", "fileId", "createdAt") SELECT "id", "runId", "fileId", "createdAt" FROM "scenario_run_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_files"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_run_files" RENAME TO "scenario_run_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "seq" integer NOT NULL DEFAULT (0), "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "FK_dde48478a42823e583a360dd468" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_62d82b9fce3a6a2947ed1136c67" FOREIGN KEY ("stepRunId") REFERENCES "scenario_run_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "seq", "createdAt") SELECT "id", "runId", "stepRunId", "level", "message", "seq", "createdAt" FROM "scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_logs"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_run_logs" RENAME TO "scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_versions" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "version" integer NOT NULL, "name" varchar NOT NULL, "description" text, "environmentId" text, "timeoutSeconds" integer, "steps" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_e1a56dce2b7e0379bb5bbdf8c1f" UNIQUE ("scenarioId", "version"), CONSTRAINT "FK_f5ccfb45c7847cfab74cf4f17b6" FOREIGN KEY ("scenarioId") REFERENCES "scenarios" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_versions"("id", "scenarioId", "version", "name", "description", "environmentId", "timeoutSeconds", "steps", "createdAt") SELECT "id", "scenarioId", "version", "name", "description", "environmentId", "timeoutSeconds", "steps", "createdAt" FROM "scenario_versions"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_versions"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_versions" RENAME TO "scenario_versions"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_snippet_versions" ("id" varchar PRIMARY KEY NOT NULL, "snippetId" varchar NOT NULL, "version" integer NOT NULL, "alias" varchar NOT NULL, "title" varchar NOT NULL DEFAULT (''), "description" text, "code" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_2487f4aabeb20c4192ee30e09a2" UNIQUE ("snippetId", "version"), CONSTRAINT "FK_0d3a004957c9553619be11635fd" FOREIGN KEY ("snippetId") REFERENCES "snippets" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_snippet_versions"("id", "snippetId", "version", "alias", "title", "description", "code", "createdAt") SELECT "id", "snippetId", "version", "alias", "title", "description", "code", "createdAt" FROM "snippet_versions"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "snippet_versions"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_snippet_versions" RENAME TO "snippet_versions"`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "snippet_versions" RENAME TO "temporary_snippet_versions"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "snippet_versions" ("id" varchar PRIMARY KEY NOT NULL, "snippetId" varchar NOT NULL, "version" integer NOT NULL, "alias" varchar NOT NULL, "title" varchar NOT NULL DEFAULT (''), "description" text, "code" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_2487f4aabeb20c4192ee30e09a2" UNIQUE ("snippetId", "version"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "snippet_versions"("id", "snippetId", "version", "alias", "title", "description", "code", "createdAt") SELECT "id", "snippetId", "version", "alias", "title", "description", "code", "createdAt" FROM "temporary_snippet_versions"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_snippet_versions"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_versions" RENAME TO "temporary_scenario_versions"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_versions" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "version" integer NOT NULL, "name" varchar NOT NULL, "description" text, "environmentId" text, "timeoutSeconds" integer, "steps" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_e1a56dce2b7e0379bb5bbdf8c1f" UNIQUE ("scenarioId", "version"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_versions"("id", "scenarioId", "version", "name", "description", "environmentId", "timeoutSeconds", "steps", "createdAt") SELECT "id", "scenarioId", "version", "name", "description", "environmentId", "timeoutSeconds", "steps", "createdAt" FROM "temporary_scenario_versions"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_versions"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_run_logs" RENAME TO "temporary_scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "seq" integer NOT NULL DEFAULT (0), "createdAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "seq", "createdAt") SELECT "id", "runId", "stepRunId", "level", "message", "seq", "createdAt" FROM "temporary_scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_run_logs"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_run_files" RENAME TO "temporary_scenario_run_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_files" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "fileId" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_run_files"("id", "runId", "fileId", "createdAt") SELECT "id", "runId", "fileId", "createdAt" FROM "temporary_scenario_run_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_run_files"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_runs" RENAME TO "temporary_scenario_runs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_runs" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "environmentId" varchar, "sessionId" varchar, "scenarioVersion" integer, "status" text NOT NULL DEFAULT ('pending'), "saveSession" boolean NOT NULL DEFAULT (0), "traceMode" text, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_runs"("id", "scenarioId", "environmentId", "sessionId", "scenarioVersion", "status", "saveSession", "traceMode", "createdAt", "updatedAt") SELECT "id", "scenarioId", "environmentId", "sessionId", "scenarioVersion", "status", "saveSession", "traceMode", "createdAt", "updatedAt" FROM "temporary_scenario_runs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_runs"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_run_steps" RENAME TO "temporary_scenario_run_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_steps" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "scenarioStepId" varchar, "title" text, "execCode" text, "timeoutSeconds" integer, "status" text NOT NULL DEFAULT ('waiting'), "order" integer NOT NULL DEFAULT (0), "description" text, "output" text, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_run_steps"("id", "runId", "scenarioStepId", "title", "execCode", "timeoutSeconds", "status", "order", "description", "output", "createdAt", "updatedAt") SELECT "id", "runId", "scenarioStepId", "title", "execCode", "timeoutSeconds", "status", "order", "description", "output", "createdAt", "updatedAt" FROM "temporary_scenario_run_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_run_steps"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_files" RENAME TO "temporary_scenario_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_files" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "fileId" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_files"("id", "scenarioId", "fileId", "createdAt") SELECT "id", "scenarioId", "fileId", "createdAt" FROM "temporary_scenario_files"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_files"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenarios" RENAME TO "temporary_scenarios"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenarios" ("id" varchar PRIMARY KEY NOT NULL, "name" varchar NOT NULL, "description" text, "environmentId" varchar, "timeoutSeconds" integer, "version" integer NOT NULL DEFAULT (1), "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenarios"("id", "name", "description", "environmentId", "timeoutSeconds", "version", "createdAt", "updatedAt") SELECT "id", "name", "description", "environmentId", "timeoutSeconds", "version", "createdAt", "updatedAt" FROM "temporary_scenarios"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenarios"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_steps" RENAME TO "temporary_scenario_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_steps" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "order" integer NOT NULL DEFAULT (0), "title" text, "execCode" text, "timeoutSeconds" integer, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_steps"("id", "scenarioId", "order", "title", "execCode", "timeoutSeconds", "createdAt", "updatedAt") SELECT "id", "scenarioId", "order", "title", "execCode", "timeoutSeconds", "createdAt", "updatedAt" FROM "temporary_scenario_steps"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_steps"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_credentials" RENAME TO "temporary_scenario_credentials"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_credentials" ("id" varchar PRIMARY KEY NOT NULL, "scenarioId" varchar NOT NULL, "credentialId" varchar NOT NULL, "alias" varchar NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), CONSTRAINT "UQ_02756536236c408dbb58b3fc964" UNIQUE ("scenarioId", "alias"))`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_credentials"("id", "scenarioId", "credentialId", "alias", "createdAt") SELECT "id", "scenarioId", "credentialId", "alias", "createdAt" FROM "temporary_scenario_credentials"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_credentials"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "snippet_versions"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "snippets"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_versions"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_logs"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_files"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_runs"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_steps"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "sessions"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_files"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenarios"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_steps"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_credentials"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "files"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "environments"`);
|
||||||
|
await queryRunner.query(`DROP TABLE "credentials"`);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
import { MigrationInterface, QueryRunner } from "typeorm";
|
||||||
|
|
||||||
|
export class AddRunLogContext1790848194828 implements MigrationInterface {
|
||||||
|
name = "AddRunLogContext1790848194828";
|
||||||
|
|
||||||
|
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "seq" integer NOT NULL DEFAULT (0), "context" text, CONSTRAINT "FK_dde48478a42823e583a360dd468" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_62d82b9fce3a6a2947ed1136c67" FOREIGN KEY ("stepRunId") REFERENCES "scenario_run_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "createdAt", "seq") SELECT "id", "runId", "stepRunId", "level", "message", "createdAt", "seq" FROM "scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_logs"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_run_logs" RENAME TO "scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_run_logs" RENAME TO "temporary_scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "seq" integer NOT NULL DEFAULT (0), CONSTRAINT "FK_dde48478a42823e583a360dd468" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION, CONSTRAINT "FK_62d82b9fce3a6a2947ed1136c67" FOREIGN KEY ("stepRunId") REFERENCES "scenario_run_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "createdAt", "seq") SELECT "id", "runId", "stepRunId", "level", "message", "createdAt", "seq" FROM "temporary_scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_run_logs"`);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
import { MigrationInterface, QueryRunner } from "typeorm";
|
||||||
|
|
||||||
|
export class AddRunLogData1790850734763 implements MigrationInterface {
|
||||||
|
name = "AddRunLogData1790850734763";
|
||||||
|
|
||||||
|
public async up(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "temporary_scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "seq" integer NOT NULL DEFAULT (0), "context" text, "data" text, CONSTRAINT "FK_62d82b9fce3a6a2947ed1136c67" FOREIGN KEY ("stepRunId") REFERENCES "scenario_run_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_dde48478a42823e583a360dd468" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "temporary_scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "createdAt", "seq", "context") SELECT "id", "runId", "stepRunId", "level", "message", "createdAt", "seq", "context" FROM "scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "scenario_run_logs"`);
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "temporary_scenario_run_logs" RENAME TO "scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
public async down(queryRunner: QueryRunner): Promise<void> {
|
||||||
|
await queryRunner.query(
|
||||||
|
`ALTER TABLE "scenario_run_logs" RENAME TO "temporary_scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`CREATE TABLE "scenario_run_logs" ("id" varchar PRIMARY KEY NOT NULL, "runId" varchar NOT NULL, "stepRunId" varchar, "level" text NOT NULL DEFAULT ('log'), "message" text NOT NULL, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "seq" integer NOT NULL DEFAULT (0), "context" text, CONSTRAINT "FK_62d82b9fce3a6a2947ed1136c67" FOREIGN KEY ("stepRunId") REFERENCES "scenario_run_steps" ("id") ON DELETE SET NULL ON UPDATE NO ACTION, CONSTRAINT "FK_dde48478a42823e583a360dd468" FOREIGN KEY ("runId") REFERENCES "scenario_runs" ("id") ON DELETE CASCADE ON UPDATE NO ACTION)`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(
|
||||||
|
`INSERT INTO "scenario_run_logs"("id", "runId", "stepRunId", "level", "message", "createdAt", "seq", "context") SELECT "id", "runId", "stepRunId", "level", "message", "createdAt", "seq", "context" FROM "temporary_scenario_run_logs"`,
|
||||||
|
);
|
||||||
|
await queryRunner.query(`DROP TABLE "temporary_scenario_run_logs"`);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
import { Initial1790793447827 } from "./1790793447827-Initial";
|
||||||
|
import { AddRunLogContext1790848194828 } from "./1790848194828-AddRunLogContext";
|
||||||
|
import { AddRunLogData1790850734763 } from "./1790850734763-AddRunLogData";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* All migrations, oldest first. Listed explicitly (instead of a glob) so the
|
||||||
|
* same list works from compiled JS, ts-jest and the TypeORM CLI.
|
||||||
|
*/
|
||||||
|
export const MIGRATIONS = [
|
||||||
|
Initial1790793447827,
|
||||||
|
AddRunLogContext1790848194828,
|
||||||
|
AddRunLogData1790850734763,
|
||||||
|
];
|
||||||
+22
-2
@@ -1,11 +1,13 @@
|
|||||||
import { RequestMethod, ValidationPipe } from "@nestjs/common";
|
import { RequestMethod, ValidationPipe } from "@nestjs/common";
|
||||||
import { ConfigService } from "@nestjs/config";
|
import { ConfigService } from "@nestjs/config";
|
||||||
import { NestFactory } from "@nestjs/core";
|
import { NestFactory } from "@nestjs/core";
|
||||||
|
import { DataSource } from "typeorm";
|
||||||
import type { NestExpressApplication } from "@nestjs/platform-express";
|
import type { NestExpressApplication } from "@nestjs/platform-express";
|
||||||
import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
|
import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
|
||||||
import { AppModule } from "./app.module";
|
import { AppModule } from "./app.module";
|
||||||
import { appPackage } from "./common/app-package";
|
import { appPackage } from "./common/app-package";
|
||||||
import { configureBodyParsers } from "./common/body-parsers";
|
import { configureBodyParsers } from "./common/body-parsers";
|
||||||
|
import { corsOrigins } from "./common/cors";
|
||||||
import { TraceLogger } from "./common/trace-logger";
|
import { TraceLogger } from "./common/trace-logger";
|
||||||
import { AppConfig } from "./config/app.config";
|
import { AppConfig } from "./config/app.config";
|
||||||
import { HttpExceptionFilter } from "./filters/http-exception.filter";
|
import { HttpExceptionFilter } from "./filters/http-exception.filter";
|
||||||
@@ -35,11 +37,21 @@ async function bootstrap() {
|
|||||||
logger: new TraceLogger("Bootstrap", { timestamp: true }),
|
logger: new TraceLogger("Bootstrap", { timestamp: true }),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The schema is managed by migrations; refuse to run against an outdated one.
|
||||||
|
// Checked before app.init(), i.e. before any module touches the tables.
|
||||||
|
if (await app.get(DataSource).showMigrations()) {
|
||||||
|
throw new Error(
|
||||||
|
"The database has pending migrations. Run `npm -w server run migration:run` " +
|
||||||
|
"(the Docker image runs them automatically before starting the server).",
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
app.setGlobalPrefix(API_PREFIX, {
|
app.setGlobalPrefix(API_PREFIX, {
|
||||||
exclude: [
|
exclude: [
|
||||||
{ path: "health", method: RequestMethod.ALL },
|
{ path: "health", method: RequestMethod.ALL },
|
||||||
{ path: "healthz", method: RequestMethod.ALL },
|
{ path: "healthz", method: RequestMethod.ALL },
|
||||||
{ path: "mcp", method: RequestMethod.ALL },
|
{ path: "mcp", method: RequestMethod.ALL },
|
||||||
|
{ path: "manifest.json", method: RequestMethod.ALL },
|
||||||
],
|
],
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -53,7 +65,7 @@ async function bootstrap() {
|
|||||||
const nodeEnv = config.get("NODE_ENV");
|
const nodeEnv = config.get("NODE_ENV");
|
||||||
|
|
||||||
app.enableCors({
|
app.enableCors({
|
||||||
origin: ["http://localhost:5173", "http://127.0.0.1:5173"],
|
origin: corsOrigins(nodeEnv, config.get("CORS_ORIGINS")),
|
||||||
methods: ["GET", "HEAD", "PUT", "PATCH", "POST", "DELETE", "OPTIONS"],
|
methods: ["GET", "HEAD", "PUT", "PATCH", "POST", "DELETE", "OPTIONS"],
|
||||||
credentials: true,
|
credentials: true,
|
||||||
});
|
});
|
||||||
@@ -76,4 +88,12 @@ async function bootstrap() {
|
|||||||
logger.log(`MCP endpoint available at http://localhost:${port}/mcp`);
|
logger.log(`MCP endpoint available at http://localhost:${port}/mcp`);
|
||||||
}
|
}
|
||||||
|
|
||||||
bootstrap();
|
// Startup failures (pending migrations, port in use, ...) must stop the
|
||||||
|
// process with an error code; the handlers above only keep a running server alive
|
||||||
|
bootstrap().catch((err: unknown) => {
|
||||||
|
processLogger.error(
|
||||||
|
`Startup failed: ${err instanceof Error ? err.message : String(err)}`,
|
||||||
|
err instanceof Error ? err.stack : undefined,
|
||||||
|
);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
import { Controller, Get, Header } from "@nestjs/common";
|
||||||
|
import { ConfigService } from "@nestjs/config";
|
||||||
|
import { ApiOkResponse, ApiOperation, ApiTags } from "@nestjs/swagger";
|
||||||
|
import { AppConfig } from "../config/app.config";
|
||||||
|
import { ManifestDto } from "./manifest.dto";
|
||||||
|
|
||||||
|
@ApiTags("manifest")
|
||||||
|
@Controller()
|
||||||
|
export class ManifestController {
|
||||||
|
constructor(private readonly config: ConfigService<AppConfig, true>) {}
|
||||||
|
|
||||||
|
@Get("manifest.json")
|
||||||
|
// Clients cache the manifest themselves; the browser just revalidates it (ETag)
|
||||||
|
@Header("Cache-Control", "no-cache")
|
||||||
|
@ApiOperation({ summary: "Public client configuration and app version" })
|
||||||
|
@ApiOkResponse({ type: ManifestDto })
|
||||||
|
manifest(): ManifestDto {
|
||||||
|
return {
|
||||||
|
name: this.config.get("APP_NAME"),
|
||||||
|
version: this.config.get("APP_VERSION"),
|
||||||
|
runLogs: {
|
||||||
|
dataLimits: {
|
||||||
|
bytes: this.config.get("RUN_LOG_DATA_COLLAPSE_BYTES"),
|
||||||
|
lines: this.config.get("RUN_LOG_DATA_COLLAPSE_LINES"),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
import { ApiProperty } from "@nestjs/swagger";
|
||||||
|
|
||||||
|
export class RunLogDataLimitsDto {
|
||||||
|
@ApiProperty({
|
||||||
|
description: "Data blocks over this many bytes (pretty-printed) start collapsed",
|
||||||
|
example: 256,
|
||||||
|
})
|
||||||
|
bytes!: number;
|
||||||
|
|
||||||
|
@ApiProperty({
|
||||||
|
description: "Data blocks over this many lines (pretty-printed) start collapsed",
|
||||||
|
example: 5,
|
||||||
|
})
|
||||||
|
lines!: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class RunLogsManifestDto {
|
||||||
|
@ApiProperty({ type: RunLogDataLimitsDto })
|
||||||
|
dataLimits!: RunLogDataLimitsDto;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ManifestDto {
|
||||||
|
@ApiProperty({ example: "liqa" })
|
||||||
|
name!: string;
|
||||||
|
|
||||||
|
@ApiProperty({ example: "1.4.0" })
|
||||||
|
version!: string;
|
||||||
|
|
||||||
|
@ApiProperty({ type: RunLogsManifestDto })
|
||||||
|
runLogs!: RunLogsManifestDto;
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
import { Module } from "@nestjs/common";
|
||||||
|
import { ManifestController } from "./manifest.controller";
|
||||||
|
|
||||||
|
@Module({
|
||||||
|
controllers: [ManifestController],
|
||||||
|
})
|
||||||
|
export class ManifestModule {}
|
||||||
@@ -13,6 +13,7 @@ import {
|
|||||||
ValidateNested,
|
ValidateNested,
|
||||||
} from "class-validator";
|
} from "class-validator";
|
||||||
import { EnvironmentData } from "../../environment/environment.entity";
|
import { EnvironmentData } from "../../environment/environment.entity";
|
||||||
|
import { SnippetExportDto } from "../../snippet/dto/snippet-export.dto";
|
||||||
|
|
||||||
export class ScenarioStepExportDto {
|
export class ScenarioStepExportDto {
|
||||||
@ApiPropertyOptional()
|
@ApiPropertyOptional()
|
||||||
@@ -154,4 +155,5 @@ export class ScenarioExportDto {
|
|||||||
export type ExportEntity =
|
export type ExportEntity =
|
||||||
| EnvironmentExportInlineDto
|
| EnvironmentExportInlineDto
|
||||||
| CredentialExportDto
|
| CredentialExportDto
|
||||||
|
| SnippetExportDto
|
||||||
| ScenarioExportDto;
|
| ScenarioExportDto;
|
||||||
@@ -370,7 +370,11 @@ function buildContext(page: Page, browser: BrowserContext, stepOutputs: StepOutp
|
|||||||
log: (...args: unknown[]) => console.log(...args),
|
log: (...args: unknown[]) => console.log(...args),
|
||||||
warn: (...args: unknown[]) => console.warn(...args),
|
warn: (...args: unknown[]) => console.warn(...args),
|
||||||
error: (...args: unknown[]) => console.error(...args),
|
error: (...args: unknown[]) => console.error(...args),
|
||||||
assert: async (fn: () => boolean | Promise<boolean>, description: string): Promise<void> => {
|
assert: async (
|
||||||
|
fn: () => boolean | Promise<boolean>,
|
||||||
|
description: string,
|
||||||
|
details?: unknown,
|
||||||
|
): Promise<void> => {
|
||||||
let passed: boolean;
|
let passed: boolean;
|
||||||
let failureReason: string | undefined;
|
let failureReason: string | undefined;
|
||||||
try {
|
try {
|
||||||
@@ -386,7 +390,11 @@ function buildContext(page: Page, browser: BrowserContext, stepOutputs: StepOutp
|
|||||||
const message = failureReason
|
const message = failureReason
|
||||||
? \`Assertion failed: \${description} (\${failureReason})\`
|
? \`Assertion failed: \${description} (\${failureReason})\`
|
||||||
: \`Assertion failed: \${description}\`;
|
: \`Assertion failed: \${description}\`;
|
||||||
console.error(message);
|
if (details !== undefined) {
|
||||||
|
console.error(message, details);
|
||||||
|
} else {
|
||||||
|
console.error(message);
|
||||||
|
}
|
||||||
throw new Error(message);
|
throw new Error(message);
|
||||||
},
|
},
|
||||||
getStepOutput: async (order: number): Promise<unknown> => {
|
getStepOutput: async (order: number): Promise<unknown> => {
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import {
|
|||||||
import { ScenarioRunStepEntity } from "./scenario-run-step.entity";
|
import { ScenarioRunStepEntity } from "./scenario-run-step.entity";
|
||||||
import { ScenarioRunEntity } from "./scenario-run.entity";
|
import { ScenarioRunEntity } from "./scenario-run.entity";
|
||||||
|
|
||||||
export type LogLevel = "log" | "warn" | "error";
|
export type LogLevel = "debug" | "log" | "warn" | "error";
|
||||||
|
|
||||||
@Entity("scenario_run_logs")
|
@Entity("scenario_run_logs")
|
||||||
export class ScenarioRunLogEntity {
|
export class ScenarioRunLogEntity {
|
||||||
@@ -36,9 +36,18 @@ export class ScenarioRunLogEntity {
|
|||||||
@Column({ type: "text", default: "log" })
|
@Column({ type: "text", default: "log" })
|
||||||
level: LogLevel;
|
level: LogLevel;
|
||||||
|
|
||||||
|
// Where the message was generated, e.g. "step:2", "snippet:login", "assertion:pass"
|
||||||
|
@Column({ type: "text", nullable: true })
|
||||||
|
context: string | null;
|
||||||
|
|
||||||
@Column({ type: "text" })
|
@Column({ type: "text" })
|
||||||
message: string;
|
message: string;
|
||||||
|
|
||||||
|
// JSON payload attached to the message (e.g. a created file's metadata),
|
||||||
|
// kept separate so message stays a stable, human-readable string.
|
||||||
|
@Column({ type: "text", nullable: true })
|
||||||
|
data: string | null;
|
||||||
|
|
||||||
// Assigned in call order per run, since concurrent unawaited writes can
|
// Assigned in call order per run, since concurrent unawaited writes can
|
||||||
// otherwise persist out of order (createdAt alone isn't a reliable tiebreaker).
|
// otherwise persist out of order (createdAt alone isn't a reliable tiebreaker).
|
||||||
@Column({ type: "int", default: 0 })
|
@Column({ type: "int", default: 0 })
|
||||||
|
|||||||
@@ -13,7 +13,10 @@ import { Repository } from "typeorm";
|
|||||||
import { type AppConfig, TraceMode } from "../config/app.config";
|
import { type AppConfig, TraceMode } from "../config/app.config";
|
||||||
import { FileStorageService } from "../file/file-storage.service";
|
import { FileStorageService } from "../file/file-storage.service";
|
||||||
import type { ScriptLogger } from "../code-executor/code-executor.service";
|
import type { ScriptLogger } from "../code-executor/code-executor.service";
|
||||||
import { CodeExecutorService } from "../code-executor/code-executor.service";
|
import {
|
||||||
|
CodeExecutorService,
|
||||||
|
findAssertionFailure,
|
||||||
|
} from "../code-executor/code-executor.service";
|
||||||
import { ExecContextBuilder } from "../code-executor/exec-context.builder";
|
import { ExecContextBuilder } from "../code-executor/exec-context.builder";
|
||||||
import { traceStorage } from "../common/trace-context";
|
import { traceStorage } from "../common/trace-context";
|
||||||
import { TraceLogger } from "../common/trace-logger";
|
import { TraceLogger } from "../common/trace-logger";
|
||||||
@@ -143,26 +146,36 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
statuses: ["pending", "waiting"],
|
statuses: ["pending", "waiting"],
|
||||||
})
|
})
|
||||||
.execute();
|
.execute();
|
||||||
this.persistLog(runId, null, "error", reason);
|
this.persistLog(runId, null, "error", reason, "run");
|
||||||
}
|
}
|
||||||
|
|
||||||
private persistLog(
|
private persistLog(
|
||||||
runId: string,
|
runId: string,
|
||||||
stepRunId: string | null,
|
stepRunId: string | null,
|
||||||
level: "log" | "warn" | "error",
|
level: "debug" | "log" | "warn" | "error",
|
||||||
message: string,
|
message: string,
|
||||||
|
context: string | null = null,
|
||||||
|
data: unknown = null,
|
||||||
): void {
|
): void {
|
||||||
const seq = (this.runLogSeq.get(runId) ?? 0) + 1;
|
const seq = (this.runLogSeq.get(runId) ?? 0) + 1;
|
||||||
this.runLogSeq.set(runId, seq);
|
this.runLogSeq.set(runId, seq);
|
||||||
void this.runLogRepo.save(
|
void this.runLogRepo.save(
|
||||||
this.runLogRepo.create({ runId, stepRunId, level, message, seq }),
|
this.runLogRepo.create({
|
||||||
|
runId,
|
||||||
|
stepRunId,
|
||||||
|
level,
|
||||||
|
message,
|
||||||
|
context,
|
||||||
|
data: data != null ? JSON.stringify(data) : null,
|
||||||
|
seq,
|
||||||
|
}),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
private stepLogger(stepRunId: string, runId: string): ScriptLogger {
|
private stepLogger(stepRunId: string, runId: string): ScriptLogger {
|
||||||
return (level, msg) => {
|
return (level, msg, context, data) => {
|
||||||
this.logger[level](`StepRun #${stepRunId} script: ${msg}`);
|
this.logger[level](`StepRun #${stepRunId} script: ${msg}`);
|
||||||
this.persistLog(runId, stepRunId, level, msg);
|
this.persistLog(runId, stepRunId, level, msg, context ?? null, data ?? null);
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -384,6 +397,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
stepRun.id,
|
stepRun.id,
|
||||||
"log",
|
"log",
|
||||||
`Step ${step.order} started${step.title ? `: ${step.title}` : ""}`,
|
`Step ${step.order} started${step.title ? `: ${step.title}` : ""}`,
|
||||||
|
`step:${step.order}`,
|
||||||
);
|
);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
@@ -402,6 +416,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
.browser(context)
|
.browser(context)
|
||||||
.code(step.execCode)
|
.code(step.execCode)
|
||||||
.log(this.stepLogger(stepRun.id, stepRun.runId))
|
.log(this.stepLogger(stepRun.id, stepRun.runId))
|
||||||
|
.logContext(`step:${step.order}`)
|
||||||
.getStepOutput(getStepOutput)
|
.getStepOutput(getStepOutput)
|
||||||
.credentials(creds)
|
.credentials(creds)
|
||||||
.environment(env)
|
.environment(env)
|
||||||
@@ -434,7 +449,11 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
} catch (err) {
|
} catch (err) {
|
||||||
const msg = (err as Error).message ?? String(err);
|
const msg = (err as Error).message ?? String(err);
|
||||||
this.logger.error(`StepRun #${stepRun.id} threw: ${msg}`);
|
this.logger.error(`StepRun #${stepRun.id} threw: ${msg}`);
|
||||||
await this.failStepRun(stepRun, msg);
|
await this.failStepRun(
|
||||||
|
stepRun,
|
||||||
|
msg,
|
||||||
|
findAssertionFailure(err)?.summary,
|
||||||
|
);
|
||||||
} finally {
|
} finally {
|
||||||
clearTimeout(timeoutId);
|
clearTimeout(timeoutId);
|
||||||
}
|
}
|
||||||
@@ -527,6 +546,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
null,
|
null,
|
||||||
"log",
|
"log",
|
||||||
"Playwright trace uploaded to run files (open with `npx playwright show-trace trace.zip` or https://trace.playwright.dev)",
|
"Playwright trace uploaded to run files (open with `npx playwright show-trace trace.zip` or https://trace.playwright.dev)",
|
||||||
|
"run",
|
||||||
);
|
);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
this.logger.warn(
|
this.logger.warn(
|
||||||
@@ -557,6 +577,8 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
stepRun.id,
|
stepRun.id,
|
||||||
"log",
|
"log",
|
||||||
`Step ${stepRun.order} passed`,
|
`Step ${stepRun.order} passed`,
|
||||||
|
`step:${stepRun.order}`,
|
||||||
|
output,
|
||||||
);
|
);
|
||||||
|
|
||||||
// Find the next waiting step in this run (next by order)
|
// Find the next waiting step in this run (next by order)
|
||||||
@@ -586,9 +608,14 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `logSummary` replaces `description` in the "Step N failed" log entry, e.g.
|
||||||
|
* for assertion failures whose details are already logged.
|
||||||
|
*/
|
||||||
private async failStepRun(
|
private async failStepRun(
|
||||||
stepRun: ScenarioRunStepEntity,
|
stepRun: ScenarioRunStepEntity,
|
||||||
description: string,
|
description: string,
|
||||||
|
logSummary?: string,
|
||||||
): Promise<void> {
|
): Promise<void> {
|
||||||
stepRun.status = "fail";
|
stepRun.status = "fail";
|
||||||
stepRun.description = description;
|
stepRun.description = description;
|
||||||
@@ -598,7 +625,8 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
stepRun.runId,
|
stepRun.runId,
|
||||||
stepRun.id,
|
stepRun.id,
|
||||||
"error",
|
"error",
|
||||||
`Step ${stepRun.order} failed: ${description}`,
|
`Step ${stepRun.order} failed: ${logSummary ?? description}`,
|
||||||
|
`step:${stepRun.order}`,
|
||||||
);
|
);
|
||||||
|
|
||||||
await this.dumpPageOnFailure(stepRun);
|
await this.dumpPageOnFailure(stepRun);
|
||||||
@@ -666,6 +694,7 @@ export class ScenarioSchedulerService implements OnModuleInit {
|
|||||||
stepRun.id,
|
stepRun.id,
|
||||||
"log",
|
"log",
|
||||||
`Step ${stepRun.order} failed: page dump uploaded to run files`,
|
`Step ${stepRun.order} failed: page dump uploaded to run files`,
|
||||||
|
`step:${stepRun.order}`,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Loaded 100 of 111 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user