explorbot 0.2.2 → 0.2.4

package/dist/boat/prima/src/envelope.js

@@ -0,0 +1,142 @@
+import { mkdirSync, writeFileSync } from 'node:fs';
+import path from 'node:path';
+const EXPECTATION_LABELS = {
+    passed: 'PASSED      ',
+    failed: 'FAILED      ',
+    unverified: 'not verified',
+};
+export function renderEnvelope(data) {
+    const sections = [renderResult(data), renderPage(data), renderValue(data), renderChanges(data), renderSteps(data), renderExpectations(data), renderOutcome(data), ...renderFailure(data), renderInstance(data), renderArtifacts(data)];
+    return sections.filter((section) => section).join('\n\n');
+}
+export function writeArtifacts(dir, snapshot) {
+    mkdirSync(dir, { recursive: true });
+    const paths = {
+        aria: path.resolve(dir, 'aria.yml'),
+        html: path.resolve(dir, 'page.html'),
+    };
+    writeFileSync(paths.aria, snapshot.aria ?? '', 'utf-8');
+    writeFileSync(paths.html, snapshot.html ?? '', 'utf-8');
+    if (!snapshot.requests.length)
+        return paths;
+    paths.network = path.resolve(dir, 'network.jsonl');
+    writeFileSync(paths.network, snapshot.requests.map((request) => `${JSON.stringify(request)}\n`).join(''), 'utf-8');
+    return paths;
+}
+function renderResult(data) {
+    const lines = [`ok: ${data.ok}`, `command: ${data.command}`];
+    if (data.used?.length)
+        lines.push(`used: ${data.used.join('; ')}`);
+    return section('Result', lines.join('\n'));
+}
+function renderPage(data) {
+    const { url, previousUrl, title, state, visits } = data.page;
+    const urlLabel = `url: ${url}`;
+    const stateLabel = `state: ${state}`;
+    const width = Math.max(urlLabel.length, stateLabel.length) + 3;
+    let changedMarker = '';
+    if (previousUrl && previousUrl !== url)
+        changedMarker = `(changed: ${previousUrl} → ${url})`;
+    const lines = [align(urlLabel, changedMarker, width), `title: ${title}`, align(stateLabel, `(visit #${visits})`, width)];
+    return section('Page', lines.join('\n'));
+}
+function renderValue(data) {
+    if (data.value === undefined)
+        return null;
+    return section('Value', data.value);
+}
+function renderChanges(data) {
+    if (data.changes === undefined || data.changes === null)
+        return null;
+    return section('Changes', data.changes);
+}
+function renderSteps(data) {
+    if (!data.steps?.length)
+        return null;
+    const lines = [];
+    data.steps.forEach((step, index) => {
+        lines.push(`${index + 1}. ${step.ok ? 'ok  ' : 'FAIL'} ${step.label}`);
+        for (const line of (step.proof || '').split('\n').filter(Boolean))
+            lines.push(`      ${line}`);
+    });
+    if (data.stepFiles)
+        lines.push('', `page after each step: ${data.stepFiles}`);
+    return section('Steps', lines.join('\n'));
+}
+function renderExpectations(data) {
+    if (!data.expectations?.length)
+        return null;
+    const lines = data.expectations.map((expectation, index) => `${index + 1}. ${EXPECTATION_LABELS[expectation.status]} ${expectation.text}`);
+    return section('Expected outcomes', lines.join('\n'));
+}
+function renderOutcome(data) {
+    if (data.answer)
+        return section('Answer', data.answer);
+    if (data.research)
+        return section('Research', data.research);
+    if (!data.assertions)
+        return null;
+    if (!data.assertions.length)
+        return section('Assertions', 'none ran — no assertion could express this claim, so nothing was checked against the page');
+    const lines = data.assertions.map((assertion) => {
+        const code = assertion.code
+            .split('\n')
+            .map((line) => line.trim())
+            .filter((line) => line && !line.startsWith('//'))
+            .join(' ');
+        return `${code}  => ${assertion.passed ? 'PASSED' : 'FAILED'}`;
+    });
+    const proof = data.assertions.flatMap((assertion) => assertion.proof);
+    if (proof.length)
+        lines.push('', 'playwright:', ...proof);
+    return section('Assertions', lines.join('\n'));
+}
+function renderFailure(data) {
+    if (!data.failure)
+        return [];
+    return [section('Failure', `error: ${data.failure.error}`), renderCompactAria(data.failure.compactAria)];
+}
+function renderCompactAria(compactAria) {
+    if (!compactAria)
+        return null;
+    return section('Current page (compact ARIA)', compactAria);
+}
+function renderInstance(data) {
+    const instance = data.instance;
+    const parts = [`${instance.name} (${tabsLabel(instance.tabs)})`, browserLine(instance)];
+    if (instance.others.length)
+        parts.push(`other instances: ${instance.others.map((other) => `${other.name} (${tabsLabel(other.tabs)})`).join(', ')}`);
+    if (data.status)
+        parts.push(`details: prima status ${data.status}`);
+    return section('Instance', parts.join(' | '));
+}
+function browserLine(instance) {
+    if (instance.attached)
+        return `attached to ${instance.attached}`;
+    if (instance.startedAgo)
+        return `running, started ${instance.startedAgo} ago`;
+    if (instance.tabs > 0)
+        return 'running';
+    return 'not running';
+}
+function tabsLabel(tabs) {
+    if (tabs === 1)
+        return '1 tab';
+    return `${tabs} tabs`;
+}
+export function renderArtifacts(data) {
+    if (!data.artifacts)
+        return null;
+    const lines = [`aria: ${data.artifacts.aria}`, `html: ${data.artifacts.html}`];
+    if (data.artifacts.network)
+        lines.push(`network: ${data.artifacts.network}`);
+    return section('Artifacts', lines.join('\n'));
+}
+function align(label, marker, width) {
+    if (!marker)
+        return label;
+    return `${label.padEnd(width)}${marker}`;
+}
+function section(title, body) {
+    return `### ${title}\n${body}`;
+}