Merge branch 'main' into grpc-resiliency-pr708-impl

Author: andystaples

.github/copilot-instructions.md

@@ -128,3 +128,18 @@ python -m pytest
 - `examples/` — example orchestrations (see `examples/README.md`)
 - `tests/` — test suite
 - `dev-requirements.txt` — development dependencies
+
+## Cross-Package Compatibility
+
+The `durabletask-azuremanaged` package extends the core `durabletask`
+package (e.g. `DurableTaskSchedulerWorker` subclasses
+`TaskHubGrpcWorker`). When adding or changing features in
+`durabletask/`, always verify that `durabletask-azuremanaged` still
+works correctly:
+
+- Check whether the azuremanaged worker, client, or tests override or
+  depend on the code you changed.
+- Run the azuremanaged unit tests if they exist for the affected area.
+- If a new public API is added to the core SDK (e.g. a method on
+  `OrchestrationContext`), confirm it is accessible through the
+  azuremanaged package and add a test or example if appropriate.

CHANGELOG.md

@@ -2,13 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
 ADDED
 
+- Added `ReplaySafeLogger` and `OrchestrationContext.create_replay_safe_logger()`
+  for suppressing duplicate log messages during orchestrator replay
 - Added `GrpcChannelOptions` and `GrpcRetryPolicyOptions` for configuring
   gRPC transport behavior, including message-size limits, keepalive settings,
   and channel-level retry policy service configuration.
@@ -56,15 +58,17 @@ ADDED
   package with `BlobPayloadStore` and `BlobPayloadStoreOptions`
 - Added `PayloadStore` abstract base class in
   `durabletask.payload` for custom storage backends
-- Added `durabletask.testing` module with `InMemoryOrchestrationBackend` for testing orchestrations without a sidecar process
+- Added `durabletask.testing` module with `InMemoryOrchestrationBackend` for testing orchestrations
+  without a sidecar process
 - Added `AsyncTaskHubGrpcClient` for asyncio-based applications using `grpc.aio`
 - Added `DefaultAsyncClientInterceptorImpl` for async gRPC metadata interceptors
 - Added `get_async_grpc_channel` helper for creating async gRPC channels
 - Added orchestration restart client support
 - Added batch client actions for purge and query operations across orchestrations and entities
 - Added worker work item filtering support
 - Added new `work_item_filtering` sample
-- Improved distributed tracing support with full span coverage for orchestrations, activities, sub-orchestrations, timers, and events
+- Improved distributed tracing support with full span coverage for orchestrations, activities,
+  sub-orchestrations, timers, and events
 
 CHANGED
 
@@ -137,7 +141,8 @@ FIXED:
 
 ## v0.4.1
 
-- Fixed an issue where orchestrations would still throw non-determinism errors even when versioning logic should have prevented it
+- Fixed an issue where orchestrations would still throw non-determinism errors even when versioning
+  logic should have prevented it
 
 ## v0.4.0
 
@@ -148,7 +153,8 @@ FIXED:
 
 ADDED
 
-- Added `ConcurrencyOptions` class for fine-grained concurrency control with separate limits for activities and orchestrations. The thread pool worker count can also be configured.
+- Added `ConcurrencyOptions` class for fine-grained concurrency control with separate limits for
+  activities and orchestrations. The thread pool worker count can also be configured.
 
 FIXED
 
@@ -158,15 +164,29 @@ FIXED
 
 ADDED
 
-- Added `set_custom_status` orchestrator API ([#31](https://github.com/microsoft/durabletask-python/pull/31)) - contributed by [@famarting](https://github.com/famarting)
-- Added `purge_orchestration` client API ([#34](https://github.com/microsoft/durabletask-python/pull/34)) - contributed by [@famarting](https://github.com/famarting)
-- Added new `durabletask-azuremanaged` package for use with the [Durable Task Scheduler](https://learn.microsoft.com/azure/azure-functions/durable/durable-task-scheduler/durable-task-scheduler) - by [@RyanLettieri](https://github.com/RyanLettieri)
+- Added `set_custom_status` orchestrator API
+  ([#31](https://github.com/microsoft/durabletask-python/pull/31)) - contributed by
+  [@famarting](https://github.com/famarting)
+- Added `purge_orchestration` client API
+  ([#34](https://github.com/microsoft/durabletask-python/pull/34)) - contributed by
+  [@famarting](https://github.com/famarting)
+- Added new `durabletask-azuremanaged` package for use with the [Durable Task
+  Scheduler](https://learn.microsoft.com/azure/azure-functions/durable/durable-task-scheduler/durable-task-scheduler)
+  - by [@RyanLettieri](https://github.com/RyanLettieri)
 
 CHANGED
 
-- Protos are compiled with gRPC 1.62.3 / protobuf 3.25.X instead of the latest release. This ensures compatibility with a wider range of grpcio versions for better compatibility with other packages / libraries ([#36](https://github.com/microsoft/durabletask-python/pull/36)) - by [@berndverst](https://github.com/berndverst)
-- Http and grpc protocols and their secure variants are stripped from the host name parameter if provided. Secure mode is enabled if the protocol provided is https or grpcs ([#38](https://github.com/microsoft/durabletask-python/pull/38) - by [@berndverst)(https://github.com/berndverst)
-- Improve ProtoGen by downloading proto file directly instead of using submodule ([#39](https://github.com/microsoft/durabletask-python/pull/39) - by [@berndverst](https://github.com/berndverst)
+- Protos are compiled with gRPC 1.62.3 / protobuf 3.25.X instead of the latest release. This ensures
+  compatibility with a wider range of grpcio versions for better compatibility with other packages /
+  libraries ([#36](https://github.com/microsoft/durabletask-python/pull/36)) - by
+  [@berndverst](https://github.com/berndverst)
+- Http and grpc protocols and their secure variants are stripped from the host name parameter if
+  provided. Secure mode is enabled if the protocol provided is https or grpcs
+  ([#38](https://github.com/microsoft/durabletask-python/pull/38)) - by
+  [@berndverst](https://github.com/berndverst)
+- Improve ProtoGen by downloading proto file directly instead of using submodule
+  ([#39](https://github.com/microsoft/durabletask-python/pull/39) - by
+  [@berndverst](https://github.com/berndverst)
 
 CHANGED
 
@@ -176,45 +196,59 @@ CHANGED
 
 ADDED
 
-- Add recursive flag in terminate_orchestration to support cascade terminate ([#27](https://github.com/microsoft/durabletask-python/pull/27)) - contributed by [@shivamkm07](https://github.com/shivamkm07)
+- Add recursive flag in terminate_orchestration to support cascade terminate
+  ([#27](https://github.com/microsoft/durabletask-python/pull/27)) - contributed by
+  [@shivamkm07](https://github.com/shivamkm07)
 
 ## v0.1.0
 
 ADDED
 
-- Retry policies for activities and sub-orchestrations ([#11](https://github.com/microsoft/durabletask-python/pull/11)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)
+- Retry policies for activities and sub-orchestrations
+  ([#11](https://github.com/microsoft/durabletask-python/pull/11)) - contributed by
+  [@DeepanshuA](https://github.com/DeepanshuA)
 
 FIXED
 
-- Fix try/except in orchestrator functions not being handled correctly ([#21](https://github.com/microsoft/durabletask-python/pull/21)) - by [@cgillum](https://github.com/cgillum)
-- Updated `durabletask-protobuf` submodule reference to latest distributed tracing commit - by [@cgillum](https://github.com/cgillum)
+- Fix try/except in orchestrator functions not being handled correctly
+  ([#21](https://github.com/microsoft/durabletask-python/pull/21)) - by
+  [@cgillum](https://github.com/cgillum)
+- Updated `durabletask-protobuf` submodule reference to latest distributed tracing commit - by
+  [@cgillum](https://github.com/cgillum)
 
 ## v0.1.0a5
 
 ADDED
 
-- Adds support for secure channels ([#18](https://github.com/microsoft/durabletask-python/pull/18)) - contributed by [@elena-kolevska](https://github.com/elena-kolevska)
+- Adds support for secure channels ([#18](https://github.com/microsoft/durabletask-python/pull/18))
+  - contributed by [@elena-kolevska](https://github.com/elena-kolevska)
 
 FIXED
 
-- Fix zero argument values sent to activities as None ([#13](https://github.com/microsoft/durabletask-python/pull/13)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)
+- Fix zero argument values sent to activities as None
+  ([#13](https://github.com/microsoft/durabletask-python/pull/13)) - contributed by
+  [@DeepanshuA](https://github.com/DeepanshuA)
 
 ## v0.1.0a3
 
 ADDED
 
-- Add gRPC metadata option ([#16](https://github.com/microsoft/durabletask-python/pull/16)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)
+- Add gRPC metadata option ([#16](https://github.com/microsoft/durabletask-python/pull/16)) -
+  contributed by [@DeepanshuA](https://github.com/DeepanshuA)
 
 CHANGED
 
-- Removed Python 3.7 support due to EOL ([#14](https://github.com/microsoft/durabletask-python/pull/14)) - contributed by [@berndverst](https://github.com/berndverst)
+- Removed Python 3.7 support due to EOL
+  ([#14](https://github.com/microsoft/durabletask-python/pull/14)) - contributed by
+  [@berndverst](https://github.com/berndverst)
 
 ## v0.1.0a2
 
 ADDED
 
 - Continue-as-new ([#9](https://github.com/microsoft/durabletask-python/pull/9))
-- Support for Python 3.7+ ([#10](https://github.com/microsoft/durabletask-python/pull/10)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)
+- Support for Python 3.7+ ([#10](https://github.com/microsoft/durabletask-python/pull/10)) -
+  contributed by [@DeepanshuA](https://github.com/DeepanshuA)
 
 ## v0.1.0a1
 

CONTRIBUTING.md

@@ -2,12 +2,14 @@
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+the rights to use your contribution. For details, visit
+[https://cla.opensource.microsoft.com](https://cla.opensource.microsoft.com).
 
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide a
+CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
 provided by the bot. You will only need to do this once across all repos using our CLA.
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+This project has adopted the [Microsoft Open Source Code of
+Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of
+Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact
+[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

README.md

@@ -1,37 +1,47 @@
 # Durable Task SDK for Python
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![Build Validation](https://github.com/microsoft/durabletask-python/actions/workflows/pr-validation.yml/badge.svg)](https://github.com/microsoft/durabletask-python/actions/workflows/pr-validation.yml)
+[![License:
+MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![Build
+Validation](https://github.com/microsoft/durabletask-python/actions/workflows/pr-validation.yml/badge.svg)](https://github.com/microsoft/durabletask-python/actions/workflows/pr-validation.yml)
 [![PyPI version](https://badge.fury.io/py/durabletask.svg)](https://badge.fury.io/py/durabletask)
 
-This repo contains a Python SDK for use with the [Azure Durable Task Scheduler](https://github.com/Azure/Durable-Task-Scheduler). With this SDK, you can define, schedule, and manage durable orchestrations using ordinary Python code.
+This repo contains a Python SDK for use with the [Azure Durable Task
+Scheduler](https://github.com/Azure/Durable-Task-Scheduler). With this SDK, you can define,
+schedule, and manage durable orchestrations using ordinary Python code.
 
-> Note that this SDK is **not** currently compatible with [Azure Durable Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview). If you are looking for a Python SDK for Azure Durable Functions, please see [this repo](https://github.com/Azure/azure-functions-durable-python).
+> Note that this SDK is **not** currently compatible with [Azure Durable
+Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview). If
+you are looking for a Python SDK for Azure Durable Functions, please see [this
+repo](https://github.com/Azure/azure-functions-durable-python).
+
+## References
 
-# References
 - [Supported Patterns](./docs/supported-patterns.md)
 - [Available Features](./docs/features.md)
 - [Getting Started](./docs/getting-started.md)
-- [Development Guide](./docs/development.md) 
+- [Development Guide](./docs/development.md)
 - [Contributing Guide](./CONTRIBUTING.md)
 
 ## Optional Features
 
 ### Large Payload Externalization
 
-Install the `azure-blob-payloads` extra to automatically offload
-oversized orchestration payloads to Azure Blob Storage:
+Install the `azure-blob-payloads` extra to automatically offload oversized orchestration payloads to
+Azure Blob Storage:
 
 ```bash
 pip install durabletask[azure-blob-payloads]
 ```
 
-See the [feature documentation](./docs/features.md#large-payload-externalization)
-and the [example](./examples/large_payload/) for usage details.
+See the [feature documentation](./docs/features.md#large-payload-externalization) and the
+[example](./examples/large_payload/) for usage details.
 
 ## Trademarks
-This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
-trademarks or logos is subject to and must follow 
-[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
-Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
-Any use of third-party trademarks or logos are subject to those third-party's policies.
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of
+Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand
+Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion
+or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those
+third-party's policies.