JCefComponent leak

Author: shalom938

src/main/java/org/digma/intellij/plugin/documentation/DocumentationFileEditor.java

@@ -16,7 +16,7 @@ public class DocumentationFileEditor extends UserDataHolderBase implements FileE
     private final VirtualFile file;
 
     @Nullable
-    private final JCefComponent jCefComponent;
+    private JCefComponent jCefComponent;
 
 
     public DocumentationFileEditor(Project project, DocumentationVirtualFile file) {
@@ -99,6 +99,7 @@ public void removePropertyChangeListener(@NotNull PropertyChangeListener listene
     public void dispose() {
         if (jCefComponent != null) {
             jCefComponent.dispose();
+            jCefComponent = null;
         }
     }
 

src/main/java/org/digma/intellij/plugin/jaegerui/JaegerUIFileEditor.java

@@ -16,7 +16,7 @@ public class JaegerUIFileEditor extends UserDataHolderBase implements FileEditor
     private final VirtualFile file;
 
     @Nullable
-    private final JCefComponent jCefComponent;
+    private JCefComponent jCefComponent;
 
     public JaegerUIFileEditor(Project project, JaegerUIVirtualFile file) {
         this.file = file;
@@ -98,6 +98,7 @@ public void removePropertyChangeListener(@NotNull PropertyChangeListener listene
     public void dispose() {
         if (jCefComponent != null) {
             jCefComponent.dispose();
+            jCefComponent = null;
         }
     }
 

src/main/java/org/digma/intellij/plugin/toolwindow/DigmaSidePaneToolWindowFactory.java

@@ -3,6 +3,7 @@
 import com.intellij.openapi.Disposable;
 import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.util.Disposer;
 import com.intellij.openapi.wm.*;
 import com.intellij.ui.content.ContentFactory;
 import com.intellij.util.ui.JBUI;
@@ -76,6 +77,9 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
         //mainContent contains the mainCardsPanel ,MainToolWindowCardsController switches between no connection and mainToolWindowPanel
         var mainContent = ContentFactory.getInstance().createContent(mainCardsPanel, null, false);
 
+        //register disposable for mainContent,any project service is good for parent disposable
+        Disposer.register(AnalyticsService.getInstance(project), mainContent);
+
         toolWindow.getContentManager().addContent(mainContent);
 
 

src/main/kotlin/org/digma/intellij/plugin/ui/insights/InsightsService.kt

@@ -44,6 +44,10 @@ class InsightsService(val project: Project) : InsightsServiceImpl(project) {
         }
     }
 
+    override fun dispose(){
+        jCefComponent = null
+    }
+
     fun setJCefComponent(jCefComponent: JCefComponent?) {
         this.jCefComponent = jCefComponent
     }

src/main/kotlin/org/digma/intellij/plugin/ui/jcef/JCefComponent.kt

@@ -50,6 +50,7 @@ import javax.swing.JComponent
 /*
 JCefComponentBuilder.build already registers a disposable for this JCefComponent using parentDisposable,
  this JCefComponent uses parentDisposable for all its listeners and connections.
+
  */
 class JCefComponent
 private constructor(
@@ -323,8 +324,6 @@ private constructor(
         try {
             jbCefBrowser.jbCefClient.dispose()
             jbCefBrowser.dispose()
-            //todo: not sure this is necessary
-            //cefMessageRouter.removeHandler(messageRouterHandler)
             cefMessageRouter.dispose()
             ApplicationUISettingsChangeNotifier.getInstance(project).removeSettingsChangeListener(settingsChangeListener)
         } catch (e: Exception) {
@@ -348,41 +347,45 @@ private constructor(
         schemeHandlerFactory: BaseSchemeHandlerFactory
     ) {
 
-        private val url = WeakReference(Objects.requireNonNull(url, "url must not be null"))
-        private val messageRouterHandler = WeakReference(Objects.requireNonNull(messageRouterHandler, "messageRouterHandlers must not be null"))
-        private val schemeHandlerFactory = WeakReference(Objects.requireNonNull(schemeHandlerFactory, "schemeHandlerFactory must not be null"))
-        private val parentDisposable = WeakReference(parentDisposable)
-        private var downloadAdapter: WeakReference<CefDownloadHandler>? = null
+        private val urlRef = WeakReference(Objects.requireNonNull(url, "url must not be null"))
+        private val messageRouterHandlerRef = WeakReference(Objects.requireNonNull(messageRouterHandler, "messageRouterHandlers must not be null"))
+        private val schemeHandlerFactoryRef = WeakReference(Objects.requireNonNull(schemeHandlerFactory, "schemeHandlerFactory must not be null"))
+        private val parentDisposableRef = WeakReference(parentDisposable)
+        private var downloadAdapterRef: WeakReference<CefDownloadHandler>? = null
 
 
         fun build(): JCefComponent {
 
+            val url: String = Objects.requireNonNull(urlRef.get(), "url must not be null")!!
+            val messageRouterHandler = Objects.requireNonNull(messageRouterHandlerRef.get(), "messageRouterHandlers must not be null")!!
+            val schemeHandlerFactory = Objects.requireNonNull(schemeHandlerFactoryRef.get(), "schemeHandlerFactory must not be null")!!
+            val parentDisposable = Objects.requireNonNull(parentDisposableRef.get(), "parentDisposable must not be null")!!
+
+
             val jbCefBrowser = JBCefBrowserBuilderCreator.create()
-                .setUrl(url.get())
+                .setUrl(url)
                 .build()
 
             val jbCefClient = jbCefBrowser.jbCefClient
             val cefMessageRouter = CefMessageRouter.create()
-            cefMessageRouter.addHandler(messageRouterHandler.get()!!, true)
+            cefMessageRouter.addHandler(messageRouterHandler, true)
             jbCefClient.cefClient.addMessageRouter(cefMessageRouter)
 
             jbCefClient.cefClient.addDisplayHandler(JCefDisplayHandler(name))
 
-            jbCefBrowser.jbCefClient.addLifeSpanHandler(LifeSpanHandle(schemeHandlerFactory.get()!!), jbCefBrowser.cefBrowser)
+            jbCefBrowser.jbCefClient.addLifeSpanHandler(LifeSpanHandle(schemeHandlerFactory), jbCefBrowser.cefBrowser)
 
-            downloadAdapter?.let {
-                jbCefClient.cefClient.addDownloadHandler(it.get())
+            downloadAdapterRef?.get()?.let {
+                jbCefClient.cefClient.addDownloadHandler(it)
             }
 
             val jCefComponent =
-                JCefComponent(project, parentDisposable.get()!!, name, jbCefBrowser, cefMessageRouter)
+                JCefComponent(project, parentDisposable, name, jbCefBrowser, cefMessageRouter)
 
             //usually the component that holds a reference to JCefComponent needs to call JCefComponent.dispose.
             //when a parentDisposable is supplied then use it also to dispose, worst case dispose will be called twice.
-            parentDisposable.get()!!.let {
-                Disposer.register(it) {
-                    jCefComponent.dispose()
-                }
+            Disposer.register(parentDisposable) {
+                jCefComponent.dispose()
             }
 
 
@@ -391,16 +394,14 @@ private constructor(
         }
 
 
-
-
         fun withDownloadAdapter(adapter: CefDownloadHandler): JCefComponentBuilder {
-            this.downloadAdapter = WeakReference(Objects.requireNonNull(adapter, "downloadAdapter must not be null"))
+            this.downloadAdapterRef = WeakReference(Objects.requireNonNull(adapter, "downloadAdapter must not be null"))
             return this
         }
     }
 }
 
-class LifeSpanHandle(private val schemeHandlerFactory: BaseSchemeHandlerFactory) : CefLifeSpanHandlerAdapter(){
+class LifeSpanHandle(private val schemeHandlerFactory: BaseSchemeHandlerFactory) : CefLifeSpanHandlerAdapter() {
 
     override fun onAfterCreated(browser: CefBrowser) {
         //schemeHandlerFactory must not be null here!

src/main/kotlin/org/digma/intellij/plugin/ui/mainapp/MainAppPanel.kt

@@ -19,11 +19,9 @@ import javax.swing.JLabel
 
 class MainAppPanel(private val project: Project) : DisposablePanel() {
 
-    private var jCefComponent: JCefComponent? = null
-
     init {
 
-        jCefComponent = createJcefComponent()
+        val jCefComponent = createJcefComponent()
 
         val jcefUiComponent: JComponent = jCefComponent?.getComponent() ?: JLabel("JCEF not supported")
 
@@ -33,6 +31,8 @@ class MainAppPanel(private val project: Project) : DisposablePanel() {
         background = listBackground()
 
         Disposer.register(MainAppService.getInstance(project)) {
+            jCefComponent?.dispose()
+            remove(jcefUiComponent)
             dispose()
         }
 
@@ -67,6 +67,6 @@ class MainAppPanel(private val project: Project) : DisposablePanel() {
     }
 
     override fun dispose() {
-        jCefComponent?.dispose()
+        //nothing to do
     }
 }

src/main/kotlin/org/digma/intellij/plugin/ui/mainapp/MainAppService.kt

@@ -35,7 +35,7 @@ class MainAppService(private val project: Project) : Disposable {
 
 
     override fun dispose() {
-        //nothing to do , used as parent disposable
+        this.jCefComponent = null
     }
 
     fun setJCefComponent(jCefComponent: JCefComponent) {

src/main/kotlin/org/digma/intellij/plugin/ui/navigation/CodeButtonCaretContextService.kt

@@ -42,7 +42,7 @@ class CodeButtonCaretContextService(private val project: Project) : CaretContext
     }
 
     override fun dispose() {
-        //nothing to do
+        jCefComponent = null
     }
 
     override fun contextChanged(methodUnderCaret: MethodUnderCaret) {

src/main/kotlin/org/digma/intellij/plugin/ui/navigation/NavigationService.kt

@@ -42,7 +42,7 @@ class NavigationService(private val project: Project) : Disposable {
 
 
     override fun dispose() {
-        //nothing to do , used as parent disposable
+        jCefComponent = null
     }
 
     fun setJCefComponent(jCefComponent: JCefComponent) {

src/main/kotlin/org/digma/intellij/plugin/ui/recentactivity/LiveViewUpdater.kt

@@ -43,6 +43,7 @@ class LiveViewUpdater(val project: Project) : Disposable {
         myDisposable?.let {
             Disposer.dispose(it)
         }
+        jCefComponent = null
     }