Convert all Log.* messages in KeyguardUpdateMonitor to use LogBuffer am: e3022817d6 (3459f452) · Commits · e / os / android_frameworks_base

packages/SystemUI/src/com/android/keyguard/KeyguardUpdateMonitor.java

+152 −197

File changed.

Preview size limit exceeded, changes collapsed.

packages/SystemUI/src/com/android/keyguard/logging/KeyguardUpdateMonitorLogger.kt

0 → 100644

+326 −0

Original line number	Diff line number	Diff line
		/*
		* 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.keyguard.logging

		import android.hardware.biometrics.BiometricConstants.LockoutMode
		import android.telephony.ServiceState
		import android.telephony.SubscriptionInfo
		import com.android.keyguard.ActiveUnlockConfig
		import com.android.keyguard.KeyguardListenModel
		import com.android.keyguard.KeyguardUpdateMonitorCallback
		import com.android.systemui.log.LogBuffer
		import com.android.systemui.log.LogLevel
		import com.android.systemui.log.LogLevel.DEBUG
		import com.android.systemui.log.LogLevel.ERROR
		import com.android.systemui.log.LogLevel.INFO
		import com.android.systemui.log.LogLevel.VERBOSE
		import com.android.systemui.log.LogLevel.WARNING
		import com.android.systemui.log.dagger.KeyguardUpdateMonitorLog
		import com.google.errorprone.annotations.CompileTimeConstant
		import javax.inject.Inject

		private const val TAG = "KeyguardUpdateMonitorLog"

		/**
		* Helper class for logging for [com.android.keyguard.KeyguardUpdateMonitor]
		*/
		class KeyguardUpdateMonitorLogger @Inject constructor(
		@KeyguardUpdateMonitorLog private val logBuffer: LogBuffer
		) {
		fun d(@CompileTimeConstant msg: String) = log(msg, DEBUG)

		fun e(@CompileTimeConstant msg: String) = log(msg, ERROR)

		fun v(@CompileTimeConstant msg: String) = log(msg, ERROR)

		fun w(@CompileTimeConstant msg: String) = log(msg, WARNING)

		fun log(@CompileTimeConstant msg: String, level: LogLevel) = logBuffer.log(TAG, level, msg)

		fun logActiveUnlockTriggered(reason: String) {
		logBuffer.log("ActiveUnlock", DEBUG,
		{ str1 = reason },
		{ "initiate active unlock triggerReason=$str1" })
		}

		fun logAuthInterruptDetected(active: Boolean) {
		logBuffer.log(TAG, DEBUG,
		{ bool1 = active },
		{ "onAuthInterruptDetected($bool1)" })
		}

		fun logBroadcastReceived(action: String?) {
		logBuffer.log(TAG, DEBUG, { str1 = action }, { "received broadcast $str1" })
		}

		fun logDeviceProvisionedState(deviceProvisioned: Boolean) {
		logBuffer.log(TAG, DEBUG,
		{ bool1 = deviceProvisioned },
		{ "DEVICE_PROVISIONED state = $bool1" })
		}

		fun logException(ex: Exception, @CompileTimeConstant logMsg: String) {
		logBuffer.log(TAG, ERROR, {}, { logMsg }, exception = ex)
		}

		fun logFaceAcquired(acquireInfo: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = acquireInfo },
		{ "Face acquired acquireInfo=$int1" })
		}

		fun logFaceAuthDisabledForUser(userId: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = userId },
		{ "Face authentication disabled by DPM for userId: $int1" })
		}
		fun logFaceAuthError(msgId: Int, originalErrMsg: String) {
		logBuffer.log(TAG, DEBUG, {
		str1 = originalErrMsg
		int1 = msgId
		}, { "Face error received: $str1 msgId= $int1" })
		}

		fun logFaceAuthForWrongUser(authUserId: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = authUserId },
		{ "Face authenticated for wrong user: $int1" })
		}

		fun logFaceAuthHelpMsg(msgId: Int, helpMsg: String) {
		logBuffer.log(TAG, DEBUG, {
		int1 = msgId
		str1 = helpMsg
		}, { "Face help received, msgId: $int1 msg: $str1" })
		}

		fun logFaceAuthRequested(userInitiatedRequest: Boolean) {
		logBuffer.log(TAG, DEBUG,
		{ bool1 = userInitiatedRequest },
		{ "requestFaceAuth() userInitiated=$bool1" })
		}

		fun logFaceAuthSuccess(userId: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = userId },
		{ "Face auth succeeded for user $int1" })
		}

		fun logFaceLockoutReset(@LockoutMode mode: Int) {
		logBuffer.log(TAG, DEBUG, { int1 = mode }, { "handleFaceLockoutReset: $int1" })
		}

		fun logFaceRunningState(faceRunningState: Int) {
		logBuffer.log(TAG, DEBUG, { int1 = faceRunningState }, { "faceRunningState: $int1" })
		}

		fun logFingerprintAuthForWrongUser(authUserId: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = authUserId },
		{ "Fingerprint authenticated for wrong user: $int1" })
		}

		fun logFingerprintDisabledForUser(userId: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = userId },
		{ "Fingerprint disabled by DPM for userId: $int1" })
		}

		fun logFingerprintLockoutReset(@LockoutMode mode: Int) {
		logBuffer.log(TAG, DEBUG, { int1 = mode }, { "handleFingerprintLockoutReset: $int1" })
		}

		fun logFingerprintRunningState(fingerprintRunningState: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = fingerprintRunningState },
		{ "fingerprintRunningState: $int1" })
		}

		fun logInvalidSubId(subId: Int) {
		logBuffer.log(TAG, INFO,
		{ int1 = subId },
		{ "Previously active sub id $int1 is now invalid, will remove" })
		}

		fun logKeyguardBouncerChanged(bouncerIsOrWillBeShowing: Boolean, bouncerFullyShown: Boolean) {
		logBuffer.log(TAG, DEBUG, {
		bool1 = bouncerIsOrWillBeShowing
		bool2 = bouncerFullyShown
		}, {
		"handleKeyguardBouncerChanged " +
		"bouncerIsOrWillBeShowing=$bool1 bouncerFullyShowing=$bool2"
		})
		}

		fun logKeyguardListenerModel(model: KeyguardListenModel) {
		logBuffer.log(TAG, VERBOSE, { str1 = "$model" }, { str1!! })
		}

		fun logKeyguardVisibilityChanged(showing: Boolean) {
		logBuffer.log(TAG, DEBUG, { bool1 = showing }, { "onKeyguardVisibilityChanged($bool1)" })
		}

		fun logMissingSupervisorAppError(userId: Int) {
		logBuffer.log(TAG, ERROR,
		{ int1 = userId },
		{ "No Profile Owner or Device Owner supervision app found for User $int1" })
		}

		fun logPhoneStateChanged(newState: String) {
		logBuffer.log(TAG, DEBUG,
		{ str1 = newState },
		{ "handlePhoneStateChanged($str1)" })
		}

		fun logRegisterCallback(callback: KeyguardUpdateMonitorCallback?) {
		logBuffer.log(TAG, VERBOSE,
		{ str1 = "$callback" },
		{ "*** register callback for $str1" })
		}

		fun logRetryingAfterFaceHwUnavailable(retryCount: Int) {
		logBuffer.log(TAG, WARNING,
		{ int1 = retryCount },
		{ "Retrying face after HW unavailable, attempt $int1" })
		}

		fun logRetryAfterFpHwUnavailable(retryCount: Int) {
		logBuffer.log(TAG, WARNING,
		{ int1 = retryCount },
		{ "Retrying fingerprint attempt: $int1" })
		}

		fun logSendKeyguardBouncerChanged(
		bouncerIsOrWillBeShowing: Boolean,
		bouncerFullyShown: Boolean,
		) {
		logBuffer.log(TAG, DEBUG, {
		bool1 = bouncerIsOrWillBeShowing
		bool2 = bouncerFullyShown
		}, {
		"sendKeyguardBouncerChanged bouncerIsOrWillBeShowing=$bool1 " +
		"bouncerFullyShown=$bool2"
		})
		}

		fun logServiceStateChange(subId: Int, serviceState: ServiceState?) {
		logBuffer.log(TAG, DEBUG, {
		int1 = subId
		str1 = "$serviceState"
		}, { "handleServiceStateChange(subId=$int1, serviceState=$str1)" })
		}

		fun logServiceStateIntent(action: String, serviceState: ServiceState?, subId: Int) {
		logBuffer.log(TAG, VERBOSE, {
		str1 = action
		str2 = "$serviceState"
		int1 = subId
		}, { "action $str1 serviceState=$str2 subId=$int1" })
		}

		fun logSimState(subId: Int, slotId: Int, state: Int) {
		logBuffer.log(TAG, DEBUG, {
		int1 = subId
		int2 = slotId
		long1 = state.toLong()
		}, { "handleSimStateChange(subId=$int1, slotId=$int2, state=$long1)" })
		}

		fun logSimStateFromIntent(action: String, extraSimState: String, slotId: Int, subId: Int) {
		logBuffer.log(TAG, VERBOSE, {
		str1 = action
		str2 = extraSimState
		int1 = slotId
		int2 = subId
		}, { "action $str1 state: $str2 slotId: $int1 subid: $int2" })
		}

		fun logSimUnlocked(subId: Int) {
		logBuffer.log(TAG, VERBOSE, { int1 = subId }, { "reportSimUnlocked(subId=$int1)" })
		}

		fun logStartedListeningForFace(faceRunningState: Int) {
		logBuffer.log(TAG, VERBOSE,
		{ int1 = faceRunningState },
		{ "startListeningForFace(): $int1" })
		}

		fun logSubInfo(subInfo: SubscriptionInfo?) {
		logBuffer.log(TAG, VERBOSE,
		{ str1 = "$subInfo" },
		{ "SubInfo:$str1" })
		}

		fun logTimeFormatChanged(newTimeFormat: String) {
		logBuffer.log(TAG, DEBUG,
		{ str1 = newTimeFormat },
		{ "handleTimeFormatUpdate timeFormat=$str1" })
		}

		fun logUdfpsPointerDown(sensorId: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = sensorId },
		{ "onUdfpsPointerDown, sensorId: $int1" })
		}
		fun logUdfpsPointerUp(sensorId: Int) {
		logBuffer.log(TAG, DEBUG,
		{ int1 = sensorId },
		{ "onUdfpsPointerUp, sensorId: $int1" })
		}

		fun logUnexpectedFaceCancellationSignalState(faceRunningState: Int, unlockPossible: Boolean) {
		logBuffer.log(TAG, ERROR, {
		int1 = faceRunningState
		bool1 = unlockPossible
		}, {
		"Cancellation signal is not null, high chance of bug in " +
		"face auth lifecycle management. " +
		"Face state: $int1, unlockPossible: $bool1"
		})
		}

		fun logUnexpectedFpCancellationSignalState(
		fingerprintRunningState: Int,
		unlockPossible: Boolean
		) {
		logBuffer.log(TAG, ERROR, {
		int1 = fingerprintRunningState
		bool1 = unlockPossible
		}, {
		"Cancellation signal is not null, high chance of bug in " +
		"fp auth lifecycle management. FP state: $int1, unlockPossible: $bool1"
		})
		}

		fun logUnregisterCallback(callback: KeyguardUpdateMonitorCallback?) {
		logBuffer.log(TAG, VERBOSE,
		{ str1 = "$callback" },
		{ "*** unregister callback for $str1" })
		}

		fun logUserRequestedUnlock(
		requestOrigin: ActiveUnlockConfig.ACTIVE_UNLOCK_REQUEST_ORIGIN,
		reason: String,
		dismissKeyguard: Boolean
		) {
		logBuffer.log("ActiveUnlock", DEBUG, {
		str1 = requestOrigin.name
		str2 = reason
		bool1 = dismissKeyguard
		}, { "reportUserRequestedUnlock origin=$str1 reason=$str2 dismissKeyguard=$bool1" })
		}
		}

packages/SystemUI/src/com/android/systemui/log/dagger/KeyguardUpdateMonitorLog.kt

0 → 100644

+4 −0

Original line number	Diff line number	Diff line
		package com.android.systemui.log.dagger

		/** A [com.android.systemui.log.LogBuffer] for KeyguardUpdateMonitor. */
		annotation class KeyguardUpdateMonitorLog

packages/SystemUI/src/com/android/systemui/log/dagger/LogModule.java

+10 −0

Original line number	Diff line number	Diff line
		@@ -277,4 +277,14 @@ public class LogModule {
		public static LogBuffer provideStatusBarNetworkControllerBuffer(LogBufferFactory factory) {
		return factory.create("StatusBarNetworkControllerLog", 20);
		}

		/**
		* Provides a {@link LogBuffer} for use by {@link com.android.keyguard.KeyguardUpdateMonitor}.
		*/
		@Provides
		@SysUISingleton
		@KeyguardUpdateMonitorLog
		public static LogBuffer provideKeyguardUpdateMonitorLogBuffer(LogBufferFactory factory) {
		return factory.create("KeyguardUpdateMonitorLog", 200);
		}
		}

packages/SystemUI/tests/src/com/android/keyguard/KeyguardUpdateMonitorTest.java

+5 −1

Original line number	Diff line number	Diff line
		@@ -86,6 +86,7 @@ import com.android.internal.util.LatencyTracker;
		import com.android.internal.widget.ILockSettings;
		import com.android.internal.widget.LockPatternUtils;
		import com.android.keyguard.KeyguardUpdateMonitor.BiometricAuthenticated;
		import com.android.keyguard.logging.KeyguardUpdateMonitorLogger;
		import com.android.systemui.SysuiTestCase;
		import com.android.systemui.biometrics.AuthController;
		import com.android.systemui.broadcast.BroadcastDispatcher;
		@@ -179,6 +180,8 @@ public class KeyguardUpdateMonitorTest extends SysuiTestCase {
		private KeyguardUpdateMonitorCallback mTestCallback;
		@Mock
		private ActiveUnlockConfig mActiveUnlockConfig;
		@Mock
		private KeyguardUpdateMonitorLogger mKeyguardUpdateMonitorLogger;
		// Direct executor
		private Executor mBackgroundExecutor = Runnable::run;
		private Executor mMainExecutor = Runnable::run;
		@@ -1189,7 +1192,8 @@ public class KeyguardUpdateMonitorTest extends SysuiTestCase {
		mBackgroundExecutor, mMainExecutor,
		mStatusBarStateController, mLockPatternUtils,
		mAuthController, mTelephonyListenerManager,
		mInteractionJankMonitor, mLatencyTracker, mActiveUnlockConfig);
		mInteractionJankMonitor, mLatencyTracker, mActiveUnlockConfig,
		mKeyguardUpdateMonitorLogger);
		setStrongAuthTracker(KeyguardUpdateMonitorTest.this.mStrongAuthTracker);
		}