CB-3703 save product configuration from ui (#2334)

* CB-4560 api for saving product configuration * CB-4560 save product config in te * CB-4560 move update product config to mutations * CB-3703 feat: extend base components * CB-3703 feat: settings editor * CB-3703 chore: review fixes * CB-3703 chore: pr review * CB-3703 feat: update server configuration icon * CB-4560 add events * CB-3703 fix: localization * CB-3703 chore: localization --------- Co-authored-by: Alexey <[email protected]> Co-authored-by: Evgenia Bezborodova <[email protected]>
dbeaver · Jan 31, 2024 · fdde434 · fdde434
1 parent 11adc7d
commit fdde434
Show file tree

Hide file tree

Showing 355 changed files with 4,305 additions and 2,059 deletions.
diff --git a/server/bundles/io.cloudbeaver.server/src/io/cloudbeaver/server/CBApplication.java b/server/bundles/io.cloudbeaver.server/src/io/cloudbeaver/server/CBApplication.java
@@ -895,11 +895,7 @@ public synchronized void finishConfiguration(
             }
         }
 
-        String sessionId = null;
-        if (credentialsProvider != null && credentialsProvider.getActiveUserCredentials() != null) {
-            sessionId = credentialsProvider.getActiveUserCredentials().getSmSessionId();
-        }
-        eventController.addEvent(new WSServerConfigurationChangedEvent(sessionId, null));
+        sendConfigChangedEvent(credentialsProvider);
         eventController.setForceSkipEvents(isConfigurationMode());
     }
 
@@ -992,11 +988,10 @@ protected void saveRuntimeConfig(
             sessionExpireTime,
             appConfig);
         validateConfiguration(configurationProperties);
-        writeRuntimeConfig(configurationProperties);
+        writeRuntimeConfig(getRuntimeAppConfigFile(), configurationProperties);
     }
 
-    private void writeRuntimeConfig(Map<String, Object> configurationProperties) throws DBException {
-        File runtimeConfigFile = getRuntimeAppConfigFile();
+    private void writeRuntimeConfig(File runtimeConfigFile, Map<String, Object> configurationProperties) throws DBException {
         if (runtimeConfigFile.exists()) {
             ContentUtils.makeFileBackup(runtimeConfigFile.toPath());
         }
@@ -1024,33 +1019,7 @@ protected Map<String, Object> collectConfigurationProperties(
             var serverConfigProperties = new LinkedHashMap<String, Object>();
             var originServerConfig = getServerConfigProps(this.originalConfigurationProperties); // get server properties from original configuration file
             rootConfig.put("server", serverConfigProperties);
-            if (!CommonUtils.isEmpty(newServerName)) {
-                copyConfigValue(originServerConfig,
-                    serverConfigProperties,
-                    CBConstants.PARAM_SERVER_NAME,
-                    newServerName);
-            }
-            if (!CommonUtils.isEmpty(newServerURL)) {
-                copyConfigValue(
-                    originServerConfig, serverConfigProperties, CBConstants.PARAM_SERVER_URL, newServerURL);
-            }
-            if (sessionExpireTime > 0) {
-                copyConfigValue(
-                    originServerConfig,
-                    serverConfigProperties,
-                    CBConstants.PARAM_SESSION_EXPIRE_PERIOD,
-                    sessionExpireTime);
-            }
-            var databaseConfigProperties = new LinkedHashMap<String, Object>();
-            Map<String, Object> oldRuntimeDBConfig = JSONUtils.getObject(originServerConfig,
-                CBConstants.PARAM_DB_CONFIGURATION);
-            if (!CommonUtils.isEmpty(databaseConfiguration) && !isDistributed()) {
-                for (Map.Entry<String, Object> mp : databaseConfiguration.entrySet()) {
-                    copyConfigValue(oldRuntimeDBConfig, databaseConfigProperties, mp.getKey(), mp.getValue());
-                }
-                serverConfigProperties.put(CBConstants.PARAM_DB_CONFIGURATION, databaseConfigProperties);
-            }
-            savePasswordPolicyConfig(originServerConfig, serverConfigProperties);
+            collectServerConfigProperties(newServerName, newServerURL, sessionExpireTime, originServerConfig, serverConfigProperties);
         }
         {
             var appConfigProperties = new LinkedHashMap<String, Object>();
@@ -1160,7 +1129,43 @@ protected Map<String, Object> collectConfigurationProperties(
         return rootConfig;
     }
 
-    private void savePasswordPolicyConfig(Map<String, Object> originServerConfig, LinkedHashMap<String, Object> serverConfigProperties) {
+    protected void collectServerConfigProperties(
+        String newServerName,
+        String newServerURL,
+        long sessionExpireTime,
+        Map<String, Object> originServerConfig,
+        Map<String, Object> serverConfigProperties
+    ) {
+        if (!CommonUtils.isEmpty(newServerName)) {
+            copyConfigValue(originServerConfig,
+                serverConfigProperties,
+                CBConstants.PARAM_SERVER_NAME,
+                newServerName);
+        }
+        if (!CommonUtils.isEmpty(newServerURL)) {
+            copyConfigValue(
+                originServerConfig, serverConfigProperties, CBConstants.PARAM_SERVER_URL, newServerURL);
+        }
+        if (sessionExpireTime > 0) {
+            copyConfigValue(
+                originServerConfig,
+                serverConfigProperties,
+                CBConstants.PARAM_SESSION_EXPIRE_PERIOD,
+                sessionExpireTime);
+        }
+        var databaseConfigProperties = new LinkedHashMap<String, Object>();
+        Map<String, Object> oldRuntimeDBConfig = JSONUtils.getObject(originServerConfig,
+            CBConstants.PARAM_DB_CONFIGURATION);
+        if (!CommonUtils.isEmpty(databaseConfiguration) && !isDistributed()) {
+            for (Map.Entry<String, Object> mp : databaseConfiguration.entrySet()) {
+                copyConfigValue(oldRuntimeDBConfig, databaseConfigProperties, mp.getKey(), mp.getValue());
+            }
+            serverConfigProperties.put(CBConstants.PARAM_DB_CONFIGURATION, databaseConfigProperties);
+        }
+        savePasswordPolicyConfig(originServerConfig, serverConfigProperties);
+    }
+
+    private void savePasswordPolicyConfig(Map<String, Object> originServerConfig, Map<String, Object> serverConfigProperties) {
         // save password policy configuration
         var passwordPolicyProperties = new LinkedHashMap<String, Object>();
 
@@ -1297,4 +1302,19 @@ public Class<? extends DBPPlatform> getPlatformClass() {
     public Class<? extends DBPPlatformUI> getPlatformUIClass() {
         return CBPlatformUI.class;
     }
+
+    public void saveProductConfiguration(SMCredentialsProvider credentialsProvider, Map<String, Object> productConfiguration) throws DBException {
+        Map<String, Object> mergedConfig = WebAppUtils.mergeConfigurations(this.productConfiguration, productConfiguration);
+        writeRuntimeConfig(getRuntimeProductConfigFilePath().toFile(), mergedConfig);
+        this.productConfiguration.putAll(mergedConfig);
+        sendConfigChangedEvent(credentialsProvider);
+    }
+
+    protected void sendConfigChangedEvent(SMCredentialsProvider credentialsProvider) {
+        String sessionId = null;
+        if (credentialsProvider != null && credentialsProvider.getActiveUserCredentials() != null) {
+            sessionId = credentialsProvider.getActiveUserCredentials().getSmSessionId();
+        }
+        eventController.addEvent(new WSServerConfigurationChangedEvent(sessionId, null));
+    }
 }
diff --git a/server/bundles/io.cloudbeaver.service.admin/schema/service.admin.graphqls b/server/bundles/io.cloudbeaver.service.admin/schema/service.admin.graphqls
@@ -206,3 +206,8 @@ extend type Query {
     setDefaultNavigatorSettings( settings: NavigatorSettingsInput!): Boolean!
 
 }
+
+extend type Mutation {
+    # Updates product configuration
+    adminUpdateProductConfiguration(configuration: Object!): Boolean! @since(version: "23.3.4")
+}
diff --git a/...undles/io.cloudbeaver.service.admin/src/io/cloudbeaver/service/admin/DBWServiceAdmin.java b/...undles/io.cloudbeaver.service.admin/src/io/cloudbeaver/service/admin/DBWServiceAdmin.java
@@ -138,6 +138,9 @@ WebAuthProviderConfiguration saveAuthProviderConfiguration(
     @WebAction(requirePermissions = DBWConstants.PERMISSION_ADMIN)
     boolean setDefaultNavigatorSettings(WebSession webSession, DBNBrowseSettings settings) throws DBWebException;
 
+    @WebAction(requirePermissions = DBWConstants.PERMISSION_ADMIN)
+    boolean updateProductConfiguration(WebSession webSession, Map<String, Object> productConfiguration) throws DBWebException;
+
     ////////////////////////////////////////////////////////////////////
     // Permissions
 
@@ -179,6 +182,7 @@ boolean setSubjectConnectionAccess(@NotNull WebSession webSession, @NotNull Stri
         DBWebException;
 
     ////////////////////////////////////////////////////////////////////
+
     // User meta parameters
 
     @WebAction(requirePermissions = DBWConstants.PERMISSION_ADMIN)
@@ -187,11 +191,11 @@ WebPropertyInfo saveUserMetaParameter(WebSession webSession, String id, String d
 
     @WebAction(requirePermissions = DBWConstants.PERMISSION_ADMIN)
     Boolean deleteUserMetaParameter(WebSession webSession, String id) throws DBWebException;
-
     @WebAction(requirePermissions = DBWConstants.PERMISSION_ADMIN)
     Boolean setUserMetaParameterValues(WebSession webSession, String userId, Map<String, String> parameters) throws DBWebException;
     @WebAction(requirePermissions = DBWConstants.PERMISSION_ADMIN)
     Boolean setTeamMetaParameterValues(WebSession webSession, String teamId, Map<String, String> parameters) throws DBWebException;
+
     @WebAction(requirePermissions = DBWConstants.PERMISSION_ADMIN)
     Boolean enableUser(WebSession webSession, String userId, Boolean enabled) throws DBWebException;
 

diff --git a/...io.cloudbeaver.service.admin/src/io/cloudbeaver/service/admin/WebServiceBindingAdmin.java b/...io.cloudbeaver.service.admin/src/io/cloudbeaver/service/admin/WebServiceBindingAdmin.java
@@ -185,6 +185,9 @@ public void bindWiring(DBWBindingContext model) throws DBWebException {
         .dataFetcher("setDefaultNavigatorSettings",
             env -> getService(env).setDefaultNavigatorSettings(getWebSession(env), WebServiceUtils.parseNavigatorSettings(env.getArgument("settings"))))
         ;
+        model.getMutationType()
+            .dataFetcher("adminUpdateProductConfiguration",
+                env -> getService(env).updateProductConfiguration(getWebSession(env), env.getArgument("configuration")));
     }
 
     @Override

diff --git a/...s/io.cloudbeaver.service.admin/src/io/cloudbeaver/service/admin/impl/WebServiceAdmin.java b/...s/io.cloudbeaver.service.admin/src/io/cloudbeaver/service/admin/impl/WebServiceAdmin.java
@@ -609,6 +609,17 @@ public boolean setDefaultNavigatorSettings(WebSession webSession, DBNBrowseSetti
         return true;
     }
 
+
+    @Override
+    public boolean updateProductConfiguration(WebSession webSession, Map<String, Object> productConfiguration) throws DBWebException {
+        try {
+            CBApplication.getInstance().saveProductConfiguration(webSession, productConfiguration);
+            return true;
+        } catch (DBException e) {
+            throw new DBWebException("Error updating product configuration", e);
+        }
+    }
+
     ////////////////////////////////////////////////////////////////////
     // Access management
 

diff --git a/webapp/packages/core-administration/public/icons/server-configuration.svg b/webapp/packages/core-administration/public/icons/server-configuration.svg
diff --git a/webapp/packages/core-administration/src/AdministrationScreen/AdministrationScreenService.ts b/webapp/packages/core-administration/src/AdministrationScreen/AdministrationScreenService.ts
@@ -12,7 +12,7 @@ import { NotificationService } from '@cloudbeaver/core-events';
 import { Executor, IExecutor } from '@cloudbeaver/core-executor';
 import { EAdminPermission, PermissionsService, ServerConfigResource, SessionPermissionsResource } from '@cloudbeaver/core-root';
 import { RouterState, ScreenService } from '@cloudbeaver/core-routing';
-import { LocalStorageSaveService } from '@cloudbeaver/core-settings';
+import { SettingsService } from '@cloudbeaver/core-settings';
 import { GlobalConstants } from '@cloudbeaver/core-utils';
 
 import { AdministrationItemService } from '../AdministrationItem/AdministrationItemService';
@@ -69,7 +69,7 @@ export class AdministrationScreenService {
     private readonly permissionsService: PermissionsService,
     private readonly screenService: ScreenService,
     private readonly administrationItemService: AdministrationItemService,
-    private readonly autoSaveService: LocalStorageSaveService,
+    private readonly settingsService: SettingsService,
     private readonly serverConfigResource: ServerConfigResource,
     private readonly notificationService: NotificationService,
   ) {
@@ -84,8 +84,8 @@ export class AdministrationScreenService {
       activeScreen: computed,
     });
 
-    this.autoSaveService.withAutoSave(ADMINISTRATION_ITEMS_STATE, this.itemState, () => new Map());
-    this.autoSaveService.withAutoSave(ADMINISTRATION_INFO, this.info, getDefaultAdministrationScreenInfo);
+    this.settingsService.registerSettings(ADMINISTRATION_ITEMS_STATE, this.itemState, () => new Map());
+    this.settingsService.registerSettings(ADMINISTRATION_INFO, this.info, getDefaultAdministrationScreenInfo);
     this.permissionsResource.onDataUpdate.addPostHandler(() => {
       this.checkPermissions(this.screenService.routerService.state);
     });

diff --git a/webapp/packages/core-administration/src/AdministrationSettingsService.ts b/webapp/packages/core-administration/src/AdministrationSettingsService.ts
@@ -7,19 +7,20 @@
  */
 import { injectable } from '@cloudbeaver/core-di';
 import { PluginManagerService, PluginSettings } from '@cloudbeaver/core-plugin';
+import { schema } from '@cloudbeaver/core-utils';
 
-const defaultSettings = {
-  baseFeatures: [] as string[],
-};
+const settingsSchema = schema.object({
+  baseFeatures: schema.array(schema.string()).default([]),
+});
 
-export type AdministrationSettings = typeof defaultSettings;
+export type AdministrationSettings = schema.infer<typeof settingsSchema>;
 
 @injectable()
 export class AdministrationSettingsService {
-  readonly settings: PluginSettings<AdministrationSettings>;
+  readonly settings: PluginSettings<typeof settingsSchema>;
 
   constructor(private readonly pluginManagerService: PluginManagerService) {
-    this.settings = this.pluginManagerService.createSettings('administration', 'core', defaultSettings);
+    this.settings = this.pluginManagerService.createSettings('administration', 'core', settingsSchema);
   }
 
   isBase(feature: string): boolean {

diff --git a/webapp/packages/core-administration/tsconfig.json b/webapp/packages/core-administration/tsconfig.json
@@ -6,6 +6,9 @@
     "tsBuildInfoFile": "dist/tsconfig.tsbuildinfo"
   },
   "references": [
+    {
+      "path": "../core-browser/tsconfig.json"
+    },
     {
       "path": "../core-data-context/tsconfig.json"
     },
@@ -16,58 +19,55 @@
       "path": "../core-events/tsconfig.json"
     },
     {
-      "path": "../core-executor/tsconfig.json"
-    },
-    {
-      "path": "../core-localization/tsconfig.json"
+      "path": "../core-events/tsconfig.json"
     },
     {
-      "path": "../core-plugin/tsconfig.json"
+      "path": "../core-executor/tsconfig.json"
     },
     {
-      "path": "../core-resource/tsconfig.json"
+      "path": "../core-localization/tsconfig.json"
     },
     {
-      "path": "../core-root/tsconfig.json"
+      "path": "../core-localization/tsconfig.json"
     },
     {
-      "path": "../core-routing/tsconfig.json"
+      "path": "../core-plugin/tsconfig.json"
     },
     {
-      "path": "../core-sdk/tsconfig.json"
+      "path": "../core-plugin/tsconfig.json"
     },
     {
-      "path": "../core-settings/tsconfig.json"
+      "path": "../core-product/tsconfig.json"
     },
     {
-      "path": "../core-theming/tsconfig.json"
+      "path": "../core-resource/tsconfig.json"
     },
     {
-      "path": "../core-utils/tsconfig.json"
+      "path": "../core-root/tsconfig.json"
     },
     {
-      "path": "../core-browser/tsconfig.json"
+      "path": "../core-root/tsconfig.json"
     },
     {
-      "path": "../core-events/tsconfig.json"
+      "path": "../core-routing/tsconfig.json"
     },
     {
-      "path": "../core-localization/tsconfig.json"
+      "path": "../core-sdk/tsconfig.json"
     },
     {
-      "path": "../core-plugin/tsconfig.json"
+      "path": "../core-sdk/tsconfig.json"
     },
     {
-      "path": "../core-product/tsconfig.json"
+      "path": "../core-settings/tsconfig.json"
     },
     {
-      "path": "../core-root/tsconfig.json"
+      "path": "../core-settings/tsconfig.json"
     },
     {
-      "path": "../core-sdk/tsconfig.json"
+      "path": "../core-theming/tsconfig.json"
     },
     {
-      "path": "../core-settings/tsconfig.json"
+      "path": "../core-utils/tsconfig.json"
     },
     {
       "path": "../tests-runner/tsconfig.json"

diff --git a/webapp/packages/core-app/package.json b/webapp/packages/core-app/package.json
@@ -22,17 +22,16 @@
     "@cloudbeaver/core-executor": "~0.1.0",
     "@cloudbeaver/core-localization": "~0.1.0",
     "@cloudbeaver/core-notifications": "~0.1.0",
-    "@cloudbeaver/core-plugin": "~0.1.0",
     "@cloudbeaver/core-projects": "~0.1.0",
     "@cloudbeaver/core-resource": "~0.1.0",
     "@cloudbeaver/core-root": "~0.1.0",
     "@cloudbeaver/core-routing": "~0.1.0",
     "@cloudbeaver/core-theming": "~0.1.0",
     "@cloudbeaver/core-ui": "~0.1.0",
+    "@cloudbeaver/core-utils": "~0.1.0",
     "@cloudbeaver/core-version": "~0.1.0",
     "mobx-react-lite": "^4.0.5",
-    "react": "^18.2.0",
-    "@cloudbeaver/core-utils": "~0.1.0"
+    "react": "^18.2.0"
   },
   "peerDependencies": {},
   "devDependencies": {

diff --git a/webapp/packages/core-app/src/CoreSettingsService.ts b/webapp/packages/core-app/src/CoreSettingsService.ts
diff --git a/webapp/packages/core-app/src/index.ts b/webapp/packages/core-app/src/index.ts
@@ -1,5 +1,4 @@
 // Services
-export * from './CoreSettingsService';
 export * from './AppScreen/AppScreenService';
 export * from './AppScreen/AppScreenBootstrap';