Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Unverified Commit c332fc52 authored by Beth Thibodeau's avatar Beth Thibodeau Committed by Kevin F. Haggerty
Browse files

Add placeholder when media control title is blank 

When an app posts a media control with no available title, show a
placeholder string with the app name instead

Bug: 274775190
Test: atest MediaDataManagerTest
(cherry picked from commit 070eff91)
(cherry picked from https://googleplex-android-review.googlesource.com/q/commit:0ad65345e93a97edba24349c052f8e001e96ec14)
Merged-In: Ie406c180af48653595e8e222a15b4dda27de2e0e
Change-Id: Ie406c180af48653595e8e222a15b4dda27de2e0e
parent e3723d5b

packages/SystemUI/res/values/strings.xml

+2 −0
Original line number Diff line number Diff line
@@ -2173,6 +2173,8 @@ 
    <string name="controls_media_smartspace_rec_item_description">Play <xliff:g id="song_name" example="Daily mix">%1$s</xliff:g> by <xliff:g id="artist_name" example="Various artists">%2$s</xliff:g> from <xliff:g id="app_label" example="Spotify">%3$s</xliff:g></string>

    <!-- Description for Smartspace recommendation's media item which doesn't have artist info, including information for the media's title and the source app [CHAR LIMIT=NONE]-->

    <string name="controls_media_smartspace_rec_item_no_artist_description">Play <xliff:g id="song_name" example="Daily mix">%1$s</xliff:g> from <xliff:g id="app_label" example="Spotify">%2$s</xliff:g></string>

    <!-- Placeholder title to inform user that an app has posted media controls [CHAR_LIMIT=NONE] -->

    <string name="controls_media_empty_title"><xliff:g id="app_name" example="Foo Music App">%1$s</xliff:g> is running</string>



    <!-- Error message indicating that a control timed out while waiting for an update [CHAR_LIMIT=30] -->

    <string name="controls_error_timeout">Inactive, check app</string>

packages/SystemUI/src/com/android/systemui/media/MediaDataManager.kt

+7 −3
Original line number Diff line number Diff line
@@ -580,12 +580,16 @@ class MediaDataManager( 


        // Song name

        var song: CharSequence? = metadata?.getString(MediaMetadata.METADATA_KEY_DISPLAY_TITLE)

        if (song == null) {

            song = metadata?.getString(MediaMetadata.METADATA_KEY_TITLE)

        if (song.isNullOrBlank()) {

            song = metadata.getString(MediaMetadata.METADATA_KEY_TITLE)

        }

        if (song == null) {

        if (song.isNullOrBlank()) {

            song = HybridGroupManager.resolveTitle(notif)

        }

        if (song.isNullOrBlank()) {

            // For apps that don't include a title, add a placeholder

            song = context.getString(R.string.controls_media_empty_title, app)

        }



        // Artist name

        var artist: CharSequence? = metadata?.getString(MediaMetadata.METADATA_KEY_ARTIST)

packages/SystemUI/tests/src/com/android/systemui/media/MediaDataManagerTest.kt

+93 −1
Original line number Diff line number Diff line
@@ -17,6 +17,7 @@ import android.service.notification.StatusBarNotification 
import android.testing.AndroidTestingRunner

import android.testing.TestableLooper.RunWithLooper

import androidx.test.filters.SmallTest

import com.android.systemui.R

import com.android.systemui.SysuiTestCase

import com.android.systemui.broadcast.BroadcastDispatcher

import com.android.systemui.dump.DumpManager
@@ -49,9 +50,11 @@ private const val KEY = "KEY" 
private const val KEY_2 = "KEY_2"

private const val KEY_MEDIA_SMARTSPACE = "MEDIA_SMARTSPACE_ID"

private const val PACKAGE_NAME = "com.android.systemui"

private const val APP_NAME = "SystemUI"

private const val APP_NAME = "com.android.systemui.tests"

private const val SESSION_ARTIST = "artist"

private const val SESSION_TITLE = "title"

private const val SESSION_BLANK_TITLE = " "

private const val SESSION_EMPTY_TITLE = ""

private const val USER_ID = 0

private val DISMISS_INTENT = Intent().apply { action = "dismiss" }
@@ -262,6 +265,95 @@ class MediaDataManagerTest : SysuiTestCase() { 
        verify(listener).onMediaDataRemoved(eq(KEY))

    }



    @Test

    fun testOnNotificationAdded_emptyTitle_hasPlaceholder() {

        // When the manager has a notification with an empty title

        val listener = mock(MediaDataManager.Listener::class.java)

        mediaDataManager.addListener(listener)

        whenever(controller.metadata)

            .thenReturn(

                metadataBuilder

                    .putString(MediaMetadata.METADATA_KEY_TITLE, SESSION_EMPTY_TITLE)

                    .build()

            )

        mediaDataManager.onNotificationAdded(KEY, mediaNotification)



        // Then a media control is created with a placeholder title string

        assertThat(backgroundExecutor.runAllReady()).isEqualTo(1)

        assertThat(foregroundExecutor.runAllReady()).isEqualTo(1)

        verify(listener)

            .onMediaDataLoaded(

                eq(KEY),

                eq(null),

                capture(mediaDataCaptor)

            )

        val placeholderTitle = context.getString(R.string.controls_media_empty_title, APP_NAME)

        assertThat(mediaDataCaptor.value.song).isEqualTo(placeholderTitle)

    }



    @Test

    fun testOnNotificationAdded_blankTitle_hasPlaceholder() {

        // GIVEN that the manager has a notification with a blank title

        val listener = mock(MediaDataManager.Listener::class.java)

        mediaDataManager.addListener(listener)

        whenever(controller.metadata)

            .thenReturn(

                metadataBuilder

                    .putString(MediaMetadata.METADATA_KEY_TITLE, SESSION_BLANK_TITLE)

                    .build()

            )

        mediaDataManager.onNotificationAdded(KEY, mediaNotification)



        // Then a media control is created with a placeholder title string

        assertThat(backgroundExecutor.runAllReady()).isEqualTo(1)

        assertThat(foregroundExecutor.runAllReady()).isEqualTo(1)

        verify(listener)

            .onMediaDataLoaded(

                eq(KEY),

                eq(null),

                capture(mediaDataCaptor)

            )

        val placeholderTitle = context.getString(R.string.controls_media_empty_title, APP_NAME)

        assertThat(mediaDataCaptor.value.song).isEqualTo(placeholderTitle)

    }



    @Test

    fun testOnNotificationAdded_emptyMetadata_usesNotificationTitle() {

        // When the app sets the metadata title fields to empty strings, but does include a

        // non-blank notification title

        val listener = mock(MediaDataManager.Listener::class.java)

        mediaDataManager.addListener(listener)

        whenever(controller.metadata)

            .thenReturn(

                metadataBuilder

                    .putString(MediaMetadata.METADATA_KEY_TITLE, SESSION_EMPTY_TITLE)

                    .putString(MediaMetadata.METADATA_KEY_DISPLAY_TITLE, SESSION_EMPTY_TITLE)

                    .build()

            )

        mediaNotification =

            SbnBuilder().run {

                setPkg(PACKAGE_NAME)

                modifyNotification(context).also {

                    it.setSmallIcon(android.R.drawable.ic_media_pause)

                    it.setContentTitle(SESSION_TITLE)

                    it.setStyle(MediaStyle().apply { setMediaSession(session.sessionToken) })

                }

                build()

            }

        mediaDataManager.onNotificationAdded(KEY, mediaNotification)



        // Then the media control is added using the notification's title

        assertThat(backgroundExecutor.runAllReady()).isEqualTo(1)

        assertThat(foregroundExecutor.runAllReady()).isEqualTo(1)

        verify(listener)

            .onMediaDataLoaded(

                eq(KEY),

                eq(null),

                capture(mediaDataCaptor)

            )

        assertThat(mediaDataCaptor.value.song).isEqualTo(SESSION_TITLE)

    }



    @Test

    fun testOnNotificationRemoved_withResumption() {

        // GIVEN that the manager has a notification with a resume action