Add inflation error manager (8ecb3e31) · Commits · e / os / android_frameworks_base

packages/SystemUI/src/com/android/systemui/statusbar/notification/collection/ListDumper.java

+0 −4

Original line number	Diff line number	Diff line
		@@ -151,10 +151,6 @@ public class ListDumper {
		.append(" ");
		}

		if (notifEntry.hasInflationError()) {
		rksb.append("(!)hasInflationError ");
		}

		if (notifEntry.getDismissState() != NOT_DISMISSED) {
		rksb.append("dismissState=")
		.append(notifEntry.getDismissState())

packages/SystemUI/src/com/android/systemui/statusbar/notification/collection/NotifInflaterImpl.java

+7 −19

Original line number	Diff line number	Diff line
		@@ -18,9 +18,7 @@ package com.android.systemui.statusbar.notification.collection;

		import static android.service.notification.NotificationStats.DISMISS_SENTIMENT_NEUTRAL;

		import android.os.RemoteException;
		import android.service.notification.NotificationStats;
		import android.service.notification.StatusBarNotification;

		import com.android.internal.statusbar.IStatusBarService;
		import com.android.internal.statusbar.NotificationVisibility;
		@@ -29,6 +27,7 @@ import com.android.systemui.statusbar.notification.collection.inflation.NotifInf
		import com.android.systemui.statusbar.notification.collection.inflation.NotificationRowBinderImpl;
		import com.android.systemui.statusbar.notification.collection.notifcollection.DismissedByUserStats;
		import com.android.systemui.statusbar.notification.logging.NotificationLogger;
		import com.android.systemui.statusbar.notification.row.NotifInflationErrorManager;
		import com.android.systemui.statusbar.notification.row.NotificationContentInflater;

		import javax.inject.Inject;
		@@ -44,6 +43,7 @@ public class NotifInflaterImpl implements NotifInflater {

		private final IStatusBarService mStatusBarService;
		private final NotifCollection mNotifCollection;
		private final NotifInflationErrorManager mNotifErrorManager;

		private NotificationRowBinderImpl mNotificationRowBinder;
		private InflationCallback mExternalInflationCallback;
		@@ -51,9 +51,11 @@ public class NotifInflaterImpl implements NotifInflater {
		@Inject
		public NotifInflaterImpl(
		IStatusBarService statusBarService,
		NotifCollection notifCollection) {
		NotifCollection notifCollection,
		NotifInflationErrorManager errorManager) {
		mStatusBarService = statusBarService;
		mNotifCollection = notifCollection;
		mNotifErrorManager = errorManager;
		}

		/**
		@@ -81,7 +83,6 @@ public class NotifInflaterImpl implements NotifInflater {
		@Override
		public void inflateViews(NotificationEntry entry) {
		try {
		entry.setHasInflationError(false);
		requireBinder().inflateViews(entry, getDismissCallback(entry));
		} catch (InflationException e) {
		// logged in mInflationCallback.handleInflationException
		@@ -131,25 +132,12 @@ public class NotifInflaterImpl implements NotifInflater {
		public void handleInflationException(
		NotificationEntry entry,
		Exception e) {
		entry.setHasInflationError(true);
		try {
		final StatusBarNotification sbn = entry.getSbn();
		// report notification inflation errors back up
		// to notification delegates
		mStatusBarService.onNotificationError(
		sbn.getPackageName(),
		sbn.getTag(),
		sbn.getId(),
		sbn.getUid(),
		sbn.getInitialPid(),
		e.getMessage(),
		sbn.getUserId());
		} catch (RemoteException ex) {
		}
		mNotifErrorManager.setInflationError(entry, e);
		}

		@Override
		public void onAsyncInflationFinished(NotificationEntry entry) {
		mNotifErrorManager.clearInflationError(entry);
		if (mExternalInflationCallback != null) {
		mExternalInflationCallback.onInflationFinished(entry);
		}

packages/SystemUI/src/com/android/systemui/statusbar/notification/collection/NotificationEntry.java

+0 −20

Original line number	Diff line number	Diff line
		@@ -122,9 +122,6 @@ public final class NotificationEntry extends ListEntry {
		*/
		@CancellationReason int mCancellationReason = REASON_NOT_CANCELED;

		/** @see #hasInflationError() */
		private boolean mHasInflationError;

		/** @see #getDismissState() */
		@NonNull private DismissState mDismissState = DismissState.NOT_DISMISSED;

		@@ -273,23 +270,6 @@ public final class NotificationEntry extends ListEntry {
		* Bookkeeping getters and setters
		*/

		/**
		* Whether this notification had an error when attempting to inflate. This is only used in
		* the NewNotifPipeline
		*/
		public boolean hasInflationError() {
		return mHasInflationError;
		}

		/**
		* Set whether the notification has an error while inflating.
		*
		* TODO: Move this into an inflation error manager class.
		*/
		public void setHasInflationError(boolean hasError) {
		mHasInflationError = hasError;
		}

		/**
		* Set if the user has dismissed this notif but we haven't yet heard back from system server to
		* confirm the dismissal.

packages/SystemUI/src/com/android/systemui/statusbar/notification/collection/coordinator/PreparationCoordinator.java

+44 −4

Original line number	Diff line number	Diff line
		@@ -16,12 +16,18 @@

		package com.android.systemui.statusbar.notification.collection.coordinator;

		import android.os.RemoteException;
		import android.service.notification.StatusBarNotification;

		import com.android.internal.statusbar.IStatusBarService;
		import com.android.systemui.statusbar.notification.collection.NotifInflaterImpl;
		import com.android.systemui.statusbar.notification.collection.NotifPipeline;
		import com.android.systemui.statusbar.notification.collection.NotificationEntry;
		import com.android.systemui.statusbar.notification.collection.ShadeListBuilder;
		import com.android.systemui.statusbar.notification.collection.inflation.NotifInflater;
		import com.android.systemui.statusbar.notification.collection.listbuilder.pluggable.NotifFilter;
		import com.android.systemui.statusbar.notification.collection.notifcollection.NotifCollectionListener;
		import com.android.systemui.statusbar.notification.row.NotifInflationErrorManager;

		import java.util.ArrayList;
		import java.util.List;
		@@ -34,7 +40,7 @@ import javax.inject.Singleton;
		* Aborts inflation when a notification is removed.
		*
		* If a notification is not done inflating, this coordinator will filter the notification out
		* from the NotifListBuilder.
		* from the {@link ShadeListBuilder}.
		*/
		@Singleton
		public class PreparationCoordinator implements Coordinator {
		@@ -42,15 +48,22 @@ public class PreparationCoordinator implements Coordinator {

		private final PreparationCoordinatorLogger mLogger;
		private final NotifInflater mNotifInflater;
		private final NotifInflationErrorManager mNotifErrorManager;
		private final List<NotificationEntry> mPendingNotifications = new ArrayList<>();
		private final IStatusBarService mStatusBarService;

		@Inject
		public PreparationCoordinator(
		PreparationCoordinatorLogger logger,
		NotifInflaterImpl notifInflater) {
		NotifInflaterImpl notifInflater,
		NotifInflationErrorManager errorManager,
		IStatusBarService service) {
		mLogger = logger;
		mNotifInflater = notifInflater;
		mNotifInflater.setInflationCallback(mInflationCallback);
		mNotifErrorManager = errorManager;
		mNotifErrorManager.addInflationErrorListener(mInflationErrorListener);
		mStatusBarService = service;
		}

		@Override
		@@ -84,8 +97,7 @@ public class PreparationCoordinator implements Coordinator {
		*/
		@Override
		public boolean shouldFilterOut(NotificationEntry entry, long now) {
		if (entry.hasInflationError()) {
		mPendingNotifications.remove(entry);
		if (mNotifErrorManager.hasInflationError(entry)) {
		return true;
		}
		return false;
		@@ -112,6 +124,34 @@ public class PreparationCoordinator implements Coordinator {
		}
		};

		private final NotifInflationErrorManager.NotifInflationErrorListener mInflationErrorListener =
		new NotifInflationErrorManager.NotifInflationErrorListener() {
		@Override
		public void onNotifInflationError(NotificationEntry entry, Exception e) {
		mPendingNotifications.remove(entry);
		try {
		final StatusBarNotification sbn = entry.getSbn();
		// report notification inflation errors back up
		// to notification delegates
		mStatusBarService.onNotificationError(
		sbn.getPackageName(),
		sbn.getTag(),
		sbn.getId(),
		sbn.getUid(),
		sbn.getInitialPid(),
		e.getMessage(),
		sbn.getUserId());
		} catch (RemoteException ex) {
		}
		mNotifInflationErrorFilter.invalidateList();
		}

		@Override
		public void onNotifInflationErrorCleared(NotificationEntry entry) {
		mNotifInflationErrorFilter.invalidateList();
		}
		};

		private void inflateEntry(NotificationEntry entry, String reason) {
		abortInflation(entry, reason);
		mPendingNotifications.add(entry);

packages/SystemUI/src/com/android/systemui/statusbar/notification/row/NotifInflationErrorManager.java

0 → 100644

+100 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2020 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* 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 com.android.systemui.statusbar.notification.row;

		import androidx.annotation.NonNull;
		import androidx.collection.ArraySet;

		import com.android.systemui.statusbar.notification.collection.NotificationEntry;

		import java.util.ArrayList;
		import java.util.List;
		import java.util.Set;

		import javax.inject.Inject;
		import javax.inject.Singleton;

		/**
		* A manager handling the error state of a notification when it encounters an exception while
		* inflating. We don't want to show these notifications to the user but may want to keep them
		* around for logging purposes.
		*/
		@Singleton
		public class NotifInflationErrorManager {

		Set<NotificationEntry> mErroredNotifs = new ArraySet<>();
		List<NotifInflationErrorListener> mListeners = new ArrayList<>();

		@Inject
		public NotifInflationErrorManager() { }

		/**
		* Mark the notification as errored out due to encountering an exception while inflating.
		*
		* @param e the exception encountered while inflating
		*/
		public void setInflationError(NotificationEntry entry, Exception e) {
		mErroredNotifs.add(entry);
		for (int i = 0; i < mListeners.size(); i++) {
		mListeners.get(i).onNotifInflationError(entry, e);
		}
		}

		/**
		* Notification inflated successfully and is no longer errored out.
		*/
		public void clearInflationError(NotificationEntry entry) {
		if (mErroredNotifs.contains(entry)) {
		mErroredNotifs.remove(entry);
		for (int i = 0; i < mListeners.size(); i++) {
		mListeners.get(i).onNotifInflationErrorCleared(entry);
		}
		}
		}

		/**
		* Whether or not the notification encountered an exception while inflating.
		*/
		public boolean hasInflationError(@NonNull NotificationEntry entry) {
		return mErroredNotifs.contains(entry);
		}

		/**
		* Add listener for changes in inflation error state.
		*/
		public void addInflationErrorListener(NotifInflationErrorListener listener) {
		mListeners.add(listener);
		}

		/**
		* Listener for changes in notification inflation error state.
		*/
		public interface NotifInflationErrorListener {

		/**
		* Called when notification encounters an inflation exception.
		*
		* @param e the exception encountered while inflating
		*/
		void onNotifInflationError(NotificationEntry entry, Exception e);

		/**
		* Called when notification inflation error is cleared.
		*/
		default void onNotifInflationErrorCleared(NotificationEntry entry) {}
		}
		}