Save Installation Wizard state globally on application level #459

Author: MykolaYaremchuk

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

@@ -80,8 +80,7 @@ public AnalyticsService(@NotNull Project project) {
         //initialize BackendConnectionMonitor when starting, so it is aware early on connection statuses
         project.getService(BackendConnectionMonitor.class);
         SettingsState settingsState = project.getService(SettingsState.class);
-        PersistenceService persistenceService = project.getService(PersistenceService.class);
-        environment = new Environment(project, this, persistenceService.getState(), settingsState);
+        environment = new Environment(project, this, PersistenceService.getInstance().getState(), settingsState);
         this.project = project;
         myApiUrl = settingsState.apiUrl;
         myApiToken = settingsState.apiToken;

ide-common/src/main/java/org/digma/intellij/plugin/persistence/PersistenceService.java

@@ -0,0 +1,36 @@
+package org.digma.intellij.plugin.persistence
+
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.components.PersistentStateComponent
+import com.intellij.openapi.components.State
+import com.intellij.openapi.components.Storage
+
+
+// the @State annotation helps IntelliJ automatically serialize and save our state
+@State(
+        name = "PersistenceService",
+        storages = [Storage("DigmaPersistence.xml")]
+)
+open class PersistenceService : PersistentStateComponent<PersistenceData> {
+
+    // this is how we're going to call the component from different classes
+    companion object {
+        @JvmStatic
+        fun getInstance() : PersistenceService {
+            return ApplicationManager.getApplication().getService(PersistenceService::class.java)
+        }
+    }
+
+    // the component will always keep our state as a variable
+    private var myPersistenceData: PersistenceData = PersistenceData()
+
+    // just an obligatory override from PersistentStateComponent
+    override fun getState(): PersistenceData {
+        return myPersistenceData
+    }
+
+    // after automatically loading our save state,  we will keep reference to it
+    override fun loadState(state: PersistenceData) {
+        myPersistenceData = state
+    }
+}

ide-common/src/main/java/org/digma/intellij/plugin/persistence/PersistenceService.kt

@@ -41,7 +41,6 @@ public class SettingsState implements PersistentStateComponent<SettingsState>, D
     public boolean firstTimeInsightReceived;
     @Nullable
     public String posthogToken;
-    public boolean alreadyPassedTheInstallationWizard;
 
     private final List<SettingsChangeListener> listeners = new ArrayList<>();
 

ide-common/src/main/java/org/digma/intellij/plugin/settings/SettingsState.java

@@ -89,8 +89,7 @@ class ErrorsViewService(project: Project) : AbstractViewService(project) {
         Log.log(logger::debug, "showDocumentPreviewList for {}. ", uid)
 
         val errorDetails = errorsProvider.getErrorDetails(uid)
-        errorDetails.flowStacks.isWorkspaceOnly =
-            project.getService(PersistenceService::class.java).state.isWorkspaceOnly
+        errorDetails.flowStacks.isWorkspaceOnly = PersistenceService.getInstance().state.isWorkspaceOnly
         model.errorDetails = errorDetails
         model.card = ErrorsTabCard.ERROR_DETAILS
 
@@ -169,8 +168,7 @@ class ErrorsViewService(project: Project) : AbstractViewService(project) {
 
     private fun createEmptyErrorDetails(): ErrorDetailsModel {
         val emptyErrorDetails = ErrorDetailsModel()
-        emptyErrorDetails.flowStacks.isWorkspaceOnly =
-            project.getService(PersistenceService::class.java).state.isWorkspaceOnly
+        emptyErrorDetails.flowStacks.isWorkspaceOnly = PersistenceService.getInstance().state.isWorkspaceOnly
         return emptyErrorDetails
     }
 

ide-common/src/main/kotlin/org/digma/intellij/plugin/ui/service/ErrorsViewService.kt

@@ -26,8 +26,8 @@ class AutoOtelAgentRunConfigurationExtension : RunConfigurationExtension() {
 
     private val logger: Logger = Logger.getInstance(AutoOtelAgentRunConfigurationExtension::class.java)
 
-    private fun enabled(project: Project): Boolean{
-        return PersistenceService.getInstance(project).state.isAutoOtel
+    private fun enabled(): Boolean{
+        return PersistenceService.getInstance().state.isAutoOtel
     }
 
     /*
@@ -68,7 +68,7 @@ class AutoOtelAgentRunConfigurationExtension : RunConfigurationExtension() {
         val project = configuration.project
 
         //testing if enabled must be done here just before running.
-        if (!enabled(project)){
+        if (!enabled()){
             Log.log(logger::debug,"AutoOtelAgentRunConfigurationExtension is not enabled")
             return
         }
@@ -171,8 +171,7 @@ class AutoOtelAgentRunConfigurationExtension : RunConfigurationExtension() {
         configuration: RunConfigurationBase<*>,
         executor: Executor
     ): ConsoleView {
-        val project = configuration.project
-        if (enabled(project)  &&
+        if (enabled()  &&
             (isMavenConfiguration(configuration) || isJavaConfiguration(configuration))){
             //that only works for java and maven run configurations.
             console.print("This process is enhanced by Digma OTEL agent !\n", ConsoleViewContentType.LOG_WARNING_OUTPUT)

java/src/main/kotlin/org/digma/intellij/plugin/idea/runcfg/AutoOtelAgentRunConfigurationExtension.kt

@@ -1,3 +1,8 @@
 package org.digma.intellij.plugin.persistence
 
-data class PersistenceData(var currentEnv: String? = null,var isWorkspaceOnly: Boolean = false,var isAutoOtel: Boolean = false)
+data class PersistenceData(
+        var currentEnv: String? = null,
+        var isWorkspaceOnly: Boolean = false,
+        var isAutoOtel: Boolean = false,
+        var alreadyPassedTheInstallationWizard: Boolean = false
+)

model/src/main/kotlin/org/digma/intellij/plugin/persistence/PersistenceData.kt

@@ -21,9 +21,9 @@
 import org.digma.intellij.plugin.analytics.BackendConnectionUtil;
 import org.digma.intellij.plugin.log.Log;
 import org.digma.intellij.plugin.model.rest.installationwizard.OpenInBrowserRequest;
+import org.digma.intellij.plugin.persistence.PersistenceService;
 import org.digma.intellij.plugin.psi.LanguageService;
 import org.digma.intellij.plugin.service.ErrorsActionsService;
-import org.digma.intellij.plugin.settings.SettingsState;
 import org.digma.intellij.plugin.toolwindow.recentactivity.ConnectionCheckResult;
 import org.digma.intellij.plugin.toolwindow.recentactivity.JBCefBrowserUtil;
 import org.digma.intellij.plugin.toolwindow.recentactivity.JcefConnectionCheckMessagePayload;
@@ -83,7 +83,7 @@ public void createToolWindowContent(@NotNull Project project, @NotNull ToolWindo
         BackendConnectionUtil backendConnectionUtil = project.getService(BackendConnectionUtil.class);
         toolWindow.getContentManager().addContentManagerListener(errorsActionsService);
 
-        if (SettingsState.getInstance(project).alreadyPassedTheInstallationWizard) {
+        if (PersistenceService.getInstance().getState().getAlreadyPassedTheInstallationWizard()) {
             displayMainSidePaneWindowPanel(project, toolWindow, contentFactory);
         } else {
             displayInstallationWizard(project, toolWindow, contentFactory, backendConnectionUtil);
@@ -195,10 +195,9 @@ private void changeToolWindowContent(@NotNull Project project, ToolWindow toolWi
         toolWindow.getContentManager().removeContent(content, true);
         toolWindow.getContentManager().addContent(newContent);
 
-        if (!SettingsState.getInstance(project).alreadyPassedTheInstallationWizard) {
-            // set flag that this use has already passed the installation wizard
-            SettingsState.getInstance(project).alreadyPassedTheInstallationWizard = true;
-            SettingsState.getInstance(project).fireChanged();
+        if (!PersistenceService.getInstance().getState().getAlreadyPassedTheInstallationWizard()) {
+            // set global flag that this user has already passed the installation wizard
+            PersistenceService.getInstance().getState().setAlreadyPassedTheInstallationWizard(true);
         }
     }
 

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

@@ -48,10 +48,10 @@ class SettingsHintPanel(project: Project) : JPanel() {
         togglePanel.background = Laf.Colors.EDITOR_BACKGROUND
         togglePanel.isOpaque = true
         togglePanel.add(JLabel("Observability"))
-        val toggle = SwitchButton(40, 20, PersistenceService.getInstance(project).state.isAutoOtel)
+        val toggle = SwitchButton(40, 20, PersistenceService.getInstance().state.isAutoOtel)
         toggle.addEventSelected(object : SwitchButton.EventSwitchSelected {
             override fun onSelected(selected: Boolean) {
-                PersistenceService.getInstance(project).state.isAutoOtel = selected
+                PersistenceService.getInstance().state.isAutoOtel = selected
             }
         })
         togglePanel.add(toggle)

src/main/kotlin/org/digma/intellij/plugin/ui/common/SettingsHintPanel.kt

@@ -225,10 +225,10 @@ fun bottomPanel(project: Project,errorsModel: ErrorsModel, framesList: Scrollabl
                     isOpaque = false
                     isContentAreaFilled = false
                     isBorderPainted = false
-                    isSelected = project.getService(PersistenceService::class.java).state.isWorkspaceOnly
-                    addActionListener(){
+                    isSelected = PersistenceService.getInstance().state.isWorkspaceOnly
+                    addActionListener {
                         errorsModel.errorDetails.flowStacks.isWorkspaceOnly = isSelected
-                        project.getService(PersistenceService::class.java).state.isWorkspaceOnly = isSelected
+                        PersistenceService.getInstance().state.isWorkspaceOnly = isSelected
                         framesList.getModel().setListData(errorsModel.errorDetails.flowStacks.getCurrentStack())
                         ActivityMonitor.getInstance(project).registerInsightButtonClicked("error-frame-workspace-only")
                     }