Skip to content

Latest commit

 

History

History
289 lines (192 loc) · 13.9 KB

CHANGELOG.md

File metadata and controls

289 lines (192 loc) · 13.9 KB

Changelog

(Unreleased)

v1.12.0

  • Activity tag support (#426)
  • Adding Analyzer to build and release (#444)
  • Add ability to filter orchestrations at worker (#443)
  • Removing breaking change for TaskOptions (#446)

v1.11.0

  • Add New Property Properties to TaskOrchestrationContext (#415)
  • Add automatic retry on gateway timeout in GrpcDurableTaskClient.WaitForInstanceCompletionAsync (#412)
  • Add specific logging for NotFound error on worker connection (#413)
  • Add user agent header to gRPC called (#417)
  • Enrich User-Agent Header in gRPC Metadata to indicate Client or Worker as caller (#421)
  • Change DTS user agent metadata to avoid overlap with gRPC user agent (#423)
  • Add extension methods for registering entities by type (#427)
  • Add TaskVersion and utilize it for version overrides when starting orchestrations (#416)
  • Update sub-orchestration default versioning (#437)
  • Distributed Tracing for Entities (Isolated) (#404)

v1.10.0

  • Update DurableTask.Core to v3.1.0 and Bump version to v1.10.0 by @nytian in (#411)

v1.9.1

  • Add basic orchestration and activity execution logs by @cgillum in (#405)
  • Add default version in TaskOrchestrationContext by @halspang in (#408)

v1.9.0

  • Fix schedule sample logging setup by @YunchuWang in (#392)
  • Introduce versioning to the DurableTaskClient by @halspang in (#393)
  • Support for local credential types for DTS by @cgillum in (#396)
  • Add utilities for easier versioning usage by @halspang in (#394)
  • Add tags to CreateInstanceRequest by @torosent in (#397)
  • Partial Purge Support by @YunchuWang in (#400)
  • Dts Grpc client retry support by @YunchuWang in (#403)
  • Introduce orchestration versioning into worker by @halspang in (#401)

v1.8.1

  • Add timeout to gRPC workitem streaming (#390)

v1.8.0

  • Add Schedule Support for Durable Task Framework (#368)
  • Fixes and improvements

v1.7.0

  • Add parent trace context information when scheduling an orchestration (#358)

v1.6.0

  • Added new preview packages, Microsoft.DurableTask.Client.AzureManaged and Microsoft.DurableTask.Worker.AzureManaged
  • Move to Central Package Management (#373)

Microsoft.DurableTask.Client

  • Add new IDurableTaskClientBuilder AddDurableTaskClient(IServiceCollection, string?) API

Microsoft.DurableTask.Worker

  • Add new IDurableTaskWorkerBuilder AddDurableTaskWorker(IServiceCollection, string?) API
  • Add support for work item history streaming

Microsoft.DurableTask.Worker.Grpc

  • Provide entity support for direct grpc connections to DTS (#369)

Microsoft.DurableTask.Grpc

  • Replace submodule for proto files with download script for easier maintenance
  • Update to latest proto files

v1.5.0

  • Implement work item completion tokens for standalone worker scenarios (#359)
  • Support for worker concurrency configuration (#359)
  • Bump System.Text.Json to 6.0.10
  • Initial support for the Azure-managed Durable Task Scheduler preview.

v1.4.0

  • Microsoft.Azure.DurableTask.Core dependency increased to 3.0.0

v1.3.0

Microsoft.DurableTask.Abstractions

  • Add RetryPolicy.Handle property to allow for exception filtering on retries (#314)

v1.2.4

  • Microsoft.Azure.DurableTask.Core dependency increased to 2.17.1

v1.2.3

Microsoft.DurableTask.Client

  • Fix filter not being passed along in PurgeAllInstancesAsync (#289)

Microsoft.DurableTask.Abstractions

  • Enable inner exception detail propagation in TaskFailureDetails (#290)
  • Microsoft.Azure.DurableTask.Core dependency increased to 2.17.0

v1.2.2

Microsoft.DurableTask.Abstractions

  • Fix TaskFailureDetails.IsCausedBy to support custom exceptions and 3rd party exceptions (#273)
  • Microsoft.Azure.DurableTask.Core dependency increased to 2.16.2

Microsoft.DurableTask.Client

  • Fix typo in PurgeInstanceAsync in DurableTaskClient (#264)

v1.2.0

  • Adds support to recursively terminate/purge sub-orchestrations in GrpcDurableTaskClient (#262)

v1.1.1

  • Microsoft.Azure.DurableTask.Core dependency increased to 2.16.1

v1.1.0

  • Microsoft.Azure.DurableTask.Core dependency increased to 2.16.0

v1.1.0-preview.2

  • Microsoft.Azure.DurableTask.Core dependency increased to 2.16.0-preview.2

v1.1.0-preview.1

Adds support for durable entities. Learn more here.

Microsoft.DurableTask.Abstractions

  • Microsoft.Azure.DurableTask.Core dependency increased to 2.16.0-preview.1

v1.0.5

Microsoft.DurableTask.Abstractions

  • Microsoft.Azure.DurableTask.Core dependency increased to 2.15.0 (#212)

Microsoft.DurableTask.Worker

  • Fix re-encoding of events when using TaskOrchestrationContext.ContinueAsNew(preserveUnprocessedEvents: true) (#212)

v1.0.4

Microsoft.DurableTask.Worker

  • Fix handling of concurrent external events with the same name (#194)

v1.0.3

Microsoft.DurableTask.Worker

  • Fix instance ID not being passed in when using retry policy (#174)

Microsoft.DurableTask.Worker.Grpc

  • Add GrpcDurableTaskWorkerOptions.CallInvoker as an alternative to GrpcDurableTaskWorkerOptions.Channel

Microsoft.DurableTask.Client.Grpc

  • Add GrpcDurableTaskClientOptions.CallInvoker as an alternative to GrpcDurableTaskClientOptions.Channel

v1.0.2

Microsoft.DurableTask.Worker

  • Fix issue with TaskOrchestrationContext.Parent not being set.

v1.0.1

Microsoft.DurableTask.Client

  • Fix incorrect bounds check on PurgeResult
  • Address typo for DurableTaskClient.GetInstancesAsync (incorrectly pluralized)
    • Added GetInstanceAsync
    • Hide GetInstancesAsync from editor

v1.0.0

  • Added SuspendInstanceAsync and ResumeInstanceAsync to DurableTaskClient.
  • Rename DurableTaskClient methods
    • TerminateAsync -> TerminateInstanceAsync
    • PurgeInstanceMetadataAsync -> PurgeInstanceAsync
    • PurgeInstances -> PurgeAllInstancesAsync
    • GetInstanceMetadataAsync -> GetInstanceAsync
    • GetInstances -> GetAllInstancesAsync
  • TaskOrchestrationContext.CreateReplaySafeLogger now creates ILogger directly (as opposed to wrapping an existing ILogger).
  • Durable Functions class-based syntax now resolves ITaskActivity instances from IServiceProvider, if available there.
  • DurableTaskClient methods have been touched up to ensure CancellationToken is included, as well as is the last parameter.
  • Removed obsolete/unimplemented local lambda activity calls from TaskOrchestrationContext
  • Input is now an optional parameter on TaskOrchestrationContext.ContinueAsNew
  • Multi-target gRPC projects to now use Grpc.Net.Client when appropriate (.NET6.0 and up)

Note: Microsoft.DurableTask.Generators is remaining as preview.1.

v1.0.0-rc.1

Included Packages

Microsoft.DurableTask.Abstractions
Microsoft.DurableTask.Client
Microsoft.DurableTask.Client.Grpc
Microsoft.DurableTask.Worker
Microsoft.DurableTask.Worker.Grpc \

see v1.0.0-preview.1 for Microsoft.DurableTask.Generators

Updates

  • Refactors and splits assemblies.
    • Microsoft.DurableTask.Abstractions
    • Microsoft.DurableTask.Generators
    • Microsoft.DurableTask.Client
    • Microsoft.DurableTask.Client.Grpc
    • Microsoft.DurableTask.Worker
    • Microsoft.DurableTask.Worker.Grpc
  • Added more API documentation
  • Adds ability to perform multi-instance query
  • Adds PurgeInstancesMetadataAsync and PurgeInstancesAsync support and implementation to GrpcDurableTaskClient
  • Fix issue with mixed Newtonsoft.Json and System.Text.Json serialization.
  • IDurableTaskClientProvider added to support multiple named clients.
  • Added new options pattern for starting new and sub orchestrations.
  • Overhauled builder API built on top of .NET generic host.
    • Now relies on dependency injection.
    • Integrates into options pattern, giving a variety of ways for user configuration.
    • Builder is now re-enterable. Multiple calls to .AddDurableTask{Worker|Client} with the same name will yield the exact same builder instance.

Breaking Changes

  • Microsoft.DurableTask.Generators reference removed.
  • Added new abstract property TaskOrchestrationContext.ParentInstance.
  • Added new abstract method DurableTaskClient.PurgeInstancesAsync.
  • Renamed TaskOrchestratorBase to TaskOrchestrator
    • OnRunAsync -> RunAsync, forced-nullability removed.
    • Nullability can be done in generic params, ie: MyOrchestrator : TaskOrchestrator<string?, string?>
    • Nullability is not verified at runtime by the base class, it is up to the individual orchestrator implementations to verify their own nullability.
  • Renamed TaskActivityBase to TaskActivity
    • OnRun removed. With both OnRun and OnRunAsync, there was no compiler error when you did not implement one. The remaining method is now marked abstract to force an implementation. Synchronous implementation can still be done via Task.FromResult.
    • OnRunAsync -> RunAsync, forced-nullability removed.
    • Nullability can be done in generic params, ie: MyActivity : TaskActivity<string?, string?>
    • Nullability is not verified at runtime by the base class, it is up to the individual activity implementations to verify their own nullability.
  • TaskOrchestrationContext.StartSubOrchestrationAsync refactored:
    • instanceId parameter removed. Can now specify it via supplying SubOrchestrationOptions for TaskOptions.
  • TaskOptions refactored to be a record type.
    • Builder removed.
    • Retry provided via a property TaskRetryOptions, which is a pseudo union-type which can be either a RetryPolicy or AsyncRetryHandler.
    • SubOrchestrationOptions is a derived type that can be used to specific a sub-orchestrations instanceId.
    • Helper method .WithInstanceId(string? instanceId) added.
  • DurableTaskClient.ScheduleNewOrchestrationInstanceAsync refactored:
    • instanceId and startAfter wrapped into StartOrchestrationOptions object.
  • Builder API completely overhauled. Now built entirely on top of the .NET generic host.
    • See samples for how the new API works.
    • Supports multiple workers and named-clients.
  • Ability to set TaskName.Version removed for now. Will be added when we address versioning.
  • IDurableTaskRegistry removed, only DurableTaskRegistry concrete type.
    • All lambda-methods renamed to AddActivityFunc and AddOrchestratorFunc. This was to avoid ambiguous or incorrect overload resolution with the factory methods.

v1.0.0-preview.1

Included Packages

Microsoft.DurableTask.Generators

Breaking Changes

  • Microsoft.DurableTask.Generators is now an optional package.
    • no longer automatically brought in when referencing other packages.
    • To get code generation, add <PackageReference Include="Microsoft.DurableTask.Generators" Version="1.0.0-preview.1" PrivateAssets="All" /> to your csproj.
  • GeneratedDurableTaskExtensions.AddAllGeneratedTasks made internal (from public)
    • This is also to avoid conflicts when multiple files have this method generated. When wanting to expose to external consumes, a new extension method can be manually authored in the desired namespace and with an appropriate name which calls this method.

v0.4.1-beta

Initial public release