added path check to waiter

Author: DavertMik

lib/helper/Playwright.js

@@ -3434,6 +3434,35 @@ class Playwright extends Helper {
     }
   }
 
+  /**
+   * {{> waitCurrentPathEquals }}
+   */
+  async waitCurrentPathEquals(path, sec = null) {
+    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
+    const normalizedPath = normalizePath(path)
+
+    try {
+      await this.page.waitForFunction(
+        expectedPath => {
+          const actualPath = window.location.pathname
+          const normalizePath = p => (p === '' || p === '/' ? '/' : p.replace(/\/+/g, '/').replace(/\/$/, '') || '/')
+          return normalizePath(actualPath) === expectedPath
+        },
+        { timeout: waitTimeout },
+        normalizedPath,
+      )
+    } catch (e) {
+      const currentUrl = await this._getPageUrl()
+      const baseUrl = this.options.url || 'http://localhost'
+      const actualPath = new URL(currentUrl, baseUrl).pathname
+      if (/Timeout/i.test(e.message)) {
+        throw new Error(`expected path to be ${normalizedPath}, but found ${normalizePath(actualPath)}`)
+      } else {
+        throw e
+      }
+    }
+  }
+
   /**
    * {{> waitForText }}
    */

lib/helper/Puppeteer.js

@@ -2497,6 +2497,35 @@ class Puppeteer extends Helper {
       })
   }
 
+  /**
+   * {{> waitCurrentPathEquals }}
+   */
+  async waitCurrentPathEquals(path, sec = null) {
+    const waitTimeout = sec ? sec * 1000 : this.options.waitForTimeout
+    const normalizedPath = normalizePath(path)
+
+    return this.page
+      .waitForFunction(
+        expectedPath => {
+          const actualPath = window.location.pathname
+          const normalizePath = p => (p === '' || p === '/' ? '/' : p.replace(/\/+/g, '/').replace(/\/$/, '') || '/')
+          return normalizePath(actualPath) === expectedPath
+        },
+        { timeout: waitTimeout },
+        normalizedPath,
+      )
+      .catch(async e => {
+        const currUrl = await this._getPageUrl()
+        const baseUrl = this.options.url || 'http://localhost'
+        const actualPath = new URL(currUrl, baseUrl).pathname
+        if (/Waiting failed/i.test(e.message) || /failed: timeout/i.test(e.message)) {
+          throw new Error(`expected path to be ${normalizedPath}, but found ${normalizePath(actualPath)}`)
+        } else {
+          throw e
+        }
+      })
+  }
+
   /**
    * {{> waitForText }}
    */

lib/helper/WebDriver.js

@@ -2544,6 +2544,34 @@ class WebDriver extends Helper {
       })
   }
 
+  /**
+   * {{> waitCurrentPathEquals }}
+   */
+  async waitCurrentPathEquals(path, sec = null) {
+    const aSec = sec || this.options.waitForTimeoutInSeconds
+    const normalizedPath = normalizePath(path)
+    const baseUrl = this.options.url || 'http://localhost'
+    let actualPath = ''
+
+    return this.browser
+      .waitUntil(
+        async () => {
+          const currUrl = await this.browser.getUrl()
+          const url = new URL(currUrl, baseUrl)
+          actualPath = url.pathname
+          return normalizePath(actualPath) === normalizedPath
+        },
+        { timeout: aSec * 1000 },
+      )
+      .catch(e => {
+        e = wrapError(e)
+        if (e.message.indexOf('timeout')) {
+          throw new Error(`expected path to be ${normalizedPath}, but found ${normalizePath(actualPath)}`)
+        }
+        throw e
+      })
+  }
+
   /**
    * {{> waitForText }}
    *

test/helper/webapi.js

@@ -172,6 +172,28 @@ export function tests() {
     })
   })
 
+  describe('#waitCurrentPathEquals', () => {
+    it('should wait for path to match (ignoring query strings)', async () => {
+      await I.amOnPage('/info')
+      await I.waitCurrentPathEquals('/info')
+    })
+
+    it('should wait timeout with proper error message', async () => {
+      try {
+        await I.amOnPage('/info')
+        await I.waitCurrentPathEquals('/nonexistent', 0.1)
+      } catch (e) {
+        assert.include(e.message, 'expected path to be /nonexistent')
+      }
+    })
+
+    it('should normalize paths when comparing', async () => {
+      await I.amOnPage('/form/field/')
+      await I.waitCurrentPathEquals('/form/field')
+      await I.waitCurrentPathEquals('/form/field/')
+    })
+  })
+
   describe('see text : #see', () => {
     it('should check text on site', async () => {
       await I.amOnPage('/')