@dxos/test-utils 0.10.0 → 0.11.0

package/dist/lib/index.mjs

@@ -0,0 +1,12 @@
+import { onTestFinished } from "vitest";
+//#region src/resource.ts
+var openAndClose = async (...resources) => {
+	for (const resourceLike of resources) {
+		await resourceLike.open();
+		onTestFinished(() => resourceLike.close());
+	}
+};
+//#endregion
+export { openAndClose };
+
+//# sourceMappingURL=index.mjs.map

package/dist/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"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":";;AAYA,IAAa,eAAe,OAAO,GAAG,cAA8B;CAClE,KAAK,MAAM,gBAAgB,WAAW;EACpC,MAAM,aAAa,KAAK;EACxB,qBAAqB,aAAa,MAAM,CAAC;CAC3C;AACF"}

package/dist/lib/playwright.mjs

@@ -0,0 +1,116 @@
+import { devices } from "@playwright/test";
+import { existsSync, readFileSync } from "@dxos/node-std/fs";
+import { dirname, join, resolve } from "@dxos/node-std/path";
+import pkgUp from "pkg-up";
+import { trigger } from "@dxos/async";
+//#region src/lock.ts
+var Lock = class {
+	_lastPromise = Promise.resolve();
+	async executeSynchronized(fun) {
+		const prevPromise = this._lastPromise;
+		const [getPromise, resolve] = trigger();
+		this._lastPromise = getPromise();
+		await prevPromise;
+		try {
+			return await fun();
+		} finally {
+			resolve();
+		}
+	}
+};
+//#endregion
+//#region src/playwright.ts
+var findWorkspaceRoot = (startDir) => {
+	let dir = resolve(startDir);
+	while (dir !== "/") {
+		try {
+			if (existsSync(join(dir, "pnpm-workspace.yaml"))) return dir;
+			const pkgPath = join(dir, "package.json");
+			if (JSON.parse(readFileSync(pkgPath, "utf-8")).workspaces) return dir;
+		} catch {}
+		const parent = dirname(dir);
+		if (parent === dir) break;
+		dir = parent;
+	}
+	throw new Error("Could not find pnpm workspace root");
+};
+var e2ePreset = (testDir) => {
+	const packageDir = pkgUp.sync({ cwd: testDir }).split("/").slice(0, -1).join("/");
+	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`);
+	const browser = process.env.PLAYWRIGHT_BROWSER || (process.env.CI ? "all" : "chromium");
+	const projects = [
+		{
+			name: "chromium",
+			use: { ...devices["Desktop Chrome"] }
+		},
+		{
+			name: "firefox",
+			use: { ...devices["Desktop Firefox"] }
+		},
+		{
+			name: "webkit",
+			use: { ...devices["Desktop Safari"] }
+		}
+	].filter((project) => {
+		return browser === "all" || project.name === browser;
+	});
+	return {
+		testDir,
+		outputDir: testResultOuputDir,
+		timeout: 6e4,
+		fullyParallel: true,
+		forbidOnly: !!process.env.CI,
+		retries: process.env.CI ? 2 : 0,
+		workers: process.env.CI ? 1 : 4,
+		reporter: process.env.CI ? [
+			["list"],
+			["json", { outputFile: reporterOutputFile }],
+			["junit", { outputFile: reporterOutputFile.replace(/\.json$/, ".xml") }]
+		] : [["list"]],
+		use: {
+			trace: "retain-on-failure",
+			actionTimeout: 3e4
+		},
+		projects
+	};
+};
+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, port = 9009) => `http://localhost:${port}/iframe.html?id=${storyId}&viewMode=story`;
+//#endregion
+export { e2ePreset, setupPage, storybookUrl };
+
+//# sourceMappingURL=playwright.mjs.map

package/dist/lib/playwright.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright.mjs","names":[],"sources":["../../src/lock.ts","../../src/playwright.ts"],"sourcesContent":["//\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","//\n// Copyright 2023 DXOS.org\n//\n\n/* eslint-disable no-console */\n\nimport { type Browser, type BrowserContext, type Page, type PlaywrightTestConfig, devices } from '@playwright/test';\nimport { existsSync, readFileSync } from 'node:fs';\nimport { dirname, join, resolve } from 'node:path';\nimport pkgUp from 'pkg-up';\n\nimport { Lock } from './lock';\n\nconst findWorkspaceRoot = (startDir: string): string => {\n  let dir = resolve(startDir);\n  while (dir !== '/') {\n    try {\n      // Check for pnpm-workspace.yaml first (modern pnpm approach)\n      const workspaceYamlPath = join(dir, 'pnpm-workspace.yaml');\n      if (existsSync(workspaceYamlPath)) {\n        return dir;\n      }\n\n      // Check for package.json with workspaces field (legacy approach)\n      const pkgPath = join(dir, 'package.json');\n      const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));\n      if (pkg.workspaces) {\n        return dir;\n      }\n    } catch {}\n    const parent = dirname(dir);\n    if (parent === dir) {\n      break;\n    }\n    dir = parent;\n  }\n\n  throw new Error('Could not find pnpm workspace root');\n};\n\nexport const e2ePreset = (testDir: string): PlaywrightTestConfig => {\n  const packageJson = pkgUp.sync({ cwd: testDir });\n  const packageDir = packageJson!.split('/').slice(0, -1).join('/');\n  const packageDirName = packageDir.split('/').pop();\n  if (!packageDirName) {\n    throw new Error('packageDirName not found');\n  }\n\n  const workspaceRoot = findWorkspaceRoot(packageDir);\n  const testResultOuputDir = join(workspaceRoot, 'test-results/playwright/output', packageDirName);\n  const reporterOutputFile = join(workspaceRoot, 'test-results/playwright/report', `${packageDirName}.json`);\n\n  const browser = process.env.PLAYWRIGHT_BROWSER || (process.env.CI ? 'all' : 'chromium');\n  const projects = [\n    {\n      name: 'chromium',\n      use: { ...devices['Desktop Chrome'] },\n    },\n    {\n      name: 'firefox',\n      use: { ...devices['Desktop Firefox'] },\n    },\n    {\n      name: 'webkit',\n      use: { ...devices['Desktop Safari'] },\n    },\n  ].filter((project) => {\n    return browser === 'all' || project.name === browser;\n  });\n\n  return {\n    testDir,\n    outputDir: testResultOuputDir,\n    // Playwright's default is 30s, which equals the action bound below — leaving a test no budget beyond\n    // a single slow action. Storybook-backed suites also pay an on-demand story compile in the first\n    // test's `beforeEach`, which alone exceeded 30s. Individual configs may still raise this.\n    timeout: 60_000,\n    // Run tests in files in parallel.\n    fullyParallel: true,\n    // Fail the build on CI if you accidentally left test.only in the source code.\n    forbidOnly: !!process.env.CI,\n    // Retry on CI to ride out the residual d&d / startup flakes while the\n    // underlying causes are still being chased. Local runs stay strict so\n    // flakes are visible while iterating.\n    retries: process.env.CI ? 2 : 0,\n    // Opt out of parallel tests on CI.\n    workers: process.env.CI ? 1 : 4,\n    // Reporter to use. See https://playwright.dev/docs/test-reporters.\n    reporter: process.env.CI\n      ? [\n          ['list'],\n          [\n            'json',\n            {\n              outputFile: reporterOutputFile,\n            },\n          ],\n          ['junit', { outputFile: reporterOutputFile.replace(/\\.json$/, '.xml') }],\n        ]\n      : [['list']],\n    use: {\n      trace: 'retain-on-failure',\n      // Playwright's default is no limit, so a stuck locator would absorb the whole per-test budget and\n      // report a bare `Test timeout` naming nothing.\n      actionTimeout: 30_000,\n    },\n    projects,\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, port = 9009) =>\n  `http://localhost:${port}/iframe.html?id=${storyId}&viewMode=story`;\n"],"mappings":";;;;;;AAOA,IAAa,OAAb,MAAkB;CAChB,eAAuB,QAAQ,QAAQ;CAEvC,MAAM,oBAAuB,KAAmC;EAC9D,MAAM,cAAc,KAAK;EACzB,MAAM,CAAC,YAAY,WAAW,QAAQ;EACtC,KAAK,eAAe,WAAW;EAE/B,MAAM;EACN,IAAI;GAEF,OAAO,MADa,IAAI;EAE1B,UAAU;GACR,QAAQ;EACV;CACF;AACF;;;ACVA,IAAM,qBAAqB,aAA6B;CACtD,IAAI,MAAM,QAAQ,QAAQ;CAC1B,OAAO,QAAQ,KAAK;EAClB,IAAI;GAGF,IAAI,WADsB,KAAK,KAAK,qBACrB,CAAiB,GAC9B,OAAO;GAIT,MAAM,UAAU,KAAK,KAAK,cAAc;GAExC,IADY,KAAK,MAAM,aAAa,SAAS,OAAO,CAChD,CAAA,CAAI,YACN,OAAO;EAEX,QAAQ,CAAC;EACT,MAAM,SAAS,QAAQ,GAAG;EAC1B,IAAI,WAAW,KACb;EAEF,MAAM;CACR;CAEA,MAAM,IAAI,MAAM,oCAAoC;AACtD;AAEA,IAAa,aAAa,YAA0C;CAElE,MAAM,aADc,MAAM,KAAK,EAAE,KAAK,QAAQ,CAC3B,CAAA,CAAa,MAAM,GAAG,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,KAAK,GAAG;CAChE,MAAM,iBAAiB,WAAW,MAAM,GAAG,CAAC,CAAC,IAAI;CACjD,IAAI,CAAC,gBACH,MAAM,IAAI,MAAM,0BAA0B;CAG5C,MAAM,gBAAgB,kBAAkB,UAAU;CAClD,MAAM,qBAAqB,KAAK,eAAe,kCAAkC,cAAc;CAC/F,MAAM,qBAAqB,KAAK,eAAe,kCAAkC,GAAG,eAAe,MAAM;CAEzG,MAAM,UAAU,QAAQ,IAAI,uBAAuB,QAAQ,IAAI,KAAK,QAAQ;CAC5E,MAAM,WAAW;EACf;GACE,MAAM;GACN,KAAK,EAAE,GAAG,QAAQ,kBAAkB;EACtC;EACA;GACE,MAAM;GACN,KAAK,EAAE,GAAG,QAAQ,mBAAmB;EACvC;EACA;GACE,MAAM;GACN,KAAK,EAAE,GAAG,QAAQ,kBAAkB;EACtC;CACF,CAAC,CAAC,QAAQ,YAAY;EACpB,OAAO,YAAY,SAAS,QAAQ,SAAS;CAC/C,CAAC;CAED,OAAO;EACL;EACA,WAAW;EAIX,SAAS;EAET,eAAe;EAEf,YAAY,CAAC,CAAC,QAAQ,IAAI;EAI1B,SAAS,QAAQ,IAAI,KAAK,IAAI;EAE9B,SAAS,QAAQ,IAAI,KAAK,IAAI;EAE9B,UAAU,QAAQ,IAAI,KAClB;GACE,CAAC,MAAM;GACP,CACE,QACA,EACE,YAAY,mBACd,CACF;GACA,CAAC,SAAS,EAAE,YAAY,mBAAmB,QAAQ,WAAW,MAAM,EAAE,CAAC;EACzE,IACA,CAAC,CAAC,MAAM,CAAC;EACb,KAAK;GACH,OAAO;GAGP,eAAe;EACjB;EACA;CACF;AACF;AAQA,IAAa,YAAY,OAAO,SAAmC,UAAwB,CAAC,MAAM;CAChG,MAAM,EAAE,KAAK,YAAY,iBAAiB;CAE1C,MAAM,UAAU,gBAAgB,UAAU,MAAM,QAAQ,WAAW,IAAI;CACvE,MAAM,OAAO,MAAM,QAAQ,QAAQ;CAEnC,IAAI,cACF,MAAM,KAAK,gBAAgB,YAAY;CAIzC,IAAI,YAAY;EACd,MAAM,OAAO,IAAI,KAAK;EAEtB,KAAK,GAAG,aAAa,OAAO,UAAU;GACpC,MAAM,KAAK,oBAAoB,YAAY;IAEzC,QAAQ,IAAI,KAAK;GACnB,CAAC;EACH,CAAC;EAED,KAAK,GAAG,WAAW,OAAO,QAAQ;GAChC,IAAI;IACF,MAAM,cAAc,QAAQ,IAAI,IAAI,KAAK,CAAC,CAAC,KAAK,MAAM,EAAE,UAAU,CAAC,CAAC;IACpE,MAAM,KAAK,oBAAoB,YAAY;KACzC,MAAM,OAAO,MAAM;KAEnB,IAAI,KAAK,SAAS,GAChB,QAAQ,IAAI,GAAG,IAAI;UAEnB,QAAQ,IAAI,GAAG;IAEnB,CAAC;GACH,SAAS,KAAK;IACZ,QAAQ,MAAM,2BAA2B,GAAG;GAC9C;EACF,CAAC;CACH;CAEA,IAAI,KACF,MAAM,KAAK,KAAK,GAAG;CAGrB,OAAO;EAAE;EAAS;CAAK;AACzB;AAEA,IAAa,gBAAgB,SAAiB,OAAO,SACnD,oBAAoB,KAAK,kBAAkB,QAAQ"}

package/dist/types/src/playwright.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../../../src/playwright.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,IAAI,EAAE,KAAK,oBAAoB,EAAW,MAAM,kBAAkB,CAAC;AAkCpH,eAAO,MAAM,SAAS,YAAa,MAAM,KAAG,oBA6D3C,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,eAAO,MAAM,SAAS,YAAmB,OAAO,GAAG,cAAc,YAAW,YAAY;;;EA4CvF,CAAC;AAEF,eAAO,MAAM,YAAY,YAAa,MAAM,0BACyB,CAAC"}
+{"version":3,"file":"playwright.d.ts","sourceRoot":"","sources":["../../../src/playwright.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,IAAI,EAAE,KAAK,oBAAoB,EAAW,MAAM,kBAAkB,CAAC;AAkCpH,eAAO,MAAM,SAAS,YAAa,MAAM,KAAG,oBAoE3C,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,CAAC,EAAE,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACvD,CAAC;AAEF,eAAO,MAAM,SAAS,YAAmB,OAAO,GAAG,cAAc,YAAW,YAAY;;;EA4CvF,CAAC;AAEF,eAAO,MAAM,YAAY,YAAa,MAAM,0BACyB,CAAC"}