@datadog/mobile-react-native 3.3.0 → 3.5.0

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.
Files changed (112) hide show
  1. package/DatadogSDKReactNative.podspec +7 -7
  2. package/android/build.gradle +7 -7
  3. package/android/src/main/kotlin/com/datadog/reactnative/DdRumImplementation.kt +4 -0
  4. package/android/src/main/kotlin/com/datadog/reactnative/DdSdkImplementation.kt +13 -5
  5. package/android/src/main/kotlin/com/datadog/reactnative/DdSdkNativeInitialization.kt +14 -6
  6. package/android/src/main/kotlin/com/datadog/reactnative/DdSdkSessionStartedListener.kt +93 -22
  7. package/android/src/main/kotlin/com/datadog/reactnative/FrameRateProvider.kt +16 -8
  8. package/android/src/main/kotlin/com/datadog/reactnative/JsThreadExecutor.kt +27 -0
  9. package/android/src/main/kotlin/com/datadog/reactnative/SdkVersion.kt +1 -1
  10. package/android/src/newarch/kotlin/com/datadog/reactnative/DdRum.kt +5 -1
  11. package/android/src/oldarch/kotlin/com/datadog/reactnative/DdRum.kt +5 -1
  12. package/android/src/test/kotlin/com/datadog/reactnative/DdRumTest.kt +9 -1
  13. package/android/src/test/kotlin/com/datadog/reactnative/DdSdkNativeInitializationTest.kt +68 -0
  14. package/android/src/test/kotlin/com/datadog/reactnative/DdSdkSessionStartedListenerTest.kt +38 -1
  15. package/android/src/test/kotlin/com/datadog/reactnative/DdSdkTest.kt +63 -5
  16. package/android/src/test/kotlin/com/datadog/tools/unit/MockRumMonitor.kt +25 -0
  17. package/android/src/test/kotlin/com/datadog/tools/unit/TestJsThreadExecutor.kt +16 -0
  18. package/ios/Sources/DdRum.mm +6 -4
  19. package/ios/Sources/DdRumImplementation.swift +82 -7
  20. package/ios/Sources/DdSdkNativeInitialization.swift +24 -17
  21. package/ios/Sources/DdSdkSessionStartedListener.swift +28 -1
  22. package/ios/Sources/RNDdSdkConfiguration.swift +2 -0
  23. package/ios/Sources/RNViewResolution.swift +88 -0
  24. package/ios/Sources/RUMMonitorInternalProtocol.swift +8 -0
  25. package/ios/Sources/SdkVersion.swift +1 -1
  26. package/lib/commonjs/DdSdkReactNative.js +25 -21
  27. package/lib/commonjs/DdSdkReactNative.js.map +1 -1
  28. package/lib/commonjs/config/DatadogProviderConfiguration.js +3 -1
  29. package/lib/commonjs/config/DatadogProviderConfiguration.js.map +1 -1
  30. package/lib/commonjs/metro/debugIdResolver.js +5 -3
  31. package/lib/commonjs/metro/debugIdResolver.js.map +1 -1
  32. package/lib/commonjs/metro/plugin/metroSerializer.js +4 -3
  33. package/lib/commonjs/metro/plugin/metroSerializer.js.map +1 -1
  34. package/lib/commonjs/rum/DdRum.js +14 -1
  35. package/lib/commonjs/rum/DdRum.js.map +1 -1
  36. package/lib/commonjs/rum/eventMappers/actionEventMapper.js.map +1 -1
  37. package/lib/commonjs/rum/instrumentation/interactionTracking/DdBabelInteractionTracking.js +1 -1
  38. package/lib/commonjs/rum/instrumentation/interactionTracking/DdBabelInteractionTracking.js.map +1 -1
  39. package/lib/commonjs/sdk/AttributesEncoding/defaultEncoders.js +6 -1
  40. package/lib/commonjs/sdk/AttributesEncoding/defaultEncoders.js.map +1 -1
  41. package/lib/commonjs/sdk/UserInfoSingleton/UserInfoSingleton.js +13 -1
  42. package/lib/commonjs/sdk/UserInfoSingleton/UserInfoSingleton.js.map +1 -1
  43. package/lib/commonjs/specs/NativeDdRum.js.map +1 -1
  44. package/lib/commonjs/types.js.map +1 -1
  45. package/lib/commonjs/version.js +1 -1
  46. package/lib/module/DdSdkReactNative.js +25 -21
  47. package/lib/module/DdSdkReactNative.js.map +1 -1
  48. package/lib/module/config/DatadogProviderConfiguration.js +3 -1
  49. package/lib/module/config/DatadogProviderConfiguration.js.map +1 -1
  50. package/lib/module/metro/debugIdResolver.js +5 -3
  51. package/lib/module/metro/debugIdResolver.js.map +1 -1
  52. package/lib/module/metro/plugin/metroSerializer.js +4 -3
  53. package/lib/module/metro/plugin/metroSerializer.js.map +1 -1
  54. package/lib/module/rum/DdRum.js +14 -1
  55. package/lib/module/rum/DdRum.js.map +1 -1
  56. package/lib/module/rum/eventMappers/actionEventMapper.js.map +1 -1
  57. package/lib/module/rum/instrumentation/interactionTracking/DdBabelInteractionTracking.js +1 -1
  58. package/lib/module/rum/instrumentation/interactionTracking/DdBabelInteractionTracking.js.map +1 -1
  59. package/lib/module/sdk/AttributesEncoding/defaultEncoders.js +6 -1
  60. package/lib/module/sdk/AttributesEncoding/defaultEncoders.js.map +1 -1
  61. package/lib/module/sdk/UserInfoSingleton/UserInfoSingleton.js +13 -1
  62. package/lib/module/sdk/UserInfoSingleton/UserInfoSingleton.js.map +1 -1
  63. package/lib/module/specs/NativeDdRum.js.map +1 -1
  64. package/lib/module/types.js.map +1 -1
  65. package/lib/module/version.js +1 -1
  66. package/lib/typescript/DdSdkReactNative.d.ts +6 -9
  67. package/lib/typescript/DdSdkReactNative.d.ts.map +1 -1
  68. package/lib/typescript/config/DatadogProviderConfiguration.d.ts +3 -1
  69. package/lib/typescript/config/DatadogProviderConfiguration.d.ts.map +1 -1
  70. package/lib/typescript/metro/debugIdResolver.d.ts.map +1 -1
  71. package/lib/typescript/metro/plugin/metroSerializer.d.ts +1 -1
  72. package/lib/typescript/metro/plugin/metroSerializer.d.ts.map +1 -1
  73. package/lib/typescript/nativeModulesTypes.d.ts +2 -1
  74. package/lib/typescript/nativeModulesTypes.d.ts.map +1 -1
  75. package/lib/typescript/rum/DdRum.d.ts.map +1 -1
  76. package/lib/typescript/rum/eventMappers/actionEventMapper.d.ts +1 -0
  77. package/lib/typescript/rum/eventMappers/actionEventMapper.d.ts.map +1 -1
  78. package/lib/typescript/rum/instrumentation/interactionTracking/DdBabelInteractionTracking.d.ts.map +1 -1
  79. package/lib/typescript/sdk/AttributesEncoding/defaultEncoders.d.ts.map +1 -1
  80. package/lib/typescript/sdk/UserInfoSingleton/UserInfoSingleton.d.ts +4 -1
  81. package/lib/typescript/sdk/UserInfoSingleton/UserInfoSingleton.d.ts.map +1 -1
  82. package/lib/typescript/sdk/UserInfoSingleton/types.d.ts +1 -1
  83. package/lib/typescript/sdk/UserInfoSingleton/types.d.ts.map +1 -1
  84. package/lib/typescript/specs/NativeDdRum.d.ts +2 -1
  85. package/lib/typescript/specs/NativeDdRum.d.ts.map +1 -1
  86. package/lib/typescript/types.d.ts +8 -7
  87. package/lib/typescript/types.d.ts.map +1 -1
  88. package/lib/typescript/version.d.ts +1 -1
  89. package/package.json +2 -2
  90. package/src/DdSdkReactNative.tsx +35 -31
  91. package/src/__tests__/DdSdkReactNative.test.tsx +22 -3
  92. package/src/__tests__/rum/instrumentation/DdRumUserInteractionTracking.test.tsx +8 -0
  93. package/src/config/DatadogProviderConfiguration.ts +3 -1
  94. package/src/metro/__tests__/metro.test.ts +13 -0
  95. package/src/metro/debugIdResolver.ts +7 -3
  96. package/src/metro/plugin/metroSerializer.ts +11 -3
  97. package/src/nativeModulesTypes.ts +2 -0
  98. package/src/rum/DdRum.ts +25 -0
  99. package/src/rum/__tests__/DdRum.test.ts +33 -0
  100. package/src/rum/eventMappers/actionEventMapper.ts +1 -0
  101. package/src/rum/instrumentation/interactionTracking/DdBabelInteractionTracking.ts +2 -1
  102. package/src/rum/instrumentation/interactionTracking/__tests__/DdBabelInteractionTracking.test.ts +28 -0
  103. package/src/sdk/AttributesEncoding/__tests__/defaultEncoders.test.ts +25 -1
  104. package/src/sdk/AttributesEncoding/defaultEncoders.ts +11 -1
  105. package/src/sdk/DatadogProvider/__tests__/__utils__/renderWithProvider.tsx +24 -7
  106. package/src/sdk/DatadogProvider/__tests__/initialization.test.tsx +19 -15
  107. package/src/sdk/DatadogProvider/__tests__/initializationModes.test.tsx +85 -54
  108. package/src/sdk/UserInfoSingleton/UserInfoSingleton.ts +15 -2
  109. package/src/sdk/UserInfoSingleton/types.ts +1 -1
  110. package/src/specs/NativeDdRum.ts +2 -0
  111. package/src/types.tsx +6 -7
  112. package/src/version.ts +1 -1
@@ -5,7 +5,7 @@
5
5
  */
6
6
 
7
7
  import { render } from '@testing-library/react-native';
8
- import { Animated, Button, InteractionManager, Text, View } from 'react-native';
8
+ import { Animated, Button, Text, View } from 'react-native';
9
9
  import React, { useState } from 'react';
10
10
 
11
11
  import { DatadogProviderConfiguration } from '../../../../config/DatadogProviderConfiguration';
@@ -109,14 +109,31 @@ export const renderWithProvider = (params?: {
109
109
  };
110
110
 
111
111
  /**
112
- * Mocks an animation for InteractionManager.runAfterInteractions. Returns
113
- * a function to be called to finish the animation
112
+ * Mocks requestIdleCallback so that scheduled callbacks only run when
113
+ * {@link flushIdleCallbacks} is called. Restores the original value on
114
+ * {@link restore}.
114
115
  */
115
- export const mockAnimation = () => {
116
- const fakeAnimationHandle = InteractionManager.createInteractionHandle();
116
+ export const mockIdleCallback = () => {
117
+ const callbacks: Array<() => void> = [];
118
+ const original = (globalThis as Record<string, unknown>)
119
+ .requestIdleCallback;
120
+
121
+ (globalThis as Record<string, unknown>).requestIdleCallback = (
122
+ cb: () => void
123
+ ) => {
124
+ callbacks.push(cb);
125
+ return callbacks.length;
126
+ };
117
127
 
118
128
  return {
119
- finishAnimation: () =>
120
- InteractionManager.clearInteractionHandle(fakeAnimationHandle)
129
+ flushIdleCallbacks: () => {
130
+ callbacks.splice(0).forEach(cb => cb());
131
+ },
132
+ restore: () => {
133
+ (globalThis as Record<
134
+ string,
135
+ unknown
136
+ >).requestIdleCallback = original;
137
+ }
121
138
  };
122
139
  };
@@ -22,7 +22,7 @@ import {
22
22
 
23
23
  import {
24
24
  getDefaultConfiguration,
25
- mockAnimation,
25
+ mockIdleCallback,
26
26
  renderWithProvider
27
27
  } from './__utils__/renderWithProvider';
28
28
 
@@ -190,20 +190,24 @@ describe('DatadogProvider', () => {
190
190
 
191
191
  it('runs after initialization when ASYNC initialization', async () => {
192
192
  const onInitialization = jest.fn();
193
- const { finishAnimation } = mockAnimation();
194
- const configuration = getDefaultConfiguration();
195
- configuration.initializationMode = InitializationMode.ASYNC;
196
- const { getByText } = renderWithProvider({
197
- onInitialization,
198
- configuration
199
- });
200
- getByText('I am a test application');
201
- await flushPromises();
202
- expect(onInitialization).not.toHaveBeenCalled();
203
-
204
- finishAnimation();
205
- await flushPromises();
206
- expect(onInitialization).toHaveBeenCalledTimes(1);
193
+ const idle = mockIdleCallback();
194
+ try {
195
+ const configuration = getDefaultConfiguration();
196
+ configuration.initializationMode = InitializationMode.ASYNC;
197
+ const { getByText } = renderWithProvider({
198
+ onInitialization,
199
+ configuration
200
+ });
201
+ getByText('I am a test application');
202
+ await flushPromises();
203
+ expect(onInitialization).not.toHaveBeenCalled();
204
+
205
+ idle.flushIdleCallbacks();
206
+ await flushPromises();
207
+ expect(onInitialization).toHaveBeenCalledTimes(1);
208
+ } finally {
209
+ idle.restore();
210
+ }
207
211
  });
208
212
  it('runs after initialization when partial initialization', async () => {
209
213
  const onInitialization = jest.fn();
@@ -5,7 +5,7 @@
5
5
  */
6
6
 
7
7
  import { fireEvent } from '@testing-library/react-native';
8
- import { NativeModules } from 'react-native';
8
+ import { InteractionManager, NativeModules } from 'react-native';
9
9
 
10
10
  import { DdSdkReactNative } from '../../../DdSdkReactNative';
11
11
  import { InitializationMode } from '../../../config/types';
@@ -22,7 +22,7 @@ import {
22
22
 
23
23
  import {
24
24
  getDefaultConfiguration,
25
- mockAnimation,
25
+ mockIdleCallback,
26
26
  renderWithProvider,
27
27
  renderWithProviderAndAnimation
28
28
  } from './__utils__/renderWithProvider';
@@ -70,70 +70,101 @@ describe('DatadogProvider', () => {
70
70
 
71
71
  expect(NativeModules.DdRum.addAction).toHaveBeenCalledTimes(1);
72
72
  });
73
- it('initializes the SDK before animations are done', async () => {
74
- const { finishAnimation } = mockAnimation();
75
- renderWithProvider();
73
+ it('initializes the SDK without waiting for idle callback', async () => {
74
+ const idle = mockIdleCallback();
75
+ try {
76
+ const configuration = getDefaultConfiguration();
77
+ configuration.initializationMode = InitializationMode.SYNC;
78
+ renderWithProvider({ configuration });
76
79
 
77
- await flushPromises();
78
- expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
79
- finishAnimation();
80
+ await flushPromises();
81
+
82
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
83
+
84
+ idle.flushIdleCallbacks();
85
+ await flushPromises();
86
+
87
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
88
+ } finally {
89
+ idle.restore();
90
+ }
80
91
  });
81
92
  });
82
93
 
83
94
  describe('initializationMode ASYNC', () => {
84
- beforeEach(() => {
85
- jest.useFakeTimers();
86
- });
87
- afterEach(() => {
88
- jest.useRealTimers();
89
- });
90
- it('starts auto-instrumentation after animations are done (with real Animation)', async () => {
91
- const configuration = getDefaultConfiguration();
92
- configuration.initializationMode = InitializationMode.ASYNC;
93
-
94
- const { getByText } = renderWithProviderAndAnimation({
95
- configuration
96
- });
97
- await flushPromises();
98
- expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(0);
99
- jest.advanceTimersByTime(700);
100
- await flushPromises();
101
- expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
102
- const button = getByText('test button');
103
- fireEvent(button, 'press', {
104
- _targetInst: {
105
- props: {
106
- 'dd-action-name': 'press button'
95
+ it('initializes the SDK when the idle callback fires', async () => {
96
+ const idle = mockIdleCallback();
97
+ try {
98
+ const configuration = getDefaultConfiguration();
99
+ configuration.initializationMode = InitializationMode.ASYNC;
100
+
101
+ const { getByText } = renderWithProvider({ configuration });
102
+ await flushPromises();
103
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(0);
104
+
105
+ idle.flushIdleCallbacks();
106
+ await flushPromises();
107
+
108
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
109
+ const button = getByText('test button');
110
+ fireEvent(button, 'press', {
111
+ _targetInst: {
112
+ props: {
113
+ 'dd-action-name': 'press button'
114
+ }
107
115
  }
108
- }
109
- });
110
- expect(NativeModules.DdRum.addAction).toHaveBeenCalledTimes(1);
116
+ });
117
+ expect(NativeModules.DdRum.addAction).toHaveBeenCalledTimes(1);
118
+ } finally {
119
+ idle.restore();
120
+ }
111
121
  });
112
122
 
113
- it('starts auto-instrumentation after animations are done (with InteractionManager)', async () => {
114
- jest.useRealTimers();
115
- const configuration = getDefaultConfiguration();
116
- configuration.initializationMode = InitializationMode.ASYNC;
123
+ it('defers initialization while animations are running', async () => {
124
+ const idle = mockIdleCallback();
125
+ try {
126
+ const configuration = getDefaultConfiguration();
127
+ configuration.initializationMode = InitializationMode.ASYNC;
117
128
 
118
- const { finishAnimation } = mockAnimation();
119
- const { getByText } = renderWithProvider({ configuration });
129
+ renderWithProviderAndAnimation({ configuration });
130
+ await flushPromises();
131
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(0);
120
132
 
121
- await flushPromises();
122
- expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(0);
133
+ idle.flushIdleCallbacks();
134
+ await flushPromises();
123
135
 
124
- finishAnimation();
125
- await flushPromises();
136
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
137
+ } finally {
138
+ idle.restore();
139
+ }
140
+ });
126
141
 
127
- expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
128
- const button = getByText('test button');
129
- fireEvent(button, 'press', {
130
- _targetInst: {
131
- props: {
132
- 'dd-action-name': 'press button'
133
- }
134
- }
135
- });
136
- expect(NativeModules.DdRum.addAction).toHaveBeenCalledTimes(1);
142
+ it('falls back to InteractionManager when requestIdleCallback is unavailable', async () => {
143
+ const original = (globalThis as Record<string, unknown>)
144
+ .requestIdleCallback;
145
+ (globalThis as Record<
146
+ string,
147
+ unknown
148
+ >).requestIdleCallback = undefined;
149
+ try {
150
+ const configuration = getDefaultConfiguration();
151
+ configuration.initializationMode = InitializationMode.ASYNC;
152
+
153
+ const handle = InteractionManager.createInteractionHandle();
154
+ renderWithProvider({ configuration });
155
+ await flushPromises();
156
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(0);
157
+
158
+ InteractionManager.clearInteractionHandle(handle);
159
+ await flushPromises();
160
+
161
+ expect(NativeModules.DdSdk.initialize).toHaveBeenCalledTimes(1);
162
+ } finally {
163
+ (globalThis as Record<
164
+ string,
165
+ unknown
166
+ >).requestIdleCallback = original;
167
+ }
137
168
  });
138
169
  });
139
170
 
@@ -11,9 +11,22 @@ import type { UserInfo } from './types';
11
11
  class UserInfoProvider {
12
12
  private userInfo: UserInfo | undefined = undefined;
13
13
 
14
- setUserInfo = (userInfo: UserInfo) => {
14
+ setUserInfo = (userInfo: UserInfo & { id: string }) => {
15
+ if (typeof userInfo.id !== 'string' || userInfo.id.length === 0) {
16
+ return;
17
+ }
15
18
  this.userInfo = userInfo;
16
- setCachedUserId(this.userInfo.id);
19
+ setCachedUserId(userInfo.id);
20
+ };
21
+
22
+ addUserExtraInfo = (extraInfo: Record<string, unknown>) => {
23
+ this.userInfo = {
24
+ ...this.userInfo,
25
+ extraInfo: {
26
+ ...this.userInfo?.extraInfo,
27
+ ...extraInfo
28
+ }
29
+ };
17
30
  };
18
31
 
19
32
  getUserInfo = (): UserInfo | undefined => {
@@ -5,7 +5,7 @@
5
5
  */
6
6
 
7
7
  export type UserInfo = {
8
- readonly id: string;
8
+ readonly id?: string;
9
9
  readonly name?: string;
10
10
  readonly email?: string;
11
11
  readonly extraInfo?: Record<string, unknown>;
@@ -68,12 +68,14 @@ export interface Spec extends TurboModule {
68
68
  * Add a RUM Action.
69
69
  * @param type: The action type (tap, scroll, swipe, back, custom).
70
70
  * @param name: The action name.
71
+ * @param touch: The native touch data for tap actions, or null for other action types.
71
72
  * @param context: The additional context to send.
72
73
  * @param timestampMs: The timestamp when the action occurred (in milliseconds). If not provided, current timestamp will be used.
73
74
  */
74
75
  addAction(
75
76
  type: string,
76
77
  name: string,
78
+ touch: Object | null,
77
79
  context: Object,
78
80
  timestampMs: number
79
81
  ): Promise<void>;
package/src/types.tsx CHANGED
@@ -47,13 +47,12 @@ export type DdSdkType = {
47
47
  removeAttributes(keys: string[]): Promise<void>;
48
48
 
49
49
  /**
50
- * Sets the user information.
51
- * @param id: A unique user identifier (relevant to your business domain)
52
- * @param name: The user name or alias.
53
- * @param email: The user email.
54
- * @param extraInfo: Additional information.
50
+ * Sets the user information. Requires a user ID — setting user properties
51
+ * like name or email implies a known user, so an ID must be provided.
52
+ * To add custom attributes without setting a user ID, use {@link addUserExtraInfo} instead.
53
+ * @param userInfo: The user object (id is required, name, email and extraInfo are optional).
55
54
  */
56
- setUserInfo(userInfo: UserInfo): Promise<void>;
55
+ setUserInfo(userInfo: UserInfo & { id: string }): Promise<void>;
57
56
 
58
57
  /**
59
58
  * Clears the user information.
@@ -128,7 +127,7 @@ export type DdTraceType = {
128
127
  // Core
129
128
 
130
129
  export type UserInfo = {
131
- id: string;
130
+ id?: string;
132
131
  name?: string;
133
132
  email?: string;
134
133
  extraInfo?: object;
package/src/version.ts CHANGED
@@ -1,2 +1,2 @@
1
1
  // generated by genversion
2
- export const version = '3.3.0';
2
+ export const version = '3.5.0';