[copilot] start recording as soon as on should start recording is called to include deferred events as part of the current history file session (#6655)

Author: Pablo Guardiola

libnavigation-copilot/src/main/java/com/mapbox/navigation/copilot/MapboxCopilotImpl.kt

@@ -205,10 +205,10 @@ internal class MapboxCopilotImpl(
     private fun startRecordingHistory(
         historyRecordingSessionState: HistoryRecordingSessionState
     ) {
+        copilotHistoryRecorder.startRecording()
         currentHistoryRecordingSessionState = historyRecordingSessionState
         startSessionTime = System.currentTimeMillis()
         startedAt = currentUtcTime()
-        copilotHistoryRecorder.startRecording()
         driveId = historyRecordingSessionState.sessionId
         driveMode = when (historyRecordingSessionState) {
             is ActiveGuidance -> "active-guidance"

libnavigation-copilot/src/test/java/com/mapbox/navigation/copilot/MapboxCopilotImplTest.kt

@@ -40,6 +40,7 @@ import io.mockk.mockkStatic
 import io.mockk.slot
 import io.mockk.unmockkAll
 import io.mockk.verify
+import io.mockk.verifyOrder
 import org.junit.After
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertTrue
@@ -1859,6 +1860,45 @@ class MapboxCopilotImplTest {
         }
     }
 
+    @Test
+    fun `startRecording as soon as onShouldStartRecording`() {
+        val mockedMapboxNavigation = prepareBasicMockks()
+        prepareLifecycleOwnerMockk()
+        val mockedHistoryRecorder = mockk<MapboxHistoryRecorder>(relaxed = true)
+        every {
+            mockedMapboxNavigation.retrieveCopilotHistoryRecorder()
+        } returns mockedHistoryRecorder
+        val userFeedbackCallback = slot<UserFeedbackCallback>()
+        every { registerUserFeedbackCallback(capture(userFeedbackCallback)) } just Runs
+        val historyRecordingStateChangeObserver = slot<HistoryRecordingStateChangeObserver>()
+        every {
+            mockedMapboxNavigation.registerHistoryRecordingStateChangeObserver(
+                capture(historyRecordingStateChangeObserver)
+            )
+        } just Runs
+        val mapboxCopilot = MapboxCopilotImpl(mockedMapboxNavigation)
+        mapboxCopilot.start()
+        val searchResults =
+            SearchResults("mapbox", "https://mapbox.com", null, null, "?query=test1", null)
+        mapboxCopilot.push(SearchResultsEvent(searchResults))
+        val activeGuidanceHistoryRecordingSessionState =
+            mockk<HistoryRecordingSessionState.ActiveGuidance>(relaxed = true)
+        historyRecordingStateChangeObserver.captured.onShouldStartRecording(
+            activeGuidanceHistoryRecordingSessionState
+        )
+        val expectedEventJson = """
+            {"provider":"mapbox","request":"https://mapbox.com","searchQuery":"?query\u003dtest1"}
+        """.trimIndent()
+
+        verifyOrder {
+            mockedHistoryRecorder.startRecording()
+            mockedHistoryRecorder.pushHistory(
+                SEARCH_RESULTS_EVENT_NAME,
+                expectedEventJson,
+            )
+        }
+    }
+
     @Test
     fun `SearchResultsEvent is pushed when push - ActiveGuidance`() {
         val mockedMapboxNavigation = prepareBasicMockks()