Merge branch 'main' into copilot/make-initializestate-async

Author: YunchuWang

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## v1.18.2
+- Add copy constructors to TaskOptions and sub-classes by halspang ([#587](https://github.com/microsoft/durabletask-dotnet/pull/587))
+- Change FunctionNotFound analyzer severity to Info for cross-assembly scenarios by Copilot ([#584](https://github.com/microsoft/durabletask-dotnet/pull/584))
+- Add Roslyn analyzer for non-contextual logger usage in orchestrations (DURABLE0010) by Copilot ([#553](https://github.com/microsoft/durabletask-dotnet/pull/553))
+- Add specific logging categories for Worker.Grpc and orchestration logs with backward-compatible opt-in by Copilot ([#583](https://github.com/microsoft/durabletask-dotnet/pull/583))
+- Fix flaky integration test race condition in dedup status check by Copilot ([#579](https://github.com/microsoft/durabletask-dotnet/pull/579))
+- Add analyzer to suggest input parameter binding over GetInput() by Copilot ([#550](https://github.com/microsoft/durabletask-dotnet/pull/550))
+- Add strongly-typed external events with DurableEventAttribute by Copilot ([#549](https://github.com/microsoft/durabletask-dotnet/pull/549))
+- Fix orchestration analyzer to detect non-function orchestrations correctly by Copilot ([#572](https://github.com/microsoft/durabletask-dotnet/pull/572))
+- Fix race condition in WaitForInstanceAsync causing intermittent test failures by Copilot ([#574](https://github.com/microsoft/durabletask-dotnet/pull/574))
+- Add HelpLinkUri to Roslyn analyzer diagnostics by Copilot ([#548](https://github.com/microsoft/durabletask-dotnet/pull/548))
+- Add DateTimeOffset.Now and DateTimeOffset.UtcNow detection to Roslyn analyzer by Copilot ([#547](https://github.com/microsoft/durabletask-dotnet/pull/547))
+- Bump Google.Protobuf from 3.33.1 to 3.33.2 by dependabot[bot] ([#569](https://github.com/microsoft/durabletask-dotnet/pull/569))
+- Add integration test coverage for Suspend/Resume operations by Copilot ([#546](https://github.com/microsoft/durabletask-dotnet/pull/546))
+- Bump coverlet.collector from 6.0.2 to 6.0.4 by dependabot[bot] ([#527](https://github.com/microsoft/durabletask-dotnet/pull/527))
+- Bump FluentAssertions from 6.12.1 to 6.12.2 by dependabot[bot] ([#528](https://github.com/microsoft/durabletask-dotnet/pull/528))
+- Add Azure Functions smoke tests with Docker CI automation by Copilot ([#545](https://github.com/microsoft/durabletask-dotnet/pull/545))
+- Bump dotnet-sdk from 10.0.100 to 10.0.101 by dependabot[bot] ([#568](https://github.com/microsoft/durabletask-dotnet/pull/568))
+- Add scheduled auto-closure for stale "Needs Author Feedback" issues by Copilot ([#566](https://github.com/microsoft/durabletask-dotnet/pull/566))
+
 ## v1.18.1
 - Support dedup status when starting orchestration by wangbill ([#542](https://github.com/microsoft/durabletask-dotnet/pull/542))
 - Add 404 exception handling in blobpayloadstore.downloadasync by Copilot ([#534](https://github.com/microsoft/durabletask-dotnet/pull/534))

Directory.Packages.props

@@ -32,7 +32,7 @@
   <!-- DurableTask Packages -->
   <ItemGroup>
     <PackageVersion Include="Microsoft.Azure.DurableTask.Core" Version="3.6.0" />
-    <PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.DurableTask" Version="1.10.0" />
+    <PackageVersion Include="Microsoft.Azure.Functions.Worker.Extensions.DurableTask" Version="1.12.1" />
   </ItemGroup>
 
   <!-- Grpc / Protobuf Packages -->

eng/targets/Release.props

@@ -17,7 +17,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>1.18.1</VersionPrefix>
+    <VersionPrefix>1.18.2</VersionPrefix>
     <VersionSuffix></VersionSuffix>
   </PropertyGroup>
 

src/Abstractions/TaskOptions.cs

@@ -30,6 +30,17 @@ public TaskOptions(TaskRetryOptions? retry = null, IDictionary<string, string>?
         this.Tags = tags;
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="TaskOptions"/> class by copying from another instance.
+    /// </summary>
+    /// <param name="options">The task options to copy from.</param>
+    public TaskOptions(TaskOptions options)
+    {
+        Check.NotNull(options);
+        this.Retry = options.Retry;
+        this.Tags = options.Tags;
+    }
+
     /// <summary>
     /// Gets the task retry options.
     /// </summary>
@@ -96,12 +107,29 @@ public SubOrchestrationOptions(TaskOptions options, string? instanceId = null)
         : base(options)
     {
         this.InstanceId = instanceId;
-        if (instanceId is null && options is SubOrchestrationOptions derived)
+        if (options is SubOrchestrationOptions derived)
         {
-            this.InstanceId = derived.InstanceId;
+            if (instanceId is null)
+            {
+                this.InstanceId = derived.InstanceId;
+            }
+
+            this.Version = derived.Version;
         }
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SubOrchestrationOptions"/> class by copying from another instance.
+    /// </summary>
+    /// <param name="options">The sub-orchestration options to copy from.</param>
+    public SubOrchestrationOptions(SubOrchestrationOptions options)
+        : base(options)
+    {
+        Check.NotNull(options);
+        this.InstanceId = options.InstanceId;
+        this.Version = options.Version;
+    }
+
     /// <summary>
     /// Gets the orchestration instance ID.
     /// </summary>
@@ -116,15 +144,51 @@ public SubOrchestrationOptions(TaskOptions options, string? instanceId = null)
 /// <summary>
 /// Options for submitting new orchestrations via the client.
 /// </summary>
-/// <param name="InstanceId">
-/// The unique ID of the orchestration instance to schedule. If not specified, a new GUID value is used.
-/// </param>
-/// <param name="StartAt">
-/// The time when the orchestration instance should start executing. If not specified or if a date-time in the past
-/// is specified, the orchestration instance will be scheduled immediately.
-/// </param>
-public record StartOrchestrationOptions(string? InstanceId = null, DateTimeOffset? StartAt = null)
+public record StartOrchestrationOptions
 {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="StartOrchestrationOptions"/> class.
+    /// </summary>
+    /// <param name="InstanceId">
+    /// The unique ID of the orchestration instance to schedule. If not specified, a new GUID value is used.
+    /// </param>
+    /// <param name="StartAt">
+    /// The time when the orchestration instance should start executing. If not specified or if a date-time in the past
+    /// is specified, the orchestration instance will be scheduled immediately.
+    /// </param>
+#pragma warning disable SA1313 // Parameter names should begin with lower-case letter - using PascalCase to maintain backward compatibility with positional record syntax
+    public StartOrchestrationOptions(string? InstanceId = null, DateTimeOffset? StartAt = null)
+#pragma warning restore SA1313
+    {
+        this.InstanceId = InstanceId;
+        this.StartAt = StartAt;
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="StartOrchestrationOptions"/> class by copying from another instance.
+    /// </summary>
+    /// <param name="options">The start orchestration options to copy from.</param>
+    public StartOrchestrationOptions(StartOrchestrationOptions options)
+    {
+        Check.NotNull(options);
+        this.InstanceId = options.InstanceId;
+        this.StartAt = options.StartAt;
+        this.Tags = options.Tags;
+        this.Version = options.Version;
+        this.DedupeStatuses = options.DedupeStatuses;
+    }
+
+    /// <summary>
+    /// Gets the unique ID of the orchestration instance to schedule. If not specified, a new GUID value is used.
+    /// </summary>
+    public string? InstanceId { get; init; }
+
+    /// <summary>
+    /// Gets the time when the orchestration instance should start executing. If not specified or if a date-time in the past
+    /// is specified, the orchestration instance will be scheduled immediately.
+    /// </summary>
+    public DateTimeOffset? StartAt { get; init; }
+
     /// <summary>
     /// Gets the tags to associate with the orchestration instance.
     /// </summary>

src/Abstractions/TaskOrchestrationContext.cs

@@ -222,13 +222,28 @@ public virtual Task CreateTimer(TimeSpan delay, CancellationToken cancellationTo
     /// </param>
     /// <param name="timeout">The amount of time to wait before cancelling the external event task.</param>
     /// <inheritdoc cref="WaitForExternalEvent(string, CancellationToken)"/>
-    public async Task<T> WaitForExternalEvent<T>(string eventName, TimeSpan timeout)
+    public Task<T> WaitForExternalEvent<T>(string eventName, TimeSpan timeout)
+    {
+        return this.WaitForExternalEvent<T>(eventName, timeout, CancellationToken.None);
+    }
+
+    /// <param name="eventName">
+    /// The name of the event to wait for. Event names are case-insensitive. External event names can be reused any
+    /// number of times; they are not required to be unique.
+    /// </param>
+    /// <param name="timeout">The amount of time to wait before cancelling the external event task.</param>
+    /// <param name="cancellationToken">A <c>CancellationToken</c> to use to abort waiting for the event.</param>
+    /// <inheritdoc cref="WaitForExternalEvent(string, CancellationToken)"/>
+    public async Task<T> WaitForExternalEvent<T>(string eventName, TimeSpan timeout, CancellationToken cancellationToken)
     {
         // Timeouts are implemented using durable timers.
         using CancellationTokenSource timerCts = new();
         Task timeoutTask = this.CreateTimer(timeout, timerCts.Token);
 
-        using CancellationTokenSource eventCts = new();
+        // Create a linked cancellation token source from the external cancellation token.
+        // This allows us to cancel the event wait either when the external token is cancelled
+        // or when the timeout fires (by calling eventCts.Cancel()).
+        using CancellationTokenSource eventCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken);
         Task<T> externalEventTask = this.WaitForExternalEvent<T>(eventName, eventCts.Token);
 
         // Wait for either task to complete and then cancel the one that didn't.

src/Analyzers/Activities/FunctionNotFoundAnalyzer.cs

@@ -37,7 +37,7 @@ public sealed class FunctionNotFoundAnalyzer : DiagnosticAnalyzer
         ActivityNotFoundTitle,
         ActivityNotFoundMessageFormat,
         AnalyzersCategories.Activity,
-        DiagnosticSeverity.Warning,
+        DiagnosticSeverity.Info,
         customTags: [WellKnownDiagnosticTags.CompilationEnd],
         isEnabledByDefault: true,
         helpLinkUri: "https://go.microsoft.com/fwlink/?linkid=2346202");
@@ -47,7 +47,7 @@ public sealed class FunctionNotFoundAnalyzer : DiagnosticAnalyzer
         SubOrchestrationNotFoundTitle,
         SubOrchestrationNotFoundMessageFormat,
         AnalyzersCategories.Orchestration,
-        DiagnosticSeverity.Warning,
+        DiagnosticSeverity.Info,
         customTags: [WellKnownDiagnosticTags.CompilationEnd],
         isEnabledByDefault: true,
         helpLinkUri: "https://go.microsoft.com/fwlink/?linkid=2346202");

src/Analyzers/AnalyzerReleases.Shipped.md

@@ -7,8 +7,8 @@
 
 Rule ID | Category | Severity | Notes
 --------|----------|----------|-------
-DURABLE2003 | Activity | Warning | **FunctionNotFoundAnalyzer**: Warns when an activity function call references a name that does not match any defined activity in the compilation.
-DURABLE2004 | Orchestration | Warning | **FunctionNotFoundAnalyzer**: Warns when a sub-orchestration call references a name that does not match any defined orchestrator in the compilation.
+DURABLE2003 | Activity | Info | **FunctionNotFoundAnalyzer**: Reports when an activity function call references a name that does not match any defined activity in the compilation. If the function is defined in another assembly, this diagnostic can be safely ignored. Static resolution across referenced assemblies is not supported.
+DURABLE2004 | Orchestration | Info | **FunctionNotFoundAnalyzer**: Reports when a sub-orchestration call references a name that does not match any defined orchestrator in the compilation. If the function is defined in another assembly, this diagnostic can be safely ignored. Static resolution across referenced assemblies is not supported.
 
 ## Release 0.1.0
 

src/Analyzers/AnalyzerReleases.Unshipped.md

@@ -6,3 +6,4 @@
 Rule ID | Category | Severity | Notes
 --------|----------|----------|-------
 DURABLE0009 | Orchestration | Info | **GetInputOrchestrationAnalyzer**: Suggests using input parameter binding instead of ctx.GetInput<T>() in orchestration methods.
+DURABLE0010 | Orchestration | Warning | **LoggerOrchestrationAnalyzer**: Warns when a non-contextual ILogger is used in an orchestration method. Orchestrations should use `context.CreateReplaySafeLogger()` instead of injecting ILogger directly.

src/Analyzers/Analyzers.csproj

@@ -11,7 +11,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>0.2.0</VersionPrefix>
+    <VersionPrefix>0.3.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <PackageDescription>.NET Analyzers for the Durable Task SDK.</PackageDescription>
     <NeutralLanguage>en</NeutralLanguage>

src/Analyzers/KnownTypeSymbols.Net.cs

@@ -23,6 +23,7 @@ public sealed partial class KnownTypeSymbols
     INamedTypeSymbol? cancellationToken;
     INamedTypeSymbol? environment;
     INamedTypeSymbol? httpClient;
+    INamedTypeSymbol? iLogger;
 
     /// <summary>
     /// Gets a Guid type symbol.
@@ -75,4 +76,9 @@ public sealed partial class KnownTypeSymbols
     /// Gets an HttpClient type symbol.
     /// </summary>
     public INamedTypeSymbol? HttpClient => this.GetOrResolveFullyQualifiedType(typeof(HttpClient).FullName, ref this.httpClient);
+
+    /// <summary>
+    /// Gets an ILogger type symbol.
+    /// </summary>
+    public INamedTypeSymbol? ILogger => this.GetOrResolveFullyQualifiedType("Microsoft.Extensions.Logging.ILogger", ref this.iLogger);
 }