Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: filter stacktraces (fix #1999) #4338

Merged
merged 1 commit into from
Oct 23, 2023

Conversation

clarkf
Copy link
Contributor

@clarkf clarkf commented Oct 19, 2023

Description

This change introduces a new optional configuration parameter, onStackTrace. If included, each frame of each error stacktrace encountered during the test run will be tested by the provided function. If the test fails, the frame will be omitted from the displayed trace.

The only real note is that this might not give enough information for more complex situations (e.g. filtering that depends on the error, or the other frames).

Fixes #1999.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

@stackblitz
Copy link

stackblitz bot commented Oct 19, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@netlify
Copy link

netlify bot commented Oct 19, 2023

Deploy Preview for fastidious-cascaron-4ded94 ready!

Name Link
🔨 Latest commit 317c309
🔍 Latest deploy log https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/6531989dec04fa00093b9d92
😎 Deploy Preview https://deploy-preview-4338--fastidious-cascaron-4ded94.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sheremet-va
Copy link
Member

The only real note is that this might not give enough information for more complex situations (e.g. filtering that depends on the error, or the other frames).

I think it would be nice to provide an error object as the first argument (or second?)

@clarkf
Copy link
Contributor Author

clarkf commented Oct 19, 2023

That would be my instinct too. (error: Error, frame: ParsedStack) => boolean makes the most sense to me. I'll make the change.

docs/config/index.md Show resolved Hide resolved
docs/config/index.md Show resolved Hide resolved
This change introduces a new optional configuration parameter,
`onStackTrace`. If included, each frame of each error stacktrace
encountered during the test run will be tested by the provided
function. If the test fails, the frame will be omitted from the
displayed trace.
@sheremet-va sheremet-va merged commit 6b73473 into vitest-dev:main Oct 23, 2023
15 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ability to filter the stack trace
2 participants