Skip to content
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

Jump to bottom

ref(replay): Split replay integration & container class #6407

Merged
merged 3 commits into from
Dec 6, 2022
Merged

ref(replay): Split replay integration & container class #6407

merged 3 commits into from
Dec 6, 2022

Conversation

mydea
Copy link
Member

@mydea mydea commented Dec 5, 2022

A part of #6406, this splits up the main index.ts file of replay into two parts:

  1. The actual Sentry SDK Integration class. The main concern of this is to handle the setup etc.
  2. A Replay Container class which encapsulates the replay state, as well as all the actual functionality etc.

@mydea mydea added the Package: replay Issues related to the Sentry Replay SDK label Dec 5, 2022
@mydea mydea requested review from billyvg and Lms24 December 5, 2022 09:53
@mydea mydea self-assigned this Dec 5, 2022
@mydea mydea mentioned this pull request Dec 5, 2022
Closed
3 tasks
github-advanced-security[bot]
github-advanced-security bot found potential problems Dec 5, 2022
View reviewed changes
packages/replay/src/replay.ts
}

if (session.id !== this.session?.id) {
session.previousSessionId = this.session?.id;

Check failure

Code scanning / CodeQL

Insecure randomness

This uses a cryptographically insecure random number generated at [Math.random()](1) in a security context.
@github-actions
Copy link
Contributor

github-actions bot commented Dec 5, 2022 •
edited
Loading

size-limit report 📦

Path Size
@sentry/browser - ES5 CDN Bundle (gzipped + minified) 19.67 KB (-0.03% 🔽)
@sentry/browser - ES5 CDN Bundle (minified) 60.94 KB (0%)
@sentry/browser - ES6 CDN Bundle (gzipped + minified) 18.46 KB (0%)
@sentry/browser - ES6 CDN Bundle (minified) 54.49 KB (0%)
@sentry/browser - Webpack (gzipped + minified) 20.26 KB (0%)
@sentry/browser - Webpack (minified) 66.24 KB (0%)
@sentry/react - Webpack (gzipped + minified) 20.29 KB (0%)
@sentry/nextjs Client - Webpack (gzipped + minified) 47.14 KB (0%)
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified) 26.52 KB (0%)
@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified) 24.96 KB (+0.02% 🔺)
@sentry/replay ES6 CDN Bundle (gzipped + minified) 41.79 KB (-0.36% 🔽)
@sentry/replay - Webpack (gzipped + minified) 37.91 KB (+0.06% 🔺)

Lms24
Lms24 approved these changes Dec 5, 2022
View reviewed changes
Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

I like the change because a) single responsibility is always good and b) (as we previously discussed) it gets us one step closer to converting the replay logic into a functional structure. We can start thinking about this if we have the time after we finish our other points on the roadmap. Added a point to #5326.

packages/replay/test/unit/index-integrationSettings.test.ts Outdated
describe('integration settings', () => {
describe('blockAllMedia', () => {
it('sets the correct configuration when `blockAllMedia` is disabled', async () => {
const { replay } = await mockSdk({ replayOptions: { blockAllMedia: false } });
Copy link
Member

Choose a reason for hiding this comment

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

Good change (never knew that the previous syntax actually works 🤔 )

Copy link
Member Author

Choose a reason for hiding this comment

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

yeah, we should prob. do that everywhere! But just stumbled over this because of some other refactoring made necessary here 😅

@mydea
Copy link
Member Author

mydea commented Dec 5, 2022

Note: I also added an entry to the MIGRATION docs.

billyvg
billyvg approved these changes Dec 5, 2022
View reviewed changes
packages/replay/src/index.ts Outdated Show resolved Hide resolved
@mydea mydea force-pushed the fn/replay-split branch 3 times, most recently from 09c1797 to 23c964d Compare December 6, 2022 12:30
@mydea mydea merged commit 591f9cb into master Dec 6, 2022
@mydea mydea deleted the fn/replay-split branch December 6, 2022 13:10
@Lms24 Lms24 mentioned this pull request Dec 22, 2022
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lms24 Lms24 Lms24 approved these changes

@billyvg billyvg billyvg approved these changes

Assignees

@mydea mydea

Labels
Package: replay Issues related to the Sentry Replay SDK
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mydea @billyvg @Lms24