@dxos/test-utils 0.8.3 → 0.8.4-main.f9ba587

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/test-utils",
-  "version": "0.8.3",
+  "version": "0.8.4-main.f9ba587",
   "description": "Test utilities",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -11,18 +11,12 @@
     ".": {
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
-      "node": {
-        "require": "./dist/lib/node/index.cjs",
-        "default": "./dist/lib/node-esm/index.mjs"
-      }
+      "node": "./dist/lib/node-esm/index.mjs"
     },
     "./playwright": {
       "types": "./dist/types/src/playwright.d.ts",
       "browser": "./dist/lib/browser/playwright.mjs",
-      "node": {
-        "require": "./dist/lib/node/playwright.cjs",
-        "default": "./dist/lib/node-esm/playwright.mjs"
-      }
+      "node": "./dist/lib/node-esm/playwright.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
@@ -38,14 +32,13 @@
     "src"
   ],
   "dependencies": {
-    "@nx/devkit": "19.7.2",
     "@playwright/test": "^1.46.0",
     "pkg-up": "^3.1.0",
-    "@dxos/async": "0.8.3",
-    "@dxos/node-std": "0.8.3"
+    "@dxos/async": "0.8.4-main.f9ba587",
+    "@dxos/node-std": "0.8.4-main.f9ba587"
   },
   "peerDependencies": {
-    "vitest": "^3.0.8"
+    "vitest": "^3.2.4"
   },
   "publishConfig": {
     "access": "public"

package/src/playwright.ts

@@ -4,21 +4,75 @@
 
 /* eslint-disable no-console */
 
-import { workspaceRoot } from '@nx/devkit';
 import { type Browser, type BrowserContext, type PlaywrightTestConfig, type Page } from '@playwright/test';
-import { join, relative } from 'node:path';
+import { existsSync, readFileSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
 import pkgUp from 'pkg-up';
 
 import { Lock } from './lock';
 
-export const e2ePreset = (cwd: string): PlaywrightTestConfig => {
-  const packageJson = pkgUp.sync({ cwd });
+const findWorkspaceRoot = (startDir: string): string => {
+  let dir = resolve(startDir);
+  while (dir !== '/') {
+    try {
+      // Check for pnpm-workspace.yaml first (modern pnpm approach)
+      const workspaceYamlPath = join(dir, 'pnpm-workspace.yaml');
+      if (existsSync(workspaceYamlPath)) {
+        return dir;
+      }
+
+      // Check for package.json with workspaces field (legacy approach)
+      const pkgPath = join(dir, 'package.json');
+      const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+      if (pkg.workspaces) {
+        return dir;
+      }
+    } catch {}
+    const parent = dirname(dir);
+    if (parent === dir) {
+      break;
+    }
+    dir = parent;
+  }
+
+  throw new Error('Could not find pnpm workspace root');
+};
+
+export const e2ePreset = (testDir: string): PlaywrightTestConfig => {
+  const packageJson = pkgUp.sync({ cwd: testDir });
   const packageDir = packageJson!.split('/').slice(0, -1).join('/');
-  const packageDirRelative = relative(workspaceRoot, packageDir);
-  const testResultsDir = join(workspaceRoot, 'test-results', packageDirRelative, 'results.xml');
+  const packageDirName = packageDir.split('/').pop();
+  if (!packageDirName) {
+    throw new Error('packageDirName not found');
+  }
+
+  const workspaceRoot = findWorkspaceRoot(packageDir);
+  const testResultOuputDir = join(workspaceRoot, 'test-results/playwright/output', packageDirName);
+  const reporterOutputFile = join(workspaceRoot, 'test-results/playwright/report', `${packageDirName}.json`);
 
   return {
-    reporter: process.env.CI ? [['list'], ['junit', { outputFile: testResultsDir }]] : [['list']],
+    testDir,
+    outputDir: testResultOuputDir,
+    // Run tests in files in parallel.
+    fullyParallel: true,
+    // Fail the build on CI if you accidentally left test.only in the source code.
+    forbidOnly: !!process.env.CI,
+    // Retry on CI only.
+    retries: process.env.CI ? 2 : 0,
+    // Opt out of parallel tests on CI.
+    workers: process.env.CI ? 1 : undefined,
+    // Reporter to use. See https://playwright.dev/docs/test-reporters.
+    reporter: process.env.CI
+      ? [
+          ['list'],
+          [
+            'json',
+            {
+              outputFile: reporterOutputFile,
+            },
+          ],
+        ]
+      : [['list']],
     use: {
       trace: 'retain-on-failure',
     },
@@ -77,4 +131,5 @@ export const setupPage = async (browser: Browser | BrowserContext, options: Setu
   return { context, page };
 };
 
-export const storybookUrl = (storyId: string) => `http://localhost:9009/iframe.html?id=${storyId}&viewMode=story`;
+export const storybookUrl = (storyId: string, port = 9009) =>
+  `http://localhost:${port}/iframe.html?id=${storyId}&viewMode=story`;

package/dist/lib/node/index.cjs

@@ -1,35 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var node_exports = {};
-__export(node_exports, {
-  openAndClose: () => openAndClose
-});
-module.exports = __toCommonJS(node_exports);
-var import_vitest = require("vitest");
-var openAndClose = async (...resources) => {
-  for (const resourceLike of resources) {
-    await resourceLike.open();
-    (0, import_vitest.onTestFinished)(() => resourceLike.close());
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  openAndClose
-});
-//# sourceMappingURL=index.cjs.map

package/dist/lib/node/index.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/resource.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { onTestFinished } from 'vitest';\n\ninterface ResourceLike {\n  open(): Promise<any>;\n  close(): Promise<any>;\n}\n\n// TODO(burdon): Replace with abstraction relating to Context object?\nexport const openAndClose = async (...resources: ResourceLike[]) => {\n  for (const resourceLike of resources) {\n    await resourceLike.open();\n    onTestFinished(() => resourceLike.close());\n  }\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;AAIA,oBAA+B;AAQxB,IAAMA,eAAe,UAAUC,cAAAA;AACpC,aAAWC,gBAAgBD,WAAW;AACpC,UAAMC,aAAaC,KAAI;AACvBC,sCAAe,MAAMF,aAAaG,MAAK,CAAA;EACzC;AACF;",
-  "names": ["openAndClose", "resources", "resourceLike", "open", "onTestFinished", "close"]
-}

package/dist/lib/node/meta.json

@@ -1 +0,0 @@
-{"inputs":{"packages/common/test-utils/src/resource.ts":{"bytes":1545,"imports":[{"path":"vitest","kind":"import-statement","external":true}],"format":"esm"},"packages/common/test-utils/src/index.ts":{"bytes":466,"imports":[{"path":"packages/common/test-utils/src/resource.ts","kind":"import-statement","original":"./resource"}],"format":"esm"},"packages/common/test-utils/src/lock.ts":{"bytes":2031,"imports":[{"path":"@dxos/async","kind":"import-statement","external":true}],"format":"esm"},"packages/common/test-utils/src/playwright.ts":{"bytes":8379,"imports":[{"path":"@nx/devkit","kind":"import-statement","external":true},{"path":"node:path","kind":"import-statement","external":true},{"path":"pkg-up","kind":"import-statement","external":true},{"path":"packages/common/test-utils/src/lock.ts","kind":"import-statement","original":"./lock"}],"format":"esm"}},"outputs":{"packages/common/test-utils/dist/lib/node/index.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":798},"packages/common/test-utils/dist/lib/node/index.cjs":{"imports":[{"path":"vitest","kind":"import-statement","external":true}],"exports":["openAndClose"],"entryPoint":"packages/common/test-utils/src/index.ts","inputs":{"packages/common/test-utils/src/resource.ts":{"bytesInOutput":214},"packages/common/test-utils/src/index.ts":{"bytesInOutput":0}},"bytes":322},"packages/common/test-utils/dist/lib/node/playwright.cjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":5324},"packages/common/test-utils/dist/lib/node/playwright.cjs":{"imports":[{"path":"@nx/devkit","kind":"import-statement","external":true},{"path":"node:path","kind":"import-statement","external":true},{"path":"pkg-up","kind":"import-statement","external":true},{"path":"@dxos/async","kind":"import-statement","external":true}],"exports":["e2ePreset","setupPage","storybookUrl"],"entryPoint":"packages/common/test-utils/src/playwright.ts","inputs":{"packages/common/test-utils/src/playwright.ts":{"bytesInOutput":1828},"packages/common/test-utils/src/lock.ts":{"bytesInOutput":416}},"bytes":2477}}}

package/dist/lib/node/playwright.cjs

@@ -1,130 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var playwright_exports = {};
-__export(playwright_exports, {
-  e2ePreset: () => e2ePreset,
-  setupPage: () => setupPage,
-  storybookUrl: () => storybookUrl
-});
-module.exports = __toCommonJS(playwright_exports);
-var import_devkit = require("@nx/devkit");
-var import_node_path = require("node:path");
-var import_pkg_up = __toESM(require("pkg-up"));
-var import_async = require("@dxos/async");
-var Lock = class {
-  constructor() {
-    this._lastPromise = Promise.resolve();
-  }
-  async executeSynchronized(fun) {
-    const prevPromise = this._lastPromise;
-    const [getPromise, resolve] = (0, import_async.trigger)();
-    this._lastPromise = getPromise();
-    await prevPromise;
-    try {
-      const value = await fun();
-      return value;
-    } finally {
-      resolve();
-    }
-  }
-};
-var e2ePreset = (cwd) => {
-  const packageJson = import_pkg_up.default.sync({
-    cwd
-  });
-  const packageDir = packageJson.split("/").slice(0, -1).join("/");
-  const packageDirRelative = (0, import_node_path.relative)(import_devkit.workspaceRoot, packageDir);
-  const testResultsDir = (0, import_node_path.join)(import_devkit.workspaceRoot, "test-results", packageDirRelative, "results.xml");
-  return {
-    reporter: process.env.CI ? [
-      [
-        "list"
-      ],
-      [
-        "junit",
-        {
-          outputFile: testResultsDir
-        }
-      ]
-    ] : [
-      [
-        "list"
-      ]
-    ],
-    use: {
-      trace: "retain-on-failure"
-    }
-  };
-};
-var setupPage = async (browser, options = {}) => {
-  const { url, bridgeLogs, viewportSize } = options;
-  const context = "newContext" in browser ? await browser.newContext() : browser;
-  const page = await context.newPage();
-  if (viewportSize) {
-    await page.setViewportSize(viewportSize);
-  }
-  if (bridgeLogs) {
-    const lock = new Lock();
-    page.on("pageerror", async (error) => {
-      await lock.executeSynchronized(async () => {
-        console.log(error);
-      });
-    });
-    page.on("console", async (msg) => {
-      try {
-        const argsPromise = Promise.all(msg.args().map((x) => x.jsonValue()));
-        await lock.executeSynchronized(async () => {
-          const args = await argsPromise;
-          if (args.length > 0) {
-            console.log(...args);
-          } else {
-            console.log(msg);
-          }
-        });
-      } catch (err) {
-        console.error("Failed to parse message", err);
-      }
-    });
-  }
-  if (url) {
-    await page.goto(url);
-  }
-  return {
-    context,
-    page
-  };
-};
-var storybookUrl = (storyId) => `http://localhost:9009/iframe.html?id=${storyId}&viewMode=story`;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  e2ePreset,
-  setupPage,
-  storybookUrl
-});
-//# sourceMappingURL=playwright.cjs.map

package/dist/lib/node/playwright.cjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/playwright.ts", "../../../src/lock.ts"],
-  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\n/* eslint-disable no-console */\n\nimport { workspaceRoot } from '@nx/devkit';\nimport { type Browser, type BrowserContext, type PlaywrightTestConfig, type Page } from '@playwright/test';\nimport { join, relative } from 'node:path';\nimport pkgUp from 'pkg-up';\n\nimport { Lock } from './lock';\n\nexport const e2ePreset = (cwd: string): PlaywrightTestConfig => {\n  const packageJson = pkgUp.sync({ cwd });\n  const packageDir = packageJson!.split('/').slice(0, -1).join('/');\n  const packageDirRelative = relative(workspaceRoot, packageDir);\n  const testResultsDir = join(workspaceRoot, 'test-results', packageDirRelative, 'results.xml');\n\n  return {\n    reporter: process.env.CI ? [['list'], ['junit', { outputFile: testResultsDir }]] : [['list']],\n    use: {\n      trace: 'retain-on-failure',\n    },\n  };\n};\n\nexport type SetupOptions = {\n  url?: string;\n  bridgeLogs?: boolean;\n  viewportSize?: Parameters<Page['setViewportSize']>[0];\n};\n\nexport const setupPage = async (browser: Browser | BrowserContext, options: SetupOptions = {}) => {\n  const { url, bridgeLogs, viewportSize } = options;\n\n  const context = 'newContext' in browser ? await browser.newContext() : browser;\n  const page = await context.newPage();\n\n  if (viewportSize) {\n    await page.setViewportSize(viewportSize);\n  }\n\n  // TODO(wittjosiah): Remove?\n  if (bridgeLogs) {\n    const lock = new Lock();\n\n    page.on('pageerror', async (error) => {\n      await lock.executeSynchronized(async () => {\n        // eslint-disable-next-line no-console\n        console.log(error);\n      });\n    });\n\n    page.on('console', async (msg) => {\n      try {\n        const argsPromise = Promise.all(msg.args().map((x) => x.jsonValue()));\n        await lock.executeSynchronized(async () => {\n          const args = await argsPromise;\n\n          if (args.length > 0) {\n            console.log(...args);\n          } else {\n            console.log(msg);\n          }\n        });\n      } catch (err) {\n        console.error('Failed to parse message', err);\n      }\n    });\n  }\n\n  if (url) {\n    await page.goto(url);\n  }\n\n  return { context, page };\n};\n\nexport const storybookUrl = (storyId: string) => `http://localhost:9009/iframe.html?id=${storyId}&viewMode=story`;\n", "//\n// Copyright 2022 DXOS.org\n//\n\nimport { trigger } from '@dxos/async';\n\n// Copied from @dxos/async.\nexport class Lock {\n  private _lastPromise = Promise.resolve();\n\n  async executeSynchronized<T>(fun: () => Promise<T>): Promise<T> {\n    const prevPromise = this._lastPromise;\n    const [getPromise, resolve] = trigger();\n    this._lastPromise = getPromise();\n\n    await prevPromise;\n    try {\n      const value = await fun();\n      return value;\n    } finally {\n      resolve();\n    }\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMA,oBAA8B;AAE9B,uBAA+B;AAC/B,oBAAkB;ACLlB,mBAAwB;AAGjB,IAAMA,OAAN,MAAMA;EAAN,cAAA;AACGC,SAAAA,eAAeC,QAAQC,QAAO;;EAEtC,MAAMC,oBAAuBC,KAAmC;AAC9D,UAAMC,cAAc,KAAKL;AACzB,UAAM,CAACM,YAAYJ,OAAAA,QAAWK,sBAAAA;AAC9B,SAAKP,eAAeM,WAAAA;AAEpB,UAAMD;AACN,QAAI;AACF,YAAMG,QAAQ,MAAMJ,IAAAA;AACpB,aAAOI;IACT,UAAA;AACEN,cAAAA;IACF;EACF;AACF;ADVO,IAAMO,YAAY,CAACC,QAAAA;AACxB,QAAMC,cAAcC,cAAAA,QAAMC,KAAK;IAAEH;EAAI,CAAA;AACrC,QAAMI,aAAaH,YAAaI,MAAM,GAAA,EAAKC,MAAM,GAAG,EAAC,EAAGC,KAAK,GAAA;AAC7D,QAAMC,yBAAqBC,2BAASC,6BAAeN,UAAAA;AACnD,QAAMO,qBAAiBJ,uBAAKG,6BAAe,gBAAgBF,oBAAoB,aAAA;AAE/E,SAAO;IACLI,UAAUC,QAAQC,IAAIC,KAAK;MAAC;QAAC;;MAAS;QAAC;QAAS;UAAEC,YAAYL;QAAe;;QAAM;MAAC;QAAC;;;IACrFM,KAAK;MACHC,OAAO;IACT;EACF;AACF;AAQO,IAAMC,YAAY,OAAOC,SAAmCC,UAAwB,CAAC,MAAC;AAC3F,QAAM,EAAEC,KAAKC,YAAYC,aAAY,IAAKH;AAE1C,QAAMI,UAAU,gBAAgBL,UAAU,MAAMA,QAAQM,WAAU,IAAKN;AACvE,QAAMO,OAAO,MAAMF,QAAQG,QAAO;AAElC,MAAIJ,cAAc;AAChB,UAAMG,KAAKE,gBAAgBL,YAAAA;EAC7B;AAGA,MAAID,YAAY;AACd,UAAMO,OAAO,IAAIzC,KAAAA;AAEjBsC,SAAKI,GAAG,aAAa,OAAOC,UAAAA;AAC1B,YAAMF,KAAKrC,oBAAoB,YAAA;AAE7BwC,gBAAQC,IAAIF,KAAAA;MACd,CAAA;IACF,CAAA;AAEAL,SAAKI,GAAG,WAAW,OAAOI,QAAAA;AACxB,UAAI;AACF,cAAMC,cAAc7C,QAAQ8C,IAAIF,IAAIG,KAAI,EAAGC,IAAI,CAACC,MAAMA,EAAEC,UAAS,CAAA,CAAA;AACjE,cAAMX,KAAKrC,oBAAoB,YAAA;AAC7B,gBAAM6C,OAAO,MAAMF;AAEnB,cAAIE,KAAKI,SAAS,GAAG;AACnBT,oBAAQC,IAAG,GAAII,IAAAA;UACjB,OAAO;AACLL,oBAAQC,IAAIC,GAAAA;UACd;QACF,CAAA;MACF,SAASQ,KAAK;AACZV,gBAAQD,MAAM,2BAA2BW,GAAAA;MAC3C;IACF,CAAA;EACF;AAEA,MAAIrB,KAAK;AACP,UAAMK,KAAKiB,KAAKtB,GAAAA;EAClB;AAEA,SAAO;IAAEG;IAASE;EAAK;AACzB;AAEO,IAAMkB,eAAe,CAACC,YAAoB,wCAAwCA,OAAAA;",
-  "names": ["Lock", "_lastPromise", "Promise", "resolve", "executeSynchronized", "fun", "prevPromise", "getPromise", "trigger", "value", "e2ePreset", "cwd", "packageJson", "pkgUp", "sync", "packageDir", "split", "slice", "join", "packageDirRelative", "relative", "workspaceRoot", "testResultsDir", "reporter", "process", "env", "CI", "outputFile", "use", "trace", "setupPage", "browser", "options", "url", "bridgeLogs", "viewportSize", "context", "newContext", "page", "newPage", "setViewportSize", "lock", "on", "error", "console", "log", "msg", "argsPromise", "all", "args", "map", "x", "jsonValue", "length", "err", "goto", "storybookUrl", "storyId"]
-}