Merge "Statsd log remaining notification events." into rvc-dev (acc504a3) · Commits · e / os / android_frameworks_base

services/core/java/com/android/server/notification/NotificationManagerService.java

+26 −1

Original line number	Diff line number	Diff line
		@@ -931,6 +931,8 @@ public class NotificationManagerService extends SystemService {
		.setType(MetricsEvent.TYPE_ACTION)
		.addTaggedData(MetricsEvent.NOTIFICATION_SHADE_INDEX, nv.rank)
		.addTaggedData(MetricsEvent.NOTIFICATION_SHADE_COUNT, nv.count));
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.NOTIFICATION_CLICKED, r);
		EventLogTags.writeNotificationClicked(key,
		r.getLifespanMs(now), r.getFreshnessMs(now), r.getExposureMs(now),
		nv.rank, nv.count);
		@@ -970,7 +972,8 @@ public class NotificationManagerService extends SystemService {
		generatedByAssistant ? 1 : 0)
		.addTaggedData(MetricsEvent.NOTIFICATION_LOCATION,
		nv.location.toMetricsEventEnum()));

		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.NOTIFICATION_ACTION_CLICKED, r);
		EventLogTags.writeNotificationActionClicked(key, actionIndex,
		r.getLifespanMs(now), r.getFreshnessMs(now), r.getExposureMs(now),
		nv.rank, nv.count);
		@@ -1004,6 +1007,8 @@ public class NotificationManagerService extends SystemService {
		public void onPanelRevealed(boolean clearEffects, int items) {
		MetricsLogger.visible(getContext(), MetricsEvent.NOTIFICATION_PANEL);
		MetricsLogger.histogram(getContext(), "note_load", items);
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationPanelEvent.NOTIFICATION_PANEL_OPEN);
		EventLogTags.writeNotificationPanelRevealed(items);
		if (clearEffects) {
		clearEffects();
		@@ -1014,6 +1019,8 @@ public class NotificationManagerService extends SystemService {
		@Override
		public void onPanelHidden() {
		MetricsLogger.hidden(getContext(), MetricsEvent.NOTIFICATION_PANEL);
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationPanelEvent.NOTIFICATION_PANEL_CLOSE);
		EventLogTags.writeNotificationPanelHidden();
		mAssistants.onPanelHidden();
		}
		@@ -1103,6 +1110,10 @@ public class NotificationManagerService extends SystemService {
		MetricsLogger.action(r.getItemLogMaker()
		.setType(expanded ? MetricsEvent.TYPE_DETAIL
		: MetricsEvent.TYPE_COLLAPSE));
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.fromExpanded(expanded,
		userAction),
		r);
		}
		if (expanded && userAction) {
		r.recordExpanded();
		@@ -1124,6 +1135,9 @@ public class NotificationManagerService extends SystemService {
		mMetricsLogger.write(r.getLogMaker()
		.setCategory(MetricsEvent.NOTIFICATION_DIRECT_REPLY_ACTION)
		.setType(MetricsEvent.TYPE_ACTION));
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.NOTIFICATION_DIRECT_REPLIED,
		r);
		reportUserInteraction(r);
		mAssistants.notifyAssistantNotificationDirectReplyLocked(r.getSbn());
		}
		@@ -1166,6 +1180,9 @@ public class NotificationManagerService extends SystemService {
		MetricsEvent.NOTIFICATION_SMART_REPLY_MODIFIED_BEFORE_SENDING,
		modifiedBeforeSending ? 1 : 0);
		mMetricsLogger.write(logMaker);
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.NOTIFICATION_SMART_REPLIED,
		r);
		// Treat clicking on a smart reply as a user interaction.
		reportUserInteraction(r);
		mAssistants.notifyAssistantSuggestedReplySent(
		@@ -1310,6 +1327,9 @@ public class NotificationManagerService extends SystemService {
		MetricsEvent.NOTIFICATION_SMART_REPLY_EDIT_BEFORE_SENDING,
		r.getEditChoicesBeforeSending() ? 1 : 0);
		mMetricsLogger.write(logMaker);
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.NOTIFICATION_SMART_REPLY_VISIBLE,
		r);
		}
		}

		@@ -6150,6 +6170,9 @@ public class NotificationManagerService extends SystemService {
		MetricsLogger.action(r.getLogMaker()
		.setType(MetricsProto.MetricsEvent.TYPE_UPDATE)
		.setCategory(MetricsProto.MetricsEvent.NOTIFICATION_SNOOZED));
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.NOTIFICATION_NOT_POSTED_SNOOZED,
		r);
		if (DBG) {
		Slog.d(TAG, "Ignored enqueue for snoozed notification " + r.getKey());
		}
		@@ -6279,6 +6302,8 @@ public class NotificationManagerService extends SystemService {
		mDuration)
		.addTaggedData(MetricsEvent.NOTIFICATION_SNOOZED_CRITERIA,
		mSnoozeCriterionId == null ? 0 : 1));
		mNotificationRecordLogger.log(
		NotificationRecordLogger.NotificationEvent.NOTIFICATION_SNOOZED, r);
		reportUserInteraction(r);
		boolean wasPosted = removeFromNotificationListsLocked(r);
		cancelNotificationLocked(r, false, REASON_SNOOZED, wasPosted, null);

services/core/java/com/android/server/notification/NotificationRecordLogger.java

+65 −5

Original line number	Diff line number	Diff line
		@@ -34,11 +34,14 @@ import java.util.ArrayList;
		import java.util.Objects;

		/**
		* Interface for writing NotificationReported atoms to statsd log.
		* Interface for writing NotificationReported atoms to statsd log. Use NotificationRecordLoggerImpl
		* in production. Use NotificationRecordLoggerFake for testing.
		* @hide
		*/
		public interface NotificationRecordLogger {

		// The high-level interface used by clients.

		/**
		* May log a NotificationReported atom reflecting the posting or update of a notification.
		* @param r The new NotificationRecord. If null, no action is taken.
		@@ -57,9 +60,11 @@ public interface NotificationRecordLogger {
		* @param reason The reason the notification was canceled.
		* @param dismissalSurface The surface the notification was dismissed from.
		*/
		void logNotificationCancelled(@Nullable NotificationRecord r,
		default void logNotificationCancelled(@Nullable NotificationRecord r,
		@NotificationListenerService.NotificationCancelReason int reason,
		@NotificationStats.DismissalSurface int dismissalSurface);
		@NotificationStats.DismissalSurface int dismissalSurface) {
		log(NotificationCancelledEvent.fromCancelReason(reason, dismissalSurface), r);
		}

		/**
		* Logs a notification visibility change event using UiEventReported (event ids from the
		@@ -67,7 +72,17 @@ public interface NotificationRecordLogger {
		* @param r The NotificationRecord. If null, no action is taken.
		* @param visible True if the notification became visible.
		*/
		void logNotificationVisibility(@Nullable NotificationRecord r, boolean visible);
		default void logNotificationVisibility(@Nullable NotificationRecord r, boolean visible) {
		log(NotificationEvent.fromVisibility(visible), r);
		}

		// The UiEventReported logging methods are implemented in terms of this lower-level interface.

		/** Logs a UiEventReported event for the given notification. */
		void log(UiEventLogger.UiEventEnum event, NotificationRecord r);

		/** Logs a UiEventReported event that is not associated with any notification. */
		void log(UiEventLogger.UiEventEnum event);

		/**
		* The UiEvent enums that this class can log.
		@@ -204,7 +219,30 @@ public interface NotificationRecordLogger {
		@UiEvent(doc = "Notification became visible.")
		NOTIFICATION_OPEN(197),
		@UiEvent(doc = "Notification stopped being visible.")
		NOTIFICATION_CLOSE(198);
		NOTIFICATION_CLOSE(198),
		@UiEvent(doc = "Notification was snoozed.")
		NOTIFICATION_SNOOZED(317),
		@UiEvent(doc = "Notification was not posted because its app is snoozed.")
		NOTIFICATION_NOT_POSTED_SNOOZED(319),
		@UiEvent(doc = "Notification was clicked.")
		NOTIFICATION_CLICKED(320),
		@UiEvent(doc = "Notification action was clicked.")
		NOTIFICATION_ACTION_CLICKED(321),
		@UiEvent(doc = "Notification detail was expanded due to non-user action.")
		NOTIFICATION_DETAIL_OPEN_SYSTEM(327),
		@UiEvent(doc = "Notification detail was collapsed due to non-user action.")
		NOTIFICATION_DETAIL_CLOSE_SYSTEM(328),
		@UiEvent(doc = "Notification detail was expanded due to user action.")
		NOTIFICATION_DETAIL_OPEN_USER(329),
		@UiEvent(doc = "Notification detail was collapsed due to user action.")
		NOTIFICATION_DETAIL_CLOSE_USER(330),
		@UiEvent(doc = "Notification direct reply action was used.")
		NOTIFICATION_DIRECT_REPLIED(331),
		@UiEvent(doc = "Notification smart reply action was used.")
		NOTIFICATION_SMART_REPLIED(332),
		@UiEvent(doc = "Notification smart reply action was visible.")
		NOTIFICATION_SMART_REPLY_VISIBLE(333),
		;

		private final int mId;
		NotificationEvent(int id) {
		@@ -217,7 +255,29 @@ public interface NotificationRecordLogger {
		public static NotificationEvent fromVisibility(boolean visible) {
		return visible ? NOTIFICATION_OPEN : NOTIFICATION_CLOSE;
		}
		public static NotificationEvent fromExpanded(boolean expanded, boolean userAction) {
		if (userAction) {
		return expanded ? NOTIFICATION_DETAIL_OPEN_USER : NOTIFICATION_DETAIL_CLOSE_USER;
		}
		return expanded ? NOTIFICATION_DETAIL_OPEN_SYSTEM : NOTIFICATION_DETAIL_CLOSE_SYSTEM;
		}
		}

		enum NotificationPanelEvent implements UiEventLogger.UiEventEnum {
		@UiEvent(doc = "Notification panel became visible.")
		NOTIFICATION_PANEL_OPEN(325),
		@UiEvent(doc = "Notification panel stopped being visible.")
		NOTIFICATION_PANEL_CLOSE(326);

		private final int mId;
		NotificationPanelEvent(int id) {
		mId = id;
		}
		@Override public int getId() {
		return mId;
		}
		}

		/**
		* A helper for extracting logging information from one or two NotificationRecords.
		*/

services/core/java/com/android/server/notification/NotificationRecordLoggerImpl.java

+6 −10

Original line number	Diff line number	Diff line
		@@ -65,20 +65,16 @@ public class NotificationRecordLoggerImpl implements NotificationRecordLogger {
		}

		@Override
		public void logNotificationCancelled(NotificationRecord r, int reason, int dismissalSurface) {
		log(NotificationCancelledEvent.fromCancelReason(reason, dismissalSurface), r);
		}

		@Override
		public void logNotificationVisibility(NotificationRecord r, boolean visible) {
		log(NotificationEvent.fromVisibility(visible), r);
		}

		void log(UiEventLogger.UiEventEnum event, NotificationRecord r) {
		public void log(UiEventLogger.UiEventEnum event, NotificationRecord r) {
		if (r == null) {
		return;
		}
		mUiEventLogger.logWithInstanceId(event, r.getUid(), r.getSbn().getPackageName(),
		r.getSbn().getInstanceId());
		}

		@Override
		public void log(UiEventLogger.UiEventEnum event) {
		mUiEventLogger.log(event);
		}
		}

services/tests/uiservicestests/src/com/android/server/notification/NotificationManagerServiceTest.java

+112 −30

File changed.

Preview size limit exceeded, changes collapsed.

services/tests/uiservicestests/src/com/android/server/notification/NotificationRecordLoggerFake.java

+15 −9

Original line number	Diff line number	Diff line
		@@ -31,25 +31,29 @@ class NotificationRecordLoggerFake implements NotificationRecordLogger {
		// The following fields are only relevant to maybeLogNotificationPosted() calls.
		static final int INVALID = -1;
		public int position = INVALID, buzzBeepBlink = INVALID;
		public boolean shouldLogReported;
		public boolean wasLogged;

		CallRecord(NotificationRecord r, NotificationRecord old, int position,
		int buzzBeepBlink) {
		super(r, old);
		this.position = position;
		this.buzzBeepBlink = buzzBeepBlink;
		shouldLogReported = shouldLogReported(buzzBeepBlink);
		event = shouldLogReported ? NotificationReportedEvent.fromRecordPair(this) : null;
		wasLogged = shouldLogReported(buzzBeepBlink);
		event = wasLogged ? NotificationReportedEvent.fromRecordPair(this) : null;
		}

		CallRecord(NotificationRecord r, UiEventLogger.UiEventEnum event) {
		super(r, null);
		shouldLogReported = false;
		wasLogged = true;
		this.event = event;
		}
		}
		private List<CallRecord> mCalls = new ArrayList<>();

		public int numCalls() {
		return mCalls.size();
		}

		List<CallRecord> getCalls() {
		return mCalls;
		}
		@@ -57,6 +61,9 @@ class NotificationRecordLoggerFake implements NotificationRecordLogger {
		CallRecord get(int index) {
		return mCalls.get(index);
		}
		UiEventLogger.UiEventEnum event(int index) {
		return mCalls.get(index).event;
		}

		@Override
		public void maybeLogNotificationPosted(NotificationRecord r, NotificationRecord old,
		@@ -65,13 +72,12 @@ class NotificationRecordLoggerFake implements NotificationRecordLogger {
		}

		@Override
		public void logNotificationCancelled(NotificationRecord r, int reason, int dismissalSurface) {
		mCalls.add(new CallRecord(r,
		NotificationCancelledEvent.fromCancelReason(reason, dismissalSurface)));
		public void log(UiEventLogger.UiEventEnum event, NotificationRecord r) {
		mCalls.add(new CallRecord(r, event));
		}

		@Override
		public void logNotificationVisibility(NotificationRecord r, boolean visible) {
		mCalls.add(new CallRecord(r, NotificationEvent.fromVisibility(visible)));
		public void log(UiEventLogger.UiEventEnum event) {
		mCalls.add(new CallRecord(null, event));
		}
		}