Compat layer V1

Author: andystaples

azure-functions-durable/CHANGELOG.md

@@ -7,13 +7,58 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Added
+
+- Backwards-compatible, deprecated aliases on `DurableFunctionsClient` for the
+  v1 `DurableOrchestrationClient` method names: `start_new`, `get_status`,
+  `get_status_all`, `get_status_by`, `raise_event`, `terminate`,
+  `purge_instance_history`, `purge_instance_history_by`, `suspend`, `resume`,
+  `restart`, `read_entity_state`, `get_client_response_links`, and
+  `wait_for_completion_or_create_check_status_response`. Each delegates to the
+  corresponding durabletask method and emits a `DeprecationWarning`; new code
+  should use the durabletask names (e.g. `schedule_new_orchestration`,
+  `get_orchestration_state`).
+- `DurableFunctionsClient.signal_entity` now also accepts the v1
+  `operation_input` keyword (alias for `input`); `task_hub_name` and
+  `connection_name` are accepted for compatibility and ignored.
+- `DurableFunctionsClient.rewind` is present as a deprecated stub that raises
+  `NotImplementedError`, pending a durabletask rewind implementation.
+- Deprecated v1 compatibility aliases are now exported from
+  `azure.durable_functions`: `DurableOrchestrationClient` (alias for
+  `DurableFunctionsClient`), `DurableOrchestrationContext`, `DurableEntityContext`,
+  `EntityId`, `ManagedIdentityTokenSource`, `TokenSource`, `Entity`, and
+  `OrchestrationRuntimeStatus`.
+- v1-compatible return-type wrappers `DurableOrchestrationStatus`,
+  `PurgeHistoryResult`, and `EntityStateResponse` (exported from
+  `azure.durable_functions`). The deprecated client methods now return these:
+  `get_status`/`get_status_all`/`get_status_by` return
+  `DurableOrchestrationStatus` (wrapping durabletask `OrchestrationState`, with
+  v1 attributes like `runtime_status`, `output`, `input_`, `custom_status`, and
+  a falsy value for missing instances); `purge_instance_history`/`_by` return
+  `PurgeHistoryResult` (with `instances_deleted`); and `read_entity_state`
+  returns `EntityStateResponse` (with `entity_exists`/`entity_state`).
+- `DurableOrchestrationContext.call_http` is present as a stub that raises
+  `NotImplementedError`, documenting the durable-HTTP gap. `TokenSource` /
+  `ManagedIdentityTokenSource` remain constructible but only apply to
+  `call_http`, which is not yet supported.
+- `RetryOptions`, a deprecated shim that maps the v1 millisecond-based
+  constructor onto durabletask `RetryPolicy` (which uses `timedelta`).
+  `RetryPolicy` is now also exported from `azure.durable_functions`.
+
 ### Changed
 
 - `DurableFunctionsClient` is now an async client. Its orchestration and entity
   management methods (e.g. `schedule_new_orchestration`, `get_orchestration_state`,
   `wait_for_orchestration_completion`) are now coroutines and must be awaited.
   This aligns the client with the async API surface of the V1
   `DurableOrchestrationClient`.
+- `create_http_management_payload` now accepts either the durabletask
+  `(request, instance_id)` signature or the v1 `(instance_id)` signature for
+  backwards compatibility.
+- `HttpManagementPayload` now supports mapping-style access
+  (`payload["statusQueryGetUri"]`, iteration, `in`, `keys()`/`items()`/`values()`)
+  so v1 code that treated the payload as a `dict` keeps working.
+
 
 ## v0.1.0
 

azure-functions-durable/azure/durable_functions/__init__.py

@@ -1,12 +1,49 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 
+# This module intentionally re-exports deprecated v1 compatibility aliases.
+# pyright: reportDeprecated=false
+
+from durabletask.task import RetryPolicy
+
 from .decorators.durable_app import Blueprint, DFApp
 from .client import DurableFunctionsClient
 from .orchestrator import Orchestrator
+from .retry_options import RetryOptions
+from .orchestration_runtime_status import OrchestrationRuntimeStatus
+from .durable_orchestration_status import DurableOrchestrationStatus
+from .purge_history_result import PurgeHistoryResult
+from .entity_state_response import EntityStateResponse
+from .entity_id import EntityId
+from .token_source import ManagedIdentityTokenSource, TokenSource
+from .compat_aliases import (
+    DurableEntityContext,
+    DurableOrchestrationClient,
+    DurableOrchestrationContext,
+    Entity,
+)
 
 # IMPORTANT: DO NOT REMOVE. `azure-functions` relies on the presence and value of this variable
 # for version detection
 version = "2.x"
 
-__all__ = ["Blueprint", "DFApp", "DurableFunctionsClient", "Orchestrator", "version"]
+__all__ = [
+    "Blueprint",
+    "DFApp",
+    "DurableEntityContext",
+    "DurableFunctionsClient",
+    "DurableOrchestrationClient",
+    "DurableOrchestrationContext",
+    "DurableOrchestrationStatus",
+    "Entity",
+    "EntityId",
+    "EntityStateResponse",
+    "ManagedIdentityTokenSource",
+    "Orchestrator",
+    "OrchestrationRuntimeStatus",
+    "PurgeHistoryResult",
+    "RetryOptions",
+    "RetryPolicy",
+    "TokenSource",
+    "version",
+]