Merge pull request #470 from DataDog/louiszawadzki/stop-session-support

Kiosk apps support

Author: louiszawadzki

packages/core/__mocks__/react-native.ts

@@ -101,7 +101,10 @@ actualRN.NativeModules.DdRum = {
     ) as jest.MockedFunction<DdRumType['addError']>,
     addTiming: jest.fn().mockImplementation(
         () => new Promise<void>(resolve => resolve())
-    ) as jest.MockedFunction<DdRumType['addTiming']>
+    ) as jest.MockedFunction<DdRumType['addTiming']>,
+    stopSession: jest.fn().mockImplementation(
+        () => new Promise<void>(resolve => resolve())
+    ) as jest.MockedFunction<DdRumType['stopSession']>
 };
 
 module.exports = actualRN;

packages/core/android/src/main/kotlin/com/datadog/reactnative/DdRum.kt

@@ -255,6 +255,15 @@ class DdRum(reactContext: ReactApplicationContext) : ReactContextBaseJavaModule(
         promise.resolve(null)
     }
 
+    /**
+     * Stops the current RUM Session.
+     */
+    @ReactMethod
+    fun stopSession(promise: Promise) {
+        GlobalRum.get().stopSession()
+        promise.resolve(null)
+    }
+
     // region Internal
 
     private fun String.asRumActionType(): RumActionType {

packages/core/android/src/test/kotlin/com/datadog/reactnative/DdRumTest.kt

@@ -410,4 +410,14 @@ internal class DdRumTest {
         // Then
         verify(mockRumMonitor).addTiming(timing)
     }
+
+    @Test
+    fun `M call stopSession W stopSession()`() {
+
+        // When
+        testedDdRum.stopSession(mockPromise)
+
+        // Then
+        verify(mockRumMonitor).stopSession()
+    }
 }

packages/core/ios/Sources/DdRum.m

@@ -71,4 +71,7 @@ @interface RCT_EXTERN_MODULE(DdRum, NSObject)
                  withResolver:(RCTPromiseResolveBlock)resolve
                  withRejecter:(RCTPromiseRejectBlock)reject)
 
+RCT_EXTERN_METHOD(stopSession:(RCTPromiseResolveBlock)resolve
+                 withRejecter:(RCTPromiseRejectBlock)reject)
+
 @end

packages/core/ios/Sources/DdRum.swift

@@ -18,6 +18,7 @@ internal protocol NativeRUM {
     func stopUserAction(type: RUMUserActionType, name: String?, attributes: [String: Encodable])
     func addUserAction(type: RUMUserActionType, name: String, attributes: [String: Encodable])
     func addTiming(name: String)
+    func stopSession()
     func addResourceMetrics(resourceKey: String,
                             fetch: (start: Date, end: Date),
                             redirection: (start: Date, end: Date)?,
@@ -187,6 +188,12 @@ class RNDdRum: NSObject {
         resolve(nil)
     }
 
+    @objc(stopSession:withRejecter:)
+    func stopSession(resolve:RCTPromiseResolveBlock, reject:RCTPromiseRejectBlock) -> Void {
+        nativeRUM.stopSession()
+        resolve(nil)
+    }
+
     // MARK: - Private methods
 
     private func attributes(from context: NSDictionary, with timestampMs: Int64) -> [String: Encodable] {

packages/core/ios/Tests/DdRumTests.swift

@@ -249,6 +249,14 @@ internal class DdRumTests: XCTestCase {
         XCTAssertEqual(mockNativeRUM.receivedAttributes.count, 0)
     }
 
+    func testStopSession() throws {
+        rum.stopSession(resolve: mockResolve, reject: mockReject)
+
+        XCTAssertEqual(mockNativeRUM.calledMethods.count, 1)
+        XCTAssertEqual(mockNativeRUM.calledMethods.last, .stopSession())
+        XCTAssertEqual(mockNativeRUM.receivedAttributes.count, 0)
+    }
+
     func testRumErrorSourceMapping() throws {
         XCTAssertEqual(RUMErrorSource(from: "source"), RUMErrorSource.source)
         XCTAssertEqual(RUMErrorSource(from: "network"), RUMErrorSource.network)
@@ -278,6 +286,7 @@ private class MockNativeRUM: NativeRUM {
         case stopUserAction(type: RUMUserActionType, name: String?)
         case addUserAction(type: RUMUserActionType, name: String)
         case addTiming(name: String)
+        case stopSession(_: Int? = nil) // We need an attribute for the case to be Equatable
         case addResourceMetrics(resourceKey: String,
                                 fetch: Interval,
                                 redirection: Interval,
@@ -331,6 +340,9 @@ private class MockNativeRUM: NativeRUM {
     func addTiming(name: String) {
         calledMethods.append(.addTiming(name: name))
     }
+    func stopSession() {
+        calledMethods.append(.stopSession())
+    }
     func addResourceMetrics(
         resourceKey: String,
         fetch: (start: Date, end: Date),

packages/core/src/nativeModulesTypes.ts

@@ -322,6 +322,11 @@ export type DdNativeRumType = {
      * @param name: The name of the new custom timing attribute. Timings can be nested up to 8 levels deep. Names using more than 8 levels will be sanitized by SDK.
      */
     addTiming(name: string): Promise<void>;
+
+    /**
+     * Stops the current RUM Session.
+     */
+    stopSession(): Promise<void>;
 };
 
 type ActionType = 'TAP' | 'SCROLL' | 'SWIPE' | 'BACK' | 'CUSTOM';

packages/core/src/rum/DdRum.ts

@@ -326,6 +326,11 @@ class DdRumWrapper implements DdRumType {
         return bufferVoidNativeCall(() => this.nativeRum.addTiming(name));
     }
 
+    stopSession(): Promise<void> {
+        InternalLog.log('Stopping RUM Session', SdkVerbosity.DEBUG);
+        return bufferVoidNativeCall(() => this.nativeRum.stopSession());
+    }
+
     registerErrorEventMapper(errorEventMapper: ErrorEventMapper) {
         this.errorEventMapper = generateErrorEventMapper(errorEventMapper);
     }

packages/core/src/rum/__tests__/DdRum.test.ts

@@ -24,12 +24,12 @@ jest.mock('../../TimeProvider', () => {
 });
 
 describe('DdRum', () => {
-    describe('DdRum.stopAction', () => {
-        beforeEach(() => {
-            jest.clearAllMocks();
-            BufferSingleton.onInitialization();
-        });
+    beforeEach(() => {
+        jest.clearAllMocks();
+        BufferSingleton.onInitialization();
+    });
 
+    describe('DdRum.stopAction', () => {
         test('calls the native SDK when called with new API', async () => {
             await DdRum.stopAction('scroll', 'page', { user: 'me' }, 123);
             expect(NativeModules.DdRum.stopAction).toHaveBeenCalledWith(
@@ -151,11 +151,6 @@ describe('DdRum', () => {
     });
 
     describe('DdRum.addError', () => {
-        beforeEach(() => {
-            jest.clearAllMocks();
-            DdRum.unregisterErrorEventMapper();
-        });
-
         it('registers event mapper and maps error', async () => {
             const errorEventMapper: ErrorEventMapper = error => {
                 error.message = 'New message';
@@ -196,12 +191,6 @@ describe('DdRum', () => {
     });
 
     describe('DdRum.stopResource', () => {
-        beforeEach(() => {
-            jest.clearAllMocks();
-            DdRum.unregisterResourceEventMapper();
-            BufferSingleton.onInitialization();
-        });
-
         it('registers event mapper and maps resource', async () => {
             const resourceEventMapper: ResourceEventMapper = resource => {
                 resource.context = { retryAttempts: 3 };
@@ -270,11 +259,6 @@ describe('DdRum', () => {
     });
 
     describe('DdRum.addAction', () => {
-        beforeEach(() => {
-            jest.clearAllMocks();
-            DdRum.unregisterActionEventMapper();
-        });
-
         it('registers event mapper and maps action', async () => {
             const actionEventMapper: ActionEventMapper = action => {
                 action.context = { frustration: true };
@@ -318,12 +302,6 @@ describe('DdRum', () => {
     });
 
     describe('DdRum.stopAction', () => {
-        beforeEach(() => {
-            jest.clearAllMocks();
-            DdRum.unregisterActionEventMapper();
-            BufferSingleton.onInitialization();
-        });
-
         it('registers event mapper and maps action', async () => {
             const actionEventMapper: ActionEventMapper = action => {
                 action.context = { frustration: true };
@@ -384,6 +362,13 @@ describe('DdRum', () => {
         });
     });
 
+    describe('DdRum.stopSession', () => {
+        it('calls the native API', async () => {
+            await DdRum.stopSession();
+            expect(NativeModules.DdRum.stopSession).toHaveBeenCalledWith();
+        });
+    });
+
     describe('PropagatorTypes', () => {
         it('matches with the native name of propagators', () => {
             /**

packages/core/src/rum/types.ts

@@ -142,6 +142,11 @@ export type DdRumType = {
      * @param name: The name of the new custom timing attribute. Timings can be nested up to 8 levels deep. Names using more than 8 levels will be sanitized by SDK.
      */
     addTiming(name: string): Promise<void>;
+
+    /**
+     * Stops the current RUM Session.
+     */
+    stopSession(): Promise<void>;
 };
 
 /**