Feature/validate data item ids (#140)

* add validation to data objects

* I realized that the request was for data inputs

* minor fixes

Author: essweine

app/spiffworkflow/DataObject/propertiesPanel/DataObjectArray.js

@@ -1,4 +1,5 @@
 import { useService } from 'bpmn-js-properties-panel';
+import { useCallback } from '@bpmn-io/properties-panel/preact/hooks';
 import { SpiffExtensionTextInput } from '../../extensions/propertiesPanel/SpiffExtensionTextInput';
 import {
   isTextFieldEntryEdited,
@@ -13,7 +14,8 @@ import {
   idToHumanReadableName,
   findDataObject,
 } from '../DataObjectHelpers';
-import { processId } from '../../helpers';
+import { validateDataId } from '../../helpers';
+
 
 /**
  * Provides a list of data objects, and allows you to add / remove data objects, and change their ids.
@@ -140,41 +142,43 @@ function DataObjectTextField(props) {
   const commandStack = useService('commandStack');
   const debounce = useService('debounceInput');
 
-  const setValue = (value) => {
-    try {
-      // Check if new dataObject Id is not unique
-      if (findDataObject(element.businessObject, value) !== undefined) {
-        alert('Data Object ID Should be unique');
-        return;
-      }
-
-      // let doName = idToHumanReadableName(value);
-      commandStack.execute('element.updateModdleProperties', {
-        element,
-        moddleElement: dataObject,
-        properties: {
-          id: processId(value),
-          // name: doName
-        },
-      });
-      // Update references name
-      // updateDataObjectReferencesName(element, doName, value, commandStack);
-    } catch (error) {
-      console.log('Set Value Error : ', error);
-    }
+  const setValue = (value, error) => {
+    if (error)
+      return;
+
+    // let doName = idToHumanReadableName(value);
+    commandStack.execute('element.updateModdleProperties', {
+      element,
+      moddleElement: dataObject,
+      properties: {
+        id: value,
+        // name: doName
+      },
+    });
+    // Update references name
+    // updateDataObjectReferencesName(element, doName, value, commandStack);
   };
 
   const getValue = () => {
     return dataObject.id;
   };
 
+  const validate = useCallback(value => {
+    const current = findDataObject(element.businessObject, value);
+    let message = validateDataId(value);
+    if (current !== undefined && current !== dataObject)
+      message = 'ID must be unique';
+    return message;
+  }, [element]);
+
   return TextFieldEntry({
     element: parameter,
     id: `${idPrefix}-id`,
     label: 'Data Object Id',
     getValue,
     setValue,
     debounce,
+    validate
   });
 }
 

app/spiffworkflow/InputOutput/IoInterceptor.js

@@ -32,6 +32,7 @@ export default class IoInterceptor extends CommandInterceptor {
         let di = context.shape.di;
         let generator = new IdGenerator(type_name);
         let dataIO = bpmnFactory.create(type, { id: generator.next() });
+        dataIO.id = dataIO.id.replaceAll('-', '_');
         context.shape.businessObject = dataIO;
         dataIO.$parent = ioSpec;
         di.businessObject = dataIO;

app/spiffworkflow/InputOutput/index.js

@@ -2,11 +2,13 @@ import IoPalette from './IoPalette';
 import IoRules from './IoRules';
 import IoInterceptor from './IoInterceptor';
 import IoPropertiesProvider from './propertiesProvider/IoPropertiesProvider';
+import DataInputOutputPropertiesProvider from './propertiesProvider/DataInputOutputPropertiesProvider';
 
 export default {
-  __init__: ['IoPalette', 'IoRules', 'IoInterceptor', 'IoPropertiesProvider'],
+  __init__: ['IoPalette', 'IoRules', 'IoInterceptor', 'IoPropertiesProvider', 'DataInputOutputPropertiesProvider'],
   IoPalette: ['type', IoPalette],
   IoRules: ['type', IoRules],
   IoInterceptor: ['type', IoInterceptor],
   IoPropertiesProvider: ['type', IoPropertiesProvider],
+  DataInputOutputPropertiesProvider: ['type', DataInputOutputPropertiesProvider],
 };

app/spiffworkflow/InputOutput/propertiesProvider/DataInputOutputPropertiesProvider.js

@@ -0,0 +1,76 @@
+import { useService } from 'bpmn-js-properties-panel';
+import { isTextFieldEntryEdited, TextFieldEntry } from '@bpmn-io/properties-panel';
+import { useCallback } from '@bpmn-io/properties-panel/preact/hooks';
+import { validateDataId } from '../../helpers';
+
+const LOW_PRIORITY = 500;
+
+export default function DataInputOutputPropertiesProvider(
+  propertiesPanel,
+  translate,
+  moddle,
+  commandStack,
+  elementRegistry,
+  bpmnFactory
+) {
+  this.getGroups = function getGroupsCallback(element) {
+    return function pushGroup(groups) {
+      if (['bpmn:DataInput', 'bpmn:DataOutput'].includes(element.type)) {
+        const general = groups.find(group => group.id == 'general');
+        general.entries = general.entries.filter(entry => entry.id != 'id');
+        general.entries.unshift({
+          component: DataTextField,
+          isEdited: isTextFieldEntryEdited,
+          inputOrOutput: element.businessObject,
+        });
+      }
+      return groups;
+    };
+  };
+  propertiesPanel.registerProvider(LOW_PRIORITY, this);
+}
+
+DataInputOutputPropertiesProvider.$inject = [
+  'propertiesPanel',
+  'translate',
+  'moddle',
+  'commandStack',
+  'elementRegistry',
+  'bpmnFactory',
+];
+
+function DataTextField(props) {
+  const { element, inputOrOutput } = props;
+
+  const commandStack = useService('commandStack');
+  const debounce = useService('debounceInput');
+
+  const setValue = (value, error) => {
+    if (error)
+      return;
+
+    commandStack.execute('element.updateModdleProperties', {
+      element,
+      moddleElement: inputOrOutput,
+      properties: {
+        id: value,
+      },
+    });
+  };
+
+  const getValue = () => {
+    return inputOrOutput.id;
+  };
+
+  const validate = useCallback(value => validateDataId(value), [element]);
+
+  return TextFieldEntry({
+    element: element,
+    id: 'id',
+    label: 'ID',
+    getValue,
+    setValue,
+    debounce,
+    validate
+  });
+}

app/spiffworkflow/helpers.js

@@ -59,3 +59,14 @@ export function checkIfServiceTaskHasParameters(extensionElements) {
   });
   return hasParameters;
 }
+
+export function validateDataId (value) {
+  let message;
+  if (!value)
+    message = 'ID must not be empty.';
+  else if (/\s+/.test(value))
+    message = 'ID must not contain spaces';
+  else if (/\-/.test(value))
+    message = 'ID must not contain dashes';
+  return message;
+}

app/spiffworkflow/index.js

@@ -17,6 +17,7 @@ import ErrorPropertiesProvider from './errors/propertiesPanel/ErrorPropertiesPro
 import EscalationPropertiesProvider from './escalations/propertiesPanel/EscalationPropertiesProvider';
 import CallActivityPropertiesProvider from './callActivity/propertiesPanel/CallActivityPropertiesProvider';
 import IoPropertiesProvider from './InputOutput/propertiesProvider/IoPropertiesProvider';
+import DataInputOutputPropertiesProvider from './InputOutput/propertiesProvider/DataInputOutputPropertiesProvider';
 import StandardLoopPropertiesProvider from './loops/StandardLoopPropertiesProvider';
 import MultiInstancePropertiesProvider from './loops/MultiInstancePropertiesProvider';
 import CallActivityInterceptor from './callActivity/CallActivityInterceptor';
@@ -48,6 +49,7 @@ export default {
     'multiInstancePropertiesProvider',
     'standardLoopPropertiesProvider',
     'IoPropertiesProvider',
+    'DataInputOutputPropertiesProvider',
     'callActivityInterceptor',
   ],
   dataObjectInterceptor: ['type', DataObjectInterceptor],
@@ -72,5 +74,6 @@ export default {
   multiInstancePropertiesProvider: ['type', MultiInstancePropertiesProvider],
   standardLoopPropertiesProvider: ['type', StandardLoopPropertiesProvider],
   IoPropertiesProvider: ['type', IoPropertiesProvider],
+  DataInputOutputPropertiesProvider: ['type', DataInputOutputPropertiesProvider],
   callActivityInterceptor: ['type', CallActivityInterceptor],
 };