feat: Add iOS overhead for SessionReplayFeature

This adds a Feature that will pass through Flutter generated Session Replay Records into SRSegments. The iOS Feature and RequestBuilder take care of serializing data to disk, assembling and compressing the SRSegments to send to intake.

The feature also takes care of broadcasting RUM context changes back to Flutter.

refs: RUM-9551

Author: fuzzybinary

packages/datadog_session_replay/example/ios/Podfile.lock

@@ -0,0 +1,70 @@
+PODS:
+  - datadog_flutter_plugin (0.0.1):
+    - DatadogCore (= 2.25.0)
+    - DatadogCrashReporting (= 2.25.0)
+    - DatadogInternal (= 2.25.0)
+    - DatadogLogs (= 2.25.0)
+    - DatadogRUM (= 2.25.0)
+    - DictionaryCoder (= 1.0.8)
+    - Flutter
+  - datadog_session_replay (0.0.1):
+    - DatadogCore (~> 2)
+    - Flutter
+  - DatadogCore (2.25.0):
+    - DatadogInternal (= 2.25.0)
+  - DatadogCrashReporting (2.25.0):
+    - DatadogInternal (= 2.25.0)
+    - PLCrashReporter (~> 1.12.0)
+  - DatadogInternal (2.25.0)
+  - DatadogLogs (2.25.0):
+    - DatadogInternal (= 2.25.0)
+  - DatadogRUM (2.25.0):
+    - DatadogInternal (= 2.25.0)
+  - DictionaryCoder (1.0.8)
+  - Flutter (1.0.0)
+  - integration_test (0.0.1):
+    - Flutter
+  - PLCrashReporter (1.12.0)
+
+DEPENDENCIES:
+  - datadog_flutter_plugin (from `.symlinks/plugins/datadog_flutter_plugin/ios`)
+  - datadog_session_replay (from `.symlinks/plugins/datadog_session_replay/ios`)
+  - Flutter (from `Flutter`)
+  - integration_test (from `.symlinks/plugins/integration_test/ios`)
+
+SPEC REPOS:
+  trunk:
+    - DatadogCore
+    - DatadogCrashReporting
+    - DatadogInternal
+    - DatadogLogs
+    - DatadogRUM
+    - DictionaryCoder
+    - PLCrashReporter
+
+EXTERNAL SOURCES:
+  datadog_flutter_plugin:
+    :path: ".symlinks/plugins/datadog_flutter_plugin/ios"
+  datadog_session_replay:
+    :path: ".symlinks/plugins/datadog_session_replay/ios"
+  Flutter:
+    :path: Flutter
+  integration_test:
+    :path: ".symlinks/plugins/integration_test/ios"
+
+SPEC CHECKSUMS:
+  datadog_flutter_plugin: 0536db97da04dda6e0198a732efb599a179cd316
+  datadog_session_replay: 50aac665d5a87dc45b9cb2df38c779e6cf43f9b0
+  DatadogCore: a068d264191f687d00125aafa8042110cf886cd7
+  DatadogCrashReporting: b19d80a98b1eb51bdb3ec5b1a7f339769fb70b95
+  DatadogInternal: e9b6cef84448ee32f73bc9b37646708a65c1b8ae
+  DatadogLogs: 623d89158ef3a4a7545a8fbce9afa4cedc576324
+  DatadogRUM: ff0661b42124d90c9ff2538c3cc1b806ddf7620c
+  DictionaryCoder: 5f84fff69f54cb806071538430bdafe04a89d658
+  Flutter: e0871f40cf51350855a761d2e70bf5af5b9b5de7
+  integration_test: 252f60fa39af5e17c3aa9899d35d908a0721b573
+  PLCrashReporter: db59ef96fa3d25f3650040d02ec2798cffee75f2
+
+PODFILE CHECKSUM: 4305caec6b40dde0ae97be1573c53de1882a07e5
+
+COCOAPODS: 1.16.2

packages/datadog_session_replay/example/ios/Runner.xcodeproj/project.pbxproj

@@ -0,0 +1,218 @@
+//// Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2025-Present Datadog, Inc.
+
+import Foundation
+import Testing
+import Flutter
+import DatadogInternal
+
+@testable import datadog_session_replay
+
+extension FlutterError: EquatableInTests {
+
+}
+
+func checkResult(_ result: ResultStatus, expectedError: NSObject) {
+    switch result {
+    case .called(let value):
+        #expect((value as? NSObject) === expectedError)
+    default:
+        #expect(Bool(false), "Unexpected result: \(result)")
+    }
+}
+
+func checkResult(_ result: ResultStatus, errorCode: String, errorMessage: String) throws {
+    switch result {
+    case .called(let value):
+        let error = value as? FlutterError
+        try #require(error != nil, "Unexpected error type: \(type(of: value))")
+        #expect(error?.code == errorCode)
+        #expect(error?.message == errorMessage)
+    default:
+        #expect(Bool(false), "Unexpected result: \(result)")
+    }
+}
+
+@Suite(.serialized)
+class SessionReplayPluginTests {
+    let mockCore = PassthroughCoreMock()
+    let mockChannel = FlutterMethodChannel()
+
+    init() {
+        CoreRegistry.register(default: mockCore)
+    }
+
+    deinit {
+        CoreRegistry.unregisterDefault()
+    }
+
+    @Test
+    func returnNotImplemented_WhenUnknownMethod() throws {
+        // Given
+        let plugin = DatadogSessionReplayPlugin(channel: FlutterMethodChannelMock())
+        let arguments: [String: Any] = [:]
+        let methodCall = FlutterMethodCall(methodName: "unknown", arguments: arguments)
+
+        // When
+        var status: ResultStatus = .notCalled
+        plugin.handle(methodCall) { result in
+            status = .called(value: result)
+        }
+
+        // Then
+        checkResult(status, expectedError: FlutterMethodNotImplemented)
+    }
+
+    @Test
+    func returnInvalidOperation_WhenBadArguments() throws {
+        // Given
+        let plugin = DatadogSessionReplayPlugin(channel: FlutterMethodChannelMock())
+        let methodCall = FlutterMethodCall(methodName: "unknown", arguments: 22)
+
+        // When
+        var status: ResultStatus = .notCalled
+        plugin.handle(methodCall) { result in
+            status = .called(value: result)
+        }
+
+        // Then
+        try checkResult(status, errorCode: "DatadogSdk:InvalidOperation", errorMessage: "No arguments in call to unknown")
+    }
+
+    @Test
+    func enablesFeature_WhenEnableMethodCall() {
+        // Given
+        let plugin = DatadogSessionReplayPlugin(channel: FlutterMethodChannelMock())
+        let arguments: [String: Any] = [
+            "configuration": [String: Any]()
+        ]
+        let methodCall = FlutterMethodCall(methodName: "enable", arguments: arguments)
+
+        // When
+        var status: ResultStatus = .notCalled
+        plugin.handle(methodCall) { result in
+            status = .called(value: result)
+        }
+
+        // Then
+        #expect(status == .called(value: nil))
+        #expect(mockCore.get(feature: FlutterSessionReplayFeature.self) != nil)
+    }
+
+    @Test
+    func returnsError_WhenEnableMethodCall_MissingConfiguration() throws {
+        // Given
+        let plugin = DatadogSessionReplayPlugin(channel: FlutterMethodChannelMock())
+        let arguments: [String: Any] = [:]
+        let methodCall = FlutterMethodCall(methodName: "enable", arguments: arguments)
+
+        // When
+        var status: ResultStatus = .notCalled
+        plugin.handle(methodCall) { result in
+            status = .called(value: result)
+        }
+
+        // Then
+        try checkResult(status, errorCode: "DatadogSdk:ContractViolation", errorMessage: "Missing parameter in call to enable")
+    }
+
+    @Test
+    func setsContext_WhenSetHasReplayMethodCall() throws {
+        // Given
+        let plugin = DatadogSessionReplayPlugin(channel: FlutterMethodChannelMock())
+        let expectedValue: Bool = .mockRandom()
+        let arguments: [String: Any] = [
+            "hasReplay": expectedValue
+        ]
+        let methodCall = FlutterMethodCall(methodName: "setHasReplay", arguments: arguments)
+
+        // When
+        plugin.enable(configuration: .init())
+        var status: ResultStatus = .notCalled
+        plugin.handle(methodCall) { result in
+            status = .called(value: result)
+        }
+
+        // Then
+        #expect(status == .called(value: nil))
+        let value = try mockCore.context.baggages["sr_has_replay"]?.encode() as? Bool
+        #expect(value == expectedValue)
+    }
+
+    @Test
+    func returnsError_WhenSetHasReplayMethodCall_InvalidParameter() throws {
+        // Given
+        let plugin = DatadogSessionReplayPlugin(channel: FlutterMethodChannelMock())
+        let arguments: [String: Any] = [
+            "hasReplay": "true"
+        ]
+        let methodCall = FlutterMethodCall(methodName: "setHasReplay", arguments: arguments)
+
+        // When
+        plugin.enable(configuration: .init())
+        var status: ResultStatus = .notCalled
+        plugin.handle(methodCall) { result in
+            status = .called(value: result)
+        }
+
+        // Then
+        try checkResult(status, errorCode: "DatadogSdk:ContractViolation", errorMessage: "Missing parameter in call to setHasReplay")
+    }
+
+    @Test
+    func setsContext_WhenSetRecordCountMethodCall() throws {
+        let plugin = DatadogSessionReplayPlugin(channel: FlutterMethodChannelMock())
+        let expectedValue: Int = .mockRandom()
+        let expectedViewId: String = .mockRandom()
+        let arguments: [String: Any] = [
+            "viewId": expectedViewId,
+            "count": expectedValue
+        ]
+        let methodCall = FlutterMethodCall(methodName: "setRecordCount", arguments: arguments)
+
+        // When
+        plugin.enable(configuration: .init())
+        var status: ResultStatus = .notCalled
+        plugin.handle(methodCall) { result in
+            status = .called(value: result)
+        }
+
+        // Then
+        #expect(status == .called(value: nil))
+        let value = try mockCore.context.baggages["sr_records_count_by_view_id"]?.encode() as? [String: Any]
+        #expect(value?.count == 1)
+        #expect(value?[expectedViewId] as? Int == expectedValue)
+    }
+
+    @Test
+    func broadcastsRumContext_WhenContextChanges() throws {
+        // Given
+        let methodChannelMock = FlutterMethodChannelMock()
+        let plugin = DatadogSessionReplayPlugin(channel: methodChannelMock)
+        plugin.enable(configuration: .init())
+
+        // When
+        let expectedRumContext: RUMContext = .mockRandom()
+        let datadogContext: DatadogContext = .mockRandom(
+            withBaggages: [
+                RUMContext.key: .init(expectedRumContext)]
+        )
+        mockCore.send(message: .context(datadogContext), else: {})
+
+        // Then
+        // Push to the back of the main queue, as method channel must send
+        // callbacks on the main queue
+        try DispatchQueue.main.sync {
+            try #require(methodChannelMock.invocations.count == 1)
+            let argument = methodChannelMock.invocations[0].arguments as? [String: Any?]
+            try #require(argument != nil)
+            if let argument = argument {
+                #expect(argument["applicationId"] as? String == expectedRumContext.applicationID)
+                #expect(argument["sessionId"] as? String == expectedRumContext.sessionID)
+                #expect(argument["viewId"] as? String == expectedRumContext.viewID)
+                #expect(argument["viewServerTimeOffset"] as? TimeInterval == expectedRumContext.viewServerTimeOffset)
+            }
+        }
+    }
+}

packages/datadog_session_replay/example/ios/Runner.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,65 @@
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache License Version 2.0.
+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2025-Present Datadog, Inc.
+
+import Foundation
+import Testing
+
+@testable import datadog_session_replay
+
+@Test
+func setsReplayBaggage_WhenSetHasReplay() throws {
+    // Given
+    let core = PassthroughCoreMock()
+    let config = FlutterSessionReplay.Configuration()
+    let feature = try FlutterSessionReplayFeature(core: core, configuration: config)
+
+    // When
+    let expectedValue: Bool = .mockRandom()
+    feature.setHasReplay(expectedValue)
+
+    // Then
+    let value = try core.context.baggages["sr_has_replay"]?.encode() as? Bool
+    #expect(value == expectedValue)
+}
+
+@Test
+func setsBackage_WhenSetRecordCount() throws {
+    // Given
+    let core = PassthroughCoreMock()
+    let config = FlutterSessionReplay.Configuration()
+    let feature = try FlutterSessionReplayFeature(core: core, configuration: config)
+
+    // When
+    let viewId: String = .mockRandom()
+    let expectedCount: Int = .mockRandom()
+    feature.setRecordCount(for: viewId, count: expectedCount)
+
+    // Then
+    let baggage = try core.context.baggages["sr_records_count_by_view_id"]?.encode() as? [String: Any]
+    let value = baggage?[viewId] as? Int
+    #expect(value == expectedCount)
+}
+
+@Test
+func setsBackage_WhenSetRecordCount_MultipleViews() throws {
+    // Given
+    let core = PassthroughCoreMock()
+    let config = FlutterSessionReplay.Configuration()
+    let feature = try FlutterSessionReplayFeature(core: core, configuration: config)
+
+    // When
+    let viewIdA: String = .mockRandom()
+    let viewIdB: String = .mockRandom()
+    let expectedCountA: Int = .mockRandom()
+    let expectedCountB: Int = .mockRandom()
+    feature.setRecordCount(for: viewIdA, count: expectedCountA)
+    feature.setRecordCount(for: viewIdB, count: expectedCountB)
+
+    // Then
+    let baggage = try core.context.baggages["sr_records_count_by_view_id"]?.encode() as? [String: Any]
+    let valueA = baggage?[viewIdA] as? Int
+    #expect(valueA == expectedCountA)
+    let valueB = baggage?[viewIdB] as? Int
+    #expect(valueB == expectedCountB)
+}