refactor(server): standardize on variableassignment for mutations (#1164

)

- Deprecates the literal_value and node_output options of VariableMutation.rhs_value
- Updates sdk-java to only use the VariableAssignment field
- Renames VariableMutation.source_variable to VariableMutation.rhs_assignment

Co-authored-by: Hazim Arafa <[email protected]>

dashboard/src/app/(authenticated)/(diagram)/components/Modals/Edge.tsx

@@ -21,7 +21,7 @@ export const Edge: FC<Modal> = ({ data }) => {
             <span className="rounded bg-green-300 p-1 text-xs">{mutation.operation}</span>
             <NodeOutput nodeOutput={mutation.nodeOutput} />
             <LiteralValue literalValue={mutation.literalValue} />
-            <SourceVariable sourceVariable={mutation.sourceVariable} />
+            <RhsAssignment rhsAssignment={mutation.rhsAssignment} />
           </div>
         ))}
       </DialogContent>
@@ -41,12 +41,12 @@ const NodeOutput: FC<Pick<VariableMutation, 'nodeOutput'>> = ({ nodeOutput }) =>
   )
 }
 
-const SourceVariable: FC<Pick<VariableMutation, 'sourceVariable'>> = ({ sourceVariable }) => {
-  if (!sourceVariable) return <></>
+const RhsAssignment: FC<Pick<VariableMutation, 'rhsAssignment'>> = ({ rhsAssignment }) => {
+  if (!rhsAssignment) return <></>
   return (
     <>
-      <span className="rounded bg-gray-200 p-1 text-xs">Source Variable</span>
-      <span className="rounded bg-gray-100 p-1 font-mono text-xs text-orange-500">{getVariable(sourceVariable)}</span>
+      <span className="rounded bg-gray-200 p-1 text-xs">RHS Assignment</span>
+      <span className="rounded bg-gray-100 p-1 font-mono text-xs text-orange-500">{getVariable(rhsAssignment)}</span>
     </>
   )
 }

docs/docs/08-api.md

@@ -858,9 +858,9 @@ they are writing their own WfSpec SDK.
 | `lhs_name` | | string | The name of the variable to mutate |
 | `lhs_json_path` | optional| string | For JSON_ARR and JSON_OBJ variables, this allows you to optionally mutate a specific sub-field of the variable. |
 | `operation` | | [VariableMutationType](#variablemutationtype) | Defines the operation that we are executing. |
-| `source_variable` | oneof `rhs_value`| [VariableAssignment](#variableassignment) | Set the source_variable as the RHS to use another variable from the workflow to as the RHS/ |
-| `literal_value` | oneof `rhs_value`| [VariableValue](#variablevalue) | Use a literal value as the RHS. |
-| `node_output` | oneof `rhs_value`| [VariableMutation.NodeOutputSource](#variablemutationnodeoutputsource) | Use the output of the current node as the RHS. |
+| `rhs_assignment` | oneof `rhs_value`| [VariableAssignment](#variableassignment) | Assigns the value to be used as the RHS of the mutation. |
+| `literal_value` | oneof `rhs_value`| [VariableValue](#variablevalue) | Use a literal value as the RHS. DEPRECATED: use rhs_assignment.literal_value instead. |
+| `node_output` | oneof `rhs_value`| [VariableMutation.NodeOutputSource](#variablemutationnodeoutputsource) | Use the output of the current node as the RHS. DEPRECATED: use rhs_assignment.node_output instead. |
  <!-- end Fields -->
  <!-- end HasFields -->
 

docs/static/img/protobuf-docs.html

@@ -2307,10 +2307,10 @@ <h3 id="littlehorse.VariableMutation">VariableMutation</h3>
                 </tr>
 
                 <tr>
-                  <td>source_variable</td>
+                  <td>rhs_assignment</td>
                   <td><a href="#littlehorse.VariableAssignment">VariableAssignment</a></td>
                   <td></td>
-                  <td><p>Set the source_variable as the RHS to use another variable from the workflow to
+                  <td><p>Set the rhs_assignment as the RHS to use another variable from the workflow to
 as the RHS/ </p></td>
                 </tr>
 

schemas/littlehorse/common_wfspec.proto

@@ -114,16 +114,20 @@ message VariableMutation {
   // Defines the operation that we are executing.
   VariableMutationType operation = 3;
 
-  // The RHS of the mutation; i.e. what is operated _with_.
+  // The RHS of the mutation; i.e. what is operated _with_. Note the values other
+  // than `rhs_assignment` are deprecated and will be removed in 2.0.
+  //
+  // As of 0.12.0, the SDK's only use rhs_assignment.
   oneof rhs_value {
-    // Set the source_variable as the RHS to use another variable from the workflow to
-    // as the RHS/
-    VariableAssignment source_variable = 4;
+    // Assigns the value to be used as the RHS of the mutation.
+    VariableAssignment rhs_assignment = 4;
 
-    // Use a literal value as the RHS.
+    // Use a literal value as the RHS. DEPRECATED: use rhs_assignment.literal_value
+    // instead.
     VariableValue literal_value = 5;
 
-    // Use the output of the current node as the RHS.
+    // Use the output of the current node as the RHS. DEPRECATED: use
+    // rhs_assignment.node_output instead.
     NodeOutputSource node_output = 6;
   }
 }

sdk-go/littlehorse/wf_lib_internal.go

@@ -709,17 +709,17 @@ func (t *WorkflowThread) mutate(
 			},
 		}
 	case WfRunVariable:
-		mutation.RhsValue = &lhproto.VariableMutation_SourceVariable{
-			SourceVariable: &lhproto.VariableAssignment{
+		mutation.RhsValue = &lhproto.VariableMutation_RhsAssignment{
+			RhsAssignment: &lhproto.VariableAssignment{
 				JsonPath: r.jsonPath,
 				Source: &lhproto.VariableAssignment_VariableName{
 					VariableName: r.Name,
 				},
 			},
 		}
 	case *WfRunVariable:
-		mutation.RhsValue = &lhproto.VariableMutation_SourceVariable{
-			SourceVariable: &lhproto.VariableAssignment{
+		mutation.RhsValue = &lhproto.VariableMutation_RhsAssignment{
+			RhsAssignment: &lhproto.VariableAssignment{
 				JsonPath: r.jsonPath,
 				Source: &lhproto.VariableAssignment_VariableName{
 					VariableName: r.Name,