How to use resolveWindowReference method in Cypress

1const _ = require('lodash')2const $ = require('jquery')3const chai = require('chai')4const blobUtil = require('blob-util')5const minimatch = require('minimatch')6const moment = require('moment')7const Promise = require('bluebird')8// const sinon = require('sinon')9const lolex = require('lolex')10const $dom = require('./dom')11const $errorMessages = require('./cypress/error_messages')12const $Chainer = require('./cypress/chainer')13const $Command = require('./cypress/command')14const $Commands = require('./cypress/commands')15const $Cookies = require('./cypress/cookies')16const $Cy = require('./cypress/cy')17const $Events = require('./cypress/events')18const $FirefoxForcedGc = require('./util/firefox_forced_gc')19const $Keyboard = require('./cy/keyboard')20const $SetterGetter = require('./cypress/setter_getter')21const $Log = require('./cypress/log')22const $Location = require('./cypress/location')23const $LocalStorage = require('./cypress/local_storage')24// const $Mocha = require('./cypress/mocha')25const $Mouse = require('./cy/mouse')26// const $Runner = require('./cypress/runner')27// const $Server = require('./cypress/server')28const $Screenshot = require('./cypress/screenshot')29const $SelectorPlayground = require('./cypress/selector_playground')30const $utils = require('./cypress/utils')31const $errUtils = require('./cypress/error_utils')32// const $scriptUtils = require('./cypress/script_utils')33const browserInfo = require('./cypress/browser')34const resolvers = require('./cypress/resolvers')35const debug = require('debug')('cypress:driver:cypress')36const jqueryProxyFn = function (...args) {37  if (!this.cy) {38    $errUtils.throwErrByPath('miscellaneous.no_cy')39  }40  return this.cy.$$.apply(this.cy, args)41}42_.extend(jqueryProxyFn, $)43// provide the old interface and44// throw a deprecation message45$Log.command = () => {46  return $errUtils.throwErrByPath('miscellaneous.command_log_renamed')47}48const throwDeprecatedCommandInterface = (key = 'commandName', method) => {49  let signature = ''50  switch (method) {51    case 'addParentCommand':52      signature = `'${key}', function(){...}`53      break54    case 'addChildCommand':55      signature = `'${key}', { prevSubject: true }, function(){...}`56      break57    case 'addDualCommand':58      signature = `'${key}', { prevSubject: 'optional' }, function(){...}`59      break60    default:61      break62  }63  $errUtils.throwErrByPath('miscellaneous.custom_command_interface_changed', {64    args: { method, signature },65  })66}67const throwPrivateCommandInterface = (method) => {68  $errUtils.throwErrByPath('miscellaneous.private_custom_command_interface', {69    args: { method },70  })71}72class $Cypress {73  constructor(config = {}) {74    this.cy = null75    this.chai = null76    this.mocha = null77    this.runner = null78    this.Commands = null79    this.$autIframe = null80    this.onSpecReady = null81    this.events = $Events.extend(this)82    this.setConfig(config)83  }84  setConfig(config = {}) {85    // config.remote86    // {87    //   origin: "http://localhost:2020"88    //   domainName: "localhost"89    //   props: null90    //   strategy: "file"91    // }92    // -- or --93    // {94    //   origin: "https://foo.google.com"95    //   domainName: "google.com"96    //   strategy: "http"97    //   props: {98    //     port: 44399    //     tld: "com"100    //     domain: "google"101    //   }102    // }103    let d = config.remote ? config.remote.domainName : undefined104    // set domainName but allow us to turn105    // off this feature in testing106    if (d) {107      document.domain = d108    }109    // a few static props for the host OS, browser110    // and the current version of Cypress111    this.arch = config.arch112    this.spec = config.spec113    this.version = config.version114    this.browser = config.browser115    this.platform = config.platform116    // normalize this into boolean117    config.isTextTerminal = !!config.isTextTerminal118    // we asumme we're interactive based on whether or119    // not we're in a text terminal, but we keep this120    // as a separate property so we can potentially121    // slice up the behavior122    config.isInteractive = !config.isTextTerminal123    // enable long stack traces when124    // we not are running headlessly125    // for debuggability but disable126    // them when running headlessly for127    // performance since users cannot128    // interact with the stack traces129    Promise.config({130      longStackTraces: config.isInteractive,131    })132    const { env } = config133    config = _.omit(134      config,135      'env',136      'remote',137      'resolved',138      'scaffoldedFiles',139      'javascripts',140      'state'141    )142    _.extend(this, browserInfo(config))143    this.state = $SetterGetter.create({})144    this.config = $SetterGetter.create(config)145    this.env = $SetterGetter.create(env)146    this.getFirefoxGcInterval = $FirefoxForcedGc.createIntervalGetter(147      this.config148    )149    this.Cookies = $Cookies.create(config.namespace, d)150    return this.action('cypress:config', config)151  }152  initialize({ $autIframe, onSpecReady }) {153    this.$autIframe = $autIframe154    this.onSpecReady = onSpecReady155  }156  run(fn) {157    if (!this.runner) {158      $errUtils.throwErrByPath('miscellaneous.no_runner')159    }160    return this.runner.run(fn)161  }162  // onSpecWindow is called as the spec window163  // is being served but BEFORE any of the actual164  // specs or support files have been downloaded165  // or parsed. we have not received any custom commands166  // at this point167  onSpecWindow(specWindow, scripts) {168    const logFn = (...args) => {169      // return this.log.apply(this, args)170    }171    // create cy and expose globally172    this.cy = $Cy.create(173      specWindow,174      this,175      this.Cookies,176      this.state,177      this.config,178      logFn179    )180    window.cy = this.cy181    this.isCy = this.cy.isCy182    this.log = $Log.create(this, this.cy, this.state, this.config)183    // this.mocha = $Mocha.create(specWindow, this)184    // this.runner = $Runner.create(specWindow, this.mocha, this, this.cy)185    // wire up command create to cy186    this.Commands = $Commands.create(this, this.cy, this.state, this.config)187    this.events.proxyTo(this.cy)188    $FirefoxForcedGc.install(this)189    // $scriptUtils190    //   .runScripts(specWindow, scripts)191    //   .catch((err) => {192    //     err = $errUtils.createUncaughtException('spec', err)193    //     this.runner.onScriptError(err)194    //   })195    //   .then(() => {196    //     this.cy.initialize(this.$autIframe)197    //     this.onSpecReady()198    //   })199  }200  action(eventName, ...args) {201    // normalizes all the various ways202    // other objects communicate intent203    // and 'action' to Cypress204    debug(eventName)205    switch (eventName) {206      case 'recorder:frame':207        return this.emit('recorder:frame', args[0])208      case 'cypress:stop':209        return this.emit('stop')210      case 'cypress:config':211        return this.emit('config', args[0])212      case 'runner:start':213        // mocha runner has begun running the tests214        this.emit('run:start')215        if (this.runner.getResumedAtTestIndex() !== null) {216          return217        }218        if (this.config('isTextTerminal')) {219          return this.emit('mocha', 'start', args[0])220        }221        break222      case 'runner:end':223        // mocha runner has finished running the tests224        // end may have been caused by an uncaught error225        // that happened inside of a hook.226        //227        // when this happens mocha aborts the entire run228        // and does not do the usual cleanup so that means229        // we have to fire the test:after:hooks and230        // test:after:run events ourselves231        this.emit('run:end')232        if (this.config('isTextTerminal')) {233          return this.emit('mocha', 'end', args[0])234        }235        break236      case 'runner:set:runnable':237        // when there is a hook / test (runnable) that238        // is about to be invoked239        return this.cy.setRunnable(...args)240      case 'runner:suite:start':241        // mocha runner started processing a suite242        if (this.config('isTextTerminal')) {243          return this.emit('mocha', 'suite', ...args)244        }245        break246      case 'runner:suite:end':247        // mocha runner finished processing a suite248        if (this.config('isTextTerminal')) {249          return this.emit('mocha', 'suite end', ...args)250        }251        break252      case 'runner:hook:start':253        // mocha runner started processing a hook254        if (this.config('isTextTerminal')) {255          return this.emit('mocha', 'hook', ...args)256        }257        break258      case 'runner:hook:end':259        // mocha runner finished processing a hook260        if (this.config('isTextTerminal')) {261          return this.emit('mocha', 'hook end', ...args)262        }263        break264      case 'runner:test:start':265        // mocha runner started processing a hook266        if (this.config('isTextTerminal')) {267          return this.emit('mocha', 'test', ...args)268        }269        break270      case 'runner:test:end':271        if (this.config('isTextTerminal')) {272          return this.emit('mocha', 'test end', ...args)273        }274        break275      case 'runner:pass':276        // mocha runner calculated a pass277        if (this.config('isTextTerminal')) {278          return this.emit('mocha', 'pass', ...args)279        }280        break281      case 'runner:pending':282        // mocha runner calculated a pending test283        if (this.config('isTextTerminal')) {284          return this.emit('mocha', 'pending', ...args)285        }286        break287      case 'runner:fail': {288        // mocha runner calculated a failure289        const err = args[0].err290        if (291          err.type === 'existence' ||292          $dom.isDom(err.actual) ||293          $dom.isDom(err.expected)294        ) {295          err.showDiff = false296        }297        if (err.actual) {298          err.actual = chai.util.inspect(err.actual)299        }300        if (err.expected) {301          err.expected = chai.util.inspect(err.expected)302        }303        if (this.config('isTextTerminal')) {304          return this.emit('mocha', 'fail', ...args)305        }306        break307      }308      case 'mocha:runnable:run':309        return this.runner.onRunnableRun(...args)310      case 'runner:test:before:run':311        // get back to a clean slate312        this.cy.reset()313        return this.emit('test:before:run', ...args)314      case 'runner:test:before:run:async':315        // TODO: handle timeouts here? or in the runner?316        return this.emitThen('test:before:run:async', ...args)317      case 'runner:runnable:after:run:async':318        return this.emitThen('runnable:after:run:async', ...args)319      case 'runner:test:after:run':320        this.runner.cleanupQueue(this.config('numTestsKeptInMemory'))321        // this event is how the reporter knows how to display322        // stats and runnable properties such as errors323        this.emit('test:after:run', ...args)324        if (this.config('isTextTerminal')) {325          // needed for calculating wallClockDuration326          // and the timings of after + afterEach hooks327          return this.emit('mocha', 'test:after:run', args[0])328        }329        break330      case 'cy:before:all:screenshots':331        return this.emit('before:all:screenshots', ...args)332      case 'cy:before:screenshot':333        return this.emit('before:screenshot', ...args)334      case 'cy:after:screenshot':335        return this.emit('after:screenshot', ...args)336      case 'cy:after:all:screenshots':337        return this.emit('after:all:screenshots', ...args)338      case 'command:log:added':339        // this.runner.addLog(args[0], this.config('isInteractive'))340        return this.emit('log:added', ...args)341      case 'command:log:changed':342        const event = args[0]343        console.log(`[${event.chainerId}]`, event.name, event.state, event)344        // this.runner.addLog(args[0], this.config('isInteractive'))345        return this.emit('log:changed', ...args)346      case 'cy:fail':347        // comes from cypress errors fail()348        return this.emitMap('fail', ...args)349      case 'cy:stability:changed':350        return this.emit('stability:changed', ...args)351      case 'cy:paused':352        return this.emit('paused', ...args)353      case 'cy:canceled':354        return this.emit('canceled')355      case 'cy:visit:failed':356        return this.emit('visit:failed', args[0])357      case 'cy:viewport:changed':358        return this.emit('viewport:changed', ...args)359      case 'cy:command:start':360        return this.emit('command:start', ...args)361      case 'cy:command:end':362        return this.emit('command:end', ...args)363      case 'cy:command:retry':364        return this.emit('command:retry', ...args)365      case 'cy:command:enqueued':366        return this.emit('command:enqueued', args[0])367      case 'cy:command:queue:before:end':368        return this.emit('command:queue:before:end')369      case 'cy:command:queue:end':370        return this.emit('command:queue:end')371      case 'cy:url:changed':372        return this.emit('url:changed', args[0])373      case 'cy:next:subject:prepared':374        return this.emit('next:subject:prepared', ...args)375      case 'cy:collect:run:state':376        return this.emitThen('collect:run:state')377      case 'cy:scrolled':378        return this.emit('scrolled', ...args)379      case 'app:uncaught:exception':380        return this.emitMap('uncaught:exception', ...args)381      case 'app:window:alert':382        return this.emit('window:alert', args[0])383      case 'app:window:confirm':384        return this.emitMap('window:confirm', args[0])385      case 'app:window:confirmed':386        return this.emit('window:confirmed', ...args)387      case 'app:page:loading':388        return this.emit('page:loading', args[0])389      case 'app:window:before:load':390        this.cy.onBeforeAppWindowLoad(args[0])391        return this.emit('window:before:load', args[0])392      case 'app:navigation:changed':393        return this.emit('navigation:changed', ...args)394      case 'app:form:submitted':395        return this.emit('form:submitted', args[0])396      case 'app:window:load':397        return this.emit('window:load', args[0])398      case 'app:window:before:unload':399        return this.emit('window:before:unload', args[0])400      case 'app:window:unload':401        return this.emit('window:unload', args[0])402      case 'app:css:modified':403        return this.emit('css:modified', args[0])404      case 'spec:script:error':405        return this.emit('script:error', ...args)406      default:407        return408    }409  }410  backend(eventName, ...args) {411    return new Promise((resolve, reject) => {412      const fn = function (reply) {413        const e = reply.error414        if (e) {415          // clone the error object416          // and set stack cleaned417          // to prevent bluebird from418          // attaching long stace traces419          // which otherwise make this err420          // unusably long421          const err = $errUtils.makeErrFromObj(e)422          err.__stackCleaned__ = true423          err.backend = true424          return reject(err)425        }426        return resolve(reply.response)427      }428      return this.emit('backend:request', eventName, ...args, fn)429    })430  }431  automation(eventName, ...args) {432    // wrap action in promise433    return new Promise((resolve, reject) => {434      const fn = function (reply) {435        const e = reply.error436        if (e) {437          const err = $errUtils.makeErrFromObj(e)438          err.automation = true439          return reject(err)440        }441        return resolve(reply.response)442      }443      return this.emit('automation:request', eventName, ...args, fn)444    })445  }446  stop() {447    this.runner.stop()448    this.cy.stop()449    return this.action('cypress:stop')450  }451  addChildCommand(key) {452    return throwDeprecatedCommandInterface(key, 'addChildCommand')453  }454  addParentCommand(key) {455    return throwDeprecatedCommandInterface(key, 'addParentCommand')456  }457  addDualCommand(key) {458    return throwDeprecatedCommandInterface(key, 'addDualCommand')459  }460  addAssertionCommand() {461    return throwPrivateCommandInterface('addAssertionCommand')462  }463  addUtilityCommand() {464    return throwPrivateCommandInterface('addUtilityCommand')465  }466  static create(config) {467    return new $Cypress(config)468  }469}470$Cypress.prototype.$ = jqueryProxyFn471// attach to $Cypress to access472// all of the constructors473// to enable users to monkeypatch474$Cypress.prototype.$Cypress = $Cypress475$Cypress.prototype.Cy = $Cy476$Cypress.prototype.Chainer = $Chainer477$Cypress.prototype.Cookies = $Cookies478$Cypress.prototype.Command = $Command479$Cypress.prototype.Commands = $Commands480$Cypress.prototype.dom = $dom481$Cypress.prototype.errorMessages = $errorMessages482$Cypress.prototype.Keyboard = $Keyboard483$Cypress.prototype.Location = $Location484$Cypress.prototype.Log = $Log485$Cypress.prototype.LocalStorage = $LocalStorage486// $Cypress.prototype.Mocha = $Mocha487$Cypress.prototype.resolveWindowReference = resolvers.resolveWindowReference488$Cypress.prototype.resolveLocationReference = resolvers.resolveLocationReference489$Cypress.prototype.Mouse = $Mouse490// $Cypress.prototype.Runner = $Runner491// $Cypress.prototype.Server = $Server492$Cypress.prototype.Screenshot = $Screenshot493$Cypress.prototype.SelectorPlayground = $SelectorPlayground494$Cypress.prototype.utils = $utils495$Cypress.prototype._ = _496$Cypress.prototype.moment = moment497$Cypress.prototype.Blob = blobUtil498$Cypress.prototype.Promise = Promise499$Cypress.prototype.minimatch = minimatch500// $Cypress.prototype.sinon = sinon501$Cypress.prototype.lolex = lolex502// attaching these so they are accessible503// via the runner + integration spec helper504$Cypress.$ = $505window.cy = $Cypress...

...11 * @param accessedObject object being accessed12 * @param prop name of property being accessed13 * @param maybeVal if an assignment is being made, this is the RHS of the assignment14 */15function resolveWindowReference(accessedObject, prop, maybeVal) {16    var args = [17        globalIdentifier,18        accessedObject,19        ast_types_1.builders.stringLiteral(prop),20    ];21    if (maybeVal) {22        args.push(maybeVal);23    }24    return ast_types_1.builders.callExpression(ast_types_1.builders.memberExpression(ast_types_1.builders.memberExpression(ast_types_1.builders.memberExpression(globalIdentifier, ast_types_1.builders.identifier('top')), ast_types_1.builders.identifier('Cypress')), ast_types_1.builders.identifier('resolveWindowReference')), args);25}26/**27 * Generate a CallExpression for Cypress.resolveLocationReference28 */29function resolveLocationReference() {30    return ast_types_1.builders.callExpression(ast_types_1.builders.memberExpression(ast_types_1.builders.memberExpression(ast_types_1.builders.memberExpression(globalIdentifier, ast_types_1.builders.identifier('top')), ast_types_1.builders.identifier('Cypress')), ast_types_1.builders.identifier('resolveLocationReference')), [globalIdentifier]);31}32/**33 * Given an Identifier or a Literal, return a property name that should use `resolveWindowReference`.34 * @param node35 */36function getReplaceablePropOfMemberExpression(node) {37    var property = node.property;38    // something.(top|parent)39    if (ast_types_1.namedTypes.Identifier.check(property) && ['parent', 'top', 'location'].includes(property.name)) {40        return property.name;41    }42    // something['(top|parent)']43    if (ast_types_1.namedTypes.Literal.check(property) && ['parent', 'top', 'location'].includes(String(property.value))) {44        return String(property.value);45    }46    // NOTE: cases where a variable is used for the prop will not be replaced47    // for example, `bar = 'top'; window[bar];` will not be replaced48    // this would most likely be too slow49    return;50}51/**52 * An AST Visitor that applies JS transformations required for Cypress.53 * @see https://github.com/benjamn/ast-types#ast-traversal for details on how the Visitor is implemented54 * @see https://astexplorer.net/#/gist/7f1e645c74df845b0e1f814454e9bbdf/f443b701b53bf17fbbf40e9285cb8b65a406624055 *  to explore ASTs generated by recast56 */57exports.jsRules = {58    // replace member accesses like foo['top'] or bar.parent with resolveWindowReference59    visitMemberExpression: function (path) {60        var node = path.node;61        var prop = getReplaceablePropOfMemberExpression(node);62        if (!prop) {63            return this.traverse(path);64        }65        path.replace(resolveWindowReference(path.get('object').node, prop));66        return false;67    },68    // replace lone identifiers like `top`, `parent`, with resolveWindowReference69    visitIdentifier: function (path) {70        var node = path.node;71        if (path.parentPath) {72            var parentNode = path.parentPath.node;73            // like `identifer = 'foo'`74            var isAssignee = ast_types_1.namedTypes.AssignmentExpression.check(parentNode) && parentNode.left === node;75            if (isAssignee && node.name === 'location') {76                // `location = 'something'`, rewrite to intercepted href setter since relative urls can break this77                path.replace(ast_types_1.builders.memberExpression(resolveLocationReference(), ast_types_1.builders.identifier('href')));78                return false;79            }80            // some Identifiers do not refer to a scoped variable, depending on how they're used81            if (82            // like `var top = 'foo'`83            (ast_types_1.namedTypes.VariableDeclarator.check(parentNode) && parentNode.id === node)84                || (isAssignee)85                || ([86                    'LabeledStatement',87                    'ContinueStatement',88                    'BreakStatement',89                    'Property',90                    'FunctionDeclaration',91                    'RestElement',92                    'ArrowFunctionExpression',93                    'ArrowExpression',94                    'FunctionExpression',95                ].includes(parentNode.type))) {96                return false;97            }98        }99        if (path.scope.declares(node.name)) {100            // identifier has been declared in local scope, don't care about replacing101            return this.traverse(path);102        }103        if (node.name === 'location') {104            path.replace(resolveLocationReference());105            return false;106        }107        if (['parent', 'top'].includes(node.name)) {108            path.replace(resolveWindowReference(globalIdentifier, node.name));109            return false;110        }111        this.traverse(path);112    },113    visitAssignmentExpression: function (path) {114        var _this = this;115        var node = path.node;116        var finish = function () {117            _this.traverse(path);118        };119        if (!ast_types_1.namedTypes.MemberExpression.check(node.left)) {120            return finish();121        }122        var propBeingSet = getReplaceablePropOfMemberExpression(node.left);123        if (!propBeingSet) {124            return finish();125        }126        if (node.operator !== '=') {127            // in the case of +=, -=, |=, etc., assume they're not doing something like128            // `window.top += 4` since that would be invalid anyways, just continue down the RHS129            this.traverse(path.get('right'));130            return false;131        }132        var objBeingSetOn = node.left.object;133        path.replace(resolveWindowReference(objBeingSetOn, propBeingSet, node.right));134        return false;135    },...