Add Azure Managed on-demand sandbox preview APIs (#151)

Author: YunchuWang

CHANGELOG.md

@@ -9,6 +9,12 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ADDED
 
+- Added overridable activity-dispatch hooks `_on_activity_execution_started`
+  and `_on_activity_execution_completed` on `TaskHubGrpcWorker`, invoked
+  immediately before each activity runs and in a `finally` after it completes
+  or fails. Subclasses can override these to observe in-flight activity
+  execution (for example, to track the number of activities currently
+  running).
 - Added `durabletask.extensions.history_export` for exporting the event history of
   terminal orchestrations to an external destination. Includes
   `ExportHistoryClient`, a per-job `ExportHistoryJobClient` returned by

Makefile

@@ -9,8 +9,12 @@ install:
 
 gen-proto:
 	curl -o durabletask/internal/orchestrator_service.proto https://raw.githubusercontent.com/microsoft/durabletask-protobuf/refs/heads/main/protos/orchestrator_service.proto
-	curl -H "Accept: application/vnd.github.v3+json" "https://api.github.com/repos/microsoft/durabletask-protobuf/commits?path=protos/orchestrator_service.proto&sha=main&per_page=1" | jq -r '.[0].sha' >> durabletask/internal/PROTO_SOURCE_COMMIT_HASH
+	curl -H "Accept: application/vnd.github.v3+json" "https://api.github.com/repos/microsoft/durabletask-protobuf/commits?path=protos/orchestrator_service.proto&sha=main&per_page=1" | jq -r '.[0].sha' > durabletask/internal/PROTO_SOURCE_COMMIT_HASH
 	python3 -m grpc_tools.protoc --proto_path=.  --python_out=. --pyi_out=. --grpc_python_out=. ./durabletask/internal/orchestrator_service.proto
 	rm durabletask/internal/*.proto
+	SANDBOX_PROTO_SOURCE_COMMIT_HASH=$$(cat durabletask-azuremanaged/durabletask/azuremanaged/internal/SANDBOX_PROTO_SOURCE_COMMIT_HASH); \
+	curl -o durabletask-azuremanaged/durabletask/azuremanaged/internal/sandbox_service.proto https://raw.githubusercontent.com/microsoft/durabletask-protobuf/$${SANDBOX_PROTO_SOURCE_COMMIT_HASH}/protos/durable-task-scheduler/sandbox_service.proto
+	python3 -m grpc_tools.protoc --proto_path=durabletask-azuremanaged --python_out=durabletask-azuremanaged --pyi_out=durabletask-azuremanaged --grpc_python_out=durabletask-azuremanaged ./durabletask-azuremanaged/durabletask/azuremanaged/internal/sandbox_service.proto
+	rm durabletask-azuremanaged/durabletask/azuremanaged/internal/*.proto
 
 .PHONY: init test gen-proto install

durabletask-azuremanaged/CHANGELOG.md

@@ -5,6 +5,16 @@ 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).
 
+## Unreleased
+
+- Updates base dependency to durabletask v1.6.0.
+- Added preview support for Durable Task Scheduler on-demand sandbox
+  activities under `durabletask.azuremanaged.preview.sandboxes`. Applications
+  can declare sandbox activities (with optional per-activity versions),
+  register sandbox worker profiles, and run a sandbox activity worker that
+  establishes a live worker session and dispatches only the activities it
+  has registered.
+
 ## v1.5.0
 
 - Updates base dependency to durabletask v1.5.0

durabletask-azuremanaged/durabletask/azuremanaged/internal/SANDBOX_PROTO_SOURCE_COMMIT_HASH

@@ -0,0 +1 @@
+67a2f1d3b9ea8a210eb86addb636a5d8a6484dbc

durabletask-azuremanaged/durabletask/azuremanaged/internal/sandbox_service_pb2.py

@@ -0,0 +1,119 @@
+from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class SandboxProviderKind(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    SANDBOX_PROVIDER_KIND_UNSPECIFIED: _ClassVar[SandboxProviderKind]
+    SANDBOX_PROVIDER_KIND_ACA_SESSION_POOL: _ClassVar[SandboxProviderKind]
+    SANDBOX_PROVIDER_KIND_SANDBOX: _ClassVar[SandboxProviderKind]
+SANDBOX_PROVIDER_KIND_UNSPECIFIED: SandboxProviderKind
+SANDBOX_PROVIDER_KIND_ACA_SESSION_POOL: SandboxProviderKind
+SANDBOX_PROVIDER_KIND_SANDBOX: SandboxProviderKind
+
+class SandboxActivityWorkerMessage(_message.Message):
+    __slots__ = ("start", "heartbeat")
+    START_FIELD_NUMBER: _ClassVar[int]
+    HEARTBEAT_FIELD_NUMBER: _ClassVar[int]
+    start: SandboxActivityWorkerStart
+    heartbeat: SandboxActivityWorkerHeartbeat
+    def __init__(self, start: _Optional[_Union[SandboxActivityWorkerStart, _Mapping]] = ..., heartbeat: _Optional[_Union[SandboxActivityWorkerHeartbeat, _Mapping]] = ...) -> None: ...
+
+class SandboxActivityWorkerStart(_message.Message):
+    __slots__ = ("task_hub", "max_activities_count", "sandbox_provider", "dts_sandbox_identifier", "worker_profile_id", "activities")
+    TASK_HUB_FIELD_NUMBER: _ClassVar[int]
+    MAX_ACTIVITIES_COUNT_FIELD_NUMBER: _ClassVar[int]
+    SANDBOX_PROVIDER_FIELD_NUMBER: _ClassVar[int]
+    DTS_SANDBOX_IDENTIFIER_FIELD_NUMBER: _ClassVar[int]
+    WORKER_PROFILE_ID_FIELD_NUMBER: _ClassVar[int]
+    ACTIVITIES_FIELD_NUMBER: _ClassVar[int]
+    task_hub: str
+    max_activities_count: int
+    sandbox_provider: SandboxProviderKind
+    dts_sandbox_identifier: str
+    worker_profile_id: str
+    activities: _containers.RepeatedCompositeFieldContainer[SandboxActivity]
+    def __init__(self, task_hub: _Optional[str] = ..., max_activities_count: _Optional[int] = ..., sandbox_provider: _Optional[_Union[SandboxProviderKind, str]] = ..., dts_sandbox_identifier: _Optional[str] = ..., worker_profile_id: _Optional[str] = ..., activities: _Optional[_Iterable[_Union[SandboxActivity, _Mapping]]] = ...) -> None: ...
+
+class SandboxActivityWorkerHeartbeat(_message.Message):
+    __slots__ = ("active_activities_count",)
+    ACTIVE_ACTIVITIES_COUNT_FIELD_NUMBER: _ClassVar[int]
+    active_activities_count: int
+    def __init__(self, active_activities_count: _Optional[int] = ...) -> None: ...
+
+class SandboxActivityWorkerSessionResult(_message.Message):
+    __slots__ = ("message",)
+    MESSAGE_FIELD_NUMBER: _ClassVar[int]
+    message: str
+    def __init__(self, message: _Optional[str] = ...) -> None: ...
+
+class SandboxWorkerProfile(_message.Message):
+    __slots__ = ("worker_profile_id", "activities", "image", "environment_variables", "max_concurrent_activities", "resources", "scheduler_managed_identity_client_id")
+    class EnvironmentVariablesEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: str
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[str] = ...) -> None: ...
+    WORKER_PROFILE_ID_FIELD_NUMBER: _ClassVar[int]
+    ACTIVITIES_FIELD_NUMBER: _ClassVar[int]
+    IMAGE_FIELD_NUMBER: _ClassVar[int]
+    ENVIRONMENT_VARIABLES_FIELD_NUMBER: _ClassVar[int]
+    MAX_CONCURRENT_ACTIVITIES_FIELD_NUMBER: _ClassVar[int]
+    RESOURCES_FIELD_NUMBER: _ClassVar[int]
+    SCHEDULER_MANAGED_IDENTITY_CLIENT_ID_FIELD_NUMBER: _ClassVar[int]
+    worker_profile_id: str
+    activities: _containers.RepeatedCompositeFieldContainer[SandboxActivity]
+    image: SandboxActivityImage
+    environment_variables: _containers.ScalarMap[str, str]
+    max_concurrent_activities: int
+    resources: SandboxActivityResources
+    scheduler_managed_identity_client_id: str
+    def __init__(self, worker_profile_id: _Optional[str] = ..., activities: _Optional[_Iterable[_Union[SandboxActivity, _Mapping]]] = ..., image: _Optional[_Union[SandboxActivityImage, _Mapping]] = ..., environment_variables: _Optional[_Mapping[str, str]] = ..., max_concurrent_activities: _Optional[int] = ..., resources: _Optional[_Union[SandboxActivityResources, _Mapping]] = ..., scheduler_managed_identity_client_id: _Optional[str] = ...) -> None: ...
+
+class SandboxActivity(_message.Message):
+    __slots__ = ("name", "version")
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    VERSION_FIELD_NUMBER: _ClassVar[int]
+    name: str
+    version: str
+    def __init__(self, name: _Optional[str] = ..., version: _Optional[str] = ...) -> None: ...
+
+class SandboxActivityImage(_message.Message):
+    __slots__ = ("image_ref", "managed_identity_client_id", "entrypoint", "cmd")
+    IMAGE_REF_FIELD_NUMBER: _ClassVar[int]
+    MANAGED_IDENTITY_CLIENT_ID_FIELD_NUMBER: _ClassVar[int]
+    ENTRYPOINT_FIELD_NUMBER: _ClassVar[int]
+    CMD_FIELD_NUMBER: _ClassVar[int]
+    image_ref: str
+    managed_identity_client_id: str
+    entrypoint: _containers.RepeatedScalarFieldContainer[str]
+    cmd: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, image_ref: _Optional[str] = ..., managed_identity_client_id: _Optional[str] = ..., entrypoint: _Optional[_Iterable[str]] = ..., cmd: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class SandboxActivityResources(_message.Message):
+    __slots__ = ("cpu", "memory")
+    CPU_FIELD_NUMBER: _ClassVar[int]
+    MEMORY_FIELD_NUMBER: _ClassVar[int]
+    cpu: str
+    memory: str
+    def __init__(self, cpu: _Optional[str] = ..., memory: _Optional[str] = ...) -> None: ...
+
+class DeclareSandboxWorkerProfileResult(_message.Message):
+    __slots__ = ()
+    def __init__(self) -> None: ...
+
+class RemoveSandboxWorkerProfileRequest(_message.Message):
+    __slots__ = ("worker_profile_id",)
+    WORKER_PROFILE_ID_FIELD_NUMBER: _ClassVar[int]
+    worker_profile_id: str
+    def __init__(self, worker_profile_id: _Optional[str] = ...) -> None: ...
+
+class RemoveSandboxWorkerProfileResult(_message.Message):
+    __slots__ = ()
+    def __init__(self) -> None: ...