Handle VisualVM closing, notify DataSource views when being closed

 - rolling back the core.boot package

Author: jisedlac

visualvm/core/manifest.mf

@@ -2,8 +2,8 @@ Manifest-Version: 1.0
 AutoUpdate-Show-In-Client: false
 AutoUpdate-Essential-Module: true
 OpenIDE-Module: org.graalvm.visualvm.core/2
-OpenIDE-Module-Layer: org/graalvm/visualvm/core/boot/layer.xml
-OpenIDE-Module-Localizing-Bundle: org/graalvm/visualvm/core/boot/Bundle.properties
-OpenIDE-Module-Install: org/graalvm/visualvm/core/boot/Install.class
-OpenIDE-Module-Specification-Version: 2.1
+OpenIDE-Module-Layer: org/graalvm/visualvm/core/layer.xml
+OpenIDE-Module-Localizing-Bundle: org/graalvm/visualvm/core/Bundle.properties
+OpenIDE-Module-Install: org/graalvm/visualvm/core/Install$Impl.class
+OpenIDE-Module-Specification-Version: 2.2
 

visualvm/core/src/org/graalvm/visualvm/core/boot/Bundle.properties renamed to visualvm/core/src/org/graalvm/visualvm/core/Bundle.properties

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -23,9 +23,7 @@
  * questions.
  */
 
-package org.graalvm.visualvm.core.boot;
-
-//import org.graalvm.visualvm.application.ApplicationsSupport;
+package org.graalvm.visualvm.core;
 
 import org.graalvm.visualvm.core.datasource.DataSourceRepository;
 import org.graalvm.visualvm.core.datasource.Storage;
@@ -38,22 +36,30 @@
  *
  * @author Jiri Sedlacek
  */
-// Class implementing logic on VisualVM module install
-public class Install extends ModuleInstall {
-
-    public void restored() {
-        // NOTE: this has to be called before any of DataSourceProviders initializes
-        cleanupPreviousSession();
-        
-        DataSourceRepository.sharedInstance();
+class Install {
+    // Class implementing logic on VisualVM module install
+    public static class Impl extends ModuleInstall {
 
-        // Initialize snapshots
-        SnapshotsSupport.getInstance();
-    }
-    
-    private void cleanupPreviousSession() {
-        File temporaryStorage = new File(Storage.getTemporaryStorageDirectoryString());
-        Utils.delete(temporaryStorage, false);
+        @Override
+        public boolean closing() {
+            return VisualVM.getInstance().closing();
+        }
+
+        @Override
+        public void restored() {
+            // NOTE: this has to be called before any of DataSourceProviders initializes
+            cleanupPreviousSession();
+
+            DataSourceRepository.sharedInstance();
+
+            // Initialize snapshots
+            SnapshotsSupport.getInstance();
+        }
+
+        private void cleanupPreviousSession() {
+            File temporaryStorage = new File(Storage.getTemporaryStorageDirectoryString());
+            Utils.delete(temporaryStorage, false);
+        }
+
     }
-    
 }

visualvm/core/src/org/graalvm/visualvm/core/boot/Install.java renamed to visualvm/core/src/org/graalvm/visualvm/core/Install.java

@@ -24,6 +24,10 @@
  */
 package org.graalvm.visualvm.core;
 
+import java.lang.ref.WeakReference;
+import java.util.ArrayList;
+import java.util.Collection;
+import org.graalvm.visualvm.core.datasupport.ComparableWeakReference;
 import org.openide.util.RequestProcessor;
 
 /**
@@ -42,6 +46,8 @@ public final class VisualVM {
 
     private final RequestProcessor taskProcessor;
 
+    private Collection<ComparableWeakReference<Runnable>> closingHandlers;
+    
 
     private VisualVM() {
         taskProcessor = new RequestProcessor("VisualVM Shared RequestProcessor", TASK_PROCESSOR_THROUGHPUT); // NOI18N
@@ -59,4 +65,30 @@ public final void runTask(Runnable task, int timeToWait) {
         taskProcessor.post(task, timeToWait);
     }
 
+    
+    /**
+     * Adds a Runnable instance to be notified when the host VisualVM is closing.
+     * Note that the Runnable cannot be explicitly unregistered, it's weakly referenced and will
+     * be notified up to once and then unregistered automatically.
+     * 
+     * @param handler Runnable instance to be notified when the host VisualVM is closing.
+     */
+    public synchronized final void notifyWhenClosing(Runnable handler) {
+        if (closingHandlers == null) closingHandlers = new ArrayList();
+        closingHandlers.add(new ComparableWeakReference(handler));
+    }
+    
+    
+    synchronized boolean closing() {
+        if (closingHandlers != null)
+            for (WeakReference<Runnable> handlerR : closingHandlers) {
+                Runnable handler = handlerR.get();
+                if (handler != null)
+                    try { handler.run(); }
+                    catch (Exception e) { System.err.println("Exception handling VisualVM.closing(): " + e); } // NOI18N
+            }
+        
+        return true;
+    }
+    
 }

visualvm/core/src/org/graalvm/visualvm/core/VisualVM.java

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
- Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
+ Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 
  This code is free software; you can redistribute it and/or modify it
@@ -80,7 +80,7 @@
         </folder>
 
          <folder name="Applications">
-            <attr name="SystemFileSystem.localizingBundle" stringvalue="org.graalvm.visualvm.core.boot.Bundle"/>
+            <attr name="SystemFileSystem.localizingBundle" stringvalue="org.graalvm.visualvm.core.Bundle"/>
             <attr name="position" intvalue="200"/>
             <file name="org-graalvm-visualvm-core-ui-actions-OpenDataSourceAction.shadow">
                 <attr name="originalFile" stringvalue="VisualVM/Actions/org-graalvm-visualvm-core-ui-actions-OpenDataSourceAction.instance"/>
@@ -123,7 +123,7 @@
     <folder name="Toolbars">
         <folder name="Snapshot">
             <attr name="position" intvalue="100"/>
-            <attr name="SystemFileSystem.localizingBundle" stringvalue="org.graalvm.visualvm.core.boot.Bundle"/>
+            <attr name="SystemFileSystem.localizingBundle" stringvalue="org.graalvm.visualvm.core.Bundle"/>
             <file name="org-graalvm-visualvm-core-ui-actions-LoadSnapshotAction.shadow">
                 <attr name="originalFile" stringvalue="Actions/Other/org-graalvm-visualvm-core-ui-actions-LoadSnapshotAction.instance"/>
                 <attr name="position" intvalue="100"/>
@@ -136,7 +136,7 @@
 
         <folder name="DataSource">
             <attr name="position" intvalue="200"/>
-            <attr name="SystemFileSystem.localizingBundle" stringvalue="org.graalvm.visualvm.core.boot.Bundle"/>
+            <attr name="SystemFileSystem.localizingBundle" stringvalue="org.graalvm.visualvm.core.Bundle"/>
         </folder>
     </folder>
 
@@ -221,11 +221,11 @@
     <folder name="Services">
         <folder name="AutoupdateType">
             <file name="com_sun_tools_visualvm_core_update_center.instance">
-                <attr name="displayName" bundlevalue="org.graalvm.visualvm.core.boot.Bundle#Services/AutoupdateType/com_sun_tools_visualvm_core_update_center.instance"/>
+                <attr name="displayName" bundlevalue="org.graalvm.visualvm.core.Bundle#Services/AutoupdateType/com_sun_tools_visualvm_core_update_center.instance"/>
                 <attr name="enabled" boolvalue="true"/>
                 <attr name="instanceCreate" methodvalue="org.netbeans.modules.autoupdate.updateprovider.AutoupdateCatalogFactory.createUpdateProvider"/>
                 <attr name="instanceOf" stringvalue="org.netbeans.spi.autoupdate.UpdateProvider"/>
-                <attr name="url" bundlevalue="org.graalvm.visualvm.core.boot.Bundle#com_sun_tools_visualvm_core_update_center"/>
+                <attr name="url" bundlevalue="org.graalvm.visualvm.core.Bundle#com_sun_tools_visualvm_core_update_center"/>
             </file>
         </folder>
     </folder>

visualvm/core/src/org/graalvm/visualvm/core/boot/layer.xml renamed to visualvm/core/src/org/graalvm/visualvm/core/layer.xml

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -160,6 +160,16 @@ protected void willBeAdded() {
     protected void added() {
     }
 
+    /**
+     * Notification when the view is about to be either programmatically removed from tabbed pane or closed by the user by clicking the X.
+     * This notification comes from the EDT thread and its main intention is to
+     * provide a possibility to save any view data before the view is closed, if
+     * needed. Long-running operations should use a separate thread to not block
+     * EDT closing the view.
+     */
+    protected void willBeRemoved() {
+    }
+    
     /**
      * Notification when the view has been either programatically removed from tabbed pane or closed by the user by clicking the X.
      * This notification comes from a thread other than EDT
@@ -198,6 +208,15 @@ void viewAdded() {
         controller.viewAdded(this);
     }
 
+    private boolean willBeRemovedNotified;
+    void viewWillBeRemoved() {
+        if (willBeRemovedNotified) return;
+        
+        willBeRemoved();
+        willBeRemovedNotified = true;
+        controller.viewWillBeRemoved(this);
+    }
+    
     void viewRemoved() {
         removed();
         controller.viewRemoved(this);

visualvm/core/src/org/graalvm/visualvm/core/ui/DataSourceView.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -122,6 +122,9 @@ void viewWillBeAdded(DataSourceView view) {
     void viewAdded(DataSourceView view) {
     }
 
+    void viewWillBeRemoved(DataSourceView view) {
+    }
+    
     void viewRemoved(DataSourceView view) {
         synchronized(viewsCache) {
             viewsCache.remove((X)view.getDataSource());

visualvm/core/src/org/graalvm/visualvm/core/ui/DataSourceViewProvider.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -130,13 +130,15 @@ public void selectView(DataSourceView view) {
     public void removeView(final DataSourceView view) {
         if (viewsCount == 1) {
             if (view != singleViewContainer.getView()) throw new RuntimeException("View " + view + " not present in DataSourceWindow " + this); // NOI18N
+            view.viewWillBeRemoved();
             remove(singleViewContainer);
             singleViewContainer.getCaption().finish();
             singleViewContainer = null;
         } else {
             int viewIndex = indexOf(view);
             if (viewIndex == -1) throw new RuntimeException("View " + view + " not present in DataSourceWindow " + this);   // NOI18N
-            else tabbedContainer.removeView(viewIndex);
+            view.viewWillBeRemoved();
+            tabbedContainer.removeView(viewIndex);
 
             if (viewsCount == 2) {
                 DataSourceView remaining = tabbedContainer.getViews().get(0);
@@ -162,6 +164,7 @@ public void run() {
 
     void clearView(final DataSourceView view, RequestProcessor notificationProcessor) {
         if (viewsCount == 1 && Objects.equals(singleViewContainer.getName(), view.getName())) {
+            view.viewWillBeRemoved();
             singleViewContainer.removeAll();
             if (singleViewContainer.getCaption() != null) singleViewContainer.getCaption().finish();
             singleViewContainer.setReloading();
@@ -171,6 +174,7 @@ void clearView(final DataSourceView view, RequestProcessor notificationProcessor
             int viewIndex = indexOf(view);
             if (viewIndex == -1) return;
 
+            view.viewWillBeRemoved();
             tabbedContainer.clearView(viewIndex);
         }
 
@@ -268,6 +272,12 @@ protected final void componentActivated() {
         else if (getComponentCount() > 0) getComponent(0).requestFocusInWindow();
     }
 
+    public final boolean canClose() {
+        for (DataSourceView view : getViews()) view.viewWillBeRemoved();
+        
+        return true;
+    }
+    
     protected final void componentClosed() {
         dataSourceDescriptor.removePropertyChangeListener(this);
         removeAllViews();

visualvm/core/src/org/graalvm/visualvm/core/ui/DataSourceWindow.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -28,6 +28,7 @@
 import org.graalvm.visualvm.core.datasource.DataSource;
 import org.graalvm.visualvm.core.datasource.descriptor.DataSourceDescriptorFactory;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -38,6 +39,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import javax.swing.SwingUtilities;
+import org.graalvm.visualvm.core.VisualVM;
 import org.netbeans.api.progress.ProgressHandle;
 import org.netbeans.api.progress.ProgressHandleFactory;
 import org.openide.util.NbBundle;
@@ -59,6 +61,8 @@ public final class DataSourceWindowManager {
 
     private final Map<DataSource, DataSourceWindow> openedWindows = Collections.synchronizedMap(new HashMap());
     private final Map<DataSource, Set<DataSourceView>> openedViews = Collections.synchronizedMap(new HashMap());
+    
+    private final Runnable closingHandler;
 
 
     /**
@@ -433,6 +437,16 @@ void unregisterClosedView(DataSourceView view) {
     }
 
 
-    private DataSourceWindowManager() {}
+    private DataSourceWindowManager() {
+        closingHandler = new Runnable() {
+            public void run() {
+                Collection<Set<DataSourceView>> allViews = openedViews.values();
+                for (Set<DataSourceView> dataSourceViews : allViews)
+                    for (DataSourceView view : dataSourceViews)
+                        view.viewWillBeRemoved();
+            }
+        };
+        VisualVM.getInstance().notifyWhenClosing(closingHandler);
+    }
 
 }