feat(plugin-session-replay-react-native): pass maskLevel through to native SessionReplay #1771
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| export { SessionReplayPlugin } from './session-replay'; | ||
| export { type SessionReplayConfig, MaskLevel, PrivacyConfig } from './session-replay-config'; | ||
|
|
||
| export { AmpMaskView } from './app-mask-view'; | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,78 @@ | ||
| import { LogLevel } from '@amplitude/analytics-types'; | ||
|
|
||
| /** | ||
| * Masking levels for sensitive content in session replay | ||
| */ | ||
| export enum MaskLevel { | ||
| /** | ||
| * Light masking - minimal content is masked | ||
| */ | ||
| Light = 'light', | ||
| /** | ||
| * Medium masking - balanced approach to content masking | ||
| */ | ||
| Medium = 'medium', | ||
| /** | ||
| * Conservative masking - maximum content masking for privacy | ||
| */ | ||
| Conservative = 'conservative', | ||
| } | ||
|
|
||
| export interface PrivacyConfig { | ||
| maskLevel?: MaskLevel; | ||
| } | ||
|
|
||
| /** | ||
| * Configuration for the Session Replay React Native plugin. | ||
| * | ||
| * Unlike the standalone `@amplitude/session-replay-react-native` SDK, the | ||
| * plugin auto-sources `apiKey`, `deviceId`, `sessionId`, and `serverZone` | ||
| * from the analytics client's `ReactNativeConfig` at `setup()` time, so | ||
| * those fields are intentionally absent from the public plugin config. | ||
| * The plugin also never shipped a deprecated top-level `maskLevel`, so no | ||
| * input-boundary normalization (and no `SessionReplayConfigInternal` alias) | ||
| * is needed here. | ||
| */ | ||
| export interface SessionReplayConfig { | ||
| /** | ||
| * Whether to automatically start recording when the plugin is added | ||
| * @default true | ||
| */ | ||
| autoStart?: boolean; | ||
|
|
||
| /** | ||
| * Whether to enable remote configuration | ||
| * @default true | ||
| */ | ||
| enableRemoteConfig?: boolean; | ||
|
|
||
| /** | ||
| * Log level for the SDK | ||
| * @default LogLevel.Warn | ||
| */ | ||
| logLevel?: LogLevel; | ||
|
|
||
| /** | ||
| * Privacy configuration for session replay | ||
| * @default { maskLevel: MaskLevel.Medium } | ||
| */ | ||
| privacyConfig?: PrivacyConfig; | ||
|
|
||
| /** | ||
| * Sample rate for session replay (0.0 to 1.0) | ||
| * Determines what percentage of sessions will be recorded | ||
| * @default 0 | ||
| */ | ||
| sampleRate?: number; | ||
| } | ||
|
|
||
| export const getDefaultConfig: () => Required<SessionReplayConfig> = () => { | ||
| return { | ||
| autoStart: true, | ||
| enableRemoteConfig: true, | ||
| logLevel: LogLevel.Warn, | ||
| privacyConfig: { maskLevel: MaskLevel.Medium }, | ||
| sampleRate: 0, | ||
| }; | ||
| }; | ||
| export { LogLevel }; |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,7 +8,8 @@ import type { EnrichmentPlugin, Event, ReactNativeClient, ReactNativeConfig } fr | |
| import { PluginSessionReplayReactNative } from './native-module'; | ||
| import { VERSION } from './version'; | ||
| import { SessionReplayConfig, getDefaultConfig } from './session-replay-config'; | ||
|
|
||
| type ResolvedSessionReplayConfig = Required<SessionReplayConfig>; | ||
|
|
||
| export class SessionReplayPlugin implements EnrichmentPlugin<ReactNativeClient, ReactNativeConfig> { | ||
| name = '@amplitude/plugin-session-replay-react-native'; | ||
|
|
@@ -19,7 +20,7 @@ export class SessionReplayPlugin implements EnrichmentPlugin<ReactNativeClient, | |
| config: ReactNativeConfig; | ||
| isInitialized = false; | ||
|
|
||
| sessionReplayConfig: ResolvedSessionReplayConfig; | ||
|
There was a problem hiding this comment. Shallow merge lets
|
||
|
|
||
| constructor(config: SessionReplayConfig = {}) { | ||
| this.sessionReplayConfig = { | ||
|
|
@@ -32,15 +33,24 @@ export class SessionReplayPlugin implements EnrichmentPlugin<ReactNativeClient, | |
| async setup(config: ReactNativeConfig, _: ReactNativeClient): Promise<void> { | ||
| this.config = config; | ||
| console.log(`Installing @amplitude/plugin-session-replay-react-native, version ${VERSION}.`); | ||
| // `apiKey`, `deviceId`, `sessionId`, and `serverZone` are sourced from the | ||
| // analytics client's `ReactNativeConfig` because the plugin runs inside an | ||
| // initialized Amplitude SDK and inherits identity from it. | ||
| // `privacyConfig.maskLevel` is guaranteed to be set by the merge in the | ||
| // constructor: `getDefaultConfig()` supplies `{ maskLevel: Medium }` and a | ||
| // user-supplied `privacyConfig` always carries a `maskLevel`. | ||
| const { privacyConfig } = this.sessionReplayConfig; | ||
| await PluginSessionReplayReactNative.setup( | ||
| config.apiKey, | ||
| config.deviceId, | ||
| config.sessionId, | ||
| config.serverZone, | ||
| this.sessionReplayConfig.sampleRate, | ||
| this.sessionReplayConfig.enableRemoteConfig, | ||
| this.sessionReplayConfig.logLevel, | ||
| this.sessionReplayConfig.autoStart, | ||
| // TODO(SDKRN-15): Migrate native bridge to accept the full privacyConfig object instead of a flat maskLevel string. | ||
| privacyConfig.maskLevel, | ||
| ); | ||
| this.isInitialized = true; | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do you also need to apply those changes to session-replay-react-native package?