chore: add unit tests for cy url, hash, location, title, reload, and go changes to make it easier to test minor behavior changes

Author: AtofStryker

packages/driver/src/cy/commands/helpers/location.ts

@@ -0,0 +1,76 @@
+export class UrlNotYetAvailableError extends Error {
+  constructor () {
+    const message = 'URL is not yet available'
+
+    super(message)
+    this.name = 'UrlNotYetAvailableError'
+  }
+}
+
+export function getUrlFromAutomation (Cypress: Cypress.Cypress, options: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
+  const timeout = options.timeout ?? Cypress.config('defaultCommandTimeout') as number
+
+  this.set('timeout', timeout)
+
+  let fullUrlObj: any = null
+  let automationPromise: Promise<void> | null = null
+  // need to set a valid type on this
+  let mostRecentError = new UrlNotYetAvailableError()
+
+  const getUrlFromAutomation = () => {
+    if (automationPromise) {
+      return automationPromise
+    }
+
+    fullUrlObj = null
+
+    automationPromise = Cypress.automation('get:aut:url', {})
+    .timeout(timeout)
+    .then((url) => {
+      const fullUrlObject = new URL(url)
+
+      fullUrlObj = {
+        hash: fullUrlObject.hash,
+        host: fullUrlObject.host,
+        hostname: fullUrlObject.hostname,
+        href: fullUrlObject.href,
+        origin: fullUrlObject.origin,
+        pathname: fullUrlObject.pathname,
+        port: fullUrlObject.port,
+        protocol: fullUrlObject.protocol,
+        search: fullUrlObject.search,
+        searchParams: fullUrlObject.searchParams,
+      }
+    })
+    .catch((err) => {
+      mostRecentError.name = err.name
+      mostRecentError.message = err.message
+    })
+    .catch((err) => mostRecentError = err)
+    // Pass or fail, we always clear the automationPromise, so future retries know there's no live request to the server.
+    .finally(() => automationPromise = null)
+
+    return automationPromise
+  }
+
+  this.set('onFail', (err) => {
+    // if we are actively retrying or the assertion failed, we want to retry
+    if (err.name === 'UrlNotYetAvailableError' || err.name === 'AssertionError') {
+      // tslint:disable-next-line no-floating-promises
+      getUrlFromAutomation()
+    } else {
+      throw err
+    }
+  })
+
+  return () => {
+    if (fullUrlObj) {
+      return fullUrlObj
+    }
+
+    // tslint:disable-next-line no-floating-promises
+    getUrlFromAutomation()
+
+    throw mostRecentError
+  }
+}

packages/driver/src/cy/commands/helpers/window.ts

@@ -0,0 +1,63 @@
+export class TitleNotYetAvailableError extends Error {
+  constructor () {
+    const message = 'document.title is not yet available'
+
+    super(message)
+    this.name = 'TitleNotYetAvailableError'
+  }
+}
+
+export function getTitleFromAutomation (Cypress: Cypress.Cypress, options: Partial<Cypress.Loggable & Cypress.Timeoutable> = {}) {
+  const timeout = options.timeout ?? Cypress.config('defaultCommandTimeout') as number
+
+  this.set('timeout', timeout)
+
+  let documentTitle: any = null
+  let automationPromise: Promise<void> | null = null
+  // need to set a valid type on this
+  let mostRecentError = new TitleNotYetAvailableError()
+
+  const getTitleFromAutomation = () => {
+    if (automationPromise) {
+      return automationPromise
+    }
+
+    documentTitle = null
+
+    automationPromise = Cypress.automation('get:aut:title', {})
+    .timeout(timeout)
+    .then((returnedDocumentTitle) => {
+      documentTitle = returnedDocumentTitle
+    })
+    .catch((err) => {
+      mostRecentError.name = err.name
+      mostRecentError.message = err.message
+    })
+    .catch((err) => mostRecentError = err)
+    // Pass or fail, we always clear the automationPromise, so future retries know there's no live request to the server.
+    .finally(() => automationPromise = null)
+
+    return automationPromise
+  }
+
+  this.set('onFail', (err, timedOut) => {
+    // if we are actively retrying or the assertion failed, we want to retry
+    if (err.name === 'TitleNotYetAvailableError' || err.name === 'AssertionError') {
+      // tslint:disable-next-line no-floating-promises
+      getTitleFromAutomation()
+    } else {
+      throw err
+    }
+  })
+
+  return () => {
+    if (documentTitle !== null) {
+      return documentTitle
+    }
+
+    // tslint:disable-next-line no-floating-promises
+    getTitleFromAutomation()
+
+    throw mostRecentError
+  }
+}