Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6e9b99e415 | ||
|
|
8aadbd25fb | ||
|
|
9f341719ef | ||
|
|
5de9272281 | ||
|
|
a6d468bd2c | ||
|
|
b0f2c72b5f | ||
|
|
e586ab9bd9 | ||
|
|
68415f805b | ||
|
|
a4bfa3117f | ||
|
|
8935783371 | ||
|
|
cf56840df9 | ||
|
|
1c5c906cbb | ||
|
|
ac12301818 | ||
|
|
84dba6d670 |
No files matched your search
@@ -7,3 +7,4 @@ node_modules
|
||||
**/*.log
|
||||
data
|
||||
keys
|
||||
**/*.tsbuildinfo
|
||||
+36
-15
@@ -1,20 +1,41 @@
|
||||
NODE_ENV=development
|
||||
PORT=3000
|
||||
## Optional overrides: copy to .env and uncomment the settings you need.
|
||||
## 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
|
||||
KEYS_DIR=keys
|
||||
## production in the Docker image; also selects the default CORS origins
|
||||
# NODE_ENV=development
|
||||
# PORT=3000
|
||||
|
||||
# SQLite database path
|
||||
DB_PATH=data/sessions.db
|
||||
## Origins allowed to call the API cross-origin (comma separated). Default: the
|
||||
## 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
|
||||
|
||||
# Playwright executable (set in Docker; leave empty to use system default)
|
||||
## SQLite database path
|
||||
# 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
|
||||
|
||||
## 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
|
||||
|
||||
# Session lifecycle
|
||||
# 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
|
||||
PLAYWRIGHT_TRACE_MODE=on
|
||||
## Directory with the built client to serve at / (the Docker image sets it to
|
||||
## "client"; leave unset to not serve the UI, e.g. when using the Vite dev server)
|
||||
# CLIENT_DIR=client
|
||||
+131
@@ -2,6 +2,137 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## 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
|
||||
|
||||
Changes since 1.19.0:
|
||||
|
||||
### Changed
|
||||
|
||||
- Upgraded to Node.js 24: the Docker image is based on `node:24-slim`, and the root `package.json` declares `"engines": { "node": ">=24" }`.
|
||||
- The server reads the app name and version (startup log, Swagger, MCP server info, `APP_NAME`/`APP_VERSION`) from the workspace root `package.json`. Previously local runs reported the server workspace's own `liqa-server` / `1.0.0`; the server workspace no longer has a version.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Tests using a local HTTP server bind to `127.0.0.1` instead of `localhost`, which could resolve to an unreachable `::1` inside Docker containers.
|
||||
|
||||
## 1.19.0 - 2026-09-30
|
||||
|
||||
Changes since 1.18.0:
|
||||
|
||||
### Changed
|
||||
|
||||
- **Breaking (deployment):** the whole application now runs from a single image and container. The server serves the built client itself (new `CLIENT_DIR` setting, set by the image) next to the API, MCP and Swagger, so the UI moved from http://localhost:13001 to **http://localhost:13000**. The root `Dockerfile` replaces `server/Dockerfile`, `client/Dockerfile` and `client/nginx.conf`, and `compose.yaml` has a single `liqa` service. When upgrading, run `docker compose up -d --build --remove-orphans` to remove the old `server` and `client` containers.
|
||||
- The image uses Playwright's headless-only Chromium build (`chromium-headless-shell`, always matching the installed Playwright version) with only the libraries it needs, instead of Debian's desktop `chromium` package. Fonts are now DejaVu and Liberation (metric-compatible with Arial/Times) instead of Noto. Together with clearing the npm cache, this shrinks the image from 1.76 GB to 1.07 GB.
|
||||
|
||||
## 1.18.0 - 2026-09-30
|
||||
|
||||
Changes since 1.17.0:
|
||||
|
||||
### Added
|
||||
|
||||
- Added a central import: `POST /import`, an Import page in the UI, and the `import_yaml` MCP tool. It takes YAML made of `---`-separated documents, each holding one exported item or a list of items (JSON is accepted too), with any mix of environments, credentials, snippets and scenarios. All items are validated before anything is imported, and they are imported in dependency order (environments, credentials, snippets, scenarios), so a scenario can reference an environment or credential from the same file.
|
||||
|
||||
### Changed
|
||||
|
||||
- The Import buttons on the scenario, snippet, credential and environment list pages use the central import. When the file holds exactly one item of the page's kind, that item is opened; otherwise the Import page shows everything that was imported.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Scenario exports that included the environment or credentials were not valid YAML (all entities were written into one document). Each entity is now a separate `---` document.
|
||||
|
||||
## 1.17.0 - 2026-09-30
|
||||
|
||||
Changes since 1.16.1:
|
||||
|
||||
### Added
|
||||
|
||||
- Files can be deleted from a run: a delete button (with confirmation) in the Files section of the run detail page, `DELETE /scenarios/:id/runs/:runId/files/:fileId`, and the `delete_run_file` MCP tool. The stored file is removed once no scenario or run references it.
|
||||
|
||||
## 1.16.1 - 2026-09-30
|
||||
|
||||
Changes since 1.16.0:
|
||||
|
||||
### Changed
|
||||
|
||||
- Playwright traces are now off by default (`PLAYWRIGHT_TRACE_MODE` defaults to `off`), since a trace often reaches ~10 MB per run. Traces can still be enabled per run in the run modal, via `traceMode` in `POST /scenarios/:id/run`, or for all runs by setting `PLAYWRIGHT_TRACE_MODE`.
|
||||
|
||||
## 1.16.0 - 2026-09-30
|
||||
|
||||
Changes since 1.15.0:
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
# liqa
|
||||
|
||||
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:
|
||||
|
||||
- `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`.
|
||||
- `client/` - React 19 + Vite SPA (i18n strings in `client/src/i18n/locales/en.json`).
|
||||
|
||||
## Docs
|
||||
|
||||
- [README.md](README.md) - overview
|
||||
- [docs/architecture.md](docs/architecture.md) - services and modules
|
||||
- [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/mcp.md](docs/mcp.md) - MCP tool reference
|
||||
- [CHANGELOG.md](CHANGELOG.md) - release notes per version
|
||||
- [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`)
|
||||
|
||||
## 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` 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`.
|
||||
|
||||
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.
|
||||
|
||||
## Code quality
|
||||
|
||||
Before committing, run and pass all of these (and report the results):
|
||||
|
||||
```bash
|
||||
# server
|
||||
cd server && npm run lint && npx tsc --noEmit -p tsconfig.json && npm test && npm run build
|
||||
# client
|
||||
cd client && npm run lint && npm run build && npm run test:storybook
|
||||
```
|
||||
|
||||
- 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.
|
||||
- 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`, ...).
|
||||
|
||||
## Committing a new version
|
||||
|
||||
When asked to commit:
|
||||
|
||||
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).
|
||||
2. Run the code quality checks above.
|
||||
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:**.
|
||||
5. Update the docs affected by the change (`docs/*.md`, `README.md`, `.env.example`, MCP tool descriptions).
|
||||
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.
|
||||
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.
|
||||
+92
@@ -0,0 +1,92 @@
|
||||
# Single image serving the whole application: the NestJS server (API, MCP,
|
||||
# scheduler) also serves the built client, so one container is enough.
|
||||
|
||||
# ── Client build ──────────────────────────────────────────────────────────────
|
||||
FROM node:24-slim AS client-build
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Root lockfile + workspace manifest so npm ci can resolve the full graph
|
||||
COPY package*.json ./
|
||||
COPY client/package.json ./client/
|
||||
RUN npm ci -w client
|
||||
|
||||
COPY client ./client
|
||||
RUN npm run -w client build
|
||||
|
||||
# ── Server build ──────────────────────────────────────────────────────────────
|
||||
FROM node:24-slim AS server-build
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY package*.json ./
|
||||
COPY server/package.json ./server/
|
||||
RUN npm ci -w server
|
||||
|
||||
COPY server/nest-cli.json ./server/
|
||||
COPY server/tsconfig*.json ./server/
|
||||
COPY server/src ./server/src
|
||||
RUN npm run -w server build
|
||||
|
||||
# ── Runtime ───────────────────────────────────────────────────────────────────
|
||||
FROM node:24-slim AS runtime
|
||||
|
||||
# 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
|
||||
# fontconfig and basic fonts for text rendering. Playwright's `--with-deps`
|
||||
# would also pull in xvfb (with Mesa/LLVM) and extra font packages, which
|
||||
# headless-only use doesn't need.
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
ca-certificates \
|
||||
fontconfig \
|
||||
fonts-dejavu-core \
|
||||
fonts-liberation \
|
||||
libasound2 \
|
||||
libatk-bridge2.0-0 \
|
||||
libatk1.0-0 \
|
||||
libatspi2.0-0 \
|
||||
libdbus-1-3 \
|
||||
libexpat1 \
|
||||
libgbm1 \
|
||||
libglib2.0-0 \
|
||||
libnspr4 \
|
||||
libnss3 \
|
||||
libx11-6 \
|
||||
libxcb1 \
|
||||
libxcomposite1 \
|
||||
libxdamage1 \
|
||||
libxext6 \
|
||||
libxfixes3 \
|
||||
libxkbcommon0 \
|
||||
libxrandr2 \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY package*.json ./
|
||||
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
|
||||
RUN npm ci --omit=dev -w server \
|
||||
&& npx playwright install --only-shell chromium \
|
||||
&& npm cache clean --force
|
||||
|
||||
COPY --from=server-build /app/server/dist ./dist
|
||||
COPY --from=client-build /app/client/dist ./client
|
||||
|
||||
# Serve the built client at / (see server/src/common/client-static.ts)
|
||||
ENV CLIENT_DIR=client
|
||||
|
||||
# Runtime directory (SQLite DB and stored files, mounted as a volume)
|
||||
RUN mkdir -p data
|
||||
|
||||
EXPOSE 3000
|
||||
|
||||
# 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"]
|
||||
@@ -1,46 +1,40 @@
|
||||
# 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/`.
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
The bot manages four core concepts:
|
||||
|
||||
| Concept | Description |
|
||||
|---|---|
|
||||
| **Environment** | A named set of URLs for a deployment target (e.g. `liquio-diia-stg`) |
|
||||
| **Key** | A JSON descriptor in `keys/` that points to an EDS key file + password |
|
||||
| **Session** | Saved browser state (cookies + localStorage) produced by a login |
|
||||
| **Scenario** | An ordered list of steps that run in sequence against a shared browser instance |
|
||||
| **Scenario** | An ordered list of steps (async Playwright JS) that run in sequence in one browser. Versioned: every content change creates a new version |
|
||||
| **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) |
|
||||
| **Snippet** | Reusable, versioned code called from steps with `context.runSnippet("alias")` (or `"alias@N"` for a specific version) |
|
||||
| **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).
|
||||
|
||||
---
|
||||
|
||||
## Key descriptors
|
||||
|
||||
See [docs/key-descriptors.md](docs/key-descriptors.md).
|
||||
|
||||
---
|
||||
|
||||
## 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.
|
||||
- [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
|
||||
- [CHANGELOG.md](CHANGELOG.md) - release notes
|
||||
@@ -12,7 +12,7 @@ function getAbsolutePath(value: string) {
|
||||
return dirname(fileURLToPath(import.meta.resolve(`${value}/package.json`)));
|
||||
}
|
||||
const config: StorybookConfig = {
|
||||
stories: ['./stories/**/*.mdx', './stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
|
||||
stories: ['./stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
|
||||
addons: [
|
||||
getAbsolutePath('@storybook/addon-vitest'),
|
||||
getAbsolutePath('@storybook/addon-a11y'),
|
||||
|
||||
@@ -37,7 +37,8 @@ const preview: Preview = {
|
||||
},
|
||||
},
|
||||
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';
|
||||
|
||||
const palette = [
|
||||
{ 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: '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' },
|
||||
];
|
||||
|
||||
@@ -23,12 +29,23 @@ const semanticColors = [
|
||||
{ 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 = [
|
||||
{ name: 'Background', token: '--color-bg', hex: '#E6EDEA' },
|
||||
{ name: 'Background subtle', token: '--color-bg-subtle', hex: '#D8E2DE' },
|
||||
{ name: 'Secondary', token: '--color-secondary', hex: '#EDF1EF' },
|
||||
{ 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' },
|
||||
];
|
||||
|
||||
@@ -43,8 +60,27 @@ function Swatch({
|
||||
hex: 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 (
|
||||
<div
|
||||
ref={ref}
|
||||
style={{
|
||||
display: 'flex',
|
||||
flexDirection: 'column',
|
||||
@@ -72,7 +108,7 @@ function Swatch({
|
||||
</div>
|
||||
)}
|
||||
<div style={{ fontSize: 11, fontFamily: 'monospace', color: 'var(--color-text-muted)' }}>
|
||||
{hex}
|
||||
{value}
|
||||
</div>
|
||||
<div style={{ fontSize: 11, fontFamily: 'monospace', color: 'var(--color-text-muted)' }}>
|
||||
{token}
|
||||
@@ -128,6 +164,11 @@ function ColorPalette() {
|
||||
<Swatch key={c.token} {...c} />
|
||||
))}
|
||||
</Section>
|
||||
<Section title="Syntax highlighting">
|
||||
{syntaxColors.map((c) => (
|
||||
<Swatch key={c.token} {...c} />
|
||||
))}
|
||||
</Section>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
@@ -13,7 +13,7 @@ export default meta;
|
||||
type Story = StoryObj<typeof ContextMenu>;
|
||||
|
||||
const trigger = (
|
||||
<Button variant="ghost" size="sm">
|
||||
<Button variant="ghost" size="sm" aria-label="Actions">
|
||||
<Settings size={16} />
|
||||
</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: {
|
||||
layout: { control: 'select', options: ['inline', 'compact'] },
|
||||
layout: { control: 'select', options: ['inline', 'compact', 'comfortable', 'grid'] },
|
||||
},
|
||||
};
|
||||
export default meta;
|
||||
@@ -35,6 +35,14 @@ export const Compact: Story = {
|
||||
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 = {
|
||||
args: {
|
||||
layout: 'inline',
|
||||
|
||||
@@ -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,63 @@
|
||||
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 }: { title: string; body: string }) {
|
||||
const [open, setOpen] = useState(false);
|
||||
return (
|
||||
<>
|
||||
<Button onClick={() => setOpen(true)}>Open modal</Button>
|
||||
<Modal
|
||||
open={open}
|
||||
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();
|
||||
},
|
||||
};
|
||||
@@ -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,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,21 @@
|
||||
import type { Meta, StoryObj } from '@storybook/react-vite';
|
||||
import { expect, within } from 'storybook/test';
|
||||
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');
|
||||
},
|
||||
};
|
||||
@@ -1,20 +0,0 @@
|
||||
# ── Build stage ───────────────────────────────────────────────────────────────
|
||||
FROM node:22-slim AS builder
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Copy root lockfile + workspace manifests so npm ci can resolve the full graph
|
||||
COPY package*.json ./
|
||||
COPY client/package.json ./client/
|
||||
RUN npm ci -w client
|
||||
|
||||
COPY client ./client
|
||||
RUN npm run -w client build
|
||||
|
||||
# ── Runtime stage ─────────────────────────────────────────────────────────────
|
||||
FROM nginx:alpine AS runtime
|
||||
|
||||
COPY --from=builder /app/client/dist /usr/share/nginx/html
|
||||
COPY client/nginx.conf /etc/nginx/conf.d/default.conf
|
||||
|
||||
EXPOSE 80
|
||||
@@ -1,17 +0,0 @@
|
||||
server {
|
||||
listen 80;
|
||||
root /usr/share/nginx/html;
|
||||
index index.html;
|
||||
|
||||
location /api/ {
|
||||
proxy_pass http://server:3000;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
}
|
||||
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
}
|
||||
+7
-1
@@ -1,7 +1,7 @@
|
||||
import { lazy, Suspense } from 'react';
|
||||
import { NavLink, Navigate, Route, Routes } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { Globe, Monitor, ClipboardList, Activity, KeyRound, Braces } from 'lucide-react';
|
||||
import { Globe, Monitor, ClipboardList, Activity, KeyRound, Braces, Upload } from 'lucide-react';
|
||||
import type { LucideIcon } from 'lucide-react';
|
||||
import styles from './App.module.css';
|
||||
import { SidePanel, ThemeSwitcher } from './ui';
|
||||
@@ -89,6 +89,9 @@ const EditSnippetPage = lazy(() =>
|
||||
const SnippetDetailPage = lazy(() =>
|
||||
import('./pages/snippet/SnippetDetailPage').then((m) => ({ default: m.SnippetDetailPage })),
|
||||
);
|
||||
const ImportPage = lazy(() =>
|
||||
import('./pages/import/ImportPage').then((m) => ({ default: m.ImportPage })),
|
||||
);
|
||||
|
||||
const NAV: ({ path: string; labelKey: string; Icon: LucideIcon } | { separator: true })[] = [
|
||||
{ path: '/runs', labelKey: 'nav.runs', Icon: Activity },
|
||||
@@ -98,6 +101,8 @@ const NAV: ({ path: string; labelKey: string; Icon: LucideIcon } | { separator:
|
||||
{ path: '/snippets', labelKey: 'nav.snippets', Icon: Braces },
|
||||
{ path: '/credentials', labelKey: 'nav.credentials', Icon: KeyRound },
|
||||
{ path: '/environments', labelKey: 'nav.environments', Icon: Globe },
|
||||
{ separator: true },
|
||||
{ path: '/import', labelKey: 'nav.import', Icon: Upload },
|
||||
];
|
||||
|
||||
export default function App() {
|
||||
@@ -163,6 +168,7 @@ export default function App() {
|
||||
<Route path="/credentials/:id/edit" element={<EditCredentialPage />} />
|
||||
<Route path="/credentials/:id" element={<CredentialDetailPage />} />
|
||||
<Route path="/snippets" element={<SnippetsPage />} />
|
||||
<Route path="/import" element={<ImportPage />} />
|
||||
<Route path="/snippets/new" element={<CreateSnippetPage />} />
|
||||
<Route path="/snippets/:id/edit" element={<EditSnippetPage />} />
|
||||
<Route path="/snippets/:id" element={<SnippetDetailPage />} />
|
||||
|
||||
+22
-24
@@ -4,6 +4,7 @@ import type {
|
||||
Environment,
|
||||
FileMetadata,
|
||||
FileListResponse,
|
||||
ImportResult,
|
||||
RunDefaults,
|
||||
ScenarioCredential,
|
||||
Session,
|
||||
@@ -88,12 +89,6 @@ export const credentials = {
|
||||
exportCredential(id: string): Promise<unknown> {
|
||||
return request(`/credentials/${id}/export`);
|
||||
},
|
||||
importCredential(payload: unknown): Promise<Credential> {
|
||||
return request('/credentials/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Snippets ──────────────────────────────────────────────────────────────────
|
||||
@@ -131,12 +126,6 @@ export const snippets = {
|
||||
exportSnippet(id: string): Promise<unknown> {
|
||||
return request(`/snippets/${id}/export`);
|
||||
},
|
||||
importSnippet(payload: unknown): Promise<Snippet> {
|
||||
return request('/snippets/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Environments ──────────────────────────────────────────────────────────────
|
||||
@@ -169,12 +158,6 @@ export const environments = {
|
||||
exportEnvironment(id: string): Promise<unknown> {
|
||||
return request(`/environments/${id}/export`);
|
||||
},
|
||||
importEnvironment(payload: unknown): Promise<Environment> {
|
||||
return request('/environments/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Sessions ──────────────────────────────────────────────────────────────────
|
||||
@@ -276,12 +259,6 @@ export const scenarios = {
|
||||
}
|
||||
return request(`/scenarios/${id}/export?${params.toString()}`);
|
||||
},
|
||||
importScenario(payload: unknown): Promise<Scenario> {
|
||||
return request('/scenarios/import', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(payload),
|
||||
});
|
||||
},
|
||||
exportE2eTestUrl(id: string): string {
|
||||
return `${BASE_URL}/scenarios/${id}/export-e2e`;
|
||||
},
|
||||
@@ -409,4 +386,25 @@ export const runFiles = {
|
||||
contentUrl(scenarioId: string, runId: string, fileId: string): string {
|
||||
return `${BASE_URL}/scenarios/${scenarioId}/runs/${runId}/files/${fileId}/content`;
|
||||
},
|
||||
remove(scenarioId: string, runId: string, fileId: string): Promise<void> {
|
||||
return request(`/scenarios/${scenarioId}/runs/${runId}/files/${fileId}`, {
|
||||
method: 'DELETE',
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
// ── Import ────────────────────────────────────────────────────────────────────
|
||||
|
||||
export const imports = {
|
||||
/**
|
||||
* Imports any mix of environments, credentials, snippets and scenarios from
|
||||
* YAML (`---`-separated documents, each one item or a list of items).
|
||||
*/
|
||||
yaml(text: string): Promise<ImportResult> {
|
||||
return request('/import', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/yaml' },
|
||||
body: text,
|
||||
});
|
||||
},
|
||||
};
|
||||
@@ -214,3 +214,19 @@ export interface FileListResponse {
|
||||
items: FileMetadata[];
|
||||
total: number;
|
||||
}
|
||||
|
||||
// ── Import ────────────────────────────────────────────────────────────────────
|
||||
|
||||
export type ImportKind = 'environment' | 'credential' | 'snippet' | 'scenario';
|
||||
|
||||
export interface ImportedItem {
|
||||
kind: ImportKind;
|
||||
id: string;
|
||||
name: string;
|
||||
/** Version stored for versioned kinds (snippets, scenarios). */
|
||||
version?: number;
|
||||
}
|
||||
|
||||
export interface ImportResult {
|
||||
imported: ImportedItem[];
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
import type { ChangeEvent } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { imports } from '../api';
|
||||
import type { ImportedItem, ImportKind } from '../api';
|
||||
import { useToast } from '../ui';
|
||||
|
||||
/** Detail page path of an imported item. */
|
||||
export function importedItemPath(item: ImportedItem): string {
|
||||
return `/${item.kind}s/${item.id}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a file input `onChange` handler that imports the chosen YAML file
|
||||
* through the central import. When the file holds exactly one item of `kind`
|
||||
* (e.g. a scenario export with its environment), opens that item; otherwise
|
||||
* opens the import page with the full result.
|
||||
*/
|
||||
export function useImportFile(kind: ImportKind) {
|
||||
const navigate = useNavigate();
|
||||
const toast = useToast();
|
||||
const { t } = useTranslation();
|
||||
|
||||
return async (e: ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const result = await imports.yaml(await file.text());
|
||||
const own = result.imported.filter((item) => item.kind === kind);
|
||||
if (own.length === 1) {
|
||||
if (result.imported.length > 1) {
|
||||
toast.success(t('import.imported_count', { count: result.imported.length }));
|
||||
}
|
||||
navigate(importedItemPath(own[0]));
|
||||
} else {
|
||||
navigate('/import', { state: { results: [{ fileName: file.name, result }] } });
|
||||
}
|
||||
} catch {
|
||||
// error toast is already emitted by the API client
|
||||
}
|
||||
};
|
||||
}
|
||||
@@ -28,7 +28,24 @@
|
||||
"keys": "Keys",
|
||||
"sessions": "Sessions",
|
||||
"scenarios": "Scenarios",
|
||||
"runs": "Runs"
|
||||
"runs": "Runs",
|
||||
"import": "Import"
|
||||
},
|
||||
"import": {
|
||||
"title": "Import",
|
||||
"action_choose": "Choose files",
|
||||
"description": "Import exported environments, credentials, snippets and scenarios. Each YAML file may hold several items as ---separated documents, and each document may hold one item or a list of items. JSON files work too.",
|
||||
"description_validation": "Every item in a file is checked before anything is imported: if one item is invalid, nothing from that file is imported. Items are imported in dependency order (environments, credentials, snippets, scenarios), and snippets and scenarios keep the version they were exported with.",
|
||||
"imported_count_one": "Imported {{count}} item",
|
||||
"imported_count_other": "Imported {{count}} items",
|
||||
"col_file": "File",
|
||||
"col_kind": "Kind",
|
||||
"col_name": "Name",
|
||||
"col_version": "Version",
|
||||
"kind_environment": "Environment",
|
||||
"kind_credential": "Credential",
|
||||
"kind_snippet": "Snippet",
|
||||
"kind_scenario": "Scenario"
|
||||
},
|
||||
"environments": {
|
||||
"title": "Environments",
|
||||
@@ -334,6 +351,10 @@
|
||||
"expiresAtLabel": "Expires At (optional)",
|
||||
"createdAt": "Created",
|
||||
"download": "Download",
|
||||
"delete": "Delete",
|
||||
"deleteTitle": "Delete file",
|
||||
"confirmDelete": "Are you sure you want to delete \"{{name}}\" from this run?",
|
||||
"deleteSuccess": "File deleted",
|
||||
"expiredTooltip": "File is expired",
|
||||
"empty": "No files uploaded.",
|
||||
"totalCount": "Total: {{count}} file(s)",
|
||||
|
||||
@@ -2,8 +2,8 @@ import { useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Settings, Pencil, Trash2, Plus, Download, KeyRound } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { credentials } from '../../api';
|
||||
import type { Credential } from '../../api';
|
||||
import {
|
||||
@@ -102,7 +102,6 @@ function AddCredentialCard() {
|
||||
export function CredentialsPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('credentials.title'));
|
||||
const navigate = useNavigate();
|
||||
const [items, setItems] = useState<Credential[]>([]);
|
||||
const [loading, setLoading] = useState(true);
|
||||
const [deleteId, setDeleteId] = useState<string | null>(null);
|
||||
@@ -136,19 +135,7 @@ export function CredentialsPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await credentials.importCredential(payload);
|
||||
navigate(`/credentials/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('credential');
|
||||
|
||||
return (
|
||||
<div>
|
||||
|
||||
@@ -2,8 +2,8 @@ import { useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Settings, ExternalLink, Pencil, Trash2, Plus, Globe, Download } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { stringify as yamlStringify } from 'yaml';
|
||||
import { environments } from '../../api';
|
||||
import type { Environment } from '../../api';
|
||||
@@ -119,7 +119,6 @@ function AddEnvironmentCard() {
|
||||
export function EnvironmentsPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('environments.title'));
|
||||
const navigate = useNavigate();
|
||||
const [items, setItems] = useState<Environment[]>([]);
|
||||
const [loading, setLoading] = useState(true);
|
||||
const [deleteId, setDeleteId] = useState<string | null>(null);
|
||||
@@ -153,19 +152,7 @@ export function EnvironmentsPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await environments.importEnvironment(payload);
|
||||
navigate(`/environments/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('environment');
|
||||
|
||||
return (
|
||||
<div>
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
import { useRef, useState, type ChangeEvent } from 'react';
|
||||
import { useLocation, useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { Upload } from 'lucide-react';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { importedItemPath } from '../../hooks/useImportFile';
|
||||
import { imports } from '../../api';
|
||||
import type { ImportedItem, ImportResult } from '../../api';
|
||||
import { Badge, Breadcrumbs, Button, Card, Table, type TableColumn } from '../../ui';
|
||||
import styles from '../Page.module.css';
|
||||
|
||||
interface FileResult {
|
||||
fileName: string;
|
||||
result: ImportResult;
|
||||
}
|
||||
|
||||
type Row = ImportedItem & { fileName: string; rowKey: string };
|
||||
|
||||
export function ImportPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('import.title'));
|
||||
const navigate = useNavigate();
|
||||
const location = useLocation();
|
||||
const fileInputRef = useRef<HTMLInputElement>(null);
|
||||
// List pages hand over the result of an import they ran
|
||||
const [results, setResults] = useState<FileResult[]>(
|
||||
() => (location.state as { results?: FileResult[] } | null)?.results ?? [],
|
||||
);
|
||||
const [importing, setImporting] = useState(false);
|
||||
|
||||
const handleFiles = async (e: ChangeEvent<HTMLInputElement>) => {
|
||||
const files = Array.from(e.target.files ?? []);
|
||||
e.target.value = '';
|
||||
if (files.length === 0) return;
|
||||
setImporting(true);
|
||||
const next: FileResult[] = [];
|
||||
try {
|
||||
for (const file of files) {
|
||||
try {
|
||||
next.push({ fileName: file.name, result: await imports.yaml(await file.text()) });
|
||||
} catch {
|
||||
// error toast is already emitted by the API client; nothing from
|
||||
// this file was imported, continue with the next one
|
||||
}
|
||||
}
|
||||
} finally {
|
||||
setResults(next);
|
||||
setImporting(false);
|
||||
}
|
||||
};
|
||||
|
||||
const rows: Row[] = results.flatMap(({ fileName, result }) =>
|
||||
result.imported.map((item, i) => ({ ...item, fileName, rowKey: `${fileName}-${i}` })),
|
||||
);
|
||||
|
||||
const columns: TableColumn<Row>[] = [
|
||||
{ key: 'fileName', header: t('import.col_file'), render: (r) => r.fileName },
|
||||
{
|
||||
key: 'kind',
|
||||
header: t('import.col_kind'),
|
||||
width: 120,
|
||||
render: (r) => <Badge variant="neutral">{t(`import.kind_${r.kind}`)}</Badge>,
|
||||
},
|
||||
{ key: 'name', header: t('import.col_name'), render: (r) => r.name },
|
||||
{
|
||||
key: 'version',
|
||||
header: t('import.col_version'),
|
||||
width: 90,
|
||||
render: (r) =>
|
||||
r.version != null ? `v${r.version}` : <span className={styles.muted}>–</span>,
|
||||
},
|
||||
];
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div className={styles.pageToolbar}>
|
||||
<Breadcrumbs items={[{ label: t('import.title'), icon: <Upload size={14} /> }]} />
|
||||
<div className={styles.toolbarActions}>
|
||||
<input
|
||||
ref={fileInputRef}
|
||||
type="file"
|
||||
accept=".yaml,.yml,.json"
|
||||
multiple
|
||||
style={{ display: 'none' }}
|
||||
onChange={handleFiles}
|
||||
/>
|
||||
<Button size="sm" onClick={() => fileInputRef.current?.click()} disabled={importing}>
|
||||
<Upload size={14} />
|
||||
{t('import.action_choose')}
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<Card>
|
||||
<p>{t('import.description')}</p>
|
||||
<p className={styles.muted}>{t('import.description_validation')}</p>
|
||||
</Card>
|
||||
|
||||
{rows.length > 0 && (
|
||||
<div className={styles.stepsSection}>
|
||||
<h2 className={styles.sectionHeading}>
|
||||
{t('import.imported_count', { count: rows.length })}
|
||||
</h2>
|
||||
<Table<Row>
|
||||
columns={columns}
|
||||
data={rows}
|
||||
rowKey={(r) => r.rowKey}
|
||||
loading={false}
|
||||
emptyMessage=""
|
||||
onRowClick={(r) => navigate(importedItemPath(r))}
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -14,7 +14,11 @@ import type {
|
||||
FileMetadata,
|
||||
} from '../../api';
|
||||
import { scenarios } from '../../api';
|
||||
import { ExportLogsModal, type LogExportFormat } from '../../components/modals';
|
||||
import {
|
||||
DeleteConfirmationModal,
|
||||
ExportLogsModal,
|
||||
type LogExportFormat,
|
||||
} from '../../components/modals';
|
||||
import {
|
||||
AutoRefreshIndicator,
|
||||
Badge,
|
||||
@@ -38,6 +42,7 @@ import {
|
||||
ClipboardList,
|
||||
Activity,
|
||||
Download,
|
||||
Trash2,
|
||||
RotateCcw,
|
||||
} from 'lucide-react';
|
||||
import styles from '../Page.module.css';
|
||||
@@ -103,6 +108,8 @@ function RunDetail() {
|
||||
const [exportLogsOpen, setExportLogsOpen] = useState(false);
|
||||
const [exportLogsFormat, setExportLogsFormat] = useState<LogExportFormat>('md');
|
||||
const [exportingLogs, setExportingLogs] = useState(false);
|
||||
const [pendingDeleteFile, setPendingDeleteFile] = useState<FileMetadata | null>(null);
|
||||
const [deletingFile, setDeletingFile] = useState(false);
|
||||
const [repeating, setRepeating] = useState(false);
|
||||
const logSearchRef = useRef('');
|
||||
const LOG_PAGE_SIZE = 25;
|
||||
@@ -167,6 +174,21 @@ function RunDetail() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleDeleteFile = async () => {
|
||||
if (!id || !runId || !pendingDeleteFile) return;
|
||||
setDeletingFile(true);
|
||||
try {
|
||||
await runFiles.remove(id, runId, pendingDeleteFile.id);
|
||||
toast.success(t('files.deleteSuccess'));
|
||||
setPendingDeleteFile(null);
|
||||
await loadArtifacts();
|
||||
} catch {
|
||||
// error toast is already emitted by the API client
|
||||
} finally {
|
||||
setDeletingFile(false);
|
||||
}
|
||||
};
|
||||
|
||||
const manualRefresh = () => {
|
||||
if (!id || !runId) return;
|
||||
runs
|
||||
@@ -611,6 +633,21 @@ function RunDetail() {
|
||||
);
|
||||
},
|
||||
},
|
||||
{
|
||||
key: 'delete',
|
||||
header: '',
|
||||
render: (f) => (
|
||||
<Button
|
||||
variant="secondary"
|
||||
size="sm"
|
||||
title={t('files.delete')}
|
||||
aria-label={t('files.delete')}
|
||||
onClick={() => setPendingDeleteFile(f)}
|
||||
>
|
||||
<Trash2 size={14} />
|
||||
</Button>
|
||||
),
|
||||
},
|
||||
] satisfies TableColumn<FileMetadata>[]
|
||||
}
|
||||
emptyMessage={t('files.empty')}
|
||||
@@ -628,6 +665,15 @@ function RunDetail() {
|
||||
onExport={handleExportLogs}
|
||||
isExporting={exportingLogs}
|
||||
/>
|
||||
|
||||
<DeleteConfirmationModal
|
||||
open={pendingDeleteFile != null}
|
||||
title={t('files.deleteTitle')}
|
||||
message={t('files.confirmDelete', { name: pendingDeleteFile?.name ?? '' })}
|
||||
onClose={() => setPendingDeleteFile(null)}
|
||||
onConfirm={handleDeleteFile}
|
||||
isDeleting={deletingFile}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -68,10 +68,12 @@ export function RunsPage() {
|
||||
const sortDirRef = useRef(sortDir);
|
||||
const pageRef = useRef(page);
|
||||
const pageSizeRef = useRef(pageSize);
|
||||
sortByRef.current = sortBy;
|
||||
sortDirRef.current = sortDir;
|
||||
pageRef.current = page;
|
||||
pageSizeRef.current = pageSize;
|
||||
useEffect(() => {
|
||||
sortByRef.current = sortBy;
|
||||
sortDirRef.current = sortDir;
|
||||
pageRef.current = page;
|
||||
pageSizeRef.current = pageSize;
|
||||
}, [sortBy, sortDir, page, pageSize]);
|
||||
|
||||
const load = useCallback(
|
||||
(orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
||||
|
||||
@@ -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 { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
@@ -82,10 +82,9 @@ export function ScenarioDetailPage() {
|
||||
const [runVersions, setRunVersions] = useState<ScenarioVersion[]>([]);
|
||||
// null = latest
|
||||
const [runVersion, setRunVersion] = useState<number | null>(null);
|
||||
const traceMode = traceModeOverride ?? runDefaults?.traceMode ?? 'on';
|
||||
const traceMode = traceModeOverride ?? runDefaults?.traceMode ?? 'off';
|
||||
const [envs, setEnvs] = useState<Environment[]>([]);
|
||||
const [selectedEnvId, setSelectedEnvId] = useState('');
|
||||
const envInitRef = useRef(false);
|
||||
const [pendingDelete, setPendingDelete] = useState<
|
||||
{ type: 'scenario' } | { type: 'step'; id: string } | { type: 'credential'; id: string } | null
|
||||
>(null);
|
||||
@@ -99,8 +98,7 @@ export function ScenarioDetailPage() {
|
||||
|
||||
// Files state
|
||||
const [files, setFiles] = useState<FileMetadata[]>([]);
|
||||
const [filesTotal, setFilesTotal] = useState(0);
|
||||
const [filesLoading, setFilesLoading] = useState(false);
|
||||
const [filesLoading, setFilesLoading] = useState(true);
|
||||
const [uploadOpen, setUploadOpen] = useState(false);
|
||||
const [uploadFile, setUploadFile] = useState<File | null>(null);
|
||||
const [uploadExpiresAt, setUploadExpiresAt] = useState('');
|
||||
@@ -108,18 +106,23 @@ export function ScenarioDetailPage() {
|
||||
|
||||
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;
|
||||
setFilesLoading(true);
|
||||
try {
|
||||
const result = await scenarioFiles.list(id);
|
||||
setFiles(result.items);
|
||||
setFilesTotal(result.total);
|
||||
} finally {
|
||||
setFilesLoading(false);
|
||||
}
|
||||
}, [id]);
|
||||
|
||||
const loadFiles = async () => {
|
||||
setFilesLoading(true);
|
||||
await fetchFiles();
|
||||
};
|
||||
|
||||
useEffect(() => {
|
||||
if (!id) return;
|
||||
void scenarios
|
||||
@@ -129,7 +132,7 @@ export function ScenarioDetailPage() {
|
||||
setScenarioCreds(s.scenarioCredentials ?? []);
|
||||
})
|
||||
.finally(() => setLoading(false));
|
||||
void loadFiles();
|
||||
void fetchFiles();
|
||||
scenarios
|
||||
.usedSnippets(id)
|
||||
.then(setUsedSnippets)
|
||||
@@ -144,16 +147,25 @@ export function ScenarioDetailPage() {
|
||||
setEnvs(r.data);
|
||||
})
|
||||
.catch(() => {});
|
||||
}, [id, loadFiles]);
|
||||
}, [id, fetchFiles]);
|
||||
|
||||
// Default selected env to scenario's linked environment (or first env) once both are loaded
|
||||
useEffect(() => {
|
||||
if (envInitRef.current || envs.length === 0) return;
|
||||
envInitRef.current = true;
|
||||
const openRunModal = () => {
|
||||
// Preselect the scenario's default environment (or the first one) when the
|
||||
// modal opens: by then both are loaded, and it follows default env edits
|
||||
const preferred = scenario?.environmentId ?? null;
|
||||
const exists = preferred ? envs.some((e) => e.id === preferred) : false;
|
||||
setSelectedEnvId(exists ? preferred! : envs[0].id);
|
||||
}, [scenario, envs]);
|
||||
setSelectedEnvId(exists ? preferred! : (envs[0]?.id ?? ''));
|
||||
setTraceModeOverride(null);
|
||||
setRunVersion(null);
|
||||
setRunVersions([]);
|
||||
if (id) {
|
||||
scenarios
|
||||
.versions(id)
|
||||
.then(setRunVersions)
|
||||
.catch(() => undefined);
|
||||
}
|
||||
setRunModalOpen(true);
|
||||
};
|
||||
|
||||
const reloadScenario = async () => {
|
||||
if (!id) return;
|
||||
@@ -472,21 +484,7 @@ export function ScenarioDetailPage() {
|
||||
/>
|
||||
{scenario && (
|
||||
<div className={styles.toolbarActions}>
|
||||
<Button
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
setTraceModeOverride(null);
|
||||
setRunVersion(null);
|
||||
setRunVersions([]);
|
||||
if (id) {
|
||||
scenarios
|
||||
.versions(id)
|
||||
.then(setRunVersions)
|
||||
.catch(() => undefined);
|
||||
}
|
||||
setRunModalOpen(true);
|
||||
}}
|
||||
>
|
||||
<Button size="sm" onClick={openRunModal}>
|
||||
<Play size={14} />
|
||||
{t('scenarios.action_run')}
|
||||
</Button>
|
||||
|
||||
@@ -2,8 +2,8 @@ import { useCallback, useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Play, Plus, Trash2, Download, ClipboardList } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { environments, scenarios } from '../../api';
|
||||
import type { Environment, Scenario, ScenarioVersion, TraceMode } from '../../api';
|
||||
import { RunScenarioModal } from '../../components/modals';
|
||||
@@ -56,7 +56,7 @@ export function ScenariosPage() {
|
||||
const [runVersions, setRunVersions] = useState<ScenarioVersion[]>([]);
|
||||
// null = latest
|
||||
const [runVersion, setRunVersion] = useState<number | null>(null);
|
||||
const traceMode = traceModeOverride ?? runDefaults?.traceMode ?? 'on';
|
||||
const traceMode = traceModeOverride ?? runDefaults?.traceMode ?? 'off';
|
||||
const [envs, setEnvs] = useState<Environment[]>([]);
|
||||
const [selectedEnvId, setSelectedEnvId] = useState('');
|
||||
|
||||
@@ -68,9 +68,10 @@ export function ScenariosPage() {
|
||||
const [pageSize, setPageSize] = useState(10);
|
||||
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) => {
|
||||
setLoading(true);
|
||||
Promise.all([
|
||||
scenarios.list(p, limit, orderBy, orderDir === 'asc' ? 'ASC' : 'DESC'),
|
||||
environments.list(1, 200),
|
||||
@@ -88,9 +89,14 @@ export function ScenariosPage() {
|
||||
[toast],
|
||||
);
|
||||
|
||||
const load = (orderBy: string, orderDir: SortDirection, p: number, limit: number) => {
|
||||
setLoading(true);
|
||||
fetchPage(orderBy, orderDir, p, limit);
|
||||
};
|
||||
|
||||
useEffect(() => {
|
||||
load('updatedAt', 'desc', 1, 10);
|
||||
}, [load]);
|
||||
fetchPage('updatedAt', 'desc', 1, 10);
|
||||
}, [fetchPage]);
|
||||
|
||||
const handleSort = (key: string, dir: SortDirection) => {
|
||||
setSortBy(key);
|
||||
@@ -159,19 +165,7 @@ export function ScenariosPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await scenarios.importScenario(payload);
|
||||
navigate(`/scenarios/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('scenario');
|
||||
|
||||
const columns: TableColumn<Scenario>[] = [
|
||||
{ key: 'id', header: t('scenarios.col_id'), render: (s) => <UuidBadge id={s.id} />, width: 60 },
|
||||
|
||||
@@ -23,7 +23,9 @@ export function SessionsPage() {
|
||||
usePageTitle(t('sessions.title'));
|
||||
const navigate = useNavigate();
|
||||
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 [deleting, setDeleting] = useState(false);
|
||||
const [sortBy, setSortBy] = useState('id');
|
||||
@@ -32,15 +34,18 @@ export function SessionsPage() {
|
||||
const [pageSize, setPageSize] = useState(10);
|
||||
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) => {
|
||||
setLoading(true);
|
||||
const key = `${orderBy}|${orderDir}|${p}|${limit}`;
|
||||
sessions
|
||||
.list(p, limit, orderBy, orderDir === 'asc' ? 'ASC' : 'DESC')
|
||||
.then((res) => {
|
||||
setItems(res.data);
|
||||
setTotal(res.total);
|
||||
})
|
||||
.finally(() => setLoading(false));
|
||||
.finally(() => setLoadedQuery(key));
|
||||
}, []);
|
||||
|
||||
useEffect(() => {
|
||||
|
||||
@@ -2,8 +2,8 @@ import { useEffect, useRef, useState } from 'react';
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
import { useTranslation } from 'react-i18next';
|
||||
import { usePageTitle } from '../../hooks/usePageTitle';
|
||||
import { useImportFile } from '../../hooks/useImportFile';
|
||||
import { Settings, Pencil, Trash2, Plus, Download, Braces } from 'lucide-react';
|
||||
import { parse as yamlParse } from 'yaml';
|
||||
import { snippets } from '../../api';
|
||||
import type { Snippet } from '../../api';
|
||||
import {
|
||||
@@ -117,7 +117,6 @@ function AddSnippetCard() {
|
||||
export function SnippetsPage() {
|
||||
const { t } = useTranslation();
|
||||
usePageTitle(t('snippets.title'));
|
||||
const navigate = useNavigate();
|
||||
const [items, setItems] = useState<Snippet[]>([]);
|
||||
const [loading, setLoading] = useState(true);
|
||||
const [deleteId, setDeleteId] = useState<string | null>(null);
|
||||
@@ -151,19 +150,7 @@ export function SnippetsPage() {
|
||||
}
|
||||
};
|
||||
|
||||
const handleImport = async (e: React.ChangeEvent<HTMLInputElement>) => {
|
||||
const file = e.target.files?.[0];
|
||||
if (!file) return;
|
||||
e.target.value = '';
|
||||
try {
|
||||
const text = await file.text();
|
||||
const payload = yamlParse(text) as unknown;
|
||||
const imported = await snippets.importSnippet(payload);
|
||||
navigate(`/snippets/${imported.id}`);
|
||||
} catch {
|
||||
// Import errors are silently ignored
|
||||
}
|
||||
};
|
||||
const handleImport = useImportFile('snippet');
|
||||
|
||||
return (
|
||||
<div>
|
||||
|
||||
@@ -71,7 +71,7 @@
|
||||
}
|
||||
|
||||
.active .label {
|
||||
color: var(--color-primary);
|
||||
color: var(--color-primary-text);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
@@ -83,8 +83,8 @@
|
||||
}
|
||||
|
||||
.inactive .label {
|
||||
/* Not dimmed with opacity: muted text already reads as inactive and keeps 4.5:1 */
|
||||
color: var(--color-text-muted);
|
||||
opacity: 0.5;
|
||||
}
|
||||
|
||||
/* ── Error state ──────────────────────────────────────────── */
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
.code :global(.hljs-comment),
|
||||
.code :global(.hljs-quote) {
|
||||
color: var(--hl-comment, #6A8072);
|
||||
color: var(--hl-comment);
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
.code :global(.hljs-built_in),
|
||||
.code :global(.hljs-name),
|
||||
.code :global(.hljs-tag) {
|
||||
color: var(--hl-keyword, #A67DCC);
|
||||
color: var(--hl-keyword);
|
||||
}
|
||||
|
||||
.code :global(.hljs-string),
|
||||
@@ -39,32 +39,32 @@
|
||||
.code :global(.hljs-template-variable),
|
||||
.code :global(.hljs-type),
|
||||
.code :global(.hljs-addition) {
|
||||
color: var(--hl-string, #9BB870);
|
||||
color: var(--hl-string);
|
||||
}
|
||||
|
||||
.code :global(.hljs-number),
|
||||
.code :global(.hljs-regexp),
|
||||
.code :global(.hljs-link) {
|
||||
color: var(--hl-number, #E8A85F);
|
||||
color: var(--hl-number);
|
||||
}
|
||||
|
||||
.code :global(.hljs-function),
|
||||
.code :global(.hljs-title.hljs-function_) {
|
||||
color: var(--hl-function, #5BB8D4);
|
||||
color: var(--hl-function);
|
||||
}
|
||||
|
||||
.code :global(.hljs-variable),
|
||||
.code :global(.hljs-params) {
|
||||
color: var(--hl-variable, #D4A0A0);
|
||||
color: var(--hl-variable);
|
||||
}
|
||||
|
||||
.code :global(.hljs-property) {
|
||||
color: var(--hl-property, #79C0C8);
|
||||
color: var(--hl-property);
|
||||
}
|
||||
|
||||
.code :global(.hljs-deletion),
|
||||
.code :global(.hljs-meta) {
|
||||
color: var(--hl-meta, #A9A3C9);
|
||||
color: var(--hl-meta);
|
||||
}
|
||||
|
||||
.code :global(.hljs-emphasis) {
|
||||
|
||||
@@ -49,7 +49,7 @@
|
||||
|
||||
.sortIconActive {
|
||||
opacity: 1;
|
||||
color: var(--color-primary);
|
||||
color: var(--color-primary-text);
|
||||
}
|
||||
|
||||
[data-theme="dark"] .th {
|
||||
|
||||
@@ -11,6 +11,8 @@
|
||||
--color-primary-hover: #8ABD2E;
|
||||
--color-primary-active: #77A320;
|
||||
--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 */
|
||||
--color-secondary: #EDEAF8;
|
||||
@@ -19,8 +21,8 @@
|
||||
--color-secondary-fg: #6650C0; /* Kimberly */
|
||||
--color-secondary-border: #B8B0E0;
|
||||
|
||||
/* Danger */
|
||||
--color-danger: #D94F4F;
|
||||
/* Danger (white text needs >= 4.5:1) */
|
||||
--color-danger: #CE4546;
|
||||
--color-danger-hover: #C03A3A;
|
||||
--color-danger-fg: #ffffff;
|
||||
|
||||
@@ -43,11 +45,21 @@
|
||||
--color-link-hover: #3D2F80;
|
||||
|
||||
--color-text: #2D3339;
|
||||
--color-text-muted: #6650C0; /* Kimberly */
|
||||
--color-text-muted: #634DBD; /* Kimberly, a touch darker for 4.5:1 on bg-subtle */
|
||||
--color-border: #AFBFB9; /* Powder Ash */
|
||||
--color-bg: #E6EDEA; /* Powder Ash tint */
|
||||
--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 */
|
||||
--space-1: 4px;
|
||||
--space-2: 8px;
|
||||
@@ -112,6 +124,7 @@ a:hover {
|
||||
--color-primary-hover: #AEDE55;
|
||||
--color-primary-active: #8ABD2E;
|
||||
--color-primary-fg: #1A1F24;
|
||||
--color-primary-text: #9DD341;
|
||||
|
||||
/* Secondary — dark Kimberly tint */
|
||||
--color-secondary: #2A2548;
|
||||
@@ -122,7 +135,7 @@ a:hover {
|
||||
|
||||
/* Danger */
|
||||
--color-danger: #E06060;
|
||||
--color-danger-hover: #CC4A4A;
|
||||
--color-danger-hover: #F06E6D; /* lighter, so the dark text keeps >= 4.5:1 */
|
||||
--color-danger-fg: #1A1F24;
|
||||
|
||||
/* Semantic */
|
||||
@@ -148,4 +161,14 @@ a:hover {
|
||||
--color-border: #3D4850;
|
||||
--color-bg: #1A1F24; /* deeper than 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;
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
services:
|
||||
liqa:
|
||||
build:
|
||||
context: .
|
||||
ports:
|
||||
# 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"
|
||||
# Optional overrides (see .env.example); every setting has a default
|
||||
env_file:
|
||||
- path: .env
|
||||
required: false
|
||||
volumes:
|
||||
# persist SQLite database across restarts
|
||||
- ./data:/app/data
|
||||
restart: unless-stopped
|
||||
@@ -1,23 +0,0 @@
|
||||
services:
|
||||
server:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: server/Dockerfile
|
||||
ports:
|
||||
- "13000:3000"
|
||||
env_file:
|
||||
- .env
|
||||
volumes:
|
||||
# persist SQLite database across restarts
|
||||
- ./data:/app/data
|
||||
# mount key files into the container
|
||||
- ./keys:/app/keys
|
||||
restart: unless-stopped
|
||||
|
||||
client:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: client/Dockerfile
|
||||
ports:
|
||||
- "13001:80"
|
||||
restart: unless-stopped
|
||||
+67
-38
@@ -1,50 +1,79 @@
|
||||
# Architecture
|
||||
|
||||
```
|
||||
┌──────────────────────────────────────────────────────┐
|
||||
│ Browser (React SPA - client/) │
|
||||
│ │
|
||||
│ Environments Credentials Snippets │
|
||||
│ Sessions Scenarios Runs │
|
||||
└─────────────────────────────┬────────────────────────┘
|
||||
│ HTTP REST (:13000)
|
||||
│
|
||||
MCP client (AI agent / VS Code Copilot)
|
||||
│ HTTP /mcp (Streamable MCP)
|
||||
▼
|
||||
┌──────────────────────────────────────────────────────┐
|
||||
│ NestJS app (server/src/) │
|
||||
│ │
|
||||
│ McpService all MCP tools │
|
||||
│ SessionService session persistence │
|
||||
│ SessionContextService live browser contexts │
|
||||
│ EnvironmentService environment CRUD + import │
|
||||
│ CredentialService credential CRUD + import │
|
||||
│ SnippetService snippet CRUD + import │
|
||||
│ BrowserService ad-hoc open/exec │
|
||||
│ CodeExecutorService sandboxed JS runtime │
|
||||
│ ScenarioService scenarios/steps/runs CRUD │
|
||||
│ ScenarioSchedulerService @Interval(1 s) run worker │
|
||||
└───────────────────────┬──────────────────────────────┘
|
||||
│ better-sqlite3 (TypeORM)
|
||||
▼
|
||||
data/sessions.db
|
||||
Browser (React SPA) MCP client (AI agent, IDE)
|
||||
│ / and /api/v1 │ /mcp (Streamable HTTP)
|
||||
└──────────────┬──────────────────┘
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ liqa container (:13000 → 3000) NestJS app, server/src/ │
|
||||
│ │
|
||||
│ Routes / built client (ServeStaticModule) │
|
||||
│ /api/v1 REST API /docs Swagger UI │
|
||||
│ /mcp MCP tools /health health check │
|
||||
│ │
|
||||
│ McpService MCP tools → services below │
|
||||
│ ScenarioService scenarios, steps, versions, runs │
|
||||
│ ScenarioSchedulerService @Interval(1 s) run worker │
|
||||
│ E2eExportService standalone Playwright test zip │
|
||||
│ SnippetService snippets + versions │
|
||||
│ EnvironmentService environments │
|
||||
│ CredentialService credentials │
|
||||
│ ImportService central YAML import │
|
||||
│ FileStorageService scenario files + run artifacts │
|
||||
│ SessionService saved browser sessions │
|
||||
│ SessionContextService live Playwright contexts │
|
||||
│ SessionSchedulerService @Interval(60 s) session cleanup │
|
||||
│ BrowserService ad-hoc open / exec │
|
||||
│ CodeExecutorService runs step / snippet JS │
|
||||
└───────────────┬─────────────────────────────┬───────────────┘
|
||||
│ 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.
|
||||
- **SessionService** persists session records in SQLite. **SessionContextService** manages live Playwright contexts for open sessions.
|
||||
- **EnvironmentService**, **CredentialService**, and **SnippetService** provide CRUD plus import/export upserts.
|
||||
- **BrowserService** handles stateless ad-hoc automation (`/open`, `/exec`) and session-aware browsing.
|
||||
- **CodeExecutorService** validates and executes user JS with `page`, `context`, and helper APIs.
|
||||
- **ScenarioService** manages scenarios, steps, credential aliases, runs, logs, and scenario import/export.
|
||||
- **ScenarioSchedulerService** polls pending runs every second and executes step runs to completion.
|
||||
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.
|
||||
|
||||
## Server components (`server/src/`)
|
||||
|
||||
- **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** (`scenario/`) manages scenarios, steps, credential aliases, versions, runs, run logs, scenario/run files, and scenario export/import.
|
||||
- **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/`)
|
||||
|
||||
A React 19 + TypeScript SPA served separately by Vite during development. In Docker Compose the same build artefacts are served statically alongside 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 HashRouter so the Vite proxy and server-side routes are never ambiguous.
|
||||
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 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 (injected from the workspace root `package.json` at build time).
|
||||
|
||||
See [development.md](development.md) for the full client tech stack and directory layout.
|
||||
+79
-31
@@ -2,7 +2,7 @@
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js 20+
|
||||
- Node.js 24+ (required by `engines` in `package.json`; the Docker image uses Node.js 24)
|
||||
- Docker + Docker Compose
|
||||
|
||||
The repository is a **npm workspace monorepo** with two packages:
|
||||
@@ -16,21 +16,29 @@ Install all dependencies from the repo root:
|
||||
|
||||
```bash
|
||||
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)
|
||||
|
||||
All settings are validated at startup by `server/src/config/app.config.ts`.
|
||||
|
||||
| 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 |
|
||||
| `KEYS_DIR` | `keys` | Directory for key material used by credential/snippet workflows |
|
||||
| `DB_PATH` | `data/sessions.db` | SQLite database file |
|
||||
| `DB_PATH` | `data/liqa.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_DELETE_CLOSED_DAYS` | `7` | Retention period for closed sessions |
|
||||
| `PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH` | _(Playwright default)_ | Path to Chromium binary. Set automatically in Docker (`/usr/bin/chromium`). |
|
||||
| `PLAYWRIGHT_TRACE_MODE` | `off` | Default Playwright trace mode for runs: `on`, `retain-on-failure` or `off` (see [scenario.md](scenario.md)) |
|
||||
| `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`. |
|
||||
|
||||
---
|
||||
|
||||
@@ -61,13 +69,12 @@ The server listens on port **3000** by default.
|
||||
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`
|
||||
- `/credentials`
|
||||
- `/snippets`
|
||||
- `/sessions`
|
||||
- `/scenarios`
|
||||
```bash
|
||||
npm -w client run dev:compose-api # API of the compose container (localhost:13000)
|
||||
VITE_API_URL=http://localhost:3000/api/v1 npm -w client run dev # API of a locally started server
|
||||
```
|
||||
|
||||
**Production build**:
|
||||
|
||||
@@ -79,6 +86,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
|
||||
|
||||
### Server (Jest)
|
||||
@@ -99,7 +136,7 @@ Watch mode:
|
||||
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
|
||||
npm -w server run test:debug
|
||||
@@ -163,6 +200,10 @@ Both workspaces target zero errors. Run lint before committing.
|
||||
|
||||
## Building the container
|
||||
|
||||
The root `Dockerfile` builds a single image with the whole application: it builds the client and the server in separate stages, and the runtime image runs the server, which also serves the built client (`CLIENT_DIR`).
|
||||
|
||||
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.
|
||||
|
||||
```bash
|
||||
docker compose build
|
||||
```
|
||||
@@ -189,9 +230,11 @@ Build and start in one step:
|
||||
docker compose up -d --build
|
||||
```
|
||||
|
||||
The server API is exposed at **http://localhost:13000**.
|
||||
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.
|
||||
|
||||
SQLite data is persisted in `./data/` and key files are mounted from `./keys/` — both directories are volume-mounted into the container.
|
||||
When switching from the old two-container setup (`server` + `client`), remove the old containers with `docker compose up -d --build --remove-orphans`.
|
||||
|
||||
The SQLite database and stored files are persisted in `./data/`, which is volume-mounted into the container.
|
||||
|
||||
Stop and remove containers:
|
||||
|
||||
@@ -209,7 +252,7 @@ docker compose logs -f
|
||||
|
||||
## 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
|
||||
|
||||
@@ -217,9 +260,13 @@ The client (`client/`) is a React 19 + TypeScript SPA built with Vite. It provid
|
||||
|---|---|
|
||||
| React 19 + TypeScript | UI framework |
|
||||
| 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 |
|
||||
| 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 |
|
||||
| ESLint 10 + Prettier | Linting and formatting |
|
||||
| Storybook 10 + Vitest | Component development and testing |
|
||||
@@ -229,29 +276,30 @@ The client (`client/`) is a React 19 + TypeScript SPA built with Vite. It provid
|
||||
```
|
||||
client/
|
||||
src/
|
||||
api/ API client modules (environments, credentials, snippets, sessions, scenarios)
|
||||
hooks/ useTheme (light/dark persistence)
|
||||
api/ API client (client.ts) and types (types.ts)
|
||||
components/ modals/ - run, export, export logs and delete confirmation modals
|
||||
hooks/ useTheme, usePageTitle, useRunDefaults, useImportFile
|
||||
i18n/ i18next bootstrap + locales/en.json
|
||||
pages/ Environment/Credential/Snippet/Session/Scenario/Run pages
|
||||
ui/ Reusable component library
|
||||
Badge, Breadcrumbs, Button, Card, Input, Select,
|
||||
SidePanel, Table, ThemeSwitcher, Timestamp
|
||||
lib/ highlight.js setup, API error toast events
|
||||
pages/ scenario/, run/, snippet/, credential/, environment/, session/, import/
|
||||
ui/ Reusable component library (Badge, Button, Card, CodeEditor, Modal,
|
||||
Select, SidePanel, Table, Toast, ... - see ui/index.ts)
|
||||
.storybook/
|
||||
stories/ *.stories.tsx for all ui/ components
|
||||
stories/ *.stories.tsx for ui/ components
|
||||
```
|
||||
|
||||
### 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 |
|
||||
|---|---|
|
||||
| `/#/environments` | Environment list |
|
||||
| `/#/credentials` | Credential list |
|
||||
| `/#/snippets` | Snippet list |
|
||||
| `/#/sessions` | Session list |
|
||||
| `/#/scenarios` | Scenario list |
|
||||
| `/#/runs` | Cross-scenario runs list |
|
||||
| `/scenarios` | Scenario list |
|
||||
| `/scenarios/:id` | Scenario details (steps, versions, credentials, used snippets, files) |
|
||||
| `/scenarios/:id/runs`, `/scenarios/:id/runs/:runId` | Runs of a scenario, run details |
|
||||
| `/runs` | Cross-scenario runs list |
|
||||
| `/snippets`, `/credentials`, `/environments`, `/sessions` | Entity lists (plus `/:id`, `/new`, `/:id/edit` where applicable) |
|
||||
| `/import` | Central import |
|
||||
|
||||
### Theming
|
||||
|
||||
|
||||
+66
-42
@@ -1,92 +1,116 @@
|
||||
# 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
|
||||
|
||||
| Tool | Description |
|
||||
|---|---|
|
||||
| `list_sessions` | List stored sessions (paginated) |
|
||||
| `delete_session` | Delete a session by UUID |
|
||||
| `list_sessions` | List saved browser sessions (`orderBy`/`orderDir`) |
|
||||
| `delete_session` | Delete a session by `id` |
|
||||
|
||||
## Environments
|
||||
|
||||
| Tool | Description |
|
||||
|---|---|
|
||||
| `list_environments` | List environments (paginated) |
|
||||
| `get_environment` | Get one environment by UUID |
|
||||
| `create_environment` | Create environment (`name`, `urls`) |
|
||||
| `update_environment` | Update environment (`id`, optional `name`/`urls`) |
|
||||
| `delete_environment` | Delete environment by UUID |
|
||||
| `list_environments` | List environments (`orderBy`/`orderDir`) |
|
||||
| `get_environment` | Get one environment by `id` |
|
||||
| `create_environment` | Create an environment: `name`, optional `description`, `data` |
|
||||
| `update_environment` | Update `name`, `description` and/or `data` of environment `id` |
|
||||
| `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)
|
||||
|
||||
| Tool | Description |
|
||||
|---|---|
|
||||
| `open_url` | Open URL with optional `sessionName`, return page/title/content |
|
||||
| `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)`. |
|
||||
| `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` | 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
|
||||
|
||||
| Tool | Description |
|
||||
|---|---|
|
||||
| `list_scenarios` | List scenarios (paginated) |
|
||||
| `get_scenario` | Get scenario with steps |
|
||||
| `create_scenario` | Create scenario by `name` |
|
||||
| `update_scenario` | Rename scenario |
|
||||
| `delete_scenario` | Delete scenario |
|
||||
| `create_scenario_step` | Add step to scenario |
|
||||
| `list_scenarios` | List scenarios (`orderBy`/`orderDir`) |
|
||||
| `get_scenario` | Get a scenario (latest version) with its steps |
|
||||
| `create_scenario` | Create a scenario: `name`, optional `description`, `environmentId` (default environment), `timeoutSeconds` |
|
||||
| `update_scenario` | Update scenario fields; bumps the version when content changes |
|
||||
| `delete_scenario` | Delete a scenario with its steps, versions and runs |
|
||||
| `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 |
|
||||
| `update_scenario_step` | Update step fields |
|
||||
| `delete_scenario_step` | Delete step |
|
||||
| `list_scenario_runs` | List runs for a scenario |
|
||||
| `update_scenario_step` | Update step fields (including `order` to move it) |
|
||||
| `delete_scenario_step` | Delete a step |
|
||||
| `list_scenario_versions` | List a scenario's versions, newest first |
|
||||
| `get_scenario_version` | Get one scenario version with its steps |
|
||||
| `run_scenario` | Trigger run for scenario; optional `version` (defaults to latest) and `traceMode` |
|
||||
| `get_scenario_run` | Get run with step runs and logs |
|
||||
| `wait_for_scenario_run` | Wait until run is `pass` or `fail` |
|
||||
| `export_scenario` | Export one scenario version (optional `version`, defaults to latest) |
|
||||
| `import_scenario` | Import one scenario version; `version` is required (see "Versioning" in `scenario.md`) |
|
||||
| `list_scenario_credentials` | List credentials assigned to a scenario (alias → credential) |
|
||||
| `add_scenario_credential` | Assign credential `credentialId` to a scenario under `alias` |
|
||||
| `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 the latest) |
|
||||
| `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](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
|
||||
|
||||
| Tool | Description |
|
||||
|---|---|
|
||||
| `list_snippets` | List snippets (paginated) |
|
||||
| `list_snippets` | List snippets (`orderBy`/`orderDir`) |
|
||||
| `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 |
|
||||
| `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 |
|
||||
| `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 |
|
||||
|---|---|
|
||||
| `upload_scenario_file` | Upload a file to a scenario; accepts optional `expiresAt` (ISO 8601 date string) |
|
||||
| `list_scenario_files` | List scenario files (paginated) |
|
||||
| `get_scenario_file_content` | Retrieve file content as base64 with metadata |
|
||||
| `upload_scenario_file` | Upload a file to a scenario: `name`, base64 `contentBase64`, optional `mimeType` and `expiresAt` (ISO 8601) |
|
||||
| `list_scenario_files` | List a scenario's files (`limit`, `offset`) |
|
||||
| `get_scenario_file_content` | Get a file's content as base64, with metadata |
|
||||
|
||||
## Run Artifact Files
|
||||
## Run files
|
||||
|
||||
| Tool | Description |
|
||||
|---|---|
|
||||
| `list_run_files` | List files (artifacts) created during a scenario run (paginated) |
|
||||
| `get_run_file_content` | Retrieve run artifact content as base64 with metadata; run artifacts are read-only and inherit expiry from the run artifact subsystem |
|
||||
| `list_run_files` | List files created during a run (`limit`, `offset`): downloads, failure screenshots/HTML, `trace.zip` |
|
||||
| `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 /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
|
||||
|
||||
- Tool IDs and entity IDs are UUIDs.
|
||||
- `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.
|
||||
|
||||
- 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`.
|
||||
+68
-45
@@ -1,23 +1,23 @@
|
||||
# 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`.
|
||||
- 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.
|
||||
## Runs
|
||||
|
||||
## 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:
|
||||
|
||||
- `execCode` is required for a step to pass.
|
||||
- `validateCode` is optional and runs after `execCode`.
|
||||
- Legacy step type metadata may still appear in MCP payloads, but run execution is not branched by step type.
|
||||
- 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`.
|
||||
- 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.
|
||||
- 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()`.
|
||||
- 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
|
||||
|
||||
`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
|
||||
async (context) => {
|
||||
@@ -25,23 +25,29 @@ async (context) => {
|
||||
}
|
||||
```
|
||||
|
||||
Available in scope:
|
||||
Available on `context`:
|
||||
|
||||
- `context.page`: Playwright `Page`
|
||||
- `context.browser`: Playwright `BrowserContext`
|
||||
- `context.env`: shallow copy of environment key/value map
|
||||
- `context.getEnv(key)`: required environment value lookup (throws if missing)
|
||||
- `context.getCredential(alias)`: credential payload assigned to the scenario alias
|
||||
- `context.getStepOutput(order)`: prior step output by absolute order (`1`, `2`, ...) or relative (`-1` = previous step)
|
||||
- `context.dumpDom(selector?)`: simplified DOM snapshot
|
||||
- `context.log(...args)`, `context.warn(...args)`, `context.error(...args)`: structured step logs
|
||||
- `context.env`: shallow copy of the environment's key/value map
|
||||
- `context.getEnv(key)`: environment value lookup (throws if missing)
|
||||
- `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)`: 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 of the page (or of one element)
|
||||
- `context.log(...args)`, `context.warn(...args)`, `context.error(...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.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.getScenarioFiles(opts?)`: list files uploaded to the scenario (`limit`, `offset`)
|
||||
- `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.
|
||||
- `console`: proxied to run logs (`log`, `warn`, `error`, etc.)
|
||||
- `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`), including their path on disk
|
||||
- `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.
|
||||
|
||||
`validateCode` additionally receives `result` in scope, which is the value returned by `execCode`.
|
||||
Also in scope:
|
||||
|
||||
- `console`: proxied to run logs (`log`, `warn`, `error`, etc.)
|
||||
- `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.
|
||||
|
||||
Step run logs also include automatic "Step N started / passed / failed" entries.
|
||||
|
||||
## Versioning
|
||||
|
||||
@@ -61,35 +67,52 @@ Exports hold exactly one version and always include its `version` number (the la
|
||||
- Otherwise it is stored under that number, and becomes the latest if it is higher than the current latest version.
|
||||
- Without an `id`, a new scenario or snippet is created at the given version.
|
||||
|
||||
## Import
|
||||
|
||||
`POST /import` (the Import page in the UI, and the Import buttons on the list pages; the `import_yaml` MCP tool) imports any mix of environments, credentials, snippets and scenarios.
|
||||
|
||||
- Send YAML with `Content-Type: application/yaml`. A file is a stream of `---`-separated documents; each document holds one exported item or a list of items. JSON is valid YAML, and a JSON body (one item or an array) is accepted too.
|
||||
- Every item needs a `kind`: `environment`, `credential`, `snippet` or `scenario`. Snippets and scenarios also need `version` (see above).
|
||||
- All items are validated before anything is imported, so one invalid item means nothing from that request is imported. The error lists every invalid item by its position.
|
||||
- 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? }] }`.
|
||||
|
||||
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.
|
||||
|
||||
```yaml
|
||||
---
|
||||
# Environment: staging
|
||||
kind: environment
|
||||
id: 5b0c…
|
||||
name: staging
|
||||
data:
|
||||
base_url: https://staging.example
|
||||
---
|
||||
# Scenario: Login flow
|
||||
kind: scenario
|
||||
id: 9e1f…
|
||||
version: 3
|
||||
name: Login flow
|
||||
environmentId: 5b0c…
|
||||
steps:
|
||||
- title: Open login page
|
||||
execCode: await context.page.goto(context.getEnv("base_url"));
|
||||
```
|
||||
|
||||
## Playwright traces
|
||||
|
||||
Each run records a [Playwright trace](https://playwright.dev/docs/trace-viewer) of its browser context (screenshots and DOM snapshots). When the run finishes, the trace is uploaded to the run's files as `trace.zip`. Download it from the run detail page, then open it with `npx playwright show-trace trace.zip` or at https://trace.playwright.dev.
|
||||
A run can record a [Playwright trace](https://playwright.dev/docs/trace-viewer) of its browser context (screenshots and DOM snapshots). When the run finishes, the trace is uploaded to the run's files as `trace.zip`. Download it from the run detail page, then open it with `npx playwright show-trace trace.zip` or at https://trace.playwright.dev.
|
||||
|
||||
The trace mode is chosen per run: the run modal in the UI, the `traceMode` field of `POST /scenarios/:id/run`, and the `traceMode` argument of the `run_scenario` MCP tool all accept one of the values below. When it is omitted, the server's `PLAYWRIGHT_TRACE_MODE` setting is used (exposed via `GET /scenarios/run-defaults`). "Repeat run" reuses the original run's mode.
|
||||
|
||||
- `on` (default): keep the trace of every run
|
||||
- `on`: keep the trace of every run
|
||||
- `retain-on-failure`: keep traces only for runs that failed
|
||||
- `off`: do not record traces
|
||||
- `off` (default): do not record traces
|
||||
|
||||
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.
|
||||
|
||||
## 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
|
||||
|
||||
Run status:
|
||||
@@ -113,7 +136,7 @@ Run-step status:
|
||||
1. Create environment
|
||||
2. Create credentials and snippets (optional but common)
|
||||
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
|
||||
6. Run scenario
|
||||
7. Wait for run completion and inspect run logs/outputs
|
||||
Generated
+4661
-3598
File diff suppressed because it is too large.
Load diff
+4
-1
@@ -1,7 +1,10 @@
|
||||
{
|
||||
"name": "liqa",
|
||||
"version": "1.16.0",
|
||||
"version": "1.20.2",
|
||||
"private": true,
|
||||
"engines": {
|
||||
"node": ">=24"
|
||||
},
|
||||
"workspaces": [
|
||||
"server",
|
||||
"client"
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
# ── Build stage ──────────────────────────────────────────────────────────────
|
||||
FROM node:22-slim AS builder
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY package*.json ./
|
||||
COPY server/package.json ./server/
|
||||
RUN npm ci -w server
|
||||
|
||||
COPY server/nest-cli.json ./server/
|
||||
COPY server/tsconfig*.json ./server/
|
||||
COPY server/src ./server/src
|
||||
RUN npm run -w server build
|
||||
|
||||
# ── Runtime stage ─────────────────────────────────────────────────────────────
|
||||
FROM node:22-slim AS runtime
|
||||
|
||||
# Playwright / Chromium system dependencies
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
chromium \
|
||||
fonts-noto \
|
||||
ca-certificates \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Tell Playwright to use the system Chromium instead of downloading its own
|
||||
ENV PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD=1
|
||||
ENV PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH=/usr/bin/chromium
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY package*.json ./
|
||||
COPY server/package.json ./server/
|
||||
RUN npm ci --omit=dev -w server
|
||||
|
||||
COPY --from=builder /app/server/dist ./dist
|
||||
|
||||
# Runtime directories (keys and SQLite DB mounted via volumes)
|
||||
RUN mkdir -p data
|
||||
|
||||
EXPOSE 3000
|
||||
|
||||
CMD ["node", "dist/main"]
|
||||
+5
-1
@@ -1,12 +1,15 @@
|
||||
{
|
||||
"name": "liqa-server",
|
||||
"version": "1.0.0",
|
||||
"private": true,
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"build": "nest build",
|
||||
"start": "nest start",
|
||||
"start:dev": "nest start --watch",
|
||||
"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\"",
|
||||
"lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
|
||||
"lint:fix": "eslint --fix \"src/**/*.ts\" \"test/**/*.ts\"",
|
||||
@@ -25,6 +28,7 @@
|
||||
"@nestjs/core": "^11.1.18",
|
||||
"@nestjs/platform-express": "^11.1.18",
|
||||
"@nestjs/schedule": "^6.1.1",
|
||||
"@nestjs/serve-static": "^5.0.5",
|
||||
"@nestjs/swagger": "^11.2.6",
|
||||
"@nestjs/typeorm": "^11.0.1",
|
||||
"@playwright/test": "^1.59.1",
|
||||
|
||||
+12
-37
@@ -1,30 +1,19 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { ConfigModule, ConfigService } from "@nestjs/config";
|
||||
import { ScheduleModule } from "@nestjs/schedule";
|
||||
import { ServeStaticModule } from "@nestjs/serve-static";
|
||||
import { TypeOrmModule } from "@nestjs/typeorm";
|
||||
import { BrowserModule } from "./browser/browser.module";
|
||||
import { clientStaticOptions } from "./common/client-static";
|
||||
import { dataSourceOptions } from "./database/data-source";
|
||||
import { AppConfig, validateAppConfig } from "./config/app.config";
|
||||
import { CredentialEntity } from "./credential/credential.entity";
|
||||
import { CredentialModule } from "./credential/credential.module";
|
||||
import { EnvironmentEntity } from "./environment/environment.entity";
|
||||
import { EnvironmentModule } from "./environment/environment.module";
|
||||
import { FileEntity } from "./file/file.entity";
|
||||
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 { ImportModule } from "./import/import.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 { SessionEntity } from "./session/session.entity";
|
||||
import { SnippetEntity } from "./snippet/snippet.entity";
|
||||
import { SnippetModule } from "./snippet/snippet.module";
|
||||
|
||||
@Module({
|
||||
@@ -35,30 +24,15 @@ import { SnippetModule } from "./snippet/snippet.module";
|
||||
validate: validateAppConfig,
|
||||
}),
|
||||
ScheduleModule.forRoot(),
|
||||
ServeStaticModule.forRootAsync({
|
||||
inject: [ConfigService],
|
||||
useFactory: (config: ConfigService<AppConfig, true>) =>
|
||||
clientStaticOptions(config.get("CLIENT_DIR")),
|
||||
}),
|
||||
TypeOrmModule.forRootAsync({
|
||||
inject: [ConfigService],
|
||||
useFactory: (config: ConfigService<AppConfig, true>) => ({
|
||||
type: "better-sqlite3",
|
||||
database: config.get("DB_PATH"),
|
||||
entities: [
|
||||
SessionEntity,
|
||||
EnvironmentEntity,
|
||||
CredentialEntity,
|
||||
ScenarioEntity,
|
||||
ScenarioStepEntity,
|
||||
ScenarioVersionEntity,
|
||||
ScenarioRunEntity,
|
||||
ScenarioRunStepEntity,
|
||||
ScenarioRunLogEntity,
|
||||
ScenarioCredentialEntity,
|
||||
SnippetEntity,
|
||||
SnippetVersionEntity,
|
||||
FileEntity,
|
||||
ScenarioFileEntity,
|
||||
ScenarioRunFileEntity,
|
||||
],
|
||||
synchronize: true,
|
||||
}),
|
||||
useFactory: (config: ConfigService<AppConfig, true>) =>
|
||||
dataSourceOptions(config.get("DB_PATH")),
|
||||
}),
|
||||
BrowserModule,
|
||||
EnvironmentModule,
|
||||
@@ -66,6 +40,7 @@ import { SnippetModule } from "./snippet/snippet.module";
|
||||
ScenarioModule,
|
||||
SnippetModule,
|
||||
FileModule,
|
||||
ImportModule,
|
||||
McpModule,
|
||||
HealthModule,
|
||||
],
|
||||
|
||||
@@ -6,7 +6,7 @@ import {
|
||||
import { expect as playwrightExpect } from "@playwright/test";
|
||||
import { parse } from "acorn";
|
||||
import type { BrowserContext, Page } from "playwright";
|
||||
import { URL } from "url";
|
||||
import { URL } from "node:url";
|
||||
import { downloadFile as downloadFileImpl } from "../common/file-downloader";
|
||||
import { TraceLogger } from "../common/trace-logger";
|
||||
import type { EnvironmentData } from "../environment/environment.entity";
|
||||
@@ -74,7 +74,6 @@ export interface ExecContext {
|
||||
credentials?: Record<string, unknown>;
|
||||
environment?: EnvironmentData | null;
|
||||
snippets?: Record<string, string> | null;
|
||||
result?: unknown;
|
||||
scenarioId?: string;
|
||||
runId?: string;
|
||||
fileService?: FileStorageService;
|
||||
@@ -115,7 +114,6 @@ export class CodeExecutorService {
|
||||
credentials,
|
||||
environment,
|
||||
snippets,
|
||||
result,
|
||||
scenarioId,
|
||||
runId,
|
||||
fileService,
|
||||
@@ -278,12 +276,11 @@ export class CodeExecutorService {
|
||||
},
|
||||
};
|
||||
|
||||
// `console`, `result`, and `expect` are injected as named parameters so
|
||||
// existing scripts that reference them directly still work.
|
||||
// `console` and `expect` are injected as named parameters so scripts
|
||||
// can reference them directly.
|
||||
const fn = new Function(
|
||||
"context",
|
||||
"console",
|
||||
"result",
|
||||
"expect",
|
||||
`return (async (context) => { ${code} })(context)`,
|
||||
);
|
||||
@@ -291,7 +288,6 @@ export class CodeExecutorService {
|
||||
const execResult = await fn(
|
||||
scriptContext,
|
||||
fakeConsole,
|
||||
result,
|
||||
playwrightExpect,
|
||||
);
|
||||
return { result: execResult };
|
||||
|
||||
@@ -46,11 +46,6 @@ export class ExecContextBuilder {
|
||||
return this;
|
||||
}
|
||||
|
||||
result(result: unknown): this {
|
||||
this.ctx.result = result;
|
||||
return this;
|
||||
}
|
||||
|
||||
scenarioId(scenarioId: string): this {
|
||||
this.ctx.scenarioId = scenarioId;
|
||||
return this;
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
import * as fs from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
export interface AppPackage {
|
||||
name: string;
|
||||
version: string;
|
||||
}
|
||||
|
||||
let cached: AppPackage | undefined;
|
||||
|
||||
/**
|
||||
* Name and version of the application, read from the workspace root
|
||||
* `package.json` (the one declaring `workspaces`) - the single source of the
|
||||
* app version. Found by walking up from this file, which covers both the repo
|
||||
* (`server/src/common` → repo root) and the Docker image
|
||||
* (`/app/dist/common` → `/app/package.json`).
|
||||
*/
|
||||
export function appPackage(): AppPackage {
|
||||
if (cached) return cached;
|
||||
let dir = __dirname;
|
||||
for (;;) {
|
||||
const file = path.join(dir, "package.json");
|
||||
if (fs.existsSync(file)) {
|
||||
const pkg = JSON.parse(fs.readFileSync(file, "utf8")) as Partial<
|
||||
AppPackage & { workspaces: unknown }
|
||||
>;
|
||||
if (pkg.workspaces && pkg.name && pkg.version) {
|
||||
cached = { name: pkg.name, version: pkg.version };
|
||||
return cached;
|
||||
}
|
||||
}
|
||||
const parent = path.dirname(dir);
|
||||
if (parent === dir) {
|
||||
throw new Error(
|
||||
`Workspace root package.json (with "workspaces", "name" and "version") not found above ${__dirname}`,
|
||||
);
|
||||
}
|
||||
dir = parent;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
import type { NestExpressApplication } from "@nestjs/platform-express";
|
||||
|
||||
/** Content types accepted as raw YAML text (e.g. by `POST /import`). */
|
||||
export const YAML_CONTENT_TYPES = [
|
||||
"application/yaml",
|
||||
"application/x-yaml",
|
||||
"text/yaml",
|
||||
"text/x-yaml",
|
||||
];
|
||||
|
||||
/** Registers body parsers beyond Nest's default JSON/urlencoded ones. */
|
||||
export function configureBodyParsers(app: NestExpressApplication): void {
|
||||
app.useBodyParser("text", { type: YAML_CONTENT_TYPES, limit: "10mb" });
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
import type { ServeStaticModuleOptions } from "@nestjs/serve-static";
|
||||
import type { ServerResponse } from "node:http";
|
||||
import * as path from "node:path";
|
||||
|
||||
/** Server routes that must never fall back to the client's index.html. */
|
||||
const SERVER_ROUTES = [
|
||||
"/api/{*path}",
|
||||
"/mcp{*path}",
|
||||
"/docs{*path}",
|
||||
"/health",
|
||||
"/healthz",
|
||||
];
|
||||
|
||||
/**
|
||||
* Serves the built client (SPA) from `clientDir`: static files as they are,
|
||||
* any other GET outside the server routes gets index.html so client-side
|
||||
* routes survive a page refresh. Returns no options (nothing served) when
|
||||
* `clientDir` is empty, e.g. in tests and local development.
|
||||
*/
|
||||
export function clientStaticOptions(
|
||||
clientDir: string,
|
||||
): ServeStaticModuleOptions[] {
|
||||
if (!clientDir) return [];
|
||||
return [
|
||||
{
|
||||
rootPath: path.resolve(clientDir),
|
||||
exclude: SERVER_ROUTES,
|
||||
serveStaticOptions: {
|
||||
setHeaders: (res: ServerResponse, filePath: string) => {
|
||||
// Vite emits content-hashed files under assets/; index.html must
|
||||
// always be revalidated so a new deploy is picked up immediately
|
||||
const cacheControl = filePath.includes(`${path.sep}assets${path.sep}`)
|
||||
? "public, max-age=31536000, immutable"
|
||||
: "no-cache";
|
||||
res.setHeader("Cache-Control", cacheControl);
|
||||
},
|
||||
},
|
||||
},
|
||||
];
|
||||
}
|
||||
@@ -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;
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
import * as https from "https";
|
||||
import * as http from "http";
|
||||
import { URL } from "url";
|
||||
import * as https from "node:https";
|
||||
import * as http from "node:http";
|
||||
import { URL } from "node:url";
|
||||
|
||||
const MAX_FILE_SIZE = 100 * 1024 * 1024; // 100 MB
|
||||
const TIMEOUT_MS = 30000; // 30 seconds
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { AsyncLocalStorage } from "async_hooks";
|
||||
import { AsyncLocalStorage } from "node:async_hooks";
|
||||
|
||||
export interface TraceStore {
|
||||
traceId: string;
|
||||
|
||||
@@ -8,7 +8,7 @@ import {
|
||||
validateSync,
|
||||
} from "class-validator";
|
||||
|
||||
import pkg from "../../package.json";
|
||||
import { appPackage } from "../common/app-package";
|
||||
|
||||
export enum TraceMode {
|
||||
On = "on",
|
||||
@@ -17,22 +17,24 @@ export enum TraceMode {
|
||||
}
|
||||
|
||||
export class AppConfig {
|
||||
/** `production` in the Docker image; also selects the default CORS origins. */
|
||||
@IsString()
|
||||
NODE_ENV: string = "development";
|
||||
|
||||
/** Comma-separated origins allowed to call the API cross-origin; empty = default for NODE_ENV. */
|
||||
@IsString()
|
||||
CORS_ORIGINS: string = "";
|
||||
|
||||
@IsInt()
|
||||
@Min(1)
|
||||
@Max(65535)
|
||||
PORT: number = 3000;
|
||||
|
||||
@IsString()
|
||||
APP_NAME: string = pkg.name;
|
||||
APP_NAME: string = appPackage().name;
|
||||
|
||||
@IsString()
|
||||
APP_VERSION: string = pkg.version;
|
||||
|
||||
@IsString()
|
||||
KEYS_DIR: string = "keys";
|
||||
APP_VERSION: string = appPackage().version;
|
||||
|
||||
@IsString()
|
||||
DB_PATH: string = "data/liqa.db";
|
||||
@@ -55,8 +57,13 @@ export class AppConfig {
|
||||
@IsString()
|
||||
FILE_CLEANUP_CRON: string = "0 3 * * *";
|
||||
|
||||
/** Directory with the built client to serve at `/`; empty to not serve it. */
|
||||
@IsString()
|
||||
CLIENT_DIR: string = "";
|
||||
|
||||
@IsEnum(TraceMode)
|
||||
PLAYWRIGHT_TRACE_MODE: TraceMode = TraceMode.On;
|
||||
// Off by default: traces with screenshots and snapshots easily reach ~10 MB per run
|
||||
PLAYWRIGHT_TRACE_MODE: TraceMode = TraceMode.Off;
|
||||
}
|
||||
|
||||
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,7 @@
|
||||
import { Initial1790793447827 } from "./1790793447827-Initial";
|
||||
|
||||
/**
|
||||
* 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];
|
||||
@@ -2,9 +2,9 @@ import { Injectable, OnModuleInit } from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { SchedulerRegistry } from "@nestjs/schedule";
|
||||
import { InjectRepository } from "@nestjs/typeorm";
|
||||
import * as crypto from "crypto";
|
||||
import * as fs from "fs/promises";
|
||||
import * as path from "path";
|
||||
import * as crypto from "node:crypto";
|
||||
import * as fs from "node:fs/promises";
|
||||
import * as path from "node:path";
|
||||
import { CronJob } from "cron";
|
||||
import { Repository } from "typeorm";
|
||||
import { TraceLogger } from "../common/trace-logger";
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
import { BadRequestException, Body, Controller, Post } from "@nestjs/common";
|
||||
import {
|
||||
ApiBody,
|
||||
ApiConsumes,
|
||||
ApiOperation,
|
||||
ApiResponse,
|
||||
ApiTags,
|
||||
} from "@nestjs/swagger";
|
||||
import { YAML_CONTENT_TYPES } from "../common/body-parsers";
|
||||
import { ImportService } from "./import.service";
|
||||
|
||||
@ApiTags("import")
|
||||
@Controller("import")
|
||||
export class ImportController {
|
||||
constructor(private readonly importService: ImportService) {}
|
||||
|
||||
@Post()
|
||||
@ApiOperation({
|
||||
summary:
|
||||
"Import any mix of environments, credentials, snippets and scenarios",
|
||||
description:
|
||||
"Send YAML (Content-Type application/yaml): `---`-separated documents, each holding one exported item or a list of them. " +
|
||||
"A JSON array of items (or a single item) is accepted too. Every item needs a `kind`. " +
|
||||
"All items are validated before anything is imported, then imported in dependency order: environments, credentials, snippets, scenarios.",
|
||||
})
|
||||
@ApiConsumes(...YAML_CONTENT_TYPES, "application/json")
|
||||
@ApiBody({ schema: { type: "string" } })
|
||||
@ApiResponse({ status: 201, description: "Imported items" })
|
||||
@ApiResponse({
|
||||
status: 400,
|
||||
description: "Invalid YAML or items; nothing was imported",
|
||||
})
|
||||
import(@Body() body: unknown) {
|
||||
if (typeof body === "string") {
|
||||
return this.importService.importYaml(body);
|
||||
}
|
||||
if (Array.isArray(body)) return this.importService.importItems(body);
|
||||
if (body && typeof body === "object" && Object.keys(body).length > 0) {
|
||||
return this.importService.importItems([body]);
|
||||
}
|
||||
throw new BadRequestException(
|
||||
"Send YAML with Content-Type application/yaml, or a JSON item or array of items",
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { CredentialModule } from "../credential/credential.module";
|
||||
import { EnvironmentModule } from "../environment/environment.module";
|
||||
import { ScenarioModule } from "../scenario/scenario.module";
|
||||
import { SnippetModule } from "../snippet/snippet.module";
|
||||
import { ImportController } from "./import.controller";
|
||||
import { ImportService } from "./import.service";
|
||||
|
||||
@Module({
|
||||
imports: [EnvironmentModule, CredentialModule, SnippetModule, ScenarioModule],
|
||||
controllers: [ImportController],
|
||||
providers: [ImportService],
|
||||
exports: [ImportService],
|
||||
})
|
||||
export class ImportModule {}
|
||||
@@ -0,0 +1,176 @@
|
||||
import { BadRequestException, Injectable } from "@nestjs/common";
|
||||
import { ClassConstructor, plainToInstance } from "class-transformer";
|
||||
import { validateSync, ValidationError } from "class-validator";
|
||||
import { parseAllDocuments } from "yaml";
|
||||
import { CredentialExportDto } from "../credential/dto/credential-export.dto";
|
||||
import { CredentialService } from "../credential/credential.service";
|
||||
import { EnvironmentExportDto } from "../environment/dto/environment-export.dto";
|
||||
import { EnvironmentService } from "../environment/environment.service";
|
||||
import { ScenarioExportDto } from "../scenario/dto/scenario-export.dto";
|
||||
import { ScenarioService } from "../scenario/scenario.service";
|
||||
import { SnippetExportDto } from "../snippet/dto/snippet-export.dto";
|
||||
import { SnippetService } from "../snippet/snippet.service";
|
||||
|
||||
export type ImportKind = "environment" | "credential" | "snippet" | "scenario";
|
||||
|
||||
/** Import order: later kinds may reference earlier ones (scenarios → environments/credentials). */
|
||||
const KIND_ORDER: ImportKind[] = [
|
||||
"environment",
|
||||
"credential",
|
||||
"snippet",
|
||||
"scenario",
|
||||
];
|
||||
|
||||
const DTO_BY_KIND: Record<ImportKind, ClassConstructor<object>> = {
|
||||
environment: EnvironmentExportDto,
|
||||
credential: CredentialExportDto,
|
||||
snippet: SnippetExportDto,
|
||||
scenario: ScenarioExportDto,
|
||||
};
|
||||
|
||||
export interface ImportedItem {
|
||||
kind: ImportKind;
|
||||
id: string;
|
||||
name: string;
|
||||
/** Version stored for versioned kinds (snippets, scenarios). */
|
||||
version?: number;
|
||||
}
|
||||
|
||||
export interface ImportResult {
|
||||
imported: ImportedItem[];
|
||||
}
|
||||
|
||||
function formatErrors(errors: ValidationError[], prefix = ""): string[] {
|
||||
return errors.flatMap((e) => {
|
||||
const field = prefix ? `${prefix}.${e.property}` : e.property;
|
||||
return [
|
||||
...Object.values(e.constraints ?? {}).map((msg) => `${field}: ${msg}`),
|
||||
...formatErrors(e.children ?? [], field),
|
||||
];
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Imports any mix of exported environments, credentials, snippets and
|
||||
* scenarios in one go. Each item must carry its `kind`.
|
||||
*/
|
||||
@Injectable()
|
||||
export class ImportService {
|
||||
constructor(
|
||||
private readonly environmentService: EnvironmentService,
|
||||
private readonly credentialService: CredentialService,
|
||||
private readonly snippetService: SnippetService,
|
||||
private readonly scenarioService: ScenarioService,
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Parses a YAML stream: `---`-separated documents, each holding a single
|
||||
* item or a list of items. JSON is valid YAML, so JSON input works too.
|
||||
*/
|
||||
parseYaml(text: string): unknown[] {
|
||||
const docs = parseAllDocuments(text);
|
||||
const items: unknown[] = [];
|
||||
docs.forEach((doc, index) => {
|
||||
if (doc.errors.length > 0) {
|
||||
throw new BadRequestException(
|
||||
`YAML document ${index + 1}: ${doc.errors[0].message}`,
|
||||
);
|
||||
}
|
||||
const value: unknown = doc.toJS();
|
||||
if (value == null) return; // empty document, e.g. a trailing `---`
|
||||
items.push(...(Array.isArray(value) ? value : [value]));
|
||||
});
|
||||
return items;
|
||||
}
|
||||
|
||||
async importYaml(text: string): Promise<ImportResult> {
|
||||
return this.importItems(this.parseYaml(text));
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates every item before importing any, then imports them in
|
||||
* dependency order (environments, credentials, snippets, scenarios).
|
||||
*/
|
||||
async importItems(items: unknown[]): Promise<ImportResult> {
|
||||
if (items.length === 0) {
|
||||
throw new BadRequestException("Nothing to import");
|
||||
}
|
||||
|
||||
const errors: string[] = [];
|
||||
const validated: { kind: ImportKind; dto: object }[] = [];
|
||||
items.forEach((item, index) => {
|
||||
const label = `Item ${index + 1}`;
|
||||
if (item == null || typeof item !== "object" || Array.isArray(item)) {
|
||||
errors.push(`${label}: must be an object`);
|
||||
return;
|
||||
}
|
||||
const kind = (item as { kind?: unknown }).kind;
|
||||
if (typeof kind !== "string" || !(kind in DTO_BY_KIND)) {
|
||||
errors.push(
|
||||
`${label}: kind must be one of ${KIND_ORDER.join(", ")} (got ${JSON.stringify(kind)})`,
|
||||
);
|
||||
return;
|
||||
}
|
||||
const dto = plainToInstance(DTO_BY_KIND[kind as ImportKind], item);
|
||||
const itemErrors = formatErrors(validateSync(dto, { whitelist: true }));
|
||||
if (itemErrors.length > 0) {
|
||||
errors.push(`${label} (${kind}): ${itemErrors.join("; ")}`);
|
||||
return;
|
||||
}
|
||||
validated.push({ kind: kind as ImportKind, dto });
|
||||
});
|
||||
if (errors.length > 0) {
|
||||
throw new BadRequestException(errors);
|
||||
}
|
||||
|
||||
const imported: ImportedItem[] = [];
|
||||
for (const kind of KIND_ORDER) {
|
||||
for (const item of validated.filter((v) => v.kind === kind)) {
|
||||
imported.push(await this.importOne(kind, item.dto));
|
||||
}
|
||||
}
|
||||
return { imported };
|
||||
}
|
||||
|
||||
private async importOne(
|
||||
kind: ImportKind,
|
||||
dto: object,
|
||||
): Promise<ImportedItem> {
|
||||
switch (kind) {
|
||||
case "environment": {
|
||||
const env = await this.environmentService.importEnvironment(
|
||||
dto as EnvironmentExportDto,
|
||||
);
|
||||
return { kind, id: env.id, name: env.name };
|
||||
}
|
||||
case "credential": {
|
||||
const cred = await this.credentialService.importCredential(
|
||||
dto as CredentialExportDto,
|
||||
);
|
||||
return { kind, id: cred.id, name: cred.name };
|
||||
}
|
||||
case "snippet": {
|
||||
const snippet = await this.snippetService.importSnippet(
|
||||
dto as SnippetExportDto,
|
||||
);
|
||||
return {
|
||||
kind,
|
||||
id: snippet.id,
|
||||
name: snippet.alias,
|
||||
version: snippet.version,
|
||||
};
|
||||
}
|
||||
case "scenario": {
|
||||
const scenario = await this.scenarioService.importScenario(
|
||||
dto as ScenarioExportDto,
|
||||
);
|
||||
return {
|
||||
kind,
|
||||
id: scenario.id,
|
||||
name: scenario.name,
|
||||
version: scenario.version,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@ import {
|
||||
Injectable,
|
||||
NestInterceptor,
|
||||
} from "@nestjs/common";
|
||||
import * as crypto from "crypto";
|
||||
import * as crypto from "node:crypto";
|
||||
import type { Request } from "express";
|
||||
import { Observable } from "rxjs";
|
||||
import { traceStorage } from "../common/trace-context";
|
||||
|
||||
+27
-4
@@ -1,9 +1,13 @@
|
||||
import { RequestMethod, ValidationPipe } from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { NestFactory } from "@nestjs/core";
|
||||
import { DataSource } from "typeorm";
|
||||
import type { NestExpressApplication } from "@nestjs/platform-express";
|
||||
import { DocumentBuilder, SwaggerModule } from "@nestjs/swagger";
|
||||
import { name as pkgName, version as pkgVersion } from "../package.json";
|
||||
import { AppModule } from "./app.module";
|
||||
import { appPackage } from "./common/app-package";
|
||||
import { configureBodyParsers } from "./common/body-parsers";
|
||||
import { corsOrigins } from "./common/cors";
|
||||
import { TraceLogger } from "./common/trace-logger";
|
||||
import { AppConfig } from "./config/app.config";
|
||||
import { HttpExceptionFilter } from "./filters/http-exception.filter";
|
||||
@@ -26,12 +30,22 @@ process.on("unhandledRejection", (reason) => {
|
||||
});
|
||||
|
||||
async function bootstrap() {
|
||||
const { name: pkgName, version: pkgVersion } = appPackage();
|
||||
const API_PREFIX = "api/v1";
|
||||
const logger = new TraceLogger("Bootstrap");
|
||||
const app = await NestFactory.create(AppModule, {
|
||||
const app = await NestFactory.create<NestExpressApplication>(AppModule, {
|
||||
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, {
|
||||
exclude: [
|
||||
{ path: "health", method: RequestMethod.ALL },
|
||||
@@ -40,6 +54,7 @@ async function bootstrap() {
|
||||
],
|
||||
});
|
||||
|
||||
configureBodyParsers(app);
|
||||
app.useGlobalPipes(new ValidationPipe({ transform: true }));
|
||||
app.useGlobalFilters(new HttpExceptionFilter());
|
||||
app.useGlobalInterceptors(new TraceInterceptor(), new LoggingInterceptor());
|
||||
@@ -49,7 +64,7 @@ async function bootstrap() {
|
||||
const nodeEnv = config.get("NODE_ENV");
|
||||
|
||||
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"],
|
||||
credentials: true,
|
||||
});
|
||||
@@ -72,4 +87,12 @@ async function bootstrap() {
|
||||
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);
|
||||
});
|
||||
@@ -6,6 +6,7 @@ import { EnvironmentModule } from "../environment/environment.module";
|
||||
import { ScenarioModule } from "../scenario/scenario.module";
|
||||
import { SessionModule } from "../session/session.module";
|
||||
import { SnippetModule } from "../snippet/snippet.module";
|
||||
import { ImportModule } from "../import/import.module";
|
||||
import { McpController } from "./mcp.controller";
|
||||
import { McpService } from "./mcp.service";
|
||||
|
||||
@@ -18,6 +19,7 @@ import { McpService } from "./mcp.service";
|
||||
CodeExecutorModule,
|
||||
ScenarioModule,
|
||||
SnippetModule,
|
||||
ImportModule,
|
||||
],
|
||||
controllers: [McpController],
|
||||
providers: [McpService],
|
||||
|
||||
@@ -14,8 +14,9 @@ import { CodeExecutorService } from "../code-executor/code-executor.service";
|
||||
import { ScenarioService } from "../scenario/scenario.service";
|
||||
import { E2eExportService } from "../scenario/e2e-export.service";
|
||||
import { SnippetService } from "../snippet/snippet.service";
|
||||
import { ImportService } from "../import/import.service";
|
||||
|
||||
import pkg from "../../package.json";
|
||||
import { appPackage } from "../common/app-package";
|
||||
|
||||
@Injectable()
|
||||
export class McpService {
|
||||
@@ -29,10 +30,12 @@ export class McpService {
|
||||
private readonly scenarioService: ScenarioService,
|
||||
private readonly e2eExportService: E2eExportService,
|
||||
private readonly snippetService: SnippetService,
|
||||
private readonly importService: ImportService,
|
||||
) {}
|
||||
|
||||
private createServer(): McpServer {
|
||||
const server = new McpServer({ name: pkg.name, version: pkg.version });
|
||||
const { name, version } = appPackage();
|
||||
const server = new McpServer({ name, version });
|
||||
this.registerTools(server);
|
||||
return server;
|
||||
}
|
||||
@@ -1307,6 +1310,35 @@ export class McpService {
|
||||
},
|
||||
);
|
||||
|
||||
server.registerTool(
|
||||
"import_yaml",
|
||||
{
|
||||
description:
|
||||
"Import any mix of exported environments, credentials, snippets and scenarios from YAML: `---`-separated documents, each holding one item or a list of items, each with a `kind`. All items are validated before anything is imported; versioned items (snippets, scenarios) must include `version`",
|
||||
inputSchema: {
|
||||
yaml: z.string().describe("YAML text, e.g. the content of an export file"),
|
||||
},
|
||||
},
|
||||
async ({ yaml }) => {
|
||||
try {
|
||||
const result = await this.importService.importYaml(yaml);
|
||||
return {
|
||||
content: [{ type: "text" as const, text: JSON.stringify(result) }],
|
||||
};
|
||||
} catch (err) {
|
||||
const response = (err as { getResponse?: () => unknown }).getResponse?.();
|
||||
const message =
|
||||
response && typeof response === "object" && "message" in response
|
||||
? JSON.stringify((response as { message: unknown }).message)
|
||||
: (err as Error).message;
|
||||
return {
|
||||
isError: true,
|
||||
content: [{ type: "text" as const, text: message }],
|
||||
};
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
server.registerTool(
|
||||
"export_e2e_test",
|
||||
{
|
||||
@@ -1407,12 +1439,12 @@ export class McpService {
|
||||
};
|
||||
}
|
||||
|
||||
// Create a mock Multer file object for the service
|
||||
// Build the subset of a Multer file object the service uses
|
||||
const file = {
|
||||
buffer,
|
||||
originalname: name,
|
||||
mimetype: mimeType || "application/octet-stream",
|
||||
} as any;
|
||||
};
|
||||
|
||||
// Call the service method
|
||||
const result = await this.scenarioService.uploadFile(
|
||||
@@ -1556,6 +1588,37 @@ export class McpService {
|
||||
},
|
||||
);
|
||||
|
||||
server.registerTool(
|
||||
"delete_run_file",
|
||||
{
|
||||
description:
|
||||
"Delete a file from a run. The stored file is removed once nothing else references it",
|
||||
inputSchema: {
|
||||
scenarioId: z.uuid().describe("Scenario ID"),
|
||||
runId: z.uuid().describe("Run ID"),
|
||||
fileId: z.uuid().describe("File ID (from list_run_files)"),
|
||||
},
|
||||
},
|
||||
async ({ scenarioId, runId, fileId }) => {
|
||||
try {
|
||||
await this.scenarioService.deleteRunFile(scenarioId, runId, fileId);
|
||||
return {
|
||||
content: [
|
||||
{
|
||||
type: "text" as const,
|
||||
text: `File ${fileId} deleted from run ${runId}`,
|
||||
},
|
||||
],
|
||||
};
|
||||
} catch (err) {
|
||||
return {
|
||||
isError: true,
|
||||
content: [{ type: "text" as const, text: (err as Error).message }],
|
||||
};
|
||||
}
|
||||
},
|
||||
);
|
||||
|
||||
server.registerTool(
|
||||
"get_run_file_content",
|
||||
{
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
import { Injectable } from "@nestjs/common";
|
||||
// archiver is a CommonJS `export =` function without a `default` export, and
|
||||
// esModuleInterop is off, so TypeScript's import-require form is the one that works
|
||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||
import archiver = require("archiver");
|
||||
import { resolveUsedSnippetAliases } from "../common/snippet-usage";
|
||||
import { SnippetService } from "../snippet/snippet.service";
|
||||
@@ -145,7 +148,7 @@ export class E2eExportService {
|
||||
const timeoutMs = (scenarioTimeoutSeconds ?? DEFAULT_SCENARIO_TIMEOUT_SEC) * 1000;
|
||||
return `import { defineConfig } from "@playwright/test";
|
||||
import * as dotenv from "dotenv";
|
||||
import * as path from "path";
|
||||
import * as path from "node:path";
|
||||
|
||||
dotenv.config({ path: path.resolve(__dirname, ".env") });
|
||||
|
||||
@@ -232,13 +235,13 @@ the scenario are bundled under \`files/\` and served locally by
|
||||
|
||||
return `import { test, expect } from "@playwright/test";
|
||||
import type { BrowserContext, Page } from "@playwright/test";
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
import * as crypto from "crypto";
|
||||
import * as http from "http";
|
||||
import * as https from "https";
|
||||
import { URL } from "url";
|
||||
import { randomUUID } from "crypto";
|
||||
import * as fs from "node:fs";
|
||||
import * as path from "node:path";
|
||||
import * as crypto from "node:crypto";
|
||||
import * as http from "node:http";
|
||||
import * as https from "node:https";
|
||||
import { URL } from "node:url";
|
||||
import { randomUUID } from "node:crypto";
|
||||
|
||||
// Credential data resolved from this scenario's aliases at export time.
|
||||
// Stored in credentials.json (gitignored) - contains sensitive values.
|
||||
|
||||
@@ -2,10 +2,10 @@ import { Injectable, OnModuleInit } from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { Interval } from "@nestjs/schedule";
|
||||
import { InjectRepository } from "@nestjs/typeorm";
|
||||
import * as crypto from "crypto";
|
||||
import * as fs from "fs/promises";
|
||||
import * as os from "os";
|
||||
import * as path from "path";
|
||||
import * as crypto from "node:crypto";
|
||||
import * as fs from "node:fs/promises";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
import { Effect } from "effect";
|
||||
import type { Browser, BrowserContext, Page } from "playwright";
|
||||
import { chromium } from "playwright";
|
||||
|
||||
@@ -25,7 +25,7 @@ import { CreateScenarioStepDto } from "./dto/create-scenario-step.dto";
|
||||
import { CreateScenarioDto } from "./dto/create-scenario.dto";
|
||||
import { ScenarioQueryDto } from "./dto/pagination-query.dto";
|
||||
import { RunsQueryDto } from "./dto/runs-query.dto";
|
||||
import { ExportEntity } from "./dto/scenario-export.dto";
|
||||
import { ExportEntity, ScenarioExportDto } from "./dto/scenario-export.dto";
|
||||
import { UpdateScenarioStepDto } from "./dto/update-scenario-step.dto";
|
||||
import { UpdateScenarioDto } from "./dto/update-scenario.dto";
|
||||
import { ScenarioService } from "./scenario.service";
|
||||
@@ -52,7 +52,9 @@ export class ScenarioController {
|
||||
@ApiOperation({ summary: "Import a scenario from an export payload (single object or array)" })
|
||||
@ApiResponse({ status: 201, description: "Scenario imported" })
|
||||
importScenario(@Body() payload: unknown) {
|
||||
return this.scenarioService.importScenario(payload as any);
|
||||
return this.scenarioService.importScenario(
|
||||
payload as ScenarioExportDto | ExportEntity[],
|
||||
);
|
||||
}
|
||||
|
||||
@Get()
|
||||
@@ -148,20 +150,20 @@ export class ScenarioController {
|
||||
version,
|
||||
});
|
||||
res.setHeader("Content-Type", "application/yaml; charset=utf-8");
|
||||
// Serialize as YAML stream: each entity separated by a comment header
|
||||
// Serialize as a YAML stream: one `---` document per entity, each with a
|
||||
// comment naming it. POST /import reads this format back.
|
||||
const kindLabels: Record<string, string> = {
|
||||
environment: "Environment",
|
||||
credential: "Credential",
|
||||
scenario: "Scenario",
|
||||
};
|
||||
const parts = (entities as ExportEntity[]).map((entity) => {
|
||||
const label = kindLabels[entity.kind ?? ""] ?? entity.kind ?? "Entity";
|
||||
const comment = `# --- ${label}: ${
|
||||
(entity as any).name ?? (entity as any).id ?? ""
|
||||
} ---`;
|
||||
return `${comment}\n${yamlStringify(entity)}`;
|
||||
});
|
||||
return parts.join("\n");
|
||||
return (entities as ExportEntity[])
|
||||
.map((entity) => {
|
||||
const label = kindLabels[entity.kind ?? ""] ?? entity.kind ?? "Entity";
|
||||
const comment = `# ${label}: ${entity.name ?? entity.id ?? ""}`;
|
||||
return `---\n${comment}\n${yamlStringify(entity)}`;
|
||||
})
|
||||
.join("");
|
||||
}
|
||||
|
||||
@Get(":id/export-e2e")
|
||||
@@ -434,4 +436,17 @@ export class ScenarioController {
|
||||
) {
|
||||
return this.scenarioService.getRunFileContent(id, runId, fileId, res);
|
||||
}
|
||||
|
||||
@Delete(":id/runs/:runId/files/:fileId")
|
||||
@HttpCode(204)
|
||||
@ApiOperation({ summary: "Delete a file from a run" })
|
||||
@ApiResponse({ status: 204, description: "File deleted" })
|
||||
@ApiResponse({ status: 404, description: "Scenario, run, or file not found" })
|
||||
deleteRunFile(
|
||||
@Param("id", ParseUUIDPipe) id: string,
|
||||
@Param("runId", ParseUUIDPipe) runId: string,
|
||||
@Param("fileId", ParseUUIDPipe) fileId: string,
|
||||
) {
|
||||
return this.scenarioService.deleteRunFile(id, runId, fileId);
|
||||
}
|
||||
}
|
||||
@@ -7,8 +7,8 @@ import {
|
||||
} from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import { InjectRepository } from "@nestjs/typeorm";
|
||||
import * as fs from "fs/promises";
|
||||
import * as path from "path";
|
||||
import * as fs from "node:fs/promises";
|
||||
import * as path from "node:path";
|
||||
import { Like, Repository } from "typeorm";
|
||||
import {
|
||||
PaginatedResult,
|
||||
@@ -21,7 +21,10 @@ import {
|
||||
import type { AppConfig, TraceMode } from "../config/app.config";
|
||||
import { CredentialEntity } from "../credential/credential.entity";
|
||||
import { EnvironmentEntity } from "../environment/environment.entity";
|
||||
import { FileStorageService } from "../file/file-storage.service";
|
||||
import {
|
||||
FileMetadata,
|
||||
FileStorageService,
|
||||
} from "../file/file-storage.service";
|
||||
import { ScenarioFileEntity } from "../file/scenario-file.entity";
|
||||
import { ScenarioRunFileEntity } from "../file/scenario-run-file.entity";
|
||||
import { SnippetEntity } from "../snippet/snippet.entity";
|
||||
@@ -83,6 +86,12 @@ function stepsSnapshot(steps: ScenarioStepEntity[]): ScenarioStepSnapshot[] {
|
||||
}));
|
||||
}
|
||||
|
||||
/** File metadata as returned by the scenario/run file listing endpoints. */
|
||||
export interface FileListResult {
|
||||
items: Omit<FileMetadata, "path">[];
|
||||
total: number;
|
||||
}
|
||||
|
||||
export type UsedSnippet = SnippetEntity & {
|
||||
/** Version pinned via `runSnippet("alias@N")`, or null for the latest. */
|
||||
pinnedVersion: number | null;
|
||||
@@ -941,9 +950,9 @@ export class ScenarioService implements OnModuleInit {
|
||||
|
||||
async uploadFile(
|
||||
scenarioId: string,
|
||||
file: MulterFile,
|
||||
file: Pick<MulterFile, "buffer" | "originalname" | "mimetype">,
|
||||
expiresAtStr?: string,
|
||||
): Promise<any> {
|
||||
): Promise<Omit<FileMetadata, "path" | "sha256">> {
|
||||
// Verify scenario exists
|
||||
await this.findOne(scenarioId);
|
||||
|
||||
@@ -990,7 +999,7 @@ export class ScenarioService implements OnModuleInit {
|
||||
scenarioId: string,
|
||||
limit?: number,
|
||||
offset?: number,
|
||||
): Promise<any> {
|
||||
): Promise<FileListResult> {
|
||||
// Verify scenario exists
|
||||
await this.findOne(scenarioId);
|
||||
|
||||
@@ -1088,7 +1097,7 @@ export class ScenarioService implements OnModuleInit {
|
||||
runId: string,
|
||||
limit?: number,
|
||||
offset?: number,
|
||||
): Promise<any> {
|
||||
): Promise<FileListResult> {
|
||||
// Verify scenario and run exist
|
||||
await this.findOne(scenarioId);
|
||||
const run = await this.runRepo.findOneBy({ id: runId, scenarioId });
|
||||
@@ -1116,6 +1125,28 @@ export class ScenarioService implements OnModuleInit {
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a file from a run. The stored file itself is deleted once no
|
||||
* scenario or run references it any more.
|
||||
*/
|
||||
async deleteRunFile(
|
||||
scenarioId: string,
|
||||
runId: string,
|
||||
fileId: string,
|
||||
): Promise<void> {
|
||||
await this.findOne(scenarioId); // 404 guard
|
||||
const run = await this.runRepo.findOneBy({ id: runId, scenarioId });
|
||||
if (!run) {
|
||||
throw new NotFoundException(`Run ${runId} not found in scenario ${scenarioId}`);
|
||||
}
|
||||
const link = await this.scenarioRunFileRepo.findOneBy({ runId, fileId });
|
||||
if (!link) {
|
||||
throw new NotFoundException(`File ${fileId} not found in run ${runId}`);
|
||||
}
|
||||
await this.scenarioRunFileRepo.delete(link.id);
|
||||
await this.fileStorageService.deleteFile(fileId);
|
||||
}
|
||||
|
||||
async getRunFileContent(
|
||||
scenarioId: string,
|
||||
runId: string,
|
||||
|
||||
@@ -18,7 +18,7 @@ const makeContext = () => ({
|
||||
stop: jest.fn().mockImplementation(async (opts?: { path?: string }) => {
|
||||
if (opts?.path) {
|
||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||
await require("fs/promises").writeFile(opts.path, "fake trace zip");
|
||||
await require("node:fs/promises").writeFile(opts.path, "fake trace zip");
|
||||
}
|
||||
}),
|
||||
},
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
import * as fs from "node:fs";
|
||||
import * as path from "node:path";
|
||||
import { appPackage } from "../src/common/app-package";
|
||||
import { validateAppConfig } from "../src/config/app.config";
|
||||
|
||||
describe("appPackage", () => {
|
||||
const root = JSON.parse(
|
||||
fs.readFileSync(path.resolve(__dirname, "../../package.json"), "utf8"),
|
||||
) as { name: string; version: string; workspaces: string[] };
|
||||
|
||||
it("reads name and version from the workspace root package.json", () => {
|
||||
expect(root.workspaces).toContain("server");
|
||||
expect(appPackage()).toEqual({ name: root.name, version: root.version });
|
||||
});
|
||||
|
||||
it("feeds APP_NAME and APP_VERSION", () => {
|
||||
const config = validateAppConfig({});
|
||||
expect(config.APP_NAME).toBe(root.name);
|
||||
expect(config.APP_VERSION).toBe(root.version);
|
||||
});
|
||||
});
|
||||
+26
-36
@@ -1,8 +1,17 @@
|
||||
import { INestApplication, ValidationPipe } from "@nestjs/common";
|
||||
import * as fs from "node:fs";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
import { Test, TestingModule } from "@nestjs/testing";
|
||||
import { TypeOrmModule } from "@nestjs/typeorm";
|
||||
import { ConfigModule } from "@nestjs/config";
|
||||
import type { NestExpressApplication } from "@nestjs/platform-express";
|
||||
import { ScheduleModule } from "@nestjs/schedule";
|
||||
|
||||
import { configureBodyParsers } from "../src/common/body-parsers";
|
||||
import { dataSourceOptions } from "../src/database/data-source";
|
||||
import { ImportModule } from "../src/import/import.module";
|
||||
|
||||
jest.mock("@nestjs/common", () => {
|
||||
const actual = jest.requireActual("@nestjs/common");
|
||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||
@@ -34,27 +43,17 @@ import { SessionModule } from "../src/session/session.module";
|
||||
import { EnvironmentModule } from "../src/environment/environment.module";
|
||||
import { ScenarioModule } from "../src/scenario/scenario.module";
|
||||
import { McpModule } from "../src/mcp/mcp.module";
|
||||
import { SessionEntity } from "../src/session/session.entity";
|
||||
import { EnvironmentEntity } from "../src/environment/environment.entity";
|
||||
import { ScenarioEntity } from "../src/scenario/scenario.entity";
|
||||
import { ScenarioStepEntity } from "../src/scenario/scenario-step.entity";
|
||||
import { ScenarioVersionEntity } from "../src/scenario/scenario-version.entity";
|
||||
import { SnippetVersionEntity } from "../src/snippet/snippet-version.entity";
|
||||
import { ScenarioRunEntity } from "../src/scenario/scenario-run.entity";
|
||||
import { ScenarioRunStepEntity } from "../src/scenario/scenario-run-step.entity";
|
||||
import { ScenarioRunLogEntity } from "../src/scenario/scenario-run-log.entity";
|
||||
import { ScenarioCredentialEntity } from "../src/scenario/scenario-credential.entity";
|
||||
import { CredentialEntity } from "../src/credential/credential.entity";
|
||||
import { SnippetEntity } from "../src/snippet/snippet.entity";
|
||||
import { HealthController } from "../src/health/health.controller";
|
||||
import { HttpExceptionFilter } from "../src/filters/http-exception.filter";
|
||||
import { LoggingInterceptor } from "../src/interceptors/logging.interceptor";
|
||||
import { validateAppConfig } from "../src/config/app.config";
|
||||
import { FileEntity } from "../src/file/file.entity";
|
||||
import { ScenarioFileEntity } from "../src/file/scenario-file.entity";
|
||||
import { ScenarioRunFileEntity } from "../src/file/scenario-run-file.entity";
|
||||
|
||||
export async function buildTestApp(): Promise<INestApplication> {
|
||||
// Each test app stores files in its own temp dir: suites run in parallel and
|
||||
// some clean up their files dir, which must not affect other suites.
|
||||
const filesDir = fs.mkdtempSync(path.join(os.tmpdir(), "liqa-test-files-"));
|
||||
process.env.FILES_DIR = filesDir;
|
||||
|
||||
const module: TestingModule = await Test.createTestingModule({
|
||||
imports: [
|
||||
ConfigModule.forRoot({
|
||||
@@ -62,42 +61,33 @@ export async function buildTestApp(): Promise<INestApplication> {
|
||||
ignoreEnvFile: true,
|
||||
validate: validateAppConfig,
|
||||
}),
|
||||
// The real migrations, not synchronize, so tests use the schema production gets
|
||||
TypeOrmModule.forRoot({
|
||||
type: "better-sqlite3",
|
||||
database: ":memory:",
|
||||
entities: [
|
||||
SessionEntity,
|
||||
EnvironmentEntity,
|
||||
ScenarioEntity,
|
||||
ScenarioStepEntity,
|
||||
ScenarioVersionEntity,
|
||||
ScenarioRunEntity,
|
||||
ScenarioRunStepEntity,
|
||||
ScenarioRunLogEntity,
|
||||
ScenarioCredentialEntity,
|
||||
CredentialEntity,
|
||||
SnippetEntity,
|
||||
SnippetVersionEntity,
|
||||
FileEntity,
|
||||
ScenarioFileEntity,
|
||||
ScenarioRunFileEntity,
|
||||
],
|
||||
synchronize: true,
|
||||
...dataSourceOptions(":memory:"),
|
||||
migrationsRun: true,
|
||||
}),
|
||||
ScheduleModule.forRoot(),
|
||||
BrowserModule,
|
||||
SessionModule,
|
||||
EnvironmentModule,
|
||||
ScenarioModule,
|
||||
ImportModule,
|
||||
McpModule,
|
||||
],
|
||||
controllers: [HealthController],
|
||||
}).compile();
|
||||
|
||||
const app = module.createNestApplication();
|
||||
const app = module.createNestApplication<NestExpressApplication>();
|
||||
configureBodyParsers(app);
|
||||
app.useGlobalPipes(new ValidationPipe({ transform: true, whitelist: true }));
|
||||
app.useGlobalFilters(new HttpExceptionFilter());
|
||||
app.useGlobalInterceptors(new LoggingInterceptor());
|
||||
await app.init();
|
||||
|
||||
const close = app.close.bind(app);
|
||||
app.close = async () => {
|
||||
await close();
|
||||
fs.rmSync(filesDir, { recursive: true, force: true });
|
||||
};
|
||||
return app;
|
||||
}
|
||||
@@ -0,0 +1,141 @@
|
||||
/**
|
||||
* Tests serving the built client alongside the server routes: static files,
|
||||
* the index.html fallback for client-side routes, and that server routes are
|
||||
* never answered with index.html.
|
||||
*/
|
||||
|
||||
import {
|
||||
Controller,
|
||||
Get,
|
||||
INestApplication,
|
||||
Module,
|
||||
Post,
|
||||
RequestMethod,
|
||||
} from "@nestjs/common";
|
||||
import { ServeStaticModule } from "@nestjs/serve-static";
|
||||
import { NestFactory } from "@nestjs/core";
|
||||
import * as fs from "node:fs";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
import request from "supertest";
|
||||
import { clientStaticOptions } from "../src/common/client-static";
|
||||
|
||||
@Controller("things")
|
||||
class ThingsController {
|
||||
@Get()
|
||||
list() {
|
||||
return [{ id: 1 }];
|
||||
}
|
||||
}
|
||||
|
||||
@Controller()
|
||||
class RootRoutesController {
|
||||
@Get("health")
|
||||
health() {
|
||||
return { status: "ok" };
|
||||
}
|
||||
|
||||
@Post("mcp")
|
||||
mcp() {
|
||||
return { jsonrpc: "2.0" };
|
||||
}
|
||||
}
|
||||
|
||||
async function buildApp(clientDir: string): Promise<INestApplication> {
|
||||
// NestFactory (as in main.ts) rather than Test.createTestingModule: the
|
||||
// serve-static module picks its HTTP loader while the module compiles,
|
||||
// which needs the HTTP adapter to exist already.
|
||||
@Module({
|
||||
imports: [ServeStaticModule.forRoot(...clientStaticOptions(clientDir))],
|
||||
controllers: [ThingsController, RootRoutesController],
|
||||
})
|
||||
class ClientStaticTestModule {}
|
||||
|
||||
const app = await NestFactory.create(ClientStaticTestModule, {
|
||||
logger: false,
|
||||
});
|
||||
// Same prefix setup as main.ts
|
||||
app.setGlobalPrefix("api/v1", {
|
||||
exclude: [
|
||||
{ path: "health", method: RequestMethod.ALL },
|
||||
{ path: "mcp", method: RequestMethod.ALL },
|
||||
],
|
||||
});
|
||||
await app.init();
|
||||
return app;
|
||||
}
|
||||
|
||||
describe("Client static serving", () => {
|
||||
let clientDir: string;
|
||||
let app: INestApplication;
|
||||
|
||||
beforeAll(async () => {
|
||||
clientDir = fs.mkdtempSync(path.join(os.tmpdir(), "liqa-client-"));
|
||||
fs.mkdirSync(path.join(clientDir, "assets"));
|
||||
fs.writeFileSync(path.join(clientDir, "index.html"), "<html>liqa</html>");
|
||||
fs.writeFileSync(
|
||||
path.join(clientDir, "assets", "app-abc123.js"),
|
||||
"console.log(1);",
|
||||
);
|
||||
app = await buildApp(clientDir);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
fs.rmSync(clientDir, { recursive: true, force: true });
|
||||
});
|
||||
|
||||
it("serves index.html at / without caching", async () => {
|
||||
const res = await request(app.getHttpServer()).get("/").expect(200);
|
||||
expect(res.text).toBe("<html>liqa</html>");
|
||||
expect(res.headers["cache-control"]).toBe("no-cache");
|
||||
});
|
||||
|
||||
it("serves index.html for client-side routes", async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get("/scenarios/123/runs/456")
|
||||
.expect(200);
|
||||
expect(res.text).toBe("<html>liqa</html>");
|
||||
expect(res.headers["cache-control"]).toBe("no-cache");
|
||||
});
|
||||
|
||||
it("serves hashed assets as immutable", async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get("/assets/app-abc123.js")
|
||||
.expect(200);
|
||||
expect(res.text).toBe("console.log(1);");
|
||||
expect(res.headers["cache-control"]).toContain("immutable");
|
||||
});
|
||||
|
||||
it("leaves API routes to the server", async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get("/api/v1/things")
|
||||
.expect(200);
|
||||
expect(res.body).toEqual([{ id: 1 }]);
|
||||
});
|
||||
|
||||
it("returns the server's 404 for unknown API routes, not index.html", async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get("/api/v1/nope")
|
||||
.expect(404);
|
||||
expect(res.text).not.toContain("liqa</html>");
|
||||
});
|
||||
|
||||
it("leaves /health and /mcp to the server", async () => {
|
||||
await request(app.getHttpServer())
|
||||
.get("/health")
|
||||
.expect(200, { status: "ok" });
|
||||
await request(app.getHttpServer())
|
||||
.post("/mcp")
|
||||
.expect(201, { jsonrpc: "2.0" });
|
||||
const res = await request(app.getHttpServer()).get("/mcp");
|
||||
expect(res.text).not.toContain("liqa</html>");
|
||||
});
|
||||
|
||||
it("serves nothing when no client directory is configured", async () => {
|
||||
const bare = await buildApp("");
|
||||
await request(bare.getHttpServer()).get("/").expect(404);
|
||||
await request(bare.getHttpServer()).get("/api/v1/things").expect(200);
|
||||
await bare.close();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,29 @@
|
||||
import { corsOrigins } from "../src/common/cors";
|
||||
|
||||
describe("corsOrigins", () => {
|
||||
it("allows the Vite dev server outside production", () => {
|
||||
for (const env of ["development", "test", ""]) {
|
||||
expect(corsOrigins(env, "")).toEqual([
|
||||
"http://localhost:5173",
|
||||
"http://127.0.0.1:5173",
|
||||
]);
|
||||
}
|
||||
});
|
||||
|
||||
it("allows the compose port in production", () => {
|
||||
expect(corsOrigins("production", "")).toEqual([
|
||||
"http://localhost:13000",
|
||||
"http://127.0.0.1:13000",
|
||||
]);
|
||||
});
|
||||
|
||||
it("uses CORS_ORIGINS when set, in any environment", () => {
|
||||
const override = " https://liqa.example.com , http://localhost:8080,";
|
||||
for (const env of ["development", "production"]) {
|
||||
expect(corsOrigins(env, override)).toEqual([
|
||||
"https://liqa.example.com",
|
||||
"http://localhost:8080",
|
||||
]);
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -1,7 +1,7 @@
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import { getRepositoryToken } from "@nestjs/typeorm";
|
||||
import * as http from "http";
|
||||
import * as fs from "fs/promises";
|
||||
import * as http from "node:http";
|
||||
import * as fs from "node:fs/promises";
|
||||
import { Repository } from "typeorm";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { FileStorageService } from "../src/file/file-storage.service";
|
||||
@@ -13,6 +13,7 @@ import { ScenarioStepEntity } from "../src/scenario/scenario-step.entity";
|
||||
import { ScenarioRunEntity } from "../src/scenario/scenario-run.entity";
|
||||
import { ScenarioRunStepEntity } from "../src/scenario/scenario-run-step.entity";
|
||||
import { ScenarioSchedulerService } from "../src/scenario/scenario-scheduler.service";
|
||||
import type { AddressInfo } from "node:net";
|
||||
|
||||
describe("Exec Context File Methods Integration Tests", () => {
|
||||
let app: INestApplication;
|
||||
@@ -57,7 +58,7 @@ describe("Exec Context File Methods Integration Tests", () => {
|
||||
|
||||
// Start a test HTTP server for downloadFile tests
|
||||
testServer = await createTestServer();
|
||||
testServerUrl = `http://localhost:${(testServer.address() as any).port}`;
|
||||
testServerUrl = `http://127.0.0.1:${(testServer.address() as AddressInfo).port}`;
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
@@ -69,7 +70,7 @@ describe("Exec Context File Methods Integration Tests", () => {
|
||||
// Clean up files directory
|
||||
try {
|
||||
await fs.rm(filesDir, { recursive: true, force: true });
|
||||
} catch (err) {
|
||||
} catch {
|
||||
// Ignore errors if directory doesn't exist
|
||||
}
|
||||
|
||||
@@ -93,7 +94,9 @@ describe("Exec Context File Methods Integration Tests", () => {
|
||||
}
|
||||
});
|
||||
|
||||
server.listen(0, "localhost", () => {
|
||||
// Explicit IPv4: "localhost" may bind ::1, which is unreachable in some
|
||||
// containers (e.g. Docker without IPv6)
|
||||
server.listen(0, "127.0.0.1", () => {
|
||||
resolve(server);
|
||||
});
|
||||
});
|
||||
@@ -223,7 +226,9 @@ describe("Exec Context File Methods Integration Tests", () => {
|
||||
expect(output.total).toBeGreaterThanOrEqual(1);
|
||||
|
||||
// Find the uploaded file in the output
|
||||
const foundFile = output.items.find((f: any) => f.id === uploadedFile.id);
|
||||
const foundFile = output.items.find(
|
||||
(f: { id: string; name: string }) => f.id === uploadedFile.id,
|
||||
);
|
||||
expect(foundFile).toBeDefined();
|
||||
expect(foundFile.name).toBe("test-file.txt");
|
||||
expect(foundFile.mimeType).toBe("text/plain");
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import { getRepositoryToken } from "@nestjs/typeorm";
|
||||
import request from "supertest";
|
||||
import * as fs from "fs/promises";
|
||||
import * as fs from "node:fs/promises";
|
||||
import { Repository } from "typeorm";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { FileStorageService } from "../src/file/file-storage.service";
|
||||
import { FileEntity } from "../src/file/file.entity";
|
||||
import { ScenarioRunFileEntity } from "../src/file/scenario-run-file.entity";
|
||||
import { ScenarioEntity } from "../src/scenario/scenario.entity";
|
||||
import { ScenarioRunEntity } from "../src/scenario/scenario-run.entity";
|
||||
|
||||
@@ -15,6 +16,7 @@ describe("File Controller Integration Tests", () => {
|
||||
let fileRepo: Repository<FileEntity>;
|
||||
let scenarioRepo: Repository<ScenarioEntity>;
|
||||
let runRepo: Repository<ScenarioRunEntity>;
|
||||
let runFileRepo: Repository<ScenarioRunFileEntity>;
|
||||
let filesDir: string;
|
||||
|
||||
beforeAll(async () => {
|
||||
@@ -27,6 +29,9 @@ describe("File Controller Integration Tests", () => {
|
||||
runRepo = app.get<Repository<ScenarioRunEntity>>(
|
||||
getRepositoryToken(ScenarioRunEntity),
|
||||
);
|
||||
runFileRepo = app.get<Repository<ScenarioRunFileEntity>>(
|
||||
getRepositoryToken(ScenarioRunFileEntity),
|
||||
);
|
||||
|
||||
// Get the files directory from the service
|
||||
filesDir = fileStorageService.getAbsolutePath("");
|
||||
@@ -36,7 +41,7 @@ describe("File Controller Integration Tests", () => {
|
||||
// Clean up files directory
|
||||
try {
|
||||
await fs.rm(filesDir, { recursive: true, force: true });
|
||||
} catch (err) {
|
||||
} catch {
|
||||
// Ignore errors if directory doesn't exist
|
||||
}
|
||||
await app.close();
|
||||
@@ -146,7 +151,9 @@ describe("File Controller Integration Tests", () => {
|
||||
expect(res.body.items.length).toBeGreaterThanOrEqual(1);
|
||||
expect(res.body.total).toBeGreaterThanOrEqual(1);
|
||||
|
||||
const file = res.body.items.find((f: any) => f.name === "listed.txt");
|
||||
const file = res.body.items.find(
|
||||
(f: { id: string; name: string }) => f.name === "listed.txt",
|
||||
);
|
||||
expect(file).toBeDefined();
|
||||
expect(file.id).toBeDefined();
|
||||
expect(file.mimeType).toBe("text/plain");
|
||||
@@ -274,7 +281,9 @@ describe("File Controller Integration Tests", () => {
|
||||
expect(Array.isArray(res.body.items)).toBe(true);
|
||||
expect(res.body.total).toBeGreaterThanOrEqual(1);
|
||||
|
||||
const artifact = res.body.items.find((f: any) => f.id === savedFile.id);
|
||||
const artifact = res.body.items.find(
|
||||
(f: { id: string; name: string; size: number }) => f.id === savedFile.id,
|
||||
);
|
||||
expect(artifact).toBeDefined();
|
||||
expect(artifact.name).toBe("artifact.txt");
|
||||
expect(artifact.size).toBe(fileBuffer.length);
|
||||
@@ -335,12 +344,83 @@ describe("File Controller Integration Tests", () => {
|
||||
});
|
||||
});
|
||||
|
||||
// ── DELETE /scenarios/:id/runs/:runId/files/:fileId ───────────────────────
|
||||
|
||||
describe("DELETE /scenarios/:id/runs/:runId/files/:fileId", () => {
|
||||
async function createArtifact(runId: string, name = "to-delete.txt") {
|
||||
return fileStorageService.createAndSaveRunArtifact(
|
||||
runId,
|
||||
Buffer.from("delete me"),
|
||||
name,
|
||||
"text/plain",
|
||||
);
|
||||
}
|
||||
|
||||
it("removes the file from the run and deletes the stored file", async () => {
|
||||
const scenario = await createScenario("run-file-delete");
|
||||
const run = await createRun(scenario.id);
|
||||
const file = await createArtifact(run.id);
|
||||
const physicalPath = fileStorageService.getAbsolutePath(file.filePath);
|
||||
|
||||
await request(app.getHttpServer())
|
||||
.delete(`/scenarios/${scenario.id}/runs/${run.id}/files/${file.id}`)
|
||||
.expect(204);
|
||||
|
||||
const list = await request(app.getHttpServer())
|
||||
.get(`/scenarios/${scenario.id}/runs/${run.id}/files`)
|
||||
.expect(200);
|
||||
expect(list.body.items).toHaveLength(0);
|
||||
expect(await fileRepo.findOneBy({ id: file.id })).toBeNull();
|
||||
await expect(fs.access(physicalPath)).rejects.toThrow();
|
||||
});
|
||||
|
||||
it("keeps the stored file while another run still references it", async () => {
|
||||
const scenario = await createScenario("run-file-delete-shared");
|
||||
const run = await createRun(scenario.id);
|
||||
const otherRun = await createRun(scenario.id);
|
||||
const file = await createArtifact(run.id, "shared.txt");
|
||||
await runFileRepo.save(
|
||||
runFileRepo.create({ runId: otherRun.id, fileId: file.id }),
|
||||
);
|
||||
|
||||
await request(app.getHttpServer())
|
||||
.delete(`/scenarios/${scenario.id}/runs/${run.id}/files/${file.id}`)
|
||||
.expect(204);
|
||||
|
||||
expect(await fileRepo.findOneBy({ id: file.id })).not.toBeNull();
|
||||
await request(app.getHttpServer())
|
||||
.get(
|
||||
`/scenarios/${scenario.id}/runs/${otherRun.id}/files/${file.id}/content`,
|
||||
)
|
||||
.expect(200);
|
||||
});
|
||||
|
||||
it("returns 404 for a file that belongs to a different run", async () => {
|
||||
const scenario = await createScenario("run-file-delete-mismatch");
|
||||
const run = await createRun(scenario.id);
|
||||
const otherRun = await createRun(scenario.id);
|
||||
const file = await createArtifact(otherRun.id);
|
||||
|
||||
await request(app.getHttpServer())
|
||||
.delete(`/scenarios/${scenario.id}/runs/${run.id}/files/${file.id}`)
|
||||
.expect(404);
|
||||
expect(await fileRepo.findOneBy({ id: file.id })).not.toBeNull();
|
||||
});
|
||||
|
||||
it("returns 404 when the run does not exist", async () => {
|
||||
const scenario = await createScenario("run-file-delete-no-run");
|
||||
await request(app.getHttpServer())
|
||||
.delete(
|
||||
`/scenarios/${scenario.id}/runs/00000000-0000-0000-0000-000000000000/files/00000000-0000-0000-0000-000000000000`,
|
||||
)
|
||||
.expect(404);
|
||||
});
|
||||
});
|
||||
|
||||
// ── File cleanup ───────────────────────────────────────────────────────────
|
||||
|
||||
describe("File cleanup", () => {
|
||||
it("removes expired files from disk and database", async () => {
|
||||
const scenario = await createScenario("cleanup-test");
|
||||
|
||||
// Upload a file with a past expiration date
|
||||
const fileBuffer = Buffer.from("to be cleaned up");
|
||||
const savedFile = await fileStorageService.saveFile(
|
||||
@@ -367,13 +447,11 @@ describe("File Controller Integration Tests", () => {
|
||||
fail("File should have been deleted");
|
||||
} catch (err) {
|
||||
// Expected: file not found
|
||||
expect((err as any).code).toBe("ENOENT");
|
||||
expect((err as NodeJS.ErrnoException).code).toBe("ENOENT");
|
||||
}
|
||||
});
|
||||
|
||||
it("does not delete files with future expiration dates", async () => {
|
||||
const scenario = await createScenario("no-cleanup-test");
|
||||
|
||||
// Upload a file with a future expiration date
|
||||
const fileBuffer = Buffer.from("should not be cleaned");
|
||||
const futureDate = new Date(Date.now() + 24 * 60 * 60 * 1000);
|
||||
@@ -397,8 +475,6 @@ describe("File Controller Integration Tests", () => {
|
||||
});
|
||||
|
||||
it("does not delete files without expiration dates", async () => {
|
||||
const scenario = await createScenario("no-expire-test");
|
||||
|
||||
// Upload a file without expiration
|
||||
const fileBuffer = Buffer.from("permanent file");
|
||||
const savedFile = await fileStorageService.saveFile(
|
||||
|
||||
@@ -0,0 +1,219 @@
|
||||
/**
|
||||
* Integration tests for the central import (`POST /import`) and the
|
||||
* multi-document YAML scenario export it reads back.
|
||||
*/
|
||||
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import request from "supertest";
|
||||
import { DataSource } from "typeorm";
|
||||
import { parseAllDocuments } from "yaml";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { CredentialEntity } from "../src/credential/credential.entity";
|
||||
import { EnvironmentEntity } from "../src/environment/environment.entity";
|
||||
import { ScenarioService } from "../src/scenario/scenario.service";
|
||||
|
||||
describe("Central import", () => {
|
||||
let app: INestApplication;
|
||||
let dataSource: DataSource;
|
||||
let scenarioService: ScenarioService;
|
||||
|
||||
beforeAll(async () => {
|
||||
app = await buildTestApp();
|
||||
dataSource = app.get(DataSource);
|
||||
scenarioService = app.get(ScenarioService);
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
await app.close();
|
||||
});
|
||||
|
||||
const uniq = () => Math.random().toString(36).slice(2, 8);
|
||||
|
||||
function postYaml(yaml: string) {
|
||||
return request(app.getHttpServer())
|
||||
.post("/import")
|
||||
.set("Content-Type", "application/yaml")
|
||||
.send(yaml);
|
||||
}
|
||||
|
||||
it("imports every kind from a multi-document YAML in dependency order", async () => {
|
||||
const envId = crypto.randomUUID();
|
||||
const credId = crypto.randomUUID();
|
||||
const snippetAlias = `imp-${uniq()}`;
|
||||
// Scenario first in the file: it references the environment and credential
|
||||
const yaml = `---
|
||||
kind: scenario
|
||||
name: imported-${uniq()}
|
||||
version: 1
|
||||
environmentId: ${envId}
|
||||
credentials:
|
||||
- credentialId: ${credId}
|
||||
alias: main
|
||||
steps:
|
||||
- title: use snippet
|
||||
execCode: return context.runSnippet("${snippetAlias}");
|
||||
---
|
||||
kind: snippet
|
||||
alias: ${snippetAlias}
|
||||
title: Imported snippet
|
||||
version: 2
|
||||
code: return 1;
|
||||
---
|
||||
kind: credential
|
||||
id: ${credId}
|
||||
name: imported-cred
|
||||
data: '{"token":"t"}'
|
||||
---
|
||||
kind: environment
|
||||
id: ${envId}
|
||||
name: imported-env-${uniq()}
|
||||
data:
|
||||
base_url: https://example.test
|
||||
`;
|
||||
const res = await postYaml(yaml).expect(201);
|
||||
const kinds = res.body.imported.map((i: { kind: string }) => i.kind);
|
||||
expect(kinds).toEqual(["environment", "credential", "snippet", "scenario"]);
|
||||
|
||||
const scenario = res.body.imported[3];
|
||||
expect(scenario.version).toBe(1);
|
||||
const sc = await scenarioService.findOne(scenario.id);
|
||||
expect(sc.environmentId).toBe(envId);
|
||||
expect(sc.scenarioCredentials.map((c) => c.credentialId)).toEqual([credId]);
|
||||
expect(res.body.imported[2]).toMatchObject({
|
||||
name: snippetAlias,
|
||||
version: 2,
|
||||
});
|
||||
});
|
||||
|
||||
it("accepts a document holding a list of items", async () => {
|
||||
const yaml = `- kind: credential
|
||||
name: list-a-${uniq()}
|
||||
- kind: credential
|
||||
name: list-b-${uniq()}
|
||||
`;
|
||||
const res = await postYaml(yaml).expect(201);
|
||||
expect(res.body.imported).toHaveLength(2);
|
||||
});
|
||||
|
||||
it("accepts a JSON array", async () => {
|
||||
const res = await request(app.getHttpServer())
|
||||
.post("/import")
|
||||
.send([{ kind: "credential", name: `json-${uniq()}` }])
|
||||
.expect(201);
|
||||
expect(res.body.imported[0].kind).toBe("credential");
|
||||
});
|
||||
|
||||
it("imports nothing when any item is invalid", async () => {
|
||||
const envName = `not-imported-${uniq()}`;
|
||||
const yaml = `---
|
||||
kind: environment
|
||||
name: ${envName}
|
||||
data: {}
|
||||
---
|
||||
kind: snippet
|
||||
alias: no-version-${uniq()}
|
||||
code: return 1;
|
||||
---
|
||||
kind: gadget
|
||||
name: what
|
||||
`;
|
||||
const res = await postYaml(yaml).expect(400);
|
||||
const message = JSON.stringify(res.body);
|
||||
expect(message).toContain("Item 2 (snippet)");
|
||||
expect(message).toContain("version");
|
||||
expect(message).toContain("Item 3");
|
||||
const envRepo = dataSource.getRepository(EnvironmentEntity);
|
||||
expect(await envRepo.findOneBy({ name: envName })).toBeNull();
|
||||
});
|
||||
|
||||
it("rejects invalid YAML", async () => {
|
||||
const res = await postYaml("kind: scenario\n bad: [indent").expect(400);
|
||||
expect(JSON.stringify(res.body)).toContain("YAML document 1");
|
||||
});
|
||||
|
||||
it("rejects an empty body", async () => {
|
||||
await postYaml("").expect(400);
|
||||
});
|
||||
|
||||
describe("scenario export round trip", () => {
|
||||
it("exports one YAML document per entity and imports it back", async () => {
|
||||
const envRepo = dataSource.getRepository(EnvironmentEntity);
|
||||
const env = await envRepo.save(
|
||||
envRepo.create({ name: `rt-env-${uniq()}`, data: { a: "1" } }),
|
||||
);
|
||||
const credRepo = dataSource.getRepository(CredentialEntity);
|
||||
const cred = await credRepo.save(
|
||||
credRepo.create({ name: "rt-cred", data: null }),
|
||||
);
|
||||
const sc = await scenarioService.create({
|
||||
name: `rt-${uniq()}`,
|
||||
environmentId: env.id,
|
||||
});
|
||||
await scenarioService.createStep(sc.id, { execCode: "return 1;" });
|
||||
await scenarioService.addScenarioCredential(sc.id, {
|
||||
credentialId: cred.id,
|
||||
alias: "c",
|
||||
});
|
||||
|
||||
const exported = await request(app.getHttpServer())
|
||||
.get(
|
||||
`/scenarios/${sc.id}/export?includeEnvironment=true&credentialIds=${cred.id}`,
|
||||
)
|
||||
.expect(200);
|
||||
const docs = parseAllDocuments(exported.text);
|
||||
expect(docs.map((d) => d.errors)).toEqual([[], [], []]);
|
||||
expect(docs.map((d) => (d.toJS() as { kind: string }).kind)).toEqual([
|
||||
"environment",
|
||||
"credential",
|
||||
"scenario",
|
||||
]);
|
||||
|
||||
const res = await postYaml(exported.text).expect(201);
|
||||
expect(res.body.imported.map((i: { id: string }) => i.id)).toEqual([
|
||||
env.id,
|
||||
cred.id,
|
||||
sc.id,
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
describe("import_yaml MCP tool", () => {
|
||||
async function mcpCall(name: string, args: Record<string, unknown>) {
|
||||
const res = await request(app.getHttpServer())
|
||||
.post("/mcp")
|
||||
.set("Accept", "application/json, text/event-stream")
|
||||
.send({
|
||||
jsonrpc: "2.0",
|
||||
id: 1,
|
||||
method: "tools/call",
|
||||
params: { name, arguments: args },
|
||||
});
|
||||
const text = res.text.startsWith("event:")
|
||||
? res.text
|
||||
.split("\n")
|
||||
.find((l) => l.startsWith("data:"))!
|
||||
.slice(5)
|
||||
: res.text;
|
||||
return JSON.parse(text).result as {
|
||||
isError?: boolean;
|
||||
content: { text: string }[];
|
||||
};
|
||||
}
|
||||
|
||||
it("imports items from YAML text", async () => {
|
||||
const result = await mcpCall("import_yaml", {
|
||||
yaml: `kind: credential\nname: mcp-${uniq()}\n`,
|
||||
});
|
||||
expect(result.isError).toBeFalsy();
|
||||
expect(JSON.parse(result.content[0].text).imported).toHaveLength(1);
|
||||
});
|
||||
|
||||
it("returns the validation errors as an MCP error", async () => {
|
||||
const result = await mcpCall("import_yaml", {
|
||||
yaml: `kind: snippet\nalias: x\ncode: return 1;\n`,
|
||||
});
|
||||
expect(result.isError).toBe(true);
|
||||
expect(result.content[0].text).toContain("version");
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,7 +1,7 @@
|
||||
import { INestApplication } from "@nestjs/common";
|
||||
import { getRepositoryToken } from "@nestjs/typeorm";
|
||||
import request from "supertest";
|
||||
import * as http from "http";
|
||||
import * as http from "node:http";
|
||||
import { Repository } from "typeorm";
|
||||
import { buildTestApp } from "./app.harness";
|
||||
import { ScenarioEntity } from "../src/scenario/scenario.entity";
|
||||
@@ -9,6 +9,7 @@ import { ScenarioStepEntity } from "../src/scenario/scenario-step.entity";
|
||||
import { ScenarioRunEntity } from "../src/scenario/scenario-run.entity";
|
||||
import { ScenarioRunStepEntity } from "../src/scenario/scenario-run-step.entity";
|
||||
import { ScenarioSchedulerService } from "../src/scenario/scenario-scheduler.service";
|
||||
import type { AddressInfo } from "node:net";
|
||||
|
||||
/**
|
||||
* MCP controller integration tests.
|
||||
@@ -50,7 +51,7 @@ describe("McpController", () => {
|
||||
|
||||
// Start a test HTTP server for downloadFile tests
|
||||
testServer = await createTestServer();
|
||||
testServerUrl = `http://localhost:${(testServer.address() as any).port}`;
|
||||
testServerUrl = `http://127.0.0.1:${(testServer.address() as AddressInfo).port}`;
|
||||
});
|
||||
|
||||
afterAll(async () => {
|
||||
@@ -77,7 +78,9 @@ describe("McpController", () => {
|
||||
}
|
||||
});
|
||||
|
||||
server.listen(0, "localhost", () => {
|
||||
// Explicit IPv4: "localhost" may bind ::1, which is unreachable in some
|
||||
// containers (e.g. Docker without IPv6)
|
||||
server.listen(0, "127.0.0.1", () => {
|
||||
resolve(server);
|
||||
});
|
||||
});
|
||||
@@ -593,12 +596,8 @@ describe("McpController", () => {
|
||||
total: number;
|
||||
};
|
||||
|
||||
// The script's artifact plus the run's Playwright trace
|
||||
expect(list.total).toBe(2);
|
||||
expect(list.items.map((f) => f.name).sort()).toEqual([
|
||||
"artifact.bin",
|
||||
"trace.zip",
|
||||
]);
|
||||
// Traces are off by default, so the script's artifact is the only file
|
||||
expect(list.total).toBe(1);
|
||||
const artifact = list.items.find((f) => f.name === "artifact.bin")!;
|
||||
expect(artifact.mimeType).toBe("application/octet-stream");
|
||||
expect(artifact.expiresAt).not.toBeNull();
|
||||
@@ -615,6 +614,42 @@ describe("McpController", () => {
|
||||
});
|
||||
});
|
||||
|
||||
describe("delete_run_file", () => {
|
||||
it("deletes a run artifact so it is no longer listed", async () => {
|
||||
const { sc, run } = await createRunArtifactFixture("mcp-run-file-delete");
|
||||
const listFiles = async () =>
|
||||
JSON.parse(
|
||||
(
|
||||
(await mcpCall("list_run_files", { scenarioId: sc.id, runId: run.id }))
|
||||
.rpc.result as { content: { text: string }[] }
|
||||
).content[0].text,
|
||||
) as { items: Array<{ id: string; name: string }>; total: number };
|
||||
|
||||
const file = (await listFiles()).items.find((f) => f.name === "artifact.bin")!;
|
||||
const { status, rpc } = await mcpCall("delete_run_file", {
|
||||
scenarioId: sc.id,
|
||||
runId: run.id,
|
||||
fileId: file.id,
|
||||
});
|
||||
expect(status).toBe(200);
|
||||
const result = rpc.result as { isError?: boolean; content: { text: string }[] };
|
||||
expect(result.isError).toBeFalsy();
|
||||
expect(result.content[0].text).toContain(file.id);
|
||||
expect((await listFiles()).items.map((f) => f.id)).not.toContain(file.id);
|
||||
});
|
||||
|
||||
it("returns an MCP error for a file not in the run", async () => {
|
||||
const { sc, run } = await createRunArtifactFixture("mcp-run-file-delete-missing");
|
||||
const { status, rpc } = await mcpCall("delete_run_file", {
|
||||
scenarioId: sc.id,
|
||||
runId: run.id,
|
||||
fileId: "00000000-0000-0000-0000-000000000000",
|
||||
});
|
||||
expect(status).toBe(200);
|
||||
expect((rpc.result as { isError: boolean }).isError).toBe(true);
|
||||
});
|
||||
});
|
||||
|
||||
describe("get_run_file_content", () => {
|
||||
it("returns run artifact bytes as base64 for a valid file", async () => {
|
||||
const { sc, run } = await createRunArtifactFixture("mcp-run-file-content-test");
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
/**
|
||||
* The schema is managed by migrations. These tests fail when an entity
|
||||
* changes without a matching migration, and cover adopting databases that
|
||||
* were created by `synchronize` before migrations existed.
|
||||
*/
|
||||
|
||||
import { DataSource } from "typeorm";
|
||||
import { dataSourceOptions } from "../src/database/data-source";
|
||||
import { MIGRATIONS } from "../src/database/migrations";
|
||||
|
||||
async function pendingSchemaChanges(dataSource: DataSource): Promise<string[]> {
|
||||
const sql = await dataSource.driver.createSchemaBuilder().log();
|
||||
return sql.upQueries.map((q) => q.query);
|
||||
}
|
||||
|
||||
describe("Database migrations", () => {
|
||||
it("migrations produce exactly the schema the entities describe", async () => {
|
||||
const dataSource = new DataSource(dataSourceOptions(":memory:"));
|
||||
await dataSource.initialize();
|
||||
try {
|
||||
await dataSource.runMigrations();
|
||||
expect(await dataSource.showMigrations()).toBe(false);
|
||||
// If this fails, generate a migration: see "Database migrations" in docs/development.md
|
||||
expect(await pendingSchemaChanges(dataSource)).toEqual([]);
|
||||
} finally {
|
||||
await dataSource.destroy();
|
||||
}
|
||||
});
|
||||
|
||||
it("adopts a database created by synchronize", async () => {
|
||||
const dataSource = new DataSource({
|
||||
...dataSourceOptions(":memory:"),
|
||||
synchronize: true,
|
||||
});
|
||||
await dataSource.initialize();
|
||||
try {
|
||||
await dataSource.query(
|
||||
`INSERT INTO scenarios (id, name, version) VALUES ('11111111-1111-4111-8111-111111111111', 'kept', 1)`,
|
||||
);
|
||||
const applied = await dataSource.runMigrations();
|
||||
expect(applied.map((m) => m.name)).toEqual(MIGRATIONS.map((m) => m.name));
|
||||
expect(await dataSource.showMigrations()).toBe(false);
|
||||
expect(await pendingSchemaChanges(dataSource)).toEqual([]);
|
||||
const [row] = await dataSource.query(`SELECT name FROM scenarios`);
|
||||
expect(row.name).toBe("kept");
|
||||
} finally {
|
||||
await dataSource.destroy();
|
||||
}
|
||||
});
|
||||
|
||||
it("can revert the initial migration", async () => {
|
||||
const dataSource = new DataSource(dataSourceOptions(":memory:"));
|
||||
await dataSource.initialize();
|
||||
try {
|
||||
await dataSource.runMigrations();
|
||||
await dataSource.undoLastMigration();
|
||||
const tables = await dataSource.query(
|
||||
`SELECT name FROM sqlite_master WHERE type = 'table' AND name NOT IN ('migrations', 'sqlite_sequence')`,
|
||||
);
|
||||
expect(tables).toEqual([]);
|
||||
} finally {
|
||||
await dataSource.destroy();
|
||||
}
|
||||
});
|
||||
});
|
||||
@@ -111,14 +111,17 @@ describe("ScenarioSchedulerService Playwright traces", () => {
|
||||
expect(await traceArtifacts(runId)).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("stores the configured default trace mode when none is given", async () => {
|
||||
const runId = await runScenario("trace-default", "return 1;");
|
||||
it("stores the configured default trace mode (off) when none is given", async () => {
|
||||
const runId = await runScenario(
|
||||
"trace-default",
|
||||
"throw new Error('boom');",
|
||||
);
|
||||
const [row] = await dataSource.query(
|
||||
`SELECT traceMode FROM scenario_runs WHERE id = ?`,
|
||||
[runId],
|
||||
);
|
||||
expect(row.traceMode).toBe("on");
|
||||
expect(await traceArtifacts(runId)).toHaveLength(1);
|
||||
expect(row.traceMode).toBe("off");
|
||||
expect(await traceArtifacts(runId)).toHaveLength(0);
|
||||
});
|
||||
|
||||
it("falls back to the configured mode for runs without a stored trace mode", async () => {
|
||||
@@ -128,7 +131,13 @@ describe("ScenarioSchedulerService Playwright traces", () => {
|
||||
const env = await envRepo.save(
|
||||
envRepo.create({ name: "trace-null-mode-env", data: {} }),
|
||||
);
|
||||
const run = await scenarioService.createRun(sc.id, env.id);
|
||||
const run = await scenarioService.createRun(
|
||||
sc.id,
|
||||
env.id,
|
||||
false,
|
||||
TraceMode.On,
|
||||
);
|
||||
// Legacy runs have no stored mode; they must use the configured default (off)
|
||||
await dataSource.query(
|
||||
`UPDATE scenario_runs SET traceMode = NULL WHERE id = ?`,
|
||||
[run.id],
|
||||
@@ -141,7 +150,7 @@ describe("ScenarioSchedulerService Playwright traces", () => {
|
||||
while (activeRuns.has(run.id) && Date.now() < deadline) {
|
||||
await new Promise((r) => setTimeout(r, 20));
|
||||
}
|
||||
expect(await traceArtifacts(run.id)).toHaveLength(1);
|
||||
expect(await traceArtifacts(run.id)).toHaveLength(0);
|
||||
});
|
||||
|
||||
describe("HTTP", () => {
|
||||
@@ -150,7 +159,7 @@ describe("ScenarioSchedulerService Playwright traces", () => {
|
||||
"/scenarios/run-defaults",
|
||||
);
|
||||
expect(res.status).toBe(200);
|
||||
expect(res.body).toEqual({ traceMode: "on" });
|
||||
expect(res.body).toEqual({ traceMode: "off" });
|
||||
});
|
||||
|
||||
it("POST /scenarios/:id/run stores the requested trace mode", async () => {
|
||||
|
||||
@@ -550,22 +550,27 @@ describe("ScenarioController", () => {
|
||||
it("filters by status", async () => {
|
||||
const sc = await createScenario();
|
||||
await createStep(sc.id, { order: 0 });
|
||||
await createRun(sc.id);
|
||||
const run = await createRun(sc.id);
|
||||
// Put the run in a final state directly: a pending run would be picked
|
||||
// up by the scheduler (@Interval) and could change status mid-test
|
||||
await app
|
||||
.get(DataSource)
|
||||
.query(`UPDATE scenario_runs SET status = 'fail' WHERE id = ?`, [
|
||||
run.id,
|
||||
]);
|
||||
|
||||
const pendingRes = await request(app.getHttpServer())
|
||||
.get(`/scenarios/${sc.id}/runs?status=pending`)
|
||||
const failRes = await request(app.getHttpServer())
|
||||
.get(`/scenarios/${sc.id}/runs?status=fail`)
|
||||
.expect(200);
|
||||
expect(failRes.body.total).toBe(1);
|
||||
expect(failRes.body.data[0].id).toBe(run.id);
|
||||
|
||||
expect(pendingRes.body.total).toBeGreaterThanOrEqual(1);
|
||||
pendingRes.body.data.forEach((r: { status: string }) =>
|
||||
expect(r.status).toBe("pending"),
|
||||
);
|
||||
|
||||
const passRes = await request(app.getHttpServer())
|
||||
.get(`/scenarios/${sc.id}/runs?status=pass`)
|
||||
.expect(200);
|
||||
|
||||
expect(passRes.body.total).toBe(0);
|
||||
for (const status of ["pending", "pass"]) {
|
||||
const res = await request(app.getHttpServer())
|
||||
.get(`/scenarios/${sc.id}/runs?status=${status}`)
|
||||
.expect(200);
|
||||
expect(res.body.total).toBe(0);
|
||||
}
|
||||
});
|
||||
|
||||
it("returns 400 for invalid status filter", async () => {
|
||||
|
||||
Reference in new issue
Block a user