Merge pull request #2251 from digma-ai/register-only-one-schema-handler-factory

Stateless schema handler factory and register only one instance per jcef type  Closes #2248

Author: shalom938

ide-common/src/main/java/org/digma/intellij/plugin/analytics/AnalyticsService.java

@@ -59,7 +59,7 @@ public class AnalyticsService implements Disposable {
 
     private static final Logger LOGGER = Logger.getInstance(AnalyticsService.class);
 
-    private final Environment environment;
+    private Environment environment;
 
     private final Project project;
 
@@ -522,6 +522,8 @@ public HttpResponse lowLevelCall(HttpRequest request) throws AnalyticsServiceExc
     public void dispose() {
         try {
             analyticsProviderProxy.close();
+            analyticsProviderProxy = null;
+            environment = null;
         } catch (Exception e) {
             Log.warnWithException(LOGGER, project, e, "exception while closing AnalyticsProvider {}", e.getMessage());
         }

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

@@ -11,13 +11,16 @@
 import javax.swing.*;
 import java.beans.PropertyChangeListener;
 
+import static org.digma.intellij.plugin.ui.jcef.JBcefBrowserPropertiesKt.JCEF_DOCUMENTATION_FILE_PROPERTY_NAME;
+
 public class DocumentationFileEditor extends UserDataHolderBase implements FileEditor {
 
-    private final VirtualFile file;
+    private final DocumentationVirtualFile file;
 
     @Nullable
     private JCefComponent jCefComponent;
 
+    private boolean disposed = false;
 
     public DocumentationFileEditor(Project project, DocumentationVirtualFile file) {
         this.file = file;
@@ -28,10 +31,10 @@ public DocumentationFileEditor(Project project, DocumentationVirtualFile file) {
     private JCefComponent createJcefComponent(Project project, DocumentationVirtualFile file) {
 
         if (JBCefApp.isSupported()) {
-            return new JCefComponent.JCefComponentBuilder(project, "Documentation", DocumentationService.getInstance(project),
+            return new JCefComponent.JCefComponentBuilder(project, "Documentation", this,
                     DocumentationConstants.DOCUMENTATION_URL,
-                    new DocumentationMessageRouterHandler(project),
-                    new DocumentationSchemeHandlerFactory(project, file))
+                    new DocumentationMessageRouterHandler(project))
+                    .withArg(JCEF_DOCUMENTATION_FILE_PROPERTY_NAME,file)
                     .withDownloadAdapter(new DownloadHandlerAdapter())
                     .build();
 
@@ -82,7 +85,7 @@ public boolean isModified() {
 
     @Override
     public boolean isValid() {
-        return true;
+        return !disposed;
     }
 
     @Override
@@ -101,6 +104,8 @@ public void dispose() {
             jCefComponent.dispose();
             jCefComponent = null;
         }
+        disposed = true;
+        file.setValid(false);
     }
 
 }

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

@@ -21,12 +21,6 @@ public boolean accept(@NotNull Project project, @NotNull VirtualFile file) {
         return new DocumentationFileEditor(project, (DocumentationVirtualFile) file);
     }
 
-    @Override
-    public void disposeEditor(@NotNull FileEditor editor) {
-        FileEditorProvider.super.disposeEditor(editor);
-    }
-
-
     @Override
     public @NotNull @NonNls String getEditorTypeId() {
         return DOCUMENTATION_EDITOR_TYPE;

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

@@ -3,11 +3,8 @@
 import com.intellij.openapi.fileTypes.ex.FakeFileType;
 import com.intellij.openapi.util.NlsContexts;
 import com.intellij.openapi.vfs.VirtualFile;
-import org.jetbrains.annotations.Nls;
-import org.jetbrains.annotations.NonNls;
-import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.*;
 
-@SuppressWarnings("UnstableApiUsage")
 public class DocumentationFileType extends FakeFileType {
 
     private DocumentationFileType() {

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

@@ -1,24 +1,19 @@
 package org.digma.intellij.plugin.documentation;
 
-import com.intellij.openapi.diagnostic.Logger;
 import com.intellij.openapi.project.Project;
-import org.digma.intellij.plugin.ui.jcef.BaseResourceHandler;
+import org.cef.browser.CefBrowser;
+import org.digma.intellij.plugin.errorreporting.ErrorReporter;
+import org.digma.intellij.plugin.log.Log;
+import org.digma.intellij.plugin.ui.jcef.*;
 import org.jetbrains.annotations.*;
 
 import java.io.InputStream;
+import java.util.Collections;
 
 public class DocumentationResourceHandler extends BaseResourceHandler {
 
-    private static final Logger LOGGER = Logger.getInstance(DocumentationResourceHandler.class);
-
-
-    private final Project project;
-    private final DocumentationVirtualFile documentationVirtualFile;
-
-    public DocumentationResourceHandler(@NotNull Project project, @NotNull String path, @NotNull DocumentationVirtualFile file) {
-        super(path);
-        this.project = project;
-        this.documentationVirtualFile = file;
+    public DocumentationResourceHandler(@NotNull CefBrowser browser, @NotNull String path) {
+        super(path, browser);
     }
 
     @Override
@@ -29,6 +24,18 @@ public boolean isIndexHtml(@NotNull String path) {
     @Nullable
     @Override
     public InputStream buildIndexFromTemplate(@NotNull String path) {
-        return new DocumentationIndexTemplateBuilder(documentationVirtualFile).build(project);
+        Project project = JBcefBrowserPropertiesKt.getProject(getBrowser());
+        if (project == null) {
+            Log.log(getLogger()::warn, "project is null , should never happen");
+            ErrorReporter.getInstance().reportError(null, "DocumentationResourceHandler.buildIndexFromTemplate", "project is null", Collections.emptyMap());
+            return null;
+        }
+        DocumentationVirtualFile file = (DocumentationVirtualFile) JBcefBrowserPropertiesKt.getProperty(getBrowser(), JBcefBrowserPropertiesKt.JCEF_DOCUMENTATION_FILE_PROPERTY_NAME);
+        if (file == null) {
+            Log.log(getLogger()::warn, "DocumentationVirtualFile is null , should never happen");
+            ErrorReporter.getInstance().reportError(null, "DocumentationResourceHandler.buildIndexFromTemplate", "DocumentationVirtualFile is null", Collections.emptyMap());
+            return null;
+        }
+        return new DocumentationIndexTemplateBuilder(file).build(project);
     }
 }

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

@@ -1,27 +1,20 @@
 package org.digma.intellij.plugin.documentation;
 
-import com.intellij.openapi.project.Project;
+import org.cef.browser.CefBrowser;
 import org.cef.handler.CefResourceHandler;
 import org.digma.intellij.plugin.ui.jcef.BaseSchemeHandlerFactory;
 import org.jetbrains.annotations.NotNull;
 
 public class DocumentationSchemeHandlerFactory extends BaseSchemeHandlerFactory {
 
-    private final DocumentationVirtualFile documentationVirtualFile;
-
-    public DocumentationSchemeHandlerFactory(Project project, DocumentationVirtualFile file) {
-        super(project);
-        this.documentationVirtualFile = file;
-    }
-
 
     @NotNull
     @Override
-    public CefResourceHandler createResourceHandler(@NotNull String resourceName, boolean resourceExists) {
+    public CefResourceHandler createResourceHandler(@NotNull String resourceName, boolean resourceExists, @NotNull CefBrowser browser) {
         if (resourceExists) {
-            return new DocumentationResourceHandler(getProject(), resourceName, documentationVirtualFile);
+            return new DocumentationResourceHandler(browser, resourceName);
         } else {
-            return new DocumentationResourceHandler(getProject(), DocumentationConstants.DOCUMENTATION_RESOURCE_FOLDER_NAME + "/index.html", documentationVirtualFile);
+            return new DocumentationResourceHandler(browser, DocumentationConstants.DOCUMENTATION_RESOURCE_FOLDER_NAME + "/index.html");
         }
     }
 

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

@@ -11,6 +11,8 @@
 import javax.swing.*;
 import java.beans.PropertyChangeListener;
 
+import static org.digma.intellij.plugin.ui.jcef.JBcefBrowserPropertiesKt.JCEF_JAEGER_UI_FILE_PROPERTY_NAME;
+
 public class JaegerUIFileEditor extends UserDataHolderBase implements FileEditor {
 
     private final JaegerUIVirtualFile file;
@@ -31,8 +33,8 @@ private JCefComponent createJcefComponent(Project project, JaegerUIVirtualFile f
         if (JBCefApp.isSupported()) {
             return new JCefComponent.JCefComponentBuilder(project, "JaegerUI", this,
                     JaegerUIConstants.JAEGER_UI_URL,
-                    new JaegerUIMessageRouterHandler(project),
-                    new JaegerUiSchemeHandlerFactory(project, file))
+                    new JaegerUIMessageRouterHandler(project))
+                    .withArg(JCEF_JAEGER_UI_FILE_PROPERTY_NAME, file)
                     .withDownloadAdapter(new DownloadHandlerAdapter())
                     .build();
 

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

@@ -1,20 +1,19 @@
 package org.digma.intellij.plugin.jaegerui;
 
 import com.intellij.openapi.project.Project;
-import org.digma.intellij.plugin.ui.jcef.BaseResourceHandler;
+import org.cef.browser.CefBrowser;
+import org.digma.intellij.plugin.errorreporting.ErrorReporter;
+import org.digma.intellij.plugin.log.Log;
+import org.digma.intellij.plugin.ui.jcef.*;
 import org.jetbrains.annotations.*;
 
 import java.io.InputStream;
+import java.util.Collections;
 
 public class JaegerUiResourceHandler extends BaseResourceHandler {
 
-    private final Project project;
-    private final JaegerUIVirtualFile file;
-
-    public JaegerUiResourceHandler(Project project, @NotNull String path, JaegerUIVirtualFile file) {
-        super(path);
-        this.project = project;
-        this.file = file;
+    public JaegerUiResourceHandler(@NotNull CefBrowser browser, @NotNull String path) {
+        super(path,browser);
     }
 
     @Override
@@ -25,6 +24,18 @@ public boolean isIndexHtml(@NotNull String path) {
     @Nullable
     @Override
     public InputStream buildIndexFromTemplate(@NotNull String path) {
+        Project project = JBcefBrowserPropertiesKt.getProject(getBrowser());
+        if (project == null) {
+            Log.log(getLogger()::warn, "project is null , should never happen");
+            ErrorReporter.getInstance().reportError(null, "JaegerUiResourceHandler.buildIndexFromTemplate", "project is null", Collections.emptyMap());
+            return null;
+        }
+        JaegerUIVirtualFile file = (JaegerUIVirtualFile) JBcefBrowserPropertiesKt.getProperty(getBrowser(),JBcefBrowserPropertiesKt.JCEF_JAEGER_UI_FILE_PROPERTY_NAME);
+        if (file == null){
+            Log.log(getLogger()::warn, "JaegerUIVirtualFile is null , should never happen");
+            ErrorReporter.getInstance().reportError(null, "JaegerUiResourceHandler.buildIndexFromTemplate", "JaegerUIVirtualFile is null", Collections.emptyMap());
+            return null;
+        }
         return new JaegerUiIndexTemplateBuilder(file).build(project);
     }
 }

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

@@ -1,6 +1,6 @@
 package org.digma.intellij.plugin.jaegerui;
 
-import com.intellij.openapi.project.Project;
+import org.cef.browser.CefBrowser;
 import org.cef.handler.CefResourceHandler;
 import org.digma.intellij.plugin.ui.jcef.BaseSchemeHandlerFactory;
 import org.jetbrains.annotations.NotNull;
@@ -9,21 +9,14 @@
 
 public class JaegerUiSchemeHandlerFactory extends BaseSchemeHandlerFactory {
 
-    private final JaegerUIVirtualFile file;
-
-    public JaegerUiSchemeHandlerFactory(Project project, JaegerUIVirtualFile file) {
-        super(project);
-        this.file = file;
-    }
-
 
     @NotNull
     @Override
-    public CefResourceHandler createResourceHandler(@NotNull String resourceName, boolean resourceExists) {
+    public CefResourceHandler createResourceHandler(@NotNull String resourceName, boolean resourceExists, @NotNull CefBrowser browser) {
         if (resourceExists) {
-            return new JaegerUiResourceHandler(getProject(), resourceName, file);
+            return new JaegerUiResourceHandler(browser, resourceName);
         } else {
-            return new JaegerUiResourceHandler(getProject(), JaegerUIConstants.JAEGER_UI_RESOURCE_FOLDER_NAME + "/index.html", file);
+            return new JaegerUiResourceHandler(browser, JaegerUIConstants.JAEGER_UI_RESOURCE_FOLDER_NAME + "/index.html");
         }
     }
 

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

@@ -1,6 +1,7 @@
 package org.digma.intellij.plugin.ui.jcef
 
 import com.intellij.openapi.diagnostic.Logger
+import org.cef.browser.CefBrowser
 import org.cef.callback.CefCallback
 import org.cef.handler.CefLoadHandler
 import org.cef.handler.CefResourceHandler
@@ -13,7 +14,7 @@ import java.io.IOException
 import java.io.InputStream
 import kotlin.math.min
 
-abstract class BaseResourceHandler(private val path: String) : CefResourceHandler {
+abstract class BaseResourceHandler(private val path: String, protected val browser: CefBrowser) : CefResourceHandler {
 
     val logger = Logger.getInstance(this::class.java)
 
@@ -24,7 +25,6 @@ abstract class BaseResourceHandler(private val path: String) : CefResourceHandle
 
     abstract fun isIndexHtml(path: String): Boolean
 
-    //todo: probably path is not necessary
     abstract fun buildIndexFromTemplate(path: String): InputStream?