Merge pull request #559 from conductor-oss/CCOR-12630

Introduce maskedFields in workflow def

Author: shaileshpadave

common/src/main/java/com/netflix/conductor/common/metadata/workflow/WorkflowDef.java

@@ -24,19 +24,16 @@
 import com.netflix.conductor.common.metadata.SchemaDef;
 import com.netflix.conductor.common.metadata.tasks.TaskType;
 
-import jakarta.validation.*;
-import jakarta.validation.constraints.*;
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.Max;
+import jakarta.validation.constraints.Min;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
 
 @ProtoMessage
 @TaskReferenceNameUniqueConstraint
 public class WorkflowDef extends Auditable {
 
-    @ProtoEnum
-    public enum TimeoutPolicy {
-        TIME_OUT_WF,
-        ALERT_ONLY
-    }
-
     @NotEmpty(message = "WorkflowDef name cannot be null or empty")
     @ProtoField(id = 1)
     @ValidNameConstraint
@@ -112,6 +109,13 @@ public enum TimeoutPolicy {
     @ProtoField(id = 23)
     private CacheConfig cacheConfig;
 
+    @ProtoField(id = 24)
+    private List<String> maskedFields = new ArrayList<>();
+
+    public static String getKey(String name, int version) {
+        return name + "." + version;
+    }
+
     public boolean isEnforceSchema() {
         return enforceSchema;
     }
@@ -197,6 +201,13 @@ public int getVersion() {
         return version;
     }
 
+    /**
+     * @param version the version to set
+     */
+    public void setVersion(int version) {
+        this.version = version;
+    }
+
     /**
      * @return the failureWorkflow
      */
@@ -211,13 +222,6 @@ public void setFailureWorkflow(String failureWorkflow) {
         this.failureWorkflow = failureWorkflow;
     }
 
-    /**
-     * @param version the version to set
-     */
-    public void setVersion(int version) {
-        this.version = version;
-    }
-
     /**
      * This method determines if the workflow is restartable or not
      *
@@ -336,10 +340,6 @@ public String key() {
         return getKey(name, version);
     }
 
-    public static String getKey(String name, int version) {
-        return name + "." + version;
-    }
-
     public String getWorkflowStatusListenerSink() {
         return workflowStatusListenerSink;
     }
@@ -388,6 +388,14 @@ public void setCacheConfig(final CacheConfig cacheConfig) {
         this.cacheConfig = cacheConfig;
     }
 
+    public List<String> getMaskedFields() {
+        return maskedFields;
+    }
+
+    public void setMaskedFields(List<String> maskedFields) {
+        this.maskedFields = maskedFields;
+    }
+
     public boolean containsType(String taskType) {
         return collectTasks().stream().anyMatch(t -> t.getType().equals(taskType));
     }
@@ -507,6 +515,14 @@ public String toString() {
                 + outputSchema
                 + ", enforceSchema="
                 + enforceSchema
+                + ", maskedFields="
+                + maskedFields
                 + '}';
     }
+
+    @ProtoEnum
+    public enum TimeoutPolicy {
+        TIME_OUT_WF,
+        ALERT_ONLY
+    }
 }

grpc/src/main/java/com/netflix/conductor/grpc/AbstractProtoMapper.java

@@ -1363,6 +1363,7 @@ public WorkflowDefPb.WorkflowDef toProto(WorkflowDef from) {
         if (from.getCacheConfig() != null) {
             to.setCacheConfig( toProto( from.getCacheConfig() ) );
         }
+        to.addAllMaskedFields( from.getMaskedFields() );
         return to.build();
     }
 
@@ -1414,6 +1415,7 @@ public WorkflowDef fromProto(WorkflowDefPb.WorkflowDef from) {
         if (from.hasCacheConfig()) {
             to.setCacheConfig( fromProto( from.getCacheConfig() ) );
         }
+        to.setMaskedFields( from.getMaskedFieldsList().stream().collect(Collectors.toCollection(ArrayList::new)) );
         return to;
     }
 
@@ -1509,6 +1511,9 @@ public WorkflowSummaryPb.WorkflowSummary toProto(WorkflowSummary from) {
             to.setCreatedBy( from.getCreatedBy() );
         }
         to.putAllTaskToDomain( from.getTaskToDomain() );
+        if (from.getIdempotencyKey() != null) {
+            to.setIdempotencyKey( from.getIdempotencyKey() );
+        }
         return to.build();
     }
 
@@ -1534,6 +1539,7 @@ public WorkflowSummary fromProto(WorkflowSummaryPb.WorkflowSummary from) {
         to.setFailedTaskNames( from.getFailedTaskNamesList().stream().collect(Collectors.toCollection(HashSet::new)) );
         to.setCreatedBy( from.getCreatedBy() );
         to.setTaskToDomain( from.getTaskToDomainMap() );
+        to.setIdempotencyKey( from.getIdempotencyKey() );
         return to;
     }
 

grpc/src/main/proto/model/workflowdef.proto

@@ -38,4 +38,5 @@ message WorkflowDef {
     bool enforce_schema = 21;
     map<string, google.protobuf.Value> metadata = 22;
     CacheConfig cache_config = 23;
+    repeated string masked_fields = 24;
 }