Merge pull request #2378 from digma-ai/export-settings

shalom938 · web-flow · commit d199c4eac78a · 2024-08-08T18:49:47.000+03:00
export import settings Closes #2370
diff --git a/ide-common/src/main/java/org/digma/intellij/plugin/settings/ProjectSettings.java b/ide-common/src/main/java/org/digma/intellij/plugin/settings/ProjectSettings.java
@@ -93,61 +93,7 @@ public void apply() throws ConfigurationException {
         //run all checks and only then update the settings.
         //never update the settings before checks are complete because then the settings will have incorrect data
 
-        try {
-            Objects.requireNonNull(mySettingsComponent.getApiUrl(), "Api url can not be null");
-            Objects.requireNonNull(mySettingsComponent.getRuntimeObservabilityBackendUrl(), "Runtime observability url can not be null");
-        } catch (Exception e) {
-            throw new ConfigurationException(e.getMessage());
-        }
-
-        if (mySettingsComponent.getApiUrl().isBlank()) {
-            throw new ConfigurationException("Api url can not be empty");
-        }
-        if (!CommonUtils.isHttpsUrl(mySettingsComponent.getApiUrl())) {
-            throw new ConfigurationException("Api url schema must be https");
-        }
-        try {
-            URLValidator.create(mySettingsComponent.getApiUrl()).validate();
-        } catch (MalformedURLException | URISyntaxException | URLValidator.InvalidUrlException | URLValidator.QueryNotAllowedException |
-                 URLValidator.IncorrectSchemaException e) {
-            throw new ConfigurationException("Api url is not a well formed: " + e.getMessage());
-        }
-
-        if (mySettingsComponent.getRuntimeObservabilityBackendUrl().isBlank()) {
-            throw new ConfigurationException("Runtime observability url can not be empty");
-        }
-        try {
-            URLValidator.create(mySettingsComponent.getRuntimeObservabilityBackendUrl()).validate();
-        } catch (MalformedURLException | URISyntaxException | URLValidator.InvalidUrlException | URLValidator.QueryNotAllowedException |
-                 URLValidator.IncorrectSchemaException e) {
-            throw new ConfigurationException("Backend observability url is not a well formed: " + e.getMessage());
-        }
-
-
-        if (mySettingsComponent.getJaegerLinkMode() == JaegerLinkMode.Embedded) {
-            if (mySettingsComponent.getJaegerQueryUrl() == null || mySettingsComponent.getJaegerQueryUrl().trim().isBlank()) {
-                throw new ConfigurationException("Jaeger query url can not be empty in mode " + mySettingsComponent.getJaegerLinkMode());
-            }
-            try {
-                URLValidator.create(mySettingsComponent.getJaegerQueryUrl()).validate();
-            } catch (MalformedURLException | URISyntaxException | URLValidator.InvalidUrlException | URLValidator.QueryNotAllowedException |
-                     URLValidator.IncorrectSchemaException e) {
-                throw new ConfigurationException("Jaeger query url is not a well formed: " + e.getMessage());
-            }
-        } else {
-            if (mySettingsComponent.getJaegerUrl() == null || mySettingsComponent.getJaegerUrl().trim().isBlank()) {
-                throw new ConfigurationException("Jaeger url can not be empty in mode " + mySettingsComponent.getJaegerLinkMode());
-            }
-            try {
-                if (mySettingsComponent.getJaegerUrl() != null) {
-                    URLValidator.create(mySettingsComponent.getJaegerUrl()).validate();
-                }
-            } catch (MalformedURLException | URISyntaxException | URLValidator.InvalidUrlException | URLValidator.QueryNotAllowedException |
-                     URLValidator.IncorrectSchemaException e) {
-                throw new ConfigurationException("Jaeger url is not a well formed: " + e.getMessage());
-            }
-        }
-
+        SettingsUtils.validateSettings(mySettingsComponent);
 
         updateSettingsAndFireChange();
 
diff --git a/ide-common/src/main/java/org/digma/intellij/plugin/settings/SettingsComponent.java b/ide-common/src/main/java/org/digma/intellij/plugin/settings/SettingsComponent.java
@@ -1,6 +1,9 @@
 package org.digma.intellij.plugin.settings;
 
 import com.intellij.icons.AllIcons;
+import com.intellij.openapi.fileChooser.*;
+import com.intellij.openapi.options.ConfigurationException;
+import com.intellij.openapi.project.Project;
 import com.intellij.openapi.ui.*;
 import com.intellij.ui.*;
 import com.intellij.ui.components.*;
@@ -9,6 +12,7 @@
 import org.digma.intellij.plugin.analytics.BackendInfoHolder;
 import org.digma.intellij.plugin.auth.account.*;
 import org.digma.intellij.plugin.common.*;
+import org.digma.intellij.plugin.errorreporting.ErrorReporter;
 import org.jetbrains.annotations.*;
 
 import javax.swing.*;
@@ -49,6 +53,9 @@ class SettingsComponent {
 
     public SettingsComponent() {
 
+        var defaultLabelForeground = JBColor.foreground();
+
+
         extendedObservabilityTextFiled.setToolTipText("package names in format 'my.pkg1;my.pkg2");
         extendedObservabilityExcludeTextField.setToolTipText("class/method names to exclude in format 'MyClass;MyOtherClass.myOtherMethod;*get");
         var extendedObservabilityTextBoxPanel = new JBPanel<JBPanel<?>>();
@@ -58,8 +65,6 @@ public SettingsComponent() {
         extendedObservabilityExcludeTextBoxPanel.setLayout(new BorderLayout());
         extendedObservabilityExcludeTextBoxPanel.add(extendedObservabilityExcludeTextField, BorderLayout.CENTER);
 
-        var defaultLabelForeground = JBColor.foreground();
-
 
         var myUrlLabel = new JBLabel("Digma API URL: ");
         myApiUrlTextField.setInputVerifier(new InputVerifier() {
@@ -121,7 +126,6 @@ public boolean verify(JComponent input) {
 
 
         myRuntimeObservabilityBackendUrlLabel.setToolTipText("Where should observability data be sent from the IDE? This would be the Digma collector URL typically listening to port 5050");
-
         myRuntimeObservabilityBackendUrlTextField.setInputVerifier(new InputVerifier() {
             @Override
             public boolean verify(JComponent input) {
@@ -141,7 +145,6 @@ public boolean verify(JComponent input) {
 
 
         myEmbeddedJaegerMessage.setForeground(JBColor.BLUE);
-
         var myJaegerLinkModeLabel = new JBLabel("Jaeger link mode: ");
         myJaegerLinkModeLabel.setToolTipText("Internal will open the link as an embedded URL within the IDE. "
                 + "External will open the link externally to your default browser. "
@@ -157,45 +160,16 @@ public boolean verify(JComponent input) {
                 + "Micrometer will use Micrometer tracing, including the annotation of 'Observed' "
         );
 
-        var resetButton = new JButton("Reset to defaults");
-        resetButton.setToolTipText("<html><body>Reset the settings to initial defaults</body>");
-        resetButton.addActionListener(e -> resetToDefaults());
 
+        var resetToDefaultsButton = createResetToDefaultsButton();
 
-        var userId = "";
-        if (DigmaDefaultAccountHolder.getInstance().getAccount() != null &&
-                !DigmaDefaultAccountHolder.getInstance().getAccount().getUserId().equals(DigmaAccountKt.DEFAULT_LOGIN_ID)) {
-            userId = DigmaDefaultAccountHolder.getInstance().getAccount().getUserId();
-        }
-        var userIdLabel = new JBLabel(userId);
-        userIdLabel.setCopyable(true);
-
-        var backendVersionLabel = new JBLabel("Unknown");
-        var someProject = ProjectUtilsKt.findActiveProject();
-        if (someProject != null) {
-            var about = BackendInfoHolder.getInstance(someProject).getAbout();
-            if (about != null) {
-                backendVersionLabel.setText(about.getApplicationVersion());
-            }
-        }
+        var userIdLabel = createUserIdLabel();
 
+        var backendVersionLabel = createBackendVersionLabel();
 
-        pluginResetWarning.setForeground(JBColor.RED);
-        pluginResetWarning.setVisible(false);
-        var resetPluginButton = new JButton("Reset plugin");
-        resetPluginButton.setToolTipText("<html><body>Reset plugin persistent properties to initial values to simulate fresh start</body>");
-        resetPluginButton.setVisible("true".equalsIgnoreCase(System.getProperty("org.digma.plugin.resetPlugin.enabled")));
-        resetPluginButton.addActionListener(e -> {
-            var confirmation = Messages.showYesNoDialog("Are you sure?\n(Plugin will reset and IDE will restart when the settings window is closed)", "Reset Confirmation", AllIcons.General.WarningDialog);
-            if (confirmation == 0) {
-                resetPluginRequested = true;
-                pluginResetWarning.setVisible(true);
-            } else {
-                resetPluginRequested = false;
-                pluginResetWarning.setVisible(false);
-            }
-        });
+        var importExportPanel = createImportExportPanel();
 
+        var resetPluginButton = createResetPluginButton();
 
 
         myMainPanel = FormBuilder.createFormBuilder()
@@ -209,9 +183,10 @@ public boolean verify(JComponent input) {
                 .addLabeledComponent(myRuntimeObservabilityBackendUrlLabel, myRuntimeObservabilityBackendUrlTextField, 1, false)
                 .addLabeledComponent("Extended observability (beta)", extendedObservabilityTextBoxPanel, 1, false)
                 .addLabeledComponent("Extended observability exclude (beta)", extendedObservabilityExcludeTextBoxPanel, 1, false)
-                .addComponent(resetButton)
+                .addComponent(resetToDefaultsButton)
                 .addLabeledComponent(new JBLabel("User id"), userIdLabel)
                 .addLabeledComponent(new JBLabel("Backend version"), backendVersionLabel)
+                .addComponent(importExportPanel)
                 .addComponent(resetPluginButton)
                 .addComponent(pluginResetWarning)
                 .addComponentFillVertically(new JPanel(), 0)
@@ -348,10 +323,12 @@ public void resetResetPluginRequested() {
     }
 
 
-
     private void resetToDefaults() {
         //create a new SettingsState object and use it for default startup values
-        SettingsState settingsState = new SettingsState();
+        resetFromSettings(new SettingsState());
+    }
+
+    private void resetFromSettings(SettingsState settingsState) {
         resetResetPluginRequested();
         hidePluginResetWarning();
         this.setApiUrl(settingsState.getApiUrl());
@@ -370,4 +347,151 @@ private void resetToDefaults() {
     public void hidePluginResetWarning() {
         this.pluginResetWarning.setVisible(false);
     }
+
+
+    @NotNull
+    private JButton createResetToDefaultsButton() {
+        var resetButton = new JButton("Reset to defaults");
+        resetButton.setToolTipText("<html><body>Reset the settings to initial defaults</body>");
+        resetButton.addActionListener(e -> resetToDefaults());
+        return resetButton;
+    }
+
+
+    @NotNull
+    private static JBLabel createUserIdLabel() {
+        var userId = "";
+        if (DigmaDefaultAccountHolder.getInstance().getAccount() != null &&
+                !DigmaDefaultAccountHolder.getInstance().getAccount().getUserId().equals(DigmaAccountKt.DEFAULT_LOGIN_ID)) {
+            userId = DigmaDefaultAccountHolder.getInstance().getAccount().getUserId();
+        }
+        var userIdLabel = new JBLabel(userId);
+        userIdLabel.setCopyable(true);
+        return userIdLabel;
+    }
+
+
+    @NotNull
+    private static JBLabel createBackendVersionLabel() {
+        var backendVersionLabel = new JBLabel("Unknown");
+        var someProject = ProjectUtilsKt.findActiveProject();
+        if (someProject != null) {
+            var about = BackendInfoHolder.getInstance(someProject).getAbout();
+            if (about != null) {
+                backendVersionLabel.setText(about.getApplicationVersion());
+            }
+        }
+        return backendVersionLabel;
+    }
+
+
+    private JPanel createImportExportPanel() {
+        //noinspection ExtractMethodRecommender
+        var exportSettingsButton = new JButton("Export Settings");
+        exportSettingsButton.addActionListener(actionEvent -> {
+            try {
+
+                SettingsUtils.validateSettings(this);
+
+                var dialog = FileChooserFactory.getInstance().createSaveFileDialog(new FileSaverDescriptor("Export To File", "Export settings to file", "conf"), (Project) null);
+                var file = dialog.save("digma-setting.conf");
+                if (file != null) {
+                    var exportResult = SettingsUtils.exportSettingsToFile(file.getFile(), toProperties());
+                    if (!exportResult) {
+                        Messages.showErrorDialog("Could not export settings,Please check the logs.", "Export Error");
+                    }
+                }
+            } catch (ConfigurationException configurationException) {
+                Messages.showErrorDialog(configurationException.getMessage(), "Invalid Settings");
+            } catch (Throwable e) {
+                Messages.showErrorDialog(e.getMessage(), "Error");
+                ErrorReporter.getInstance().reportError("SettingsComponent.exportSettingsButton.ActionListener", e);
+            }
+        });
+
+        var importSettingsButton = new JButton("Import Settings");
+        importSettingsButton.addActionListener(actionEvent -> {
+            try {
+                var dialog = FileChooserFactory.getInstance().createPathChooser(new FileChooserDescriptor(true, false, false, false, false, false), null, myMainPanel);
+                dialog.choose(null, virtualFiles -> {
+                    if (virtualFiles.size() == 1) {
+                        var properties = SettingsUtils.importSettingsFromFile(virtualFiles.get(0));
+                        if (properties == null) {
+                            Messages.showErrorDialog("Could not import settings,Please check the logs.", "Import Error");
+                        } else {
+                            fromProperties(properties);
+                        }
+                    }
+                });
+            } catch (Throwable e) {
+                Messages.showErrorDialog(e.getMessage(), "Error");
+                ErrorReporter.getInstance().reportError("SettingsComponent.importSettingsButton.ActionListener", e);
+            }
+        });
+
+        var importExportPanel = new JPanel();
+        importExportPanel.add(exportSettingsButton);
+        importExportPanel.add(importSettingsButton);
+
+        return importExportPanel;
+    }
+
+
+    @NotNull
+    private JButton createResetPluginButton() {
+        pluginResetWarning.setForeground(JBColor.RED);
+        pluginResetWarning.setVisible(false);
+        var resetPluginButton = new JButton("Reset plugin");
+        resetPluginButton.setToolTipText("<html><body>Reset plugin persistent properties to initial values to simulate fresh start</body>");
+        resetPluginButton.setVisible("true".equalsIgnoreCase(System.getProperty("org.digma.plugin.resetPlugin.enabled")));
+        resetPluginButton.addActionListener(e -> {
+            var confirmation = Messages.showYesNoDialog("Are you sure?\n(Plugin will reset and IDE will restart when the settings window is closed)", "Reset Confirmation", AllIcons.General.WarningDialog);
+            if (confirmation == Messages.YES) {
+                resetPluginRequested = true;
+                pluginResetWarning.setVisible(true);
+            } else {
+                resetPluginRequested = false;
+                pluginResetWarning.setVisible(false);
+            }
+        });
+        return resetPluginButton;
+    }
+
+
+    private Map<String, String> toProperties() {
+        Map<String, String> properties = new HashMap<>();
+        properties.put("apiUrl", getApiUrl());
+        if (getApiToken() != null) {
+            properties.put("apiToken", getApiToken());
+        }
+        if (getJaegerUrl() != null) {
+            properties.put("jaegerUrl", getJaegerUrl());
+        }
+        if (getJaegerQueryUrl() != null) {
+            properties.put("jaegerQueryUrl", getJaegerQueryUrl());
+        }
+        properties.put("jaegerLinkMode", getJaegerLinkMode().name());
+        properties.put("springBootObservabilityMode", getSpringBootObservabilityMode().name());
+        properties.put("runtimeObservabilityBackendUrl", getRuntimeObservabilityBackendUrl());
+        if (getExtendedObservability() != null) {
+            properties.put("extendedObservability", getExtendedObservability());
+        }
+        if (getExtendedObservabilityExclude() != null) {
+            properties.put("extendedObservabilityExcludes", getExtendedObservabilityExclude());
+        }
+        return properties;
+    }
+
+    private void fromProperties(Map<String, String> properties) {
+        setApiUrl(properties.get("apiUrl"));
+        setApiToken(properties.get("apiToken"));
+        setJaegerUrl(properties.get("jaegerUrl"));
+        setJaegerQueryUrl(properties.get("jaegerQueryUrl"));
+        setJaegerLinkMode(JaegerLinkMode.valueOf(properties.get("jaegerLinkMode")));
+        setSpringBootObservabilityMode(SpringBootObservabilityMode.valueOf(properties.get("springBootObservabilityMode")));
+        setRuntimeObservabilityBackendUrl(properties.get("runtimeObservabilityBackendUrl"));
+        setExtendedObservability(properties.get("extendedObservability"));
+        setExtendedObservabilityExclude(properties.get("extendedObservabilityExcludes"));
+    }
+
 }
diff --git a/ide-common/src/main/java/org/digma/intellij/plugin/settings/SettingsState.java b/ide-common/src/main/java/org/digma/intellij/plugin/settings/SettingsState.java
@@ -38,7 +38,6 @@ public class SettingsState implements PersistentStateComponent<SettingsState>, D
 
     @NotNull
     private String apiUrl = DEFAULT_API_URL;
-
     @Nullable
     private String apiToken = null;
     @Nullable
@@ -206,6 +205,5 @@ public String getNormalizedExtendedObservabilityExcludes() {
         return normalizeExtendedObservabilityValue(extendedObservabilityExcludes);
     }
 
-
 }
 
diff --git a/ide-common/src/main/java/org/digma/intellij/plugin/settings/SettingsUtils.java b/ide-common/src/main/java/org/digma/intellij/plugin/settings/SettingsUtils.java

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,6 @@ public class SettingsState implements PersistentStateComponent<SettingsState>, D`
`38`	`38`
`39`	`39`	`@NotNull`
`40`	`40`	`private String apiUrl = DEFAULT_API_URL;`
`41`		`-`
`42`	`41`	`@Nullable`
`43`	`42`	`private String apiToken = null;`
`44`	`43`	`@Nullable`
`@@ -206,6 +205,5 @@ public String getNormalizedExtendedObservabilityExcludes() {`
`206`	`205`	`return normalizeExtendedObservabilityValue(extendedObservabilityExcludes);`
`207`	`206`	`}`
`208`	`207`
`209`		`-`
`210`	`208`	`}`
`211`	`209`