test

dotnet/samples/GettingStarted/Workflows/Checkpoint/CheckpointAndResume/Program.cs

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Agents.AI.Workflows;
+
+namespace WorkflowCheckpointAndResumeSample;
+
+/// <summary>
+/// This sample introduces the concepts of check points and shows how to save and restore
+/// the state of a workflow using checkpoints.
+/// This sample demonstrates checkpoints, which allow you to save and restore a workflow's state.
+/// Key concepts:
+/// - Super Steps: A workflow executes in stages called "super steps". Each super step runs
+///   one or more executors and completes when all those executors finish their work.
+/// - Checkpoints: The system automatically saves the workflow's state at the end of each
+///   super step. You can use these checkpoints to resume the workflow from any saved point.
+/// - Resume: If needed, you can restore a checkpoint and continue execution from that state.
+/// </summary>
+/// <remarks>
+/// Pre-requisites:
+/// - Foundational samples should be completed first.
+/// </remarks>
+public static class Program
+{
+    private static async Task Main()
+    {
+        // Create the workflow
+        var workflow = WorkflowFactory.BuildWorkflow();
+
+        // Create checkpoint manager
+        var checkpointManager = CheckpointManager.Default;
+        var checkpoints = new List<CheckpointInfo>();
+
+        // Execute the workflow and save checkpoints
+        await using Checkpointed<StreamingRun> checkpointedRun = await InProcessExecution
+            .StreamAsync(workflow, NumberSignal.Init, checkpointManager)
+            ;
+        await foreach (WorkflowEvent evt in checkpointedRun.Run.WatchStreamAsync())
+        {
+            if (evt is ExecutorCompletedEvent executorCompletedEvt)
+            {
+                Console.WriteLine($"* Executor {executorCompletedEvt.ExecutorId} completed.");
+            }
+
+            if (evt is SuperStepCompletedEvent superStepCompletedEvt)
+            {
+                // Checkpoints are automatically created at the end of each super step when a
+                // checkpoint manager is provided. You can store the checkpoint info for later use.
+                CheckpointInfo? checkpoint = superStepCompletedEvt.CompletionInfo!.Checkpoint;
+                if (checkpoint is not null)
+                {
+                    checkpoints.Add(checkpoint);
+                    Console.WriteLine($"** Checkpoint created at step {checkpoints.Count}.");
+                }
+            }
+
+            if (evt is WorkflowOutputEvent workflowOutputEvt)
+            {
+                Console.WriteLine($"Workflow completed with result: {workflowOutputEvt.Data}");
+            }
+        }
+
+        if (checkpoints.Count == 0)
+        {
+            throw new InvalidOperationException("No checkpoints were created during the workflow execution.");
+        }
+        Console.WriteLine($"Number of checkpoints created: {checkpoints.Count}");
+
+        // Restoring from a checkpoint and resuming execution
+        const int CheckpointIndex = 5;
+        Console.WriteLine($"\n\nRestoring from the {CheckpointIndex + 1}th checkpoint.");
+        CheckpointInfo savedCheckpoint = checkpoints[CheckpointIndex];
+        // Note that we are restoring the state directly to the same run instance.
+        await checkpointedRun.RestoreCheckpointAsync(savedCheckpoint, CancellationToken.None);
+        await foreach (WorkflowEvent evt in checkpointedRun.Run.WatchStreamAsync())
+        {
+            if (evt is ExecutorCompletedEvent executorCompletedEvt)
+            {
+                Console.WriteLine($"* Executor {executorCompletedEvt.ExecutorId} completed.");
+            }
+
+            if (evt is WorkflowOutputEvent workflowOutputEvt)
+            {
+                Console.WriteLine($"Workflow completed with result: {workflowOutputEvt.Data}");
+            }
+        }
+    }
+}