npm - @vitest/browser - Versions diffs - 2.0.0-beta.2 → 2.0.0-beta.3 - Mend

@vitest/browser 2.0.0-beta.2 → 2.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

package/context.d.ts +83 -0
package/dist/client/__vitest__/assets/{index-D0Wp7rbG.css → index-C576npev.css} +1 -1
package/dist/client/__vitest__/assets/index-DBVixaI-.js +51 -0
package/dist/client/__vitest__/index.html +2 -2
package/dist/client/__vitest_browser__/{main-DmAU-Uff.js → main-uRgy0zc4.js} +1 -1
package/dist/client/__vitest_browser__/{rpc-By4jD8av.js → rpc-Hw6RY18C.js} +53 -24
package/dist/client/__vitest_browser__/{tester-CrKhlp5g.js → tester-Ly7RLJnN.js} +1 -1
package/dist/client/index.html +3 -3
package/dist/client/tester.html +2 -2
package/dist/index.d.ts +2 -1
package/dist/index.js +157 -5
package/dist/providers.js +25 -25
package/package.json +11 -7
package/dist/client/__vitest__/assets/index-D1SnFeL5.js +0 -51

package/dist/client/__vitest__/index.html CHANGED Viewed

@@ -17,8 +17,8 @@
       })()
     </script>
     <!-- !LOAD_METADATA! -->
-    <script type="module" crossorigin src="./assets/index-D1SnFeL5.js"></script>
-    <link rel="stylesheet" crossorigin href="./assets/index-D0Wp7rbG.css">
+    <script type="module" crossorigin src="./assets/index-DBVixaI-.js"></script>
+    <link rel="stylesheet" crossorigin href="./assets/index-C576npev.css">
   </head>
   <body>
     <div id="app"></div>

package/dist/client/__vitest_browser__/{main-DmAU-Uff.js → main-uRgy0zc4.js} RENAMED Viewed

@@ -1,4 +1,4 @@
-import { c as client, g as getConfig, a as getBrowserState, b as channel, r as rpcDone } from "./rpc-By4jD8av.js";
+import { c as client, g as getConfig, a as getBrowserState, b as channel, r as rpcDone } from "./rpc-Hw6RY18C.js";
 const url = new URL(location.href);
 const ID_ALL = "__vitest_all__";
 const iframes = /* @__PURE__ */ new Map();

package/dist/client/__vitest_browser__/{rpc-By4jD8av.js → rpc-Hw6RY18C.js} RENAMED Viewed

@@ -338,6 +338,33 @@ const relative = function(from, to) {
   }
   return [..._from.map(() => ".."), ..._to].join("/");
 };
+function generateHash(str) {
+  let hash = 0;
+  if (str.length === 0)
+    return `${hash}`;
+  for (let i = 0; i < str.length; i++) {
+    const char = str.charCodeAt(i);
+    hash = (hash << 5) - hash + char;
+    hash = hash & hash;
+  }
+  return `${hash}`;
+}
+function createFileTask(filepath, root, projectName) {
+  const path = relative(root, filepath);
+  const file = {
+    id: generateHash(`${path}${projectName || ""}`),
+    name: path,
+    type: "suite",
+    mode: "run",
+    filepath,
+    tasks: [],
+    meta: /* @__PURE__ */ Object.create(null),
+    projectName,
+    file: void 0
+  };
+  file.file = file;
+  return file;
+}
 function isAggregateError(err) {
   if (typeof AggregateError !== "undefined" && err instanceof AggregateError)
     return true;
@@ -409,6 +436,9 @@ class StateManager {
     files.forEach((file) => {
       const existing = this.filesMap.get(file.filepath) || [];
       const otherProject = existing.filter((i) => i.projectName !== file.projectName);
+      const currentFile = existing.find((i) => i.projectName === file.projectName);
+      if (currentFile)
+        file.logs = currentFile.logs;
       otherProject.push(file);
       this.filesMap.set(file.filepath, otherProject);
       this.updateId(file);
@@ -419,13 +449,21 @@ class StateManager {
     const project = _project;
     paths.forEach((path) => {
       const files = this.filesMap.get(path);
-      if (!files)
+      const fileTask = createFileTask(path, project.config.root, project.config.name);
+      this.idMap.set(fileTask.id, fileTask);
+      if (!files) {
+        this.filesMap.set(path, [fileTask]);
         return;
+      }
       const filtered = files.filter((file) => file.projectName !== project.config.name);
-      if (!filtered.length)
-        this.filesMap.delete(path);
-      else
-        this.filesMap.set(path, filtered);
+      if (!filtered.length) {
+        this.filesMap.set(path, [fileTask]);
+      } else {
+        this.filesMap.set(path, [
+          ...filtered,
+          fileTask
+        ]);
+      }
     });
   }
   updateId(task) {
@@ -464,25 +502,7 @@ class StateManager {
     }).length;
   }
   cancelFiles(files, root, projectName) {
-    this.collectFiles(files.map((filepath) => {
-      const file = {
-        filepath,
-        name: relative(root, filepath),
-        id: filepath,
-        mode: "skip",
-        type: "suite",
-        result: {
-          state: "skip"
-        },
-        meta: {},
-        // Cancelled files have not yet collected tests
-        tasks: [],
-        projectName,
-        file: null
-      };
-      file.file = file;
-      return file;
-    }));
+    this.collectFiles(files.map((filepath) => createFileTask(filepath, root, projectName)));
   }
 }
 function createClient(url, options = {}) {
@@ -506,6 +526,13 @@ function createClient(url, options = {}) {
   ctx.state.idMap = reactive(ctx.state.idMap);
   let onMessage;
   const functions = {
+    onSpecsCollected(specs) {
+      var _a;
+      specs == null ? void 0 : specs.forEach(([config, file]) => {
+        ctx.state.clearFiles({ config }, [file]);
+      });
+      (_a = handlers.onSpecsCollected) == null ? void 0 : _a.call(handlers, specs);
+    },
     onPathsCollected(paths) {
       var _a;
       ctx.state.collectPaths(paths);
@@ -522,7 +549,9 @@ function createClient(url, options = {}) {
       (_a = handlers.onTaskUpdate) == null ? void 0 : _a.call(handlers, packs);
     },
     onUserConsoleLog(log) {
+      var _a;
       ctx.state.updateUserLog(log);
+      (_a = handlers.onUserConsoleLog) == null ? void 0 : _a.call(handlers, log);
     },
     onFinished(files, errors) {
       var _a;

package/dist/client/__vitest_browser__/{tester-CrKhlp5g.js → tester-Ly7RLJnN.js} RENAMED Viewed

@@ -10,7 +10,7 @@ var __publicField = (obj, key, value) => {
   __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
   return value;
 };
-import { i as importId, d as rpc$1, g as getConfig, _ as __vitePreload, b as channel, a as getBrowserState, c as client, l as loadSafeRpc, o as onCancel } from "./rpc-By4jD8av.js";
+import { i as importId, d as rpc$1, g as getConfig, _ as __vitePreload, b as channel, a as getBrowserState, c as client, l as loadSafeRpc, o as onCancel } from "./rpc-Hw6RY18C.js";
 function showPopupWarning(name, value, defaultValue) {
   return (...params) => {
     const formatedParams = params.map((p) => JSON.stringify(p)).join(", ");

package/dist/client/index.html CHANGED Viewed

@@ -23,11 +23,11 @@
     </style>
     <script>{__VITEST_INJECTOR__}</script>
     {__VITEST_SCRIPTS__}
-    <script type="module" crossorigin src="/__vitest_browser__/main-DmAU-Uff.js"></script>
-    <link rel="modulepreload" crossorigin href="/__vitest_browser__/rpc-By4jD8av.js">
+    <script type="module" crossorigin src="/__vitest_browser__/main-uRgy0zc4.js"></script>
+    <link rel="modulepreload" crossorigin href="/__vitest_browser__/rpc-Hw6RY18C.js">
   </head>
   <body>
-    <iframe id="vitest-ui" src=""></iframe>
+    <iframe id="vitest-ui" src="/__vitest__/"></iframe>
     <div id="vitest-tester"></div>
   </body>
 </html>

package/dist/client/tester.html CHANGED Viewed

@@ -17,8 +17,8 @@
     </style>
     <script>{__VITEST_INJECTOR__}</script>
     {__VITEST_SCRIPTS__}
-    <script type="module" crossorigin src="/__vitest_browser__/tester-CrKhlp5g.js"></script>
-    <link rel="modulepreload" crossorigin href="/__vitest_browser__/rpc-By4jD8av.js">
+    <script type="module" crossorigin src="/__vitest_browser__/tester-Ly7RLJnN.js"></script>
+    <link rel="modulepreload" crossorigin href="/__vitest_browser__/rpc-Hw6RY18C.js">
   </head>
   <body>
     {__VITEST_APPEND__}

package/dist/index.d.ts CHANGED Viewed

@@ -1,5 +1,6 @@
-import { Plugin } from 'vite';
 import { WorkspaceProject } from 'vitest/node';
+export { BrowserCommand } from 'vitest/node';
+import { Plugin } from 'vitest/config';
 declare const _default: (project: WorkspaceProject, base?: string) => Plugin[];

package/dist/index.js CHANGED Viewed

@@ -1,10 +1,13 @@
 import { fileURLToPath } from 'node:url';
-import { readFile } from 'node:fs/promises';
+import { readFile as readFile$1 } from 'node:fs/promises';
 import sirv from 'sirv';
 import { coverageConfigDefaults } from 'vitest/config';
 import { slash } from '@vitest/utils';
 import MagicString from 'magic-string';
 import { esmWalker } from '@vitest/utils/ast';
+import fs, { promises } from 'node:fs';
+import { resolve as resolve$1, dirname } from 'node:path';
+import { isFileServingAllowed } from 'vitest/node';
 const _DRIVE_LETTER_START_RE = /^[A-Za-z]:\//;
 function normalizeWindowsPath(input = "") {
@@ -398,6 +401,154 @@ export { ${viInjectedKey} }`);
   };
 }
+function assertFileAccess(path, project) {
+  if (!isFileServingAllowed(path, project.server) && !isFileServingAllowed(path, project.ctx.server))
+    throw new Error(`Access denied to "${path}". See Vite config documentation for "server.fs": https://vitejs.dev/config/server-options.html#server-fs-strict.`);
+}
+const readFile = async ({ project, testPath = process.cwd() }, path, options = {}) => {
+  const filepath = resolve$1(dirname(testPath), path);
+  assertFileAccess(filepath, project);
+  if (typeof options === "object" && !options.encoding)
+    options.encoding = "utf-8";
+  return promises.readFile(filepath, options);
+};
+const writeFile = async ({ project, testPath = process.cwd() }, path, data, options) => {
+  const filepath = resolve$1(dirname(testPath), path);
+  assertFileAccess(filepath, project);
+  const dir = dirname(filepath);
+  if (!fs.existsSync(dir))
+    await promises.mkdir(dir, { recursive: true });
+  await promises.writeFile(filepath, data, options);
+};
+const removeFile = async ({ project, testPath = process.cwd() }, path) => {
+  const filepath = resolve$1(dirname(testPath), path);
+  assertFileAccess(filepath, project);
+  await promises.rm(filepath);
+};
+function isObject(payload) {
+  return payload != null && typeof payload === "object";
+}
+function isSendKeysPayload(payload) {
+  const validOptions = ["type", "press", "down", "up"];
+  if (!isObject(payload))
+    throw new Error("You must provide a `SendKeysPayload` object");
+  const numberOfValidOptions = Object.keys(payload).filter(
+    (key) => validOptions.includes(key)
+  ).length;
+  const unknownOptions = Object.keys(payload).filter((key) => !validOptions.includes(key));
+  if (numberOfValidOptions > 1) {
+    throw new Error(
+      `You must provide ONLY one of the following properties to pass to the browser runner: ${validOptions.join(
+        ", "
+      )}.`
+    );
+  }
+  if (numberOfValidOptions === 0) {
+    throw new Error(
+      `You must provide one of the following properties to pass to the browser runner: ${validOptions.join(
+        ", "
+      )}.`
+    );
+  }
+  if (unknownOptions.length > 0)
+    throw new Error(`Unknown options \`${unknownOptions.join(", ")}\` present.`);
+  return true;
+}
+function isTypePayload(payload) {
+  return "type" in payload;
+}
+function isPressPayload(payload) {
+  return "press" in payload;
+}
+function isDownPayload(payload) {
+  return "down" in payload;
+}
+function isUpPayload(payload) {
+  return "up" in payload;
+}
+const sendKeys = async ({ provider }, payload) => {
+  if (!isSendKeysPayload(payload) || !payload)
+    throw new Error("You must provide a `SendKeysPayload` object");
+  if (provider.name === "playwright") {
+    const page = provider.page;
+    if (isTypePayload(payload))
+      await page.keyboard.type(payload.type);
+    else if (isPressPayload(payload))
+      await page.keyboard.press(payload.press);
+    else if (isDownPayload(payload))
+      await page.keyboard.down(payload.down);
+    else if (isUpPayload(payload))
+      await page.keyboard.up(payload.up);
+  } else if (provider.name === "webdriverio") {
+    const browser = provider.browser;
+    if (isTypePayload(payload))
+      await browser.keys(payload.type.split(""));
+    else if (isPressPayload(payload))
+      await browser.keys([payload.press]);
+    else
+      throw new Error('Only "press" and "type" are supported by webdriverio.');
+  } else {
+    throw new Error(`"sendKeys" is not supported for ${provider.name} browser provider.`);
+  }
+};
+var builtinCommands = {
+  readFile,
+  removeFile,
+  writeFile,
+  sendKeys
+};
+const VIRTUAL_ID_CONTEXT = "\0@vitest/browser/context";
+const ID_CONTEXT = "@vitest/browser/context";
+function BrowserContext(project) {
+  project.config.browser.commands ??= {};
+  for (const [name, command] of Object.entries(builtinCommands))
+    project.config.browser.commands[name] ??= command;
+  for (const command in project.config.browser.commands) {
+    if (!/^[a-z_$][\w$]*$/i.test(command))
+      throw new Error(`Invalid command name "${command}". Only alphanumeric characters, $ and _ are allowed.`);
+  }
+  return {
+    name: "vitest:browser:virtual-module:context",
+    enforce: "pre",
+    resolveId(id) {
+      if (id === ID_CONTEXT)
+        return VIRTUAL_ID_CONTEXT;
+    },
+    load(id) {
+      if (id === VIRTUAL_ID_CONTEXT)
+        return generateContextFile(project);
+    }
+  };
+}
+function generateContextFile(project) {
+  const commands = Object.keys(project.config.browser.commands ?? {});
+  const filepathCode = "__vitest_worker__.filepath || __vitest_worker__.current?.file?.filepath || undefined";
+  const commandsCode = commands.map((command) => {
+    return `    ["${command}"]: (...args) => rpc().triggerCommand("${command}", ${filepathCode}, args),`;
+  }).join("\n");
+  return `
+const rpc = () => __vitest_worker__.rpc
+export const server = {
+  platform: ${JSON.stringify(process.platform)},
+  version: ${JSON.stringify(process.version)},
+  provider: ${JSON.stringify(project.browserProvider.name)},
+  commands: {
+    ${commandsCode}
+  }
+}
+export const commands = server.commands
+export const page = {
+  get config() {
+    return __vitest_browser_runner__.config
+  }
+}
+`;
+}
 var index = (project, base = "/") => {
   const pkgRoot = resolve(fileURLToPath(import.meta.url), "../..");
   const distRoot = resolve(pkgRoot, "dist");
@@ -413,9 +564,9 @@ var index = (project, base = "/") => {
         }
       },
       async configureServer(server) {
-        const testerHtml = readFile(resolve(distRoot, "client/tester.html"), "utf8");
-        const runnerHtml = readFile(resolve(distRoot, "client/index.html"), "utf8");
-        const injectorJs = readFile(resolve(distRoot, "client/esm-client-injector.js"), "utf8");
+        const testerHtml = readFile$1(resolve(distRoot, "client/tester.html"), "utf8");
+        const runnerHtml = readFile$1(resolve(distRoot, "client/index.html"), "utf8");
+        const injectorJs = readFile$1(resolve(distRoot, "client/esm-client-injector.js"), "utf8");
         const favicon = `${base}favicon.svg`;
         const testerPrefix = `${base}__vitest_test__/__test__/`;
         server.middlewares.use((_req, res, next) => {
@@ -562,6 +713,7 @@ export default globalThis.loupe`;
         return useId;
       }
     },
+    BrowserContext(project),
     {
       name: "vitest:browser:esm-injector",
       enforce: "post",
@@ -600,7 +752,7 @@ function wrapConfig(config) {
   };
 }
 function replacer(code, values) {
-  return code.replace(/{\s*(\w+)\s*}/g, (_, key) => values[key] ?? "");
+  return code.replace(/\{\s*(\w+)\s*\}/g, (_, key) => values[key] ?? "");
 }
 async function formatScripts(scripts, server) {
   if (!scripts?.length)

package/dist/providers.js CHANGED Viewed

@@ -1,9 +1,9 @@
 const playwrightBrowsers = ["firefox", "webkit", "chromium"];
 class PlaywrightBrowserProvider {
   name = "playwright";
-  cachedBrowser = null;
-  cachedPage = null;
-  browser;
+  browser = null;
+  page = null;
+  browserName;
   ctx;
   options;
   getSupportedBrowsers() {
@@ -11,31 +11,31 @@ class PlaywrightBrowserProvider {
   }
   initialize(project, { browser, options }) {
     this.ctx = project;
-    this.browser = browser;
+    this.browserName = browser;
     this.options = options;
   }
   async openBrowserPage() {
-    if (this.cachedPage)
-      return this.cachedPage;
+    if (this.page)
+      return this.page;
     const options = this.ctx.config.browser;
     const playwright = await import('playwright');
-    const browser = await playwright[this.browser].launch({
+    const browser = await playwright[this.browserName].launch({
       ...this.options?.launch,
       headless: options.headless
     });
-    this.cachedBrowser = browser;
-    this.cachedPage = await browser.newPage(this.options?.page);
-    return this.cachedPage;
+    this.browser = browser;
+    this.page = await browser.newPage(this.options?.page);
+    return this.page;
   }
   async openPage(url) {
     const browserPage = await this.openBrowserPage();
     await browserPage.goto(url);
   }
   async close() {
-    const page = this.cachedPage;
-    this.cachedPage = null;
-    const browser = this.cachedBrowser;
-    this.cachedBrowser = null;
+    const page = this.page;
+    this.page = null;
+    const browser = this.browser;
+    this.browser = null;
     await page?.close();
     await browser?.close();
   }
@@ -44,8 +44,8 @@ class PlaywrightBrowserProvider {
 const webdriverBrowsers = ["firefox", "chrome", "edge", "safari"];
 class WebdriverBrowserProvider {
   name = "webdriverio";
-  cachedBrowser = null;
-  browser;
+  browser = null;
+  browserName;
   ctx;
   options;
   getSupportedBrowsers() {
@@ -53,29 +53,29 @@ class WebdriverBrowserProvider {
   }
   async initialize(ctx, { browser, options }) {
     this.ctx = ctx;
-    this.browser = browser;
+    this.browserName = browser;
     this.options = options;
   }
   async openBrowser() {
-    if (this.cachedBrowser)
-      return this.cachedBrowser;
+    if (this.browser)
+      return this.browser;
     const options = this.ctx.config.browser;
-    if (this.browser === "safari") {
+    if (this.browserName === "safari") {
       if (options.headless)
         throw new Error("You've enabled headless mode for Safari but it doesn't currently support it.");
     }
     const { remote } = await import('webdriverio');
-    this.cachedBrowser = await remote({
+    this.browser = await remote({
       ...this.options,
       logLevel: "error",
       capabilities: this.buildCapabilities()
     });
-    return this.cachedBrowser;
+    return this.browser;
   }
   buildCapabilities() {
     const capabilities = {
       ...this.options?.capabilities,
-      browserName: this.browser
+      browserName: this.browserName
     };
     const headlessMap = {
       chrome: ["goog:chromeOptions", ["headless", "disable-gpu"]],
@@ -83,7 +83,7 @@ class WebdriverBrowserProvider {
       edge: ["ms:edgeOptions", ["--headless"]]
     };
     const options = this.ctx.config.browser;
-    const browser = this.browser;
+    const browser = this.browserName;
     if (browser !== "safari" && options.headless) {
       const [key, args] = headlessMap[browser];
       const currentValues = this.options?.capabilities?.[key] || {};
@@ -98,7 +98,7 @@ class WebdriverBrowserProvider {
   }
   async close() {
     await Promise.all([
-      this.cachedBrowser?.sessionId ? this.cachedBrowser?.deleteSession?.() : null
+      this.browser?.sessionId ? this.browser?.deleteSession?.() : null
     ]);
     process.exit();
   }

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@vitest/browser",
   "type": "module",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "description": "Browser running for Vitest",
   "license": "MIT",
   "funding": "https://opencollective.com/vitest",
@@ -24,6 +24,10 @@
       "types": "./providers.d.ts",
       "default": "./dist/providers.js"
     },
+    "./context": {
+      "types": "./context.d.ts",
+      "default": "./context.js"
+    },
     "./providers/webdriverio": {
       "types": "./providers/webdriverio.d.ts"
     },
@@ -43,7 +47,7 @@
   "peerDependencies": {
     "playwright": "*",
     "webdriverio": "*",
-    "vitest": "2.0.0-beta.2"
+    "vitest": "2.0.0-beta.3"
   },
   "peerDependenciesMeta": {
     "playwright": {
@@ -59,7 +63,7 @@
   "dependencies": {
     "magic-string": "^0.30.10",
     "sirv": "^2.0.4",
-    "@vitest/utils": "2.0.0-beta.2"
+    "@vitest/utils": "2.0.0-beta.3"
   },
   "devDependencies": {
     "@types/ws": "^8.5.10",
@@ -69,10 +73,10 @@
     "playwright-core": "^1.44.0",
     "safaridriver": "^0.1.2",
     "webdriverio": "^8.36.1",
-    "@vitest/ui": "2.0.0-beta.2",
-    "@vitest/ws-client": "2.0.0-beta.2",
-    "@vitest/runner": "2.0.0-beta.2",
-    "vitest": "2.0.0-beta.2"
+    "@vitest/runner": "2.0.0-beta.3",
+    "@vitest/ui": "2.0.0-beta.3",
+    "@vitest/ws-client": "2.0.0-beta.3",
+    "vitest": "2.0.0-beta.3"
   },
   "scripts": {
     "build": "rimraf dist && pnpm build:node && pnpm build:client",