jestjs/jest

Use cross browser stack trace utils

Open

#10023 opened on May 11, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (45,361 stars) (6,653 forks)batch import
:rocket: Feature RequestHelp WantedPinned

Description

🚀 Feature Proposal

It'd be awesome and fairly simple (I hope) to swap out stack-utils for https://github.com/stacktracejs/error-stack-parser which would give you the same metadata about stacks but work for non v8 stack traces

Motivation

We want to use jest-message-util to format errors from multiple browsers

Pitch

We are using a lot of jest in https://github.com/4Catalyzer/karma-jest which is a multi-browser environment via karma. Jest's excellent error formatting utils from jest-message-util work great (after mapping browser stacks to correct ones via source maps), but the formatting utils assume V8 based stack traces, which means FF and safari traces don't get nicely printed and call-site files are incorrectly parsed. This is due to some bad regexs and stack-utils which is designed for node.

If this seems like a good idea i can problem send a PR for it

Contributor guide

Tech stack
typescriptjavascriptnodejs
Domain
testing
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of stack tracesFamiliarity with jest message utilBasic regex knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the jest message util source code, specifically how it parses stack traces using stack utils. Compare the API of error stack parser (https://github.com/stacktracejs/error stack parser) and identify the differences in how non V8 browser stacks are parsed. Look at the regex patterns in the current code that assume V8 format and propose changes to accommodate Firefox and Safari traces. Consider writing a small test case with sample stacks from different browsers to validate the new parser.