.Net: Processes - Sample Pattern Adjustments

dotnet/samples/GettingStartedWithProcesses/SharedSteps/ScriptedUserInputStep.cs

@@ -22,12 +22,13 @@ public static class Functions
     /// <summary>
     /// The state object for the user input step. This object holds the user inputs and the current input index.
     /// </summary>
-    protected UserInputState? _state;
+    private UserInputState? _state;
 
     /// <summary>
     /// Method to be overridden by the user to populate with custom user messages
     /// </summary>
-    public virtual void PopulateUserInputs()
+    /// <param name="state">The initialized state object for the step.</param>
+    public virtual void PopulateUserInputs(UserInputState state)
     {
         return;
     }
@@ -43,7 +44,7 @@ public override ValueTask ActivateAsync(KernelProcessStepState<UserInputState> s
         state.State ??= new();
         _state = state.State;
 
-        PopulateUserInputs();
+        PopulateUserInputs(_state);
 
         return ValueTask.CompletedTask;
     }

dotnet/samples/GettingStartedWithProcesses/Step01/Step01_Processes.cs

@@ -65,7 +65,7 @@ public async Task UseSimpleProcessAsync()
         KernelProcess kernelProcess = process.Build();
 
         // Start the process with an initial external event
-        var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = ChatBotEvents.StartProcess, Data = null });
+        using var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = ChatBotEvents.StartProcess, Data = null });
     }
 
     /// <summary>
@@ -88,16 +88,13 @@ public void PrintIntroMessage()
     /// </summary>
     private sealed class ChatUserInputStep : ScriptedUserInputStep
     {
-        public override void PopulateUserInputs()
+        public override void PopulateUserInputs(UserInputState state)
         {
-            if (_state != null)
-            {
-                _state.UserInputs.Add("Hello");
-                _state.UserInputs.Add("How tall is the tallest mountain?");
-                _state.UserInputs.Add("How low is the lowest valley?");
-                _state.UserInputs.Add("How wide is the widest river?");
-                _state.UserInputs.Add("exit");
-            }
+            state.UserInputs.Add("Hello");
+            state.UserInputs.Add("How tall is the tallest mountain?");
+            state.UserInputs.Add("How low is the lowest valley?");
+            state.UserInputs.Add("How wide is the widest river?");
+            state.UserInputs.Add("exit");
         }
     }
 
@@ -124,7 +121,6 @@ public static class Functions
         public override ValueTask ActivateAsync(KernelProcessStepState<ChatBotState> state)
         {
             _state = state.State ?? new();
-            _state.ChatMessages ??= new();
             return ValueTask.CompletedTask;
         }
 
@@ -147,9 +143,8 @@ public async Task GetChatResponseAsync(KernelProcessStepContext context, string
             }
 
             System.Console.ForegroundColor = ConsoleColor.Yellow;
-            System.Console.Write("Assistant: ");
+            System.Console.WriteLine($"ASSISTANT: {response.Content}");
             System.Console.ResetColor();
-            System.Console.WriteLine(response.Content);
 
             // Update state with the response
             _state.ChatMessages.Add(response);
@@ -164,7 +159,7 @@ public async Task GetChatResponseAsync(KernelProcessStepContext context, string
     /// </summary>
     private sealed class ChatBotState
     {
-        internal ChatHistory ChatMessages { get; set; } = new();
+        internal ChatHistory ChatMessages { get; } = new();
     }
 
     /// <summary>

dotnet/samples/GettingStartedWithProcesses/Step02/Step02_AccountOpening.cs

@@ -16,6 +16,9 @@ namespace Step02;
 /// </summary>
 public class Step02_AccountOpening(ITestOutputHelper output) : BaseTest(output, redirectSystemConsoleOutput: true)
 {
+    // Target Open AI Services
+    protected override bool ForceOpenAI => true;
+
     private KernelProcess SetupAccountOpeningProcess<TUserInputStep>() where TUserInputStep : ScriptedUserInputStep
     {
         ProcessBuilder process = new("AccountOpeningProcess");
@@ -143,21 +146,18 @@ public async Task UseAccountOpeningProcessSuccessfulInteractionAsync()
     {
         Kernel kernel = CreateKernelWithChatCompletion();
         KernelProcess kernelProcess = SetupAccountOpeningProcess<UserInputSuccessfulInteraction>();
-        var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = AccountOpeningEvents.StartProcess, Data = null });
+        using var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = AccountOpeningEvents.StartProcess, Data = null });
     }
 
     private sealed class UserInputSuccessfulInteraction : ScriptedUserInputStep
     {
-        public override void PopulateUserInputs()
+        public override void PopulateUserInputs(UserInputState state)
         {
-            if (_state != null)
-            {
-                _state.UserInputs.Add("I would like to open an account");
-                _state.UserInputs.Add("My name is John Contoso, dob 02/03/1990");
-                _state.UserInputs.Add("I live in Washington and my phone number es 222-222-1234");
-                _state.UserInputs.Add("My userId is 987-654-3210");
-                _state.UserInputs.Add("My email is [email protected], what else do you need?");
-            }
+            state.UserInputs.Add("I would like to open an account");
+            state.UserInputs.Add("My name is John Contoso, dob 02/03/1990");
+            state.UserInputs.Add("I live in Washington and my phone number es 222-222-1234");
+            state.UserInputs.Add("My userId is 987-654-3210");
+            state.UserInputs.Add("My email is [email protected], what else do you need?");
         }
     }
 
@@ -169,21 +169,18 @@ public async Task UseAccountOpeningProcessFailureDueToCreditScoreFailureAsync()
     {
         Kernel kernel = CreateKernelWithChatCompletion();
         KernelProcess kernelProcess = SetupAccountOpeningProcess<UserInputCreditScoreFailureInteraction>();
-        var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = AccountOpeningEvents.StartProcess, Data = null });
+        using var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = AccountOpeningEvents.StartProcess, Data = null });
     }
 
     private sealed class UserInputCreditScoreFailureInteraction : ScriptedUserInputStep
     {
-        public override void PopulateUserInputs()
+        public override void PopulateUserInputs(UserInputState state)
         {
-            if (_state != null)
-            {
-                _state.UserInputs.Add("I would like to open an account");
-                _state.UserInputs.Add("My name is John Contoso, dob 01/01/1990");
-                _state.UserInputs.Add("I live in Washington and my phone number es 222-222-1234");
-                _state.UserInputs.Add("My userId is 987-654-3210");
-                _state.UserInputs.Add("My email is [email protected], what else do you need?");
-            }
+            state.UserInputs.Add("I would like to open an account");
+            state.UserInputs.Add("My name is John Contoso, dob 01/01/1990");
+            state.UserInputs.Add("I live in Washington and my phone number es 222-222-1234");
+            state.UserInputs.Add("My userId is 987-654-3210");
+            state.UserInputs.Add("My email is [email protected], what else do you need?");
         }
     }
 
@@ -195,31 +192,18 @@ public async Task UseAccountOpeningProcessFailureDueToFraudFailureAsync()
     {
         Kernel kernel = CreateKernelWithChatCompletion();
         KernelProcess kernelProcess = SetupAccountOpeningProcess<UserInputFraudFailureInteraction>();
-        var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = AccountOpeningEvents.StartProcess, Data = null });
+        using var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent() { Id = AccountOpeningEvents.StartProcess, Data = null });
     }
 
     private sealed class UserInputFraudFailureInteraction : ScriptedUserInputStep
     {
-        public override void PopulateUserInputs()
+        public override void PopulateUserInputs(UserInputState state)
         {
-            if (_state != null)
-            {
-                _state.UserInputs.Add("I would like to open an account");
-                _state.UserInputs.Add("My name is John Contoso, dob 02/03/1990");
-                _state.UserInputs.Add("I live in Washington and my phone number es 222-222-1234");
-                _state.UserInputs.Add("My userId is 123-456-7890");
-                _state.UserInputs.Add("My email is [email protected], what else do you need?");
-            }
+            state.UserInputs.Add("I would like to open an account");
+            state.UserInputs.Add("My name is John Contoso, dob 02/03/1990");
+            state.UserInputs.Add("I live in Washington and my phone number es 222-222-1234");
+            state.UserInputs.Add("My userId is 123-456-7890");
+            state.UserInputs.Add("My email is [email protected], what else do you need?");
         }
     }
-
-    protected new Kernel CreateKernelWithChatCompletion()
-    {
-        var builder = Kernel.CreateBuilder();
-        builder.AddOpenAIChatCompletion(
-            TestConfiguration.OpenAI.ChatModelId,
-            TestConfiguration.OpenAI.ApiKey);
-
-        return builder.Build();
-    }
 }

dotnet/samples/GettingStartedWithProcesses/Step03/Step03_FoodPreparation.cs

@@ -13,6 +13,9 @@ namespace Step03;
 /// </summary>
 public class Step03_FoodPreparation(ITestOutputHelper output) : BaseTest(output, redirectSystemConsoleOutput: true)
 {
+    // Target Open AI Services
+    protected override bool ForceOpenAI => true;
+
     [Fact]
     public async Task UsePrepareFriedFishProcessAsync()
     {
@@ -50,7 +53,7 @@ protected async Task UsePrepareSpecificProductAsync(ProcessBuilder processBuilde
         KernelProcess kernelProcess = processBuilder.Build();
 
         // Assert
-        var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent()
+        using var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent()
         {
             Id = externalTriggerEvent, Data = new List<string>()
         });
@@ -85,20 +88,10 @@ protected async Task UsePrepareFoodOrderProcessSingleItemAsync(FoodItem foodItem
         Kernel kernel = CreateKernelWithChatCompletion();
         KernelProcess kernelProcess = SingleFoodItemProcess.CreateProcess().Build();
 
-        var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent()
+        using var runningProcess = await kernelProcess.StartAsync(kernel, new KernelProcessEvent()
         {
             Id = SingleFoodItemProcess.ProcessEvents.SingleOrderReceived,
             Data = foodItem
         });
     }
-
-    protected new Kernel CreateKernelWithChatCompletion()
-    {
-        var builder = Kernel.CreateBuilder();
-        builder.AddOpenAIChatCompletion(
-            TestConfiguration.OpenAI.ChatModelId,
-            TestConfiguration.OpenAI.ApiKey);
-
-        return builder.Build();
-    }
 }

dotnet/src/InternalUtilities/samples/InternalUtilities/BaseTest.cs

@@ -93,9 +93,21 @@ public override void WriteLine(string? value)
         => this.Output.WriteLine(value ?? string.Empty);
 
     /// <inheritdoc/>
+    /// <remarks>
+    /// <see cref="ITestOutputHelper"/> only supports output that ends with a newline.
+    /// User this method will resolve in a call to <see cref="WriteLine(string?)"/>.
+    /// </remarks>
     public override void Write(object? value = null)
         => this.Output.WriteLine(value ?? string.Empty);
 
+    /// <inheritdoc/>
+    /// <remarks>
+    /// <see cref="ITestOutputHelper"/> only supports output that ends with a newline.
+    /// User this method will resolve in a call to <see cref="WriteLine(string?)"/>.
+    /// </remarks>
+    public override void Write(char[]? buffer)
+        => this.Output.WriteLine(new string(buffer));
+
     /// <inheritdoc/>
     public override Encoding Encoding => Encoding.UTF8;