@usestrider/vitest 0.0.0-stage → 0.1.1

package/INDEX.md

@@ -0,0 +1,13 @@
+# @usestrider/vitest API index
+
+Generated from `src/` by `pnpm index`; don't edit by hand. One line per declaration and member, by entry point, module and `@category`. Experimental APIs are marked. The browsable reference is generated from the same sources by `pnpm api-reference`.
+
+## `@usestrider/vitest`
+
+### VitestBrowser
+
+The Vitest adapter: a browser layer for `@effect/vitest`, with `TestRun` for the test that's running.
+
+*layers*
+
+- `const layer: <E, R>(backend: Layer.Layer<Browser.Browser, E, R>) => Layer.Layer<Browser.Browser | TestRun.TestRun, E, R>`

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jonathan Powers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,40 @@
-# Temporary Holding Version
+# @usestrider/vitest
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Run [Strider](https://usestrider.dev) tests under Vitest: each test is an Effect program, with one browser per file and
+a fresh context for each page.
+
+**Status:** pre-release.
+
+```sh
+pnpm add -D vitest @effect/vitest @effect/platform-node effect @usestrider/browser @usestrider/vitest
+```
+
+`VitestBrowser.layer` provides the backend you give it, unchanged, plus `TestRun`, the test that's running:
+
+```ts
+import { NodeServices } from "@effect/platform-node"
+import { layer } from "@effect/vitest"
+import { Browser, Expect } from "@usestrider/browser"
+import { Chromium } from "@usestrider/browser/chromium"
+import { VitestBrowser } from "@usestrider/vitest"
+import { Config, Effect, Layer } from "effect"
+
+const ChromiumLive = Chromium.layerConfig({
+  executablePath: Config.String("CHROMIUM_PATH")
+}).pipe(Layer.provide(NodeServices.layer))
+
+layer(VitestBrowser.layer(ChromiumLive), { excludeTestServices: true })("checkout", (it) => {
+  it.effect("adds a product to the cart", () =>
+    Effect.gen(function*() {
+      const page = yield* Browser.newPage()
+      yield* page.goto("https://shop.example.com")
+      yield* page.getByRole("button", { name: "Add to cart" }).click()
+      yield* page.getByText("1 item").pipe(Expect.toBeVisible)
+    }))
+})
+```
+
+[Tests with Vitest](https://usestrider.dev/docs/tools/testing) covers concurrent pages, attaching files to a test, and a
+fake browser for events. The source is at https://github.com/usestrider/strider.
+
+MIT licensed.

package/dist/VitestBrowser.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The Vitest adapter: a browser layer for `@effect/vitest`, with `TestRun` for the test that's running.
+ *
+ * `VitestBrowser.layer` passes the backend's layer through unchanged. The package's peer dependency is `vitest` 5.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ */
+import type * as Browser from "@usestrider/browser/Browser";
+import { TestRun } from "@usestrider/browser/test";
+import * as Layer from "effect/Layer";
+declare module "vitest" {
+    interface TestArtifactRegistry {
+        "@usestrider/browser": {
+            readonly type: "@usestrider/browser";
+            readonly artifact: TestRun.TestArtifact["_tag"];
+            readonly attachments: Array<{
+                readonly path: string;
+                readonly contentType: string;
+            }>;
+        };
+    }
+}
+/**
+ * Provides the backend you pass, unchanged, plus `TestRun` for the current test.
+ *
+ * **Details**
+ *
+ * The browser starts where the layer is built: given to `@effect/vitest`'s `layer`, once for the block, whose tests
+ * share it; provided to one effect, as below, once for that effect.
+ *
+ * **Example** (Providing a browser to a test)
+ *
+ * ```ts import.meta.vitest
+ * import { Browser } from "@usestrider/browser"
+ * import { Chromium } from "@usestrider/browser/chromium"
+ * import { VitestBrowser } from "@usestrider/vitest"
+ * import { Effect } from "effect"
+ *
+ * const test = Effect.scoped(Effect.gen(function*() {
+ *   const page = yield* Browser.newPage({ focus: "emulated" })
+ *   yield* page.goto("https://shop.example.com")
+ * })).pipe(
+ *   Effect.provide(
+ *     VitestBrowser.layer(Chromium.layer({ executablePath: "/usr/bin/chromium" }))
+ *   )
+ * )
+ * ```
+ *
+ * @stability unstable
+ * @category layers
+ * @since 0.1.0
+ */
+export declare const layer: <E, R>(backend: Layer.Layer<Browser.Browser, E, R>) => Layer.Layer<Browser.Browser | TestRun.TestRun, E, R>;
+//# sourceMappingURL=VitestBrowser.d.ts.map

package/dist/VitestBrowser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VitestBrowser.d.ts","sourceRoot":"","sources":["../src/VitestBrowser.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,KAAK,OAAO,MAAM,6BAA6B,CAAA;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAElD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAGrC,OAAO,QAAQ,QAAQ,CAAC;IACtB,UAAU,oBAAoB;QAC5B,qBAAqB,EAAE;YACrB,QAAQ,CAAC,IAAI,EAAE,qBAAqB,CAAA;YACpC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;YAC/C,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC;gBAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;aAAE,CAAC,CAAA;SACrF,CAAA;KACF;CACF;AA8DD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,KAAK,GAAI,CAAC,EAAE,CAAC,WACf,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,KAC1C,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAkE,CAAA"}

package/dist/VitestBrowser.js

@@ -0,0 +1,79 @@
+import { TestRun } from "@usestrider/browser/test";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import { recordArtifact, TestRunner } from "vitest";
+/** The test's path: its file, then each suite, then the test. */
+const pathOf = test => {
+  const names = [test.name];
+  for (let suite = test.suite; suite !== undefined; suite = suite.suite) {
+    if (suite.name !== "") names.unshift(suite.name);
+  }
+  return [test.file.name, ...names].join(" > ");
+};
+const env = name => globalThis.process?.env?.[name] ?? "";
+const infoOf = test => new TestRun.TestInfo({
+  project: test?.file.projectName ?? "",
+  file: test?.file.filepath ?? "",
+  id: test === undefined ? "" : pathOf(test),
+  attempt: test?.result?.retryCount ?? 0,
+  worker: env("VITEST_POOL_ID"),
+  shard: env("VITEST_SHARD")
+});
+const contentType = {
+  Trace: "application/zip",
+  Har: "application/json",
+  Screenshot: "image/png"
+};
+/** `TestRun` for Vitest: the current test, read each time, and its artifacts. */
+const testRun = {
+  get info() {
+    return infoOf(TestRunner.getCurrentTest());
+  },
+  attach: artifact => Effect.suspend(() => {
+    const test = TestRunner.getCurrentTest();
+    if (test === undefined) {
+      return Effect.logWarning(`TestRun.attach: no test is running, so ${artifact.path} wasn't attached`);
+    }
+    const type = artifact._tag === "Screenshot" && /\.jpe?g$/i.test(artifact.path) ? "image/jpeg" : contentType[artifact._tag];
+    return Effect.tryPromise(() => recordArtifact(test, {
+      type: "@usestrider/browser",
+      artifact: artifact._tag,
+      attachments: [{
+        path: artifact.path,
+        contentType: type
+      }]
+    })).pipe(Effect.asVoid, Effect.catch(error => Effect.logWarning(`TestRun.attach: Vitest didn't attach ${artifact.path}: ${error.message}`)));
+  })
+};
+/**
+ * Provides the backend you pass, unchanged, plus `TestRun` for the current test.
+ *
+ * **Details**
+ *
+ * The browser starts where the layer is built: given to `@effect/vitest`'s `layer`, once for the block, whose tests
+ * share it; provided to one effect, as below, once for that effect.
+ *
+ * **Example** (Providing a browser to a test)
+ *
+ * ```ts import.meta.vitest
+ * import { Browser } from "@usestrider/browser"
+ * import { Chromium } from "@usestrider/browser/chromium"
+ * import { VitestBrowser } from "@usestrider/vitest"
+ * import { Effect } from "effect"
+ *
+ * const test = Effect.scoped(Effect.gen(function*() {
+ *   const page = yield* Browser.newPage({ focus: "emulated" })
+ *   yield* page.goto("https://shop.example.com")
+ * })).pipe(
+ *   Effect.provide(
+ *     VitestBrowser.layer(Chromium.layer({ executablePath: "/usr/bin/chromium" }))
+ *   )
+ * )
+ * ```
+ *
+ * @stability unstable
+ * @category layers
+ * @since 0.1.0
+ */
+export const layer = backend => Layer.merge(backend, Layer.succeed(TestRun.TestRun, testRun));
+//# sourceMappingURL=VitestBrowser.js.map

package/dist/VitestBrowser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VitestBrowser.js","names":[],"sources":["../src/VitestBrowser.ts"],"sourcesContent":[null],"mappings":"AASA,SAAS,OAAO,QAAQ,0BAA0B;AAClD,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc;AACrC,SAAS,cAAc,EAAE,UAAU,QAAQ,QAAQ;AAcnD;AACA,MAAM,MAAM,GAAI,IAAgB,IAAY;EAC1C,MAAM,KAAK,GAAkB,CAAC,IAAI,CAAC,IAAI,CAAC;EACxC,KAAK,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,SAAS,EAAE,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE;IACrE,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;EAClD;EACA,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;AAC/C,CAAC;AAED,MAAM,GAAG,GAAI,IAAY,IACtB,UAA2F,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI,CAAC,IAC/G,EAAE;AAEN,MAAM,MAAM,GAAI,IAA4B,IAC1C,IAAI,OAAO,CAAC,QAAQ,CAAC;EACnB,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE;EACrC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE;EAC/B,EAAE,EAAE,IAAI,KAAK,SAAS,GAAG,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;EAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,IAAI,CAAC;EACtC,MAAM,EAAE,GAAG,CAAC,gBAAgB,CAAC;EAC7B,KAAK,EAAE,GAAG,CAAC,cAAc;CAC1B,CAAC;AAEJ,MAAM,WAAW,GAAiD;EAChE,KAAK,EAAE,iBAAiB;EACxB,GAAG,EAAE,kBAAkB;EACvB,UAAU,EAAE;CACb;AAED;AACA,MAAM,OAAO,GAAoB;EAC/B,IAAI,IAAI;IACN,OAAO,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;EAC5C,CAAC;EACD,MAAM,EAAG,QAAQ,IACf,MAAM,CAAC,OAAO,CAAC,MAAK;IAClB,MAAM,IAAI,GAAG,UAAU,CAAC,cAAc,EAAE;IACxC,IAAI,IAAI,KAAK,SAAS,EAAE;MACtB,OAAO,MAAM,CAAC,UAAU,CAAC,0CAA0C,QAAQ,CAAC,IAAI,kBAAkB,CAAC;IACrG;IACA,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,KAAK,YAAY,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAC1E,YAAY,GACZ,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;IAC9B,OAAO,MAAM,CAAC,UAAU,CAAC,MACvB,cAAc,CAAC,IAAI,EAAE;MACnB,IAAI,EAAE,qBAAqB;MAC3B,QAAQ,EAAE,QAAQ,CAAC,IAAI;MACvB,WAAW,EAAE,CAAC;QAAE,IAAI,EAAE,QAAQ,CAAC,IAAI;QAAE,WAAW,EAAE;MAAI,CAAE;KACzD,CAAC,CACH,CAAC,IAAI,CACJ,MAAM,CAAC,MAAM,EACb,MAAM,CAAC,KAAK,CAAE,KAAK,IACjB,MAAM,CAAC,UAAU,CAAC,wCAAwC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAC7F,CACF;EACH,CAAC;CACJ;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8BA,OAAO,MAAM,KAAK,GAChB,OAA2C,IACc,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC","ignoreList":[]}

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @stability unstable
+ * @since 0.1.0
+ */
+/**
+ * @stability unstable
+ * @since 0.1.0
+ */
+export * as VitestBrowser from "./VitestBrowser.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;GAGG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA"}

package/dist/index.js

@@ -0,0 +1,11 @@
+/**
+ * @stability unstable
+ * @since 0.1.0
+ */
+// @barrel: Auto-generated exports. Do not edit manually.
+/**
+ * @stability unstable
+ * @since 0.1.0
+ */
+export * as VitestBrowser from "./VitestBrowser.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;AAKA;AAEA;;;;AAIA,OAAO,KAAK,aAAa,MAAM,oBAAoB","ignoreList":[]}

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@usestrider/vitest",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "type": "module",
+  "license": "MIT",
+  "homepage": "https://usestrider.dev",
+  "description": "Vitest for @usestrider/browser: the current test as TestRun, and its artifacts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/usestrider/strider.git",
+    "directory": "packages/vitest"
+  },
+  "bugs": {
+    "url": "https://github.com/usestrider/strider/issues"
+  },
+  "keywords": [
+    "effect",
+    "typescript",
+    "browser",
+    "vitest"
+  ],
+  "sideEffects": [],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./dist/index.js",
+    "./*": "./dist/*.js",
+    "./index": null
+  },
+  "files": [
+    "src/**/*.ts",
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "INDEX.md"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "peerDependencies": {
+    "@usestrider/browser": "^0.1.1",
+    "effect": "^4.0.6",
+    "vitest": "^5.0.5"
+  },
+  "devDependencies": {
+    "@usestrider/browser": "^0.1.1",
+    "@usestrider/utils": "^0.0.0",
+    "effect": "^4.0.6",
+    "vitest": "^5.0.5"
+  },
+  "scripts": {
+    "codegen": "strider-utils barrel",
+    "build": "tsc -b tsconfig.json && pnpm babel",
+    "babel": "babel dist --plugins annotate-pure-calls --out-dir dist --source-maps",
+    "check": "tsc -b tsconfig.json"
+  }
 }

package/src/VitestBrowser.ts

@@ -0,0 +1,117 @@
+/**
+ * The Vitest adapter: a browser layer for `@effect/vitest`, with `TestRun` for the test that's running.
+ *
+ * `VitestBrowser.layer` passes the backend's layer through unchanged. The package's peer dependency is `vitest` 5.
+ *
+ * @stability unstable
+ * @since 0.1.0
+ */
+import type * as Browser from "@usestrider/browser/Browser"
+import { TestRun } from "@usestrider/browser/test"
+import * as Effect from "effect/Effect"
+import * as Layer from "effect/Layer"
+import { recordArtifact, TestRunner } from "vitest"
+
+declare module "vitest" {
+  interface TestArtifactRegistry {
+    "@usestrider/browser": {
+      readonly type: "@usestrider/browser"
+      readonly artifact: TestRun.TestArtifact["_tag"]
+      readonly attachments: Array<{ readonly path: string; readonly contentType: string }>
+    }
+  }
+}
+
+type RunnerTest = NonNullable<ReturnType<typeof TestRunner.getCurrentTest>>
+
+/** The test's path: its file, then each suite, then the test. */
+const pathOf = (test: RunnerTest): string => {
+  const names: Array<string> = [test.name]
+  for (let suite = test.suite; suite !== undefined; suite = suite.suite) {
+    if (suite.name !== "") names.unshift(suite.name)
+  }
+  return [test.file.name, ...names].join(" > ")
+}
+
+const env = (name: string): string =>
+  (globalThis as { readonly process?: { readonly env?: Record<string, string | undefined> } }).process?.env?.[name] ??
+    ""
+
+const infoOf = (test: RunnerTest | undefined): TestRun.TestInfo =>
+  new TestRun.TestInfo({
+    project: test?.file.projectName ?? "",
+    file: test?.file.filepath ?? "",
+    id: test === undefined ? "" : pathOf(test),
+    attempt: test?.result?.retryCount ?? 0,
+    worker: env("VITEST_POOL_ID"),
+    shard: env("VITEST_SHARD")
+  })
+
+const contentType: Record<TestRun.TestArtifact["_tag"], string> = {
+  Trace: "application/zip",
+  Har: "application/json",
+  Screenshot: "image/png"
+}
+
+/** `TestRun` for Vitest: the current test, read each time, and its artifacts. */
+const testRun: TestRun.TestRun = {
+  get info() {
+    return infoOf(TestRunner.getCurrentTest())
+  },
+  attach: (artifact) =>
+    Effect.suspend(() => {
+      const test = TestRunner.getCurrentTest()
+      if (test === undefined) {
+        return Effect.logWarning(`TestRun.attach: no test is running, so ${artifact.path} wasn't attached`)
+      }
+      const type = artifact._tag === "Screenshot" && /\.jpe?g$/i.test(artifact.path)
+        ? "image/jpeg"
+        : contentType[artifact._tag]
+      return Effect.tryPromise(() =>
+        recordArtifact(test, {
+          type: "@usestrider/browser",
+          artifact: artifact._tag,
+          attachments: [{ path: artifact.path, contentType: type }]
+        })
+      ).pipe(
+        Effect.asVoid,
+        Effect.catch((error) =>
+          Effect.logWarning(`TestRun.attach: Vitest didn't attach ${artifact.path}: ${error.message}`)
+        )
+      )
+    })
+}
+
+/**
+ * Provides the backend you pass, unchanged, plus `TestRun` for the current test.
+ *
+ * **Details**
+ *
+ * The browser starts where the layer is built: given to `@effect/vitest`'s `layer`, once for the block, whose tests
+ * share it; provided to one effect, as below, once for that effect.
+ *
+ * **Example** (Providing a browser to a test)
+ *
+ * ```ts import.meta.vitest
+ * import { Browser } from "@usestrider/browser"
+ * import { Chromium } from "@usestrider/browser/chromium"
+ * import { VitestBrowser } from "@usestrider/vitest"
+ * import { Effect } from "effect"
+ *
+ * const test = Effect.scoped(Effect.gen(function*() {
+ *   const page = yield* Browser.newPage({ focus: "emulated" })
+ *   yield* page.goto("https://shop.example.com")
+ * })).pipe(
+ *   Effect.provide(
+ *     VitestBrowser.layer(Chromium.layer({ executablePath: "/usr/bin/chromium" }))
+ *   )
+ * )
+ * ```
+ *
+ * @stability unstable
+ * @category layers
+ * @since 0.1.0
+ */
+export const layer = <E, R>(
+  backend: Layer.Layer<Browser.Browser, E, R>
+): Layer.Layer<Browser.Browser | TestRun.TestRun, E, R> => Layer.merge(backend, Layer.succeed(TestRun.TestRun, testRun))

package/src/index.ts

@@ -0,0 +1,12 @@
+/**
+ * @stability unstable
+ * @since 0.1.0
+ */
+
+// @barrel: Auto-generated exports. Do not edit manually.
+
+/**
+ * @stability unstable
+ * @since 0.1.0
+ */
+export * as VitestBrowser from "./VitestBrowser.ts"