- {' '}
- Learn More
+ Learn more
A Record Key sends your failing tests, screenshots, and videos to your{' '}
diff --git a/packages/desktop-gui/src/settings/settings.jsx b/packages/desktop-gui/src/settings/settings.jsx
index b111f35367e6..6415ab776776 100644
--- a/packages/desktop-gui/src/settings/settings.jsx
+++ b/packages/desktop-gui/src/settings/settings.jsx
@@ -9,6 +9,7 @@ import ProjectId from './project-id'
import RecordKey from './record-key'
import ProxySettings from './proxy-settings'
import NodeVersion from './node-version'
+import FilePreference from './file-preference'
import Experiments from './experiments'
import { getExperiments, experimental } from '@packages/server/lib/experiments'
@@ -45,10 +46,13 @@ const Settings = observer(({ project, app }) => {
- {hasExperiments &&
-
-
+
+
+ {hasExperiments &&
+
+
+
}
diff --git a/packages/desktop-gui/src/settings/settings.scss b/packages/desktop-gui/src/settings/settings.scss
index a9934393f0d4..428789e2d035 100644
--- a/packages/desktop-gui/src/settings/settings.scss
+++ b/packages/desktop-gui/src/settings/settings.scss
@@ -245,6 +245,20 @@
}
}
+.editor-picker {
+ margin: 0;
+ padding: 0;
+
+ li {
+ list-style: none;
+ }
+
+ label {
+ margin: 0;
+ font-weight: normal;
+ }
+}
+
.experiment-intro {
padding-bottom: 15px;
margin-bottom: 0px;
diff --git a/packages/desktop-gui/webpack.config.ts b/packages/desktop-gui/webpack.config.ts
index 1a4beb59830c..de73af77c700 100644
--- a/packages/desktop-gui/webpack.config.ts
+++ b/packages/desktop-gui/webpack.config.ts
@@ -1,8 +1,10 @@
-import commonConfig, { HtmlWebpackPlugin } from '@packages/web-config/webpack.config.base'
+import getCommonConfig, { HtmlWebpackPlugin } from '@packages/web-config/webpack.config.base'
import path from 'path'
+import webpack from 'webpack'
-const config: typeof commonConfig = {
- ...commonConfig,
+// @ts-ignore
+const config: webpack.Configuration = {
+ ...getCommonConfig(),
entry: {
app: [require.resolve('@babel/polyfill'), path.resolve(__dirname, 'src/main')],
},
@@ -26,7 +28,10 @@ config.plugins = [
config.resolve = {
...config.resolve,
alias: {
+ 'bluebird': require.resolve('bluebird'),
'lodash$': require.resolve('lodash'),
+ 'mobx': require.resolve('mobx'),
+ 'mobx-react': require.resolve('mobx-react'),
'react': require.resolve('react'),
'react-dom': require.resolve('react-dom'),
},
diff --git a/packages/driver/package.json b/packages/driver/package.json
index ef7728ffce0c..1b738037413e 100644
--- a/packages/driver/package.json
+++ b/packages/driver/package.json
@@ -10,6 +10,7 @@
"start": "$(yarn bin coffee) test/support/server.coffee"
},
"devDependencies": {
+ "@babel/code-frame": "^7.0.0",
"@cypress/bower-kendo-ui": "0.0.2",
"@cypress/sinon-chai": "1.1.0",
"@cypress/underscore.inflection": "1.0.1",
@@ -37,6 +38,7 @@
"cors": "2.8.5",
"cypress-multi-reporters": "1.2.4",
"debug": "4.1.1",
+ "error-stack-parser": "2.0.6",
"errorhandler": "1.5.1",
"eventemitter2": "4.1.2",
"express": "4.16.4",
@@ -60,6 +62,7 @@
"react-dom-16.0.0": "npm:react-dom@16.0.0",
"setimmediate": "1.0.5",
"sinon": "8.1.1",
+ "source-map": "0.7.3",
"text-mask-addons": "3.8.0",
"underscore": "1.9.1",
"underscore.string": "3.3.5",
diff --git a/packages/driver/src/cy/assertions.js b/packages/driver/src/cy/assertions.js
index d18dacbb8257..658a7a476204 100644
--- a/packages/driver/src/cy/assertions.js
+++ b/packages/driver/src/cy/assertions.js
@@ -111,6 +111,10 @@ const create = function (state, queue, retryFn) {
// them up with existing ones
cmd.set('assertionIndex', 0)
+ if (state('current') != null) {
+ state('current').set('currentAssertionCommand', cmd)
+ }
+
return cmd.get('fn').originalFn.apply(
state('ctx'),
[subject].concat(cmd.get('args')),
@@ -202,6 +206,8 @@ const create = function (state, queue, retryFn) {
err = e2
}
+ err.isDefaultAssertionErr = isDefaultAssertionErr
+
options.error = err
if (err.retry === false) {
diff --git a/packages/driver/src/cy/chai.js b/packages/driver/src/cy/chai.js
index ba6bca9ce2d1..b78ed33faba1 100644
--- a/packages/driver/src/cy/chai.js
+++ b/packages/driver/src/cy/chai.js
@@ -9,6 +9,7 @@ const sinonChai = require('@cypress/sinon-chai')
const $dom = require('../dom')
const $utils = require('../cypress/utils')
const $errUtils = require('../cypress/error_utils')
+const $stackUtils = require('../cypress/stack_utils')
const $chaiJquery = require('../cypress/chai_jquery')
const chaiInspect = require('./chai/inspect')
@@ -198,8 +199,8 @@ chai.use((chai, u) => {
}
}
- const overrideChaiAsserts = function (specWindow, assertFn) {
- chai.Assertion.prototype.assert = createPatchedAssert(specWindow, assertFn)
+ const overrideChaiAsserts = function (specWindow, state, assertFn) {
+ chai.Assertion.prototype.assert = createPatchedAssert(specWindow, state, assertFn)
const _origGetmessage = function (obj, args) {
const negate = chaiUtils.flag(obj, 'negate')
@@ -414,7 +415,29 @@ chai.use((chai, u) => {
})
}
- const createPatchedAssert = (specWindow, assertFn) => {
+ const captureUserInvocationStack = (specWindow, state, ssfi) => {
+ let userInvocationStack
+
+ // we need a user invocation stack with the top line being the point where
+ // the error occurred for the sake of the code frame
+ // in chrome, stack lines from another frame don't appear in the
+ // error. specWindow.Error works for our purposes because it
+ // doesn't include anything extra (chai.Assertion error doesn't work
+ // because it doesn't have lines from the spec iframe)
+ // in firefox, specWindow.Error has too many extra lines at the
+ // beginning, but chai.AssertionError helps us winnow those down
+ if ($stackUtils.hasCrossFrameStacks(specWindow)) {
+ userInvocationStack = (new chai.AssertionError('uis', {}, ssfi)).stack
+ } else {
+ userInvocationStack = (new specWindow.Error()).stack
+ }
+
+ userInvocationStack = $stackUtils.normalizedUserInvocationStack(userInvocationStack)
+
+ state('currentAssertionUserInvocationStack', userInvocationStack)
+ }
+
+ const createPatchedAssert = (specWindow, state, assertFn) => {
return (function (...args) {
let err
const passed = chaiUtils.test(this, args)
@@ -438,39 +461,44 @@ chai.use((chai, u) => {
if (!err) return
- // stack from chai AssertionError instances are useless, because
- // the chai code is served from `top`, which binds to `top`'s Error
- // but assertions fail inside the spec window and then err.stack
- // will not include the frames from the spec window (a different window)
- // for security purposes. therefore, we instantiate a new error on
- // the spec window to get a better stack
- const betterStackErr = new specWindow.Error(err.message)
-
- err.stack = $errUtils.replacedStack(err, betterStackErr)
+ // when assert() is used instead of expect(), we override the method itself
+ // below in `overrideAssert` and prefer the user invocation stack
+ // that we capture there
+ if (!state('assertUsed')) {
+ captureUserInvocationStack(specWindow, state, chaiUtils.flag(this, 'ssfi'))
+ }
throw err
})
}
- const overrideExpect = () => {
+ const overrideExpect = (specWindow, state) => {
// only override assertions for this specific
// expect function instance so we do not affect
// the outside world
return (val, message) => {
+ captureUserInvocationStack(specWindow, state, overrideExpect)
+
// make the assertion
return new chai.Assertion(val, message)
}
}
- const overrideAssert = function () {
+ const overrideAssert = function (specWindow, state) {
const fn = (express, errmsg) => {
+ state('assertUsed', true)
+ captureUserInvocationStack(specWindow, state, fn)
+
return chai.assert(express, errmsg)
}
const fns = _.functions(chai.assert)
_.each(fns, (name) => {
- return fn[name] = function () {
+ fn[name] = function () {
+ state('assertUsed', true)
+ captureUserInvocationStack(specWindow, state, overrideAssert)
+
return chai.assert[name].apply(this, arguments)
}
})
@@ -478,9 +506,9 @@ chai.use((chai, u) => {
return fn
}
- const setSpecWindowGlobals = function (specWindow, assertFn) {
- const expect = overrideExpect()
- const assert = overrideAssert()
+ const setSpecWindowGlobals = function (specWindow, state) {
+ const expect = overrideExpect(specWindow, state)
+ const assert = overrideAssert(specWindow, state)
specWindow.chai = chai
specWindow.expect = expect
@@ -493,15 +521,14 @@ chai.use((chai, u) => {
}
}
- const create = function (specWindow, assertFn) {
- // restoreOverrides()
+ const create = function (specWindow, state, assertFn) {
restoreAsserts()
overrideChaiInspect()
overrideChaiObjDisplay()
- overrideChaiAsserts(specWindow, assertFn)
+ overrideChaiAsserts(specWindow, state, assertFn)
- return setSpecWindowGlobals(specWindow)
+ return setSpecWindowGlobals(specWindow, state)
}
module.exports = {
@@ -511,8 +538,6 @@ chai.use((chai, u) => {
setSpecWindowGlobals,
- // overrideChai: overrideChai
-
restoreAsserts,
overrideExpect,
diff --git a/packages/driver/src/cy/commands/asserting.js b/packages/driver/src/cy/commands/asserting.js
index 754a03c5b085..2db2de5e2ac1 100644
--- a/packages/driver/src/cy/commands/asserting.js
+++ b/packages/driver/src/cy/commands/asserting.js
@@ -8,14 +8,20 @@ const reExistence = /exist/
const reEventually = /^eventually/
const reHaveLength = /length/
-module.exports = function (Commands, Cypress, cy) {
+module.exports = function (Commands, Cypress, cy, state) {
const shouldFnWithCallback = function (subject, fn) {
+ state('current')?.set('followedByShouldCallback', true)
+
return Promise
.try(() => {
const remoteSubject = cy.getRemotejQueryInstance(subject)
return fn.call(this, remoteSubject ? remoteSubject : subject)
- }).return(subject)
+ })
+ .tap(() => {
+ state('current')?.set('followedByShouldCallback', false)
+ })
+ .return(subject)
}
const shouldFn = function (subject, chainers, ...args) {
diff --git a/packages/driver/src/cy/commands/commands.js b/packages/driver/src/cy/commands/commands.js
index 2f40438e1085..23ebdbb98471 100644
--- a/packages/driver/src/cy/commands/commands.js
+++ b/packages/driver/src/cy/commands/commands.js
@@ -17,7 +17,8 @@ const command = function (ctx, name, ...args) {
module.exports = function (Commands, Cypress, cy) {
Commands.addChainer({
- command (chainer, args) {
+ // userInvocationStack has to be passed in here, but can be ignored
+ command (chainer, userInvocationStack, args) {
return command(chainer, ...args)
},
})
diff --git a/packages/driver/src/cy/commands/cookies.js b/packages/driver/src/cy/commands/cookies.js
index b16b1fbbe89d..fb8850789ca3 100644
--- a/packages/driver/src/cy/commands/cookies.js
+++ b/packages/driver/src/cy/commands/cookies.js
@@ -124,10 +124,15 @@ module.exports = function (Commands, Cypress, cy, state, config) {
action,
cmd: command,
browserDisplayName: Cypress.browser.displayName,
- errMessage: err.message,
- errStack: err.stack,
+ error: err,
},
onFail,
+ errProps: {
+ appendToStack: {
+ title: 'From Node.js Internals',
+ content: err.stack,
+ },
+ },
})
}
}
diff --git a/packages/driver/src/cy/commands/files.js b/packages/driver/src/cy/commands/files.js
index cda87d0c1f96..75fb740801f5 100644
--- a/packages/driver/src/cy/commands/files.js
+++ b/packages/driver/src/cy/commands/files.js
@@ -2,7 +2,6 @@ const _ = require('lodash')
const Promise = require('bluebird')
const $errUtils = require('../../cypress/error_utils')
-const $errMessages = require('../../cypress/error_messages')
module.exports = (Commands, Cypress, cy) => {
Commands.addAll({
@@ -62,11 +61,11 @@ module.exports = (Commands, Cypress, cy) => {
return
}
- const { message, docsUrl } = (contents != null)
- // file exists but it shouldn't
- ? $errUtils.errObjByPath($errMessages, 'files.existent', { file, filePath })
- // file doesn't exist but it should
- : $errUtils.errObjByPath($errMessages, 'files.nonexistent', { file, filePath })
+ // file exists but it shouldn't - or - file doesn't exist but it should
+ const errPath = contents ? 'files.existent' : 'files.nonexistent'
+ const { message, docsUrl } = $errUtils.cypressErrByPath(errPath, {
+ args: { file, filePath },
+ })
err.message = message
err.docsUrl = docsUrl
diff --git a/packages/driver/src/cy/commands/navigation.js b/packages/driver/src/cy/commands/navigation.js
index 80b53a4eebd7..efdca3d0a809 100644
--- a/packages/driver/src/cy/commands/navigation.js
+++ b/packages/driver/src/cy/commands/navigation.js
@@ -771,8 +771,13 @@ module.exports = (Commands, Cypress, cy, state, config) => {
// the onLoad callback should only be skipped if specified
if (runOnLoadCallback !== false) {
- if (options.onLoad != null) {
- options.onLoad.call(runnable.ctx, win)
+ try {
+ options.onLoad?.call(runnable.ctx, win)
+ } catch (err) {
+ // mark these as onLoad errors, so they're treated differently
+ // than Node.js errors when caught below
+ err.isOnLoadError = true
+ throw err
}
}
@@ -981,6 +986,15 @@ module.exports = (Commands, Cypress, cy, state, config) => {
args,
})
})
+
+ return
+ }
+
+ // if it came from the user's onLoad callback, it's not a network
+ // failure, and we should just throw the original error
+ if (err.isOnLoadError) {
+ delete err.isOnLoadError
+ throw err
}
visitFailedByErr(err, url, () => {
@@ -989,9 +1003,13 @@ module.exports = (Commands, Cypress, cy, state, config) => {
args: {
url,
error: err,
- stack: err.stack,
},
- noStackTrace: true,
+ errProps: {
+ appendToStack: {
+ title: 'From Node.js Internals',
+ content: err.stack,
+ },
+ },
})
})
})
diff --git a/packages/driver/src/cy/commands/request.js b/packages/driver/src/cy/commands/request.js
index a368b0aad3c1..17abb809f4ea 100644
--- a/packages/driver/src/cy/commands/request.js
+++ b/packages/driver/src/cy/commands/request.js
@@ -306,11 +306,15 @@ module.exports = (Commands, Cypress, cy, state, config) => {
onFail: options._log,
args: {
error: err.message,
- stack: err.stack,
method: requestOpts.method,
url: requestOpts.url,
},
- noStackTrace: true,
+ errProps: {
+ appendToStack: {
+ title: 'From Node.js Internals',
+ content: err.stack,
+ },
+ },
})
})
},
diff --git a/packages/driver/src/cy/commands/task.js b/packages/driver/src/cy/commands/task.js
index f8ab36fa5fbc..10ebf2d135e2 100644
--- a/packages/driver/src/cy/commands/task.js
+++ b/packages/driver/src/cy/commands/task.js
@@ -3,6 +3,7 @@ const Promise = require('bluebird')
const $utils = require('../../cypress/utils')
const $errUtils = require('../../cypress/error_utils')
+const $stackUtils = require('../../cypress/stack_utils')
module.exports = (Commands, Cypress, cy) => {
Commands.addAll({
@@ -72,24 +73,24 @@ module.exports = (Commands, Cypress, cy) => {
args: { task, timeout: options.timeout, error: error.message },
})
})
- .catch((error) => {
+ .catch((err) => {
// re-throw if timedOut error from above
- if (error.name === 'CypressError') {
- throw error
+ if ($errUtils.isCypressErr(err)) {
+ throw err
}
- $errUtils.normalizeErrorStack(error)
+ err.stack = $stackUtils.normalizedStack(err)
- if (error?.isKnownError) {
+ if (err?.isKnownError) {
$errUtils.throwErrByPath('task.known_error', {
onFail: options._log,
- args: { task, error: error.message },
+ args: { task, error: err.message },
})
}
$errUtils.throwErrByPath('task.failed', {
onFail: options._log,
- args: { task, error: error?.stack || error?.message || error },
+ args: { task, error: err?.stack || err?.message || err },
})
})
},
diff --git a/packages/driver/src/cy/commands/waiting.js b/packages/driver/src/cy/commands/waiting.js
index 4b42383083eb..507820623d6e 100644
--- a/packages/driver/src/cy/commands/waiting.js
+++ b/packages/driver/src/cy/commands/waiting.js
@@ -70,12 +70,12 @@ module.exports = (Commands, Cypress, cy, state) => {
return Promise.resolve(xhr)
}
- options.error = $errUtils.errMsgByPath('wait.timed_out', {
+ options.error = $errUtils.errByPath('wait.timed_out', {
timeout: options.timeout,
alias,
num,
type,
- })
+ }).message
const args = [alias, type, index, num, options]
diff --git a/packages/driver/src/cy/commands/xhr.js b/packages/driver/src/cy/commands/xhr.js
index 579e1cab9cf1..d98f25f22f06 100644
--- a/packages/driver/src/cy/commands/xhr.js
+++ b/packages/driver/src/cy/commands/xhr.js
@@ -4,6 +4,7 @@ const Promise = require('bluebird')
const $utils = require('../../cypress/utils')
const $errUtils = require('../../cypress/error_utils')
+const $stackUtils = require('../../cypress/stack_utils')
const $Server = require('../../cypress/server')
const $Location = require('../../cypress/location')
@@ -221,10 +222,10 @@ const startXhrServer = (cy, state, config) => {
onXhrAbort: (xhr, stack) => {
setResponse(state, xhr)
- const err = new Error($errUtils.errMsgByPath('xhr.aborted'))
+ const err = $errUtils.errByPath('xhr.aborted')
err.name = 'AbortError'
- err.stack = stack
+ err.stack = $stackUtils.replacedStack(err, stack)
const log = logs[xhr.id]
diff --git a/packages/driver/src/cy/errors.js b/packages/driver/src/cy/errors.js
index d94ad17ced39..0c22ef21c286 100644
--- a/packages/driver/src/cy/errors.js
+++ b/packages/driver/src/cy/errors.js
@@ -1,7 +1,5 @@
-const _ = require('lodash')
const $dom = require('../dom')
const $errUtils = require('../cypress/error_utils')
-const $errorMessages = require('../cypress/error_messages')
const crossOriginScriptRe = /^script error/i
@@ -35,58 +33,34 @@ const create = (state, config, log) => {
}
const createUncaughtException = (type, args) => {
- // @ts-ignore
let [msg, source, lineno, colno, err] = args // eslint-disable-line no-unused-vars
-
- const current = state('current')
+ let message
+ let docsUrl
// reset the msg on a cross origin script error
// since no details are accessible
if (crossOriginScriptRe.test(msg)) {
- msg = $errUtils.errMsgByPath('uncaught.cross_origin_script')
- }
-
- const createErrFromMsg = () => {
- return new Error($errUtils.errMsgByPath('uncaught.error', {
- msg, source, lineno,
- }))
- }
-
- // if we have the 5th argument it means we're in a super
- // modern browser making this super simple to work with.
- err = err ?? createErrFromMsg()
+ const crossOriginErr = $errUtils.errByPath('uncaught.cross_origin_script')
- let uncaughtErrLookup = ''
-
- if (type === 'app') {
- uncaughtErrLookup = 'uncaught.fromApp'
- } else if (type === 'spec') {
- uncaughtErrLookup = 'uncaught.fromSpec'
+ message = crossOriginErr.message
+ docsUrl = crossOriginErr.docsUrl
}
- const uncaughtErrObj = $errUtils.errObjByPath($errorMessages, uncaughtErrLookup)
-
- const uncaughtErrProps = $errUtils.modifyErrMsg(err, uncaughtErrObj.message, (msg1, msg2) => {
- return `${msg1}\n\n${msg2}`
+ // if we have the 5th argument it means we're in a modern browser with an
+ // error object already provided. otherwise, we create one
+ err = err ?? $errUtils.errByPath('uncaught.error', {
+ message, source, lineno,
})
- _.defaults(uncaughtErrProps, uncaughtErrObj)
-
- const uncaughtErr = $errUtils.mergeErrProps(err, uncaughtErrProps)
+ err.docsUrl = docsUrl
- $errUtils.modifyErrName(err, `Uncaught ${err.name}`)
+ const uncaughtErr = $errUtils.createUncaughtException(type, err)
+ const current = state('current')
uncaughtErr.onFail = () => {
- const l = current && current.getLastLog()
-
- if (l) {
- return l.error(uncaughtErr)
- }
+ current?.getLastLog()?.error(uncaughtErr)
}
- // normalize error message for firefox
- $errUtils.normalizeErrorStack(uncaughtErr)
-
return uncaughtErr
}
diff --git a/packages/driver/src/cy/retries.js b/packages/driver/src/cy/retries.js
index b1805721d12d..b80e1e258e19 100644
--- a/packages/driver/src/cy/retries.js
+++ b/packages/driver/src/cy/retries.js
@@ -1,6 +1,5 @@
const _ = require('lodash')
const Promise = require('bluebird')
-const debug = require('debug')('cypress:driver:retries')
const $errUtils = require('../cypress/error_utils')
@@ -36,14 +35,6 @@ const create = (Cypress, state, timeout, clearTimeout, whenStable, finishAsserti
let { error } = options
- // TODO: remove this once the codeframe PR is in since that
- // correctly handles not rewrapping errors so that stack
- // traces are correctly displayed
- if (debug.enabled && error && !$errUtils.CypressErrorRe.test(error.name)) {
- debug('retrying due to caught error...')
- console.error(error) // eslint-disable-line no-console
- }
-
const interval = options.interval ?? options._interval
// we calculate the total time we've been retrying
@@ -75,7 +66,7 @@ const create = (Cypress, state, timeout, clearTimeout, whenStable, finishAsserti
({ error, onFail } = options)
- const prependMsg = $errUtils.errMsgByPath('miscellaneous.retry_timed_out')
+ const prependMsg = $errUtils.errByPath('miscellaneous.retry_timed_out').message
const retryErrProps = $errUtils.modifyErrMsg(error, prependMsg, (msg1, msg2) => {
return `${msg2}${msg1}`
diff --git a/packages/driver/src/cy/timeouts.js b/packages/driver/src/cy/timeouts.js
index e35a20ac5a6e..84068108ac22 100644
--- a/packages/driver/src/cy/timeouts.js
+++ b/packages/driver/src/cy/timeouts.js
@@ -1,3 +1,4 @@
+const _ = require('lodash')
const $errUtils = require('../cypress/error_utils')
const create = (state) => {
@@ -9,7 +10,7 @@ const create = (state) => {
$errUtils.throwErrByPath('miscellaneous.outside_test')
}
- if (ms) {
+ if (_.isFinite(ms)) {
// if delta is true then we add (or subtract) from the
// runnables current timeout instead of blanketingly setting it
ms = delta ? runnable.timeout() + ms : ms
diff --git a/packages/driver/src/cypress.js b/packages/driver/src/cypress.js
index ad0c2161f026..0125a9c88412 100644
--- a/packages/driver/src/cypress.js
+++ b/packages/driver/src/cypress.js
@@ -30,6 +30,7 @@ const $Screenshot = require('./cypress/screenshot')
const $SelectorPlayground = require('./cypress/selector_playground')
const $utils = require('./cypress/utils')
const $errUtils = require('./cypress/error_utils')
+const $scriptUtils = require('./cypress/script_utils')
const browserInfo = require('./cypress/browser')
const debug = require('debug')('cypress:driver:cypress')
@@ -90,6 +91,8 @@ class $Cypress {
this.runner = null
this.Commands = null
this._RESUMED_AT_TEST = null
+ this.$autIframe = null
+ this.onSpecReady = null
this.events = $Events.extend(this)
@@ -169,8 +172,9 @@ class $Cypress {
return this.action('cypress:config', config)
}
- initialize ($autIframe) {
- return this.cy.initialize($autIframe)
+ initialize ({ $autIframe, onSpecReady }) {
+ this.$autIframe = $autIframe
+ this.onSpecReady = onSpecReady
}
run (fn) {
@@ -186,7 +190,7 @@ class $Cypress {
// specs or support files have been downloaded
// or parsed. we have not received any custom commands
// at this point
- onSpecWindow (specWindow) {
+ onSpecWindow (specWindow, scripts) {
const logFn = (...args) => {
return this.log.apply(this, args)
}
@@ -206,7 +210,17 @@ class $Cypress {
$FirefoxForcedGc.install(this)
- return null
+ $scriptUtils.runScripts(specWindow, scripts)
+ .catch((err) => {
+ err = $errUtils.createUncaughtException('spec', err)
+
+ this.runner.onScriptError(err)
+ })
+ .then(() => {
+ this.cy.initialize(this.$autIframe)
+
+ this.onSpecReady()
+ })
}
action (eventName, ...args) {
diff --git a/packages/driver/src/cypress/chainer.js b/packages/driver/src/cypress/chainer.js
index 48a064e89efb..7de6c7563d65 100644
--- a/packages/driver/src/cypress/chainer.js
+++ b/packages/driver/src/cypress/chainer.js
@@ -1,7 +1,10 @@
const _ = require('lodash')
+const $stackUtils = require('./stack_utils')
class $Chainer {
- constructor () {
+ constructor (userInvocationStack, specWindow) {
+ this.userInvocationStack = userInvocationStack
+ this.specWindow = specWindow
this.chainerId = _.uniqueId('chainer')
this.firstCall = true
}
@@ -12,9 +15,15 @@ class $Chainer {
static add (key, fn) {
$Chainer.prototype[key] = function (...args) {
+ const userInvocationStack = this.useInitialStack
+ ? this.userInvocationStack
+ : $stackUtils.normalizedUserInvocationStack(
+ (new this.specWindow.Error('command invocation stack')).stack,
+ )
+
// call back the original function with our new args
// pass args an as array and not a destructured invocation
- if (fn(this, args)) {
+ if (fn(this, userInvocationStack, args)) {
// no longer the first call
this.firstCall = false
}
@@ -26,12 +35,21 @@ class $Chainer {
}
// creates a new chainer instance
- static create (key, args) {
- const chainer = new $Chainer()
+ static create (key, userInvocationStack, specWindow, args) {
+ const chainer = new $Chainer(userInvocationStack, specWindow)
+
+ // this is the first command chained off of cy, so we use
+ // the stack passed in from that call instead of the stack
+ // from this invocation
+ chainer.useInitialStack = true
// since this is the first function invocation
// we need to pass through onto our instance methods
- return chainer[key].apply(chainer, args)
+ const chain = chainer[key].apply(chainer, args)
+
+ chain.useInitialStack = false
+
+ return chain
}
}
diff --git a/packages/driver/src/cypress/cy.js b/packages/driver/src/cypress/cy.js
index 453f62b9fb3b..4ced1b5cb4f2 100644
--- a/packages/driver/src/cypress/cy.js
+++ b/packages/driver/src/cypress/cy.js
@@ -6,6 +6,7 @@ const Promise = require('bluebird')
const $dom = require('../dom')
const $utils = require('./utils')
const $errUtils = require('./error_utils')
+const $stackUtils = require('./stack_utils')
const $Chai = require('../cy/chai')
const $Xhrs = require('../cy/xhrs')
const $jQuery = require('../cy/jquery')
@@ -60,6 +61,10 @@ const setRemoteIframeProps = ($autIframe, state) => {
return state('$autIframe', $autIframe)
}
+function __stackReplacementMarker (fn, ctx, args) {
+ return fn.apply(ctx, args)
+}
+
// We only set top.onerror once since we make it configurable:false
// but we update cy instance every run (page reload or rerun button)
let curCy = null
@@ -133,7 +138,7 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
const mouse = $Mouse.create(state, keyboard, focused, Cypress)
const timers = $Timers.create()
- const { expect } = $Chai.create(specWindow, assertions.assert)
+ const { expect } = $Chai.create(specWindow, state, assertions.assert)
const xhrs = $Xhrs.create(state)
const aliases = $Aliases.create(state)
@@ -345,7 +350,7 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
// run the command's fn with runnable's context
try {
- ret = command.get('fn').apply(state('ctx'), args)
+ ret = __stackReplacementMarker(command.get('fn'), state('ctx'), args)
} catch (err) {
throw err
} finally {
@@ -556,14 +561,12 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
}
state('resolve', resolve)
-
- return state('reject', rejectOuterAndCancelInner)
+ state('reject', rejectOuterAndCancelInner)
})
.catch((err) => {
// since this failed this means that a
// specific command failed and we should
// highlight it in red or insert a new command
-
err.name = err.name || 'CypressError'
errors.commandRunningFailed(err)
@@ -673,12 +676,53 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
return state('index', queue.length)
}
- const fail = function (err, runnable) {
+ const getUserInvocationStack = (err) => {
+ const current = state('current')
+ const currentAssertionCommand = current?.get('currentAssertionCommand')
+ const withInvocationStack = currentAssertionCommand || current
+ // user assertion errors (expect().to, etc) get their invocation stack
+ // attached to the error thrown from chai
+ // command errors and command assertion errors (default assertion or cy.should)
+ // have the invocation stack attached to the current command
+ let userInvocationStack = state('currentAssertionUserInvocationStack')
+
+ // if there is no user invocation stack from an assertion or it is the default
+ // assertion, meaning it came from a command (e.g. cy.get), prefer the
+ // command's user invocation stack so the code frame points to the command.
+ // `should` callbacks are tricky because the `currentAssertionUserInvocationStack`
+ // points to the `cy.should`, but the error came from inside the callback,
+ // so we need to prefer that.
+ if (
+ !userInvocationStack
+ || err.isDefaultAssertionErr
+ || (currentAssertionCommand && !current?.get('followedByShouldCallback'))
+ ) {
+ userInvocationStack = withInvocationStack?.get('userInvocationStack')
+ }
+
+ if (!userInvocationStack) return
+
+ if (
+ $errUtils.isCypressErr(err)
+ || $errUtils.isAssertionErr(err)
+ || $errUtils.isChaiValidationErr(err)
+ ) {
+ return userInvocationStack
+ }
+ }
+
+ const fail = (err) => {
let rets
stopped = true
- err = $errUtils.normalizeErrorStack(err)
+ err.stack = $stackUtils.normalizedStack(err)
+
+ err = $errUtils.enhanceStack({
+ err,
+ userInvocationStack: getUserInvocationStack(err),
+ projectRoot: config('projectRoot'),
+ })
err = $errUtils.processErr(err, config)
@@ -718,11 +762,11 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
try {
// collect all of the callbacks for 'fail'
rets = Cypress.action('cy:fail', err, state('runnable'))
- } catch (err2) {
- $errUtils.normalizeErrorStack(err2)
-
+ } catch (cyFailErr) {
// and if any of these throw synchronously immediately error
- return finish(err2)
+ cyFailErr.stack = $stackUtils.normalizedStack(cyFailErr)
+
+ return finish(cyFailErr)
}
// bail if we had callbacks attached
@@ -962,13 +1006,17 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
}
cy[name] = function (...args) {
+ const userInvocationStack = $stackUtils.normalizedUserInvocationStack(
+ (new specWindow.Error('command invocation stack')).stack,
+ )
+
let ret
ensures.ensureRunnable(name)
// this is the first call on cypress
// so create a new chainer instance
- const chain = $Chainer.create(name, args)
+ const chain = $Chainer.create(name, userInvocationStack, specWindow, args)
// store the chain so we can access it later
state('chain', chain)
@@ -1009,7 +1057,7 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
return chain
}
- return cy.addChainer(name, (chainer, args) => {
+ return cy.addChainer(name, (chainer, userInvocationStack, args) => {
const { firstCall, chainerId } = chainer
// dont enqueue / inject any new commands if
@@ -1027,6 +1075,7 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
args,
type,
chainerId,
+ userInvocationStack,
fn: wrap(firstCall),
})
@@ -1123,30 +1172,22 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
onSpecWindowUncaughtException () {
// create the special uncaught exception err
- let runnable
const err = errors.createUncaughtException('spec', arguments)
+ const runnable = state('runnable')
- runnable = state('runnable')
-
- if (runnable) {
- // we're using an explicit done callback here
- let d; let r
-
- d = state('done')
+ if (!runnable) return err
- if (d) {
- d(err)
- }
-
- r = state('reject')
+ try {
+ fail(err)
+ } catch (failErr) {
+ const r = state('reject')
if (r) {
return r(err)
}
- }
- // else pass the error along
- return err
+ return failErr
+ }
},
onUncaughtException () {
@@ -1254,7 +1295,7 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
state('done', done)
}
- let ret = fn.apply(this, arguments)
+ let ret = __stackReplacementMarker(fn, this, arguments)
// if we returned a value from fn
// and enqueued some new commands
@@ -1317,13 +1358,10 @@ const create = function (specWindow, Cypress, Cookies, state, config, log) {
// else just return ret
return ret
- } catch (error) {
- // if our runnable.fn throw synchronously
- // then it didnt fail from a cypress command
- // but we should still teardown and handle
+ } catch (err) {
+ // if runnable.fn threw synchronously, then it didnt fail from
+ // a cypress command, but we should still teardown and handle
// the error
- const err = error
-
return fail(err, runnable)
}
}
diff --git a/packages/driver/src/cypress/error_messages.coffee b/packages/driver/src/cypress/error_messages.coffee
index d720409b032f..42938350f186 100644
--- a/packages/driver/src/cypress/error_messages.coffee
+++ b/packages/driver/src/cypress/error_messages.coffee
@@ -214,8 +214,9 @@ module.exports = {
backend_error: (obj) -> {
message: """
#{cmd('{{cmd}}')} had an unexpected error {{action}} {{browserDisplayName}}.
- {{errMessage}}
- {{errStack}}
+
+ > {{error}}
+
"""
docsUrl: "https://on.cypress.io/#{_.toLower(obj.cmd)}"
}
@@ -493,7 +494,7 @@ module.exports = {
If you want to assert on the property's value, then switch to use #{cmd('its')} and add an assertion such as:
`cy.wrap({ foo: 'bar' }).its('foo').should('eq', 'bar')`
- """
+ """
docsUrl: "https://on.cypress.io/invoke"
}
subject_null_or_undefined: {
@@ -503,7 +504,7 @@ module.exports = {
If you expect your subject to be `{{value}}`, then add an assertion such as:
`cy.wrap({{value}}).should('be.{{value}}')`
- """
+ """
docsUrl: "https://on.cypress.io/invoke"
}
null_or_undefined_prop_value: {
@@ -515,7 +516,7 @@ module.exports = {
If you expect the property `{{prop}}` to be `{{value}}`, then switch to use #{cmd('its')} and add an assertion such as:
`cy.wrap({ foo: {{value}} }).its('foo').should('be.{{value}}')`
- """
+ """
docsUrl: "https://on.cypress.io/invoke"
}
@@ -527,7 +528,7 @@ module.exports = {
If you expect your subject to be `{{value}}`, then add an assertion such as:
`cy.wrap({{value}}).should('be.{{value}}')`
- """
+ """
docsUrl: "https://on.cypress.io/its"
}
null_or_undefined_prop_value: {
@@ -539,7 +540,7 @@ module.exports = {
If you expect the property `{{prop}}` to be `{{value}}`, then add an assertion such as:
`cy.wrap({ foo: {{value}} }).its('foo').should('be.{{value}}')`
- """
+ """
docsUrl: "https://on.cypress.io/its"
}
@@ -553,7 +554,7 @@ module.exports = {
If you do not expect the property `{{prop}}` to exist, then add an assertion such as:
`cy.wrap({ foo: 'bar' }).its('quux').should('not.exist')`
- """
+ """
docsUrl: "https://on.cypress.io/{{cmd}}"
}
previous_prop_null_or_undefined: {
@@ -630,7 +631,7 @@ module.exports = {
To rewrite this custom command you'd likely write:
`Cypress.Commands.add(#{obj.signature})`
- """
+ """
docsUrl: "https://on.cypress.io/custom-command-interface-changed"
}
returned_value_and_commands_from_custom_command: (obj) -> {
@@ -922,10 +923,6 @@ module.exports = {
- you forgot to run / boot your web server
- your web server isn't accessible
- you have weird network configuration settings on your computer
-
- The stack trace for this error is:
-
- #{obj.stack}
"""
docsUrl: "https://on.cypress.io/request"
}
@@ -1170,14 +1167,6 @@ module.exports = {
unavailable: "The XHR server is unavailable or missing. This should never happen and likely is a bug. Open an issue if you see this message."
setCookie:
- backend_error: {
- message: """
- #{cmd('setCookie')} had an unexpected error setting the requested cookie in {{browserDisplayName}}.
-
- {{errStack}}
- """
- docsUrl: "https://on.cypress.io/setcookie"
- }
invalid_arguments: {
message: "#{cmd('setCookie')} must be passed two string arguments for `name` and `value`."
docsUrl: "https://on.cypress.io/setcookie"
@@ -1428,19 +1417,20 @@ module.exports = {
}
uncaught:
- cross_origin_script: """
- Script error.
-
- Cypress detected that an uncaught error was thrown from a cross origin script.
+ cross_origin_script: {
+ message: """
+ Script error.
- We cannot provide you the stack trace, line number, or file where this error occurred.
+ Cypress detected that an uncaught error was thrown from a cross origin script.
- Check your Developer Tools Console for the actual error - it should be printed there.
+ We cannot provide you the stack trace, line number, or file where this error occurred.
- It's possible to enable debugging these scripts by adding the `crossorigin` attribute and setting a CORS header.
+ Check your Developer Tools Console for the actual error - it should be printed there.
- https://on.cypress.io/cross-origin-script-error
- """
+ It's possible to enable debugging these scripts by adding the `crossorigin` attribute and setting a CORS header.
+ """
+ docsUrl: "https://on.cypress.io/cross-origin-script-error"
+ }
error_in_hook: (obj) ->
msg = "Because this error occurred during a `#{obj.hookName}` hook we are skipping "
@@ -1450,15 +1440,15 @@ module.exports = {
msg += "all of the remaining tests."
msg
-
error: (obj) ->
- {msg, source, lineno} = obj
-
- msg + if source and lineno then " (#{source}:#{lineno})" else ""
+ {message, source, lineno} = obj
+ message + if source and lineno then " (#{source}:#{lineno})" else ""
fromApp: {
message: """
- This error originated from your application code, not from Cypress.
+ The following error originated from your application code, not from Cypress.
+
+ > {{errMsg}}
When Cypress detects uncaught errors originating from your application it will automatically fail the current test.
@@ -1468,7 +1458,9 @@ module.exports = {
}
fromSpec:
message: """
- This error originated from your test code, not from Cypress.
+ The following error originated from your test code, not from Cypress.
+
+ > {{errMsg}}
When Cypress detects uncaught errors originating from your test code it will automatically fail the current test.
"""
@@ -1574,10 +1566,6 @@ module.exports = {
- you forgot to run / boot your web server
- your web server isn't accessible
- you have weird network configuration settings on your computer
-
- The stack trace for this error is:
-
- {{stack}}
"""
loading_file_failed: (obj) ->
"""
@@ -1630,15 +1618,14 @@ module.exports = {
#{cmd('request')} will automatically get and set cookies and enable you to parse responses.
"""
- specify_file_by_relative_path: """
- #{cmd('visit')} failed because the 'file://...' protocol is not supported by Cypress.
-
- To visit a local file, you can pass in the relative path to the file from the `projectRoot` (Note: if the configuration value `baseUrl` is set, the supplied path will be resolved from the `baseUrl` instead of `projectRoot`)
-
- https://docs.cypress.io/api/commands/visit.html
+ specify_file_by_relative_path: {
+ message: """
+ #{cmd('visit')} failed because the 'file://...' protocol is not supported by Cypress.
- https://docs.cypress.io/api/cypress-api/config.html
+ To visit a local file, you can pass in the relative path to the file from the `projectRoot` (Note: if the configuration value `baseUrl` is set, the supplied path will be resolved from the `baseUrl` instead of `projectRoot`)
"""
+ docsUrl: ["https://docs.cypress.io/api/commands/visit.html", "/https://docs.cypress.io/api/cypress-api/config.html"]
+ }
wait:
alias_invalid: {
diff --git a/packages/driver/src/cypress/error_utils.js b/packages/driver/src/cypress/error_utils.js
index 5b355fc2ddc5..6130a7125c76 100644
--- a/packages/driver/src/cypress/error_utils.js
+++ b/packages/driver/src/cypress/error_utils.js
@@ -2,11 +2,17 @@ const _ = require('lodash')
const $errorMessages = require('./error_messages')
const $utils = require('./utils')
+const $stackUtils = require('./stack_utils')
-const ERROR_PROPS = 'message type name stack sourceMappedStack parsedStack fileName lineNumber columnNumber host uncaught actual expected showDiff isPending docsUrl'.split(' ')
+const ERROR_PROPS = 'message type name stack sourceMappedStack parsedStack fileName lineNumber columnNumber host uncaught actual expected showDiff isPending docsUrl codeFrame'.split(' ')
-const CypressErrorRe = /(AssertionError|CypressError)/
-const twoOrMoreNewLinesRe = /\n{2,}/
+if (!Error.captureStackTrace) {
+ Error.captureStackTrace = (err, fn) => {
+ const stack = (new Error()).stack
+
+ err.stack = $stackUtils.stackWithLinesDroppedFromMarker(stack, fn.name)
+ }
+}
const wrapErr = (err) => {
if (!err) return
@@ -14,78 +20,74 @@ const wrapErr = (err) => {
return $utils.reduceProps(err, ERROR_PROPS)
}
-const mergeErrProps = (origErr, ...newProps) => {
- return _.extend(origErr, ...newProps)
+const isAssertionErr = (err = {}) => {
+ return err.name === 'AssertionError'
}
-const replaceNameInStack = (err, newName) => {
- const { name, stack } = err
+const isChaiValidationErr = (err = {}) => {
+ return _.startsWith(err.message, 'Invalid Chai property')
+}
- if (!stack) return stack
+const isCypressErr = (err = {}) => {
+ return err.name === 'CypressError'
+}
- return stack.replace(name, newName)
+const mergeErrProps = (origErr, ...newProps) => {
+ return _.extend(origErr, ...newProps)
}
-const modifyErrName = (err, newName) => {
- const newStack = replaceNameInStack(err, newName)
+const stackWithReplacedProps = (err, props) => {
+ const {
+ message: originalMessage,
+ name: originalName,
+ stack: originalStack,
+ } = err
- err.name = newName
- err.stack = newStack
+ const {
+ message: newMessage,
+ name: newName,
+ } = props
- return err
-}
+ // if stack doesn't already exist, leave it as is
+ if (!originalStack) return originalStack
+
+ let stack
-const replaceMsgInStack = (err, newMsg) => {
- const { message, name, stack } = err
+ if (newMessage) {
+ stack = originalStack.replace(originalMessage, newMessage)
+ }
- if (!stack) return stack
+ if (newName) {
+ stack = originalStack.replace(originalName, newName)
+ }
- if (message) {
- // reset stack by replacing the original message with the new one
- return stack.replace(message, newMsg)
+ if (originalMessage) {
+ return stack
}
// if message is undefined or an empty string, the error (in Chrome at least)
// is 'Error\n\n