From ce70d5e080e5253b280d6bade4c835d1ee2bc11a Mon Sep 17 00:00:00 2001
From: mvdbeek <m.vandenbeek@gmail.com>
Date: Thu, 19 Jan 2023 21:40:39 +0100
Subject: [PATCH] Display optional output connections as dashed lines

---
 client/src/components/Workflow/Editor/Connector.vue  | 12 +++++-------
 .../components/Workflow/Editor/TerminalConnector.vue | 11 ++++++++++-
 .../src/components/Workflow/Editor/WorkflowEdges.vue |  7 ++++++-
 client/src/stores/workflowStepStore.ts               |  1 +
 client/src/style/scss/workflow.scss                  |  3 +++
 5 files changed, 25 insertions(+), 9 deletions(-)

diff --git a/client/src/components/Workflow/Editor/Connector.vue b/client/src/components/Workflow/Editor/Connector.vue
index c42b833d062..863a130a799 100644
--- a/client/src/components/Workflow/Editor/Connector.vue
+++ b/client/src/components/Workflow/Editor/Connector.vue
@@ -1,12 +1,7 @@
 <template>
-    <g :id="id" class="ribbon">
+    <g :id="id" :class="ribbonClasses">
         <g v-for="svgLine in paths" :key="svgLine">
-            <path
-                v-b-tooltip:hover="`my message`"
-                class="ribbon-outer"
-                :d="svgLine"
-                :stroke-width="stroke.outerStroke"
-                fill="none"></path>
+            <path class="ribbon-outer" :d="svgLine" :stroke-width="stroke.outerStroke" fill="none"></path>
             <path :class="innerClass" :d="svgLine" :stroke-width="stroke.innerStroke" fill="none"></path>
         </g>
     </g>
@@ -23,12 +18,14 @@ const props = withDefaults(
         inputIsMappedOver: boolean;
         outputIsMappedOver: boolean;
         connectionIsValid?: boolean;
+        nullable?: boolean;
     }>(),
     {
         id: undefined,
         inputIsMappedOver: false,
         outputIsMappedOver: false,
         connectionIsValid: true,
+        nullable: false,
     }
 );
 
@@ -47,6 +44,7 @@ const stroke = computed(() => {
     return { innerStroke, outerStroke };
 });
 
+const ribbonClasses = computed(() => (props.nullable ? "ribbon dashed" : "ribbon"));
 const innerClass = computed(() => (props.connectionIsValid ? "ribbon-inner" : "ribbon-inner ribbon-inner-invalid"));
 
 const offsets = computed(() => {
diff --git a/client/src/components/Workflow/Editor/TerminalConnector.vue b/client/src/components/Workflow/Editor/TerminalConnector.vue
index eb3006f44b4..1b0d12bd214 100644
--- a/client/src/components/Workflow/Editor/TerminalConnector.vue
+++ b/client/src/components/Workflow/Editor/TerminalConnector.vue
@@ -5,7 +5,8 @@
         :position="position"
         :output-is-mapped-over="outputIsMappedOver"
         :input-is-mapped-over="inputIsMappedOver"
-        :connection-is-valid="connectionIsValid"></raw-connector>
+        :connection-is-valid="connectionIsValid"
+        :nullable="outputIsOptional"></raw-connector>
 </template>
 
 <script lang="ts" setup>
@@ -23,6 +24,14 @@ const stepStore = useWorkflowStepStore();
 const connectionStore = useConnectionStore();
 const outputIsMappedOver = computed(() => stepStore.stepMapOver[props.connection.output.stepId]?.isCollection);
 const inputIsMappedOver = computed(() => stepStore.stepMapOver[props.connection.input.stepId]?.isCollection);
+const outputIsOptional = computed(() => {
+    return Boolean(
+        stepStore.getStep(props.connection.output.stepId)?.when ||
+            stepStore
+                .getStep(props.connection.output.stepId)
+                ?.outputs.find((output) => output.name === props.connection.output.name && output.optional)
+    );
+});
 
 // move into connection store ?
 // move all of terminal logic into connection store ?
diff --git a/client/src/components/Workflow/Editor/WorkflowEdges.vue b/client/src/components/Workflow/Editor/WorkflowEdges.vue
index b481c7fc5e3..36809805069 100644
--- a/client/src/components/Workflow/Editor/WorkflowEdges.vue
+++ b/client/src/components/Workflow/Editor/WorkflowEdges.vue
@@ -26,6 +26,10 @@ const dragStyle = computed(() => {
     }
     return dragStyle;
 });
+
+const dragIsOptional = computed(() => {
+    return props.draggingTerminal?.optional;
+});
 </script>
 <template>
     <div>
@@ -35,7 +39,8 @@ const dragStyle = computed(() => {
                 v-if="draggingTerminal && draggingConnection"
                 :position="draggingConnection"
                 :input-is-mapped-over="false"
-                :output-is-mapped-over="draggingTerminal.mapOver.isCollection"></raw-connector>
+                :output-is-mapped-over="draggingTerminal.mapOver.isCollection"
+                :nullable="dragIsOptional"></raw-connector>
             <terminal-connector
                 v-for="connection in connections"
                 :key="connection.id"
diff --git a/client/src/stores/workflowStepStore.ts b/client/src/stores/workflowStepStore.ts
index 32b043304dc..5955056672f 100644
--- a/client/src/stores/workflowStepStore.ts
+++ b/client/src/stores/workflowStepStore.ts
@@ -105,6 +105,7 @@ export interface NewStep {
     tooltip?: string;
     type: "tool" | "data_input" | "data_collection_input" | "subworkflow" | "parameter_input" | "pause";
     uuid?: string;
+    when?: string;
     workflow_outputs?: WorkflowOutput[];
 }
 
diff --git a/client/src/style/scss/workflow.scss b/client/src/style/scss/workflow.scss
index eb94d9c3dfa..a3ca99cf01d 100644
--- a/client/src/style/scss/workflow.scss
+++ b/client/src/style/scss/workflow.scss
@@ -117,6 +117,9 @@
                 .ribbon-inner-invalid {
                     stroke: $brand-warning;
                 }
+                &.dashed {
+                    stroke-dasharray: 5, 3;
+                }
                 &:hover .ribbon-outer {
                     stroke: $brand-success;
                 }