Plugin now knows who opened a given display

daykin · daykin · commit b4e92635793c · 2024-06-19T17:38:28.000-04:00
diff --git a/app/display/representation/src/main/java/org/csstudio/display/builder/representation/ToolkitListener.java b/app/display/representation/src/main/java/org/csstudio/display/builder/representation/ToolkitListener.java
@@ -44,4 +44,7 @@ public interface ToolkitListener
      *  @param value The value
      */
     default public void handleWrite(Widget widget, Object value) {};
+
+    default public void handleMethodCalled(Object... user_args) {};
+
 }
diff --git a/app/display/representation/src/main/java/org/csstudio/display/builder/representation/ToolkitRepresentation.java b/app/display/representation/src/main/java/org/csstudio/display/builder/representation/ToolkitRepresentation.java
@@ -74,7 +74,7 @@ abstract public class ToolkitRepresentation<TWP extends Object, TW> implements E
     private final RepresentationUpdateThrottle throttle = new RepresentationUpdateThrottle(this);
 
     /** Listener list */
-    private final List<ToolkitListener> listeners = new CopyOnWriteArrayList<>();
+    protected final List<ToolkitListener> listeners = new CopyOnWriteArrayList<>();
 
     /** Add/remove representations for child elements as model changes */
     private final WidgetPropertyListener<List<Widget>> container_children_listener = (children, removed, added) ->
@@ -689,6 +689,20 @@ public void fireWrite(final Widget widget, final Object value)
         }
     }
 
+    public void fireMethodCall(Object... user_args) {
+        for (final ToolkitListener listener : listeners)
+        {
+            try
+            {
+                listener.handleMethodCalled(user_args);
+            }
+            catch (final Throwable ex)
+            {
+                logger.log(Level.WARNING, "Failure when firing method-call event for " + Thread.currentThread().getStackTrace()[1].getMethodName(), ex);
+            }
+        }
+    };
+
     /** Close the toolkit's "window" that displays a model
      *  @param model Model that has been represented in this toolkit
      *  @throws Exception on error
diff --git a/app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/DisplayRuntimeInstance.java b/app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/DisplayRuntimeInstance.java
@@ -294,6 +294,8 @@ public void loadDisplayFile(final DisplayInfo info)
         // another instance
         dock_item.setInput(info.toURI());
 
+        representation.fireMethodCall((Object)display_info);
+
         // Now that old model is no longer represented,
         // show info.
         // Showing this info before disposeModel()
@@ -452,7 +454,6 @@ void trackCurrentModel(final DisplayModel model)
         // setInput sets the tab name based on the input via runLater.
         // Update to the display name via another runLater.
         Platform.runLater(() -> dock_item.setLabel(info.getName()));
-
         navigation.setCurrentDisplay(info);
         active_model = model;
     }
diff --git a/app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/DockItemRepresentation.java b/app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/app/DockItemRepresentation.java
@@ -14,6 +14,7 @@
 
 import org.csstudio.display.builder.model.DisplayModel;
 import org.csstudio.display.builder.model.Widget;
+import org.csstudio.display.builder.representation.ToolkitListener;
 import org.csstudio.display.builder.representation.ToolkitRepresentation;
 import org.csstudio.display.builder.representation.javafx.JFXRepresentation;
 import org.phoebus.framework.workbench.ApplicationService;
diff --git a/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ActiveTab.java b/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ActiveTab.java
@@ -43,6 +43,7 @@ public ActiveTab(DockItemWithInput tab){
         toolkitListener = new UXAToolkitListener();
         ((UXAToolkitListener)toolkitListener).setTabWrapper(this);
         ((DisplayRuntimeInstance)tab.getProperties().get("application")).addListener(toolkitListener);
+        ((DisplayRuntimeInstance)tab.getProperties().get("application")).addListener(toolkitListener);
         jfxNode = tab.getContent();
         mouseMonitor = new UXAMouseMonitor(this);
         jfxNode.addEventFilter(MouseEvent.MOUSE_CLICKED, mouseMonitor);
diff --git a/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ActiveTabsOfWindow.java b/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ActiveTabsOfWindow.java
@@ -17,6 +17,11 @@ public ActiveTabsOfWindow(Window window){
         activeWindowsService = ActiveWindowsService.getInstance();
     }
 
+    public void add(ActiveTab tab) throws Exception {
+        this.remove(tab);
+        activeTabs.putIfAbsent(tab.toString(), tab);
+    }
+
     public void add(DockItemWithInput tab) throws Exception {
         this.remove(tab);
         activeTabs.putIfAbsent(tab.toString(), new ActiveTab(tab));
@@ -29,6 +34,13 @@ public void remove(DockItemWithInput tab){
         }
     }
 
+    public void remove(ActiveTab tab){
+        if(activeTabs.containsKey(tab.toString())){
+            activeTabs.get(tab.toString()).close();
+            activeTabs.remove(tab.toString());
+        }
+    }
+
     public boolean contains(DockItemWithInput tab){
         return activeTabs.containsKey(tab.toString());
     }
@@ -37,8 +49,6 @@ public synchronized void addWidget(DockItemWithInput tab, Widget widget){
         activeTabs.get(tab.toString()).add(widget);
     }
 
-
-
     public ConcurrentHashMap<String, ActiveTab> getActiveTabs() {
         return activeTabs;
     }
diff --git a/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ActiveWindowsService.java b/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ActiveWindowsService.java
@@ -5,6 +5,7 @@
 import javafx.stage.Stage;
 import javafx.stage.Window;
 
+import net.dongliu.commons.Sys;
 import org.csstudio.display.builder.runtime.app.DisplayRuntimeInstance;
 import org.phoebus.ui.docking.DockItemWithInput;
 import org.phoebus.ui.docking.DockPane;
@@ -34,20 +35,21 @@ public void onChanged(Change<? extends Tab> change) {
                         Window window = change.getList().get(0).getTabPane().getScene().getWindow();
                         if(tab.getProperties().get("application") instanceof DisplayRuntimeInstance && tab instanceof DockItemWithInput){
 
-                            //When @DockItem s are initialized, their models aren't ready yet.
-                            //On startup, the DockItemWithInput will show up but its DisplayModel will be null.
-                            //block until the model is ready, in an individual background thread.
                             try {
+                                //Creating the wrapper object first (in the application thread) attaches a listener ASAP
+                                //we want to catch what caused the display to open
+                                ActiveTab tabWrapper = new ActiveTab((DockItemWithInput) tab);
+                                DisplayRuntimeInstance instance = (DisplayRuntimeInstance) tabWrapper.getParentTab().getProperties().get("application");
+                                //When @DockItem s are initialized, their models aren't ready yet.
+                                //On startup, the DockItemWithInput will show up but its DisplayModel will be null.
+                                //block until the model is ready, in an individual background thread.
                                 new Thread(() -> {
                                     try {
-                                        DisplayRuntimeInstance instance = ((DisplayRuntimeInstance) tab.getProperties().get("application"));
                                         //block until the model is ready
                                         instance.getRepresentation_init().get();
                                         lock.lock();
                                         String windowID = (String) window.getProperties().get(DockStage.KEY_ID);
-
-                                        DockItemWithInput diwi = (DockItemWithInput)tab;
-                                        activeWindowsAndTabs.get(windowID).add(diwi);
+                                        activeWindowsAndTabs.get(windowID).add(tabWrapper);
                                         lock.unlock();
                                     } catch (Exception e) {
                                         e.printStackTrace();
@@ -59,6 +61,16 @@ public void onChanged(Change<? extends Tab> change) {
                         }
                     }
                 }
+                else if(change.wasRemoved()){
+                    for(Tab tab: change.getRemoved()){
+                        if(tab.getProperties().get("application") instanceof DisplayRuntimeInstance && tab instanceof DockItemWithInput){
+                            lock.lock();
+                            String windowID = (String) tab.getTabPane().getScene().getWindow().getProperties().get(DockStage.KEY_ID);
+                            activeWindowsAndTabs.get(windowID).remove((DockItemWithInput) tab);
+                            lock.unlock();
+                        }
+                    }
+                }
             }
         }
     };
@@ -72,27 +84,23 @@ public void onChanged(Change<? extends Window> change) {
                     for (javafx.stage.Window window : change.getAddedSubList()) {
                         if(window.getProperties().containsKey(DockStage.KEY_ID)){
                             String windowID = (String) window.getProperties().get(DockStage.KEY_ID);
+                            lock.lock();
                             activeWindowsAndTabs.putIfAbsent(windowID, new ActiveTabsOfWindow(window));
                             for(DockPane item: DockStage.getDockPanes((Stage)window)){
-                                for (Tab tab: item.getTabs()){
-                                    if(tab instanceof DockItemWithInput){
-                                        try {
-                                            activeWindowsAndTabs.get(windowID).add((DockItemWithInput)tab);
-                                        } catch (Exception e) {
-                                            throw new RuntimeException(e);
-                                        }
-                                    }
-                                }
+                                item.getTabs().removeListener(UXATabChangeListener);
                                 item.getTabs().addListener(UXATabChangeListener);
                             }
+                            lock.unlock();
                         }
                     }
                 }
                 else if(change.wasRemoved()){
                     for(Window window: change.getRemoved()){
                         if(window.getProperties().containsKey(DockStage.KEY_ID)){
                             String windowID = (String) window.getProperties().get(DockStage.KEY_ID);
+                            lock.lock();
                             activeWindowsAndTabs.remove(windowID);
+                            lock.unlock();
                         }
                     }
                 }
diff --git a/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ResourceOpenSources.java b/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/ResourceOpenSources.java
@@ -0,0 +1,10 @@
+package org.phoebus.applications.uxanalytics.monitor;
+
+public enum ResourceOpenSources {
+    UNKNOWN,
+    ACTION_BUTTON,
+    FILE_BROWSER,
+    NAVIGATION_BUTTON,
+    TOP_RESOURCES,
+    RESTORED
+}
diff --git a/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/UXAToolkitListener.java b/app/ux-analytics/monitor/src/main/java/org/phoebus/applications/uxanalytics/monitor/UXAToolkitListener.java
@@ -4,9 +4,22 @@
 import org.csstudio.display.builder.model.properties.ActionInfo;
 import org.csstudio.display.builder.representation.ToolkitListener;
 
+import java.util.HashMap;
+import java.util.Map;
+
 
 public class UXAToolkitListener implements ToolkitListener {
 
+    public static final HashMap<String, ResourceOpenSources> openSources = new HashMap<>(
+            Map.of(
+                    "org.csstudio.display.builder.runtime.ActionUtil.openDisplay", ResourceOpenSources.ACTION_BUTTON,
+                    "org.phoebus.ui.application.PhoebusApplication.fileOpen", ResourceOpenSources.FILE_BROWSER,
+                    "org.csstudio.display.builder.runtime.app.NavigationAction.navigate", ResourceOpenSources.NAVIGATION_BUTTON,
+                    "org.phoebus.ui.internal.MementoHelper.restoreDockItem", ResourceOpenSources.RESTORED,
+                    "TOP_RESOURCES", ResourceOpenSources.TOP_RESOURCES
+            )
+    );
+
     private ActiveTab tabWrapper;
     private final UXAMonitor monitor = UXAMonitor.getInstance();
     void setTabWrapper(ActiveTab tabWrapper){
@@ -32,4 +45,41 @@ public void handleWrite(Widget widget, Object value) {
     public void handleClick(Widget widget, boolean with_control) {
         //nothing for now
     }
+
+    //Traverse down the call stack to find out what caused the display to open
+    public static ResourceOpenSources getSourceOfOpen(StackTraceElement[] stackTrace){
+        for(StackTraceElement e: stackTrace){
+            String methodName =  e.getMethodName();
+            if( methodName.contains("lambda$")){
+                methodName = unmangleLambda(methodName);
+            }
+            String fullName = e.getClassName()+"."+methodName;
+            if(openSources.containsKey(fullName)){
+                return openSources.get(fullName);
+            }
+        }
+        return ResourceOpenSources.UNKNOWN;
+    }
+
+    private static String unmangleLambda(String expression){
+        //find index of first '$' after 'lambda$'
+        int start = expression.indexOf("lambda$") + 7;
+        int end = expression.indexOf("$", start);
+        String unmangled = expression.substring(start,end);
+        return unmangled;
+    }
+
+    @Override
+    public void handleMethodCalled(Object... user_args) {
+        StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
+        //zeroth element is getStackTrace itself, first is this method,
+        //second is fireMethodCalled, third is the one we care about
+        String methodName = stackTrace[3].getMethodName();
+        if(methodName.equals("loadDisplayFile")){
+            ResourceOpenSources source = getSourceOfOpen(stackTrace);
+            System.out.println("Method call: "+methodName);
+            System.out.println("Source: "+getSourceOfOpen(stackTrace));
+        }
+    }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -44,4 +44,7 @@ public interface ToolkitListener`
`44`	`44`	`* @param value The value`
`45`	`45`	`*/`
`46`	`46`	`default public void handleWrite(Widget widget, Object value) {};`
	`47`	`+`
	`48`	`+ default public void handleMethodCalled(Object... user_args) {};`
	`49`	`+`
`47`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,11 @@ public ActiveTabsOfWindow(Window window){`
`17`	`17`	`activeWindowsService = ActiveWindowsService.getInstance();`
`18`	`18`	`}`
`19`	`19`
	`20`	`+ public void add(ActiveTab tab) throws Exception {`
	`21`	`+ this.remove(tab);`
	`22`	`+ activeTabs.putIfAbsent(tab.toString(), tab);`
	`23`	`+ }`
	`24`	`+`
`20`	`25`	`public void add(DockItemWithInput tab) throws Exception {`
`21`	`26`	`this.remove(tab);`
`22`	`27`	`activeTabs.putIfAbsent(tab.toString(), new ActiveTab(tab));`
`@@ -29,6 +34,13 @@ public void remove(DockItemWithInput tab){`
`29`	`34`	`}`
`30`	`35`	`}`
`31`	`36`
	`37`	`+ public void remove(ActiveTab tab){`
	`38`	`+ if(activeTabs.containsKey(tab.toString())){`
	`39`	`+ activeTabs.get(tab.toString()).close();`
	`40`	`+ activeTabs.remove(tab.toString());`
	`41`	`+ }`
	`42`	`+ }`
	`43`	`+`
`32`	`44`	`public boolean contains(DockItemWithInput tab){`
`33`	`45`	`return activeTabs.containsKey(tab.toString());`
`34`	`46`	`}`
`@@ -37,8 +49,6 @@ public synchronized void addWidget(DockItemWithInput tab, Widget widget){`
`37`	`49`	`activeTabs.get(tab.toString()).add(widget);`
`38`	`50`	`}`
`39`	`51`
`40`		`-`
`41`		`-`
`42`	`52`	`public ConcurrentHashMap<String, ActiveTab> getActiveTabs() {`
`43`	`53`	`return activeTabs;`
`44`	`54`	`}`