feat(core): Add `replay_event` type for events #6481

mydea · 2022-12-09T08:26:33Z

As a first step for #6480, this adds the replay event type.

Note that replay is a bit special, in that it has two event types: replay_event and replay_recording. These are sent in one envelope, where replay_event contains the replay metadata etc, and replay_recording the actual recording as string.

IMHO for the event type we have here it is sufficient to have replay_event, as the replay_recording is not really passed around but only need to be considered when we (eventually) build the envelope.

mydea · 2022-12-09T08:27:17Z

packages/core/src/hub.ts

  public captureEvent(event: Event, hint?: EventHint): string {
    const eventId = hint && hint.event_id ? hint.event_id : uuid4();
-    if (event.type !== 'transaction') {
+    if (!event.type) {


Question: I guess replays should not count here? (Eventually - currently they do not go through this method at all)

Reading #3966, I think you're right.

We might also add a test for the new event type here:

sentry-javascript/packages/hub/test/hub.test.ts

Lines 360 to 373 in c68d429

test('transactions do not set lastEventId', () => {

const event: Event = {

extra: { b: 3 },

type: 'transaction',

};

const testClient = makeClient();

const hub = new Hub(testClient);

hub.captureEvent(event);

const args = getPassedArgs(testClient.captureEvent);

expect(args[1].event_id).not.toEqual(hub.lastEventId());

});

done in 37535a0

github-actions · 2022-12-09T08:56:53Z

size-limit report 📦

Path	Size
@sentry/browser - ES5 CDN Bundle (gzipped + minified)	19.82 KB (+0.1% 🔺)
@sentry/browser - ES5 CDN Bundle (minified)	61.36 KB (+0.08% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped + minified)	18.6 KB (+0.11% 🔺)
@sentry/browser - ES6 CDN Bundle (minified)	54.92 KB (+0.08% 🔺)
@sentry/browser - Webpack (gzipped + minified)	20.37 KB (+0.1% 🔺)
@sentry/browser - Webpack (minified)	66.54 KB (+0.07% 🔺)
@sentry/react - Webpack (gzipped + minified)	20.39 KB (+0.1% 🔺)
@sentry/nextjs Client - Webpack (gzipped + minified)	47.64 KB (+0.04% 🔺)
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified)	26.79 KB (+0.09% 🔺)
@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified)	25.22 KB (+0.07% 🔺)
@sentry/replay ES6 CDN Bundle (gzipped + minified)	42.99 KB (-0.03% 🔽)
@sentry/replay - Webpack (gzipped + minified)	37.68 KB (-0.02% 🔽)

Lms24 · 2022-12-09T08:58:43Z

packages/core/src/hub.ts

  public captureEvent(event: Event, hint?: EventHint): string {
    const eventId = hint && hint.event_id ? hint.event_id : uuid4();
-    if (event.type !== 'transaction') {
+    if (!event.type) {


Reading #3966, I think you're right.

Lms24 · 2022-12-09T09:01:50Z

packages/core/src/hub.ts

  public captureEvent(event: Event, hint?: EventHint): string {
    const eventId = hint && hint.event_id ? hint.event_id : uuid4();
-    if (event.type !== 'transaction') {
+    if (!event.type) {


We might also add a test for the new event type here:

sentry-javascript/packages/hub/test/hub.test.ts

Lines 360 to 373 in c68d429

test('transactions do not set lastEventId', () => {

const event: Event = {

extra: { b: 3 },

type: 'transaction',

};

const testClient = makeClient();

const hub = new Hub(testClient);

hub.captureEvent(event);

const args = getPassedArgs(testClient.captureEvent);

expect(args[1].event_id).not.toEqual(hub.lastEventId());

});

mydea · 2022-12-09T09:06:22Z

packages/core/src/envelope.ts

+
+  // TODO: Handle replay_event here
+  // Currently, this is done by replay, but we want to upstream this here
+  const eventType = event.type && event.type !== 'replay_event' ? event.type : 'event';


To note, this is technically correct, but may increase the bundle size slightly for "nothing", as this will not really be hit right now. I'd still rather leave this in and remove it once we (hopefully soon!) actually handle replay events "normally". WDYT?

Sounds good to me.

billyvg · 2022-12-09T15:47:57Z

packages/replay/src/coreHandlers/handleGlobalEvent.ts


    // Only tag transactions with replayId if not waiting for an error
    // @ts-ignore private
-    if (event.type !== 'transaction' || !replay._waitForError) {


What's the reason for this change?

To be explicit that we only want this when the event is an error. This is IMHO more future proof, as when/if we add further event types, we'll need to explicitly handle them.

github-actions · 2023-01-03T00:22:36Z

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

mydea requested review from AbhiPrasad, Lms24, billyvg and lforst December 9, 2022 08:26

mydea self-assigned this Dec 9, 2022

mydea commented Dec 9, 2022

View reviewed changes

mydea force-pushed the fn/add-replay-types branch from 71839e0 to 2a68ccf Compare December 9, 2022 08:47

Lms24 approved these changes Dec 9, 2022

View reviewed changes

mydea commented Dec 9, 2022

View reviewed changes

mydea force-pushed the fn/add-replay-types branch 2 times, most recently from 37535a0 to 4e35eb8 Compare December 9, 2022 12:31

billyvg reviewed Dec 9, 2022

View reviewed changes

mydea mentioned this pull request Dec 12, 2022

ref(replay): Avoid using private hub._withClient #6494

Merged

github-actions bot added the Status: Stale label Jan 3, 2023

mydea added Status: In Progress and removed Status: Stale labels Jan 3, 2023

mydea force-pushed the fn/add-replay-types branch from 4e35eb8 to 0e74f6a Compare January 4, 2023 09:46

mydea added 4 commits January 4, 2023 16:14

feat(core): Add replay_event type for events

d35c559

ref: PR fixes

997b275

ref: Add test for lastEventId

5f3b7cd

ref: Export EventType type

4e87368

mydea force-pushed the fn/add-replay-types branch from 0e74f6a to 4e87368 Compare January 4, 2023 15:16

mydea merged commit 6cfd730 into master Jan 5, 2023

mydea deleted the fn/add-replay-types branch January 5, 2023 08:22

shouze mentioned this pull request May 2, 2023

Errors with ky / globalThis.fetch when trying to upgrade @sentry/nextjs > 7.29.0: typeerror, cannot read properties of undefined (reading 'bind') #7070

Closed

3 tasks


	test('transactions do not set lastEventId', () => {
	const event: Event = {
	extra: { b: 3 },
	type: 'transaction',
	};
	const testClient = makeClient();
	const hub = new Hub(testClient);

	hub.captureEvent(event);
	const args = getPassedArgs(testClient.captureEvent);

	expect(args[1].event_id).not.toEqual(hub.lastEventId());
	});

Uh oh!

feat(core): Add replay_event type for events #6481

feat(core): Add replay_event type for events #6481

Uh oh!

Conversation

mydea commented Dec 9, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 3, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat(core): Add `replay_event` type for events #6481

feat(core): Add `replay_event` type for events #6481

github-actions bot commented Dec 9, 2022 •

edited

Loading