Fix for issue 4629 (#5150)

* distinguish button and menu * reuse enum-Actions to distinguish user actions * avoid duplicating code in JabRefAction * updateforcrash * fixExceptClassActions * correctCheckstyle * try01 * tryforcheck
JabRef · Aug 24, 2019 · c6ded5d · c6ded5d
1 parent ad3e811
commit c6ded5d
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 6 deletions.
diff --git a/src/main/java/org/jabref/gui/JabRefFrame.java b/src/main/java/org/jabref/gui/JabRefFrame.java
@@ -1227,6 +1227,11 @@ public EditAction(Actions command) {
             this.command = command;
         }
 
+        @Override
+        public String toString() {
+            return this.command.toString();
+        }
+
         @Override
         public void execute() {
             Node focusOwner = mainStage.getScene().getFocusOwner();

diff --git a/src/main/java/org/jabref/gui/actions/ActionFactory.java b/src/main/java/org/jabref/gui/actions/ActionFactory.java
@@ -74,7 +74,7 @@ private static Label getAssociatedNode(MenuItem menuItem) {
     }
 
     public MenuItem configureMenuItem(Action action, Command command, MenuItem menuItem) {
-        ActionUtils.configureMenuItem(new JabRefAction(action, command, keyBindingRepository), menuItem);
+        ActionUtils.configureMenuItem(new JabRefAction(action, command, keyBindingRepository, Sources.FromMenu), menuItem);
         setGraphic(menuItem, action);
 
         // Show tooltips
@@ -105,7 +105,7 @@ public MenuItem createMenuItem(Action action, Command command) {
     }
 
     public CheckMenuItem createCheckMenuItem(Action action, Command command, boolean selected) {
-        CheckMenuItem checkMenuItem = ActionUtils.createCheckMenuItem(new JabRefAction(action, command, keyBindingRepository));
+        CheckMenuItem checkMenuItem = ActionUtils.createCheckMenuItem(new JabRefAction(action, command, keyBindingRepository, Sources.FromMenu));
         checkMenuItem.setSelected(selected);
         setGraphic(checkMenuItem, action);
 
@@ -127,7 +127,7 @@ public Menu createSubMenu(Action action, MenuItem... children) {
     }
 
     public Button createIconButton(Action action, Command command) {
-        Button button = ActionUtils.createButton(new JabRefAction(action, command, keyBindingRepository), ActionUtils.ActionTextBehavior.HIDE);
+        Button button = ActionUtils.createButton(new JabRefAction(action, command, keyBindingRepository, Sources.FromButton), ActionUtils.ActionTextBehavior.HIDE);
 
         button.getStyleClass().setAll("icon-button");
 
@@ -140,7 +140,7 @@ public Button createIconButton(Action action, Command command) {
 
     public ButtonBase configureIconButton(Action action, Command command, ButtonBase button) {
         ActionUtils.configureButton(
-                new JabRefAction(action, command, keyBindingRepository),
+                                    new JabRefAction(action, command, keyBindingRepository, Sources.FromButton),
                 button,
                 ActionUtils.ActionTextBehavior.HIDE);
 

diff --git a/src/main/java/org/jabref/gui/actions/JabRefAction.java b/src/main/java/org/jabref/gui/actions/JabRefAction.java
@@ -1,5 +1,8 @@
 package org.jabref.gui.actions;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import javafx.beans.binding.Bindings;
 
 import org.jabref.Globals;
@@ -23,11 +26,23 @@ public JabRefAction(Action action, KeyBindingRepository keyBindingRepository) {
     }
 
     public JabRefAction(Action action, Command command, KeyBindingRepository keyBindingRepository) {
+        this(action, command, keyBindingRepository, null);
+    }
+
+    /**
+     * especially for the track execute when the action run the same function but from different source.
+     * @param source is a string contains the source, for example "button"
+     */
+    public JabRefAction(Action action, Command command, KeyBindingRepository keyBindingRepository, Sources source) {
         this(action, keyBindingRepository);
 
         setEventHandler(event -> {
             command.execute();
-            trackExecute(getActionName(action, command));
+            if (source == null) {
+                trackExecute(getActionName(action, command));
+            } else {
+                trackUserActionSource(getActionName(action, command), source);
+            }
         });
 
         disabledProperty().bind(command.executableProperty().not());
@@ -42,12 +57,25 @@ private String getActionName(Action action, Command command) {
         if (command.getClass().isAnonymousClass()) {
             return action.getText();
         } else {
-            return command.getClass().getSimpleName();
+            String commandName = command.getClass().getSimpleName();
+            if ((command instanceof OldDatabaseCommandWrapper) || (command instanceof OldCommandWrapper) || commandName.contains("EditAction")) {
+                return command.toString();
+            } else {
+                return commandName;
+            }
         }
     }
 
     private void trackExecute(String actionName) {
         Globals.getTelemetryClient()
                .ifPresent(telemetryClient -> telemetryClient.trackEvent(actionName));
     }
+
+    private void trackUserActionSource(String actionName, Sources source) {
+        Map<String, String> properties = new HashMap<>();
+        Map<String, Double> measurements = new HashMap<>();
+        properties.put("Source", source.toString());
+
+        Globals.getTelemetryClient().ifPresent(telemetryClient -> telemetryClient.trackEvent(actionName, properties, measurements));
+    }
 }
diff --git a/src/main/java/org/jabref/gui/actions/OldCommandWrapper.java b/src/main/java/org/jabref/gui/actions/OldCommandWrapper.java
@@ -48,4 +48,9 @@ public ReadOnlyDoubleProperty progressProperty() {
     public void setExecutable(boolean executable) {
         this.executable.bind(BindingsHelper.constantOf(executable));
     }
+
+    @Override
+    public String toString() {
+        return this.command.toString();
+    }
 }
diff --git a/src/main/java/org/jabref/gui/actions/OldDatabaseCommandWrapper.java b/src/main/java/org/jabref/gui/actions/OldDatabaseCommandWrapper.java
@@ -51,6 +51,11 @@ public double getProgress() {
         return 0;
     }
 
+    @Override
+    public String toString() {
+        return this.command.toString();
+    }
+
     @Override
     public ReadOnlyDoubleProperty progressProperty() {
         return null;

diff --git a/src/main/java/org/jabref/gui/actions/Sources.java b/src/main/java/org/jabref/gui/actions/Sources.java
@@ -0,0 +1,7 @@
+package org.jabref.gui.actions;
+
+public enum Sources {
+    FromButton,
+    FromMenu
+
+}