Move deployment models to separate group to enable combining them wit…

…h connectors (#103) * Move deployment models to separate group to enable combining them with connectors * Move Yaml Upload Button to Connector menu * Move OpenAPI endpoint selection to implementation group * Move YAMl upload button into if * Invert null check
PlanQK · Oct 24, 2023 · 864e676 · 864e676
1 parent 803fbc9
commit 864e676
Show file tree

Hide file tree

Showing 11 changed files with 207 additions and 169 deletions.
diff --git a/components/bpmn-q/modeler-component/editor/util/camunda-utils/ImplementationTypeUtils.js b/components/bpmn-q/modeler-component/editor/util/camunda-utils/ImplementationTypeUtils.js
@@ -42,15 +42,6 @@ export function isExternalCapable(element) {
   return is(element, "camunda:ExternalCapable");
 }
 
-/**
- * Returns 'true'
- *
- * @return {boolean} true
- */
-export function isDeploymentCapable() {
-  return true;
-}
-
 /**
  * getServiceTaskLikeBusinessObject - Get a 'camunda:ServiceTaskLike' business object.
  *
@@ -78,76 +69,6 @@ export function getServiceTaskLikeBusinessObject(element) {
   return isServiceTaskLike(element) && getBusinessObject(element);
 }
 
-// /**
-//  * Returns the implementation type of the given element.
-//  *
-//  * Possible implementation types are:
-//  * - dmn
-//  * - connector
-//  * - external
-//  * - class
-//  * - expression
-//  * - delegateExpression
-//  * - script
-//  * - or undefined, when no matching implementation type is found
-//  *
-//  * @param  {djs.model.Base} element
-//  *
-//  * @return {String} the implementation type
-//  */
-// export function getImplementationType(element) {
-//
-//   const businessObject = (
-//     getListenerBusinessObject(element) ||
-//     getServiceTaskLikeBusinessObject(element)
-//   );
-//
-//   if (!businessObject) {
-//     return;
-//   }
-//
-//   if (isDmnCapable(businessObject)) {
-//     const decisionRef = businessObject.get('camunda:decisionRef');
-//     if (typeof decisionRef !== 'undefined') {
-//       return 'dmn';
-//     }
-//   }
-//
-//   if (isServiceTaskLike(businessObject)) {
-//     const connectors = getExtensionElementsList(businessObject, 'camunda:Connector');
-//     if (connectors.length) {
-//       return 'connector';
-//     }
-//   }
-//
-//   if (isExternalCapable(businessObject)) {
-//     const type = businessObject.get('camunda:type');
-//     if (type === 'external') {
-//       return 'external';
-//     }
-//   }
-//
-//   const cls = businessObject.get('camunda:class');
-//   if (typeof cls !== 'undefined') {
-//     return 'class';
-//   }
-//
-//   const expression = businessObject.get('camunda:expression');
-//   if (typeof expression !== 'undefined') {
-//     return 'expression';
-//   }
-//
-//   const delegateExpression = businessObject.get('camunda:delegateExpression');
-//   if (typeof delegateExpression !== 'undefined') {
-//     return 'delegateExpression';
-//   }
-//
-//   const script = businessObject.get('script');
-//   if (typeof script !== 'undefined') {
-//     return 'script';
-//   }
-// }
-
 export function isListener(element) {
   return this.isTaskListener(element) || this.isExecutionListener(element);
 }

diff --git a/components/bpmn-q/modeler-component/extensions/opentosca/modeling/OpenTOSCARenderer.js b/components/bpmn-q/modeler-component/extensions/opentosca/modeling/OpenTOSCARenderer.js
@@ -1,3 +1,14 @@
+/**
+ * Copyright (c) 2023 Institute of Architecture of Application Systems -
+ * University of Stuttgart
+ *
+ * This program and the accompanying materials are made available under the
+ * terms the Apache Software License 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { connectRectangles } from "diagram-js/lib/layout/ManhattanLayout";
 
 import { createLine } from "diagram-js/lib/util/RenderUtil";

diff --git a/...n-q/modeler-component/extensions/opentosca/modeling/properties-provider/ArtifactUpload.js b/...n-q/modeler-component/extensions/opentosca/modeling/properties-provider/ArtifactUpload.js
@@ -1,3 +1,14 @@
+/**
+ * Copyright (c) 2023 Institute of Architecture of Application Systems -
+ * University of Stuttgart
+ *
+ * This program and the accompanying materials are made available under the
+ * terms the Apache Software License 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { HeaderButton } from "@bpmn-io/properties-panel";
 import React from "react";
 import ArtifactModal from "./ArtifactUploadModal";

diff --git a/...s/bpmn-q/modeler-component/extensions/opentosca/modeling/properties-provider/Connector.js b/...s/bpmn-q/modeler-component/extensions/opentosca/modeling/properties-provider/Connector.js
@@ -1,8 +1,3 @@
-import { SelectEntry } from "@bpmn-io/properties-panel";
-import React from "@bpmn-io/properties-panel/preact/compat";
-import { useService } from "bpmn-js-properties-panel";
-import { getModeler } from "../../../../editor/ModelerHandler";
-
 /**
  * Copyright (c) 2023 Institute of Architecture of Application Systems -
  * University of Stuttgart
@@ -13,6 +8,12 @@ import { getModeler } from "../../../../editor/ModelerHandler";
  *
  * SPDX-License-Identifier: Apache-2.0
  */
+
+import { SelectEntry } from "@bpmn-io/properties-panel";
+import React from "@bpmn-io/properties-panel/preact/compat";
+import { useService } from "bpmn-js-properties-panel";
+import { getModeler } from "../../../../editor/ModelerHandler";
+
 const yaml = require("js-yaml");
 /**
  * Entry to display the endpoints of the uploaded openapi specification for BPMN service task.

diff --git a/.../bpmn-q/modeler-component/extensions/opentosca/modeling/properties-provider/Deployment.js b/.../bpmn-q/modeler-component/extensions/opentosca/modeling/properties-provider/Deployment.js
@@ -1,8 +1,3 @@
-import { SelectEntry } from "@bpmn-io/properties-panel";
-import React from "@bpmn-io/properties-panel/preact/compat";
-import { useService } from "bpmn-js-properties-panel";
-import { getImplementationType } from "../../../quantme/utilities/ImplementationTypeHelperExtension";
-
 /**
  * Copyright (c) 2023 Institute of Architecture of Application Systems -
  * University of Stuttgart
@@ -14,6 +9,10 @@ import { getImplementationType } from "../../../quantme/utilities/Implementation
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { SelectEntry } from "@bpmn-io/properties-panel";
+import React from "@bpmn-io/properties-panel/preact/compat";
+import { useService } from "bpmn-js-properties-panel";
+
 const jquery = require("jquery");
 
 const QUANTME_NAMESPACE_PULL = "http://quantil.org/quantme/pull";
@@ -28,7 +27,7 @@ export function Deployment({ element, translate, wineryEndpoint }) {
   const debounce = useService("debounceInput");
 
   const selectOptions = function () {
-    const arrValues = [];
+    const arrValues = [{ label: "No CSAR", value: undefined }];
     jquery.ajax({
       url: wineryEndpoint + "/servicetemplates/?grouped",
       method: "GET",
@@ -53,9 +52,6 @@ export function Deployment({ element, translate, wineryEndpoint }) {
       },
       async: false,
     });
-    if (arrValues.length === 0) {
-      arrValues.push({ label: "No CSARs available", value: "" });
-    }
     return arrValues;
   };
 
@@ -65,20 +61,16 @@ export function Deployment({ element, translate, wineryEndpoint }) {
 
   const setValue = function (value) {
     return modeling.updateProperties(element, {
-      deploymentModelUrl: value || "",
+      deploymentModelUrl: value,
     });
   };
 
-  const validate = function (values) {
-    return values === undefined || values === ""
-      ? translate("Must provide a CSAR")
-      : "";
+  const validate = function () {
+    return "";
   };
 
   const hidden = function () {
-    const implType = getImplementationType(element);
-    console.log("getImplementationType returns " + implType);
-    return !(implType === "deploymentModel");
+    return false;
   };
 
   return (

diff --git a/...deler-component/extensions/opentosca/modeling/properties-provider/DeploymentModelProps.js b/...deler-component/extensions/opentosca/modeling/properties-provider/DeploymentModelProps.js
@@ -0,0 +1,55 @@
+/**
+ * Copyright (c) 2023 Institute of Architecture of Application Systems -
+ * University of Stuttgart
+ *
+ * This program and the accompanying materials are made available under the
+ * terms the Apache Software License 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { getServiceTaskLikeBusinessObject } from "../../../../editor/util/camunda-utils/ImplementationTypeUtils";
+import { ArtifactUpload } from "./ArtifactUpload";
+import { isTextFieldEntryEdited } from "@bpmn-io/properties-panel";
+import { Deployment } from "./Deployment";
+
+/**
+ * Properties group for service tasks. Extends the original implementation by adding a new selection option to the
+ * implementation entry: deployment.
+ *
+ * @param props
+ * @return {{component: function(*): preact.VNode<any>, isEdited: function(*): *, id: string}[]|*[]}
+ * @constructor
+ */
+export function DeploymentModelProps(props) {
+  const { element, wineryEndpoint, translate } = props;
+
+  // deployment models can only be defined for ServiceTasks
+  if (!getServiceTaskLikeBusinessObject(element)) {
+    return [];
+  }
+
+  // list of configuration options
+  const entries = [];
+
+  // field to define deployment models
+  entries.push({
+    id: "deployment",
+    element,
+    translate,
+    wineryEndpoint,
+    component: Deployment,
+    isEdited: isTextFieldEntryEdited,
+  });
+
+  entries.push({
+    id: "artifactUpload",
+    element,
+    translate,
+    component: ArtifactUpload,
+    isEdited: isTextFieldEntryEdited,
+  });
+
+  return entries;
+}
diff --git a/...ler-component/extensions/opentosca/modeling/properties-provider/DmnImplementationProps.js b/...ler-component/extensions/opentosca/modeling/properties-provider/DmnImplementationProps.js
@@ -1,3 +1,14 @@
+/**
+ * Copyright (c) 2023 Institute of Architecture of Application Systems -
+ * University of Stuttgart
+ *
+ * This program and the accompanying materials are made available under the
+ * terms the Apache Software License 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import { getBusinessObject } from "bpmn-js/lib/util/ModelUtil";
 
 import {

diff --git a/...odeler-component/extensions/opentosca/modeling/properties-provider/ImplementationProps.js b/...odeler-component/extensions/opentosca/modeling/properties-provider/ImplementationProps.js
@@ -1,3 +1,14 @@
+/**
+ * Copyright (c) 2023 Institute of Architecture of Application Systems -
+ * University of Stuttgart
+ *
+ * This program and the accompanying materials are made available under the
+ * terms the Apache Software License 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
 import {
   isTextFieldEntryEdited,
   TextFieldEntry,
@@ -8,24 +19,22 @@ import { useService } from "bpmn-js-properties-panel";
 import { getImplementationType } from "../../../quantme/utilities/ImplementationTypeHelperExtension";
 import { getServiceTaskLikeBusinessObject } from "../../../../editor/util/camunda-utils/ImplementationTypeUtils";
 import { getExtensionElementsList } from "../../../../editor/util/camunda-utils/ExtensionElementsUtil";
-import { Deployment } from "./Deployment";
-import { Connector } from "./Connector";
 import { YamlUpload } from "./YamlUpload";
-import { ArtifactUpload } from "./ArtifactUpload";
+import { Connector } from "./Connector";
+import yaml from "js-yaml";
 
-const yaml = require("js-yaml");
 const QUANTME_NAMESPACE_PULL = "http://quantil.org/quantme/pull";
 
 /**
- * Properties group for service tasks. Extends the original implementation by adding a new selection option to the
- * implementation entry: deployment.
+ * Properties group for implementations of service tasks.
  *
- * @param props
+ * @param element
  * @return {{component: function(*): preact.VNode<any>, isEdited: function(*): *, id: string}[]|*[]}
  * @constructor
  */
 export function ImplementationProps(props) {
-  const { element, wineryEndpoint, translate } = props;
+  console.log("Rendering implementation properties for ServiceTask!");
+  const { element, translate } = props;
 
   if (!getServiceTaskLikeBusinessObject(element)) {
     return [];
@@ -77,44 +86,32 @@ export function ImplementationProps(props) {
       isEdited: isTextFieldEntryEdited,
     });
 
-    // custom extension
-  } else if (implementationType === "deploymentModel") {
-    entries.push({
-      id: "deployment",
-      element,
-      translate,
-      wineryEndpoint,
-      component: Deployment,
-      isEdited: isTextFieldEntryEdited,
-    });
-    entries.push({
-      id: "yamlUpload",
-      component: YamlUpload,
-      isEdited: isTextFieldEntryEdited,
-    });
     if (
+      !element.businessObject.deploymentModelUrl ||
       !element.businessObject.deploymentModelUrl.includes(
         encodeURIComponent(encodeURIComponent(QUANTME_NAMESPACE_PULL))
-      ) &&
-      element.businessObject.yaml !== undefined
+      )
     ) {
-      const urls = extractUrlsFromYaml(element.businessObject.yaml);
+      // field to upload an OpenAPI spec for automated connector generation
       entries.push({
-        id: "connector",
-        element,
-        translate,
-        urls,
-        component: Connector,
+        id: "yamlUpload",
+        component: YamlUpload,
         isEdited: isTextFieldEntryEdited,
       });
+
+      // drop down to select endpoint from OpenAPI spec
+      if (element.businessObject.yaml !== undefined) {
+        const urls = extractUrlsFromYaml(element.businessObject.yaml);
+        entries.push({
+          id: "connector",
+          element,
+          translate,
+          urls,
+          component: Connector,
+          isEdited: isTextFieldEntryEdited,
+        });
+      }
     }
-    entries.push({
-      id: "artifactUpload",
-      element,
-      translate,
-      component: ArtifactUpload,
-      isEdited: isTextFieldEntryEdited,
-    });
   }
 
   return entries;