-
Notifications
You must be signed in to change notification settings - Fork 58
Avoid leaking pending broadcast in GenericCallActionBroadcastReceiver when call id is missing #1768
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
Open
rahul-lohra
wants to merge
1
commit into
develop
Choose a base branch
from
improvement/rahullohra/broadcast-receiver
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
146 changes: 146 additions & 0 deletions
146
...o/android/core/notifications/internal/receivers/GenericCallActionBroadcastReceiverTest.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,146 @@ | ||
| /* | ||
| * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. | ||
| * | ||
| * Licensed under the Stream License; | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://github.com/GetStream/stream-video-android/blob/main/LICENSE | ||
| * | ||
| * 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 io.getstream.video.android.core.notifications.internal.receivers | ||
|
|
||
| import android.content.BroadcastReceiver | ||
| import android.content.Context | ||
| import android.content.Intent | ||
| import io.getstream.video.android.core.Call | ||
| import io.getstream.video.android.core.StreamVideo | ||
| import io.getstream.video.android.core.notifications.NotificationHandler | ||
| import io.getstream.video.android.model.StreamCallId | ||
| import io.mockk.every | ||
| import io.mockk.mockk | ||
| import io.mockk.mockkObject | ||
| import io.mockk.spyk | ||
| import io.mockk.unmockkAll | ||
| import io.mockk.verify | ||
| import org.junit.After | ||
| import org.junit.Assert.assertEquals | ||
| import org.junit.Before | ||
| import org.junit.Test | ||
| import org.junit.runner.RunWith | ||
| import org.robolectric.RobolectricTestRunner | ||
| import org.robolectric.RuntimeEnvironment | ||
| import java.util.concurrent.atomic.AtomicInteger | ||
|
|
||
| @RunWith(RobolectricTestRunner::class) | ||
| class GenericCallActionBroadcastReceiverTest { | ||
|
|
||
| private val testAction = "io.getstream.video.android.TEST_ACTION" | ||
|
|
||
| /** | ||
| * Concrete receiver used to observe how [GenericCallActionBroadcastReceiver] dispatches | ||
| * to the actual action handler. | ||
| */ | ||
| private class TestReceiver(override val action: String) : GenericCallActionBroadcastReceiver() { | ||
| @Volatile | ||
| var handledCall: Call? = null | ||
| val invocationCount = AtomicInteger(0) | ||
|
|
||
| override suspend fun onReceive(call: Call, context: Context, intent: Intent) { | ||
| invocationCount.incrementAndGet() | ||
| handledCall = call | ||
| } | ||
| } | ||
|
|
||
| private lateinit var context: Context | ||
| private lateinit var receiver: TestReceiver | ||
| private lateinit var pendingResult: BroadcastReceiver.PendingResult | ||
|
|
||
| @Before | ||
| fun setup() { | ||
| context = RuntimeEnvironment.getApplication() | ||
| pendingResult = mockk(relaxed = true) | ||
| // Spy so we can observe goAsync() and stub it, since a real broadcast context is absent. | ||
| receiver = spyk(TestReceiver(testAction)) | ||
| every { receiver.goAsync() } returns pendingResult | ||
| } | ||
|
|
||
| @After | ||
| fun tearDown() { | ||
| unmockkAll() | ||
| } | ||
|
|
||
| private fun intentWithCallId(callId: StreamCallId?, action: String = testAction): Intent = | ||
| Intent(action).apply { | ||
| if (callId != null) { | ||
| putExtra(NotificationHandler.INTENT_EXTRA_CALL_CID, callId) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `when stream call id is missing goAsync is not called so the broadcast is not left pending`() { | ||
| receiver.onReceive(context, intentWithCallId(null)) | ||
|
|
||
| // The core of the fix: without a pending result there is nothing to leak. | ||
| verify(exactly = 0) { receiver.goAsync() } | ||
| assertEquals(0, receiver.invocationCount.get()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when action does not match the intent goAsync is not called and handler is not invoked`() { | ||
| receiver.onReceive( | ||
| context, | ||
| intentWithCallId(StreamCallId("default", "123"), action = "some.other.action"), | ||
| ) | ||
|
|
||
| verify(exactly = 0) { receiver.goAsync() } | ||
| assertEquals(0, receiver.invocationCount.get()) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when stream call id is present the broadcast is kept alive and finished`() { | ||
| mockkObject(StreamVideo.Companion) | ||
| val streamVideo = mockk<StreamVideo>(relaxed = true) | ||
| val call = mockk<Call>(relaxed = true) | ||
| every { StreamVideo.instanceOrNull() } returns streamVideo | ||
| every { streamVideo.call(any(), any()) } returns call | ||
|
|
||
| receiver.onReceive(context, intentWithCallId(StreamCallId("default", "123"))) | ||
|
|
||
| verify(exactly = 1) { receiver.goAsync() } | ||
| // The launched coroutine finishes the pending broadcast once the handler completes. | ||
| verify(timeout = 5_000) { pendingResult.finish() } | ||
| } | ||
|
|
||
| @Test | ||
| fun `when stream call id is present the action handler receives the resolved call`() { | ||
| mockkObject(StreamVideo.Companion) | ||
| val streamVideo = mockk<StreamVideo>(relaxed = true) | ||
| val call = mockk<Call>(relaxed = true) | ||
| every { StreamVideo.instanceOrNull() } returns streamVideo | ||
| every { streamVideo.call("default", "123") } returns call | ||
|
|
||
| receiver.onReceive(context, intentWithCallId(StreamCallId("default", "123"))) | ||
|
|
||
| verify(timeout = 5_000) { pendingResult.finish() } | ||
| assertEquals(call, receiver.handledCall) | ||
| } | ||
|
|
||
| @Test | ||
| fun `when stream video is not initialised the broadcast is still finished`() { | ||
| mockkObject(StreamVideo.Companion) | ||
| every { StreamVideo.instanceOrNull() } returns null | ||
|
|
||
| receiver.onReceive(context, intentWithCallId(StreamCallId("default", "123"))) | ||
|
|
||
| verify(exactly = 1) { receiver.goAsync() } | ||
| verify(timeout = 5_000) { pendingResult.finish() } | ||
| assertEquals(0, receiver.invocationCount.get()) | ||
| } | ||
| } | ||
Oops, something went wrong.
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.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use
TestBasefor this unit test.Make
GenericCallActionBroadcastReceiverTestextendTestBase. Keep the Robolectric configuration supported by that base class.As per coding guidelines:
Use TestBase for fast unit tests.🤖 Prompt for AI Agents
Source: Coding guidelines