Make the preference schema validation optional (#11189)

It costs time at startup and it only logs warnings. Can be disabled with the `validatePreferencesSchema` fronted app config. Signed-off-by: Akos Kitta <[email protected]>
eclipse-theia · May 24, 2022 · fad026f · fad026f
1 parent eb5b668
commit fad026f
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/dev-packages/application-package/src/application-props.ts b/dev-packages/application-package/src/application-props.ts
@@ -55,7 +55,8 @@ export namespace FrontendApplicationConfig {
         defaultTheme: 'dark',
         defaultIconTheme: 'none',
         electron: ElectronFrontendApplicationConfig.DEFAULT,
-        defaultLocale: ''
+        defaultLocale: '',
+        validatePreferencesSchema: true
     };
     export interface Partial extends ApplicationConfig {
 
@@ -93,6 +94,14 @@ export namespace FrontendApplicationConfig {
          * Defaults to "".
          */
         readonly defaultLocale?: string;
+
+        /**
+         * When `true`, the application will validate the JSON schema of the preferences on start
+         * and log warnings to the console if the schema is not valid.
+         *
+         * Defaults to `true`.
+         */
+        readonly validatePreferencesSchema?: boolean;
     }
 }
 

diff --git a/packages/core/src/browser/preferences/preference-contribution.ts b/packages/core/src/browser/preferences/preference-contribution.ts
@@ -188,13 +188,19 @@ export class PreferenceSchemaProvider extends PreferenceProvider {
         return inverseChanges;
     }
 
-    protected doSetSchema(schema: PreferenceSchema): PreferenceProviderDataChange[] {
+    protected validateSchema(schema: PreferenceSchema): void {
         const ajv = new Ajv();
         const valid = ajv.validateSchema(schema);
         if (!valid) {
             const errors = !!ajv.errors ? ajv.errorsText(ajv.errors) : 'unknown validation error';
             console.warn('A contributed preference schema has validation issues : ' + errors);
         }
+    }
+
+    protected doSetSchema(schema: PreferenceSchema): PreferenceProviderDataChange[] {
+        if (FrontendApplicationConfigProvider.get().validatePreferencesSchema) {
+            this.validateSchema(schema);
+        }
         const scope = PreferenceScope.Default;
         const domain = this.getDomain();
         const changes: PreferenceProviderDataChange[] = [];