-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstack-utils.ts
More file actions
408 lines (342 loc) · 11.1 KB
/
stack-utils.ts
File metadata and controls
408 lines (342 loc) · 11.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
import { builtinModules } from 'module';
import type { StackUtilsOptions, StackData, StackLineData, CallSiteLike } from './mix.js';
const natives = [...builtinModules, 'bootstrap_node', 'node'].map(
(n) => new RegExp(`(?:\\((?:node:)?${n}(?:\\.js)?:\\d+:\\d+\\)$|^\\s*at (?:node:)?${n}(?:\\.js)?:\\d+:\\d+$)`),
);
natives.push(
/\((?:node:)?internal\/[^:]+:\d+:\d+\)$/,
/\s*at (?:node:)?internal\/[^:]+:\d+:\d+$/,
/\/\.node-spawn-wrap-\w+-\w+\/node:\d+:\d+\)?$/,
);
export class StackUtils {
protected cwd: string;
protected internals: RegExp[];
protected wrapCallSite?: (callSite: NodeJS.CallSite) => NodeJS.CallSite;
constructor(protected opts: StackUtilsOptions = {}) {
this.opts = {
ignoredPackages: [],
...opts,
};
if (!this.opts.internals) {
this.opts.internals = StackUtils.nodeInternals();
}
if ('cwd' in this.opts === false) {
this.opts.cwd = '';
}
this.cwd = this.opts.cwd!.replace(/\\/g, '/');
this.internals = this.opts.internals.concat(this.ignoredPackagesRegExp(this.opts.ignoredPackages || []));
this.wrapCallSite = this.opts.wrapCallSite;
}
/**
* Returns an array of regular expressions that be used to cull lines from the stack trace that
* reference common Node.js internal files.
*/
static nodeInternals() {
return [...natives];
}
/**
* Cleans up a stack trace by deleting any lines that match the `internals` passed to the constructor,
* and shortening file names relative to `cwd`.
*
* Returns a `string` with the cleaned up stack (always terminated with a `\n` newline character).
* Spaces at the start of each line are trimmed, indentation can be added by setting `indent` to the
* desired number of spaces.
*
* @todo Refactor this!
*/
clean(stack: string | string[], indent = 0) {
if (!Array.isArray(stack)) {
stack = stack.split('\n');
}
if (this.opts.removeFirstLine && !/^\s*at /.test(stack[0]) && /^\s*at /.test(stack[1])) {
stack = stack.slice(1);
}
let outdent = false;
let lastNonAtLine = '';
const result: string[] = [];
stack.forEach((st) => {
st = st.replace(/\\/g, '/');
if (this.internals.some((internal) => internal.test(st))) {
return;
}
const isAtLine = /^\s*at /.test(st);
if (outdent) {
if (this.opts.removeFirstLine) {
st = st.trimEnd().replace(/^(\s+)at /, '$1');
}
} else {
if (isAtLine) {
st = st.trim();
st = st.slice(3);
}
}
if (this.cwd) {
st = st.replace(`${this.cwd}/`, '');
}
if (st) {
if (isAtLine) {
if (lastNonAtLine) {
result.push(lastNonAtLine);
lastNonAtLine = '';
}
result.push(st);
} else {
outdent = true;
lastNonAtLine = st;
}
}
});
const indentStr = ' '.repeat(indent);
return result.map((line) => `${indentStr}${line}\n`).join('');
}
/**
* Captures the current stack trace, cleans it using `stackUtils.clean(stack)`, and returns a string with
* the cleaned stack trace. It takes the same arguments as `stackUtils.capture`.
*/
captureString(limit: number, fn = this.captureString) {
if (typeof limit == 'function') {
fn = limit;
limit = Infinity;
}
const { stackTraceLimit } = Error;
if (limit) {
Error.stackTraceLimit = limit;
}
const obj: any = {};
Error.captureStackTrace(obj, fn);
const { stack } = obj;
Error.stackTraceLimit = stackTraceLimit;
return this.clean(stack);
}
/**
* Captures the current stack trace, returning an array of `CallSite`s. There are good overviews
* of the available CallSite methods [here](https://github.com/v8/v8/wiki/Stack%20Trace%20API#customizing-stack-traces),
* and [here](https://github.com/sindresorhus/callsites#api).
*
* @param limit Limits the number of lines returned by dropping all lines in excess of the limit.
* This removes lines from the stack trace.
* @param startStackFunction The function where the stack trace should start. The first line of the stack trace
* will be the function that called `startStackFunction`. This removes lines from the end of the stack trace.
*/
capture(limit: number = Infinity, startStackFunction = this.capture) {
if (typeof limit == 'function') {
startStackFunction = limit;
limit = Infinity;
}
const { prepareStackTrace, stackTraceLimit } = Error;
Error.prepareStackTrace = (obj, site) => {
if (this.wrapCallSite) {
return site.map(this.wrapCallSite);
}
return site;
};
if (limit) {
Error.stackTraceLimit = limit;
}
const obj: any = {};
Error.captureStackTrace(obj, startStackFunction);
const { stack } = obj;
Object.assign(Error, { prepareStackTrace, stackTraceLimit });
return stack;
}
/**
* Captures the first line of the stack trace (or the first line after `startStackFunction` if supplied),
* and returns a `CallSite` like object that is serialization friendly (properties are actual values
* instead of getter functions).
*
* The available properties are:
*
* - `line`: `number`
* - `column`: `number`
* - `file`: `string`
* - `constructor`: `boolean`
* - `evalOrigin`: `string`
* - `native`: `boolean`
* - `type`: `string`
* - `function`: `string`
* - `method`: `string`
*/
at(startStackFunction: (...args: any[]) => any = this.at) {
const [site] = this.capture(1, startStackFunction);
if (!site) {
return {};
}
const res = {
line: site.getLineNumber(),
column: site.getColumnNumber(),
} as CallSiteLike;
this.setFile(res, site.getFileName(), this.cwd);
if (site.isConstructor()) {
Object.defineProperty(res, 'constructor', {
value: true,
configurable: true,
});
}
if (site.isEval()) {
res.evalOrigin = site.getEvalOrigin();
}
// Node v10 stopped with the isNative() on callsites, apparently
/* istanbul ignore next */
if (site.isNative()) {
res.native = true;
}
let typename;
try {
typename = site.getTypeName();
} catch (_) {}
if (typename && typename !== 'Object' && typename !== '[object Object]') {
res.type = typename;
}
const fname = site.getFunctionName();
if (fname) {
res.function = fname;
}
const meth = site.getMethodName();
if (meth && fname !== meth) {
res.method = meth;
}
return res;
}
/**
* Parses a `string` (which should be a single line from a stack trace), and generates an object with
* the following properties:
*
* - `line`: `number`
* - `column`: `number`
* - `file`: `string`
* - `constructor`: `boolean`
* - `evalOrigin`: `string`
* - `evalLine`: `number`
* - `evalColumn`: `number`
* - `evalFile`: `string`
* - `native`: `boolean`
* - `function`: `string`
* - `method`: `string`
*/
parseLine(line: string) {
const match = line && line.match(re);
if (!match) {
return null;
}
const ctor = match[1] === 'new';
let fname = match[2];
const evalOrigin = match[3];
const evalFile = match[4];
const evalLine = Number(match[5]);
const evalCol = Number(match[6]);
let file = match[7];
const lnum = match[8];
const col = match[9];
const native = match[10] === 'native';
const closeParen = match[11] === ')';
let method;
const res = {} as StackLineData;
if (lnum) {
res.line = Number(lnum);
}
if (col) {
res.column = Number(col);
}
if (closeParen && file) {
// make sure parens are balanced
// if we have a file like "asdf) [as foo] (xyz.js", then odds are
// that the fname should be += " (asdf) [as foo]" and the file
// should be just "xyz.js"
// walk backwards from the end to find the last unbalanced (
let closes = 0;
for (let i = file.length - 1; i > 0; i--) {
if (file.charAt(i) === ')') {
closes++;
} else if (file.charAt(i) === '(' && file.charAt(i - 1) === ' ') {
closes--;
if (closes === -1 && file.charAt(i - 1) === ' ') {
const before = file.slice(0, i - 1);
const after = file.slice(i + 1);
file = after;
fname += ` (${before}`;
break;
}
}
}
}
if (fname) {
const methodMatch = fname.match(/^(.*?) \[as (.*?)\]$/);
if (methodMatch) {
fname = methodMatch[1];
method = methodMatch[2];
}
}
this.setFile(res, file, this.cwd);
if (ctor) {
Object.defineProperty(res, 'constructor', {
value: true,
configurable: true,
});
}
if (evalOrigin) {
res.evalOrigin = evalOrigin;
res.evalLine = evalLine;
res.evalColumn = evalCol;
res.evalFile = evalFile && evalFile.replace(/\\/g, '/');
}
if (native) {
res.native = true;
}
if (fname) {
res.function = fname;
}
if (method && fname !== method) {
res.method = method;
}
return res;
}
protected setFile(result: StackData, filename: string, cwd: string) {
if (filename) {
filename = filename.replace(/\\/g, '/');
if (cwd && filename.startsWith(`${cwd}/`)) {
filename = filename.slice(cwd.length + 1);
}
result.file = filename;
}
}
protected ignoredPackagesRegExp(ignoredPackages: string[]): RegExp | any[] {
if (ignoredPackages.length === 0) {
return [];
}
const packages = ignoredPackages.map((mod) => this.escapeStringRegexp(mod));
return new RegExp(`[\/\\\\]node_modules[\/\\\\](?:${packages.join('|')})[\/\\\\][^:]+:\\d+:\\d+`);
}
protected escapeStringRegexp(str: string) {
if (typeof str !== 'string') {
throw new TypeError('Expected a string');
}
// Escape characters with special meaning either inside or outside character sets.
// Use a simple backslash escape when it’s always valid, and a `\xnn` escape when the simpler form would be disallowed by Unicode patterns’ stricter grammar.
return str.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&').replace(/-/g, '\\x2d');
}
}
const re = new RegExp(
'^' +
// Sometimes we strip out the ' at' because it's noisy
'(?:\\s*at )?' +
// $1 = ctor if 'new'
'(?:(new) )?' +
// $2 = function name (can be literally anything)
// May contain method at the end as [as xyz]
'(?:(.*?) \\()?' +
// (eval at <anonymous> (file.js:1:1),
// $3 = eval origin
// $4:$5:$6 are eval file/line/col, but not normally reported
'(?:eval at ([^ ]+) \\((.+?):(\\d+):(\\d+)\\), )?' +
// file:line:col
// $7:$8:$9
// $10 = 'native' if native
'(?:(.+?):(\\d+):(\\d+)|(native))' +
// maybe close the paren, then end
// if $11 is ), then we only allow balanced parens in the filename
// any imbalance is placed on the fname. This is a heuristic, and
// bound to be incorrect in some edge cases. The bet is that
// having weird characters in method names is more common than
// having weird characters in filenames, which seems reasonable.
'(\\)?)$',
);