feat: Add support for Get / Set SessionId on Rokt (#45)

Author: jamesnrokt

Package.swift

@@ -17,7 +17,7 @@ let package = Package(
                .upToNextMajor(from: "8.0.0")),
       .package(name: "Rokt-Widget",
                url: "https://github.com/ROKT/rokt-sdk-ios",
-               .upToNextMajor(from: "4.10.0")),
+               .upToNextMajor(from: "4.15.0")),
     ],
     targets: [
         .target(

mParticle-Rokt.podspec

@@ -21,15 +21,15 @@ Pod::Spec.new do |s|
         objc.source_files = 'mParticle-Rokt/*.{h,m}'
         objc.public_header_files = 'mParticle-Rokt/*.h'
         objc.dependency 'mParticle-Apple-SDK', '~> 8.0'
-        objc.dependency 'Rokt-Widget', '~> 4.10'
+        objc.dependency 'Rokt-Widget', '~> 4.15'
     end
 
      # Swift subspec
     s.subspec 'Swift' do |swift|
         swift.source_files = 'mParticle-Rokt-Swift/*.swift'
         swift.dependency 'mParticle-Rokt/ObjC'
         swift.dependency 'mParticle-Apple-SDK', '~> 8.0'
-        swift.dependency 'Rokt-Widget', '~> 4.10'
+        swift.dependency 'Rokt-Widget', '~> 4.15'
     end
 
     # Default includes both

mParticle-Rokt/MPKitRokt.m

@@ -511,6 +511,23 @@ - (MPKitExecStatus *)close {
     return [[MPKitExecStatus alloc] initWithSDKCode:[[self class] kitCode] returnCode:MPKitReturnCodeSuccess];
 }
 
+/// Set the session id to use for the next execute call.
+/// This is useful for cases where you have a session id from a non-native integration,
+/// e.g. WebView, and you want the session to be consistent across integrations.
+///
+/// @param sessionId The session id to be set. Must be a non-empty string.
+- (MPKitExecStatus *)setSessionId:(NSString *)sessionId {
+    [Rokt setSessionIdWithSessionId:sessionId];
+    return [[MPKitExecStatus alloc] initWithSDKCode:[[self class] kitCode] returnCode:MPKitReturnCodeSuccess];
+}
+
+/// Get the session id to use within a non-native integration e.g. WebView.
+///
+/// @return The session id or nil if no session is present.
+- (NSString *)getSessionId {
+    return [Rokt getSessionId];
+}
+
 #pragma mark - User attributes and identities
 
 - (MPKitExecStatus *)setUserIdentity:(NSString *)identityString identityType:(MPUserIdentity)identityType {

mParticle_RoktTests/mParticle_RoktTests.m

@@ -21,6 +21,9 @@ - (MPKitExecStatus *)purchaseFinalized:(NSString *)placementId
                          catalogItemId:(NSString *)catalogItemId
                                success:(NSNumber *)success;
 
+- (MPKitExecStatus *)setSessionId:(NSString *)sessionId;
+- (NSString *)getSessionId;
+
 - (NSDictionary<NSString *, RoktEmbeddedView *> * _Nullable) confirmEmbeddedViews:(NSDictionary<NSString *, MPRoktEmbeddedView *> * _Nullable)embeddedViews;
 
 + (void)addIdentityAttributes:(NSMutableDictionary<NSString *, NSString *> * _Nullable)attributes filteredUser:(FilteredMParticleUser * _Nonnull)filteredUser;
@@ -796,4 +799,79 @@ - (void)testExecuteWithIdentifierLogsSelectPlacementEventWithPreparedAttributes
     [mockMParticleInstance stopMocking];
 }
 
+#pragma mark - setSessionId tests
+
+- (void)testSetSessionIdCallsRoktSDK {
+    id mockRoktSDK = OCMClassMock([Rokt class]);
+
+    NSString *sessionId = @"test-session-id-12345";
+
+    // Expect Rokt setSessionIdWithSessionId call with correct parameter
+    OCMExpect([mockRoktSDK setSessionIdWithSessionId:sessionId]);
+
+    // Execute the method
+    MPKitExecStatus *status = [self.kitInstance setSessionId:sessionId];
+
+    // Verify
+    XCTAssertNotNil(status);
+    XCTAssertEqual(status.returnCode, MPKitReturnCodeSuccess);
+    XCTAssertEqualObjects(status.integrationId, @181);
+    OCMVerifyAll(mockRoktSDK);
+
+    [mockRoktSDK stopMocking];
+}
+
+- (void)testSetSessionIdWithEmptyString {
+    id mockRoktSDK = OCMClassMock([Rokt class]);
+
+    NSString *sessionId = @"";
+
+    // Expect Rokt setSessionIdWithSessionId call - the kit passes it through, Rokt SDK handles validation
+    OCMExpect([mockRoktSDK setSessionIdWithSessionId:sessionId]);
+
+    // Execute the method
+    MPKitExecStatus *status = [self.kitInstance setSessionId:sessionId];
+
+    // Verify
+    XCTAssertNotNil(status);
+    XCTAssertEqual(status.returnCode, MPKitReturnCodeSuccess);
+    OCMVerifyAll(mockRoktSDK);
+
+    [mockRoktSDK stopMocking];
+}
+
+#pragma mark - getSessionId tests
+
+- (void)testGetSessionIdReturnsSessionIdFromRoktSDK {
+    id mockRoktSDK = OCMClassMock([Rokt class]);
+
+    NSString *expectedSessionId = @"mock-session-id-67890";
+
+    // Stub Rokt getSessionId to return the expected session ID
+    OCMStub([mockRoktSDK getSessionId]).andReturn(expectedSessionId);
+
+    // Execute the method
+    NSString *result = [self.kitInstance getSessionId];
+
+    // Verify
+    XCTAssertEqualObjects(result, expectedSessionId, @"Should return the session id from the Rokt SDK");
+
+    [mockRoktSDK stopMocking];
+}
+
+- (void)testGetSessionIdReturnsNilWhenRoktSDKReturnsNil {
+    id mockRoktSDK = OCMClassMock([Rokt class]);
+
+    // Stub Rokt getSessionId to return nil
+    OCMStub([mockRoktSDK getSessionId]).andReturn(nil);
+
+    // Execute the method
+    NSString *result = [self.kitInstance getSessionId];
+
+    // Verify
+    XCTAssertNil(result, @"Should return nil when Rokt SDK returns nil");
+
+    [mockRoktSDK stopMocking];
+}
+
 @end