feat: Schedule Support

Microsoft.DurableTask.sln

@@ -85,6 +85,14 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Shared.AzureManaged.Tests",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConsoleAppMinimal", "samples\ConsoleAppMinimal\ConsoleAppMinimal.csproj", "{B48FACA9-A328-452A-BFAE-C4F60F9C7024}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScheduledTasks", "src\ScheduledTasks\ScheduledTasks.csproj", "{69ED743C-D616-4530-87E2-391D249D7368}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScheduleConsoleApp", "samples\ScheduleConsoleApp\ScheduleConsoleApp.csproj", "{A89B766C-987F-4C9F-8937-D0AB9FE640C8}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScheduleWebApp", "samples\ScheduleWebApp\ScheduleWebApp.csproj", "{100348B5-4D97-4A3F-B777-AB14F276F8FE}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScheduledTasks.Tests", "test\ScheduledTasks.Tests\ScheduledTasks.Tests.csproj", "{D2779F32-A548-44F8-B60A-6AC018966C79}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -223,6 +231,22 @@ Global
 		{B48FACA9-A328-452A-BFAE-C4F60F9C7024}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B48FACA9-A328-452A-BFAE-C4F60F9C7024}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{B48FACA9-A328-452A-BFAE-C4F60F9C7024}.Release|Any CPU.Build.0 = Release|Any CPU
+		{69ED743C-D616-4530-87E2-391D249D7368}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{69ED743C-D616-4530-87E2-391D249D7368}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{69ED743C-D616-4530-87E2-391D249D7368}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{69ED743C-D616-4530-87E2-391D249D7368}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A89B766C-987F-4C9F-8937-D0AB9FE640C8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A89B766C-987F-4C9F-8937-D0AB9FE640C8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A89B766C-987F-4C9F-8937-D0AB9FE640C8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A89B766C-987F-4C9F-8937-D0AB9FE640C8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{100348B5-4D97-4A3F-B777-AB14F276F8FE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{100348B5-4D97-4A3F-B777-AB14F276F8FE}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{100348B5-4D97-4A3F-B777-AB14F276F8FE}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{100348B5-4D97-4A3F-B777-AB14F276F8FE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D2779F32-A548-44F8-B60A-6AC018966C79}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D2779F32-A548-44F8-B60A-6AC018966C79}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D2779F32-A548-44F8-B60A-6AC018966C79}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D2779F32-A548-44F8-B60A-6AC018966C79}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -265,6 +289,10 @@ Global
 		{CECADDB5-E30A-4CE2-8604-9AC596D4A2DC} = {E5637F81-2FB9-4CD7-900D-455363B142A7}
 		{3272C041-F81D-4C85-A4FB-2A700B5A7A9D} = {CECADDB5-E30A-4CE2-8604-9AC596D4A2DC}
 		{B48FACA9-A328-452A-BFAE-C4F60F9C7024} = {EFF7632B-821E-4CFC-B4A0-ED4B24296B17}
+		{69ED743C-D616-4530-87E2-391D249D7368} = {8AFC9781-F6F1-4696-BB4A-9ED7CA9D612B}
+		{A89B766C-987F-4C9F-8937-D0AB9FE640C8} = {EFF7632B-821E-4CFC-B4A0-ED4B24296B17}
+		{100348B5-4D97-4A3F-B777-AB14F276F8FE} = {EFF7632B-821E-4CFC-B4A0-ED4B24296B17}
+		{D2779F32-A548-44F8-B60A-6AC018966C79} = {E5637F81-2FB9-4CD7-900D-455363B142A7}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {AB41CB55-35EA-4986-A522-387AB3402E71}

samples/ScheduleConsoleApp/Activities/GetStockPrice.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.DurableTask;
+
+namespace ScheduleConsoleApp.Activities;
+
+[DurableTask]
+public class GetStockPrice : TaskActivity<string, decimal>
+{
+    public override Task<decimal> RunAsync(TaskActivityContext context, string symbol)
+    {
+        // Mock implementation - would normally call stock API
+        return Task.FromResult(100.00m);
+    }
+}

samples/ScheduleConsoleApp/Orchestrators/StockPriceOrchestrator.cs

@@ -0,0 +1,29 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.DurableTask;
+using Microsoft.Extensions.Logging;
+
+[DurableTask]
+public class StockPriceOrchestrator : TaskOrchestrator<string, string>
+{
+    public override async Task<string> RunAsync(TaskOrchestrationContext context, string symbol)
+    {
+        var logger = context.CreateReplaySafeLogger("DemoOrchestration");
+        logger.LogInformation("Getting stock price for: {symbol}", symbol);
+        try
+        {
+            // Get current stock price
+            decimal currentPrice = await context.CallGetStockPriceAsync(symbol);
+
+            logger.LogInformation("Current price for {symbol} is ${price:F2}", symbol, currentPrice);
+
+            return $"Stock {symbol} price: ${currentPrice:F2} at {DateTime.UtcNow}";
+        }
+        catch (Exception ex)
+        {
+            logger.LogError(ex, "Error processing stock price for {symbol}", symbol);
+            throw;
+        }
+    }
+}

samples/ScheduleConsoleApp/Program.cs

@@ -0,0 +1,57 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+using Microsoft.DurableTask;
+using Microsoft.DurableTask.Client;
+using Microsoft.DurableTask.Client.AzureManaged;
+using Microsoft.DurableTask.ScheduledTasks;
+using Microsoft.DurableTask.Worker;
+using Microsoft.DurableTask.Worker.AzureManaged;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using ScheduleConsoleApp;
+
+HostApplicationBuilder builder = Host.CreateApplicationBuilder(args);
+
+// Get configuration
+string connectionString = builder.Configuration.GetValue<string>("DURABLE_TASK_SCHEDULER_CONNECTION_STRING")
+    ?? throw new InvalidOperationException("Missing required configuration 'DURABLE_TASK_SCHEDULER_CONNECTION_STRING'");
+
+// Configure the worker
+builder.Services.AddDurableTaskWorker(builder =>
+{
+    // Add the Schedule entity and demo orchestration
+    builder.AddTasks(r => r.AddAllGeneratedTasks());
+
+    // Enable scheduled tasks support
+    builder.UseDurableTaskScheduler(connectionString);
+    builder.UseScheduledTasks();
+});
+
+// Configure the client
+builder.Services.AddDurableTaskClient(builder =>
+{
+    builder.UseDurableTaskScheduler(connectionString);
+    builder.UseScheduledTasks();
+});
+
+// Configure console logging
+builder.Services.AddLogging(logging =>
+{
+    logging.AddSimpleConsole(options =>
+    {
+        options.SingleLine = true;
+        options.UseUtcTimestamp = true;
+        options.TimestampFormat = "yyyy-MM-ddTHH:mm:ss.fffZ ";
+    });
+});
+
+IHost host = builder.Build();
+await host.StartAsync();
+
+// Run the schedule operations
+ScheduledTaskClient scheduledTaskClient = host.Services.GetRequiredService<ScheduledTaskClient>();
+await ScheduleDemo.RunDemoAsync(scheduledTaskClient);
+
+await host.StopAsync();

samples/ScheduleConsoleApp/ScheduleConsoleApp.csproj

@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Hosting"/>
+    <PackageReference Include="Azure.Identity" />
+    <PackageReference Include="Grpc.Net.Client" />
+    <PackageReference Include="Microsoft.DurableTask.Generators" OutputItemType="Analyzer" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Client\AzureManaged\Client.AzureManaged.csproj" />
+    <ProjectReference Include="..\..\src\Worker\AzureManaged\Worker.AzureManaged.csproj" />
+    <ProjectReference Include="..\..\src\ScheduledTasks\ScheduledTasks.csproj" />
+  </ItemGroup>
+</Project>

samples/ScheduleConsoleApp/ScheduleDemo.cs

@@ -0,0 +1,84 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.DurableTask;
+using Microsoft.DurableTask.ScheduledTasks;
+
+namespace ScheduleConsoleApp;
+
+/// <summary>
+/// Demonstrates various schedule operations in a sample application.
+/// </summary>
+static class ScheduleDemo
+{
+    public static async Task RunDemoAsync(ScheduledTaskClient scheduledTaskClient)
+    {
+        ArgumentNullException.ThrowIfNull(scheduledTaskClient);
+
+        try
+        {
+            await DeleteExistingSchedulesAsync(scheduledTaskClient);
+            await CreateAndManageScheduleAsync(scheduledTaskClient);
+        }
+        catch (Exception ex)
+        {
+            Console.WriteLine($"One of your schedule operations failed, please fix and rerun: {ex.Message}");
+        }
+    }
+
+    static async Task DeleteExistingSchedulesAsync(ScheduledTaskClient scheduledTaskClient)
+    {
+        // Define the initial query with the desired page size
+        ScheduleQuery query = new ScheduleQuery { PageSize = 100 };
+
+        // Retrieve the pageable collection of schedule IDs
+        AsyncPageable<ScheduleDescription> schedules = scheduledTaskClient.ListSchedulesAsync(query);
+
+        // Delete each existing schedule
+        await foreach (ScheduleDescription schedule in schedules)
+        {
+            ScheduleClient scheduleClient = scheduledTaskClient.GetScheduleClient(schedule.ScheduleId);
+            await scheduleClient.DeleteAsync();
+            Console.WriteLine($"Deleted schedule {schedule.ScheduleId}");
+        }
+    }
+
+    static async Task CreateAndManageScheduleAsync(ScheduledTaskClient scheduledTaskClient)
+    {
+        // Create schedule options that runs every 4 seconds
+        ScheduleCreationOptions scheduleOptions = new ScheduleCreationOptions(
+            "demo-schedule101",
+            nameof(StockPriceOrchestrator),
+            TimeSpan.FromSeconds(4))
+        {
+            StartAt = DateTimeOffset.UtcNow,
+            OrchestrationInput = "MSFT"
+        };
+
+        // Create the schedule and get a handle to it
+        ScheduleClient scheduleClient = await scheduledTaskClient.CreateScheduleAsync(scheduleOptions);
+
+        // Get and print the initial schedule description
+        await PrintScheduleDescriptionAsync(scheduleClient);
+
+        // Pause the schedule
+        Console.WriteLine("\nPausing schedule...");
+        await scheduleClient.PauseAsync();
+        await PrintScheduleDescriptionAsync(scheduleClient);
+
+        // Resume the schedule
+        Console.WriteLine("\nResuming schedule...");
+        await scheduleClient.ResumeAsync();
+        await PrintScheduleDescriptionAsync(scheduleClient);
+
+        // Wait for a while to let the schedule run
+        await Task.Delay(TimeSpan.FromMinutes(30));
+    }
+
+    static async Task PrintScheduleDescriptionAsync(ScheduleClient scheduleClient)
+    {
+        ScheduleDescription scheduleDescription = await scheduleClient.DescribeAsync();
+        Console.WriteLine(scheduleDescription);
+        Console.WriteLine("\n\n");
+    }
+}

samples/ScheduleConsoleApp/appsettings.json

@@ -0,0 +1,10 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Debug",
+      "Microsoft": "Warning",
+      "ScheduleConsoleApp": "Debug",
+      "DemoOrchestration": "Debug"
+    }
+  }
+} 

samples/ScheduleWebApp/Models/CreateScheduleRequest.cs

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace ScheduleWebApp.Models;
+
+/// <summary>
+/// Represents a request to create a new schedule.
+/// </summary>
+public class CreateScheduleRequest
+{
+    /// <summary>
+    /// Gets or sets the unique identifier for the schedule.
+    /// </summary>
+    public string Id { get; set; } = default!;
+
+    /// <summary>
+    /// Gets or sets the name of the orchestration to be scheduled.
+    /// </summary>
+    public string OrchestrationName { get; set; } = default!;
+
+    /// <summary>
+    /// Gets or sets the input data for the orchestration.
+    /// </summary>
+    public string? Input { get; set; }
+
+    /// <summary>
+    /// Gets or sets the time interval between schedule executions.
+    /// </summary>
+    public TimeSpan Interval { get; set; }
+
+    /// <summary>
+    /// Gets or sets the time when the schedule should start.
+    /// </summary>
+    public DateTimeOffset? StartAt { get; set; }
+
+    /// <summary>
+    /// Gets or sets the time when the schedule should end.
+    /// </summary>
+    public DateTimeOffset? EndAt { get; set; }
+}

samples/ScheduleWebApp/Models/UpdateScheduleRequest.cs

@@ -0,0 +1,35 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+namespace ScheduleWebApp.Models;
+
+/// <summary>
+/// Represents a request to update an existing schedule.
+/// </summary>
+public class UpdateScheduleRequest
+{
+    /// <summary>
+    /// Gets or sets the name of the orchestration to be scheduled.
+    /// </summary>
+    public string OrchestrationName { get; set; } = default!;
+
+    /// <summary>
+    /// Gets or sets the input data for the orchestration.
+    /// </summary>
+    public string? Input { get; set; }
+
+    /// <summary>
+    /// Gets or sets the time interval between schedule executions.
+    /// </summary>
+    public TimeSpan Interval { get; set; }
+
+    /// <summary>
+    /// Gets or sets the time when the schedule should start.
+    /// </summary>
+    public DateTimeOffset? StartAt { get; set; }
+
+    /// <summary>
+    /// Gets or sets the time when the schedule should end.
+    /// </summary>
+    public DateTimeOffset? EndAt { get; set; }
+}

samples/ScheduleWebApp/Orchestrations/CacheClearingOrchestrator.cs

@@ -0,0 +1,30 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+using Microsoft.DurableTask;
+
+namespace ScheduleWebApp.Orchestrations;
+
+public class CacheClearingOrchestrator : TaskOrchestrator<string, string>
+{
+    public override async Task<string> RunAsync(TaskOrchestrationContext context, string scheduleId)
+    {
+        ILogger logger = context.CreateReplaySafeLogger(nameof(CacheClearingOrchestrator));
+        try
+        {
+            logger.LogInformation("Starting CacheClearingOrchestration for schedule ID: {ScheduleId}", scheduleId);
+
+            // Simulate cache clearing
+            await Task.Delay(TimeSpan.FromSeconds(5));
+
+            logger.LogInformation("CacheClearingOrchestration completed for schedule ID: {ScheduleId}", scheduleId);
+
+            return "ok";
+        }
+        catch (Exception ex)
+        {
+            logger.LogError(ex, "Error in CacheClearingOrchestration for schedule ID: {ScheduleId}", scheduleId);
+            throw;
+        }
+    }
+}