Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/driver/src/cypress/stack_utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ const stackWithLinesRemoved = (stack, cb) => {
return unsplitStack(messageLines, remainingStackLines)
}

const stackWithGrepLinesRemoved = (stack) => {
return stackWithLinesRemoved(stack, (lines) => {
return _.reject(lines, (line) => line.includes('itGrep'))
})
}

const stackWithLinesDroppedFromMarker = (stack, marker, includeLast = false) => {
return stackWithLinesRemoved(stack, (lines) => {
// drop lines above the marker
Expand Down Expand Up @@ -149,6 +155,12 @@ const getInvocationDetails = (specWindow, config): InvocationDetails | undefined
}
}

// if the stack includes the 'itGrep' function, remove any lines that include it
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likely good to reference what itGrep is and where it is coming from (same with above) https://github.com/cypress-io/cypress/blob/develop/npm/grep/src/register.ts#L77. people who aren't familiar with @cypress/grep will struggle to understand what this means.

The other concern I have is that there could be something legitimate in the stack that has itGrep in it that we want to capture but are omitting it here. Or is this only considered when trying to calculate the row/column in the spec file where the error occurred?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a comment there. I'm pretty sure this function is specifically used to identify where the test was executed from, so this shouldn't affect anything else. If it does, it'll be limited to use of the grep plugin

// so that the first line in the stack is the spec invocation
if (stack.includes('itGrep')) {
stack = stackWithGrepLinesRemoved(stack)
}

const details: Omit<InvocationDetails, 'stack'> = getSourceDetailsForFirstLine(stack, config('projectRoot')) || {};

(details as any).stack = stack
Expand Down
26 changes: 26 additions & 0 deletions packages/driver/test/unit/cypress/stack_utils.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,32 @@ describe('stack_utils', () => {
})
})
}

it('returns the correct invocation details for a grep stack trace', () => {
const stack = `Error\n
at itGrep (http://localhost:3000/__cypress/tests?p=cypress/support/e2e.js:444:14)\n
at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:14:1)\n
at eval (http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js:18:12)\n
at eval (<anonymous>)\n
at eval (cypress:///../driver/src/cypress/script_utils.ts:38:23)`

class GrepError {
get stack () {
return stack
}
}

stack_utils.getInvocationDetails(
{ Error: GrepError, Cypress: {} },
config,
)

expect(source_map_utils.getSourcePosition).toHaveBeenCalledWith('http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js', expect.objectContaining({
column: 1,
line: 14,
file: 'http://localhost:3000/__cypress/tests?p=cypress/e2e/spec.cy.js',
}))
})
})

describe('normalizedUserInvocationStack', () => {
Expand Down
Loading