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.

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

[Feature] Include takeFullSnapshot function in rrweb #1527

Merged
merged 2 commits into from
Jul 3, 2024

Conversation

arredgroup
Copy link
Contributor

Added takeFullSnapshot function to allow retake a snapshot if user decide pause recording (avoid emit function) and after resume with an updated screen

Copy link

changeset-bot bot commented Jun 27, 2024

🦋 Changeset detected

Latest commit: 3ac0ad7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 18 packages
Name Type
rrweb Patch
rrweb-snapshot Patch
rrdom Patch
rrdom-nodejs Patch
rrweb-player Patch
@rrweb/all Patch
@rrweb/replay Patch
@rrweb/record Patch
@rrweb/types Patch
@rrweb/packer Patch
@rrweb/web-extension Patch
rrvideo Patch
@rrweb/rrweb-plugin-console-record Patch
@rrweb/rrweb-plugin-console-replay Patch
@rrweb/rrweb-plugin-sequential-id-record Patch
@rrweb/rrweb-plugin-sequential-id-replay Patch
@rrweb/rrweb-plugin-canvas-webrtc-record Patch
@rrweb/rrweb-plugin-canvas-webrtc-replay Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@Juice10
Copy link
Contributor

Juice10 commented Jun 28, 2024

Hi @arredgroup, thanks for the contribution. After reading your description I'm still not sure I fully understand the use case. Could you elaborate a bit on this topic?

Also maybe this is a better fit for @rrweb/record instead of rrweb itself, but that depends on the use case I guess.

@arredgroup
Copy link
Contributor Author

Hi @arredgroup, thanks for the contribution. After reading your description I'm still not sure I fully understand the use case. Could you elaborate a bit on this topic?

Also maybe this is a better fit for @rrweb/record instead of rrweb itself, but that depends on the use case I guess.

Sure, we are using rrweb, but in some specific paths, for data security we need to pause the recording and continue, to do that, we decide to stop the emit event, with a return before data is enqueued, but we need to take a full snapshot to refresh the screen recording when pause is finished.

the idea is use this method to avoid stop the recording and start other.

Copy link
Member

@YunFeng0817 YunFeng0817 left a comment

Choose a reason for hiding this comment

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

I agree with exporting this function explicitly. This function is defined similarly to addCustomEvent and freezePage, both of which were exported long ago. Therefore, it makes sense to also export takeFullSnapshot.

@Juice10 Juice10 merged commit 68076b7 into rrweb-io:master Jul 3, 2024
6 checks passed
@eoghanmurray
Copy link
Contributor

Anything exported in packages/rrweb/src/record/index.ts should also be exported by packages/record/src/index.ts I think?

jeffdnguyen pushed a commit to pendo-io/rrweb that referenced this pull request Jul 29, 2024
jeffdnguyen pushed a commit to pendo-io/rrweb that referenced this pull request Jul 29, 2024
jxiwang pushed a commit to amplitude/rrweb that referenced this pull request Oct 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants