Schneider Victor-tulias
a571affc9d
Flag: NONE Fixes: 308982078 Test: quickly swipe to home after tapping a non-running task from overview Change-Id: I1fbf669368586af4e5b9319603c6a928969cb494
446 lines
22 KiB
Java
446 lines
22 KiB
Java
/*
|
|
* Copyright (C) 2022 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.quickstep.util;
|
|
|
|
import android.util.ArraySet;
|
|
|
|
import androidx.annotation.NonNull;
|
|
|
|
import java.io.PrintWriter;
|
|
import java.util.Set;
|
|
|
|
/**
|
|
* Utility class for tracking gesture navigation events as they happen, then detecting and reporting
|
|
* known issues at log dump time.
|
|
*/
|
|
public class ActiveGestureErrorDetector {
|
|
|
|
/**
|
|
* Enums associated to gesture navigation events.
|
|
*/
|
|
public enum GestureEvent {
|
|
MOTION_DOWN, MOTION_UP, MOTION_MOVE, SET_END_TARGET, SET_END_TARGET_HOME,
|
|
SET_END_TARGET_NEW_TASK, SET_END_TARGET_ALL_APPS, ON_SETTLED_ON_END_TARGET,
|
|
ON_START_RECENTS_ANIMATION, ON_FINISH_RECENTS_ANIMATION, ON_CANCEL_RECENTS_ANIMATION,
|
|
START_RECENTS_ANIMATION, FINISH_RECENTS_ANIMATION, CANCEL_RECENTS_ANIMATION,
|
|
SET_ON_PAGE_TRANSITION_END_CALLBACK, CANCEL_CURRENT_ANIMATION, CLEANUP_SCREENSHOT,
|
|
SCROLLER_ANIMATION_ABORTED, TASK_APPEARED, EXPECTING_TASK_APPEARED,
|
|
FLAG_USING_OTHER_ACTIVITY_INPUT_CONSUMER, LAUNCHER_DESTROYED, RECENT_TASKS_MISSING,
|
|
INVALID_VELOCITY_ON_SWIPE_UP,
|
|
|
|
/**
|
|
* These GestureEvents are specifically associated to state flags that get set in
|
|
* {@link com.android.quickstep.MultiStateCallback}. If a state flag needs to be tracked
|
|
* for error detection, an enum should be added here and that state flag-enum pair should
|
|
* be added to the state flag's container class' {@code getTrackedEventForState} method.
|
|
*/
|
|
STATE_GESTURE_STARTED, STATE_GESTURE_COMPLETED, STATE_GESTURE_CANCELLED,
|
|
STATE_END_TARGET_ANIMATION_FINISHED, STATE_RECENTS_SCROLLING_FINISHED,
|
|
STATE_CAPTURE_SCREENSHOT, STATE_SCREENSHOT_CAPTURED, STATE_HANDLER_INVALIDATED,
|
|
STATE_RECENTS_ANIMATION_CANCELED, STATE_LAUNCHER_DRAWN(true, false);
|
|
|
|
public final boolean mLogEvent;
|
|
public final boolean mTrackEvent;
|
|
|
|
GestureEvent() {
|
|
this(false, true);
|
|
}
|
|
|
|
GestureEvent(boolean logEvent, boolean trackEvent) {
|
|
mLogEvent = logEvent;
|
|
mTrackEvent = trackEvent;
|
|
}
|
|
}
|
|
|
|
private ActiveGestureErrorDetector() {}
|
|
|
|
private static final long ON_START_RECENT_ANIMATION_TIME_LIMIT = 500;
|
|
|
|
protected static void analyseAndDump(
|
|
@NonNull String prefix,
|
|
@NonNull PrintWriter writer,
|
|
@NonNull ActiveGestureLog.EventLog eventLog) {
|
|
writer.println(prefix + "Error messages for gesture ID: " + eventLog.logId);
|
|
if (!eventLog.mIsFullyGesturalNavMode) {
|
|
writer.println(prefix
|
|
+ "\tSkipping gesture error detection because gesture navigation not enabled");
|
|
return;
|
|
}
|
|
|
|
boolean errorDetected = false;
|
|
// Use a Set since the order is inherently checked in the loop.
|
|
final Set<GestureEvent> encounteredEvents = new ArraySet<>();
|
|
// Set flags and check order of operations.
|
|
long lastStartRecentAnimationEventEntryTime = 0;
|
|
for (ActiveGestureLog.EventEntry eventEntry : eventLog.eventEntries) {
|
|
GestureEvent gestureEvent = eventEntry.getGestureEvent();
|
|
if (gestureEvent == null) {
|
|
continue;
|
|
}
|
|
encounteredEvents.add(gestureEvent);
|
|
|
|
switch (gestureEvent) {
|
|
case MOTION_UP:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.MOTION_DOWN),
|
|
prefix,
|
|
/* errorMessage= */ "Motion up detected before/without"
|
|
+ " motion down.",
|
|
writer);
|
|
break;
|
|
case ON_SETTLED_ON_END_TARGET:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.SET_END_TARGET),
|
|
prefix,
|
|
/* errorMessage= */ "onSettledOnEndTarget called "
|
|
+ "before/without setEndTarget.",
|
|
writer);
|
|
break;
|
|
case FINISH_RECENTS_ANIMATION:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.START_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */ "finishRecentsAnimation called "
|
|
+ "before/without startRecentsAnimation.",
|
|
writer);
|
|
break;
|
|
case CANCEL_RECENTS_ANIMATION:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.START_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */ "cancelRecentsAnimation called "
|
|
+ "before/without startRecentsAnimation.",
|
|
writer);
|
|
break;
|
|
case CLEANUP_SCREENSHOT:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.STATE_SCREENSHOT_CAPTURED),
|
|
prefix,
|
|
/* errorMessage= */ "recents activity screenshot was "
|
|
+ "cleaned up before/without STATE_SCREENSHOT_CAPTURED "
|
|
+ "being set.",
|
|
writer);
|
|
break;
|
|
case SCROLLER_ANIMATION_ABORTED:
|
|
errorDetected |= printErrorIfTrue(
|
|
encounteredEvents.contains(GestureEvent.SET_END_TARGET_HOME)
|
|
&& !encounteredEvents.contains(
|
|
GestureEvent.ON_SETTLED_ON_END_TARGET),
|
|
prefix,
|
|
/* errorMessage= */ "recents view scroller animation "
|
|
+ "aborted after setting end target HOME, but before"
|
|
+ " settling on end target.",
|
|
writer);
|
|
break;
|
|
case TASK_APPEARED:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.EXPECTING_TASK_APPEARED),
|
|
prefix,
|
|
/* errorMessage= */ "onTasksAppeared was not expected to be called",
|
|
writer);
|
|
if (encounteredEvents.contains(GestureEvent.EXPECTING_TASK_APPEARED)) {
|
|
// Remove both events so that we can properly detect following errors.
|
|
encounteredEvents.remove(GestureEvent.EXPECTING_TASK_APPEARED);
|
|
encounteredEvents.remove(GestureEvent.TASK_APPEARED);
|
|
}
|
|
break;
|
|
case LAUNCHER_DESTROYED:
|
|
errorDetected |= printErrorIfTrue(
|
|
true,
|
|
prefix,
|
|
/* errorMessage= */ "Launcher destroyed mid-gesture",
|
|
writer);
|
|
break;
|
|
case STATE_GESTURE_COMPLETED:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.MOTION_UP),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_GESTURE_COMPLETED set "
|
|
+ "before/without motion up.",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.STATE_GESTURE_STARTED),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_GESTURE_COMPLETED set "
|
|
+ "before/without STATE_GESTURE_STARTED.",
|
|
writer);
|
|
break;
|
|
case STATE_GESTURE_CANCELLED:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.MOTION_UP),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_GESTURE_CANCELLED set "
|
|
+ "before/without motion up.",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.STATE_GESTURE_STARTED),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_GESTURE_CANCELLED set "
|
|
+ "before/without STATE_GESTURE_STARTED.",
|
|
writer);
|
|
break;
|
|
case STATE_SCREENSHOT_CAPTURED:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.STATE_CAPTURE_SCREENSHOT),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_SCREENSHOT_CAPTURED set "
|
|
+ "before/without STATE_CAPTURE_SCREENSHOT.",
|
|
writer);
|
|
break;
|
|
case STATE_RECENTS_SCROLLING_FINISHED:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(
|
|
GestureEvent.SET_ON_PAGE_TRANSITION_END_CALLBACK),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_RECENTS_SCROLLING_FINISHED "
|
|
+ "set before/without calling "
|
|
+ "setOnPageTransitionEndCallback.",
|
|
writer);
|
|
break;
|
|
case STATE_RECENTS_ANIMATION_CANCELED:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(
|
|
GestureEvent.START_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_RECENTS_ANIMATION_CANCELED "
|
|
+ "set before/without startRecentsAnimation.",
|
|
writer);
|
|
break;
|
|
case RECENT_TASKS_MISSING:
|
|
errorDetected |= printErrorIfTrue(
|
|
true,
|
|
prefix,
|
|
/* errorMessage= */ "SystemUiProxy.mRecentTasks missing,"
|
|
+ " couldn't start the recents activity",
|
|
writer);
|
|
break;
|
|
case ON_START_RECENTS_ANIMATION:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.START_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */ "ON_START_RECENTS_ANIMATION "
|
|
+ "onAnimationStart callback ran before startRecentsAnimation",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
eventEntry.getTime() - lastStartRecentAnimationEventEntryTime
|
|
> ON_START_RECENT_ANIMATION_TIME_LIMIT,
|
|
prefix,
|
|
/* errorMessage= */"ON_START_RECENTS_ANIMATION "
|
|
+ "startRecentsAnimation was never called or onAnimationStart "
|
|
+ "callback was called more than 500 ms after "
|
|
+ "startRecentsAnimation.",
|
|
writer);
|
|
lastStartRecentAnimationEventEntryTime = 0;
|
|
break;
|
|
case ON_CANCEL_RECENTS_ANIMATION:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.ON_START_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */ "ON_CANCEL_RECENTS_ANIMATION "
|
|
+ "onAnimationCanceled callback ran before onAnimationStart "
|
|
+ "callback",
|
|
writer);
|
|
break;
|
|
case ON_FINISH_RECENTS_ANIMATION:
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.ON_START_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */ "ON_FINISH_RECENTS_ANIMATION "
|
|
+ "onAnimationFinished callback ran before onAnimationStart "
|
|
+ "callback",
|
|
writer);
|
|
break;
|
|
case INVALID_VELOCITY_ON_SWIPE_UP:
|
|
errorDetected |= printErrorIfTrue(
|
|
true,
|
|
prefix,
|
|
/* errorMessage= */ "invalid velocity on swipe up gesture.",
|
|
writer);
|
|
break;
|
|
case START_RECENTS_ANIMATION:
|
|
lastStartRecentAnimationEventEntryTime = eventEntry.getTime();
|
|
break;
|
|
case EXPECTING_TASK_APPEARED:
|
|
case MOTION_DOWN:
|
|
case SET_END_TARGET:
|
|
case SET_END_TARGET_HOME:
|
|
case SET_END_TARGET_ALL_APPS:
|
|
case SET_END_TARGET_NEW_TASK:
|
|
case SET_ON_PAGE_TRANSITION_END_CALLBACK:
|
|
case CANCEL_CURRENT_ANIMATION:
|
|
case FLAG_USING_OTHER_ACTIVITY_INPUT_CONSUMER:
|
|
case STATE_GESTURE_STARTED:
|
|
case STATE_END_TARGET_ANIMATION_FINISHED:
|
|
case STATE_CAPTURE_SCREENSHOT:
|
|
case STATE_HANDLER_INVALIDATED:
|
|
case STATE_LAUNCHER_DRAWN:
|
|
default:
|
|
// No-Op
|
|
}
|
|
}
|
|
|
|
// Check that all required events were found.
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.MOTION_DOWN),
|
|
prefix,
|
|
/* errorMessage= */ "Motion down never detected.",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
!encounteredEvents.contains(GestureEvent.MOTION_UP),
|
|
prefix,
|
|
/* errorMessage= */ "Motion up never detected.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(GestureEvent.SET_END_TARGET)
|
|
&& !encounteredEvents.contains(GestureEvent.ON_SETTLED_ON_END_TARGET),
|
|
prefix,
|
|
/* errorMessage= */ "setEndTarget was called, but "
|
|
+ "onSettledOnEndTarget wasn't.",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(GestureEvent.SET_END_TARGET)
|
|
&& !encounteredEvents.contains(
|
|
GestureEvent.STATE_END_TARGET_ANIMATION_FINISHED),
|
|
prefix,
|
|
/* errorMessage= */ "setEndTarget was called, but "
|
|
+ "STATE_END_TARGET_ANIMATION_FINISHED was never set.",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(GestureEvent.SET_END_TARGET)
|
|
&& !encounteredEvents.contains(
|
|
GestureEvent.STATE_RECENTS_SCROLLING_FINISHED),
|
|
prefix,
|
|
/* errorMessage= */ "setEndTarget was called, but "
|
|
+ "STATE_RECENTS_SCROLLING_FINISHED was never set.",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(
|
|
GestureEvent.STATE_END_TARGET_ANIMATION_FINISHED)
|
|
&& encounteredEvents.contains(
|
|
GestureEvent.STATE_RECENTS_SCROLLING_FINISHED)
|
|
&& !encounteredEvents.contains(GestureEvent.ON_SETTLED_ON_END_TARGET),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_END_TARGET_ANIMATION_FINISHED and "
|
|
+ "STATE_RECENTS_SCROLLING_FINISHED were set, but onSettledOnEndTarget "
|
|
+ "wasn't called.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(
|
|
GestureEvent.START_RECENTS_ANIMATION)
|
|
&& !encounteredEvents.contains(GestureEvent.FINISH_RECENTS_ANIMATION)
|
|
&& !encounteredEvents.contains(GestureEvent.CANCEL_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */ "startRecentsAnimation was called, but "
|
|
+ "finishRecentsAnimation and cancelRecentsAnimation weren't.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(GestureEvent.STATE_GESTURE_STARTED)
|
|
&& !encounteredEvents.contains(GestureEvent.STATE_GESTURE_COMPLETED)
|
|
&& !encounteredEvents.contains(GestureEvent.STATE_GESTURE_CANCELLED),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_GESTURE_STARTED was set, but "
|
|
+ "STATE_GESTURE_COMPLETED and STATE_GESTURE_CANCELLED weren't.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(
|
|
GestureEvent.STATE_CAPTURE_SCREENSHOT)
|
|
&& !encounteredEvents.contains(GestureEvent.STATE_SCREENSHOT_CAPTURED),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_CAPTURE_SCREENSHOT was set, but "
|
|
+ "STATE_SCREENSHOT_CAPTURED wasn't.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(
|
|
GestureEvent.SET_ON_PAGE_TRANSITION_END_CALLBACK)
|
|
&& !encounteredEvents.contains(
|
|
GestureEvent.STATE_RECENTS_SCROLLING_FINISHED),
|
|
prefix,
|
|
/* errorMessage= */ "setOnPageTransitionEndCallback called, but "
|
|
+ "STATE_RECENTS_SCROLLING_FINISHED wasn't set.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(
|
|
GestureEvent.FLAG_USING_OTHER_ACTIVITY_INPUT_CONSUMER)
|
|
&& !encounteredEvents.contains(GestureEvent.CANCEL_CURRENT_ANIMATION)
|
|
&& !encounteredEvents.contains(GestureEvent.STATE_HANDLER_INVALIDATED),
|
|
prefix,
|
|
/* errorMessage= */ "AbsSwipeUpHandler.cancelCurrentAnimation "
|
|
+ "wasn't called and STATE_HANDLER_INVALIDATED wasn't set.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(
|
|
GestureEvent.STATE_RECENTS_ANIMATION_CANCELED)
|
|
&& !encounteredEvents.contains(GestureEvent.CLEANUP_SCREENSHOT),
|
|
prefix,
|
|
/* errorMessage= */ "STATE_RECENTS_ANIMATION_CANCELED was set but "
|
|
+ "the task screenshot wasn't cleaned up.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(
|
|
GestureEvent.EXPECTING_TASK_APPEARED)
|
|
&& !encounteredEvents.contains(GestureEvent.TASK_APPEARED),
|
|
prefix,
|
|
/* errorMessage= */ "onTaskAppeared was expected to be called but wasn't.",
|
|
writer);
|
|
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */ encounteredEvents.contains(GestureEvent.START_RECENTS_ANIMATION)
|
|
&& !encounteredEvents.contains(GestureEvent.ON_START_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */
|
|
"startRecentAnimation was called but onAnimationStart callback was not",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */
|
|
encounteredEvents.contains(GestureEvent.FINISH_RECENTS_ANIMATION)
|
|
&& !encounteredEvents.contains(GestureEvent.ON_FINISH_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */
|
|
"finishController was called but onAnimationFinished callback was not",
|
|
writer);
|
|
errorDetected |= printErrorIfTrue(
|
|
/* condition= */
|
|
encounteredEvents.contains(GestureEvent.CANCEL_RECENTS_ANIMATION)
|
|
&& !encounteredEvents.contains(GestureEvent.ON_CANCEL_RECENTS_ANIMATION),
|
|
prefix,
|
|
/* errorMessage= */
|
|
"onRecentsAnimationCanceled was called but onAnimationCanceled was not",
|
|
writer);
|
|
|
|
if (!errorDetected) {
|
|
writer.println(prefix + "\tNo errors detected.");
|
|
}
|
|
}
|
|
|
|
private static boolean printErrorIfTrue(
|
|
boolean condition, String prefix, String errorMessage, PrintWriter writer) {
|
|
if (!condition) {
|
|
return false;
|
|
}
|
|
writer.println(prefix + "\t- " + errorMessage);
|
|
|
|
return true;
|
|
}
|
|
}
|