lawnchair/src/com/android/launcher3/logging/StatsLogManager.java

/*
 * Copyright (C) 2018 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.launcher3.logging;

import android.content.Context;
import android.util.Log;

import com.android.launcher3.R;
import com.android.launcher3.logger.LauncherAtom;
import com.android.launcher3.logger.LauncherAtom.ItemInfo;
import com.android.launcher3.logging.StatsLogUtils.LogStateProvider;
import com.android.launcher3.util.ResourceBasedOverride;

/**
 * Handles the user event logging in R+.
 */
public class StatsLogManager implements ResourceBasedOverride {

    private static final String TAG = "StatsLogManager";

    interface EventEnum {
        int getId();
    }

    public enum LauncherEvent implements EventEnum {
        @LauncherUiEvent(doc = "App launched from workspace, hotseat or folder in launcher")
        APP_LAUNCH_TAP(1),
        @LauncherUiEvent(doc = "Task launched from overview using TAP")
        TASK_LAUNCH_TAP(2),
        @LauncherUiEvent(doc = "Task launched from overview using SWIPE DOWN")
        TASK_LAUNCH_SWIPE_DOWN(2),
        @LauncherUiEvent(doc = "TASK dismissed from overview using SWIPE UP")
        TASK_DISMISS_SWIPE_UP(3),
        @LauncherUiEvent(doc = "User dragged a launcher item")
        LAUNCHER_ITEM_DRAG_STARTED(383),
        @LauncherUiEvent(doc = "A dragged launcher item is successfully dropped")
        LAUNCHER_ITEM_DROP_COMPLETED(385);
        // ADD MORE

        private final int mId;
        LauncherEvent(int id) {
            mId = id;
        }
        public int getId() {
            return mId;
        }
    }

    protected LogStateProvider mStateProvider;

    /**
     * Creates a new instance of {@link StatsLogManager} based on provided context.
     */
    public static StatsLogManager newInstance(Context context) {
        return newInstance(context, null);
    }

    public static StatsLogManager newInstance(Context context, LogStateProvider stateProvider) {
        StatsLogManager mgr = Overrides.getObject(StatsLogManager.class,
                context.getApplicationContext(), R.string.stats_log_manager_class);
        mgr.mStateProvider = stateProvider;
        mgr.verify();
        return mgr;
    }

    /**
     * Logs an event and accompanying {@link ItemInfo}
     */
    public void log(LauncherEvent event, LauncherAtom.ItemInfo itemInfo) {
        Log.d(TAG, String.format("%s\n%s", event.name(), itemInfo));
        // Call StatsLog method
    }

    /**
     * Logs an event and accompanying {@link ItemInfo}
     */
    public void log(LauncherEvent event, int instanceId, LauncherAtom.ItemInfo itemInfo) {
        Log.d(TAG, String.format("%s(InstanceId:%s)\n%s", event.name(), instanceId, itemInfo));
        // Call StatsLog method
    }

    /**
     * Logs snapshot, or impression of the current workspace.
     */
    public void logSnapshot() { }

    public void verify() {}     // TODO: should move into robo tests
}