[HEAP-43104] Send a foregrounded notification to the SDK on startRecording (#101)

Author: bnickel

Development/Sources/HeapSwiftCore/Implementations/EventConsumer/EventConsumer.swift

@@ -113,6 +113,27 @@ class EventConsumer<StateStore: StateStoreProtocol, DataStore: DataStoreProtocol
                 }
             }
         }
+        
+        if updateResults.outcomes.currentStarted {
+            // Switch to the main thread so we can check Event.AppVisibility.current.
+            onMainThread {
+                
+                if Event.AppVisibility.current == .foregrounded {
+                    
+                    for (sourceName, source) in snapshot.sources {
+                        source.applicationDidEnterForeground(timestamp: timestamp) {
+                            HeapLogger.shared.trace("Source [\(sourceName)] has completed all work related to session initialization.")
+                        }
+                    }
+                    
+                    for bridge in snapshot.runtimeBridges {
+                        bridge.applicationDidEnterForeground(timestamp: timestamp) {
+                            HeapLogger.shared.trace("Bridge of type [\(type(of: bridge))] has completed all work related to session initialization.")
+                        }
+                    }
+                }
+            }
+        }
     }
 }
 

Development/Tests/HeapSwiftCoreTests/EventConsumer/StartRecordingSpec.swift

@@ -186,7 +186,7 @@ final class EventConsumer_StartRecordingSpec: HeapSpec {
                 expect(dataStore.usersToUpload()).to(haveCount(1), description: "Data store should have purged three users and created one more")
             }
 
-            context("with a source and bridge added when called with startSessionImmediately") {
+            context("with a source and bridge added") {
 
                 var bridge: CountingRuntimeBridge!
                 var source: CountingSource!
@@ -198,54 +198,109 @@ final class EventConsumer_StartRecordingSpec: HeapSpec {
                     consumer.addRuntimeBridge(bridge)
                     consumer.addSource(source, isDefault: false)
 
-                    consumer.startRecording("11", with: [ .startSessionImmediately: true ])
+                    consumer.startRecording("11")
                 }
 
-                it("calls .didStartRecording and .sessionDidStart on sources and bridges") {
+                it("calls .didStartRecording on sources and bridges") {
 
                     expect(bridge.calls).to(equal([
                         .didStartRecording,
-                        .sessionDidStart,
-                    ]))
+                    ] + foregroundEventIfForegrounded()))
 
                     expect(source.calls).to(equal([
                         .didStartRecording,
-                        .sessionDidStart,
-                    ]))
+                    ] + foregroundEventIfForegrounded()))
                 }
 
                 it("calls .didStopRecording on sources and bridges") {
 
+                    bridge.calls.removeAll()
+                    source.calls.removeAll()
                     consumer.stopRecording()
 
                     expect(bridge.calls).to(equal([
-                        .didStartRecording,
-                        .sessionDidStart,
                         .didStopRecording
                     ]))
 
                     expect(source.calls).to(equal([
-                        .didStartRecording,
-                        .sessionDidStart,
                         .didStopRecording
                     ]))
                 }
 
                 it("does not call .didStopRecording on sources and bridges when called twice") {
 
+                    bridge.calls.removeAll()
+                    source.calls.removeAll()
                     consumer.startRecording("12")
 
+                    expect(bridge.calls).to(equal([
+                        .didStartRecording,
+                    ] + foregroundEventIfForegrounded()))
+                    
+                    expect(source.calls).to(equal([
+                        .didStartRecording,
+                    ] + foregroundEventIfForegrounded()))
+                }
+            }
+            
+            context("with a source and bridge added, called with startSessionImmediately") {
+                
+                var bridge: CountingRuntimeBridge!
+                var source: CountingSource!
+
+                beforeEach {
+                    bridge = CountingRuntimeBridge()
+                    source = CountingSource(name: "A", version: "1")
+                    
+                    consumer.addRuntimeBridge(bridge)
+                    consumer.addSource(source, isDefault: false)
+                    
+                    consumer.startRecording("11", with: [ .startSessionImmediately: true ])
+                }
+                
+                it("calls .didStartRecording and .sessionDidStart on sources and bridges") {
+
                     expect(bridge.calls).to(equal([
                         .didStartRecording,
                         .sessionDidStart,
+                    ] + foregroundEventIfForegrounded()))
+                    
+                    expect(source.calls).to(equal([
                         .didStartRecording,
+                        .sessionDidStart,
+                    ] + foregroundEventIfForegrounded()))
+                }
+                
+                it("calls .didStopRecording on sources and bridges") {
+
+                    bridge.calls.removeAll()
+                    source.calls.removeAll()
+                    consumer.stopRecording()
+                    
+                    expect(bridge.calls).to(equal([
+                        .didStopRecording
                     ]))
 
                     expect(source.calls).to(equal([
+                        .didStopRecording
+                    ]))
+                }
+                
+                it("does not call .didStopRecording on sources and bridges when called twice") {
+
+                    bridge.calls.removeAll()
+                    source.calls.removeAll()
+                    consumer.startRecording("12", with: [ .startSessionImmediately: true ])
+                    
+                    expect(bridge.calls).to(equal([
                         .didStartRecording,
                         .sessionDidStart,
+                    ] + foregroundEventIfForegrounded()))
+                    
+                    expect(source.calls).to(equal([
                         .didStartRecording,
-                    ]))
+                        .sessionDidStart,
+                    ] + foregroundEventIfForegrounded()))
                 }
             }