@itmetsam/samurai-framework 0.3.0 → 0.5.0

package/dist/flows/steps/set.js

@@ -0,0 +1,43 @@
+import { projectConfig } from "../../config/config.js";
+import { api } from "./api.js";
+import { checkStep, infoOf, stepNode } from "./define.js";
+import { stepHandler } from "./handler.js";
+import { setVariable } from "./set-variable.js";
+import { wait } from "./wait.js";
+/** The built-in steps, in library order */
+export const BUILTIN_STEPS = [wait, setVariable, api];
+const WHERE = " (samurai.config.ts)";
+/** The built-in steps plus a project's (its config's `steps`). Throws for a list that can't work. */
+export function stepSet(projectSteps = []) {
+    if (!Array.isArray(projectSteps))
+        throw new Error("samurai.config.ts: steps must be a list of steps.");
+    const builtin = new Set(BUILTIN_STEPS.map((s) => s.kind));
+    const seen = new Set();
+    projectSteps.forEach((entry, i) => {
+        const kind = entry && typeof entry === "object"
+            ? entry.kind
+            : undefined;
+        if (typeof kind !== "string" || kind === "")
+            throw new Error(`Step #${i + 1}${WHERE}: it has no kind; make it with defineStep.`);
+        checkStep(entry, WHERE);
+        if (builtin.has(kind))
+            throw new Error(`Step "${kind}"${WHERE}: a built-in step already uses this kind.`);
+        if (seen.has(kind))
+            throw new Error(`Step "${kind}"${WHERE}: declared twice.`);
+        seen.add(kind);
+    });
+    const steps = [...BUILTIN_STEPS, ...projectSteps];
+    return {
+        steps,
+        nodes: steps.map(stepNode),
+        handlers: Object.fromEntries(steps.map((s) => [s.kind, stepHandler(s)])),
+        catalog: steps.map(infoOf),
+    };
+}
+/** The built-in steps alone */
+export const BUILTIN_SET = stepSet();
+/** The project's steps: its config's `steps` after the built-ins. `projectDir` defaults to the working directory. */
+export async function projectSteps(options = {}) {
+    const config = await projectConfig(options);
+    return config.steps === undefined ? BUILTIN_SET : stepSet(config.steps);
+}

package/dist/flows/steps/wait.d.ts

@@ -0,0 +1,8 @@
+export declare const wait: import("./define.js").StepDefinition<import("./define.js").RunConfigOf<readonly [{
+    readonly path: "config.ms";
+    readonly type: "number";
+    readonly label: "Duration";
+    readonly unit: "ms";
+    readonly default: 1000;
+    readonly min: 0;
+}]>>;

package/dist/flows/steps/wait.js

@@ -0,0 +1,21 @@
+import { defineStep } from "./define.js";
+export const wait = defineStep({
+    kind: "wait",
+    label: "Wait",
+    icon: "timer",
+    section: "control",
+    fields: [
+        {
+            path: "config.ms",
+            type: "number",
+            label: "Duration",
+            unit: "ms",
+            default: 1000,
+            min: 0,
+        },
+    ],
+    summary: "{config.ms} ms",
+    async run({ config, sleep }) {
+        await sleep(config.ms);
+    },
+});

package/dist/runner/groups.d.ts

@@ -23,6 +23,11 @@ export interface ResolvedGroup {
         title: string;
     }[];
 }
+/**
+ * The real path of `p` (symlinks resolved), or `p` itself when it does not exist. Registered test files come
+ * from stack traces, which resolve symlinks, so paths compared with them must be real too
+ */
+export declare function realPath(p: string): string;
 /** Separators of any platform become `/` */
 export declare const toPosix: (p: string) => string;
 /** The id of a test: its spec file relative to `srcDir` with `/` separators, then `::` and its full name */

package/dist/runner/groups.js

@@ -1,8 +1,21 @@
+import { realpathSync } from "node:fs";
 import { matchesGlob, relative, resolve } from "node:path";
 /** The test folder when the config names none */
 export const DEFAULT_SRC_DIR = "./src";
 /** The spec pattern when a group names none */
 export const DEFAULT_TEST_MATCH = "**/*.spec.ts";
+/**
+ * The real path of `p` (symlinks resolved), or `p` itself when it does not exist. Registered test files come
+ * from stack traces, which resolve symlinks, so paths compared with them must be real too
+ */
+export function realPath(p) {
+    try {
+        return realpathSync(p);
+    }
+    catch {
+        return p;
+    }
+}
 /** Separators of any platform become `/` */
 export const toPosix = (p) => p.replace(/\\/g, "/");
 /** The id of a test: its spec file relative to `srcDir` with `/` separators, then `::` and its full name */

package/dist/runner/test-runner.js

@@ -14,7 +14,7 @@ import Page from "../browser/page.js";
 import { takePendingAssertions } from "../assert/expect.js";
 import { toTestError } from "./test-error.js";
 import { ConnectionClosedError } from "../transport/bidi-connection.js";
-import { DEFAULT_SRC_DIR, findGroup, resolveGroups, testId, toPosix, } from "./groups.js";
+import { DEFAULT_SRC_DIR, findGroup, realPath, resolveGroups, testId, toPosix, } from "./groups.js";
 import { judgePageLogs } from "./page-logs-report.js";
 /** Whether a test with this full name is selected by the options */
 export function isSelected(name, { grep, testNames }) {
@@ -81,8 +81,9 @@ export default class TestRunner {
     /** The config's groups, resolved against the tests the specs register */
     async resolveAll(tests) {
         const config = await loadConfig();
-        const dir = projectDir();
-        const srcDir = path.resolve(dir, config.srcDir ?? DEFAULT_SRC_DIR);
+        // Real paths: registered test files come from stack traces, which resolve symlinks
+        const dir = realPath(projectDir());
+        const srcDir = realPath(path.resolve(dir, config.srcDir ?? DEFAULT_SRC_DIR));
         const groups = resolveGroups(config, tests.map(({ file, name }) => ({
             file: toPosix(path.relative(srcDir, file)),
             name,

package/dist/types/config.d.ts

@@ -1,3 +1,4 @@
+import type { StepDefinition } from "../flows/steps/define.js";
 import type { SupportedBrowser } from "./browser.js";
 
 interface SamuraiTest {
@@ -57,6 +58,12 @@ export interface SamuraiTestConfig {
    * Define a group of test's you want to have executed with a certain configuration
    **/
   groups?: SamuraiGroup[];
+  /**
+   * Flow steps of this project, made with `defineStep`. Listed after the built-in steps;
+   * a kind a built-in or another step uses is refused.
+   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  steps?: readonly StepDefinition<any>[];
   /**
    * The base URL to use when navigating the browser.
    * When recording starts, the browser will start at this URL.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itmetsam/samurai-framework",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Browser test framework over WebDriver BiDi: auto-waiting locators, environments and secrets, a recorder, and a command line.",
   "main": "dist/api.js",
   "exports": {
@@ -36,6 +36,10 @@
       "types": "./dist/flows/run/index.d.ts",
       "default": "./dist/flows/run/index.js"
     },
+    "./flows/steps": {
+      "types": "./dist/flows/steps/index.d.ts",
+      "default": "./dist/flows/steps/index.js"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {

package/dist/flows/core/nodes/api.d.ts

@@ -1,9 +0,0 @@
-export declare const api: import("./define.js").NodeCoreDefinition<"api", import("./define.js").ConfigOf<readonly [{
-    readonly path: "title";
-    readonly type: "text";
-    readonly label: "Title";
-}, {
-    readonly path: "subtitle";
-    readonly type: "text";
-    readonly label: "Description";
-}]>>;

package/dist/flows/core/nodes/api.js

@@ -1,12 +0,0 @@
-import { defineNode } from "./define.js";
-// Declared so flows can hold it; no handler runs it yet (unsupported).
-export const api = defineNode({
-    kind: "api",
-    label: "HTTP request",
-    shape: "step",
-    fields: [
-        { path: "title", type: "text", label: "Title" },
-        { path: "subtitle", type: "text", label: "Description" },
-    ],
-    outputs: true,
-});

package/dist/flows/core/nodes/database.d.ts

@@ -1,9 +0,0 @@
-export declare const database: import("./define.js").NodeCoreDefinition<"database", import("./define.js").ConfigOf<readonly [{
-    readonly path: "title";
-    readonly type: "text";
-    readonly label: "Title";
-}, {
-    readonly path: "subtitle";
-    readonly type: "text";
-    readonly label: "Description";
-}]>>;

package/dist/flows/core/nodes/database.js

@@ -1,12 +0,0 @@
-import { defineNode } from "./define.js";
-// Declared so flows can hold it; no handler runs it yet (unsupported).
-export const database = defineNode({
-    kind: "database",
-    label: "Database query",
-    shape: "step",
-    fields: [
-        { path: "title", type: "text", label: "Title" },
-        { path: "subtitle", type: "text", label: "Description" },
-    ],
-    outputs: true,
-});

package/dist/flows/core/nodes/email.d.ts

@@ -1,9 +0,0 @@
-export declare const email: import("./define.js").NodeCoreDefinition<"email", import("./define.js").ConfigOf<readonly [{
-    readonly path: "title";
-    readonly type: "text";
-    readonly label: "Title";
-}, {
-    readonly path: "subtitle";
-    readonly type: "text";
-    readonly label: "Description";
-}]>>;

package/dist/flows/core/nodes/email.js

@@ -1,12 +0,0 @@
-import { defineNode } from "./define.js";
-// Declared so flows can hold it; no handler runs it yet (unsupported).
-export const email = defineNode({
-    kind: "email",
-    label: "Email inbox",
-    shape: "step",
-    fields: [
-        { path: "title", type: "text", label: "Title" },
-        { path: "subtitle", type: "text", label: "Description" },
-    ],
-    outputs: true,
-});

package/dist/flows/core/nodes/script.d.ts

@@ -1,9 +0,0 @@
-export declare const script: import("./define.js").NodeCoreDefinition<"script", import("./define.js").ConfigOf<readonly [{
-    readonly path: "title";
-    readonly type: "text";
-    readonly label: "Title";
-}, {
-    readonly path: "subtitle";
-    readonly type: "text";
-    readonly label: "Description";
-}]>>;

package/dist/flows/core/nodes/script.js

@@ -1,12 +0,0 @@
-import { defineNode } from "./define.js";
-// Declared so flows can hold it; no handler runs it yet (unsupported).
-export const script = defineNode({
-    kind: "script",
-    label: "Script",
-    shape: "step",
-    fields: [
-        { path: "title", type: "text", label: "Title" },
-        { path: "subtitle", type: "text", label: "Description" },
-    ],
-    outputs: true,
-});

package/dist/flows/core/nodes/set-variable.js

@@ -1,39 +0,0 @@
-import { defineNode } from "./define.js";
-export const setVariable = defineNode({
-    kind: "set-variable",
-    label: "Set variable",
-    shape: "step",
-    fields: [
-        {
-            path: "config.name",
-            type: "text",
-            label: "Name",
-            placeholder: "orderId",
-            default: "",
-        },
-        {
-            path: "config.value",
-            type: "expression",
-            label: "Value",
-            placeholder: '"order-" + run.environment',
-            default: "",
-        },
-    ],
-    validate: (node, ctx) => node.config.name === ""
-        ? [
-            {
-                level: "error",
-                nodeId: node.id,
-                message: `${ctx.label}: give the variable a name.`,
-            },
-        ]
-        : /^[a-z][a-z0-9_]*$/.test(node.config.name)
-            ? []
-            : [
-                {
-                    level: "error",
-                    nodeId: node.id,
-                    message: `${ctx.label}: use lowercase letters, digits and _ for the name.`,
-                },
-            ],
-});

package/dist/flows/core/nodes/wait.d.ts

@@ -1,15 +0,0 @@
-export declare const wait: import("./define.js").NodeCoreDefinition<"wait", import("./define.js").ConfigOf<readonly [{
-    readonly path: "title";
-    readonly type: "text";
-    readonly label: "Title";
-}, {
-    readonly path: "subtitle";
-    readonly type: "text";
-    readonly label: "Description";
-}, {
-    readonly path: "config.ms";
-    readonly type: "number";
-    readonly label: "Duration";
-    readonly unit: "ms";
-    readonly default: 1000;
-}]>>;

package/dist/flows/core/nodes/wait.js

@@ -1,18 +0,0 @@
-import { defineNode } from "./define.js";
-export const wait = defineNode({
-    kind: "wait",
-    label: "Wait",
-    shape: "step",
-    fields: [
-        { path: "title", type: "text", label: "Title" },
-        { path: "subtitle", type: "text", label: "Description" },
-        {
-            path: "config.ms",
-            type: "number",
-            label: "Duration",
-            unit: "ms",
-            default: 1000,
-        },
-    ],
-    outputs: true,
-});

package/dist/flows/run/handlers/set-variable.d.ts

@@ -1,2 +0,0 @@
-import { type Handler } from "./support.js";
-export declare const setVariable: Handler;

package/dist/flows/run/handlers/set-variable.js

@@ -1,22 +0,0 @@
-import { evaluateText, KEY_PATTERN } from "../../core/index.js";
-import { fail, problemAt } from "./support.js";
-export const setVariable = async (node, run) => {
-    const name = node.config?.name;
-    if (typeof name !== "string" || !KEY_PATTERN.test(name))
-        return {
-            status: "failed",
-            error: "Give the variable a name: lowercase letters, digits and _.",
-        };
-    const text = String(node.config?.value ?? "");
-    const problem = problemAt(node, run, text);
-    if (problem)
-        return { status: "failed", error: problem };
-    try {
-        const value = evaluateText(text, run.context);
-        run.context.vars[name] = value;
-        return { status: "passed", wrote: { [name]: value } };
-    }
-    catch (e) {
-        return fail(e);
-    }
-};

package/dist/flows/run/handlers/wait.d.ts

@@ -1,2 +0,0 @@
-import type { Handler } from "./support.js";
-export declare const wait: Handler;

package/dist/flows/run/handlers/wait.js

@@ -1,10 +0,0 @@
-export const wait = async (node, run) => {
-    const ms = typeof node.config?.ms === "number" ? node.config.ms : 1000;
-    try {
-        await run.sleep(ms, run.signal);
-    }
-    catch {
-        return "cancelled";
-    }
-    return { status: "passed" };
-};