@hanzo/event 0.3.48 → 0.3.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -50
- package/dist/core.d.ts +6 -36
- package/dist/core.d.ts.map +1 -1
- package/dist/index.cjs +206 -409
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -4
- package/dist/index.d.ts +2 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +208 -406
- package/dist/index.mjs.map +1 -1
- package/dist/org.d.ts.map +1 -1
- package/dist/react.cjs +118 -404
- package/dist/react.cjs.map +1 -1
- package/dist/react.mjs +119 -405
- package/dist/react.mjs.map +1 -1
- package/dist/throwable.d.ts +15 -0
- package/dist/throwable.d.ts.map +1 -0
- package/dist/types.d.ts +19 -74
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/core.test.ts +28 -300
- package/src/core.ts +36 -185
- package/src/exception.ts +1 -1
- package/src/index.ts +1 -5
- package/src/org.ts +4 -0
- package/src/stream.test.ts +0 -7
- package/src/throwable.test.ts +72 -0
- package/src/throwable.ts +126 -0
- package/src/types.ts +15 -75
- package/src/uid.test.ts +1 -1
- package/dist/dsn.d.ts +0 -43
- package/dist/dsn.d.ts.map +0 -1
- package/dist/sentry.d.ts +0 -62
- package/dist/sentry.d.ts.map +0 -1
- package/src/dsn.test.ts +0 -75
- package/src/dsn.ts +0 -56
- package/src/sentry.test.ts +0 -312
- package/src/sentry.ts +0 -311
package/src/core.ts
CHANGED
|
@@ -7,21 +7,10 @@
|
|
|
7
7
|
// Cloud resolves the tenant server-side (validated session, or the signed
|
|
8
8
|
// publishable key) and stamps it; the client NEVER sends the org.
|
|
9
9
|
//
|
|
10
|
-
//
|
|
11
|
-
//
|
|
12
|
-
//
|
|
13
|
-
//
|
|
14
|
-
//
|
|
15
|
-
// These are NOT the same pipe and one does NOT feed the other. The event stream
|
|
16
|
-
// stores a `type:'error'` row in the cloud event warehouse (readable via
|
|
17
|
-
// GET /v1/errors) — that is product signal, not error tracking. There is no
|
|
18
|
-
// server-side fan-out from /v1/event into Sentry; without the envelope below,
|
|
19
|
-
// nothing ever reaches sentry.hanzo.ai. An earlier revision of this file claimed
|
|
20
|
-
// the one entry point was "lensed server-side into … error tracking (sentry)". It was
|
|
21
|
-
// wrong, and it silently cost the fleet all of its error telemetry.
|
|
22
|
-
//
|
|
23
|
-
// The error plane is inert (fail-safe) when no DSN is configured: nothing is
|
|
24
|
-
// sent, nothing throws, and the event stream is unaffected.
|
|
10
|
+
// Errors ride the same pipe: a captured exception is ONE event of type 'error'
|
|
11
|
+
// carrying {type, message, frames|stack, handled} plus release, environment,
|
|
12
|
+
// site, product and level. The server files it on the error plane and groups it
|
|
13
|
+
// into an issue. There is no second endpoint, DSN or envelope.
|
|
25
14
|
//
|
|
26
15
|
// Auth is orthogonal — the SAME body to the SAME endpoint, differing only in how the
|
|
27
16
|
// caller proves its tenant:
|
|
@@ -34,29 +23,17 @@
|
|
|
34
23
|
// is the carrier neither send needs a header for, which is what keeps both
|
|
35
24
|
// CORS-simple and therefore sendable from a customer's own origin.
|
|
36
25
|
//
|
|
37
|
-
// The wire is the canonical `Event` (== the cloud CaptureEvent)
|
|
38
|
-
// is what Cloud folds to event_type='error', which is how the event WAREHOUSE
|
|
39
|
-
// classifies the row (GET /v1/errors). That is the extent of it — the fold does
|
|
40
|
-
// not forward anything to Sentry. The error dashboard is fed only by the envelope
|
|
41
|
-
// in plane 2 above, and only when a DSN is set.
|
|
26
|
+
// The wire is the canonical `Event` (== the cloud CaptureEvent).
|
|
42
27
|
|
|
43
28
|
import {
|
|
44
29
|
parseAttribution,
|
|
45
30
|
hasAttribution,
|
|
46
31
|
deriveChannel,
|
|
47
32
|
} from './attribution'
|
|
48
|
-
import { dsnForProduct } from './dsn'
|
|
49
33
|
import { keyForPage } from './org'
|
|
50
|
-
import {
|
|
51
|
-
import { exceptionProperties } from './exception'
|
|
34
|
+
import { PAGEVIEW } from './events'
|
|
52
35
|
import { scrubText, withoutFragment } from './scrub'
|
|
53
|
-
import {
|
|
54
|
-
buildEnvelope,
|
|
55
|
-
buildSentryEvent,
|
|
56
|
-
normalizeError as normalizeThrowable,
|
|
57
|
-
parseDsn,
|
|
58
|
-
type ErrorIdentity,
|
|
59
|
-
} from './sentry'
|
|
36
|
+
import { framesFromStack, normalizeError as normalizeThrowable } from './throwable'
|
|
60
37
|
import {
|
|
61
38
|
adoptAnonId,
|
|
62
39
|
adoptSession,
|
|
@@ -74,7 +51,6 @@ import type {
|
|
|
74
51
|
Attribution,
|
|
75
52
|
CaptureErrorOptions,
|
|
76
53
|
Cohort,
|
|
77
|
-
Dsn,
|
|
78
54
|
EventKind,
|
|
79
55
|
Exception,
|
|
80
56
|
Transport,
|
|
@@ -86,7 +62,6 @@ export { VERSION }
|
|
|
86
62
|
|
|
87
63
|
const EVENT_PATH = '/v1/event' // the ONE canonical ingestion entry point
|
|
88
64
|
const DEFAULT_HOST = 'https://api.hanzo.ai' // the one edge; cookie apps pass host:''
|
|
89
|
-
const ENVELOPE_CONTENT_TYPE = 'application/x-sentry-envelope'
|
|
90
65
|
// The beacon body's type. text/plain is CORS-SAFELISTED, which is the whole
|
|
91
66
|
// property: a safelisted type makes the POST a SIMPLE request, and a simple
|
|
92
67
|
// request needs no preflight. An unloading document does not get a second round
|
|
@@ -95,22 +70,7 @@ const ENVELOPE_CONTENT_TYPE = 'application/x-sentry-envelope'
|
|
|
95
70
|
// CORS class and nothing else.
|
|
96
71
|
const BEACON_CONTENT_TYPE = 'text/plain'
|
|
97
72
|
|
|
98
|
-
/**
|
|
99
|
-
* gets the error plane by setting ONE build-time variable and nothing else.
|
|
100
|
-
* Next/Vite inline these at build; the access is guarded so it is safe in a bare
|
|
101
|
-
* browser and during SSR/prerender where `process` may not exist. */
|
|
102
|
-
function readEnvDsn(): string | undefined {
|
|
103
|
-
try {
|
|
104
|
-
if (typeof process !== 'undefined' && process.env) {
|
|
105
|
-
return process.env.NEXT_PUBLIC_HANZO_EVENT_DSN || process.env.HANZO_EVENT_DSN || undefined
|
|
106
|
-
}
|
|
107
|
-
} catch {
|
|
108
|
-
/* no process — browser without inlined env */
|
|
109
|
-
}
|
|
110
|
-
return undefined
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
/** readEnv reads an inlined build-time variable, guarded like readEnvDsn. */
|
|
73
|
+
/** readEnv reads an inlined build-time variable, guarded for SSR. */
|
|
114
74
|
function readEnv(name: string): string | undefined {
|
|
115
75
|
try {
|
|
116
76
|
if (typeof process !== 'undefined' && process.env) return process.env[name] || undefined
|
|
@@ -127,14 +87,15 @@ function appendQuery(url: string, key: string, value: string): string {
|
|
|
127
87
|
}
|
|
128
88
|
|
|
129
89
|
/** Normalize anything thrown (Error | string | unknown) into an Exception. */
|
|
130
|
-
/** normalizeError adapts the
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
* plane rolled its own reader the stream still lost the report that the error
|
|
134
|
-
* plane had already survived. */
|
|
90
|
+
/** normalizeError adapts the hostile-input-safe normalizer (sentry.ts) to the
|
|
91
|
+
* stream's Exception shape: a thrown object may define `name`/`message`/`stack`
|
|
92
|
+
* as throwing getters. */
|
|
135
93
|
function normalizeError(err: unknown): Exception {
|
|
136
94
|
const n = normalizeThrowable(err)
|
|
137
|
-
|
|
95
|
+
const frames = framesFromStack(n.stack)
|
|
96
|
+
.slice(-50)
|
|
97
|
+
.map((f) => ({ function: f.function, file: f.filename, line: f.lineno, column: f.colno }))
|
|
98
|
+
return { type: n.name, message: n.message, stack: n.stack, frames }
|
|
138
99
|
}
|
|
139
100
|
|
|
140
101
|
// React Native defines a `window` but no `document` (and no `window.location`),
|
|
@@ -267,8 +228,6 @@ export class Analytics {
|
|
|
267
228
|
private started = false
|
|
268
229
|
/** The view pageview() last counted — path + location. */
|
|
269
230
|
private counted?: string
|
|
270
|
-
/** Parsed error-plane DSN, or null when the plane is inert. */
|
|
271
|
-
private dsn: Dsn | null
|
|
272
231
|
/** Guards against an error thrown *inside* the error path re-entering it. */
|
|
273
232
|
private reentrant = false
|
|
274
233
|
|
|
@@ -304,43 +263,14 @@ export class Analytics {
|
|
|
304
263
|
config.ingestKey ?? readEnv('NEXT_PUBLIC_PUBLISHABLE_KEY') ?? keyForPage(),
|
|
305
264
|
}
|
|
306
265
|
this.transport = config.transport ?? new DefaultTransport()
|
|
307
|
-
// Error plane, most specific source first: an explicit DSN wins, then the
|
|
308
|
-
// inlined build-time env (a per-deploy override), then the product registry —
|
|
309
|
-
// whose DSN carries the SAME resolved key (not a baked one), so declaring
|
|
310
|
-
// `product` + providing the key is enough to report errors. Malformed or
|
|
311
|
-
// absent => null => inert, never throwing into the host app.
|
|
312
|
-
this.dsn = parseDsn(
|
|
313
|
-
config.dsn ?? readEnvDsn() ?? dsnForProduct(this.cfg.product, this.cfg.ingestKey)
|
|
314
|
-
)
|
|
315
266
|
}
|
|
316
267
|
|
|
317
268
|
/** adopt gives this client a credential it does not have. The key belongs to
|
|
318
269
|
* the stream, not to whichever caller happened to ask for the handle first,
|
|
319
|
-
* so a later caller carrying one hands it over.
|
|
320
|
-
* the key, so it comes up here too when it was inert for want of one.
|
|
321
|
-
* Present fields are never overwritten: the first caller's key stays. */
|
|
270
|
+
* so a later caller carrying one hands it over. Present fields are never overwritten: the first caller's key stays. */
|
|
322
271
|
adopt(config: AnalyticsConfig): void {
|
|
323
272
|
if (config.ingestKey && !this.cfg.ingestKey) this.cfg.ingestKey = config.ingestKey
|
|
324
273
|
if (config.getToken && !this.cfg.getToken) this.cfg.getToken = config.getToken
|
|
325
|
-
if (!this.dsn) {
|
|
326
|
-
this.dsn = parseDsn(
|
|
327
|
-
config.dsn ?? readEnvDsn() ?? dsnForProduct(this.cfg.product, this.cfg.ingestKey),
|
|
328
|
-
)
|
|
329
|
-
}
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
/** errorPlaneEnabled reports whether captured exceptions can actually reach the
|
|
333
|
-
* error host. False means a DSN was never configured — the documented
|
|
334
|
-
* fail-safe. Exposed so an app (or a test) can assert its wiring instead of
|
|
335
|
-
* discovering months later that nothing was ever reported. */
|
|
336
|
-
get errorPlaneEnabled(): boolean {
|
|
337
|
-
return this.dsn !== null
|
|
338
|
-
}
|
|
339
|
-
|
|
340
|
-
/** errorIngestUrl is the fully-derived envelope endpoint, or undefined when the
|
|
341
|
-
* plane is inert. Diagnostics only. */
|
|
342
|
-
get errorIngestUrl(): string | undefined {
|
|
343
|
-
return this.dsn?.ingestUrl
|
|
344
274
|
}
|
|
345
275
|
|
|
346
276
|
/** init is idempotent and browser-only for its side effects: capture first-touch
|
|
@@ -383,10 +313,7 @@ export class Analytics {
|
|
|
383
313
|
window.addEventListener('visibilitychange', flushHidden)
|
|
384
314
|
window.addEventListener('pagehide', () => this.flush(true))
|
|
385
315
|
|
|
386
|
-
//
|
|
387
|
-
// rejected promises are reported on BOTH planes: a Sentry envelope to the DSN
|
|
388
|
-
// host (what reaches the error dashboard — requires a DSN) and a type:'error'
|
|
389
|
-
// event on the stream (product signal in the warehouse).
|
|
316
|
+
// Unhandled errors and rejected promises are reported as type:'error' events.
|
|
390
317
|
if (this.cfg.captureErrors) {
|
|
391
318
|
window.addEventListener('error', (e: ErrorEvent) => {
|
|
392
319
|
this.captureError(e.error ?? e.message, { handled: false })
|
|
@@ -462,71 +389,30 @@ export class Analytics {
|
|
|
462
389
|
}
|
|
463
390
|
|
|
464
391
|
/** captureError reports a caught error, an unhandled rejection, a React render
|
|
465
|
-
* error, or a manual report
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
*
|
|
470
|
-
* - the EVENT STREAM — a `type:'error'` row in the cloud event warehouse, so
|
|
471
|
-
* an error stays correlated with the session's pageviews for product
|
|
472
|
-
* analysis (readable via GET /v1/errors).
|
|
473
|
-
*
|
|
474
|
-
* Both carry the SAME session and subject id, so an error and the pageview
|
|
475
|
-
* before it join up. Never throws back into the app; errors are higher-signal
|
|
476
|
-
* than pageviews, so both planes flush promptly (a crash may unload the page
|
|
477
|
-
* moments later). */
|
|
392
|
+
* error, or a manual report as ONE event of type 'error' on the one stream.
|
|
393
|
+
* It carries the exception (type, message, frames, stack, handled) and the
|
|
394
|
+
* release, environment, site, product and level that group and scope it, and
|
|
395
|
+
* flushes promptly (a crash may unload the page moments later). Never throws
|
|
396
|
+
* back into the app. */
|
|
478
397
|
captureError(err: unknown, context?: CaptureErrorOptions): void {
|
|
479
398
|
// A failure inside the error path must not recurse through the global handlers.
|
|
480
399
|
if (this.reentrant) return
|
|
481
400
|
this.reentrant = true
|
|
482
401
|
try {
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
const handled = context?.handled ?? true
|
|
498
|
-
const ex = normalizeError(err)
|
|
499
|
-
ex.handled = handled
|
|
500
|
-
// NAME: the reserved '$exception', never the message. The message was the
|
|
501
|
-
// name until 0.3.20, which put every distinct error string — one per failed
|
|
502
|
-
// chunk id, per ResizeObserver notification — permanently into the event
|
|
503
|
-
// taxonomy, and left Error Tracking (which reads this exact name) at zero.
|
|
504
|
-
//
|
|
505
|
-
// TYPE 'event', not 'error'. `type` alone picks the storage plane: 'error'
|
|
506
|
-
// routes to the error plane, which the product-event projection does not
|
|
507
|
-
// read, so an exception filed there is invisible to Error Tracking however
|
|
508
|
-
// well-formed it is. The full error record still reaches the error plane as
|
|
509
|
-
// a Sentry envelope above — this row is the product-analytics breadcrumb,
|
|
510
|
-
// which is what keeps a crash correlated with the session's pageviews.
|
|
511
|
-
//
|
|
512
|
-
// `error` is still carried: the server folds it into properties.$exception
|
|
513
|
-
// (scrubbing message and stack on the way), which is the shape existing
|
|
514
|
-
// readers bind to.
|
|
515
|
-
this.enqueue('event', EXCEPTION, {
|
|
516
|
-
error: ex,
|
|
517
|
-
properties: {
|
|
518
|
-
...context?.properties,
|
|
519
|
-
...exceptionProperties(err, {
|
|
520
|
-
handled,
|
|
521
|
-
id: uuidv7(),
|
|
522
|
-
level: context?.level,
|
|
523
|
-
}),
|
|
524
|
-
},
|
|
525
|
-
})
|
|
526
|
-
this.flush()
|
|
527
|
-
} catch {
|
|
528
|
-
/* nor the reverse */
|
|
529
|
-
}
|
|
402
|
+
const handled = context?.handled ?? true
|
|
403
|
+
const ex = normalizeError(err)
|
|
404
|
+
ex.handled = handled
|
|
405
|
+
this.enqueue('error', undefined, {
|
|
406
|
+
error: ex,
|
|
407
|
+
level: context?.level ?? (handled ? 'error' : 'fatal'),
|
|
408
|
+
release: this.cfg.release ?? readEnv('NEXT_PUBLIC_HANZO_RELEASE'),
|
|
409
|
+
environment: this.cfg.environment ?? readEnv('NODE_ENV'),
|
|
410
|
+
site: isBrowser() ? window.location.hostname : undefined,
|
|
411
|
+
properties: context?.properties,
|
|
412
|
+
})
|
|
413
|
+
this.flush()
|
|
414
|
+
} catch {
|
|
415
|
+
/* the error path never takes the app down */
|
|
530
416
|
} finally {
|
|
531
417
|
this.reentrant = false
|
|
532
418
|
}
|
|
@@ -588,41 +474,6 @@ export class Analytics {
|
|
|
588
474
|
|
|
589
475
|
// ── internals ────────────────────────────────────────────────────────────
|
|
590
476
|
|
|
591
|
-
/** sendError frames one exception as a Sentry envelope and posts it to the DSN's
|
|
592
|
-
* ingest URL. The DSN's own key rides ?sentry_key= (the credential channel the
|
|
593
|
-
* server trusts, and the only one a headerless beacon can carry), so NO bearer
|
|
594
|
-
* or publishable key is attached here — the two planes authenticate
|
|
595
|
-
* independently. Errors are sent one envelope per event, immediately: batching
|
|
596
|
-
* a crash report is how you lose it. */
|
|
597
|
-
private sendError(err: unknown, options?: CaptureErrorOptions): void {
|
|
598
|
-
if (!this.cfg.enabled || !this.dsn) return
|
|
599
|
-
const event = buildSentryEvent({
|
|
600
|
-
error: err,
|
|
601
|
-
options,
|
|
602
|
-
identity: this.errorIdentity(),
|
|
603
|
-
capturePII: this.cfg.capturePII ?? false,
|
|
604
|
-
})
|
|
605
|
-
const body = buildEnvelope(event, this.dsn)
|
|
606
|
-
if (this.cfg.debug) console.debug('[event] error →', this.dsn.ingestUrl, event.event_id)
|
|
607
|
-
this.transport.send(this.dsn.ingestUrl, body, {
|
|
608
|
-
beacon: false,
|
|
609
|
-
contentType: ENVELOPE_CONTENT_TYPE,
|
|
610
|
-
debug: this.cfg.debug,
|
|
611
|
-
})
|
|
612
|
-
}
|
|
613
|
-
|
|
614
|
-
/** errorIdentity is the SAME identity the event stream stamps — the OIDC subject
|
|
615
|
-
* once identify() has run, else the anon id. Never email/PII. */
|
|
616
|
-
private errorIdentity(): ErrorIdentity {
|
|
617
|
-
return {
|
|
618
|
-
userId: this.personId ?? anonId(),
|
|
619
|
-
sessionId: sessionId(),
|
|
620
|
-
product: this.cfg.product,
|
|
621
|
-
release: this.cfg.release ?? readEnv('NEXT_PUBLIC_HANZO_RELEASE'),
|
|
622
|
-
environment: this.cfg.environment ?? readEnv('NODE_ENV'),
|
|
623
|
-
}
|
|
624
|
-
}
|
|
625
|
-
|
|
626
477
|
private enqueue(kind: EventKind, event: string | undefined, extra: Partial<WireEvent>): void {
|
|
627
478
|
if (!this.cfg.enabled) return
|
|
628
479
|
if (!this.started) this.init()
|
package/src/exception.ts
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
// throw site. framesFromStack (sentry.ts) already returns that order, which is why
|
|
30
30
|
// this module reuses it rather than re-parsing.
|
|
31
31
|
|
|
32
|
-
import { framesFromStack, normalizeError } from './
|
|
32
|
+
import { framesFromStack, normalizeError } from './throwable'
|
|
33
33
|
import type {
|
|
34
34
|
ExceptionEntry,
|
|
35
35
|
ExceptionFrame,
|
package/src/index.ts
CHANGED
|
@@ -15,12 +15,10 @@ export {
|
|
|
15
15
|
getCohort,
|
|
16
16
|
getFirstTouch,
|
|
17
17
|
} from './core'
|
|
18
|
-
export {
|
|
18
|
+
export { framesFromStack } from './throwable'
|
|
19
19
|
export { uuidv7, uuidv7Time } from './uid'
|
|
20
20
|
export { linkUrl, readLink, stripLink, LINK_PARAMS } from './link'
|
|
21
21
|
export type { LinkState } from './link'
|
|
22
|
-
export { PRODUCT_PROJECT, dsnForProduct } from './dsn'
|
|
23
|
-
export type { ErrorIdentity } from './sentry'
|
|
24
22
|
export { scrubText, redactSecrets, scrubPII } from './scrub'
|
|
25
23
|
export { EVENTS, EXCEPTION, PAGEVIEW } from './events'
|
|
26
24
|
export { exceptionEntry, exceptionProperties, fingerprint, digest } from './exception'
|
|
@@ -51,13 +49,11 @@ export type {
|
|
|
51
49
|
Attribution,
|
|
52
50
|
CaptureErrorOptions,
|
|
53
51
|
Cohort,
|
|
54
|
-
Dsn,
|
|
55
52
|
EventKind,
|
|
56
53
|
Exception,
|
|
57
54
|
ExceptionEntry,
|
|
58
55
|
ExceptionFrame,
|
|
59
56
|
ExceptionProperties,
|
|
60
|
-
SentryEvent,
|
|
61
57
|
SentryFrame,
|
|
62
58
|
SentryLevel,
|
|
63
59
|
Transport,
|
package/src/org.ts
CHANGED
|
@@ -51,11 +51,15 @@ export const ORG_DOMAIN: Readonly<Record<string, readonly string[]>> = Object.fr
|
|
|
51
51
|
// separate fact, which is the whole reason this is a table.
|
|
52
52
|
hanzo: Object.freeze([
|
|
53
53
|
'hanzo.ai',
|
|
54
|
+
'hanzo.agency',
|
|
54
55
|
'hanzo.app',
|
|
55
56
|
'hanzo.bot',
|
|
56
57
|
'hanzo.chat',
|
|
57
58
|
'hanzo.codes',
|
|
58
59
|
'hanzo.id',
|
|
60
|
+
'hanzo.industries',
|
|
61
|
+
'hanzo.market',
|
|
62
|
+
'hanzo.network',
|
|
59
63
|
'hanzo.sh',
|
|
60
64
|
'hanzo.team',
|
|
61
65
|
'hanzo.ventures',
|
package/src/stream.test.ts
CHANGED
|
@@ -81,13 +81,6 @@ describe('one stream, one client', () => {
|
|
|
81
81
|
expect(tx.sent[0].token).toBe(KEY)
|
|
82
82
|
})
|
|
83
83
|
|
|
84
|
-
it('brings up the error plane on the key it adopts', () => {
|
|
85
|
-
const a = createAnalytics({ product: 'console', host: HOST, transport: tx })
|
|
86
|
-
expect(a.errorPlaneEnabled).toBe(false)
|
|
87
|
-
createAnalytics({ product: 'console', host: HOST, ingestKey: KEY })
|
|
88
|
-
expect(a.errorPlaneEnabled).toBe(true)
|
|
89
|
-
})
|
|
90
|
-
|
|
91
84
|
it('keeps the first credential rather than overwriting it', () => {
|
|
92
85
|
createAnalytics({ product: 'site', host: HOST, ingestKey: KEY, transport: tx })
|
|
93
86
|
createAnalytics({ product: 'site', host: HOST, ingestKey: 'pk-second' }).capture('x')
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { describe, it, expect } from 'vitest'
|
|
2
|
+
import { framesFromStack, normalizeError } from './throwable'
|
|
3
|
+
|
|
4
|
+
describe('framesFromStack', () => {
|
|
5
|
+
it('parses a V8 stack oldest-first with in_app marking', () => {
|
|
6
|
+
const stack = [
|
|
7
|
+
'TypeError: x is not a function',
|
|
8
|
+
' at inner (https://app.hanzo.ai/app.js:10:5)',
|
|
9
|
+
' at outer (https://app.hanzo.ai/app.js:20:1)',
|
|
10
|
+
' at eval (webpack-internal:///./node_modules/lib/index.js:3:2)',
|
|
11
|
+
].join('\n')
|
|
12
|
+
const frames = framesFromStack(stack)
|
|
13
|
+
expect(frames).toHaveLength(3)
|
|
14
|
+
// oldest-first: the node_modules frame is the outermost caller (first),
|
|
15
|
+
// the crash site (inner) is last.
|
|
16
|
+
expect(frames[frames.length - 1].function).toBe('inner')
|
|
17
|
+
expect(frames[frames.length - 1].lineno).toBe(10)
|
|
18
|
+
expect(frames[frames.length - 1].in_app).toBe(true)
|
|
19
|
+
expect(frames[0].function).toBe('eval')
|
|
20
|
+
expect(frames[0].in_app).toBe(false) // node_modules
|
|
21
|
+
})
|
|
22
|
+
it('parses a Firefox/Safari stack (fn@file:li:co and bare @file)', () => {
|
|
23
|
+
const stack = ['boom@https://app.hanzo.ai/a.js:1:2', '@https://app.hanzo.ai/b.js:3:4'].join('\n')
|
|
24
|
+
const frames = framesFromStack(stack)
|
|
25
|
+
expect(frames).toHaveLength(2)
|
|
26
|
+
expect(frames[frames.length - 1].function).toBe('boom')
|
|
27
|
+
expect(frames[frames.length - 1].filename).toBe('https://app.hanzo.ai/a.js')
|
|
28
|
+
})
|
|
29
|
+
it('skips the header line and tolerates junk', () => {
|
|
30
|
+
expect(framesFromStack('Error: nope\n total garbage line')).toHaveLength(0)
|
|
31
|
+
expect(framesFromStack(undefined)).toHaveLength(0)
|
|
32
|
+
})
|
|
33
|
+
})
|
|
34
|
+
|
|
35
|
+
describe('normalizeError', () => {
|
|
36
|
+
it('coerces Error, string, and objects', () => {
|
|
37
|
+
expect(normalizeError(new RangeError('r')).name).toBe('RangeError')
|
|
38
|
+
expect(normalizeError('boom')).toEqual({ name: 'Error', message: 'boom' })
|
|
39
|
+
expect(normalizeError({ a: 1 }).message).toBe('{"a":1}')
|
|
40
|
+
})
|
|
41
|
+
})
|
|
42
|
+
|
|
43
|
+
describe('normalizeError survives hostile input', () => {
|
|
44
|
+
const bomb = (prop: string) => {
|
|
45
|
+
const e = new Error('real message')
|
|
46
|
+
Object.defineProperty(e, prop, {
|
|
47
|
+
get() {
|
|
48
|
+
throw new Error(prop + ' bomb')
|
|
49
|
+
},
|
|
50
|
+
configurable: true,
|
|
51
|
+
})
|
|
52
|
+
return e
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
for (const prop of ['stack', 'message', 'name']) {
|
|
56
|
+
it(`a throwing ${prop} getter does not throw`, () => {
|
|
57
|
+
expect(() => normalizeError(bomb(prop))).not.toThrow()
|
|
58
|
+
const n = normalizeError(bomb(prop))
|
|
59
|
+
expect(typeof n.name).toBe('string')
|
|
60
|
+
expect(typeof n.message).toBe('string')
|
|
61
|
+
})
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
it('an object with a throwing toString is still reportable', () => {
|
|
65
|
+
const evil = {
|
|
66
|
+
toString() {
|
|
67
|
+
throw new Error('toString bomb')
|
|
68
|
+
},
|
|
69
|
+
}
|
|
70
|
+
expect(() => normalizeError(evil)).not.toThrow()
|
|
71
|
+
})
|
|
72
|
+
})
|
package/src/throwable.ts
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
// Pure throwable parsing: coerce anything thrown into {name, message, stack} and
|
|
2
|
+
// parse a browser stack into frames. No I/O, no globals.
|
|
3
|
+
|
|
4
|
+
import type { SentryFrame } from './types'
|
|
5
|
+
|
|
6
|
+
const MAX_FRAMES = 50
|
|
7
|
+
/** Max stack lines examined, and max length of a line worth examining. Guards the
|
|
8
|
+
* frame regexes against a hostile `stack` string (see framesFromStack). */
|
|
9
|
+
const MAX_LINES = 500
|
|
10
|
+
const MAX_LINE_LEN = 2048
|
|
11
|
+
|
|
12
|
+
const V8_FRAME = /^\s*at\s+(?:(.+?)\s+\()?(?:(.+?):(\d+):(\d+)|([^)]+))\)?\s*$/
|
|
13
|
+
const MOZ_FRAME = /^\s*(?:(.*?)@)?(.+?):(\d+):(\d+)\s*$/
|
|
14
|
+
|
|
15
|
+
/** inApp marks a frame as the app's own code (vs vendor/runtime) for grouping. */
|
|
16
|
+
function inApp(file: string): boolean {
|
|
17
|
+
if (!file) return false
|
|
18
|
+
return !(
|
|
19
|
+
file.includes('node_modules') ||
|
|
20
|
+
file.startsWith('webpack-internal') ||
|
|
21
|
+
file.startsWith('webpack://') ||
|
|
22
|
+
file.startsWith('chrome-extension://') ||
|
|
23
|
+
file.startsWith('moz-extension://')
|
|
24
|
+
)
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* framesFromStack parses a browser Error.stack into Sentry frames, OLDEST-FIRST
|
|
29
|
+
* (Sentry orders caller->callee; the crash site is last — matching the server's
|
|
30
|
+
* pickCrashFrame). Handles both V8 ("at fn (file:li:co)") and
|
|
31
|
+
* Firefox/Safari ("fn@file:li:co"). Unparseable lines are skipped.
|
|
32
|
+
*/
|
|
33
|
+
export function framesFromStack(stack: string | undefined): SentryFrame[] {
|
|
34
|
+
if (!stack) return []
|
|
35
|
+
// Both frame regexes use lazy nested quantifiers, which backtrack badly on a
|
|
36
|
+
// long line that never matches. A stack is attacker-influenced (a thrown value
|
|
37
|
+
// can carry any `stack` string), so bound the work: skip absurd lines and stop
|
|
38
|
+
// after MAX_LINES. Only the innermost MAX_FRAMES are kept anyway.
|
|
39
|
+
const lines = stack.split('\n', MAX_LINES)
|
|
40
|
+
const frames: SentryFrame[] = []
|
|
41
|
+
for (const raw of lines) {
|
|
42
|
+
if (raw.length > MAX_LINE_LEN) continue
|
|
43
|
+
const line = raw.trimEnd()
|
|
44
|
+
if (!line) continue
|
|
45
|
+
// Header lines like "TypeError: x is not a function" match neither frame
|
|
46
|
+
// regex (no "at " prefix, no trailing :line:col) and are skipped naturally.
|
|
47
|
+
let fn: string | undefined
|
|
48
|
+
let file = ''
|
|
49
|
+
let lineno = 0
|
|
50
|
+
let colno = 0
|
|
51
|
+
const v = V8_FRAME.exec(line)
|
|
52
|
+
if (v) {
|
|
53
|
+
fn = v[1]
|
|
54
|
+
if (v[2]) {
|
|
55
|
+
file = v[2]
|
|
56
|
+
lineno = Number(v[3]) || 0
|
|
57
|
+
colno = Number(v[4]) || 0
|
|
58
|
+
} else {
|
|
59
|
+
file = (v[5] || '').trim()
|
|
60
|
+
}
|
|
61
|
+
} else {
|
|
62
|
+
const f = MOZ_FRAME.exec(line)
|
|
63
|
+
if (!f) continue
|
|
64
|
+
fn = f[1]
|
|
65
|
+
file = f[2]
|
|
66
|
+
lineno = Number(f[3]) || 0
|
|
67
|
+
colno = Number(f[4]) || 0
|
|
68
|
+
}
|
|
69
|
+
if (!file && !fn) continue
|
|
70
|
+
frames.push({
|
|
71
|
+
function: fn || '<anonymous>',
|
|
72
|
+
filename: file,
|
|
73
|
+
abs_path: file,
|
|
74
|
+
lineno,
|
|
75
|
+
colno,
|
|
76
|
+
in_app: inApp(file),
|
|
77
|
+
})
|
|
78
|
+
}
|
|
79
|
+
// Reverse to oldest-first and cap to the innermost MAX_FRAMES.
|
|
80
|
+
frames.reverse()
|
|
81
|
+
if (frames.length > MAX_FRAMES) return frames.slice(frames.length - MAX_FRAMES)
|
|
82
|
+
return frames
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/** normalizeError coerces an unknown throwable into {name, message, stack}. */
|
|
86
|
+
export function normalizeError(err: unknown): { name: string; message: string; stack?: string } {
|
|
87
|
+
if (err instanceof Error) {
|
|
88
|
+
// `name`, `message` and `stack` are ordinary getters, and the thrown object is
|
|
89
|
+
// the least trustworthy input this library handles — any of them may throw.
|
|
90
|
+
// Losing the whole report to a hostile getter is not acceptable.
|
|
91
|
+
const name = read(err, 'name')
|
|
92
|
+
const message = read(err, 'message')
|
|
93
|
+
const stack = read(err, 'stack')
|
|
94
|
+
return {
|
|
95
|
+
name: typeof name === 'string' && name ? name : 'Error',
|
|
96
|
+
message: typeof message === 'string' && message ? message : str(err),
|
|
97
|
+
stack: typeof stack === 'string' ? stack : undefined,
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
if (typeof err === 'string') return { name: 'Error', message: err }
|
|
101
|
+
try {
|
|
102
|
+
return { name: 'Error', message: JSON.stringify(err) ?? str(err) }
|
|
103
|
+
} catch {
|
|
104
|
+
return { name: 'Error', message: str(err) }
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/** read pulls a property off a possibly-hostile value without letting a throwing
|
|
109
|
+
* getter escape. */
|
|
110
|
+
function read(o: unknown, k: string): unknown {
|
|
111
|
+
try {
|
|
112
|
+
return (o as Record<string, unknown>)[k]
|
|
113
|
+
} catch {
|
|
114
|
+
return undefined
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
/** str coerces to a string without letting a throwing toString/Symbol.toPrimitive
|
|
119
|
+
* escape. */
|
|
120
|
+
function str(v: unknown): string {
|
|
121
|
+
try {
|
|
122
|
+
return String(v)
|
|
123
|
+
} catch {
|
|
124
|
+
return '[unstringifiable]'
|
|
125
|
+
}
|
|
126
|
+
}
|