fix(gv-policy-studio): make dynamic properties backward compatible

Related to gravitee-io/issues#5910
gravitee-io · Jul 30, 2021 · 0e894f5 · 0e894f5
1 parent b65304b
commit 0e894f5
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 33 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/organisms/gv-properties.js b/src/organisms/gv-properties.js
@@ -45,6 +45,7 @@ import { empty } from '../styles/empty';
 export class GvProperties extends KeyboardElement(LitElement) {
   static get properties() {
     return {
+      dynamicPropertySchema: { type: Object },
       properties: { type: Array },
       _properties: { type: Array, attribute: false },
       provider: { type: Object },
@@ -208,44 +209,47 @@ export class GvProperties extends KeyboardElement(LitElement) {
   }
 
   _onConfigureDynamicProperties() {
-    const providersTitleMap = this.providers.reduce((map, provider) => {
-      map[provider.id] = provider.key;
-      return map;
-    }, {});
-
-    const providersEnum = Object.keys(providersTitleMap);
-    const defaultSchema = {
-      properties: {
-        enabled: {
-          type: 'boolean',
-          title: 'Enabled',
-          description: ' This service is requiring an API deployment. Do not forget to deploy API to start dynamic-properties service.',
-        },
-        schedule: {
-          type: 'string',
-          title: 'Schedule',
-          'x-schema-form': {
-            'cron-expression': true,
+    if (this.dynamicPropertySchema == null) {
+      // dynamicPropertySchema has been introduced to ensure backward compatibility with old versions. If no schema is provided a default schema will be used.
+      const providersTitleMap = this.providers.reduce((map, provider) => {
+        map[provider.id] = provider.key;
+        return map;
+      }, {});
+
+      const providersEnum = Object.keys(providersTitleMap);
+      this.dynamicPropertySchema = {
+        properties: {
+          enabled: {
+            type: 'boolean',
+            title: 'Enabled',
+            description: ' This service is requiring an API deployment. Do not forget to deploy API to start dynamic-properties service.',
           },
-        },
-        provider: {
-          type: 'string',
-          title: 'Provider type',
-          enum: providersEnum,
-          default: providersEnum[0],
-          'x-schema-form': {
-            titleMap: providersTitleMap,
+          schedule: {
+            type: 'string',
+            title: 'Schedule',
+            'x-schema-form': {
+              'cron-expression': true,
+            },
+          },
+          provider: {
+            type: 'string',
+            title: 'Provider type',
+            enum: providersEnum,
+            default: providersEnum[0],
+            'x-schema-form': {
+              titleMap: providersTitleMap,
+            },
           },
         },
-      },
-      required: ['schedule', 'provider'],
-    };
+        required: ['schedule', 'provider'],
+      };
+    }
 
     const defaultProvider = this.providers[0];
 
     this._propertySchemaForm = {
-      properties: { ...defaultSchema.properties, configuration: defaultProvider.schema },
-      required: defaultSchema.required,
+      properties: { ...this.dynamicPropertySchema.properties, configuration: defaultProvider.schema },
+      required: this.dynamicPropertySchema.required,
     };
     this._providerDocumentation = defaultProvider.documentation;
     this._maximizeBottomView();

diff --git a/src/policy-studio/gv-policy-studio.js b/src/policy-studio/gv-policy-studio.js
@@ -48,6 +48,7 @@ const FLOW_STEP_FORM_ID = 'flow-step-form';
  * @attr {Array} services - Services available
  * @attr {Array} resourceTypes - Resources types available
  * @attr {Array} propertyProviders - Providers of properties
+ * @attr {Array} dynamicPropertySchema - Schema for the dynamic property form
  * @attr {String} tabId - Current tabId to display (design, settings, properties or resources)
  * @attr {Object} definition - The definition of flows
  * @attr {Object} documentation - The documentation to display
@@ -70,6 +71,7 @@ export class GvPolicyStudio extends KeyboardElement(LitElement) {
       services: { type: Object },
       resourceTypes: { type: Array, attribute: 'resource-types' },
       propertyProviders: { type: Array, attribute: 'property-providers' },
+      dynamicPropertySchema: { type: Object, attribute: 'dynamic-property-schema' },
       tabId: { type: String, attribute: 'tab-id' },
       _tabId: { type: String, attribute: false },
       definition: { type: Object },
@@ -1704,6 +1706,7 @@ export class GvPolicyStudio extends KeyboardElement(LitElement) {
           ?readonly="${readonlyMode}"
           .properties="${this.definedProperties}"
           .providers="${this.propertyProviders}"
+          .dynamicPropertySchema="${this.dynamicPropertySchema}"
         ></gv-properties>
         <gv-resources
           id="resources"