Compare commits

..
4 Commits
Author SHA1 Message Date
ars9 63c2df96f1 build(docker): slim down the runtime image
- install production dependencies and chromium in a separate stage
- drop source maps, typescript sources and declarations, docs,
  typeorm's browser build, better-sqlite3's c sources and ffmpeg
- base the runtime on debian:bookworm-slim with only the node binary
- document the image layout
- bump version to 1.22.1
2026-10-01 10:52:47 +03:00
ars9 23fa302b25 feat(scenarios): export used snippets with a scenario
- list the snippets a scenario uses in the export dialog, checked by
  default, with the versions the scenario uses
- export each selected snippet once per used version (latest and
  pinned) via the new snippetIds query parameter
- resolve used snippets from the exported version's steps
- show the scenario version in the export dialog
- document the export query parameters
- bump version to 1.22.0
2026-10-01 10:45:39 +03:00
ars9 f43d902297 feat(credentials): hide credential data until revealed
- add a RevealableCodeBlock ui component that renders its code only
  after the user clicks Reveal, with a storybook story
- use it for the data section of the credential page
- bump version to 1.21.1
2026-10-01 10:36:37 +03:00
ars9 2129708819 feat(ui): color-code uuid badges and highlight them on hover
- show a circle colored by the first 6 hex digits of the uuid,
  bordered with the badge text color for contrast in both themes
- lighten the uuid badge background on hover
- let Badge accept a className
- add a storybook story with six sample uuids and a randomize button
- bump version to 1.21.0
2026-10-01 10:23:50 +03:00
24 changed files with 410 additions and 31 deletions

No files matched your search

+40
View File
@@ -2,6 +2,46 @@
All notable changes to this project will be documented in this file.
## 1.22.1 - 2026-10-01
Changes since 1.22.0:
### Changed
- The Docker image is about 20% smaller (1.09 GB → 876 MB on disk, 251 MB → 220 MB compressed). Production dependencies and Chromium are installed in a separate stage that drops files nothing loads at runtime (source maps, TypeScript sources and declarations, docs, TypeORM's browser build, better-sqlite3's C sources, Playwright's ffmpeg). The runtime image is `debian:bookworm-slim` with only the `node` binary, so it no longer contains `npm`, `npx`, `yarn` or `corepack`.
## 1.22.0 - 2026-10-01
Changes since 1.21.1:
### Added
- The Export Scenario dialog lists the snippets the scenario uses (including ones used only through other snippets), all checked by default. A selected snippet is exported once per version the scenario uses: the latest for `runSnippet("alias")`, plus each version pinned with `alias@N`. `GET /scenarios/:id/export` takes the new `snippetIds` query parameter for this.
- The Export Scenario dialog shows the scenario version next to its name and id.
## 1.21.1 - 2026-10-01
Changes since 1.21.0:
### Changed
- The credential page hides the credential data when it opens; a Reveal button shows it and Hide hides it again. The data is not rendered on the page until revealed.
### Added
- A `RevealableCodeBlock` UI component (a CodeBlock that starts hidden behind a Reveal/Hide button), with a Storybook story.
## 1.21.0 - 2026-10-01
Changes since 1.20.2:
### Added
- UUID badges show a small colored circle in front of the short id. Its color comes from the first 6 hex digits of the UUID, so the same id always gets the same color, and its border uses the badge text color to stay visible in both themes.
- UUID badges get lighter on hover to show they can be clicked.
- `Badge` accepts an optional `className`.
- A Storybook "Colors" story for UuidBadge with six sample ids and a button to randomize them.
## 1.20.2 - 2026-09-30
Changes since 1.20.1:
+35 -7
View File
@@ -28,8 +28,38 @@ COPY server/tsconfig*.json ./server/
COPY server/src ./server/src
RUN npm run -w server build
# ── Runtime dependencies ──────────────────────────────────────────────────────
FROM node:24-slim AS runtime-deps
WORKDIR /app
COPY package*.json ./
COPY server/package.json ./server/
# Production dependencies and Playwright's headless-only Chromium build,
# matching the installed Playwright version. All browser launches are
# headless, so the full desktop Chromium (GTK, Mesa/LLVM, icon themes) isn't
# needed, and neither is ffmpeg (only used for video recording).
#
# Then drop what nothing loads at runtime: source maps, TypeScript sources and
# declarations, docs, TypeORM's browser build and better-sqlite3's C sources
# (the addon is already compiled).
ENV PLAYWRIGHT_BROWSERS_PATH=/ms-playwright
RUN npm ci --omit=dev -w server \
&& npx playwright install --only-shell chromium \
&& rm -rf /ms-playwright/ffmpeg-* \
&& find node_modules -type f \( \
-name '*.map' -o -name '*.ts' -o -name '*.mts' -o -name '*.cts' \
-o -iname '*.md' -o -iname '*.markdown' \
\) -delete \
&& rm -rf node_modules/typeorm/browser \
node_modules/better-sqlite3/deps \
node_modules/better-sqlite3/src
# ── Runtime ───────────────────────────────────────────────────────────────────
FROM node:24-slim AS runtime
# Plain Debian with just the node binary: npm, yarn, corepack and the C
# headers that come with the node image aren't needed to run the app.
FROM debian:bookworm-slim AS runtime
# Runtime only: in the build stages it would make npm ci skip devDependencies
ENV NODE_ENV=production
@@ -63,18 +93,16 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
libxrandr2 \
&& rm -rf /var/lib/apt/lists/*
COPY --from=runtime-deps /usr/local/bin/node /usr/local/bin/node
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=runtime-deps /ms-playwright /ms-playwright
COPY --from=runtime-deps /app/node_modules ./node_modules
COPY --from=server-build /app/server/dist ./dist
COPY --from=client-build /app/client/dist ./client
@@ -0,0 +1,33 @@
import type { Meta, StoryObj } from '@storybook/react-vite';
import { expect, userEvent, within } from 'storybook/test';
import { RevealableCodeBlock } from '../../src/ui/RevealableCodeBlock/RevealableCodeBlock';
const meta: Meta<typeof RevealableCodeBlock> = {
title: 'UI/RevealableCodeBlock',
component: RevealableCodeBlock,
parameters: { layout: 'padded' },
tags: ['autodocs'],
};
export default meta;
type Story = StoryObj<typeof RevealableCodeBlock>;
export const Default: Story = {
args: {
language: 'json',
code: JSON.stringify({ username: 'admin', password: 's3cr3t-p4ss' }, null, 2),
},
play: async ({ canvasElement }) => {
// The code is not rendered until revealed, and hidden again on the second click
const canvas = within(canvasElement);
const toggle = canvas.getByRole('button');
await expect(canvasElement).not.toHaveTextContent('s3cr3t-p4ss');
await expect(toggle).toHaveAttribute('aria-expanded', 'false');
await userEvent.click(toggle);
await expect(canvasElement.querySelector('code')).toHaveTextContent('s3cr3t-p4ss');
await expect(toggle).toHaveAttribute('aria-expanded', 'true');
await userEvent.click(toggle);
await expect(canvasElement).not.toHaveTextContent('s3cr3t-p4ss');
},
};
@@ -1,5 +1,7 @@
import type { Meta, StoryObj } from '@storybook/react-vite';
import { useState } from 'react';
import { expect, within } from 'storybook/test';
import { Button } from '../../src/ui/Button/Button';
import { UuidBadge } from '../../src/ui/UuidBadge/UuidBadge';
const meta: Meta<typeof UuidBadge> = {
@@ -19,3 +21,43 @@ export const Default: Story = {
await expect(badge).toHaveTextContent('61d2…0b2e');
},
};
const SAMPLE_IDS = [
'61d2b1c2-7664-4dca-974f-436c2ee90b2e',
'e83f0a5d-1b9c-4f27-8d6e-2a4c9b7f1e03',
'0c7a94f1-3e52-4b8d-a1f6-9d2e5c8b4a70',
'f4b21e8c-9a07-4c63-b5d2-7e1f0a3c6d98',
'8d5e3a10-c4f7-4e29-9b81-5f6a2d0c7e14',
'2a9fc067-58d3-4a1e-86b4-c3e7f19d5b2a',
];
function Gallery() {
const [ids, setIds] = useState(SAMPLE_IDS);
return (
<div style={{ display: 'flex', flexDirection: 'column', alignItems: 'flex-start', gap: 12 }}>
<div style={{ display: 'flex', flexWrap: 'wrap', gap: 16 }}>
{ids.map((id) => (
<UuidBadge key={id} id={id} />
))}
</div>
<Button
size="sm"
variant="secondary"
onClick={() => setIds(ids.map(() => crypto.randomUUID()))}
>
Randomize
</Button>
</div>
);
}
export const Colors: Story = {
render: () => <Gallery />,
play: async ({ canvasElement }) => {
// Each sample id gets its own badge
const canvas = within(canvasElement);
for (const id of SAMPLE_IDS) {
await expect(canvas.getByTitle(id)).toBeInTheDocument();
}
},
};
+5 -1
View File
@@ -247,9 +247,10 @@ export const scenarios = {
},
exportScenario(
id: string,
options: { includeEnvironment: boolean; credentialIds: string[] } = {
options: { includeEnvironment: boolean; credentialIds: string[]; snippetIds: string[] } = {
includeEnvironment: false,
credentialIds: [],
snippetIds: [],
},
): Promise<string> {
const params = new URLSearchParams();
@@ -257,6 +258,9 @@ export const scenarios = {
for (const cid of options.credentialIds) {
params.append('credentialIds', cid);
}
for (const sid of options.snippetIds) {
params.append('snippetIds', sid);
}
return request(`/scenarios/${id}/export?${params.toString()}`);
},
exportE2eTestUrl(id: string): string {
@@ -61,3 +61,8 @@
cursor: pointer;
accent-color: var(--color-primary);
}
.versions {
color: var(--color-text-muted);
font-size: var(--font-size-xs);
}
@@ -1,7 +1,7 @@
import { useTranslation } from 'react-i18next';
import { X, Upload } from 'lucide-react';
import { Modal, Button, UuidBadge } from '../../ui';
import type { Scenario, ScenarioCredential } from '../../api';
import type { Scenario, ScenarioCredential, UsedSnippet } from '../../api';
import styles from './ExportScenarioModal.module.css';
export interface ExportScenarioModalProps {
@@ -13,6 +13,9 @@ export interface ExportScenarioModalProps {
onIncludeEnvironmentChange: (v: boolean) => void;
includedCredentialIds: Set<string>;
onCredentialToggle: (id: string, checked: boolean) => void;
usedSnippets: UsedSnippet[];
includedSnippetIds: Set<string>;
onSnippetToggle: (id: string, checked: boolean) => void;
onClose: () => void;
onExport: () => void;
isExporting: boolean;
@@ -27,12 +30,24 @@ export function ExportScenarioModal({
onIncludeEnvironmentChange,
includedCredentialIds,
onCredentialToggle,
usedSnippets,
includedSnippetIds,
onSnippetToggle,
onClose,
onExport,
isExporting,
}: ExportScenarioModalProps) {
const { t } = useTranslation();
// One row per snippet, listing every version the scenario uses (latest or pinned)
const snippetRows = new Map<string, { alias: string; versions: number[] }>();
for (const s of usedSnippets) {
const row = snippetRows.get(s.id) ?? { alias: s.alias, versions: [] };
const version = s.pinnedVersion ?? s.version;
if (!row.versions.includes(version)) row.versions.push(version);
snippetRows.set(s.id, row);
}
return (
<Modal
open={open}
@@ -64,6 +79,10 @@ export function ExportScenarioModal({
<UuidBadge id={scenario.id} />
</span>
</div>
<div className={styles.metaRow}>
<span className={styles.metaLabel}>{t('scenarios.field_version')}</span>
<span className={styles.metaValue}>v{scenario.version}</span>
</div>
</div>
{environment && (
@@ -95,6 +114,25 @@ export function ExportScenarioModal({
))}
</div>
)}
{snippetRows.size > 0 && (
<div className={styles.section}>
<h4 className={styles.sectionTitle}>{t('scenarios.export_include_snippets')}</h4>
{[...snippetRows].map(([snippetId, row]) => (
<label key={snippetId} className={styles.checkboxRow}>
<input
type="checkbox"
checked={includedSnippetIds.has(snippetId)}
onChange={(e) => onSnippetToggle(snippetId, e.target.checked)}
/>
<span>{row.alias}</span>
<span className={styles.versions}>
{row.versions.map((v) => `v${v}`).join(', ')}
</span>
</label>
))}
</div>
)}
</div>
)}
</Modal>
+6
View File
@@ -217,6 +217,7 @@
"export_modal_title": "Export Scenario",
"export_include_environment": "Include Environment",
"export_include_credentials": "Include Credentials",
"export_include_snippets": "Include Snippets",
"form_timeout": "Scenario Timeout (seconds)",
"form_timeout_placeholder": "Default: 600",
"form_timeout_hint": "Max seconds for the entire scenario run (default: 600)",
@@ -229,6 +230,11 @@
"light_mode": "Light mode",
"dark_mode": "Dark mode"
},
"revealable": {
"hidden": "Hidden so secrets aren't exposed on screen.",
"reveal": "Reveal",
"hide": "Hide"
},
"pagination": {
"prev": "Previous page",
"next": "Next page",
@@ -3,11 +3,18 @@ import { useNavigate, useParams } from 'react-router-dom';
import { useTranslation } from 'react-i18next';
import { usePageTitle } from '../../hooks/usePageTitle';
import { Upload, Pencil, Trash2, KeyRound } from 'lucide-react';
import { CodeBlock } from '../../ui';
import { stringify as yamlStringify } from 'yaml';
import { credentials } from '../../api';
import type { Credential } from '../../api';
import { Breadcrumbs, Button, Card, DescriptionList, Timestamp, UuidBadge } from '../../ui';
import {
Breadcrumbs,
Button,
Card,
DescriptionList,
RevealableCodeBlock,
Timestamp,
UuidBadge,
} from '../../ui';
import { DeleteConfirmationModal } from '../../components/modals';
import styles from '../Page.module.css';
@@ -117,7 +124,8 @@ export function CredentialDetailPage() {
<div className={styles.stepsSection}>
<h2 className={styles.sectionHeading}>{t('credentials.section_data')}</h2>
<Card>
<CodeBlock
<RevealableCodeBlock
key={credential.id}
language="json"
code={(() => {
try {
@@ -94,6 +94,7 @@ export function ScenarioDetailPage() {
const [exportModalOpen, setExportModalOpen] = useState(false);
const [includeEnvironment, setIncludeEnvironment] = useState(true);
const [includedCredentialIds, setIncludedCredentialIds] = useState<Set<string>>(new Set());
const [includedSnippetIds, setIncludedSnippetIds] = useState<Set<string>>(new Set());
const [isExporting, setIsExporting] = useState(false);
// Files state
@@ -212,8 +213,9 @@ export function ScenarioDetailPage() {
const handleOpenExportModal = () => {
if (!scenario) return;
// Initialise all credential checkboxes to checked
// Initialise all credential and snippet checkboxes to checked
setIncludedCredentialIds(new Set(scenarioCreds.map((sc) => sc.credentialId)));
setIncludedSnippetIds(new Set(usedSnippets.map((s) => s.id)));
setIncludeEnvironment(true);
setExportModalOpen(true);
};
@@ -226,6 +228,7 @@ export function ScenarioDetailPage() {
const yamlContent = await scenarios.exportScenario(scenario.id, {
includeEnvironment,
credentialIds: credIds,
snippetIds: Array.from(includedSnippetIds),
});
const blob = new Blob([yamlContent], { type: 'application/yaml' });
const url = URL.createObjectURL(blob);
@@ -899,6 +902,16 @@ export function ScenarioDetailPage() {
return next;
});
}}
usedSnippets={usedSnippets}
includedSnippetIds={includedSnippetIds}
onSnippetToggle={(snippetId, checked) => {
setIncludedSnippetIds((prev) => {
const next = new Set(prev);
if (checked) next.add(snippetId);
else next.delete(snippetId);
return next;
});
}}
onClose={() => setExportModalOpen(false)}
onExport={handleExport}
isExporting={isExporting}
+3 -2
View File
@@ -6,12 +6,13 @@ export type BadgeVariant = 'success' | 'error' | 'warning' | 'info' | 'neutral'
export interface BadgeProps {
variant?: BadgeVariant;
dot?: boolean;
className?: string;
children: React.ReactNode;
}
export function Badge({ variant = 'neutral', dot = false, children }: BadgeProps) {
export function Badge({ variant = 'neutral', dot = false, className, children }: BadgeProps) {
return (
<span className={[styles.badge, styles[variant]].join(' ')}>
<span className={[styles.badge, styles[variant], className].filter(Boolean).join(' ')}>
{dot && <span className={styles.dot} aria-hidden="true" />}
{children}
</span>
@@ -0,0 +1,17 @@
.wrapper {
display: flex;
align-items: flex-start;
gap: var(--space-3);
}
.content {
flex: 1;
min-width: 0;
}
.placeholder {
margin: 0;
color: var(--color-text-muted);
font-size: var(--font-size-sm);
line-height: 1.6;
}
@@ -0,0 +1,38 @@
import { useState } from 'react';
import { useTranslation } from 'react-i18next';
import { Eye, EyeOff } from 'lucide-react';
import { Button } from '../Button/Button';
import { CodeBlock } from '../CodeBlock/CodeBlock';
import styles from './RevealableCodeBlock.module.css';
export interface RevealableCodeBlockProps {
code: string;
language?: string;
}
/** A CodeBlock that starts hidden; the code is only rendered after the user reveals it. */
export function RevealableCodeBlock({ code, language }: RevealableCodeBlockProps) {
const { t } = useTranslation();
const [revealed, setRevealed] = useState(false);
return (
<div className={styles.wrapper}>
<div className={styles.content}>
{revealed ? (
<CodeBlock code={code} language={language} />
) : (
<p className={styles.placeholder}>{t('revealable.hidden')}</p>
)}
</div>
<Button
variant="secondary"
size="sm"
aria-expanded={revealed}
onClick={() => setRevealed((r) => !r)}
>
{revealed ? <EyeOff size={14} /> : <Eye size={14} />}
{revealed ? t('revealable.hide') : t('revealable.reveal')}
</Button>
</div>
);
}
@@ -4,6 +4,23 @@
position: relative;
}
.badge {
transition: background var(--transition);
}
.badge:hover {
background: color-mix(in srgb, var(--color-neutral-bg) 85%, white);
}
.swatch {
width: 8px;
height: 8px;
border-radius: 50%;
border: 1px solid currentColor;
box-sizing: border-box;
flex-shrink: 0;
}
.button {
all: unset;
cursor: pointer;
+10 -1
View File
@@ -7,9 +7,15 @@ export interface UuidBadgeProps {
id: string;
}
function uuidColor(id: string): string | null {
const hex = id.replace(/-/g, '').slice(0, 6);
return /^[0-9a-f]{6}$/i.test(hex) ? `#${hex}` : null;
}
export function UuidBadge({ id }: UuidBadgeProps) {
const [copied, setCopied] = useState(false);
const short = `${id.slice(0, 4)}…${id.slice(-4)}`;
const color = uuidColor(id);
const handleClick = (e: React.MouseEvent) => {
e.stopPropagation();
@@ -21,7 +27,10 @@ export function UuidBadge({ id }: UuidBadgeProps) {
return (
<span className={styles.wrapper} title={copied ? 'Copied!' : id}>
<Badge variant="neutral">
<Badge variant="neutral" className={styles.badge}>
{color && (
<span className={styles.swatch} style={{ background: color }} aria-hidden="true" />
)}
<button type="button" className={styles.button} onClick={handleClick}>
{short}
</button>
+3
View File
@@ -43,6 +43,9 @@ export type { SearchProps } from './Search/Search';
export { CodeBlock } from './CodeBlock/CodeBlock';
export type { CodeBlockProps } from './CodeBlock/CodeBlock';
export { RevealableCodeBlock } from './RevealableCodeBlock/RevealableCodeBlock';
export type { RevealableCodeBlockProps } from './RevealableCodeBlock/RevealableCodeBlock';
export { CodeEditor } from './CodeEditor/CodeEditor';
export type { CodeEditorProps } from './CodeEditor/CodeEditor';
+2
View File
@@ -204,6 +204,8 @@ The root `Dockerfile` builds a single image with the whole application: it build
The runtime image uses Playwright's headless-only Chromium build (`chromium-headless-shell`) with just the shared libraries it links against, plus DejaVu and Liberation fonts (Liberation is metric-compatible with Arial/Times, so pages lay out as they would with those fonts). All browser launches are headless, so the full desktop Chromium isn't installed. If a new Playwright version needs another library, `ldd` on the `chrome-headless-shell` binary in the image lists what's missing.
To keep the image small, production dependencies and the browser are installed in a separate `runtime-deps` stage, which drops what nothing loads at runtime (source maps, TypeScript sources and declarations, docs, TypeORM's browser build, better-sqlite3's C sources, and Playwright's ffmpeg, which is only used for video recording). The runtime stage is plain `debian:bookworm-slim` with only the `node` binary copied in, so the image has no `npm`, `npx`, `yarn` or `corepack`. If a package starts failing in the image only, check whether it reads one of the deleted file types at runtime.
```bash
docker compose build
```
+1 -1
View File
@@ -77,7 +77,7 @@ Exports hold exactly one version and always include its `version` number (the la
- Items are imported in dependency order - environments, credentials, snippets, scenarios - regardless of their order in the file, so a scenario can reference an environment or credential from the same file.
- The response lists what was imported: `{ imported: [{ kind, id, name, version? }] }`.
A scenario export (`GET /scenarios/:id/export`, optionally with its environment and credentials) is in this format, one document per entity, and can be imported back as is.
A scenario export (`GET /scenarios/:id/export`, optionally with its environment, credentials and used snippets) is in this format, one document per entity, and can be imported back as is. Query parameters: `includeEnvironment=true`, `credentialIds` and `snippetIds` (repeat the parameter or separate ids with commas) and `version`. A selected snippet is exported once per version the scenario uses: the latest for plain `runSnippet("alias")` calls, plus each version pinned with `alias@N`. Snippets used only through other snippets count as used.
```yaml
---
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "liqa",
"version": "1.20.2",
"version": "1.22.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "liqa",
"version": "1.20.2",
"version": "1.22.1",
"workspaces": [
"server",
"client"
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "liqa",
"version": "1.20.2",
"version": "1.22.1",
"private": true,
"engines": {
"node": ">=24"
@@ -13,6 +13,7 @@ import {
ValidateNested,
} from "class-validator";
import { EnvironmentData } from "../../environment/environment.entity";
import { SnippetExportDto } from "../../snippet/dto/snippet-export.dto";
export class ScenarioStepExportDto {
@ApiPropertyOptional()
@@ -154,4 +155,5 @@ export class ScenarioExportDto {
export type ExportEntity =
| EnvironmentExportInlineDto
| CredentialExportDto
| SnippetExportDto
| ScenarioExportDto;
+11 -7
View File
@@ -135,18 +135,17 @@ export class ScenarioController {
@Param("id", ParseUUIDPipe) id: string,
@Query("includeEnvironment") includeEnvironment: string,
@Query("credentialIds") credentialIds: string | string[] | undefined,
@Query("snippetIds") snippetIds: string | string[] | undefined,
@Query("version", new ParseIntPipe({ optional: true }))
version: number | undefined,
@Res({ passthrough: true }) res: Response,
) {
const credIds: string[] = credentialIds
? Array.isArray(credentialIds)
? credentialIds
: credentialIds.split(",").filter(Boolean)
: [];
const toIds = (ids: string | string[] | undefined): string[] =>
ids ? (Array.isArray(ids) ? ids : ids.split(",").filter(Boolean)) : [];
const entities = await this.scenarioService.exportScenario(id, {
includeEnvironment: includeEnvironment === "true",
credentialIds: credIds,
credentialIds: toIds(credentialIds),
snippetIds: toIds(snippetIds),
version,
});
res.setHeader("Content-Type", "application/yaml; charset=utf-8");
@@ -155,12 +154,17 @@ export class ScenarioController {
const kindLabels: Record<string, string> = {
environment: "Environment",
credential: "Credential",
snippet: "Snippet",
scenario: "Scenario",
};
return (entities as ExportEntity[])
.map((entity) => {
const label = kindLabels[entity.kind ?? ""] ?? entity.kind ?? "Entity";
const comment = `# ${label}: ${entity.name ?? entity.id ?? ""}`;
const title =
entity.kind === "snippet"
? `${entity.alias ?? entity.name} v${entity.version}`
: entity.name;
const comment = `# ${label}: ${title ?? entity.id ?? ""}`;
return `---\n${comment}\n${yamlStringify(entity)}`;
})
.join("");
+32 -4
View File
@@ -486,11 +486,18 @@ export class ScenarioService implements OnModuleInit {
*/
async getUsedSnippets(scenarioId: string): Promise<UsedSnippet[]> {
const scenario = await this.findOne(scenarioId);
const snippetMap = await this.snippetService.buildSnippetMap();
const usedRefs = resolveUsedSnippetAliases(
return this.resolveUsedSnippets(
scenario.steps.map((s) => s.execCode ?? ""),
snippetMap,
).map(parseSnippetRef);
);
}
private async resolveUsedSnippets(
execCodes: string[],
): Promise<UsedSnippet[]> {
const snippetMap = await this.snippetService.buildSnippetMap();
const usedRefs = resolveUsedSnippetAliases(execCodes, snippetMap).map(
parseSnippetRef,
);
if (usedRefs.length === 0) return [];
const snippets = await this.snippetService.findByAliases([
...new Set(usedRefs.map((r) => r.alias)),
@@ -699,6 +706,8 @@ export class ScenarioService implements OnModuleInit {
options: {
includeEnvironment: boolean;
credentialIds: string[];
/** Used snippets to include, at every version the scenario uses. */
snippetIds?: string[];
/** Version to export; defaults to the latest. */
version?: number;
},
@@ -741,6 +750,25 @@ export class ScenarioService implements OnModuleInit {
}
}
// Include selected snippets, once per used version (latest or pinned)
const snippetIds = options.snippetIds ?? [];
if (snippetIds.length > 0) {
const used = await this.resolveUsedSnippets(
content.steps.map((s) => s.execCode ?? ""),
);
const seen = new Set<string>();
for (const snippet of used) {
if (!snippetIds.includes(snippet.id)) continue;
const version = snippet.pinnedVersion ?? snippet.version;
const key = `${snippet.id}@${version}`;
if (seen.has(key)) continue;
seen.add(key);
entities.push(
await this.snippetService.exportSnippet(snippet, version),
);
}
}
// Scenario is always last
const allCreds = scenario.scenarioCredentials ?? [];
const credentialMappings = allCreds
+41
View File
@@ -277,6 +277,47 @@ describe("Versioning", () => {
expect(first[first.length - 1]).toMatchObject({ version: 1, steps: [] });
});
it("includes selected used snippets at the versions the scenario uses", async () => {
const alias = `exp-snip-${uniq()}`;
const sn = await snippetService.create({
alias,
title: "t",
code: "return 'one';",
});
await snippetService.update(sn.id, { code: "return 'two';" });
const other = await snippetService.create({
alias: `exp-other-${uniq()}`,
title: "t",
code: "return 3;",
});
const sc = await scenarioService.create({ name: `exp-sn-${uniq()}` });
await scenarioService.createStep(sc.id, {
execCode: `await context.runSnippet("${alias}"); await context.runSnippet("${alias}@1"); await context.runSnippet("${alias}"); return context.runSnippet("${other.alias}");`,
});
const withSnippet = await scenarioService.exportScenario(sc.id, {
includeEnvironment: false,
credentialIds: [],
snippetIds: [sn.id],
});
expect(withSnippet.map((e) => e.kind)).toEqual([
"snippet",
"snippet",
"scenario",
]);
expect(withSnippet.slice(0, 2)).toMatchObject([
{ id: sn.id, version: 2, code: "return 'two';" },
{ id: sn.id, version: 1, code: "return 'one';" },
]);
const without = await scenarioService.exportScenario(sc.id, {
includeEnvironment: false,
credentialIds: [],
});
expect(without.map((e) => e.kind)).toEqual(["scenario"]);
});
it("restores exact versions by id + version", async () => {
const id = crypto.randomUUID();
const base = { kind: "scenario" as const, id, name: "imported" };