-
Notifications
You must be signed in to change notification settings - Fork 625
Populate firebaseInstallationId field in session #4801
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
55 changes: 55 additions & 0 deletions
55
firebase-sessions/src/main/kotlin/com/google/firebase/sessions/SessionCoordinator.kt
This file contains hidden or 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,55 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.firebase.sessions | ||
|
|
||
| import android.util.Log | ||
| import com.google.firebase.installations.FirebaseInstallationsApi | ||
| import kotlinx.coroutines.CoroutineDispatcher | ||
| import kotlinx.coroutines.CoroutineScope | ||
| import kotlinx.coroutines.launch | ||
| import kotlinx.coroutines.tasks.await | ||
|
|
||
| /** | ||
| * [SessionCoordinator] is responsible for coordinating the systems in this SDK involved with | ||
| * sending a [SessionEvent]. | ||
| * | ||
| * @hide | ||
| */ | ||
| internal class SessionCoordinator( | ||
| private val firebaseInstallations: FirebaseInstallationsApi, | ||
| backgroundDispatcher: CoroutineDispatcher | ||
| ) { | ||
| private val scope = CoroutineScope(backgroundDispatcher) | ||
|
|
||
| fun attemptLoggingSessionEvent(sessionEvent: SessionEvent) = | ||
| scope.launch { | ||
| sessionEvent.sessionData.firebaseInstallationId = | ||
| try { | ||
| firebaseInstallations.id.await() | ||
| } catch (ex: Exception) { | ||
| Log.w(TAG, "Session Installations Error", ex) | ||
| // Use an empty fid if there is any failure. | ||
| "" | ||
| } | ||
|
|
||
| Log.i(TAG, "Initiate session start: $sessionEvent") | ||
| } | ||
|
|
||
| companion object { | ||
| private const val TAG = "SessionCoordinator" | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
58 changes: 58 additions & 0 deletions
58
firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionCoordinatorTest.kt
This file contains hidden or 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,58 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.firebase.sessions | ||
|
|
||
| import androidx.test.ext.junit.runners.AndroidJUnit4 | ||
| import com.google.common.truth.Truth.assertThat | ||
| import com.google.firebase.sessions.testing.FakeFirebaseInstallations | ||
| import kotlinx.coroutines.ExperimentalCoroutinesApi | ||
| import kotlinx.coroutines.test.StandardTestDispatcher | ||
| import kotlinx.coroutines.test.runCurrent | ||
| import kotlinx.coroutines.test.runTest | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
|
|
||
| @OptIn(ExperimentalCoroutinesApi::class) | ||
| @RunWith(AndroidJUnit4::class) | ||
| class SessionCoordinatorTest { | ||
| @Test | ||
| fun attemptLoggingSessionEvent_populatesFid() = runTest { | ||
| val sessionCoordinator = | ||
| SessionCoordinator( | ||
| firebaseInstallations = FakeFirebaseInstallations("FaKeFiD"), | ||
| backgroundDispatcher = StandardTestDispatcher(testScheduler), | ||
| ) | ||
|
|
||
| // Construct an event with no fid set. | ||
| val sessionEvent = | ||
| SessionEvent( | ||
| eventType = EventType.SESSION_START, | ||
| sessionData = | ||
| SessionInfo( | ||
| sessionId = "id", | ||
| firstSessionId = "first", | ||
| sessionIndex = 3, | ||
| ), | ||
| ) | ||
|
|
||
| sessionCoordinator.attemptLoggingSessionEvent(sessionEvent) | ||
|
|
||
| runCurrent() | ||
|
|
||
| assertThat(sessionEvent.sessionData.firebaseInstallationId).isEqualTo("FaKeFiD") | ||
| } | ||
| } | ||
This file contains hidden or 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
37 changes: 37 additions & 0 deletions
37
...essions/src/test/kotlin/com/google/firebase/sessions/testing/FakeFirebaseInstallations.kt
This file contains hidden or 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,37 @@ | ||
| /* | ||
| * Copyright 2023 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.google.firebase.sessions.testing | ||
|
|
||
| import com.google.android.gms.tasks.Task | ||
| import com.google.android.gms.tasks.Tasks | ||
| import com.google.firebase.installations.FirebaseInstallationsApi | ||
| import com.google.firebase.installations.InstallationTokenResult | ||
| import com.google.firebase.installations.internal.FidListener | ||
| import com.google.firebase.installations.internal.FidListenerHandle | ||
|
|
||
| /** Fake [FirebaseInstallationsApi] that implements [getId] and always returns the given [fid]. */ | ||
| internal class FakeFirebaseInstallations(private val fid: String = "") : FirebaseInstallationsApi { | ||
| override fun getId(): Task<String> = Tasks.forResult(fid) | ||
|
|
||
| override fun getToken(forceRefresh: Boolean): Task<InstallationTokenResult> = | ||
| throw NotImplementedError("getToken not faked.") | ||
|
|
||
| override fun delete(): Task<Void> = throw NotImplementedError("delete not faked.") | ||
|
|
||
| override fun registerFidListener(listener: FidListener): FidListenerHandle = | ||
| throw NotImplementedError("registerFidListener not faked.") | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:integ-testingdoesn't have any testCoroutineDispatchers to work well withrunTesting.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does that impact us?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:integ-testingis to provide executors for testing that mimic the executors provided byfirebase-commonwith policies e.g. don't do blocking network requests on Background. See https://firebase.github.io/firebase-android-sdk/components/executors/#testingSo these tests don't mimic the Background policy. I tried to use
TestOnlyExecutors.background().asCoroutineDispatcher()when I first wrote this test, but then I couldn't callrunCurrent()to wait for the suspend functions to finish before doing the assert.