@amplitude/session-replay-react-native 0.1.0-beta.3 → 0.1.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -17
- package/android/src/main/java/com/amplitude/sessionreplayreactnative/SessionReplayReactNativeModule.kt +99 -48
- package/android/src/oldarch/java/com/amplitude/sessionreplayreactnative/SessionReplayReactNativeSpec.kt +2 -1
- package/ios/AMPNativeSessionReplay.mm +4 -2
- package/ios/NativeSessionReplay.swift +41 -37
- package/lib/commonjs/index.js +15 -9
- package/lib/commonjs/index.js.map +1 -1
- package/lib/commonjs/native-module.js.map +1 -1
- package/lib/commonjs/plugin-session-replay.js +23 -32
- package/lib/commonjs/plugin-session-replay.js.map +1 -1
- package/lib/commonjs/session-replay-config.js +0 -1
- package/lib/commonjs/session-replay-config.js.map +1 -1
- package/lib/commonjs/session-replay.js +40 -40
- package/lib/commonjs/session-replay.js.map +1 -1
- package/lib/commonjs/specs/NativeAmpSessionReplay.js.map +1 -1
- package/lib/commonjs/version.js +1 -1
- package/lib/module/index.js +2 -2
- package/lib/module/index.js.map +1 -1
- package/lib/module/native-module.js.map +1 -1
- package/lib/module/plugin-session-replay.js +24 -33
- package/lib/module/plugin-session-replay.js.map +1 -1
- package/lib/module/session-replay-config.js +0 -1
- package/lib/module/session-replay-config.js.map +1 -1
- package/lib/module/session-replay.js +38 -39
- package/lib/module/session-replay.js.map +1 -1
- package/lib/module/specs/NativeAmpSessionReplay.js.map +1 -1
- package/lib/module/version.js +1 -1
- package/lib/typescript/index.d.ts +2 -3
- package/lib/typescript/index.d.ts.map +1 -1
- package/lib/typescript/native-module.d.ts +9 -12
- package/lib/typescript/native-module.d.ts.map +1 -1
- package/lib/typescript/plugin-session-replay.d.ts +9 -14
- package/lib/typescript/plugin-session-replay.d.ts.map +1 -1
- package/lib/typescript/session-replay-config.d.ts +0 -5
- package/lib/typescript/session-replay-config.d.ts.map +1 -1
- package/lib/typescript/session-replay.d.ts +18 -28
- package/lib/typescript/session-replay.d.ts.map +1 -1
- package/lib/typescript/specs/NativeAmpSessionReplay.d.ts +2 -1
- package/lib/typescript/specs/NativeAmpSessionReplay.d.ts.map +1 -1
- package/lib/typescript/version.d.ts +1 -1
- package/package.json +1 -1
- package/src/index.tsx +3 -4
- package/src/native-module.ts +11 -14
- package/src/plugin-session-replay.ts +24 -33
- package/src/session-replay-config.ts +0 -7
- package/src/session-replay.ts +38 -42
- package/src/specs/NativeAmpSessionReplay.ts +2 -1
- package/src/version.ts +1 -1
package/README.md
CHANGED
|
@@ -38,23 +38,7 @@ const config: SessionReplayConfig = {
|
|
|
38
38
|
await init(config);
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
Add the session replay plugin to your Amplitude instance as follows
|
|
44
|
-
|
|
45
|
-
```js
|
|
46
|
-
import { SessionReplayPlugin, SessionReplaPluginConfig } from '@amplitude/session-replay-react-native';
|
|
47
|
-
|
|
48
|
-
// ...
|
|
49
|
-
|
|
50
|
-
const config: SessionReplaPluginConfig = {
|
|
51
|
-
enableRemoteConfig: true, // default true
|
|
52
|
-
sampleRate: 1, // default 0
|
|
53
|
-
logLevel: LogLevel.Warn, // default LogLevel.Warn
|
|
54
|
-
};
|
|
55
|
-
await init('YOUR_API_KEY').promise;
|
|
56
|
-
await add(new SessionReplayPlugin(config)).promise;
|
|
57
|
-
```
|
|
41
|
+
To use Amplitude Session Replay with Amplitude Analytics, use the [`@amplitude/plugin-session-replay-react-native`](https://www.npmjs.com/package/@amplitude/plugin-session-replay-react-native) plugin package.
|
|
58
42
|
|
|
59
43
|
## Masking views
|
|
60
44
|
|
|
@@ -9,15 +9,26 @@ import com.amplitude.core.ServerZone
|
|
|
9
9
|
import com.facebook.react.bridge.ReactApplicationContext
|
|
10
10
|
import com.facebook.react.bridge.ReactMethod
|
|
11
11
|
import com.facebook.react.bridge.Promise
|
|
12
|
-
import com.facebook.react.bridge.WritableMap
|
|
13
|
-
import com.facebook.react.bridge.WritableNativeMap
|
|
14
12
|
import com.facebook.react.bridge.ReadableMap
|
|
15
13
|
|
|
16
14
|
// `@ReactMethod` is required on the legacy architecture and ignored on the new
|
|
17
15
|
// one, so it stays on the overrides below.
|
|
18
16
|
class SessionReplayReactNativeModule(private val reactContext: ReactApplicationContext) :
|
|
19
17
|
SessionReplayReactNativeSpec(reactContext) {
|
|
20
|
-
private
|
|
18
|
+
private data class NativeConfig(
|
|
19
|
+
val apiKey: String,
|
|
20
|
+
val deviceId: String?,
|
|
21
|
+
val sessionId: Long,
|
|
22
|
+
val serverZone: String,
|
|
23
|
+
val sampleRate: Double,
|
|
24
|
+
val enableRemoteConfig: Boolean,
|
|
25
|
+
val optOut: Boolean,
|
|
26
|
+
val maskLevel: MaskLevel,
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
private var sessionReplay: SessionReplay? = null
|
|
30
|
+
private var nativeConfig: NativeConfig? = null
|
|
31
|
+
private var shouldStart = false
|
|
21
32
|
|
|
22
33
|
override fun getName(): String {
|
|
23
34
|
return NAME
|
|
@@ -33,7 +44,6 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
33
44
|
val sampleRate = config.getDouble("sampleRate")
|
|
34
45
|
val enableRemoteConfig = config.getBoolean("enableRemoteConfig")
|
|
35
46
|
val logLevel = config.getInt("logLevel")
|
|
36
|
-
val autoStart = config.getBoolean("autoStart")
|
|
37
47
|
val optOut = config.getBoolean("optOut")
|
|
38
48
|
val maskLevel = when ((config.getString("maskLevel") ?: "medium").lowercase()) {
|
|
39
49
|
"light" -> MaskLevel.LIGHT
|
|
@@ -60,28 +70,23 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
60
70
|
Sample Rate: $sampleRate
|
|
61
71
|
Enable Remote Config: $enableRemoteConfig
|
|
62
72
|
Log Level: $logLevel
|
|
63
|
-
Auto Start: $autoStart
|
|
64
73
|
Mask Level: $maskLevel
|
|
65
74
|
Opt Out: $optOut
|
|
66
75
|
""".trimIndent())
|
|
67
76
|
|
|
68
|
-
|
|
77
|
+
nativeConfig = NativeConfig(
|
|
69
78
|
apiKey = apiKey,
|
|
70
|
-
|
|
71
|
-
deviceId = deviceId ?: "",
|
|
79
|
+
deviceId = deviceId,
|
|
72
80
|
sessionId = sessionId,
|
|
73
|
-
|
|
81
|
+
serverZone = serverZone,
|
|
74
82
|
sampleRate = sampleRate,
|
|
75
|
-
logger = LogcatLogger.logger,
|
|
76
83
|
enableRemoteConfig = enableRemoteConfig,
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
else -> ServerZone.US
|
|
80
|
-
},
|
|
81
|
-
autoStart = autoStart,
|
|
82
|
-
privacyConfig = PrivacyConfig(maskLevel = maskLevel),
|
|
84
|
+
optOut = optOut,
|
|
85
|
+
maskLevel = maskLevel,
|
|
83
86
|
)
|
|
84
|
-
|
|
87
|
+
rebootSessionReplay(requireNotNull(nativeConfig))
|
|
88
|
+
shouldStart = false
|
|
89
|
+
|
|
85
90
|
promise.resolve(null)
|
|
86
91
|
} catch (e: Exception) {
|
|
87
92
|
promise.reject("SETUP_ERROR", e.message, e)
|
|
@@ -91,7 +96,8 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
91
96
|
@ReactMethod
|
|
92
97
|
override fun setSessionId(sessionId: Double, promise: Promise) {
|
|
93
98
|
try {
|
|
94
|
-
|
|
99
|
+
nativeConfig = requireNotNull(nativeConfig).copy(sessionId = sessionId.toLong())
|
|
100
|
+
sessionReplay?.setSessionId(sessionId.toLong())
|
|
95
101
|
promise.resolve(null)
|
|
96
102
|
} catch (e: Exception) {
|
|
97
103
|
promise.reject("SET_SESSION_ID_ERROR", e.message, e)
|
|
@@ -101,7 +107,8 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
101
107
|
@ReactMethod
|
|
102
108
|
override fun setDeviceId(deviceId: String?, promise: Promise) {
|
|
103
109
|
try {
|
|
104
|
-
|
|
110
|
+
nativeConfig = requireNotNull(nativeConfig).copy(deviceId = deviceId)
|
|
111
|
+
sessionReplay?.setDeviceId(deviceId ?: "")
|
|
105
112
|
promise.resolve(null)
|
|
106
113
|
} catch (e: Exception) {
|
|
107
114
|
promise.reject("SET_DEVICE_ID_ERROR", e.message, e)
|
|
@@ -109,42 +116,46 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
109
116
|
}
|
|
110
117
|
|
|
111
118
|
@ReactMethod
|
|
112
|
-
override fun
|
|
119
|
+
override fun setOptOut(optOut: Boolean, promise: Promise) {
|
|
113
120
|
try {
|
|
114
|
-
|
|
121
|
+
val currentConfig = requireNotNull(nativeConfig)
|
|
122
|
+
if (currentConfig.optOut == optOut) {
|
|
123
|
+
promise.resolve(null)
|
|
124
|
+
return
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// session-replay-android has no public runtime opt-out setter, so retain
|
|
128
|
+
// the bridge config and skip constructing the native SDK while opted out.
|
|
129
|
+
// Create the next instance before shutting the current one down so a
|
|
130
|
+
// constructor failure leaves native state unchanged (and retryable).
|
|
131
|
+
val updatedConfig = currentConfig.copy(optOut = optOut)
|
|
132
|
+
rebootSessionReplay(updatedConfig)
|
|
133
|
+
nativeConfig = updatedConfig
|
|
134
|
+
if (shouldStart && !optOut) {
|
|
135
|
+
sessionReplay?.start()
|
|
136
|
+
}
|
|
137
|
+
promise.resolve(null)
|
|
115
138
|
} catch (e: Exception) {
|
|
116
|
-
promise.reject("
|
|
139
|
+
promise.reject("SET_OPT_OUT_ERROR", e.message, e)
|
|
117
140
|
}
|
|
118
141
|
}
|
|
119
142
|
|
|
120
143
|
@ReactMethod
|
|
121
|
-
override fun
|
|
144
|
+
override fun getSessionId(promise: Promise) {
|
|
122
145
|
try {
|
|
123
|
-
val
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
if (value is String) {
|
|
127
|
-
map.putString(key, value)
|
|
128
|
-
} else if (value is Int) {
|
|
129
|
-
map.putInt(key, value)
|
|
130
|
-
} else if (value is Long) {
|
|
131
|
-
map.putDouble(key, value.toDouble())
|
|
132
|
-
} else if (value is Double) {
|
|
133
|
-
map.putDouble(key, value)
|
|
134
|
-
} else if (value is Boolean) {
|
|
135
|
-
map.putBoolean(key, value)
|
|
136
|
-
}
|
|
137
|
-
}
|
|
138
|
-
promise.resolve(map)
|
|
146
|
+
val sessionId = sessionReplay?.getSessionId() ?: nativeConfig?.sessionId
|
|
147
|
+
?: throw IllegalStateException("SessionReplay is not initialized")
|
|
148
|
+
promise.resolve(sessionId.toDouble())
|
|
139
149
|
} catch (e: Exception) {
|
|
140
|
-
promise.reject("
|
|
150
|
+
promise.reject("GET_SESSION_ID_ERROR", e.message, e)
|
|
141
151
|
}
|
|
142
152
|
}
|
|
143
|
-
|
|
153
|
+
|
|
144
154
|
@ReactMethod
|
|
145
155
|
override fun start(promise: Promise) {
|
|
146
156
|
try {
|
|
147
|
-
|
|
157
|
+
shouldStart = true
|
|
158
|
+
sessionReplay?.start()
|
|
148
159
|
promise.resolve(null)
|
|
149
160
|
} catch (e: Exception) {
|
|
150
161
|
promise.reject("START_ERROR", e.message, e)
|
|
@@ -154,7 +165,8 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
154
165
|
@ReactMethod
|
|
155
166
|
override fun stop(promise: Promise) {
|
|
156
167
|
try {
|
|
157
|
-
|
|
168
|
+
shouldStart = false
|
|
169
|
+
sessionReplay?.stop()
|
|
158
170
|
promise.resolve(null)
|
|
159
171
|
} catch (e: Exception) {
|
|
160
172
|
promise.reject("STOP_ERROR", e.message, e)
|
|
@@ -164,7 +176,7 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
164
176
|
@ReactMethod
|
|
165
177
|
override fun flush(promise: Promise) {
|
|
166
178
|
try {
|
|
167
|
-
sessionReplay
|
|
179
|
+
sessionReplay?.flush()
|
|
168
180
|
promise.resolve(null)
|
|
169
181
|
} catch (e: Exception) {
|
|
170
182
|
promise.reject("FLUSH_ERROR", e.message, e)
|
|
@@ -172,14 +184,53 @@ class SessionReplayReactNativeModule(private val reactContext: ReactApplicationC
|
|
|
172
184
|
}
|
|
173
185
|
|
|
174
186
|
@ReactMethod
|
|
175
|
-
fun teardown() {
|
|
176
|
-
|
|
187
|
+
override fun teardown(promise: Promise) {
|
|
188
|
+
try {
|
|
189
|
+
sessionReplay?.shutdown()
|
|
190
|
+
sessionReplay = null
|
|
191
|
+
nativeConfig = null
|
|
192
|
+
shouldStart = false
|
|
193
|
+
promise.resolve(null)
|
|
194
|
+
} catch (e: Exception) {
|
|
195
|
+
promise.reject("TEARDOWN_ERROR", e.message, e)
|
|
196
|
+
}
|
|
177
197
|
}
|
|
178
198
|
|
|
179
199
|
override fun invalidate() {
|
|
180
|
-
|
|
181
|
-
|
|
200
|
+
sessionReplay?.shutdown()
|
|
201
|
+
sessionReplay = null
|
|
202
|
+
nativeConfig = null
|
|
203
|
+
shouldStart = false
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
private fun rebootSessionReplay(config: NativeConfig) {
|
|
207
|
+
val nextSessionReplay = if (config.optOut) {
|
|
208
|
+
LogcatLogger.logger.debug("skipping SessionReplay init because optOut=true")
|
|
209
|
+
null
|
|
210
|
+
} else {
|
|
211
|
+
createSessionReplay(config)
|
|
182
212
|
}
|
|
213
|
+
sessionReplay?.shutdown()
|
|
214
|
+
sessionReplay = nextSessionReplay
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
private fun createSessionReplay(config: NativeConfig): SessionReplay {
|
|
218
|
+
return SessionReplay(
|
|
219
|
+
apiKey = config.apiKey,
|
|
220
|
+
context = reactContext.applicationContext,
|
|
221
|
+
deviceId = config.deviceId ?: "",
|
|
222
|
+
sessionId = config.sessionId,
|
|
223
|
+
optOut = config.optOut,
|
|
224
|
+
sampleRate = config.sampleRate,
|
|
225
|
+
logger = LogcatLogger.logger,
|
|
226
|
+
enableRemoteConfig = config.enableRemoteConfig,
|
|
227
|
+
serverZone = when (config.serverZone) {
|
|
228
|
+
"EU" -> ServerZone.EU
|
|
229
|
+
else -> ServerZone.US
|
|
230
|
+
},
|
|
231
|
+
autoStart = false,
|
|
232
|
+
privacyConfig = PrivacyConfig(maskLevel = config.maskLevel),
|
|
233
|
+
)
|
|
183
234
|
}
|
|
184
235
|
|
|
185
236
|
companion object {
|
|
@@ -12,9 +12,10 @@ abstract class SessionReplayReactNativeSpec(reactContext: ReactApplicationContex
|
|
|
12
12
|
abstract fun setup(config: ReadableMap, promise: Promise)
|
|
13
13
|
abstract fun setSessionId(sessionId: Double, promise: Promise)
|
|
14
14
|
abstract fun setDeviceId(deviceId: String?, promise: Promise)
|
|
15
|
+
abstract fun setOptOut(optOut: Boolean, promise: Promise)
|
|
15
16
|
abstract fun getSessionId(promise: Promise)
|
|
16
|
-
abstract fun getSessionReplayProperties(promise: Promise)
|
|
17
17
|
abstract fun start(promise: Promise)
|
|
18
18
|
abstract fun stop(promise: Promise)
|
|
19
19
|
abstract fun flush(promise: Promise)
|
|
20
|
+
abstract fun teardown(promise: Promise)
|
|
20
21
|
}
|
|
@@ -6,18 +6,20 @@ RCT_EXTERN_METHOD(flush:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseReject
|
|
|
6
6
|
|
|
7
7
|
RCT_EXTERN_METHOD(getSessionId:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
8
8
|
|
|
9
|
-
RCT_EXTERN_METHOD(getSessionReplayProperties:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
10
|
-
|
|
11
9
|
RCT_EXTERN_METHOD(setSessionId:(nonnull NSNumber)sessionId resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
12
10
|
|
|
13
11
|
RCT_EXTERN_METHOD(setDeviceId:(NSString)deviceId resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
14
12
|
|
|
13
|
+
RCT_EXTERN_METHOD(setOptOut:(BOOL)optOut resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
14
|
+
|
|
15
15
|
RCT_EXTERN_METHOD(setup:(NSDictionary *)config resolve:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
16
16
|
|
|
17
17
|
RCT_EXTERN_METHOD(start:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
18
18
|
|
|
19
19
|
RCT_EXTERN_METHOD(stop:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
20
20
|
|
|
21
|
+
RCT_EXTERN_METHOD(teardown:(RCTPromiseResolveBlock)resolve reject:(RCTPromiseRejectBlock)reject)
|
|
22
|
+
|
|
21
23
|
@end
|
|
22
24
|
|
|
23
25
|
#ifdef RCT_NEW_ARCH_ENABLED
|
|
@@ -8,8 +8,8 @@ class NativeSessionReplay: NSObject, RCTBridgeModule {
|
|
|
8
8
|
"AMPNativeSessionReplay"
|
|
9
9
|
}
|
|
10
10
|
|
|
11
|
-
var sessionReplay: SessionReplay
|
|
12
|
-
var logger: CoreLogger
|
|
11
|
+
var sessionReplay: SessionReplay?
|
|
12
|
+
var logger: CoreLogger?
|
|
13
13
|
|
|
14
14
|
override init() {
|
|
15
15
|
print("NativeSessionReplay init")
|
|
@@ -23,7 +23,6 @@ class NativeSessionReplay: NSObject, RCTBridgeModule {
|
|
|
23
23
|
let sampleRate = config["sampleRate"] as? NSNumber,
|
|
24
24
|
let enableRemoteConfig = config["enableRemoteConfig"] as? Bool,
|
|
25
25
|
let logLevel = config["logLevel"] as? Int,
|
|
26
|
-
let autoStart = config["autoStart"] as? Bool,
|
|
27
26
|
let maskLevel = config["maskLevel"] as? String,
|
|
28
27
|
let optOut = config["optOut"] as? Bool else {
|
|
29
28
|
reject("INVALID_CONFIG", "Invalid configuration parameters", nil)
|
|
@@ -31,10 +30,10 @@ class NativeSessionReplay: NSObject, RCTBridgeModule {
|
|
|
31
30
|
}
|
|
32
31
|
|
|
33
32
|
let deviceId = config["deviceId"] as? String
|
|
33
|
+
let createdLogger = OSLogger(logLevel: LogLevel(rawValue: logLevel) ?? .warn)
|
|
34
|
+
logger = createdLogger
|
|
34
35
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
logger.log(message:
|
|
36
|
+
createdLogger.log(message:
|
|
38
37
|
"""
|
|
39
38
|
setup:
|
|
40
39
|
API Key: \(apiKey)
|
|
@@ -44,7 +43,6 @@ class NativeSessionReplay: NSObject, RCTBridgeModule {
|
|
|
44
43
|
Sample Rate: \(sampleRate)
|
|
45
44
|
Enable Remote Config: \(enableRemoteConfig)
|
|
46
45
|
Log Level: \(logLevel)
|
|
47
|
-
Auto Start: \(autoStart)
|
|
48
46
|
Mask Level: \(maskLevel)
|
|
49
47
|
Opt Out: \(optOut)
|
|
50
48
|
"""
|
|
@@ -56,29 +54,33 @@ class NativeSessionReplay: NSObject, RCTBridgeModule {
|
|
|
56
54
|
sessionId: sessionId.int64Value,
|
|
57
55
|
optOut: optOut,
|
|
58
56
|
sampleRate: Float(truncating: sampleRate),
|
|
59
|
-
logger:
|
|
57
|
+
logger: createdLogger,
|
|
60
58
|
serverZone: serverZone == "EU" ? .EU : .US,
|
|
61
59
|
maskLevel: .fromString(maskLevel),
|
|
62
60
|
enableRemoteConfig: enableRemoteConfig
|
|
63
61
|
)
|
|
64
62
|
|
|
65
|
-
if (autoStart) {
|
|
66
|
-
sessionReplay.start()
|
|
67
|
-
}
|
|
68
63
|
resolve(nil)
|
|
69
64
|
}
|
|
70
65
|
|
|
71
66
|
@objc(setSessionId:resolve:reject:)
|
|
72
67
|
func setSessionId(_ sessionId: NSNumber, resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) -> Void {
|
|
73
|
-
logger
|
|
74
|
-
sessionReplay
|
|
68
|
+
logger?.debug(message: "setSessionId: \(sessionId)")
|
|
69
|
+
sessionReplay?.sessionId = sessionId.int64Value
|
|
75
70
|
resolve(nil)
|
|
76
71
|
}
|
|
77
72
|
|
|
78
73
|
@objc(setDeviceId:resolve:reject:)
|
|
79
74
|
func setDeviceId(_ deviceId: NSString, resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) -> Void {
|
|
80
|
-
logger
|
|
81
|
-
sessionReplay
|
|
75
|
+
logger?.debug(message: "setDeviceId: \(deviceId)")
|
|
76
|
+
sessionReplay?.deviceId = deviceId as String?
|
|
77
|
+
resolve(nil)
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
@objc(setOptOut:resolve:reject:)
|
|
81
|
+
func setOptOut(_ optOut: Bool, resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) -> Void {
|
|
82
|
+
logger?.debug(message: "setOptOut: \(optOut)")
|
|
83
|
+
sessionReplay?.optOut = optOut
|
|
82
84
|
resolve(nil)
|
|
83
85
|
}
|
|
84
86
|
|
|
@@ -87,50 +89,52 @@ class NativeSessionReplay: NSObject, RCTBridgeModule {
|
|
|
87
89
|
_ resolve: RCTPromiseResolveBlock,
|
|
88
90
|
reject: RCTPromiseRejectBlock
|
|
89
91
|
) {
|
|
90
|
-
logger
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
_ resolve: RCTPromiseResolveBlock,
|
|
97
|
-
reject: RCTPromiseRejectBlock
|
|
98
|
-
) {
|
|
99
|
-
logger.debug(message: "getSessionReplayProperties")
|
|
100
|
-
resolve(sessionReplay.additionalEventProperties)
|
|
92
|
+
logger?.debug(message: "getSessionId")
|
|
93
|
+
if let sessionId = sessionReplay?.sessionId {
|
|
94
|
+
resolve(NSNumber(value: sessionId))
|
|
95
|
+
} else {
|
|
96
|
+
resolve(nil)
|
|
97
|
+
}
|
|
101
98
|
}
|
|
102
99
|
|
|
103
100
|
@objc(start:reject:)
|
|
104
101
|
func start(_ resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) -> Void {
|
|
105
|
-
logger
|
|
106
|
-
sessionReplay
|
|
107
|
-
print(sessionReplay.additionalEventProperties)
|
|
108
|
-
print(
|
|
109
|
-
"SessionId: \(sessionReplay.sessionId); DeviceId: \(sessionReplay.deviceId ?? "nil")"
|
|
110
|
-
)
|
|
102
|
+
logger?.debug(message: "start")
|
|
103
|
+
sessionReplay?.start()
|
|
111
104
|
resolve(nil)
|
|
112
105
|
}
|
|
113
106
|
|
|
114
107
|
@objc(stop:reject:)
|
|
115
108
|
func stop(_ resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) -> Void {
|
|
116
|
-
logger
|
|
117
|
-
sessionReplay
|
|
109
|
+
logger?.debug(message: "stop")
|
|
110
|
+
sessionReplay?.stop()
|
|
118
111
|
resolve(nil)
|
|
119
112
|
}
|
|
120
113
|
|
|
121
114
|
@objc(flush:reject:)
|
|
122
115
|
func flush(_ resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) -> Void {
|
|
123
|
-
logger
|
|
124
|
-
sessionReplay
|
|
116
|
+
logger?.debug(message: "flush")
|
|
117
|
+
sessionReplay?.flush()
|
|
118
|
+
resolve(nil)
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
@objc(teardown:reject:)
|
|
122
|
+
func teardown(_ resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) -> Void {
|
|
123
|
+
logger?.debug(message: "teardown")
|
|
124
|
+
tearDownSessionReplay()
|
|
125
125
|
resolve(nil)
|
|
126
126
|
}
|
|
127
127
|
|
|
128
128
|
@objc(invalidate)
|
|
129
129
|
func invalidate() {
|
|
130
130
|
print("invalidate")
|
|
131
|
-
|
|
131
|
+
tearDownSessionReplay()
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
private func tearDownSessionReplay() {
|
|
132
135
|
sessionReplay?.stop()
|
|
133
136
|
sessionReplay = nil
|
|
137
|
+
logger = nil
|
|
134
138
|
}
|
|
135
139
|
}
|
|
136
140
|
|
package/lib/commonjs/index.js
CHANGED
|
@@ -9,10 +9,10 @@ Object.defineProperty(exports, "AmpMaskView", {
|
|
|
9
9
|
return _ampMaskView.AmpMaskView;
|
|
10
10
|
}
|
|
11
11
|
});
|
|
12
|
-
Object.defineProperty(exports, "
|
|
12
|
+
Object.defineProperty(exports, "LogLevel", {
|
|
13
13
|
enumerable: true,
|
|
14
14
|
get: function () {
|
|
15
|
-
return
|
|
15
|
+
return _sessionReplayConfig.LogLevel;
|
|
16
16
|
}
|
|
17
17
|
});
|
|
18
18
|
Object.defineProperty(exports, "flush", {
|
|
@@ -27,12 +27,6 @@ Object.defineProperty(exports, "getSessionId", {
|
|
|
27
27
|
return _sessionReplay.getSessionId;
|
|
28
28
|
}
|
|
29
29
|
});
|
|
30
|
-
Object.defineProperty(exports, "getSessionReplayProperties", {
|
|
31
|
-
enumerable: true,
|
|
32
|
-
get: function () {
|
|
33
|
-
return _sessionReplay.getSessionReplayProperties;
|
|
34
|
-
}
|
|
35
|
-
});
|
|
36
30
|
Object.defineProperty(exports, "init", {
|
|
37
31
|
enumerable: true,
|
|
38
32
|
get: function () {
|
|
@@ -45,6 +39,12 @@ Object.defineProperty(exports, "setDeviceId", {
|
|
|
45
39
|
return _sessionReplay.setDeviceId;
|
|
46
40
|
}
|
|
47
41
|
});
|
|
42
|
+
Object.defineProperty(exports, "setOptOut", {
|
|
43
|
+
enumerable: true,
|
|
44
|
+
get: function () {
|
|
45
|
+
return _sessionReplay.setOptOut;
|
|
46
|
+
}
|
|
47
|
+
});
|
|
48
48
|
Object.defineProperty(exports, "setSessionId", {
|
|
49
49
|
enumerable: true,
|
|
50
50
|
get: function () {
|
|
@@ -63,7 +63,13 @@ Object.defineProperty(exports, "stop", {
|
|
|
63
63
|
return _sessionReplay.stop;
|
|
64
64
|
}
|
|
65
65
|
});
|
|
66
|
+
Object.defineProperty(exports, "teardown", {
|
|
67
|
+
enumerable: true,
|
|
68
|
+
get: function () {
|
|
69
|
+
return _sessionReplay.teardown;
|
|
70
|
+
}
|
|
71
|
+
});
|
|
66
72
|
var _sessionReplay = require("./session-replay");
|
|
67
|
-
var
|
|
73
|
+
var _sessionReplayConfig = require("./session-replay-config");
|
|
68
74
|
var _ampMaskView = require("./amp-mask-view");
|
|
69
75
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["_sessionReplay","require","
|
|
1
|
+
{"version":3,"names":["_sessionReplay","require","_sessionReplayConfig","_ampMaskView"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,IAAAA,cAAA,GAAAC,OAAA;AAYA,IAAAC,oBAAA,GAAAD,OAAA;AAEA,IAAAE,YAAA,GAAAF,OAAA","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["_reactNative","require","_NativeAmpSessionReplay","_interopRequireDefault","e","__esModule","default","LINKING_ERROR","Platform","select","ios","NativeSessionReplay","exports","SessionReplaySpec","Proxy","get","Error"],"sourceRoot":"../../src","sources":["native-module.ts"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AACA,IAAAC,uBAAA,GAAAC,sBAAA,CAAAF,OAAA;AAA+D,SAAAE,uBAAAC,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE/D,MAAMG,aAAa,GACjB,iGAAiG,GACjGC,qBAAQ,CAACC,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEJ,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;;AAEjC;AACA;AACA;AACA;AACA;AACA;AACO,MAAMK,mBAAmB,GAAAC,OAAA,CAAAD,mBAAA,GAAIE,+BAAiB,IACnD,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACT,aAAa,CAAC;EAChC;AACF,CACF,CAAwC;;AAE1C;AACA;AACA;AACA;;
|
|
1
|
+
{"version":3,"names":["_reactNative","require","_NativeAmpSessionReplay","_interopRequireDefault","e","__esModule","default","LINKING_ERROR","Platform","select","ios","NativeSessionReplay","exports","SessionReplaySpec","Proxy","get","Error"],"sourceRoot":"../../src","sources":["native-module.ts"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AACA,IAAAC,uBAAA,GAAAC,sBAAA,CAAAF,OAAA;AAA+D,SAAAE,uBAAAC,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE/D,MAAMG,aAAa,GACjB,iGAAiG,GACjGC,qBAAQ,CAACC,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEJ,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;;AAEjC;AACA;AACA;AACA;AACA;AACA;AACO,MAAMK,mBAAmB,GAAAC,OAAA,CAAAD,mBAAA,GAAIE,+BAAiB,IACnD,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACT,aAAa,CAAC;EAChC;AACF,CACF,CAAwC;;AAE1C;AACA;AACA;AACA;;AAsBA;AACA;AACA;AACA;AACA;AACA;AACA;AACA","ignoreList":[]}
|
|
@@ -65,12 +65,15 @@ class SessionReplayPlugin {
|
|
|
65
65
|
sampleRate: this.sessionReplayConfig.sampleRate,
|
|
66
66
|
enableRemoteConfig: this.sessionReplayConfig.enableRemoteConfig,
|
|
67
67
|
logLevel: this.sessionReplayConfig.logLevel,
|
|
68
|
-
|
|
68
|
+
optOut: config.optOut
|
|
69
69
|
}, this.logger);
|
|
70
70
|
this.isInitialized = true;
|
|
71
|
+
if (this.sessionReplayConfig.autoStart) {
|
|
72
|
+
await (0, _sessionReplay.start)();
|
|
73
|
+
}
|
|
71
74
|
}
|
|
72
75
|
async execute(event) {
|
|
73
|
-
var _this$config
|
|
76
|
+
var _this$config;
|
|
74
77
|
if (!this.isInitialized) {
|
|
75
78
|
return Promise.resolve(event);
|
|
76
79
|
}
|
|
@@ -81,15 +84,6 @@ class SessionReplayPlugin {
|
|
|
81
84
|
if ((_this$config = this.config) !== null && _this$config !== void 0 && _this$config.sessionId && this.config.sessionId !== (await (0, _sessionReplay.getSessionId)())) {
|
|
82
85
|
await (0, _sessionReplay.setSessionId)(this.config.sessionId);
|
|
83
86
|
}
|
|
84
|
-
// Treating config.sessionId as source of truth, if the event's session id doesn't match, the
|
|
85
|
-
// event is not of the current session (offline/late events). In that case, don't tag the events
|
|
86
|
-
if ((_this$config2 = this.config) !== null && _this$config2 !== void 0 && _this$config2.sessionId && this.config.sessionId === event.session_id) {
|
|
87
|
-
const sessionRecordingProperties = await (0, _sessionReplay.getSessionReplayProperties)();
|
|
88
|
-
event.event_properties = {
|
|
89
|
-
...event.event_properties,
|
|
90
|
-
...sessionRecordingProperties
|
|
91
|
-
};
|
|
92
|
-
}
|
|
93
87
|
return Promise.resolve(event);
|
|
94
88
|
}
|
|
95
89
|
|
|
@@ -116,34 +110,31 @@ class SessionReplayPlugin {
|
|
|
116
110
|
await (0, _sessionReplay.stop)();
|
|
117
111
|
}
|
|
118
112
|
}
|
|
119
|
-
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* Update whether session replay collection is disabled for the current user.
|
|
116
|
+
*
|
|
117
|
+
* @param optOut - Whether to opt out of session replay collection
|
|
118
|
+
* @returns Promise that resolves when the opt-out state is updated
|
|
119
|
+
*/
|
|
120
|
+
async setOptOut(optOut) {
|
|
120
121
|
if (this.isInitialized) {
|
|
121
|
-
await (0, _sessionReplay.
|
|
122
|
+
await (0, _sessionReplay.setOptOut)(optOut);
|
|
122
123
|
}
|
|
123
|
-
this.config = null;
|
|
124
|
-
this.isInitialized = false;
|
|
125
124
|
}
|
|
126
125
|
|
|
127
126
|
/**
|
|
128
|
-
*
|
|
129
|
-
* When you send events to Amplitude, call this method to get the most up-to-date session replay properties for the event.
|
|
130
|
-
*
|
|
131
|
-
* @returns Promise that resolves to an object containing session replay metadata
|
|
132
|
-
*
|
|
133
|
-
* @example
|
|
134
|
-
* ```typescript
|
|
135
|
-
* const sessionReplayProperties = await plugin.getSessionReplayProperties();
|
|
136
|
-
* analytics.track('Button Clicked', {
|
|
137
|
-
* buttonName: 'submit',
|
|
138
|
-
* ...sessionReplayProperties
|
|
139
|
-
* });
|
|
140
|
-
* ```
|
|
127
|
+
* Amplitude SDK hook. `client.setOptOut()` fans this out through the plugin timeline.
|
|
141
128
|
*/
|
|
142
|
-
async
|
|
143
|
-
|
|
144
|
-
|
|
129
|
+
async onOptOutChanged(optOut) {
|
|
130
|
+
await this.setOptOut(optOut);
|
|
131
|
+
}
|
|
132
|
+
async teardown() {
|
|
133
|
+
if (this.isInitialized) {
|
|
134
|
+
await (0, _sessionReplay.teardown)();
|
|
145
135
|
}
|
|
146
|
-
|
|
136
|
+
this.config = null;
|
|
137
|
+
this.isInitialized = false;
|
|
147
138
|
}
|
|
148
139
|
}
|
|
149
140
|
exports.SessionReplayPlugin = SessionReplayPlugin;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["_pluginSessionReplayConfig","require","_sessionReplay","_logger","SessionReplayPlugin","name","type","config","isInitialized","logger","createSessionReplayLogger","constructor","sessionReplayConfig","getDefaultSessionReplayPluginConfig","setLogLevel","logLevel","log","setup","_","privateInit","apiKey","deviceId","sessionId","serverZone","sampleRate","enableRemoteConfig","autoStart","execute","event","_this$config","
|
|
1
|
+
{"version":3,"names":["_pluginSessionReplayConfig","require","_sessionReplay","_logger","SessionReplayPlugin","name","type","config","isInitialized","logger","createSessionReplayLogger","constructor","sessionReplayConfig","getDefaultSessionReplayPluginConfig","setLogLevel","logLevel","log","setup","_","privateInit","apiKey","deviceId","sessionId","serverZone","sampleRate","enableRemoteConfig","optOut","autoStart","start","execute","event","_this$config","Promise","resolve","getSessionId","setSessionId","stop","setOptOut","onOptOutChanged","teardown","exports"],"sourceRoot":"../../src","sources":["plugin-session-replay.ts"],"mappings":";;;;;;AAOA,IAAAA,0BAAA,GAAAC,OAAA;AACA,IAAAC,cAAA,GAAAD,OAAA;AACA,IAAAE,OAAA,GAAAF,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMG,mBAAmB,CAAmE;EACjGC,IAAI,GAAG,+CAA+C;EACtDC,IAAI,GAAG,YAAY;EAEXC,MAAM,GAA6B,IAAI;EACvCC,aAAa,GAAG,KAAK;EAGrBC,MAAM,GAAG,IAAAC,iCAAyB,EAAC,CAAC;;EAE5C;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEC,WAAWA,CAACJ,MAAiC,GAAG,CAAC,CAAC,EAAE;IAClD,IAAI,CAACK,mBAAmB,GAAG;MACzB,GAAG,IAAAC,8DAAmC,EAAC,CAAC;MACxC,GAAGN;IACL,CAAC;IAED,IAAI,CAACE,MAAM,CAACK,WAAW,CAAC,IAAI,CAACF,mBAAmB,CAACG,QAAQ,CAAC;IAC1D,IAAI,CAACN,MAAM,CAACO,GAAG,CAAC,4CAA4C,EAAE,IAAI,CAACJ,mBAAmB,CAAC;EACzF;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EACE,MAAMK,KAAKA,CAACV,MAAyB,EAAEW,CAAoB,EAAiB;IAC1E,IAAI,CAACX,MAAM,GAAGA,MAAM;IACpB,MAAM,IAAAY,0BAAW,EACf;MACEC,MAAM,EAAEb,MAAM,CAACa,MAAM;MACrBC,QAAQ,EAAEd,MAAM,CAACc,QAAQ;MACzBC,SAAS,EAAEf,MAAM,CAACe,SAAS;MAC3BC,UAAU,EAAEhB,MAAM,CAACgB,UAAyB;MAC5CC,UAAU,EAAE,IAAI,CAACZ,mBAAmB,CAACY,UAAU;MAC/CC,kBAAkB,EAAE,IAAI,CAACb,mBAAmB,CAACa,kBAAkB;MAC/DV,QAAQ,EAAE,IAAI,CAACH,mBAAmB,CAACG,QAAQ;MAC3CW,MAAM,EAAEnB,MAAM,CAACmB;IACjB,CAAC,EACD,IAAI,CAACjB,MACP,CAAC;IACD,IAAI,CAACD,aAAa,GAAG,IAAI;IACzB,IAAI,IAAI,CAACI,mBAAmB,CAACe,SAAS,EAAE;MACtC,MAAM,IAAAC,oBAAK,EAAC,CAAC;IACf;EACF;EAEA,MAAMC,OAAOA,CAACC,KAAY,EAAyB;IAAA,IAAAC,YAAA;IACjD,IAAI,CAAC,IAAI,CAACvB,aAAa,EAAE;MACvB,OAAOwB,OAAO,CAACC,OAAO,CAACH,KAAK,CAAC;IAC/B;;IAEA;IACA;IACA;IACA,IAAI,CAAAC,YAAA,OAAI,CAACxB,MAAM,cAAAwB,YAAA,eAAXA,YAAA,CAAaT,SAAS,IAAI,IAAI,CAACf,MAAM,CAACe,SAAS,MAAM,MAAM,IAAAY,2BAAY,EAAC,CAAC,CAAC,EAAE;MAC9E,MAAM,IAAAC,2BAAY,EAAC,IAAI,CAAC5B,MAAM,CAACe,SAAS,CAAC;IAC3C;IACA,OAAOU,OAAO,CAACC,OAAO,CAACH,KAAK,CAAC;EAC/B;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMF,KAAKA,CAAA,EAAkB;IAC3B,IAAI,IAAI,CAACpB,aAAa,EAAE;MACtB,MAAM,IAAAoB,oBAAK,EAAC,CAAC;IACf;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMQ,IAAIA,CAAA,EAAkB;IAC1B,IAAI,IAAI,CAAC5B,aAAa,EAAE;MACtB,MAAM,IAAA4B,mBAAI,EAAC,CAAC;IACd;EACF;;EAEA;AACF;AACA;AACA;AACA;AACA;EACE,MAAMC,SAASA,CAACX,MAAe,EAAiB;IAC9C,IAAI,IAAI,CAAClB,aAAa,EAAE;MACtB,MAAM,IAAA6B,wBAAS,EAACX,MAAM,CAAC;IACzB;EACF;;EAEA;AACF;AACA;EACE,MAAMY,eAAeA,CAACZ,MAAe,EAAiB;IACpD,MAAM,IAAI,CAACW,SAAS,CAACX,MAAM,CAAC;EAC9B;EAEA,MAAMa,QAAQA,CAAA,EAAkB;IAC9B,IAAI,IAAI,CAAC/B,aAAa,EAAE;MACtB,MAAM,IAAA+B,uBAAQ,EAAC,CAAC;IAClB;IAEA,IAAI,CAAChC,MAAM,GAAG,IAAI;IAClB,IAAI,CAACC,aAAa,GAAG,KAAK;EAC5B;AACF;AAACgC,OAAA,CAAApC,mBAAA,GAAAA,mBAAA","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"names":["_analyticsTypes","require","getDefaultConfig","
|
|
1
|
+
{"version":3,"names":["_analyticsTypes","require","getDefaultConfig","deviceId","enableRemoteConfig","logLevel","LogLevel","Warn","optOut","privacyConfig","sampleRate","serverZone","sessionId","exports"],"sourceRoot":"../../src","sources":["session-replay-config.ts"],"mappings":";;;;;;;;;;;;AAAA,IAAAA,eAAA,GAAAC,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;;AAqEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGO,MAAMC,gBAA6E,GAAGA,CAAA,KAAM;EACjG,OAAO;IACLC,QAAQ,EAAE,IAAI;IACdC,kBAAkB,EAAE,IAAI;IACxBC,QAAQ,EAAEC,wBAAQ,CAACC,IAAI;IACvBC,MAAM,EAAE,KAAK;IACb;IACA;IACA;IACA;IACAC,aAAa,EAAE,CAAC,CAAC;IACjBC,UAAU,EAAE,CAAC;IACbC,UAAU,EAAE,IAAI;IAChBC,SAAS,EAAE,CAAC;EACd,CAAC;AACH,CAAC;AAACC,OAAA,CAAAX,gBAAA,GAAAA,gBAAA","ignoreList":[]}
|