Don't override playback exception when creating the playback state

#cherrypick

PiperOrigin-RevId: 785793329

Author: marcbaechinger

RELEASENOTES.md

@@ -71,6 +71,9 @@
     *   Change the default value for
         `MediaLibrarySession.Builder.setLibraryErrorReplicationMode` to non
         fatal.
+    *   Fix a bug that causes a player's first playback error to be incorrectly
+        treated as a persistent custom exception. This prevents the application
+        from recovering.
 *   UI:
     *   Add `ProgressStateWithTickInterval` class and the corresponding
         `rememberProgressStateWithTickInterval` Composable to

libraries/session/src/main/java/androidx/media3/session/MediaSessionLegacyStub.java

@@ -148,7 +148,7 @@
   private ImmutableList<CommandButton> mediaButtonPreferences;
   private SessionCommands availableSessionCommands;
   private Player.Commands availablePlayerCommands;
-  @Nullable private PlaybackException playbackException;
+  @Nullable private PlaybackException customPlaybackException;
   @Nullable private Player.Commands playerCommandsForErrorState;
 
   @SuppressWarnings({
@@ -269,7 +269,7 @@ public MediaSessionLegacyStub(
    */
   public void setAvailableCommands(
       SessionCommands sessionCommands, Player.Commands playerCommands) {
-    if (playbackException != null) {
+    if (customPlaybackException != null) {
       return;
     }
     boolean commandGetTimelineChanged =
@@ -361,7 +361,7 @@ public void setPlatformMediaButtonPreferences(
   }
 
   /**
-   * Sets or clears an playback exception override for the platform session.
+   * Sets or clears a playback exception override for the platform session.
    *
    * @param playbackException The {@link PlaybackException} or null.
    * @param playerCommandsForErrorState The available {@link Player.Commands} while the exception
@@ -373,7 +373,7 @@ public void setPlaybackException(
     checkArgument(
         (playbackException == null && playerCommandsForErrorState == null)
             || (playbackException != null && playerCommandsForErrorState != null));
-    this.playbackException = playbackException;
+    customPlaybackException = playbackException;
     this.playerCommandsForErrorState = playerCommandsForErrorState;
     if (playbackException != null) {
       updateLegacySessionPlaybackState(sessionImpl.getPlayerWrapper());
@@ -1292,7 +1292,7 @@ public ControllerLegacyCbForBroadcast() {
      * @return True if updates should be skipped.
      */
     public boolean skipLegacySessionPlaybackStateUpdates() {
-      return playbackException != null;
+      return customPlaybackException != null;
     }
 
     @Override
@@ -1765,7 +1765,7 @@ private static ComponentName getServiceComponentByAction(Context context, String
 
   private PlaybackStateCompat createPlaybackStateCompat(PlayerWrapper player) {
     LegacyError legacyError = this.legacyError;
-    if (playbackException == null && legacyError != null && legacyError.isFatal) {
+    if (customPlaybackException == null && legacyError != null && legacyError.isFatal) {
       // A fatal legacy error automatically set by Media3 upon a calling
       // MediaLibrarySession.Callback according to the configured LibraryErrorReplicationMode.
       Bundle extras = new Bundle(legacyError.extras);
@@ -1783,17 +1783,17 @@ private PlaybackStateCompat createPlaybackStateCompat(PlayerWrapper player) {
           .setExtras(legacyError.extras)
           .build();
     }
-    if (playbackException == null) {
-      // The actual error from the player, if any.
-      playbackException = player.getPlayerError();
-    }
+    // The custom error from the session if present, or the actual error from the player, if any.
+    @Nullable
+    PlaybackException publicPlaybackException =
+        customPlaybackException != null ? customPlaybackException : player.getPlayerError();
     boolean canReadPositions =
         player.isCommandAvailable(Player.COMMAND_GET_CURRENT_MEDIA_ITEM)
             && !player.isCurrentMediaItemLive();
     boolean shouldShowPlayButton =
-        playbackException != null || Util.shouldShowPlayButton(player, playIfSuppressed);
+        publicPlaybackException != null || Util.shouldShowPlayButton(player, playIfSuppressed);
     int state =
-        playbackException != null
+        publicPlaybackException != null
             ? PlaybackStateCompat.STATE_ERROR
             : LegacyConversions.convertToPlaybackStateCompatState(player, shouldShowPlayButton);
     // Always advertise ACTION_SET_RATING.
@@ -1824,8 +1824,9 @@ private PlaybackStateCompat createPlaybackStateCompat(PlayerWrapper player) {
             : MediaSessionCompat.QueueItem.UNKNOWN_ID;
     float playbackSpeed = player.getPlaybackParameters().speed;
     float sessionPlaybackSpeed = player.isPlaying() && canReadPositions ? playbackSpeed : 0f;
-    Bundle extras = playbackException != null ? new Bundle(playbackException.extras) : new Bundle();
-    if (playbackException == null && legacyError != null) {
+    Bundle extras =
+        publicPlaybackException != null ? new Bundle(publicPlaybackException.extras) : new Bundle();
+    if (publicPlaybackException == null && legacyError != null) {
       extras.putAll(legacyError.extras);
     }
     extras.putAll(legacyExtras);
@@ -1879,10 +1880,10 @@ private PlaybackStateCompat createPlaybackStateCompat(PlayerWrapper player) {
                 .build());
       }
     }
-    if (playbackException != null) {
+    if (publicPlaybackException != null) {
       builder.setErrorMessage(
-          LegacyConversions.convertToLegacyErrorCode(playbackException),
-          playbackException.getMessage());
+          LegacyConversions.convertToLegacyErrorCode(publicPlaybackException),
+          publicPlaybackException.getMessage());
     } else if (legacyError != null) {
       builder.setErrorMessage(legacyError.code, legacyError.message);
     }

libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaControllerCompatCallbackWithMediaSessionTest.java

@@ -239,7 +239,7 @@ public void onSessionReady() {
   }
 
   @Test
-  public void playerError_notified() throws Exception {
+  public void playerError_errorEmittedAndResolved_correctPlaybackStatesReceived() throws Exception {
     Bundle extras = new Bundle();
     extras.putString("key-1", "value-1");
     PlaybackException testPlayerError =
@@ -248,27 +248,49 @@ public void playerError_notified() throws Exception {
             /* cause= */ null,
             PlaybackException.ERROR_CODE_AUTHENTICATION_EXPIRED,
             extras);
-
     CountDownLatch latch = new CountDownLatch(1);
     AtomicReference<PlaybackStateCompat> playbackStateCompatRef = new AtomicReference<>();
-    MediaControllerCompat.Callback callback =
+    MediaControllerCompat.Callback errorCallback =
         new MediaControllerCompat.Callback() {
           @Override
           public void onPlaybackStateChanged(PlaybackStateCompat state) {
             playbackStateCompatRef.set(state);
             latch.countDown();
           }
         };
-    controllerCompat.registerCallback(callback, handler);
+    controllerCompat.registerCallback(errorCallback, handler);
 
     session.getMockPlayer().notifyPlayerError(testPlayerError);
+
     assertThat(latch.await(TIMEOUT_MS, MILLISECONDS)).isTrue();
-    PlaybackStateCompat state = playbackStateCompatRef.get();
-    assertThat(state.getState()).isEqualTo(PlaybackStateCompat.STATE_ERROR);
-    assertThat(state.getErrorCode())
+    PlaybackStateCompat errorState = playbackStateCompatRef.get();
+    assertThat(errorState.getState()).isEqualTo(PlaybackStateCompat.STATE_ERROR);
+    assertThat(errorState.getErrorCode())
         .isEqualTo(PlaybackStateCompat.ERROR_CODE_AUTHENTICATION_EXPIRED);
-    assertThat(state.getErrorMessage().toString()).isEqualTo(testPlayerError.getMessage());
-    assertThat(state.getExtras().getString("key-1")).isEqualTo("value-1");
+    assertThat(errorState.getErrorMessage().toString()).isEqualTo(testPlayerError.getMessage());
+    assertThat(errorState.getExtras().getString("key-1")).isEqualTo("value-1");
+    // Resolve the exception and assert the playback state transition
+    controllerCompat.unregisterCallback(errorCallback);
+    CountDownLatch bufferingLatch = new CountDownLatch(1);
+    AtomicReference<PlaybackStateCompat> bufferingPlaybackStateCompatRef = new AtomicReference<>();
+    MediaControllerCompat.Callback bufferingCallback =
+        new MediaControllerCompat.Callback() {
+          @Override
+          public void onPlaybackStateChanged(PlaybackStateCompat state) {
+            bufferingPlaybackStateCompatRef.set(state);
+            bufferingLatch.countDown();
+          }
+        };
+    controllerCompat.registerCallback(bufferingCallback, handler);
+
+    session.getMockPlayer().notifyPlaybackStateChanged(Player.STATE_BUFFERING);
+
+    assertThat(bufferingLatch.await(TIMEOUT_MS, MILLISECONDS)).isTrue();
+    PlaybackStateCompat bufferingState = bufferingPlaybackStateCompatRef.get();
+    assertThat(bufferingState.getState()).isEqualTo(PlaybackStateCompat.STATE_PAUSED);
+    assertThat(bufferingState.getErrorCode()).isEqualTo(0);
+    assertThat(bufferingState.getErrorMessage()).isNull();
+    assertThat(bufferingState.getExtras().getString("key-1")).isNull();
   }
 
   @SuppressWarnings("deprecation") // Using PlaybackStateCompat

libraries/test_session_current/src/main/java/androidx/media3/session/MockPlayer.java

@@ -633,6 +633,9 @@ public void notifyPlaybackStateChanged(@State int playbackState) {
       return;
     }
     boolean wasPlaying = isPlaying();
+    if (playbackState != STATE_IDLE) {
+      this.playerError = null;
+    }
     this.playbackState = playbackState;
     boolean isPlaying = isPlaying();
     for (Listener listener : listeners) {