feat: allows async form providers

related to camunda/product-hub#1792
bpmn-io · Nov 21, 2023 · 99b61c4 · 99b61c4
1 parent cd0a6df
commit 99b61c4
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 3 deletions.
diff --git a/lib/variableProvider/index.js b/lib/variableProvider/index.js
@@ -11,13 +11,13 @@ class FormVariableProvider extends VariableProvider {
     this._eventBus = eventBus;
   }
 
-  getVariables(element) {
+  async getVariables(element) {
 
     /**
      * Use the eventBus to collect form schemas. We currently only support locally defined forms,
      * but plan to have linked forms on a project level soon.
      */
-    const formSchema = this._eventBus.fire('formVariableProvider.getFormSchema', { element });
+    const formSchema = await (this._eventBus.fire('formVariableProvider.getFormSchema', { element }));
 
     if (!formSchema) {
       return;

diff --git a/test/spec/Integration.spec.js b/test/spec/Integration.spec.js
@@ -13,7 +13,7 @@ import FormVariableProvider from 'lib/';
 
 import placeholderXML from '../fixtures/placeholder.bpmn';
 import startFormXML from '../fixtures/start-form.bpmn';
-
+import sinon from 'sinon';
 
 
 describe('<Form Extractor>', function() {
@@ -209,4 +209,73 @@ describe('<Form Extractor>', function() {
 
   });
 
+
+  describe('additional extractors', async function() {
+
+    it('should allow async extractors', async function() {
+
+      // given
+      let clock = sinon.useFakeTimers();
+
+      const form = `{
+          "components": [
+            {
+              "label": "Number",
+              "type": "number",
+              "layout": {
+                "row": "Row_0tsd0f1",
+                "columns": null
+              },
+              "id": "Field_164bcb2",
+              "key": "Number_1"
+            },
+            {
+              "label": "Text field",
+              "type": "textfield",
+              "layout": {
+                "row": "Row_1l0lwcs",
+                "columns": null
+              },
+              "id": "Field_1b97d86",
+              "key": "Text_1"
+            }
+          ],
+          "type": "default",
+          "id": "Form_0",
+          "schemaVersion": 10
+        }`;
+
+      await createModelerWithForm('');
+      const modeler = getBpmnJS();
+
+      const eventBus = modeler.get('eventBus');
+      const elementRegistry = modeler.get('elementRegistry');
+      const variableResolver = modeler.get('variableResolver');
+
+      const task = elementRegistry.get('Task_1');
+
+      const MockProvider = ({ element }) => {
+        if (element.id === task.id) {
+          return new Promise(resolve => setTimeout(resolve(form), 100));
+        }
+      };
+
+      eventBus.on('formVariableProvider.getFormSchema', MockProvider);
+
+      // when
+      const variables = await variableResolver.getVariablesForElement(task);
+      await clock.tick(1000);
+
+      // then
+      expect(variables).to.variableEqual([
+        { name: 'Number_1', info: 'Returned from Form in Form Task' },
+        { name: 'Text_1', info: 'Returned from Form in Form Task' }
+      ]);
+
+      clock.restore();
+
+    });
+
+  });
+
 });