Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d70220cb authored by Caitlin Shkuratov's avatar Caitlin Shkuratov
Browse files

[SB][Screen Chips] Convert RecordingController logs to LogBuffer. 

The new screen chips rely on some data from RecordingController, and
it would be great to always have that log information available in a
LogBuffer.

Bug: 351785188
Bug: 332662551
Flag: NONE logging change

Test: Do some screen recording then dump `RecordingControllerLog` ->
verify logging
Test: atest RecordingControllerTest

Change-Id: Iaeed70782d072ed7b5e552fe00a04f93298bbfa8
parent 5464aa5d

packages/SystemUI/src/com/android/systemui/screenrecord/RecordingController.java

+13 −10
Original line number Diff line number Diff line
@@ -27,7 +27,6 @@ import android.os.Bundle; 
import android.os.CountDownTimer;

import android.os.Process;

import android.os.UserHandle;

import android.util.Log;



import androidx.annotation.NonNull;

import androidx.annotation.Nullable;
@@ -60,8 +59,6 @@ import javax.inject.Inject; 
@SysUISingleton

public class RecordingController

        implements CallbackController<RecordingController.RecordingStateChangeCallback> {

    private static final String TAG = "RecordingController";



    private boolean mIsStarting;

    private boolean mIsRecording;

    private PendingIntent mStopIntent;
@@ -71,6 +68,7 @@ public class RecordingController 
    private final BroadcastDispatcher mBroadcastDispatcher;

    private final FeatureFlags mFlags;

    private final UserTracker mUserTracker;

    private final RecordingControllerLogger mRecordingControllerLogger;

    private final MediaProjectionMetricsLogger mMediaProjectionMetricsLogger;

    private final ScreenCaptureDisabledDialogDelegate mScreenCaptureDisabledDialogDelegate;

    private final ScreenRecordDialogDelegate.Factory mScreenRecordDialogFactory;
@@ -102,9 +100,10 @@ public class RecordingController 
            if (intent != null && INTENT_UPDATE_STATE.equals(intent.getAction())) {

                if (intent.hasExtra(EXTRA_STATE)) {

                    boolean state = intent.getBooleanExtra(EXTRA_STATE, false);

                    mRecordingControllerLogger.logIntentStateUpdated(state);

                    updateState(state);

                } else {

                    Log.e(TAG, "Received update intent with no state");

                    mRecordingControllerLogger.logIntentMissingState();

                }

            }

        }
@@ -120,6 +119,7 @@ public class RecordingController 
            FeatureFlags flags,

            Lazy<ScreenCaptureDevicePolicyResolver> devicePolicyResolver,

            UserTracker userTracker,

            RecordingControllerLogger recordingControllerLogger,

            MediaProjectionMetricsLogger mediaProjectionMetricsLogger,

            ScreenCaptureDisabledDialogDelegate screenCaptureDisabledDialogDelegate,

            ScreenRecordDialogDelegate.Factory screenRecordDialogFactory,
@@ -130,6 +130,7 @@ public class RecordingController 
        mDevicePolicyResolver = devicePolicyResolver;

        mBroadcastDispatcher = broadcastDispatcher;

        mUserTracker = userTracker;

        mRecordingControllerLogger = recordingControllerLogger;

        mMediaProjectionMetricsLogger = mediaProjectionMetricsLogger;

        mScreenCaptureDisabledDialogDelegate = screenCaptureDisabledDialogDelegate;

        mScreenRecordDialogFactory = screenRecordDialogFactory;
@@ -212,9 +213,9 @@ public class RecordingController 
                    IntentFilter stateFilter = new IntentFilter(INTENT_UPDATE_STATE);

                    mBroadcastDispatcher.registerReceiver(mStateChangeReceiver, stateFilter, null,

                            UserHandle.ALL);

                    Log.d(TAG, "sent start intent");

                    mRecordingControllerLogger.logSentStartIntent();

                } catch (PendingIntent.CanceledException e) {

                    Log.e(TAG, "Pending intent was cancelled: " + e.getMessage());

                    mRecordingControllerLogger.logPendingIntentCancelled(e);

                }

            }

        };
@@ -227,9 +228,10 @@ public class RecordingController 
     */

    public void cancelCountdown() {

        if (mCountDownTimer != null) {

            mRecordingControllerLogger.logCountdownCancelled();

            mCountDownTimer.cancel();

        } else {

            Log.e(TAG, "Timer was null");

            mRecordingControllerLogger.logCountdownCancelErrorNoTimer();

        }

        mIsStarting = false;
@@ -258,16 +260,16 @@ public class RecordingController 
     * Stop the recording

     */

    public void stopRecording() {

        // TODO(b/332662551): Convert Logcat to LogBuffer.

        try {

            if (mStopIntent != null) {

                mRecordingControllerLogger.logRecordingStopped();

                mStopIntent.send(mInteractiveBroadcastOption);

            } else {

                Log.e(TAG, "Stop intent was null");

                mRecordingControllerLogger.logRecordingStopErrorNoStopIntent();

            }

            updateState(false);

        } catch (PendingIntent.CanceledException e) {

            Log.e(TAG, "Error stopping: " + e.getMessage());

            mRecordingControllerLogger.logRecordingStopError(e);

        }

    }
@@ -276,6 +278,7 @@ public class RecordingController 
     * @param isRecording

     */

    public synchronized void updateState(boolean isRecording) {

        mRecordingControllerLogger.logStateUpdated(isRecording);

        if (!isRecording && mIsRecording) {

            // Unregister receivers if we have stopped recording

            mUserTracker.removeCallback(mUserChangedCallback);

packages/SystemUI/src/com/android/systemui/screenrecord/RecordingControllerLog.kt

0 → 100644
+28 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.screenrecord



import javax.inject.Qualifier



/**

 * Logs for screen record events. See [com.android.systemui.screenrecord.RecordingController] and

 * [com.android.systemui.screenrecord.RecordingControllerLogger].

 */

@Qualifier

@MustBeDocumented

@Retention(AnnotationRetention.RUNTIME)

annotation class RecordingControllerLog

packages/SystemUI/src/com/android/systemui/screenrecord/RecordingControllerLogger.kt

0 → 100644
+77 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2024 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.screenrecord



import com.android.systemui.dagger.SysUISingleton

import com.android.systemui.log.LogBuffer

import com.android.systemui.log.core.LogLevel

import javax.inject.Inject



/** Helper class for logging events to [RecordingControllerLog] from Java. */

@SysUISingleton

class RecordingControllerLogger

@Inject

constructor(

    @RecordingControllerLog private val logger: LogBuffer,

) {

    fun logStateUpdated(isRecording: Boolean) =

        logger.log(

            TAG,

            LogLevel.DEBUG,

            { bool1 = isRecording },

            { "Updating state. isRecording=$bool1" },

        )



    fun logIntentStateUpdated(isRecording: Boolean) =

        logger.log(

            TAG,

            LogLevel.DEBUG,

            { bool1 = isRecording },

            { "Update intent has state. isRecording=$bool1" },

        )



    fun logIntentMissingState() =

        logger.log(TAG, LogLevel.ERROR, {}, { "Received update intent with no state" })



    fun logSentStartIntent() = logger.log(TAG, LogLevel.DEBUG, {}, { "Sent start intent" })



    fun logPendingIntentCancelled(e: Exception) =

        logger.log(TAG, LogLevel.ERROR, {}, { "Pending intent was cancelled" }, e)



    fun logCountdownCancelled() =

        logger.log(TAG, LogLevel.DEBUG, {}, { "Record countdown cancelled" })



    fun logCountdownCancelErrorNoTimer() =

        logger.log(TAG, LogLevel.ERROR, {}, { "Couldn't cancel countdown because timer was null" })



    fun logRecordingStopped() = logger.log(TAG, LogLevel.DEBUG, {}, { "Stopping recording" })



    fun logRecordingStopErrorNoStopIntent() =

        logger.log(

            TAG,

            LogLevel.ERROR,

            {},

            { "Couldn't stop recording because stop intent was null" },

        )



    fun logRecordingStopError(e: Exception) =

        logger.log(TAG, LogLevel.DEBUG, {}, { "Couldn't stop recording" }, e)



    companion object {

        private const val TAG = "RecordingController"

    }

}

packages/SystemUI/src/com/android/systemui/screenrecord/ScreenRecordModule.kt

+11 −1
Original line number Diff line number Diff line
@@ -16,6 +16,9 @@ 


package com.android.systemui.screenrecord



import com.android.systemui.dagger.SysUISingleton

import com.android.systemui.log.LogBuffer

import com.android.systemui.log.LogBufferFactory

import com.android.systemui.qs.QsEventLogger

import com.android.systemui.qs.pipeline.shared.TileSpec

import com.android.systemui.qs.tileimpl.QSTileImpl
@@ -89,5 +92,12 @@ interface ScreenRecordModule { 
                stateInteractor,

                mapper,

            )



        @Provides

        @SysUISingleton

        @RecordingControllerLog

        fun provideRecordingControllerLogBuffer(factory: LogBufferFactory): LogBuffer {

            return factory.create("RecordingControllerLog", 50)

        }

    }

}

packages/SystemUI/tests/src/com/android/systemui/screenrecord/RecordingControllerTest.java

+3 −4
Original line number Diff line number Diff line
@@ -18,6 +18,8 @@ package com.android.systemui.screenrecord; 


import static android.os.Process.myUid;



import static com.android.systemui.log.LogBufferHelperKt.logcatLogBuffer;



import static com.google.common.truth.Truth.assertThat;



import static junit.framework.Assert.assertFalse;
@@ -69,10 +71,6 @@ import org.mockito.MockitoAnnotations; 
@SmallTest

@RunWith(AndroidTestingRunner.class)

@TestableLooper.RunWithLooper(setAsMainLooper = true)

/**

 * Tests for exception handling and  bitmap configuration in adding smart actions to Screenshot

 * Notification.

 */

public class RecordingControllerTest extends SysuiTestCase {



    private static final int TEST_USER_ID = 12345;
@@ -146,6 +144,7 @@ public class RecordingControllerTest extends SysuiTestCase { 
                mFeatureFlags,

                () -> mDevicePolicyResolver,

                mUserTracker,

                new RecordingControllerLogger(logcatLogBuffer("RecordingControllerTest")),

                mMediaProjectionMetricsLogger,

                mScreenCaptureDisabledDialogDelegate,

                mScreenRecordDialogFactory,