Skip to content

ref(replay): Extract some functions out from class #6448

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.

Sign up for GitHub

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

Merged
merged 15 commits into from
Dec 9, 2022
Merged

ref(replay): Extract some functions out from class #6448

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
737adb2
ref(replay): Extract `overwriteRecordDroppedEvent` into fn
mydea Dec 6, 2022
a558935
ref(replay): Extract span listeners out
mydea Dec 6, 2022
db1ab04
ref(replay): Extract handleGlobalEvent handler out
mydea Dec 6, 2022
edd132a
ref(replay): Fix accidental renaming
mydea Dec 6, 2022
391a22c
ref(replay): Extract performanceObserver out
mydea Dec 6, 2022
229bd51
ref(replay): Make some things public
mydea Dec 6, 2022
721e682
ref(replay): Extract addEvent out
mydea Dec 6, 2022
d7a3e3a
ref(replay): Extract createPerformanceSpans out
mydea Dec 6, 2022
e026241
ref(replay): Extract addMemoryEntry out
mydea Dec 6, 2022
3791c69
doc(replay): Add jsdoc to extracted functions
mydea Dec 7, 2022
37efedb
ref(replay): Only import types for extracted replay functions
mydea Dec 7, 2022
efc9525
build(replay): Skip type imports for circular dependency check
mydea Dec 7, 2022
432da15
ref(replay): PR feedback
mydea Dec 7, 2022
f7caf64
ref(replay): Extract types into `types.ts`
mydea Dec 7, 2022
cf54a67
ref(replay): Make `addMemoryEntry` and `createPerformanceSpans` to sync
mydea Dec 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
ref(replay): PR feedback
  • Loading branch information
@mydea
mydea committed Dec 9, 2022
commit 432da151e3b3b76251c570c4bf123044319055ef
10 changes: 6 additions & 4 deletions packages/replay/src/coreHandlers/handleGlobalEvent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,15 @@ export function handleGlobalEventListener(replay: ReplayContainer): (event: Even

// Collect traceIds in _context regardless of `_waitForError` - if it's true,
// _context gets cleared on every checkout
if (event.type === 'transaction') {
replay.getContext().traceIds.add(String(event.contexts?.trace?.trace_id || ''));
if (event.type === 'transaction' && event.contexts && event.contexts.trace && event.contexts.trace.trace_id) {
replay.getContext().traceIds.add(event.contexts.trace.trace_id as string);
return event;
}

// XXX: Is it safe to assume that all other events are error events?
replay.getContext().errorIds.add(event.event_id as string);
// no event type means error
if (!event.type) {
replay.getContext().errorIds.add(event.event_id as string);
}

const exc = event.exception?.values?.[0];
addInternalBreadcrumb({
Expand Down
15 changes: 7 additions & 8 deletions packages/replay/src/util/addMemoryEntry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,13 @@ import { createPerformanceSpans } from './createPerformanceSpans';
* (including v8 internal objects).
*/
export function addMemoryEntry(replay: ReplayContainer): Promise<void[]> | undefined {
Copy link
Member

@AbhiPrasad AbhiPrasad Dec 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: can we change the func signature here to just be void? Then we don't need the return statements and we can also just void createPerformanceSpans

Copy link
Member Author

@mydea mydea Dec 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good finding, there is actually nothing async about this 😅 so should be good to clean up. done!

Copy link
Member

@billyvg billyvg Dec 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addEvent should be async

Copy link
Member Author

@mydea mydea Dec 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addEvent was also sync before, and we are not really waiting for it anywhere?

Copy link
Member

@billyvg billyvg Dec 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 , it may have been a bug -- eventbuffer's addevent is async, looks like replay.addEvent was not returning the promise.

Copy link
Member Author

@mydea mydea Dec 9, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I think you're right - but I'll make a separate PR to fix that 👍

// window.performance.memory is a non-standard API and doesn't work on all browsers
// so we check before creating the event.
if (!('memory' in WINDOW.performance)) {
// window.performance.memory is a non-standard API and doesn't work on all browsers, so we try-catch this
try {
return createPerformanceSpans(replay, [
// @ts-ignore memory doesn't exist on type Performance as the API is non-standard (we check that it exists above)
createMemoryEntry(WINDOW.performance.memory),
]);
} catch (error) {
return;
}

return createPerformanceSpans(replay, [
// @ts-ignore memory doesn't exist on type Performance as the API is non-standard (we check that it exists above)
createMemoryEntry(WINDOW.performance.memory),
]);
}