-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #556 from embrace-io/add-new-collator
Add V2 payload message collator
- Loading branch information
Showing
7 changed files
with
225 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
...k/src/main/java/io/embrace/android/embracesdk/session/message/V2PayloadMessageCollator.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| package io.embrace.android.embracesdk.session.message | ||
|
|
||
| import io.embrace.android.embracesdk.payload.Session | ||
| import io.embrace.android.embracesdk.payload.SessionMessage | ||
|
|
||
| /** | ||
| * Generates a V2 payload. This currently calls through to the V1 collator for | ||
| * backwards compatibility. | ||
| */ | ||
| internal class V2PayloadMessageCollator( | ||
| private val v1Collator: V1PayloadMessageCollator | ||
| ) : PayloadMessageCollator { | ||
|
|
||
| override fun buildInitialSession(params: InitialEnvelopeParams): Session { | ||
| return v1Collator.buildInitialSession(params) | ||
| } | ||
|
|
||
| override fun buildFinalSessionMessage(params: FinalEnvelopeParams.SessionParams): SessionMessage { | ||
| return v1Collator.buildFinalSessionMessage(params) | ||
| } | ||
|
|
||
| override fun buildFinalBackgroundActivityMessage(params: FinalEnvelopeParams.BackgroundActivityParams): SessionMessage { | ||
| return v1Collator.buildFinalBackgroundActivityMessage(params) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
190 changes: 190 additions & 0 deletions
190
...c/test/java/io/embrace/android/embracesdk/session/message/V2PayloadMessageCollatorTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| package io.embrace.android.embracesdk.session.message | ||
|
|
||
| import io.embrace.android.embracesdk.FakeBreadcrumbService | ||
| import io.embrace.android.embracesdk.FakeSessionPropertiesService | ||
| import io.embrace.android.embracesdk.fakes.FakeConfigService | ||
| import io.embrace.android.embracesdk.fakes.FakeEventService | ||
| import io.embrace.android.embracesdk.fakes.FakeInternalErrorService | ||
| import io.embrace.android.embracesdk.fakes.FakeLogMessageService | ||
| import io.embrace.android.embracesdk.fakes.FakeMetadataService | ||
| import io.embrace.android.embracesdk.fakes.FakePerformanceInfoService | ||
| import io.embrace.android.embracesdk.fakes.FakePreferenceService | ||
| import io.embrace.android.embracesdk.fakes.FakeStartupService | ||
| import io.embrace.android.embracesdk.fakes.FakeThermalStatusService | ||
| import io.embrace.android.embracesdk.fakes.FakeUserService | ||
| import io.embrace.android.embracesdk.fakes.FakeWebViewService | ||
| import io.embrace.android.embracesdk.fakes.injection.FakeInitModule | ||
| import io.embrace.android.embracesdk.payload.LegacyExceptionError | ||
| import io.embrace.android.embracesdk.payload.Session | ||
| import io.embrace.android.embracesdk.payload.SessionMessage | ||
| import io.embrace.android.embracesdk.session.orchestrator.SessionSnapshotType | ||
| import org.junit.Assert | ||
| import org.junit.Assert.assertEquals | ||
| import org.junit.Assert.assertNotNull | ||
| import org.junit.Before | ||
| import org.junit.Test | ||
|
|
||
| internal class V2PayloadMessageCollatorTest { | ||
|
|
||
| private lateinit var initModule: FakeInitModule | ||
| private lateinit var v1collator: V1PayloadMessageCollator | ||
| private lateinit var v2collator: V2PayloadMessageCollator | ||
|
|
||
| private enum class PayloadType { | ||
| BACKGROUND_ACTIVITY, | ||
| SESSION | ||
| } | ||
|
|
||
| @Before | ||
| fun setUp() { | ||
| initModule = FakeInitModule() | ||
| v1collator = V1PayloadMessageCollator( | ||
| configService = FakeConfigService(), | ||
| nativeThreadSamplerService = null, | ||
| thermalStatusService = FakeThermalStatusService(), | ||
| webViewService = FakeWebViewService(), | ||
| userService = FakeUserService(), | ||
| preferencesService = FakePreferenceService(), | ||
| eventService = FakeEventService(), | ||
| logMessageService = FakeLogMessageService(), | ||
| internalErrorService = FakeInternalErrorService().apply { currentExceptionError = LegacyExceptionError() }, | ||
| breadcrumbService = FakeBreadcrumbService(), | ||
| metadataService = FakeMetadataService(), | ||
| performanceInfoService = FakePerformanceInfoService(), | ||
| spanSink = initModule.openTelemetryModule.spanSink, | ||
| currentSessionSpan = initModule.openTelemetryModule.currentSessionSpan, | ||
| sessionPropertiesService = FakeSessionPropertiesService(), | ||
| startupService = FakeStartupService() | ||
| ) | ||
| v2collator = V2PayloadMessageCollator(v1collator) | ||
| } | ||
|
|
||
| @Test | ||
| fun `create background activity initial message`() { | ||
| val msg = v2collator.buildInitialSession( | ||
| InitialEnvelopeParams.BackgroundActivityParams( | ||
| false, | ||
| Session.LifeEventType.BKGND_STATE, | ||
| 5 | ||
| ) | ||
| ) | ||
| msg.verifyInitialFieldsPopulated(PayloadType.BACKGROUND_ACTIVITY) | ||
| } | ||
|
|
||
| @Test | ||
| fun `create session initial message`() { | ||
| val msg = v2collator.buildInitialSession( | ||
| InitialEnvelopeParams.SessionParams( | ||
| false, | ||
| Session.LifeEventType.STATE, | ||
| 5 | ||
| ) | ||
| ) | ||
| msg.verifyInitialFieldsPopulated(PayloadType.SESSION) | ||
| } | ||
|
|
||
| @Test | ||
| fun `create background activity end message`() { | ||
| // create start message | ||
| val startMsg = v2collator.buildInitialSession( | ||
| InitialEnvelopeParams.BackgroundActivityParams( | ||
| false, | ||
| Session.LifeEventType.BKGND_STATE, | ||
| 5 | ||
| ) | ||
| ) | ||
| startMsg.verifyInitialFieldsPopulated(PayloadType.BACKGROUND_ACTIVITY) | ||
|
|
||
| // create session | ||
| val payload = v2collator.buildFinalBackgroundActivityMessage( | ||
| FinalEnvelopeParams.BackgroundActivityParams( | ||
| startMsg, | ||
| 15000000000, | ||
| Session.LifeEventType.BKGND_STATE, | ||
| "crashId" | ||
| ) | ||
| ) | ||
| payload.verifyFinalFieldsPopulated(PayloadType.BACKGROUND_ACTIVITY) | ||
| } | ||
|
|
||
| @Test | ||
| fun `create session end message`() { | ||
| // create start message | ||
| val startMsg = v2collator.buildInitialSession( | ||
| InitialEnvelopeParams.SessionParams( | ||
| false, | ||
| Session.LifeEventType.STATE, | ||
| 5 | ||
| ) | ||
| ) | ||
| startMsg.verifyInitialFieldsPopulated(PayloadType.SESSION) | ||
|
|
||
| // create session | ||
| val payload = v2collator.buildFinalSessionMessage( | ||
| FinalEnvelopeParams.SessionParams( | ||
| startMsg, | ||
| 15000000000, | ||
| Session.LifeEventType.STATE, | ||
| "crashId", | ||
| SessionSnapshotType.NORMAL_END | ||
| ) | ||
| ) | ||
| payload.verifyFinalFieldsPopulated(PayloadType.SESSION) | ||
| } | ||
|
|
||
| private fun SessionMessage.verifyFinalFieldsPopulated( | ||
| payloadType: PayloadType | ||
| ) { | ||
| assertNotNull(userInfo) | ||
| assertNotNull(appInfo) | ||
| assertNotNull(deviceInfo) | ||
| assertNotNull(performanceInfo) | ||
| assertNotNull(breadcrumbs) | ||
| session.verifyInitialFieldsPopulated(payloadType) | ||
| session.verifyFinalFieldsPopulated(payloadType) | ||
| } | ||
|
|
||
| private fun Session.verifyInitialFieldsPopulated(payloadType: PayloadType) { | ||
| assertNotNull(sessionId) | ||
| assertEquals(5L, startTime) | ||
| Assert.assertFalse(isColdStart) | ||
| assertNotNull(number) | ||
|
|
||
| val expectedState = when (payloadType) { | ||
| PayloadType.BACKGROUND_ACTIVITY -> Session.APPLICATION_STATE_BACKGROUND | ||
| PayloadType.SESSION -> Session.APPLICATION_STATE_FOREGROUND | ||
| } | ||
| val expectedStartType = when (payloadType) { | ||
| PayloadType.BACKGROUND_ACTIVITY -> Session.LifeEventType.BKGND_STATE | ||
| PayloadType.SESSION -> Session.LifeEventType.STATE | ||
| } | ||
| val expectedSessionProps = when (payloadType) { | ||
| PayloadType.BACKGROUND_ACTIVITY -> null | ||
| PayloadType.SESSION -> emptyMap<String, String>() | ||
| } | ||
| assertEquals(expectedState, appState) | ||
| assertEquals(expectedStartType, startType) | ||
| assertEquals(Session.MESSAGE_TYPE_END, messageType) | ||
| assertEquals(expectedSessionProps, properties) | ||
| } | ||
|
|
||
| private fun Session.verifyFinalFieldsPopulated(payloadType: PayloadType) { | ||
| val expectedEndType = when (payloadType) { | ||
| PayloadType.BACKGROUND_ACTIVITY -> Session.LifeEventType.BKGND_STATE | ||
| PayloadType.SESSION -> Session.LifeEventType.STATE | ||
| } | ||
| assertEquals(15000000000L, endTime) | ||
| assertEquals(expectedEndType, endType) | ||
| assertEquals(15000000000L, lastHeartbeatTime) | ||
| assertEquals("crashId", crashReportId) | ||
| assertNotNull(eventIds) | ||
| assertNotNull(infoLogIds) | ||
| assertNotNull(warningLogIds) | ||
| assertNotNull(errorLogIds) | ||
| assertNotNull(infoLogsAttemptedToSend) | ||
| assertNotNull(warnLogsAttemptedToSend) | ||
| assertNotNull(errorLogsAttemptedToSend) | ||
| assertNotNull(exceptionError) | ||
| assertNotNull(unhandledExceptions) | ||
| } | ||
| } |