fix(replays): Show the correct Replay config option name maskFn
#8169
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
billyvg
reviewed
May 19, 2023
| /** | ||
| * A callback function to customize how your text is masked. | ||
| */ | ||
| maskFn?: Pick<RecordingOptions, 'maskTextFn'>; |
Member
There was a problem hiding this comment.
So this is correct because it comes from rrweb
Member
There was a problem hiding this comment.
Ah nevermind, I misread, you're right!
billyvg
approved these changes
May 19, 2023
| /** | ||
| * A callback function to customize how your text is masked. | ||
| */ | ||
| maskFn?: Pick<RecordingOptions, 'maskTextFn'>; |
Member
There was a problem hiding this comment.
Ah nevermind, I misread, you're right!
Member
Author
|
@billyvg it might make sense to go through more deeply and align the names internally in the codebase too. I'm not the authority on what we should be publishing here, but we're passing |
Member
|
|
Contributor
size-limit report 📦
|
Member
Author
ok! |
Lms24
approved these changes
May 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Typescript says that the function is called
maskFn, but the tests are passing inmaskTextFnto something...Something is inconsistent, and either way the type,
Pick<RecordingOptions, 'maskTextFn'>, is wrong!!! RecordingOptions doesn't have eithermaskFnormaskTextFn, it's coming from here: https://github.com/getsentry/sentry-javascript/blob/ryan953/replay-maskFn-docs/packages/replay/src/types/rrweb.ts#L32-L41https://github.com/getsentry/sentry-javascript/blob/master/packages/replay/src/types.ts#L314-L317
See also: getsentry/sentry-docs#6988