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

Commit 67419e59 authored by Jason Chang's avatar Jason Chang
Browse files

Add UiEventLogger to log One-Handed Mode metrics via Westworld. 

To log One-Handed Mode events via Westworld by using go/uievent.

Bug: 149366439

Test: manual
Test: Test-drive by command: adb shell cmd stats print-logs
      && adb logcat -s statsd:I | grep ' (90)'
Test: atest SystemUITests:OneHandedEventsTest

Change-Id: If940d0f1901bfdbca6dafec2c0c1391a6fb63461
parent 0d127dd5

packages/SystemUI/src/com/android/systemui/onehanded/OneHandedEvents.java

0 → 100644
+270 −0
Original line number Original line 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.onehanded;



import android.util.Log;



import com.android.internal.annotations.VisibleForTesting;

import com.android.internal.logging.UiEvent;

import com.android.internal.logging.UiEventLogger;

import com.android.internal.logging.UiEventLoggerImpl;



/**

 *  Interesting events related to the One-Handed.

 */

public class OneHandedEvents {

    private static final String TAG = "OneHandedEvents";



    public static Callback sCallback;

    @VisibleForTesting

    static UiEventLogger sUiEventLogger = new UiEventLoggerImpl();



    /**

     * One-Handed event types

     */

    // Triggers

    public static final int EVENT_ONE_HANDED_TRIGGER_GESTURE_IN = 0;

    public static final int EVENT_ONE_HANDED_TRIGGER_GESTURE_OUT = 1;

    public static final int EVENT_ONE_HANDED_TRIGGER_OVERSPACE_OUT = 2;

    public static final int EVENT_ONE_HANDED_TRIGGER_POP_IME_OUT = 3;

    public static final int EVENT_ONE_HANDED_TRIGGER_ROTATION_OUT = 4;

    public static final int EVENT_ONE_HANDED_TRIGGER_APP_TAPS_OUT = 5;

    public static final int EVENT_ONE_HANDED_TRIGGER_TIMEOUT_OUT = 6;

    // Settings toggles

    public static final int EVENT_ONE_HANDED_SETTINGS_ENABLED_ON = 7;

    public static final int EVENT_ONE_HANDED_SETTINGS_ENABLED_OFF = 8;

    public static final int EVENT_ONE_HANDED_SETTINGS_APP_TAPS_EXIT_ON = 9;

    public static final int EVENT_ONE_HANDED_SETTINGS_APP_TAPS_EXIT_OFF = 10;

    public static final int EVENT_ONE_HANDED_SETTINGS_TIMEOUT_EXIT_ON = 11;

    public static final int EVENT_ONE_HANDED_SETTINGS_TIMEOUT_EXIT_OFF = 12;

    public static final int EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_NEVER = 13;

    public static final int EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_4 = 14;

    public static final int EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_8 = 15;

    public static final int EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_12 = 16;



    private static final String[] EVENT_TAGS = {

            "one_handed_trigger_gesture_in",

            "one_handed_trigger_gesture_out",

            "one_handed_trigger_overspace_out",

            "one_handed_trigger_pop_ime_out",

            "one_handed_trigger_rotation_out",

            "one_handed_trigger_app_taps_out",

            "one_handed_trigger_timeout_out",

            "one_handed_settings_enabled_on",

            "one_handed_settings_enabled_off",

            "one_handed_settings_app_taps_exit_on",

            "one_handed_settings_app_taps_exit_off",

            "one_handed_settings_timeout_exit_on",

            "one_handed_settings_timeout_exit_off",

            "one_handed_settings_timeout_seconds_never",

            "one_handed_settings_timeout_seconds_4",

            "one_handed_settings_timeout_seconds_8",

            "one_handed_settings_timeout_seconds_12"

    };



    /**

     * Events definition that related to One-Handed gestures.

     */

    @VisibleForTesting

    public enum OneHandedTriggerEvent implements UiEventLogger.UiEventEnum {

        INVALID(0),

        @UiEvent(doc = "One-Handed trigger in via NavigationBar area")

        ONE_HANDED_TRIGGER_GESTURE_IN(366),



        @UiEvent(doc = "One-Handed trigger out via NavigationBar area")

        ONE_HANDED_TRIGGER_GESTURE_OUT(367),



        @UiEvent(doc = "One-Handed trigger out via Overspace area")

        ONE_HANDED_TRIGGER_OVERSPACE_OUT(368),



        @UiEvent(doc = "One-Handed trigger out while IME pop up")

        ONE_HANDED_TRIGGER_POP_IME_OUT(369),



        @UiEvent(doc = "One-Handed trigger out while device rotation to landscape")

        ONE_HANDED_TRIGGER_ROTATION_OUT(370),



        @UiEvent(doc = "One-Handed trigger out when an Activity is launching")

        ONE_HANDED_TRIGGER_APP_TAPS_OUT(371),



        @UiEvent(doc = "One-Handed trigger out when one-handed mode times up")

        ONE_HANDED_TRIGGER_TIMEOUT_OUT(372);



        private final int mId;



        OneHandedTriggerEvent(int id) {

            mId = id;

        }



        public int getId() {

            return mId;

        }

    }



    /**

     * Events definition that related to Settings toggles.

     */

    @VisibleForTesting

    public enum OneHandedSettingsTogglesEvent implements UiEventLogger.UiEventEnum {

        INVALID(0),

        @UiEvent(doc = "One-Handed mode enabled toggle on")

        ONE_HANDED_SETTINGS_TOGGLES_ENABLED_ON(356),



        @UiEvent(doc = "One-Handed mode enabled toggle off")

        ONE_HANDED_SETTINGS_TOGGLES_ENABLED_OFF(357),



        @UiEvent(doc = "One-Handed mode app-taps-exit toggle on")

        ONE_HANDED_SETTINGS_TOGGLES_APP_TAPS_EXIT_ON(358),



        @UiEvent(doc = "One-Handed mode app-taps-exit toggle off")

        ONE_HANDED_SETTINGS_TOGGLES_APP_TAPS_EXIT_OFF(359),



        @UiEvent(doc = "One-Handed mode timeout-exit toggle on")

        ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_EXIT_ON(360),



        @UiEvent(doc = "One-Handed mode timeout-exit toggle off")

        ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_EXIT_OFF(361),



        @UiEvent(doc = "One-Handed mode timeout value changed to never timeout")

        ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_NEVER(362),



        @UiEvent(doc = "One-Handed mode timeout value changed to 4 seconds")

        ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_4(363),



        @UiEvent(doc = "One-Handed mode timeout value changed to 8 seconds")

        ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_8(364),



        @UiEvent(doc = "One-Handed mode timeout value changed to 12 seconds")

        ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_12(365);



        private final int mId;



        OneHandedSettingsTogglesEvent(int id) {

            mId = id;

        }



        public int getId() {

            return mId;

        }

    }





    /**

     * Logs an event to the system log, to sCallback if present, and to the logEvent destinations.

     * @param tag One of the EVENT_* codes above.

     */

    public static void writeEvent(int tag) {

        final long time = System.currentTimeMillis();

        Log.i(TAG, logEvent(tag));

        if (sCallback != null) {

            sCallback.writeEvent(time, tag);

        }

    }



    /**

     * Logs an event to the UiEvent (Westworld) logging.

     * @param event One of the EVENT_* codes above.

     * @return String a readable description of the event.  Begins "writeEvent <tag_description>"

     * if the tag is valid.

     */

    public static String logEvent(int event) {

        if (event >= EVENT_TAGS.length) {

            return "";

        }

        final StringBuilder sb = new StringBuilder("writeEvent ").append(EVENT_TAGS[event]);

        switch (event) {

            // Triggers

            case EVENT_ONE_HANDED_TRIGGER_GESTURE_IN:

                sUiEventLogger.log(OneHandedTriggerEvent.ONE_HANDED_TRIGGER_GESTURE_IN);

                break;

            case EVENT_ONE_HANDED_TRIGGER_GESTURE_OUT:

                sUiEventLogger.log(OneHandedTriggerEvent.ONE_HANDED_TRIGGER_GESTURE_OUT);

                break;

            case EVENT_ONE_HANDED_TRIGGER_OVERSPACE_OUT:

                sUiEventLogger.log(OneHandedTriggerEvent.ONE_HANDED_TRIGGER_OVERSPACE_OUT);

                break;

            case EVENT_ONE_HANDED_TRIGGER_POP_IME_OUT:

                sUiEventLogger.log(OneHandedTriggerEvent.ONE_HANDED_TRIGGER_POP_IME_OUT);

                break;

            case EVENT_ONE_HANDED_TRIGGER_ROTATION_OUT:

                sUiEventLogger.log(OneHandedTriggerEvent.ONE_HANDED_TRIGGER_ROTATION_OUT);

                break;

            case EVENT_ONE_HANDED_TRIGGER_APP_TAPS_OUT:

                sUiEventLogger.log(OneHandedTriggerEvent.ONE_HANDED_TRIGGER_APP_TAPS_OUT);

                break;

            case EVENT_ONE_HANDED_TRIGGER_TIMEOUT_OUT:

                sUiEventLogger.log(OneHandedTriggerEvent.ONE_HANDED_TRIGGER_TIMEOUT_OUT);

                break;

            // Settings

            case EVENT_ONE_HANDED_SETTINGS_ENABLED_ON:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_ENABLED_ON);

                break;

            case EVENT_ONE_HANDED_SETTINGS_ENABLED_OFF:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_ENABLED_OFF);

                break;

            case EVENT_ONE_HANDED_SETTINGS_APP_TAPS_EXIT_ON:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_APP_TAPS_EXIT_ON);

                break;

            case EVENT_ONE_HANDED_SETTINGS_APP_TAPS_EXIT_OFF:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_APP_TAPS_EXIT_OFF);

                break;

            case EVENT_ONE_HANDED_SETTINGS_TIMEOUT_EXIT_ON:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_EXIT_ON);

                break;

            case EVENT_ONE_HANDED_SETTINGS_TIMEOUT_EXIT_OFF:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_EXIT_OFF);

                break;

            case EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_NEVER:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_NEVER);

                break;

            case EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_4:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_4);

                break;

            case EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_8:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_8);

                break;

            case EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_12:

                sUiEventLogger.log(OneHandedSettingsTogglesEvent

                        .ONE_HANDED_SETTINGS_TOGGLES_TIMEOUT_SECONDS_12);

                break;

            default:

                // Do nothing

                break;

        }

        return sb.toString();

    }



    /**

     * An interface for logging an event to the system log, if Callback present.

     */

    public interface Callback {

        /**

         *

         * @param time System current time.

         * @param tag Event tag.

         */

        void writeEvent(long time, int tag);

    }

}

packages/SystemUI/tests/src/com/android/systemui/onehanded/OneHandedEventsTest.java

0 → 100644
+104 −0
Original line number Original line 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.onehanded;



import static org.junit.Assert.assertEquals;



import androidx.test.filters.SmallTest;



import com.android.internal.logging.UiEventLogger;

import com.android.internal.logging.testing.UiEventLoggerFake;

import com.android.systemui.SysuiTestCase;



import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.junit.runners.Parameterized;



import java.util.Arrays;

import java.util.Collection;



@RunWith(Parameterized.class)

@SmallTest

public class OneHandedEventsTest extends SysuiTestCase {



    private UiEventLoggerFake mUiEventLogger;



    @Parameterized.Parameter

    public int mTag;



    @Parameterized.Parameter(1)

    public String mExpectedMessage;



    public UiEventLogger.UiEventEnum mUiEvent;



    @Before

    public void setFakeLoggers() {

        mUiEventLogger = new UiEventLoggerFake();

        OneHandedEvents.sUiEventLogger = mUiEventLogger;

    }



    @Test

    public void testLogEvent() {

        if (mUiEvent != null) {

            assertEquals(1, mUiEventLogger.numLogs());

            assertEquals(mUiEvent.getId(), mUiEventLogger.eventId(0));

        }

    }



    @Parameterized.Parameters(name = "{index}: {2}")

    public static Collection<Object[]> data() {

        return Arrays.asList(new Object[][]{

                // Triggers

                {OneHandedEvents.EVENT_ONE_HANDED_TRIGGER_GESTURE_IN,

                        "writeEvent one_handed_trigger_gesture_in"},

                {OneHandedEvents.EVENT_ONE_HANDED_TRIGGER_GESTURE_OUT,

                        "writeEvent one_handed_trigger_gesture_out"},

                {OneHandedEvents.EVENT_ONE_HANDED_TRIGGER_OVERSPACE_OUT,

                        "writeEvent one_handed_trigger_overspace_out"},

                {OneHandedEvents.EVENT_ONE_HANDED_TRIGGER_POP_IME_OUT,

                        "writeEvent one_handed_trigger_pop_ime_out"},

                {OneHandedEvents.EVENT_ONE_HANDED_TRIGGER_ROTATION_OUT,

                        "writeEvent one_handed_trigger_rotation_out"},

                {OneHandedEvents.EVENT_ONE_HANDED_TRIGGER_APP_TAPS_OUT,

                        "writeEvent one_handed_trigger_app_taps_out"},

                {OneHandedEvents.EVENT_ONE_HANDED_TRIGGER_TIMEOUT_OUT,

                        "writeEvent one_handed_trigger_timeout_out"},

                // Settings toggles

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_ENABLED_ON,

                        "writeEvent one_handed_settings_enabled_on"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_ENABLED_OFF,

                        "writeEvent one_handed_settings_enabled_off"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_APP_TAPS_EXIT_ON,

                        "writeEvent one_handed_settings_app_taps_exit_on"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_APP_TAPS_EXIT_OFF,

                        "writeEvent one_handed_settings_app_taps_exit_off"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_TIMEOUT_EXIT_ON,

                        "writeEvent one_handed_settings_timeout_exit_on"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_TIMEOUT_EXIT_OFF,

                        "writeEvent one_handed_settings_timeout_exit_off"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_NEVER,

                        "writeEvent one_handed_settings_timeout_seconds_never"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_4,

                        "writeEvent one_handed_settings_timeout_seconds_4"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_8,

                        "writeEvent one_handed_settings_timeout_seconds_8"},

                {OneHandedEvents.EVENT_ONE_HANDED_SETTINGS_TIMEOUT_SECONDS_12,

                        "writeEvent one_handed_settings_timeout_seconds_12"}

        });

    }

}