changes to update name of state props in both runtimes

Author: esttenorio

dotnet/samples/GettingStartedWithProcesses/Step04/Step04_AgentOrchestration.cs

@@ -74,7 +74,7 @@ await process.StartAsync(
 
         // Cleaning up created agents
         var processState = await localProcess.GetStateAsync();
-        var agentState = (KernelProcessStepState<KernelProcessAgentExecutorState>)processState.Steps.Where(step => step.State.Id == "Student").FirstOrDefault()!.State;
+        var agentState = (KernelProcessStepState<KernelProcessAgentExecutorState>)processState.Steps.Where(step => step.State.StepId == "Student").FirstOrDefault()!.State;
         var agentId = agentState?.State?.AgentId;
         if (agentId != null)
         {

dotnet/src/Experimental/Process.Abstractions/KernelProcess.cs

@@ -47,7 +47,7 @@ public KernelProcess(KernelProcessState state, IList<KernelProcessStepInfo> step
         : base(typeof(KernelProcess), state, edges ?? [])
     {
         Verify.NotNull(steps);
-        Verify.NotNullOrWhiteSpace(state.Name);
+        Verify.NotNullOrWhiteSpace(state.StepId);
 
         this.Steps = [.. steps];
     }

dotnet/src/Experimental/Process.Abstractions/KernelProcessFunctionTarget.cs

@@ -9,6 +9,7 @@ namespace Microsoft.SemanticKernel;
 /// <summary>
 /// Represents the target for an edge in a Process
 /// </summary>
+[DataContract]
 public record KernelProcessTarget
 {
     /// <summary>
@@ -29,6 +30,7 @@ public KernelProcessTarget(ProcessTargetType type)
 /// <summary>
 /// Represents a state operations target for an edge in a Process
 /// </summary>
+[DataContract]
 public record KernelProcessStateTarget : KernelProcessTarget
 {
     /// <summary>
@@ -42,12 +44,14 @@ public KernelProcessStateTarget(VariableUpdate variableUpdate) : base(ProcessTar
     /// <summary>
     /// The associated <see cref="VariableUpdate"/>.
     /// </summary>
+    [DataMember]
     public VariableUpdate VariableUpdate { get; init; }
 }
 
 /// <summary>
 /// Represents a state operations target for an edge in a Process
 /// </summary>
+[DataContract]
 public record KernelProcessEmitTarget : KernelProcessTarget
 {
     /// <summary>
@@ -65,17 +69,20 @@ public KernelProcessEmitTarget(string eventName, Dictionary<string, string>? pay
     /// <summary>
     /// The name or type of the event to be emitted.
     /// </summary>
+    [DataMember]
     public string EventName { get; init; }
 
     /// <summary>
     /// /// The payload to be sent with the event.
     /// </summary>
+    [DataMember]
     public Dictionary<string, string>? Payload { get; init; }
 }
 
 /// <summary>
 /// Represents an agent invocation target for an edge in a Process
 /// </summary>
+[DataContract]
 public record KernelProcessAgentInvokeTarget : KernelProcessTarget
 {
     /// <summary>
@@ -99,21 +106,25 @@ public KernelProcessAgentInvokeTarget(string stepId, string? threadEval, List<st
     /// <summary>
     /// The unique identifier of the Step being targeted.
     /// </summary>
+    [DataMember]
     public string StepId { get; init; }
 
     /// <summary>
     /// An evaluation string that will be evaluated to determine the thread to run on.
     /// </summary>
+    [DataMember]
     public string? ThreadEval { get; init; }
 
     /// <summary>
     /// An evaluation string that will be evaluated to determine the messages to send to the target.
     /// </summary>
+    [DataMember]
     public List<string>? MessagesInEval { get; init; }
 
     /// <summary>
     /// An evaluation string that will be evaluated to determine the inputs to send to the target.
     /// </summary>
+    [DataMember]
     public Dictionary<string, string> InputEvals { get; init; }
 }
 

dotnet/src/Experimental/Process.Abstractions/KernelProcessMap.cs

@@ -23,8 +23,8 @@ public KernelProcessMap(KernelProcessMapState state, KernelProcessStepInfo opera
         : base(typeof(KernelProcessMap), state, edges)
     {
         Verify.NotNull(operation, nameof(operation));
-        Verify.NotNullOrWhiteSpace(state.Name, $"{nameof(state)}.{nameof(KernelProcessMapState.Name)}");
-        Verify.NotNullOrWhiteSpace(state.Id, $"{nameof(state)}.{nameof(KernelProcessMapState.Id)}");
+        Verify.NotNullOrWhiteSpace(state.StepId, $"{nameof(state)}.{nameof(KernelProcessMapState.StepId)}");
+        Verify.NotNullOrWhiteSpace(state.RunId, $"{nameof(state)}.{nameof(KernelProcessMapState.RunId)}");
 
         this.Operation = operation;
     }

dotnet/src/Experimental/Process.Abstractions/KernelProcessProxy.cs

@@ -23,7 +23,7 @@ public sealed record KernelProcessProxy : KernelProcessStepInfo
     public KernelProcessProxy(KernelProcessStepState state, Dictionary<string, List<KernelProcessEdge>> edges)
         : base(typeof(KernelProxyStep), state, edges)
     {
-        Verify.NotNullOrWhiteSpace(state.Name, $"{nameof(state)}.{nameof(KernelProcessStepState.Name)}");
-        Verify.NotNullOrWhiteSpace(state.Id, $"{nameof(state)}.{nameof(KernelProcessStepState.Id)}");
+        Verify.NotNullOrWhiteSpace(state.StepId, $"{nameof(state)}.{nameof(KernelProcessStepState.StepId)}");
+        Verify.NotNullOrWhiteSpace(state.RunId, $"{nameof(state)}.{nameof(KernelProcessStepState.RunId)}");
     }
 }

dotnet/src/Experimental/Process.Abstractions/KernelProcessStepState.cs

@@ -40,14 +40,14 @@ internal static void RegisterDerivedType(Type derivedType)
     /// This may be null until a process containing this step has been invoked.
     /// </summary>
     [DataMember]
-    public string? Id { get; init; }
+    public string? RunId { get; set; }
 
     /// <summary>
     /// The name of the Step. This is intended to be human readable and is not required to be unique. If
     /// not provided, the name will be derived from the steps .NET type.
     /// </summary>
     [DataMember]
-    public string Name { get; init; }
+    public string StepId { get; init; }
 
     /// <summary>
     /// Version of the state
@@ -66,8 +66,8 @@ public KernelProcessStepState(string name, string version, string? id = null)
         Verify.NotNullOrWhiteSpace(name, nameof(name));
         Verify.NotNullOrWhiteSpace(version, nameof(version));
 
-        this.Id = id;
-        this.Name = name;
+        this.RunId = id;
+        this.StepId = name;
         this.Version = version;
     }
 }
@@ -96,8 +96,8 @@ public KernelProcessStepState(string name, string version, string? id = null)
     {
         Verify.NotNullOrWhiteSpace(name);
 
-        this.Id = id;
-        this.Name = name;
+        this.RunId = id;
+        this.StepId = name;
         this.Version = version;
     }
 }

dotnet/src/Experimental/Process.Abstractions/Models/Storage/StorageProcessState.cs

@@ -48,9 +48,9 @@ public static StorageProcessState ToKernelStorageProcessState(this KernelProcess
     {
         return new StorageProcessState
         {
-            ProcessName = kernelProcess.State?.Name ?? string.Empty,
-            ProcessInstance = kernelProcess.State?.Id ?? string.Empty,
-            Steps = kernelProcess.Steps.ToList().ToDictionary(step => step.State.Name, step => step.State.Id ?? string.Empty) ?? []
+            ProcessName = kernelProcess.State?.StepId ?? string.Empty,
+            ProcessInstance = kernelProcess.State?.RunId ?? string.Empty,
+            Steps = kernelProcess.Steps.ToList().ToDictionary(step => step.State.StepId, step => step.State.RunId ?? string.Empty) ?? []
         };
     }
 }

dotnet/src/Experimental/Process.Abstractions/Serialization/Model/Workflow.cs

@@ -1,6 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 
 using System.Collections.Generic;
+using System.Runtime.Serialization;
 using System.Text.Json.Serialization;
 using Microsoft.SemanticKernel.Agents;
 using Microsoft.SemanticKernel.Process.Internal;
@@ -843,6 +844,7 @@ public enum HITLMode
 /// Represents an update operation to be performed on a workflow variable.
 /// Variable updates allow workflows to modify state based on conditions and execution flow.
 /// </summary>
+[DataContract]
 public sealed class VariableUpdate
 {
     /// <summary>
@@ -851,6 +853,7 @@ public sealed class VariableUpdate
     /// </summary>
     [YamlMember(Alias = "path")]
     [JsonPropertyName("path")]
+    [DataMember]
     public string Path { get; set; } = string.Empty;
 
     /// <summary>
@@ -859,6 +862,7 @@ public sealed class VariableUpdate
     /// </summary>
     [YamlMember(Alias = "operation")]
     [JsonPropertyName("operation")]
+    [DataMember]
     public StateUpdateOperations Operation { get; set; }
 
     /// <summary>
@@ -867,6 +871,7 @@ public sealed class VariableUpdate
     /// </summary>
     [YamlMember(Alias = "value")]
     [JsonPropertyName("value")]
+
     public object? Value { get; set; } = string.Empty;
 }
 

dotnet/src/Experimental/Process.Core/ProcessExporter.cs

@@ -23,7 +23,7 @@ public static string ExportProcess(KernelProcess process)
 
         Workflow workflow = new()
         {
-            Name = process.State.Name,
+            Name = process.State.StepId,
             Description = process.Description,
             FormatVersion = "1.0",
             WorkflowVersion = process.State.Version,
@@ -50,7 +50,7 @@ private static Node GetNodeFromStep(KernelProcessStepInfo stepInfo)
         {
             var agentNode = new Node()
             {
-                Id = agentStep.State.Id ?? throw new KernelException("All steps must have an Id."),
+                Id = agentStep.State.RunId ?? throw new KernelException("All steps must have an Id."),
                 Description = agentStep.Description,
                 Type = "agent",
                 Inputs = agentStep.Inputs.ToDictionary((kvp) => kvp.Key, (kvp) =>

dotnet/src/Experimental/Process.Core/Tools/ProcessVisualizationExtensions.cs

@@ -64,10 +64,10 @@ private static string RenderProcess(KernelProcess process, int level, bool isSub
 
         // Dictionary to map step IDs to step names
         var stepNames = process.Steps
-            .Where(step => step.State.Id != null && step.State.Name != null)
+            .Where(step => step.State.RunId != null && step.State.StepId != null)
             .ToDictionary(
-                step => step.State.Id!,
-                step => step.State.Name!
+                step => step.State.RunId!,
+                step => step.State.StepId!
             );
 
         // Add Start and End nodes only if this is not a sub-process
@@ -80,8 +80,8 @@ private static string RenderProcess(KernelProcess process, int level, bool isSub
         // Process each step
         foreach (var step in process.Steps)
         {
-            var stepId = step.State.Id;
-            var stepName = step.State.Name;
+            var stepId = step.State.RunId;
+            var stepName = step.State.StepId;
 
             // Check if the step is a nested process (sub-process)
             if (step is KernelProcess nestedProcess && level < maxLevel)
@@ -115,7 +115,7 @@ private static string RenderProcess(KernelProcess process, int level, bool isSub
                     var stepEdges = kvp.Value;
 
                     // Skip drawing edges that point to a nested process as an entry point
-                    if (stepNames.ContainsKey(eventId) && process.Steps.Any(s => s.State.Name == eventId && s is KernelProcess))
+                    if (stepNames.ContainsKey(eventId) && process.Steps.Any(s => s.State.StepId == eventId && s is KernelProcess))
                     {
                         continue;
                     }
@@ -156,8 +156,8 @@ private static string RenderProcess(KernelProcess process, int level, bool isSub
         // Connect Start to the first step and the last step to End (only for the main process)
         if (!isSubProcess && process.Steps.Count > 0)
         {
-            var firstStepName = process.Steps.First().State.Name;
-            var lastStepName = process.Steps.Last().State.Name;
+            var firstStepName = process.Steps.First().State.StepId;
+            var lastStepName = process.Steps.Last().State.StepId;
 
             sb.AppendLine($"{indentation}Start --> {firstStepName}[\"{firstStepName}\"]");
             sb.AppendLine($"{indentation}{lastStepName}[\"{lastStepName}\"] --> End");

dotnet/src/Experimental/Process.Core/Workflow/WorkflowBuilder.cs

@@ -325,10 +325,10 @@ public static Task<Workflow> BuildWorkflow(KernelProcess process)
 
         Workflow workflow = new()
         {
-            Id = process.State.Id ?? throw new KernelException("The process must have an Id set"),
+            Id = process.State.RunId ?? throw new KernelException("The process must have an Id set"),
             Description = process.Description,
             FormatVersion = "1.0",
-            Name = process.State.Name,
+            Name = process.State.StepId,
             Nodes = [new Node { Id = "End", Type = "declarative", Version = "1.0", Description = "Terminal state" }],
             Variables = [],
         };
@@ -403,7 +403,7 @@ public static Task<Workflow> BuildWorkflow(KernelProcess process)
 
     private static Node BuildNode(KernelProcessStepInfo step, List<OrchestrationStep> orchestrationSteps)
     {
-        Verify.NotNullOrWhiteSpace(step?.State?.Id, nameof(step.State.Id));
+        Verify.NotNullOrWhiteSpace(step?.State?.RunId, nameof(step.State.RunId));
 
         if (step is KernelProcessAgentStep agentStep)
         {
@@ -418,12 +418,12 @@ private static Node BuildNode(KernelProcessStepInfo step, List<OrchestrationStep
 
         var node = new Node()
         {
-            Id = step.State.Id,
+            Id = step.State.RunId,
             Type = "dotnet",
             Agent = new AgentDefinition()
             {
                 Type = innerStepTypeString,
-                Id = step.State.Id
+                Id = step.State.RunId
             }
         };
 
@@ -433,7 +433,7 @@ private static Node BuildNode(KernelProcessStepInfo step, List<OrchestrationStep
             {
                 ListenFor = new ListenCondition()
                 {
-                    From = step.State.Id,
+                    From = step.State.RunId,
                     Event = edge.Key,
                     Condition = edge.Value.FirstOrDefault()?.Condition.DeclarativeDefinition
                 },
@@ -465,14 +465,14 @@ private static Node BuildAgentNode(KernelProcessAgentStep agentStep, List<Orches
     {
         Verify.NotNull(agentStep);
 
-        if (agentStep.AgentDefinition is null || string.IsNullOrWhiteSpace(agentStep.State?.Id) || string.IsNullOrWhiteSpace(agentStep.AgentDefinition.Type))
+        if (agentStep.AgentDefinition is null || string.IsNullOrWhiteSpace(agentStep.State?.RunId) || string.IsNullOrWhiteSpace(agentStep.AgentDefinition.Type))
         {
             throw new InvalidOperationException("Attempt to build a workflow node from step with no Id");
         }
 
         var node = new Node()
         {
-            Id = agentStep.State.Id!,
+            Id = agentStep.State.RunId!,
             Type = agentStep.AgentDefinition.Type!,
             Agent = agentStep.AgentDefinition,
             HumanInLoopType = agentStep.HumanInLoopMode,
@@ -511,7 +511,7 @@ private static Node BuildAgentNode(KernelProcessAgentStep agentStep, List<Orches
             {
                 ListenFor = new ListenCondition()
                 {
-                    From = agentStep.State.Id,
+                    From = agentStep.State.RunId,
                     Event = ResolveEventName(edge.Key.key),
                     Condition = edge.Key.DeclarativeDefinition
                 },

dotnet/src/Experimental/Process.IntegrationTestRunner.Dapr/DaprTestProcessContext.cs

@@ -23,13 +23,13 @@ internal sealed class DaprTestProcessContext : KernelProcessContext
     /// <param name="httpClient"></param>
     internal DaprTestProcessContext(KernelProcess process, HttpClient httpClient)
     {
-        if (string.IsNullOrWhiteSpace(process.State.Id))
+        if (string.IsNullOrWhiteSpace(process.State.RunId))
         {
-            process = process with { State = process.State with { Id = Guid.NewGuid().ToString() } };
+            process = process with { State = process.State with { RunId = Guid.NewGuid().ToString() } };
         }
 
         this._process = process;
-        this._processId = process.State.Id;
+        this._processId = process.State.RunId;
         this._httpClient = httpClient;
 
         this._serializerOptions = new JsonSerializerOptions()
@@ -146,5 +146,5 @@ public override Task StopAsync()
         };
     }
 
-    public override Task<string> GetProcessIdAsync() => Task.FromResult(this._process?.State.Id!);
+    public override Task<string> GetProcessIdAsync() => Task.FromResult(this._process?.State.RunId!);
 }

dotnet/src/Experimental/Process.IntegrationTests.Shared/ProcessCycleTests.cs

@@ -74,7 +74,7 @@ public async Task TestCycleAndExitWithFanInAsync()
         var processContext = await this._fixture.StartProcessAsync(kernelProcess, kernel, new KernelProcessEvent() { Id = CommonEvents.StartProcess, Data = "foo" });
 
         var processState = await processContext.GetStateAsync();
-        var cStepState = processState.Steps.Where(s => s.State.Name == "CStep").FirstOrDefault()?.State as KernelProcessStepState<CStepState>;
+        var cStepState = processState.Steps.Where(s => s.State.StepId == "CStep").FirstOrDefault()?.State as KernelProcessStepState<CStepState>;
 
         Assert.NotNull(cStepState?.State);
         Assert.Equal(3, cStepState.State.CurrentCycle);