webdriverio 9.2.0 → 9.2.1

package/build/index.js

@@ -886,7 +886,7 @@ async function addInitScript(script, ...args) {
     throw new Error("This command is only supported when automating browser using WebDriver Bidi protocol");
   }
   const serializedParameters = (args || []).map((arg) => JSON.stringify(arg));
-  const context2 = await this.getWindowHandle();
+  const context = await this.getWindowHandle();
   const fn = `(emit) => {
         const closure = new Function(\`return ${script.toString()}\`)
         return closure()(${serializedParameters.length ? `${serializedParameters.join(", ")}, emit` : "emit"})
@@ -898,7 +898,7 @@ async function addInitScript(script, ...args) {
       type: "channel",
       value: { channel }
     }],
-    contexts: [context2]
+    contexts: [context]
   });
   await this.sessionSubscribe({
     events: ["script.message"]
@@ -972,13 +972,13 @@ function debug(commandTimeout = 5e3) {
   const { introMessage } = WDIORepl;
   if (!process.env.WDIO_WORKER_ID || typeof process.send !== "function") {
     console.log(WDIORepl.introMessage);
-    const context2 = {
+    const context = {
       browser: this,
       driver: this,
       $: this.$.bind(this),
       $$: this.$$.bind(this)
     };
-    return repl.start(context2);
+    return repl.start(context);
   }
   process._debugProcess(process.pid);
   process.send({
@@ -3013,15 +3013,15 @@ var ContextManager = class {
    *
    * @param {local.BrowsingContextNavigationInfo} context  browsing context used to navigate
    */
-  async #handleNavigationStarted(context2) {
+  async #handleNavigationStarted(context) {
     const windowHandle = await this.#browser.getWindowHandle();
-    if (context2.context === windowHandle && context2.url !== "UNKNOWN") {
-      log4.info(`Update current context: ${context2.context}`);
-      this.#currentContext = context2.context;
+    if (context.context === windowHandle && context.url !== "UNKNOWN") {
+      log4.info(`Update current context: ${context.context}`);
+      this.#currentContext = context.context;
     }
   }
-  setCurrentContext(context2) {
-    this.#currentContext = context2;
+  setCurrentContext(context) {
+    this.#currentContext = context;
   }
   async getCurrentContext() {
     if (!this.#currentContext) {
@@ -3077,7 +3077,7 @@ async function execute(script, ...args) {
   if (this.isBidi && !this.isMultiremote) {
     const browser = getBrowserObject2(this);
     const contextManager2 = getContextManager(browser);
-    const context2 = await contextManager2.getCurrentContext();
+    const context = await contextManager2.getCurrentContext();
     const userScript = typeof script === "string" ? new Function(script) : script;
     const functionDeclaration = new Function(`
             return (${SCRIPT_PREFIX}${userScript.toString()}${SCRIPT_SUFFIX}).apply(this, arguments);
@@ -3087,7 +3087,7 @@ async function execute(script, ...args) {
       awaitPromise: true,
       arguments: args.map((arg) => LocalValue.getArgument(arg)),
       target: {
-        context: context2
+        context
       }
     };
     const result = await browser.scriptCallFunction(params);
@@ -3111,7 +3111,7 @@ async function executeAsync(script, ...args) {
   if (this.isBidi && !this.isMultiremote) {
     const browser = getBrowserObject3(this);
     const contextManager2 = getContextManager(browser);
-    const context2 = await contextManager2.getCurrentContext();
+    const context = await contextManager2.getCurrentContext();
     const userScript = typeof script === "string" ? new Function(script) : script;
     const functionDeclaration = new Function(`
             const args = Array.from(arguments)
@@ -3129,7 +3129,7 @@ async function executeAsync(script, ...args) {
       awaitPromise: true,
       arguments: args.map((arg) => LocalValue.getArgument(arg)),
       target: {
-        context: context2
+        context
       }
     };
     const result = await browser.scriptCallFunction(params);
@@ -3802,12 +3802,12 @@ async function mock(url6, filterOptions) {
   }
   const browser = getBrowserObject5(this);
   const contextManager2 = getContextManager(browser);
-  const context2 = await contextManager2.getCurrentContext();
-  if (!SESSION_MOCKS[context2]) {
-    SESSION_MOCKS[context2] = /* @__PURE__ */ new Set();
+  const context = await contextManager2.getCurrentContext();
+  if (!SESSION_MOCKS[context]) {
+    SESSION_MOCKS[context] = /* @__PURE__ */ new Set();
   }
   const networkInterception = await WebDriverInterception.initiate(url6, filterOptions || {}, this);
-  SESSION_MOCKS[context2].add(networkInterception);
+  SESSION_MOCKS[context].add(networkInterception);
   return networkInterception;
 }
 
@@ -3849,9 +3849,9 @@ async function newWindow(url6, { windowName = "", windowFeatures = "" } = {}) {
   const tabsBefore = await this.getWindowHandles();
   if (this.isBidi) {
     const contextManager2 = getContextManager(this);
-    const { context: context2 } = await this.browsingContextCreate({ type: "window" });
-    contextManager2.setCurrentContext(context2);
-    await this.browsingContextNavigate({ context: context2, url: url6 });
+    const { context } = await this.browsingContextCreate({ type: "window" });
+    contextManager2.setCurrentContext(context);
+    await this.browsingContextNavigate({ context, url: url6 });
   } else {
     await this.execute(newWindowHelper, url6, windowName, windowFeatures);
   }
@@ -4017,8 +4017,8 @@ async function saveScreenshot(filepath) {
   if (this.isBidi) {
     const browser = getBrowserObject6(this);
     const contextManager2 = getContextManager(browser);
-    const context2 = await contextManager2.getCurrentContext();
-    const { data } = await this.browsingContextCaptureScreenshot({ context: context2 });
+    const context = await contextManager2.getCurrentContext();
+    const { data } = await this.browsingContextCaptureScreenshot({ context });
     screenBuffer = data;
   } else {
     screenBuffer = await this.takeScreenshot();
@@ -4104,9 +4104,9 @@ async function setViewport(options) {
     throw new Error("setViewport expects devicePixelRatio to be a number in the 0 to 2^31 \u2212 1 range");
   }
   const contextManager2 = getContextManager(this);
-  const context2 = await contextManager2.getCurrentContext();
+  const context = await contextManager2.getCurrentContext();
   await this.browsingContextSetViewport({
-    context: context2,
+    context,
     devicePixelRatio: options.devicePixelRatio || 1,
     viewport: {
       width: options.width,
@@ -4166,70 +4166,73 @@ async function switchWindow(matcher) {
 }
 
 // src/commands/browser/switchFrame.ts
-async function switchFrame(context2) {
-  if (context2 === null) {
+async function switchFrame(context) {
+  if (context === null) {
     const handle = await this.getWindowHandle();
     await switchToFrameHelper(this, handle);
     return handle;
   }
-  if (typeof context2 === "string") {
+  if (typeof context === "string") {
     const tree = await this.browsingContextGetTree({});
-    const urlContext = findContext(context2, tree.contexts, byUrl)?.context;
+    const urlContext = findContext(context, tree.contexts, byUrl)?.context;
     if (urlContext) {
       await switchToFrameHelper(this, urlContext);
       return urlContext;
     }
-    const urlContextContaining = findContext(context2, tree.contexts, byUrlContaining)?.context;
+    const urlContextContaining = findContext(context, tree.contexts, byUrlContaining)?.context;
     if (urlContextContaining) {
       await switchToFrameHelper(this, urlContextContaining);
       return urlContextContaining;
     }
-    const contextIdContext = findContext(context2, tree.contexts, byContextId)?.context;
+    const contextIdContext = findContext(context, tree.contexts, byContextId)?.context;
     if (contextIdContext) {
       await switchToFrameHelper(this, contextIdContext);
       return contextIdContext;
     }
-    throw new Error(`Frame with url or context id "${context2}" not found`);
+    throw new Error(`Frame with url or context id "${context}" not found`);
   }
-  if (typeof context2 === "object" && typeof context2.getElement === "function") {
-    const element = await context2.getElement();
+  if (typeof context === "object" && typeof context.getElement === "function") {
+    const element = await context.getElement();
     return switchToFrameUsingElement(this, element);
   }
-  if (typeof context2 === "function") {
+  if (typeof context === "function") {
     const tree = await this.browsingContextGetTree({});
-    const mapContext = (context3) => [
-      context3.context,
-      ...(context3.children || []).map(mapContext)
+    const mapContext = (context2) => [
+      context2.context,
+      ...(context2.children || []).map(mapContext)
     ];
     const sessionContext = getContextManager(this);
     const currentContext = await sessionContext.getCurrentContext();
     const allContexts = tree.contexts.map(mapContext).flat(Infinity).filter((ctx) => ctx !== currentContext).reduce((acc, ctx) => {
-      const context3 = findContext(ctx, tree.contexts, byContextId);
-      acc[ctx] = context3;
+      const context2 = findContext(ctx, tree.contexts, byContextId);
+      acc[ctx] = context2;
       return acc;
     }, {});
     for (const [contextId, ctx] of Object.entries(allContexts)) {
       sessionContext.setCurrentContext(contextId);
-      const isDesiredFrame = await context2(ctx);
+      const isDesiredFrame = await context(ctx);
       if (isDesiredFrame) {
-        return context2;
+        return context;
       }
     }
     sessionContext.setCurrentContext(currentContext);
     throw new Error("Could not find the desired frame");
   }
   throw new Error(
-    `Invalid type for context parameter: ${typeof context2}, expected one of number, string or null. Check out our docs: https://webdriver.io/docs/api/browser/switchToFrame.html`
+    `Invalid type for context parameter: ${typeof context}, expected one of number, string or null. Check out our docs: https://webdriver.io/docs/api/browser/switchToFrame.html`
   );
 }
-function switchToFrameHelper(browser, context2) {
+function switchToFrameHelper(browser, context) {
   const sessionContext = getContextManager(browser);
-  sessionContext.setCurrentContext(context2);
+  sessionContext.setCurrentContext(context);
 }
 async function switchToFrameUsingElement(browser, element) {
   let frameSrc = await element.getAttribute("src");
   if (!frameSrc) {
-    throw new Error(`Frame with index ${context} has no src attribute`);
+    const source = await element.getHTML({ includeSelectorTag: true });
+    throw new Error(
+      `The provided frame element ("${source}") does not have a src attribute needed to detect the context, please use a different method to select the frame. For more information checkout our docs: https://webdriver.io/docs/api/browser/switchFrame.html`
+    );
   }
   if (!frameSrc.startsWith("http")) {
     frameSrc = await browser.execute((urlPath) => URL.parse(urlPath, window.location.href)?.href, frameSrc) || frameSrc;
@@ -4237,27 +4240,29 @@ async function switchToFrameUsingElement(browser, element) {
   const tree = await browser.browsingContextGetTree({});
   const urlContext = findContext(frameSrc, tree.contexts, byUrl)?.context;
   if (!urlContext) {
-    throw new Error(`Frame with url "${frameSrc}" not found`);
+    throw new Error(
+      `Frame with url "${frameSrc}" not found! Please try a different method to select the frame. For more information checkout our docs: https://webdriver.io/docs/api/browser/switchFrame.html`
+    );
   }
   await switchToFrameHelper(browser, urlContext);
   return urlContext;
 }
-function byUrl(context2, url6) {
-  return context2.url === url6;
+function byUrl(context, url6) {
+  return context.url === url6;
 }
-function byUrlContaining(context2, url6) {
-  return context2.url.includes(url6);
+function byUrlContaining(context, url6) {
+  return context.url.includes(url6);
 }
-function byContextId(context2, contextId) {
-  return context2.context === contextId;
+function byContextId(context, contextId) {
+  return context.context === contextId;
 }
 function findContext(url6, contexts, matcher) {
-  for (const context2 of contexts || []) {
-    if (matcher(context2, url6)) {
-      return context2;
+  for (const context of contexts || []) {
+    if (matcher(context, url6)) {
+      return context;
     }
-    if (Array.isArray(context2.children) && context2.children.length > 0) {
-      const result = findContext(url6, context2.children, matcher);
+    if (Array.isArray(context.children) && context.children.length > 0) {
+      const result = findContext(url6, context.children, matcher);
       if (result) {
         return result;
       }
@@ -4557,18 +4562,18 @@ var NetworkManager = class {
     };
     response.children?.push(request);
   }
-  getRequestResponseData(context2) {
-    return this.#requests.get(context2);
+  getRequestResponseData(context) {
+    return this.#requests.get(context);
   }
   /**
    * Returns the number of requests that are currently pending.
    * @param context browsing context id
    * @returns the number of requests that are currently pending
    */
-  getPendingRequests(context2) {
-    const request = this.#requests.get(context2);
+  getPendingRequests(context) {
+    const request = this.#requests.get(context);
     if (!request) {
-      throw new Error(`Couldn't find request for context ${context2}`);
+      throw new Error(`Couldn't find request for context ${context}`);
     }
     const subRequests = request.children || [];
     return subRequests.filter((child) => (
@@ -4602,7 +4607,7 @@ async function url3(path4, options = {}) {
   if (this.isBidi) {
     let resetPreloadScript;
     const contextManager2 = getContextManager(this);
-    const context2 = await contextManager2.getCurrentContext();
+    const context = await contextManager2.getCurrentContext();
     if (options.onBeforeLoad) {
       if (typeof options.onBeforeLoad !== "function") {
         throw new Error(`Option "onBeforeLoad" must be a function, but received: ${typeof options.onBeforeLoad}`);
@@ -4623,22 +4628,22 @@ async function url3(path4, options = {}) {
     const classicPageLoadStrategy = this.capabilities.pageLoadStrategy === "none" ? "none" : this.capabilities.pageLoadStrategy === "normal" ? "complete" : this.capabilities.pageLoadStrategy === "eager" ? "interactive" : void 0;
     const wait = options.wait === "networkIdle" ? "complete" : options.wait || classicPageLoadStrategy || DEFAULT_WAIT_STATE;
     await this.browsingContextNavigate({
-      context: context2,
+      context,
       url: path4,
       wait
     });
     const network = networkManager.get(this);
-    const request = network?.getRequestResponseData(context2);
+    const request = network?.getRequestResponseData(context);
     if (mock2) {
       await mock2.restore();
     }
     if (network && options.wait === "networkIdle") {
       const timeout = options.timeout || DEFAULT_NETWORK_IDLE_TIMEOUT;
       await this.waitUntil(async () => {
-        return network.getPendingRequests(context2).length === 0;
+        return network.getPendingRequests(context).length === 0;
       }, {
         timeout,
-        timeoutMsg: `Navigation to '${path4}' timed out after ${timeout}ms with ${network.getPendingRequests(context2).length} (${network.getPendingRequests(context2).map((r) => r.url).join(", ")}) pending requests`
+        timeoutMsg: `Navigation to '${path4}' timed out after ${timeout}ms with ${network.getPendingRequests(context).length} (${network.getPendingRequests(context).map((r) => r.url).join(", ")}) pending requests`
       });
     }
     if (resetPreloadScript) {
@@ -5319,8 +5324,8 @@ async function getHTML(options = {}) {
     const { load } = await import("cheerio");
     const shadowRootManager2 = getShadowRootManager(browser);
     const contextManager2 = getContextManager(browser);
-    const context2 = await contextManager2.getCurrentContext();
-    const shadowRootElementPairs = shadowRootManager2.getShadowElementPairsByContextId(context2, this.elementId);
+    const context = await contextManager2.getCurrentContext();
+    const shadowRootElementPairs = shadowRootManager2.getShadowElementPairsByContextId(context, this.elementId);
     const elementsWithShadowRootAndIdVerified = (await Promise.all(
       shadowRootElementPairs.map(([elemId, elem]) => browser.execute((elem2) => elem2.tagName, { [ELEMENT_KEY11]: elemId }).then(
         () => [elemId, elem],
@@ -5341,7 +5346,7 @@ async function getHTML(options = {}) {
     populateHTML($3, shadowElementHTML.map(({ id, ...props }) => ({
       ...props,
       id,
-      mode: shadowRootManager2.getShadowRootModeById(context2, id) || "open"
+      mode: shadowRootManager2.getShadowRootModeById(context, id) || "open"
     })));
     return sanitizeHTML($3, { removeCommentNodes, prettify, excludeElements });
   }
@@ -5492,8 +5497,8 @@ var getWebElement = (el) => ({
 async function isEqual(el) {
   const browser = getBrowserObject21(this);
   if (browser.isMobile) {
-    const context2 = await browser.getContext().catch(() => void 0);
-    const contextId = typeof context2 === "string" ? context2 : context2?.id;
+    const context = await browser.getContext().catch(() => void 0);
+    const contextId = typeof context === "string" ? context : context?.id;
     if (contextId && contextId.toLowerCase().includes("native")) {
       return this.elementId === el.elementId;
     }
@@ -6595,15 +6600,15 @@ async function findDeepElement(selector) {
   const browser = getBrowserObject30(this);
   const shadowRootManager2 = getShadowRootManager(browser);
   const contextManager2 = getContextManager(browser);
-  const context2 = await contextManager2.getCurrentContext();
+  const context = await contextManager2.getCurrentContext();
   const shadowRoots = shadowRootManager2.getShadowElementsByContextId(
-    context2,
+    context,
     this.elementId
   );
   const { using, value } = findStrategy(selector, this.isW3C, this.isMobile);
   const locator = transformClassicToBidiSelector(using, value);
   const startNodes = shadowRoots.length > 0 ? shadowRoots.map((shadowRootNodeId) => ({ sharedId: shadowRootNodeId })) : this.elementId ? [{ sharedId: this.elementId }] : void 0;
-  const deepElementResult = await browser.browsingContextLocateNodes({ locator, context: context2, startNodes }).then(async (result) => {
+  const deepElementResult = await browser.browsingContextLocateNodes({ locator, context, startNodes }).then(async (result) => {
     const nodes = result.nodes.filter((node) => Boolean(node.sharedId)).map((node) => ({
       [ELEMENT_KEY17]: node.sharedId,
       locator
@@ -6633,15 +6638,15 @@ async function findDeepElements(selector) {
   const browser = getBrowserObject30(this);
   const shadowRootManager2 = getShadowRootManager(browser);
   const contextManager2 = getContextManager(browser);
-  const context2 = await contextManager2.getCurrentContext();
+  const context = await contextManager2.getCurrentContext();
   const shadowRoots = shadowRootManager2.getShadowElementsByContextId(
-    context2,
+    context,
     this.elementId
   );
   const { using, value } = findStrategy(selector, this.isW3C, this.isMobile);
   const locator = transformClassicToBidiSelector(using, value);
   const startNodes = shadowRoots.length > 0 ? shadowRoots.map((shadowRootNodeId) => ({ sharedId: shadowRootNodeId })) : this.elementId ? [{ sharedId: this.elementId }] : void 0;
-  const deepElementResult = await browser.browsingContextLocateNodes({ locator, context: context2, startNodes }).then(async (result) => {
+  const deepElementResult = await browser.browsingContextLocateNodes({ locator, context, startNodes }).then(async (result) => {
     const nodes = result.nodes.filter((node) => Boolean(node.sharedId)).map((node) => ({
       [ELEMENT_KEY17]: node.sharedId,
       locator

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "webdriverio",
   "description": "Next-gen browser and mobile automation test framework for Node.js",
-  "version": "9.2.0",
+  "version": "9.2.1",
   "homepage": "https://webdriver.io",
   "author": "Christian Bromann <mail@bromann.dev>",
   "license": "MIT",
@@ -110,5 +110,5 @@
       "optional": true
     }
   },
-  "gitHead": "d19039c7166c6df2e47a02de289a66865372107e"
+  "gitHead": "3da8b097c684b0ed9cda7224c41f96151bcd4104"
 }