imrpved wait* methods

Author: DavertMik

lib/helper/Playwright.js

@@ -24,6 +24,7 @@ import {
   requireWithFallback,
   normalizeSpacesInString,
   normalizePath,
+  resolveUrl,
   relativeDir,
 } from '../utils.js'
 import { isColorProperty, convertColorToRGBA } from '../colorUtils.js'
@@ -3383,20 +3384,21 @@ class Playwright extends Helper {
    */
   async waitInUrl(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
 
     return this.page
       .waitForFunction(
         urlPart => {
           const currUrl = decodeURIComponent(decodeURIComponent(decodeURIComponent(window.location.href)))
           return currUrl.indexOf(urlPart) > -1
         },
-        urlPart,
+        expectedUrl,
         { timeout: waitTimeout },
       )
       .catch(async e => {
-        const currUrl = await this._getPageUrl() // Required because the waitForFunction can't return data.
+        const currUrl = await this._getPageUrl()
         if (/Timeout/i.test(e.message)) {
-          throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`)
+          throw new Error(`expected url to include ${expectedUrl}, but found ${currUrl}`)
         } else {
           throw e
         }
@@ -3408,26 +3410,17 @@ class Playwright extends Helper {
    */
   async waitUrlEquals(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
-
-    const baseUrl = this.options.url
-    let expectedUrl = urlPart
-    if (urlPart.indexOf('http') < 0) {
-      expectedUrl = baseUrl + urlPart
-    }
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
 
     try {
       await this.page.waitForURL(
-        url => url.href.includes(expectedUrl),
+        url => url.href === expectedUrl,
         { timeout: waitTimeout },
       )
     } catch (e) {
       const currUrl = await this._getPageUrl()
       if (/Timeout/i.test(e.message)) {
-        if (!currUrl.includes(expectedUrl)) {
-          throw new Error(`expected url to be ${expectedUrl}, but found ${currUrl}`)
-        } else {
-          throw new Error(`expected url not loaded, error message: ${e.message}`)
-        }
+        throw new Error(`expected url to be ${expectedUrl}, but found ${currUrl}`)
       } else {
         throw e
       }

lib/helper/Puppeteer.js

@@ -27,6 +27,7 @@ import {
   requireWithFallback,
   normalizeSpacesInString,
   normalizePath,
+  resolveUrl,
 } from '../utils.js'
 import { isColorProperty, convertColorToRGBA } from '../colorUtils.js'
 import ElementNotFound from './errors/ElementNotFound.js'
@@ -2442,6 +2443,7 @@ class Puppeteer extends Helper {
    */
   async waitInUrl(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
 
     return this.page
       .waitForFunction(
@@ -2450,12 +2452,12 @@ class Puppeteer extends Helper {
           return currUrl.indexOf(urlPart) > -1
         },
         { timeout: waitTimeout },
-        urlPart,
+        expectedUrl,
       )
       .catch(async e => {
-        const currUrl = await this._getPageUrl() // Required because the waitForFunction can't return data.
+        const currUrl = await this._getPageUrl()
         if (/Waiting failed:/i.test(e.message) || /failed: timeout/i.test(e.message)) {
-          throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`)
+          throw new Error(`expected url to include ${expectedUrl}, but found ${currUrl}`)
         } else {
           throw e
         }
@@ -2467,30 +2469,21 @@ class Puppeteer extends Helper {
    */
   async waitUrlEquals(urlPart, sec = null) {
     const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
-
-    const baseUrl = this.options.url
-    let expectedUrl = urlPart
-    if (urlPart.indexOf('http') < 0) {
-      expectedUrl = baseUrl + urlPart
-    }
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
 
     return this.page
       .waitForFunction(
         url => {
           const currUrl = decodeURIComponent(window.location.href)
-          return currUrl.indexOf(url) > -1
+          return currUrl === url
         },
         { timeout: waitTimeout },
         expectedUrl,
       )
       .catch(async e => {
         const currUrl = await this._getPageUrl()
         if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
-          if (!currUrl.includes(expectedUrl)) {
-            throw new Error(`expected url to be ${expectedUrl}, but found ${currUrl}`)
-          } else {
-            throw new Error(`expected url not loaded, error message: ${e.message}`)
-          }
+          throw new Error(`expected url to be ${expectedUrl}, but found ${currUrl}`)
         } else {
           throw e
         }

lib/helper/WebDriver.js

@@ -23,6 +23,7 @@ import {
   getNormalizedKeyAttributeValue,
   modifierKeys,
   normalizePath,
+  resolveUrl,
 } from '../utils.js'
 import { isColorProperty, convertColorToRGBA } from '../colorUtils.js'
 import ElementNotFound from './errors/ElementNotFound.js'
@@ -2497,22 +2498,23 @@ class WebDriver extends Helper {
   async waitInUrl(urlPart, sec = null) {
     const client = this.browser
     const aSec = sec || this.options.waitForTimeoutInSeconds
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
     let currUrl = ''
 
     return client
       .waitUntil(
         function () {
           return this.getUrl().then(res => {
             currUrl = decodeUrl(res)
-            return currUrl.indexOf(urlPart) > -1
+            return currUrl.indexOf(expectedUrl) > -1
           })
         },
         { timeout: aSec * 1000 },
       )
       .catch(e => {
         e = wrapError(e)
         if (e.message.indexOf('timeout')) {
-          throw new Error(`expected url to include ${urlPart}, but found ${currUrl}`)
+          throw new Error(`expected url to include ${expectedUrl}, but found ${currUrl}`)
         }
         throw e
       })
@@ -2523,22 +2525,19 @@ class WebDriver extends Helper {
    */
   async waitUrlEquals(urlPart, sec = null) {
     const aSec = sec || this.options.waitForTimeoutInSeconds
-    const baseUrl = this.options.url
-    if (urlPart.indexOf('http') < 0) {
-      urlPart = baseUrl + urlPart
-    }
+    const expectedUrl = resolveUrl(urlPart, this.options.url)
     let currUrl = ''
     return this.browser
       .waitUntil(function () {
         return this.getUrl().then(res => {
           currUrl = decodeUrl(res)
-          return currUrl === urlPart
+          return currUrl === expectedUrl
         })
       }, aSec * 1000)
       .catch(e => {
         e = wrapError(e)
         if (e.message.indexOf('timeout')) {
-          throw new Error(`expected url to be ${urlPart}, but found ${currUrl}`)
+          throw new Error(`expected url to be ${expectedUrl}, but found ${currUrl}`)
         }
         throw e
       })

lib/utils.js

@@ -157,6 +157,17 @@ export const normalizePath = function (path) {
     .replace(/\/$/, '') || '/'
 }
 
+export const resolveUrl = function (url, baseUrl) {
+  if (!url) return url
+  if (url.indexOf('http') === 0) return url
+  if (!baseUrl) return url
+  try {
+    return new URL(url, baseUrl).href
+  } catch (e) {
+    return url
+  }
+}
+
 export const xpathLocator = {
   /**
    * @param {string} string

test/helper/webapi.js

@@ -156,7 +156,7 @@ export function tests() {
         await I.waitInUrl('/info')
         await I.waitInUrl('/info2', 0.1)
       } catch (e) {
-        assert.include(e.message, `expected url to include /info2, but found ${siteUrl}/info`)
+        assert.include(e.message, `expected url to include ${siteUrl}/info2, but found ${siteUrl}/info`)
       }
     })