NAVAND-1025: fix the crash in MapboxVoiceInstructionsPlayer

[zeac]

Description

This PR fixes the possible crash. The reproduce steps are unknown, I guess there is a race between calls to clear and focus callback calls.

[codecov]

Codecov Report

Merging #6760 (3c2fa0c) into main (0077240) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##               main    #6760   +/-   ##
=========================================
  Coverage     72.51%   72.51%           
- Complexity     5540     5541    +1     
=========================================
  Files           777      777           
  Lines         30038    30039    +1     
  Branches       3546     3547    +1     
=========================================
+ Hits          21782    21783    +1     
  Misses         6832     6832           
  Partials       1424     1424           

Impacted Files	Coverage Δ
...tion/ui/voice/api/MapboxVoiceInstructionsPlayer.kt	79.12% <100.00%> (+0.23%)	⬆️

[dzinad]

Can you add the following test to MapboxVoiceInstructionsPlayerTest:

    @Test
    fun `play is done after clear`() {
        val anyLanguage = Locale.US.language
        val mockedAnnouncement: SpeechAnnouncement = mockk(relaxed = true)
        val mapboxVoiceInstructionsPlayer =
            MapboxVoiceInstructionsPlayer(
                aMockedContext,
                anyLanguage,
                mockedPlayerOptions
            )
        val mockedPlay: SpeechAnnouncement = mockedAnnouncement
        val voiceInstructionsPlayerConsumer =
            mockk<MapboxNavigationConsumer<SpeechAnnouncement>>(relaxed = true)

        val requestSlotCallback = slot<AudioFocusRequestCallback>()
        every {
            mockedAudioFocusDelegate.requestFocus(any(), capture(requestSlotCallback))
        } just Runs
        mapboxVoiceInstructionsPlayer.play(mockedPlay, voiceInstructionsPlayerConsumer)
        mapboxVoiceInstructionsPlayer.clear()

        requestSlotCallback.captured.invoke(true)

        verify(exactly = 0) { voiceInstructionsPlayerConsumer.accept(any()) }
    }

[zeac]

Sure, done.

[dzinad]

Thanks. I'd wait for Tomasz though, he's the one who's been working with voice instructions lately.

[dzinad]

Oh, we's out until after the holidays, let's merge.

[dzinad]

We should also add a changelog entry. Sth like:

- Fixed a rare `java.lang.NullPointerException: Attempt to read from field 'en.b dn.m.a' on a null object reference` crash in `PlayCallback.getAnnouncement`. [#6760](https://github.com/mapbox/mapbox-navigation-android/pull/6760)

to mapbox-navigation-android/CHANGELOG.md.

[Guardiola31337]

@zeac noting that Ktlint failed 👀

> Task :libnavui-voice:ktlint
/root/code/libnavui-voice/src/test/java/com/******/navigation/ui/voice/api/MapboxVoiceInstructionsPlayerTest.kt:662:1: Needless blank line(s) (no-consecutive-blank-lines)

> Task :libnavui-voice:ktlint FAILED

[Guardiola31337]

@zeac it seems we're good merging here 🚀

cc @dzinad

[Guardiola31337]

@zeac

it seems we're good merging here 🚀

I'd wait for Tomasz though, he's the one who's been working with voice instructions lately.

Oh well, maybe not #6760 (comment) wdyt @dzinad?

cc @tomaszrybakiewicz