Better player error handling

app/src/main/java/org/schabi/newpipe/error/EnsureExceptionSerializable.java

@@ -0,0 +1,103 @@
+package org.schabi.newpipe.error;
+
+import android.util.Log;
+
+import androidx.annotation.NonNull;
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.ObjectOutputStream;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Ensures that a Exception is serializable.
+ * This is
+ */
+public final class EnsureExceptionSerializable {
+    private static final String TAG = "EnsureExSerializable";
+
+    private EnsureExceptionSerializable() {
+        // No instance
+    }
+
+    /**
+     * Ensures that an exception is serializable.
+     * <br/>
+     * If that is not the case a {@link WorkaroundNotSerializableException} is created.
+     *
+     * @param exception
+     * @return if an exception is not serializable a new {@link WorkaroundNotSerializableException}
+     * otherwise the exception from the parameter
+     */
+    public static Exception ensureSerializable(@NonNull final Exception exception) {
+        return checkIfSerializable(exception)
+                ? exception
+                : WorkaroundNotSerializableException.create(exception);
+    }
+
+    public static boolean checkIfSerializable(@NonNull final Exception exception) {
+        try {
+            // Check by creating a new ObjectOutputStream which does the serialization
+            try (ByteArrayOutputStream bos = new ByteArrayOutputStream();
+                 ObjectOutputStream oos = new ObjectOutputStream(bos)
+            ) {
+                oos.writeObject(exception);
+                oos.flush();
+
+                bos.toByteArray();
+            }
+
+            return true;
+        } catch (final IOException ex) {
+            Log.d(TAG, "Exception is not serializable", ex);
+            return false;
+        }
+    }
+
+    public static class WorkaroundNotSerializableException extends Exception {
+        protected WorkaroundNotSerializableException(
+                final Throwable notSerializableException,
+                final Throwable cause) {
+            super(notSerializableException.toString(), cause);
+            setStackTrace(notSerializableException.getStackTrace());
+        }
+
+        protected WorkaroundNotSerializableException(final Throwable notSerializableException) {
+            super(notSerializableException.toString());
+            setStackTrace(notSerializableException.getStackTrace());
+        }
+
+        public static WorkaroundNotSerializableException create(
+                @NonNull final Exception notSerializableException
+        ) {
+            // Build a list of the exception + all causes
+            final List<Throwable> throwableList = new ArrayList<>();
+
+            int pos = 0;
+            Throwable throwableToProcess = notSerializableException;
+
+            while (throwableToProcess != null) {
+                throwableList.add(throwableToProcess);
+
+                pos++;
+                throwableToProcess = throwableToProcess.getCause();
+            }
+
+            // Reverse list so that it starts with the last one
+            Collections.reverse(throwableList);
+
+            // Build exception stack
+            WorkaroundNotSerializableException cause = null;
+            for (final Throwable t : throwableList) {
+                cause = cause == null
+                        ? new WorkaroundNotSerializableException(t)
+                        : new WorkaroundNotSerializableException(t, cause);
+            }
+
+            return cause;
+        }
+
+    }
+}

app/src/main/java/org/schabi/newpipe/error/ErrorActivity.java

@@ -77,6 +77,16 @@ public class ErrorActivity extends AppCompatActivity {
 
     private ActivityErrorBinding activityErrorBinding;
 
+    /**
+     * Reports a new error by starting a new activity.
+     * <br/>
+     * Ensure that the data within errorInfo is serializable otherwise
+     * an exception will be thrown!<br/>
+     * {@link EnsureExceptionSerializable} might help.
+     *
+     * @param context
+     * @param errorInfo
+     */
     public static void reportError(final Context context, final ErrorInfo errorInfo) {
         final Intent intent = new Intent(context, ErrorActivity.class);
         intent.putExtra(ERROR_INFO, errorInfo);

app/src/main/java/org/schabi/newpipe/fragments/detail/VideoDetailFragment.java

@@ -594,6 +594,11 @@ private void toggleTitleAndSecondaryControls() {
     // Init
     //////////////////////////////////////////////////////////////////////////*/
 
+    @Override
+    public void onViewCreated(@NonNull final View rootView, final Bundle savedInstanceState) {
+        super.onViewCreated(rootView, savedInstanceState);
+    }
+
     @Override // called from onViewCreated in {@link BaseFragment#onViewCreated}
     protected void initViews(final View rootView, final Bundle savedInstanceState) {
         super.initViews(rootView, savedInstanceState);
@@ -604,6 +609,18 @@ protected void initViews(final View rootView, final Bundle savedInstanceState) {
 
         binding.detailThumbnailRootLayout.requestFocus();
 
+        binding.detailControlsPlayWithKodi.setVisibility(
+                KoreUtils.shouldShowPlayWithKodi(requireContext(), serviceId)
+                        ? View.VISIBLE
+                        : View.GONE
+        );
+        binding.detailControlsCrashThePlayer.setVisibility(
+                DEBUG && PreferenceManager.getDefaultSharedPreferences(getContext())
+                        .getBoolean(getString(R.string.show_crash_the_player_key), false)
+                        ? View.VISIBLE
+                        : View.GONE
+        );
+
         if (DeviceUtils.isTv(getContext())) {
             // remove ripple effects from detail controls
             final int transparent = ContextCompat.getColor(requireContext(),
@@ -638,8 +655,11 @@ protected void initListeners() {
         binding.detailControlsShare.setOnClickListener(this);
         binding.detailControlsOpenInBrowser.setOnClickListener(this);
         binding.detailControlsPlayWithKodi.setOnClickListener(this);
-        binding.detailControlsPlayWithKodi.setVisibility(KoreUtils.shouldShowPlayWithKodi(
-                requireContext(), serviceId) ? View.VISIBLE : View.GONE);
+        if (DEBUG) {
+            binding.detailControlsCrashThePlayer.setOnClickListener(
+                    v -> VideoDetailPlayerCrasher.onCrashThePlayer(this.player, getLayoutInflater())
+            );
+        }
 
         binding.overlayThumbnail.setOnClickListener(this);
         binding.overlayThumbnail.setOnLongClickListener(this);

app/src/main/java/org/schabi/newpipe/fragments/detail/VideoDetailPlayerCrasher.java

@@ -0,0 +1,159 @@
+package org.schabi.newpipe.fragments.detail;
+
+import android.content.Context;
+import android.util.Log;
+import android.view.ContextThemeWrapper;
+import android.view.LayoutInflater;
+import android.view.ViewGroup;
+import android.widget.RadioButton;
+import android.widget.RadioGroup;
+import android.widget.Toast;
+
+import androidx.annotation.NonNull;
+import androidx.appcompat.app.AlertDialog;
+
+import com.google.android.exoplayer2.C;
+import com.google.android.exoplayer2.ExoPlaybackException;
+
+import org.schabi.newpipe.R;
+import org.schabi.newpipe.databinding.ListRadioIconItemBinding;
+import org.schabi.newpipe.databinding.SingleChoiceDialogViewBinding;
+import org.schabi.newpipe.player.Player;
+import org.schabi.newpipe.util.ThemeHelper;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.function.Supplier;
+
+/**
+ * Outsourced logic for crashing the player in the {@link VideoDetailFragment}.
+ */
+public final class VideoDetailPlayerCrasher {
+
+    // This has to be <= 23 chars on devices running Android 7 or lower (API <= 25)
+    // or it fails with an IllegalArgumentException
+    // https://stackoverflow.com/a/54744028
+    private static final String TAG = "VideoDetPlayerCrasher";
+
+    private static final Map<String, Supplier<ExoPlaybackException>> AVAILABLE_EXCEPTION_TYPES =
+            getExceptionTypes();
+
+    private VideoDetailPlayerCrasher() {
+        // No impls
+    }
+
+    private static Map<String, Supplier<ExoPlaybackException>> getExceptionTypes() {
+        final String defaultMsg = "Dummy";
+        final Map<String, Supplier<ExoPlaybackException>> exceptionTypes = new LinkedHashMap<>();
+        exceptionTypes.put(
+                "Source",
+                () -> ExoPlaybackException.createForSource(
+                        new IOException(defaultMsg)
+                )
+        );
+        exceptionTypes.put(
+                "Renderer",
+                () -> ExoPlaybackException.createForRenderer(
+                        new Exception(defaultMsg),
+                        "Dummy renderer",
+                        0,
+                        null,
+                        C.FORMAT_HANDLED
+                )
+        );
+        exceptionTypes.put(
+                "Unexpected",
+                () -> ExoPlaybackException.createForUnexpected(
+                        new RuntimeException(defaultMsg)
+                )
+        );
+        exceptionTypes.put(
+                "Remote",
+                () -> ExoPlaybackException.createForRemote(defaultMsg)
+        );
+
+        return Collections.unmodifiableMap(exceptionTypes);
+    }
+
+    private static Context getThemeWrapperContext(final Context context) {
+        return new ContextThemeWrapper(
+                context,
+                ThemeHelper.isLightThemeSelected(context)
+                        ? R.style.LightTheme
+                        : R.style.DarkTheme);
+    }
+
+    public static void onCrashThePlayer(final Player player, final LayoutInflater layoutInflater) {
+        final Context context = player.getContext();
+        if (!isPlayerAvailable(player)) {
+            Log.d(TAG, "Player is not available");
+            Toast.makeText(context, "Player is not available", Toast.LENGTH_SHORT)
+                    .show();
+
+            return;
+        }
+
+        // -- Build the dialog/UI --
+
+        final Context themeWrapperContext = getThemeWrapperContext(context);
+
+        final LayoutInflater inflater = LayoutInflater.from(themeWrapperContext);
+        final RadioGroup radioGroup = SingleChoiceDialogViewBinding.inflate(layoutInflater)
+                .list;
+
+        final AlertDialog alertDialog = new AlertDialog.Builder(getThemeWrapperContext(context))
+                .setTitle("Choose an exception")
+                .setView(radioGroup)
+                .setCancelable(true)
+                .setNegativeButton(R.string.cancel, null)
+                .create();
+
+        for (final Map.Entry<String, Supplier<ExoPlaybackException>> entry
+                : AVAILABLE_EXCEPTION_TYPES.entrySet()) {
+            final RadioButton radioButton = ListRadioIconItemBinding.inflate(inflater).getRoot();
+            radioButton.setText(entry.getKey());
+            radioButton.setChecked(false);
+            radioButton.setLayoutParams(
+                    new RadioGroup.LayoutParams(
+                            ViewGroup.LayoutParams.MATCH_PARENT,
+                            ViewGroup.LayoutParams.WRAP_CONTENT
+                    )
+            );
+            radioButton.setOnClickListener(v -> {
+                tryCrashPlayerWith(player, entry.getValue().get());
+                if (alertDialog != null) {
+                    alertDialog.cancel();
+                }
+            });
+            radioGroup.addView(radioButton);
+        }
+
+        alertDialog.show();
+    }
+
+    /**
+     * Note that this method does not crash the underlying exoplayer directly (it's not possible).
+     * It simply supplies a Exception to {@link Player#onPlayerError(ExoPlaybackException)}.
+     * @param player
+     * @param exception
+     */
+    private static void tryCrashPlayerWith(
+            @NonNull final Player player,
+            @NonNull final ExoPlaybackException exception
+    ) {
+        Log.d(TAG, "Crashing the player using player.onPlayerError(ex)");
+        try {
+            player.onPlayerError(exception);
+        } catch (final Exception exPlayer) {
+            Log.e(TAG,
+                    "Run into an exception while crashing the player:",
+                    exPlayer);
+        }
+    }
+
+    private static boolean isPlayerAvailable(final Player player) {
+        return player != null;
+    }
+}