Merge pull request #7162 from sainthkh/decaff-driver-2

packages/driver/src/cy/commands/location.js

@@ -0,0 +1,100 @@
+const _ = require('lodash')
+const Promise = require('bluebird')
+
+const $errUtils = require('../../cypress/error_utils')
+
+module.exports = (Commands, Cypress, cy) => {
+  Commands.addAll({
+    url (options = {}) {
+      const userOptions = options
+
+      options = _.defaults({}, userOptions, { log: true })
+
+      if (options.log !== false) {
+        options._log = Cypress.log({
+          message: '',
+        })
+      }
+
+      const getHref = () => {
+        return cy.getRemoteLocation('href')
+      }
+
+      const resolveHref = () => {
+        return Promise.try(getHref).then((href) => {
+          return cy.verifyUpcomingAssertions(href, options, {
+            onRetry: resolveHref,
+          })
+        })
+      }
+
+      return resolveHref()
+    },
+
+    hash (options = {}) {
+      const userOptions = options
+
+      options = _.defaults({}, userOptions, { log: true })
+
+      if (options.log !== false) {
+        options._log = Cypress.log({
+          message: '',
+        })
+      }
+
+      const getHash = () => {
+        return cy.getRemoteLocation('hash')
+      }
+
+      const resolveHash = () => {
+        return Promise.try(getHash).then((hash) => {
+          return cy.verifyUpcomingAssertions(hash, options, {
+            onRetry: resolveHash,
+          })
+        })
+      }
+
+      return resolveHash()
+    },
+
+    location (key, options) {
+      let userOptions = options
+
+      // normalize arguments allowing key + options to be undefined
+      // key can represent the options
+      if (_.isObject(key) && _.isUndefined(userOptions)) {
+        userOptions = key
+      }
+
+      userOptions = userOptions || {}
+
+      options = _.defaults({}, userOptions, { log: true })
+
+      const getLocation = () => {
+        const location = cy.getRemoteLocation()
+
+        return _.isString(key)
+          // use existential here because we only want to throw
+          // on null or undefined values (and not empty strings)
+          ? location[key] ?? $errUtils.throwErrByPath('location.invalid_key', { args: { key } })
+          : location
+      }
+
+      if (options.log !== false) {
+        options._log = Cypress.log({
+          message: key != null ? key : '',
+        })
+      }
+
+      const resolveLocation = () => {
+        return Promise.try(getLocation).then((ret) => {
+          return cy.verifyUpcomingAssertions(ret, options, {
+            onRetry: resolveLocation,
+          })
+        })
+      }
+
+      return resolveLocation()
+    },
+  })
+}

packages/driver/src/cy/commands/misc.js

@@ -0,0 +1,58 @@
+const _ = require('lodash')
+
+const $dom = require('../../dom')
+
+module.exports = (Commands, Cypress, cy) => {
+  Commands.addAll({ prevSubject: 'optional' }, {
+    end () {
+      return null
+    },
+  })
+
+  Commands.addAll({
+    noop (arg) {
+      return arg
+    },
+
+    log (msg, args) {
+      Cypress.log({
+        end: true,
+        snapshot: true,
+        message: [msg, args],
+        consoleProps () {
+          return {
+            message: msg,
+            args,
+          }
+        },
+      })
+
+      return null
+    },
+
+    wrap (arg, options = {}) {
+      const userOptions = options
+
+      options = _.defaults({}, userOptions, { log: true })
+
+      if (options.log !== false) {
+        options._log = Cypress.log({
+          message: arg,
+        })
+
+        if ($dom.isElement(arg)) {
+          options._log.set({ $el: arg })
+        }
+      }
+
+      const resolveWrap = () => {
+        return cy.verifyUpcomingAssertions(arg, options, {
+          onRetry: resolveWrap,
+        })
+        .return(arg)
+      }
+
+      return resolveWrap()
+    },
+  })
+}