Action analytics (#2233)

pq · web-flow · commit 1a4ca2fdade4 · 2018-05-16T10:34:27.000-07:00
* Flutter View Action analytics.

* cleaned up imports

* Analytics for “open in…” actions.

* rebase of flutterview

* open module analytics

* rebase

* rebase and renames
diff --git a/flutter-studio/src/io/flutter/actions/OpenAndroidModule.java b/flutter-studio/src/io/flutter/actions/OpenAndroidModule.java
@@ -33,7 +33,7 @@
  */
 public class OpenAndroidModule extends OpenInAndroidStudioAction implements DumbAware {
   @Override
-  public void actionPerformed(AnActionEvent e) {
+  public void performAction(AnActionEvent e) {
     final VirtualFile projectFile = findProjectFile(e);
     if (projectFile == null) {
       FlutterMessages.showError("Error Opening Android Studio", "Project not found.");
@@ -52,6 +52,12 @@ public void actionPerformed(AnActionEvent e) {
     openOrImportProject(projectFile, e.getProject(), sourceFile, forceOpenInNewFrame);
   }
 
+  @NotNull
+  @Override
+  public String getAnalyticsId() {
+    return "OpenModuleInAndroidStudio";
+  }
+
   private static void openOrImportProject(@NotNull VirtualFile projectFile,
                                           @Nullable Project project,
                                           @Nullable VirtualFile sourceFile,
diff --git a/src/io/flutter/actions/ActionWithAnalytics.java b/src/io/flutter/actions/ActionWithAnalytics.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2018 The Chromium Authors. All rights reserved.
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+package io.flutter.actions;
+
+import com.intellij.openapi.actionSystem.AnAction;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import io.flutter.FlutterInitializer;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * An action that sends analytics when performed.
+ */
+public abstract class ActionWithAnalytics extends AnAction {
+
+  /**
+   * Template method.  Implement @performAction.
+   */
+  @Override
+  public final void actionPerformed(AnActionEvent e) {
+    FlutterInitializer.getAnalytics().sendEvent("flutter", getAnalyticsId());
+    performAction(e);
+  }
+
+  /**
+   * Return the unique analytics Id for this action.
+   */
+  @NotNull
+  public abstract String getAnalyticsId();
+
+  /**
+   * Perform the action.
+   *
+   * Called by @actionPerformed.
+   */
+  public abstract void performAction(AnActionEvent e);
+}
diff --git a/src/io/flutter/actions/OpenInAndroidStudioAction.java b/src/io/flutter/actions/OpenInAndroidStudioAction.java
@@ -10,7 +10,6 @@
 import com.intellij.execution.process.OSProcessHandler;
 import com.intellij.execution.process.ProcessAdapter;
 import com.intellij.execution.process.ProcessEvent;
-import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.CommonDataKeys;
 import com.intellij.openapi.actionSystem.Presentation;
@@ -28,7 +27,7 @@
 
 import java.io.File;
 
-public class OpenInAndroidStudioAction extends AnAction {
+public class OpenInAndroidStudioAction extends ActionWithAnalytics {
 
   private static final String LABEL_FILE = FlutterBundle.message("flutter.androidstudio.open.file.text");
   private static final String DESCR_FILE = FlutterBundle.message("flutter.androidstudio.open.file.description");
@@ -40,8 +39,14 @@ public void update(AnActionEvent event) {
     updatePresentation(event, event.getPresentation());
   }
 
+  @NotNull
   @Override
-  public void actionPerformed(AnActionEvent e) {
+  public String getAnalyticsId() {
+    return "OpenInAndroidStudio";
+  }
+
+  @Override
+  public void performAction(AnActionEvent e) {
     final String androidStudioPath = findAndroidStudio(e.getProject());
     if (androidStudioPath == null) {
       FlutterMessages.showError("Error Opening Android Studio", "Unable to locate Android Studio.");
diff --git a/src/io/flutter/actions/OpenInXcodeAction.java b/src/io/flutter/actions/OpenInXcodeAction.java
@@ -10,7 +10,6 @@
 import com.intellij.execution.process.OSProcessHandler;
 import com.intellij.execution.process.ProcessAdapter;
 import com.intellij.execution.process.ProcessEvent;
-import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.CommonDataKeys;
 import com.intellij.openapi.actionSystem.Presentation;
@@ -27,7 +26,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-public class OpenInXcodeAction extends AnAction {
+public class OpenInXcodeAction extends ActionWithAnalytics {
   private static VirtualFile findProjectFile(@Nullable AnActionEvent e) {
     if (e != null) {
       final VirtualFile file = CommonDataKeys.VIRTUAL_FILE.getData(e.getDataContext());
@@ -141,8 +140,14 @@ public void update(AnActionEvent event) {
     }
   }
 
+  @NotNull
   @Override
-  public void actionPerformed(AnActionEvent e) {
+  public String getAnalyticsId() {
+    return "OpenInXcode";
+  }
+
+  @Override
+  public void performAction(AnActionEvent e) {
     final VirtualFile projectFile = findProjectFile(e);
     if (projectFile != null) {
       openFile(projectFile);
diff --git a/src/io/flutter/editor/NativeEditorNotificationProvider.java b/src/io/flutter/editor/NativeEditorNotificationProvider.java
@@ -16,13 +16,30 @@
 import com.intellij.ui.EditorNotificationPanel;
 import com.intellij.ui.EditorNotifications;
 import icons.FlutterIcons;
-import org.jetbrains.annotations.NonNls;
+import io.flutter.actions.ActionWithAnalytics;
+import io.flutter.actions.OpenInXcodeAction;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 public class NativeEditorNotificationProvider extends EditorNotifications.Provider<EditorNotificationPanel> implements DumbAware {
   private static final Key<EditorNotificationPanel> KEY = Key.create("flutter.native.editor.notification");
 
+  private static final ActionWithAnalytics OPEN_IN_XCODE_ACTION = new OpenInXcodeAction() {
+    @NotNull
+    @Override
+    public String getAnalyticsId() {
+      return "OpenInXcode.banner";
+    }
+  };
+
+  private static final ActionWithAnalytics OPEN_IN_ANDROID_STUDIO_ACTION = new OpenInXcodeAction() {
+    @NotNull
+    @Override
+    public String getAnalyticsId() {
+      return "OpenInAndroidStudio.banner";
+    }
+  };
+
   private final Project myProject;
 
   public NativeEditorNotificationProvider(@NotNull Project project) {
@@ -48,26 +65,26 @@ private EditorNotificationPanel createPanelForFile(VirtualFile file, VirtualFile
     if (root == null) {
       return null;
     }
-    return createPanelForAction(file, root, getActionName(root));
+    return createPanelForAction(file, root, getAction(root));
   }
 
-  private EditorNotificationPanel createPanelForAction(VirtualFile file, VirtualFile root, String actionName) {
-    if (actionName == null) {
+  private EditorNotificationPanel createPanelForAction(VirtualFile file, VirtualFile root, AnAction action) {
+    if (action == null) {
       return null;
     }
-    NativeEditorActionsPanel panel = new NativeEditorActionsPanel(file, root, actionName);
+    NativeEditorActionsPanel panel = new NativeEditorActionsPanel(file, root, action);
     return panel.isValidForFile() ? panel : null;
   }
 
-  private static String getActionName(VirtualFile root) {
+  private static AnAction getAction(VirtualFile root) {
     if (root == null) {
       return null;
     }
     if (root.getName().equals("android")) {
-      return "flutter.androidstudio.open";
+      return OPEN_IN_ANDROID_STUDIO_ACTION;
     }
     else if (root.getName().equals("ios")) {
-      return "flutter.xcode.open";
+      return OPEN_IN_XCODE_ACTION;
     }
     else {
       return null;
@@ -97,11 +114,11 @@ class NativeEditorActionsPanel extends EditorNotificationPanel {
     final AnAction myAction;
     final boolean isVisible;
 
-    NativeEditorActionsPanel(VirtualFile file, VirtualFile root, String actionName) {
+    NativeEditorActionsPanel(VirtualFile file, VirtualFile root, AnAction openAction) {
       super(EditorColors.GUTTER_BACKGROUND);
       myFile = file;
       myRoot = root;
-      myAction = ActionManager.getInstance().getAction(actionName);
+      myAction = openAction;
 
       icon(FlutterIcons.Flutter);
       text("Flutter commands");
@@ -128,18 +145,14 @@ private void performAction() {
     }
 
     private DataContext makeContext() {
-      return new DataContext() {
-        @Override
-        @Nullable
-        public Object getData(@NonNls String dataId) {
-          if (CommonDataKeys.VIRTUAL_FILE.is(dataId)) {
-            return myFile;
-          }
-          if (CommonDataKeys.PROJECT.is(dataId)) {
-            return myProject;
-          }
-          return null;
+      return dataId -> {
+        if (CommonDataKeys.VIRTUAL_FILE.is(dataId)) {
+          return myFile;
+        }
+        if (CommonDataKeys.PROJECT.is(dataId)) {
+          return myProject;
         }
+        return null;
       };
     }
   }
diff --git a/src/io/flutter/view/FlutterView.java b/src/io/flutter/view/FlutterView.java
@@ -999,4 +999,3 @@ private static DefaultActionGroup createPopupActionGroup(FlutterView view, Flutt
     return group;
   }
 }
-

Original file line number	Diff line number	Diff line change
`@@ -999,4 +999,3 @@ private static DefaultActionGroup createPopupActionGroup(FlutterView view, Flutt`
`999`	`999`	`return group;`
`1000`	`1000`	`}`
`1001`	`1001`	`}`
`1002`		`-`