@glubean/runner 0.2.2 → 0.2.4

package/dist/project-runner.js

@@ -0,0 +1,202 @@
+/**
+ * @module project-runner
+ *
+ * `ProjectRunner` — single top-level API for "run the tests of a project".
+ *
+ * Wraps the orchestration primitives (`loadProjectEnv`, `bootstrap`,
+ * `RunOrchestrator`, `TestExecutor`) into one coherent pipeline with a
+ * well-typed event stream. Consumers (CLI, MCP, VSCode extension,
+ * third-party embedders) all go through this facade rather than re-
+ * assembling the primitives themselves.
+ *
+ * **Scope boundary:**
+ * - Facade does: env load → bootstrap → per-file-batched TestExecutor
+ *   loop with session setup/teardown, metric recording
+ * - Facade does NOT: console presentation, trace-file writing, upload,
+ *   result.json formatting, CI-specific flag guards, summary judgment.
+ *   Consumers build their own summary by observing events.
+ *
+ * Batching is fixed at per-file batched (one tsx subprocess per file,
+ * all of that file's testIds batched into `TestExecutor.run(fileUrl, "",
+ * ctx, {testIds})`).
+ */
+import { resolve } from "node:path";
+import { pathToFileURL } from "node:url";
+import { bootstrap } from "./bootstrap.js";
+import { TestExecutor } from "./executor.js";
+import { discoverSessionFile, RunOrchestrator, } from "./orchestrator.js";
+import { MetricCollector } from "./thresholds.js";
+import { toSingleExecutionOptions } from "./config.js";
+// =============================================================================
+// ProjectRunner
+// =============================================================================
+export class ProjectRunner {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    /**
+     * Run the full pipeline as an async event stream.
+     *
+     * @example
+     * ```ts
+     * const runner = new ProjectRunner({...});
+     * for await (const event of runner.run()) {
+     *   switch (event.type) { ... }
+     * }
+     * ```
+     */
+    async *run() {
+        const { rootDir, sharedConfig, vars: envVars, secrets, tests, noSession = false, interactive = false, signal, } = this.options;
+        const sessionStartDir = this.options.sessionStartDir ?? rootDir;
+        const metricCollector = this.options.metricCollector ?? new MetricCollector();
+        // ── 1. Bootstrap ─────────────────────────────────────────────────
+        yield { type: "bootstrap:start", projectRoot: rootDir };
+        try {
+            await bootstrap(rootDir);
+        }
+        catch (err) {
+            const error = err instanceof Error ? err : new Error(String(err));
+            yield { type: "bootstrap:failed", error };
+            yield { type: "run:failed", reason: "bootstrap-failed", error: error.message };
+            return;
+        }
+        yield { type: "bootstrap:done" };
+        // ── 3. Group tests by file (per-file batching) ───────────────────
+        const fileGroups = new Map();
+        for (const t of tests) {
+            const group = fileGroups.get(t.filePath) || [];
+            group.push(t);
+            fileGroups.set(t.filePath, group);
+        }
+        yield { type: "discovery:done", totalFiles: fileGroups.size, totalTests: tests.length };
+        // ── 4. Build executor (shared across all files) ──────────────────
+        const executor = this.options.executor ?? TestExecutor.fromSharedConfig(sharedConfig, {
+            cwd: rootDir,
+            ...(this.options.inspectBrk !== undefined && { inspectBrk: this.options.inspectBrk }),
+        });
+        const orchestrator = new RunOrchestrator(executor);
+        const sessionState = {};
+        let sessionSetupSucceeded = false;
+        // Wrap all post-executor-construction work in try/finally so the
+        // executor's own cleanup path (zero-project scratch teardown, any
+        // future finalizers) always runs — even on early return from
+        // session-setup failure or signal abort. This also covers the case
+        // where the generator is abandoned by its caller (iterator .return()
+        // triggers the finally block).
+        try {
+            // ── 5. Session setup ───────────────────────────────────────────
+            const sessionFile = noSession ? undefined : discoverSessionFile(sessionStartDir, rootDir);
+            yield { type: "session:discovered", sessionFile };
+            if (sessionFile) {
+                yield { type: "session:setup:start", sessionFile };
+                let setupFailed = false;
+                let failureInfo;
+                for await (const event of orchestrator.runSessionSetup(sessionFile, { vars: envVars, secrets, interactive }, toSingleExecutionOptions(sharedConfig))) {
+                    if (event.type === "session:set") {
+                        sessionState[event.key] = event.value;
+                    }
+                    else if (event.type === "status" && event.status === "failed") {
+                        setupFailed = true;
+                        failureInfo = { error: event.error, stack: event.stack };
+                    }
+                    yield { type: "session:setup:event", event };
+                }
+                if (setupFailed) {
+                    yield { type: "session:setup:failed", ...(failureInfo ?? {}) };
+                    // Best-effort teardown before bailing.
+                    yield { type: "session:teardown:start", sessionFile };
+                    for await (const event of orchestrator.runSessionTeardown(sessionFile, { vars: envVars, secrets }, sessionState, toSingleExecutionOptions(sharedConfig))) {
+                        yield { type: "session:teardown:event", event };
+                    }
+                    yield { type: "session:teardown:done" };
+                    yield {
+                        type: "run:failed",
+                        reason: "session-setup-failed",
+                        ...(failureInfo?.error !== undefined && { error: failureInfo.error }),
+                    };
+                    return;
+                }
+                sessionSetupSucceeded = true;
+                yield { type: "session:setup:done", stateKeys: Object.keys(sessionState) };
+            }
+            // ── 6. File loop (per-file batched) ────────────────────────────
+            let passedCount = 0;
+            let failedCount = 0;
+            let skippedCount = 0;
+            const failureLimit = sharedConfig.failAfter ??
+                (sharedConfig.failFast ? 1 : undefined);
+            for (const [filePath, fileTests] of fileGroups) {
+                if (signal?.aborted)
+                    break;
+                if (failureLimit !== undefined && failedCount >= failureLimit)
+                    break;
+                const testFileUrl = pathToFileURL(resolve(filePath)).href;
+                const testIds = fileTests.map((t) => t.meta.id);
+                const exportNames = {};
+                for (const t of fileTests)
+                    exportNames[t.meta.id] = t.exportName;
+                yield { type: "file:start", filePath, testCount: fileTests.length };
+                const fileStart = Date.now();
+                for await (const event of executor.run(testFileUrl, "", {
+                    vars: envVars,
+                    secrets,
+                    ...(Object.keys(sessionState).length > 0 && { session: sessionState }),
+                }, {
+                    ...toSingleExecutionOptions(sharedConfig),
+                    testIds,
+                    exportNames,
+                    ...(fileTests.some((t) => t.meta.parallel) && sharedConfig.concurrency > 1
+                        ? { concurrency: sharedConfig.concurrency }
+                        : {}),
+                })) {
+                    if (event.type === "session:set") {
+                        sessionState[event.key] = event.value;
+                    }
+                    if (event.type === "metric") {
+                        metricCollector.add(event.name, event.value);
+                    }
+                    if (event.type === "status") {
+                        if (event.status === "completed")
+                            passedCount += 1;
+                        else if (event.status === "skipped")
+                            skippedCount += 1;
+                        else
+                            failedCount += 1;
+                    }
+                    yield { type: "file:event", filePath, event };
+                }
+                yield { type: "file:complete", filePath, duration: Date.now() - fileStart };
+            }
+            // ── 7. Session teardown ────────────────────────────────────────
+            if (sessionFile && sessionSetupSucceeded) {
+                yield { type: "session:teardown:start", sessionFile };
+                for await (const event of orchestrator.runSessionTeardown(sessionFile, { vars: envVars, secrets }, sessionState, toSingleExecutionOptions(sharedConfig))) {
+                    yield { type: "session:teardown:event", event };
+                }
+                yield { type: "session:teardown:done" };
+            }
+            // ── 8. Done ────────────────────────────────────────────────────
+            yield { type: "run:complete", passedCount, failedCount, skippedCount };
+        }
+        finally {
+            // Drain executor.finalize() — zero-project scratch cleanup and any
+            // future executor-level finalizers. Safe to call even after session
+            // teardown already ran (executor.finalize() guards on _sessionSetupDone,
+            // which stays false when sessions are driven by RunOrchestrator rather
+            // than executor auto-session). Discard yielded events; this is pure
+            // cleanup, not part of the user-visible run.
+            try {
+                for await (const _ of executor.finalize()) {
+                    // intentionally drain
+                }
+            }
+            catch {
+                // Finalize errors are non-fatal — surface silently to avoid masking
+                // the primary run outcome. Could be upgraded to a warning event
+                // later if needed.
+            }
+        }
+    }
+}
+//# sourceMappingURL=project-runner.js.map

package/dist/project-runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-runner.js","sourceRoot":"","sources":["../src/project-runner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EACL,mBAAmB,EACnB,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AA8GvD,gFAAgF;AAChF,gBAAgB;AAChB,gFAAgF;AAEhF,MAAM,OAAO,aAAa;IACP,OAAO,CAAuB;IAE/C,YAAY,OAA6B;QACvC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,CAAC,GAAG;QACR,MAAM,EACJ,OAAO,EACP,YAAY,EACZ,IAAI,EAAE,OAAO,EACb,OAAO,EACP,KAAK,EACL,SAAS,GAAG,KAAK,EACjB,WAAW,GAAG,KAAK,EACnB,MAAM,GACP,GAAG,IAAI,CAAC,OAAO,CAAC;QAEjB,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC;QAChE,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,IAAI,eAAe,EAAE,CAAC;QAE9E,oEAAoE;QACpE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;QACxD,IAAI,CAAC;YACH,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAClE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,CAAC;YAC1C,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,kBAAkB,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YAC/E,OAAO;QACT,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC;QAEjC,oEAAoE;QACpE,MAAM,UAAU,GAAG,IAAI,GAAG,EAA+B,CAAC;QAC1D,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC/C,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACd,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;QAExF,oEAAoE;QACpE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAC,gBAAgB,CACrE,YAAY,EACZ;YACE,GAAG,EAAE,OAAO;YACZ,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;SACtF,CACF,CAAC;QACF,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAC;QACnD,MAAM,YAAY,GAA4B,EAAE,CAAC;QACjD,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAElC,iEAAiE;QACjE,kEAAkE;QAClE,6DAA6D;QAC7D,mEAAmE;QACnE,qEAAqE;QACrE,+BAA+B;QAC/B,IAAI,CAAC;YACH,kEAAkE;YAClE,MAAM,WAAW,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YAC1F,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,WAAW,EAAE,CAAC;YAElD,IAAI,WAAW,EAAE,CAAC;gBAChB,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,WAAW,EAAE,CAAC;gBACnD,IAAI,WAAW,GAAG,KAAK,CAAC;gBACxB,IAAI,WAA2D,CAAC;gBAEhE,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,YAAY,CAAC,eAAe,CACpD,WAAW,EACX,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,EACvC,wBAAwB,CAAC,YAAY,CAAC,CACvC,EAAE,CAAC;oBACF,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;wBACjC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC;oBACxC,CAAC;yBAAM,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;wBAChE,WAAW,GAAG,IAAI,CAAC;wBACnB,WAAW,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;oBAC3D,CAAC;oBACD,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,CAAC;gBAC/C,CAAC;gBAED,IAAI,WAAW,EAAE,CAAC;oBAChB,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,EAAE,CAAC;oBAE/D,uCAAuC;oBACvC,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,WAAW,EAAE,CAAC;oBACtD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,YAAY,CAAC,kBAAkB,CACvD,WAAW,EACX,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAC1B,YAAY,EACZ,wBAAwB,CAAC,YAAY,CAAC,CACvC,EAAE,CAAC;wBACF,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,CAAC;oBAClD,CAAC;oBACD,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;oBAExC,MAAM;wBACJ,IAAI,EAAE,YAAY;wBAClB,MAAM,EAAE,sBAAsB;wBAC9B,GAAG,CAAC,WAAW,EAAE,KAAK,KAAK,SAAS,IAAI,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC;qBACtE,CAAC;oBACF,OAAO;gBACT,CAAC;gBAED,qBAAqB,GAAG,IAAI,CAAC;gBAC7B,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YAC7E,CAAC;YAED,kEAAkE;YAClE,IAAI,WAAW,GAAG,CAAC,CAAC;YACpB,IAAI,WAAW,GAAG,CAAC,CAAC;YACpB,IAAI,YAAY,GAAG,CAAC,CAAC;YACrB,MAAM,YAAY,GAAG,YAAY,CAAC,SAAS;gBACzC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAE1C,KAAK,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,UAAU,EAAE,CAAC;gBAC/C,IAAI,MAAM,EAAE,OAAO;oBAAE,MAAM;gBAC3B,IAAI,YAAY,KAAK,SAAS,IAAI,WAAW,IAAI,YAAY;oBAAE,MAAM;gBAErE,MAAM,WAAW,GAAG,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1D,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAChD,MAAM,WAAW,GAA2B,EAAE,CAAC;gBAC/C,KAAK,MAAM,CAAC,IAAI,SAAS;oBAAE,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC;gBAEjE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;gBACpE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAE7B,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,QAAQ,CAAC,GAAG,CACpC,WAAW,EACX,EAAE,EACF;oBACE,IAAI,EAAE,OAAO;oBACb,OAAO;oBACP,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC;iBACvE,EACD;oBACE,GAAG,wBAAwB,CAAC,YAAY,CAAC;oBACzC,OAAO;oBACP,WAAW;oBACX,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,YAAY,CAAC,WAAW,GAAG,CAAC;wBACxE,CAAC,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,WAAW,EAAE;wBAC3C,CAAC,CAAC,EAAE,CAAC;iBACR,CACF,EAAE,CAAC;oBACF,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;wBACjC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC;oBACxC,CAAC;oBACD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC5B,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;oBAC/C,CAAC;oBACD,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;wBAC5B,IAAI,KAAK,CAAC,MAAM,KAAK,WAAW;4BAAE,WAAW,IAAI,CAAC,CAAC;6BAC9C,IAAI,KAAK,CAAC,MAAM,KAAK,SAAS;4BAAE,YAAY,IAAI,CAAC,CAAC;;4BAClD,WAAW,IAAI,CAAC,CAAC;oBACxB,CAAC;oBACD,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;gBAChD,CAAC;gBAED,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;YAC9E,CAAC;YAED,kEAAkE;YAClE,IAAI,WAAW,IAAI,qBAAqB,EAAE,CAAC;gBACzC,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,WAAW,EAAE,CAAC;gBACtD,IAAI,KAAK,EAAE,MAAM,KAAK,IAAI,YAAY,CAAC,kBAAkB,CACvD,WAAW,EACX,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,EAC1B,YAAY,EACZ,wBAAwB,CAAC,YAAY,CAAC,CACvC,EAAE,CAAC;oBACF,MAAM,EAAE,IAAI,EAAE,wBAAwB,EAAE,KAAK,EAAE,CAAC;gBAClD,CAAC;gBACD,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC;YAC1C,CAAC;YAED,kEAAkE;YAClE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;QACzE,CAAC;gBAAS,CAAC;YACT,mEAAmE;YACnE,oEAAoE;YACpE,yEAAyE;YACzE,uEAAuE;YACvE,oEAAoE;YACpE,6CAA6C;YAC7C,IAAI,CAAC;gBACH,IAAI,KAAK,EAAE,MAAM,CAAC,IAAI,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC;oBAC1C,sBAAsB;gBACxB,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,oEAAoE;gBACpE,gEAAgE;gBAChE,mBAAmB;YACrB,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glubean/runner",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "type": "module",
   "exports": {
     ".": {
@@ -16,10 +16,11 @@
     "access": "public"
   },
   "dependencies": {
+    "dotenv": "^16.4.0",
     "ky": "^1.14.0",
     "p-queue": "^9.1.0",
     "tsx": "^4.19.0",
-    "@glubean/sdk": "0.2.0"
+    "@glubean/sdk": "0.2.2"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",