Add Functions gRPC core helpers by YunchuWang · Pull Request #282 · microsoft/durabletask-js

YunchuWang · 2026-06-29T22:42:01Z

What

Adds the minimal host-integration surface so Azure Functions can drive a single durable work item per invocation, without running the long-lived gRPC worker loop. This mirrors the Azure Functions consolidation done for Python in durabletask-python PR #155.

API

Two methods on TaskHubGrpcWorker:

processOrchestratorRequest(request: Uint8Array): Promise<Uint8Array>
processEntityBatchRequest(request: Uint8Array): Promise<Uint8Array>

Each deserializes a TaskHubSidecarService protobuf payload, executes one work item, and returns the serialized response. Host integrations own any transport encoding (for example base64); base64 stays out of the core SDK.

Design (aligned with Python #155)

Rather than refactoring the worker, these methods reuse the worker's existing internal execution path (_executeOrchestratorInternal / _executeEntityInternal) and pass an in-process CapturingSidecarStub that records the completion payload instead of sending it over gRPC. This is the same null-stub pattern Python uses (AzureFunctionsNullStub).

Deliberately NOT included (kept minimal)

No base64 protobuf helper module (transport detail belongs in the host).
No object-level execute* public methods (the byte processors are the single entry point).
No V2 EntityRequest host path (not present in Python fix: Reset customStatus on continue-as-new in InMemoryOrchestrationBackend #155; the worker's internal V2 handling for the DTS backend is unchanged).
No new client options; task-hub routing metadata continues to flow through the existing metadataGenerator.

Tests

packages/durabletask-js/test/functions-grpc-support.spec.ts covers both byte processors end to end.

Expose low-level protobuf codecs and single work-item execution helpers for Azure Functions Durable JS gRPC consolidation without adding Functions metadata support. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Expose stable byte-oriented worker processing methods and endpoint/taskHub client options for Azure Functions Durable JS gRPC consolidation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Replace the work-item-executor extraction and base64 protobuf helpers with a minimal, Python-aligned implementation. processOrchestratorRequest and processEntityBatchRequest now reuse the existing worker execution path via an in-process capturing stub (mirroring durabletask-python PR #155's null-stub pattern) instead of refactoring the worker. Removed the base64 helper module, the object-level execute* methods, the V2 EntityRequest host path, and the related exports and tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Adds a minimal “single work-item” execution surface to the Durable Task JS worker so host integrations (e.g., Azure Functions) can execute one orchestrator/entity batch request per invocation without running the long-lived gRPC streaming loop. This aligns with the SDK’s role as a low-level Durable Task Scheduler (sidecar) client/worker implementation.

Changes:

Added byte-level helper methods on TaskHubGrpcWorker to process serialized OrchestratorRequest / EntityBatchRequest payloads and return serialized responses.
Introduced an in-process CapturingSidecarStub that captures completion payloads instead of sending them over gRPC.
Added end-to-end tests and README documentation for the new host-integration surface.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
README.md	Documents the new low-level host integration APIs and clarifies the non–Durable Functions programming model scope.
packages/durabletask-js/test/functions-grpc-support.spec.ts	Adds e2e-style tests covering the new byte processors for orchestrations and entities.
packages/durabletask-js/src/worker/task-hub-grpc-worker.ts	Implements the new public byte-processing methods and the capturing sidecar stub.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…ator Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…t glue Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…ease pipeline - Add DurableOrchestrationContext/DurableEntityContext (context.df.* adapters) + wrapOrchestrator/wrapEntity - Add RetryOptions, callHttp (throws), parentInstanceId; align newGuid/callSubOrchestrator with v3 signatures - Add v3 client query-return types (DurableOrchestrationStatus, OrchestrationRuntimeStatus, EntityStateResponse, PurgeHistoryResult) - Add client getStatus/getStatusAll/getStatusBy/readEntityState/purgeInstanceHistory/startNew/waitForCompletionOrCreateCheckStatusResponse - Add deprecated DurableOrchestrationClient alias - Wire host-provided maxGrpcMessageSizeInBytes into gRPC channel options (Python parity) - Remove dead CapturingSidecarStub.abandonRequest field (keep required no-op method) - Add durable-functions package to build/release pipelines

YunchuWang · 2026-07-07T23:08:29Z

+  "dependencies": {
+    "@azure/functions": "^4.16.1",
+    "@grpc/grpc-js": "^1.14.4",
+    "@microsoft/durabletask-js": "0.3.0"


TODO: remember to bump this to 0.4.0, and we need to release @microsoft/durabletask-js first

also confirm whether @azure/functions 4.16.1 has the extension changes required,

Drop rootDir, outDir, include, and exclude since they are inherited from ./tsconfig.json. Keep only the baseUrl + paths override that points @microsoft/durabletask-js imports at the built dist output. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

…ment call style and update tests

…to DurableFunctionsClient

…m/microsoft/durabletask-js into pr/282/yunchuwang/functions-grpc-support

… Functions - Introduced `EntityId` class for classic v3 entity identifiers. - Enhanced `DurableEntityContext` to include `isNewlyConstructed` and `entityId` properties. - Implemented `signalEntity` method in `DurableEntityContext` for signaling other entities. - Updated `DurableOrchestrationContext` to track and set custom status. - Added unit tests for new features and behaviors.

…ayload in DurableFunctionsClient

Collapse the 4.0.0-alpha.0 changelog to a single bullet and rewrite the README to focus on what the package supports and why it is needed, dropping the implementation-plan / phase-status / open-questions sections. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…onContext type aliases Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

…rator Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

… context.log to classic orchestration context Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

…3-compatible) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

YunchuWang and others added 4 commits June 29, 2026 15:30

Add Functions gRPC core helpers

57b48be

Expose low-level protobuf codecs and single work-item execution helpers for Azure Functions Durable JS gRPC consolidation without adding Functions metadata support. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add raw Functions gRPC worker processors

c272a55

Expose stable byte-oriented worker processing methods and endpoint/taskHub client options for Azure Functions Durable JS gRPC consolidation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Remove extra client task hub shortcut

fb3a55b

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

YunchuWang marked this pull request as ready for review June 30, 2026 22:02

Copilot AI review requested due to automatic review settings June 30, 2026 22:02

Copilot started reviewing on behalf of YunchuWang June 30, 2026 22:03 View session

Copilot AI reviewed Jun 30, 2026

View reviewed changes

Comment thread packages/durabletask-js/src/worker/task-hub-grpc-worker.ts

Comment thread packages/durabletask-js/src/worker/task-hub-grpc-worker.ts

Comment thread packages/durabletask-js/src/worker/task-hub-grpc-worker.ts

YunchuWang and others added 5 commits July 1, 2026 15:34

Add Azure Functions Durable workspace package

f54138d

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Rename Azure Functions Durable package folder

93f5122

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Remove unused requiredQueryStringParameters param from metadata gener…

9ca4fce

…ator Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Add trigger registration with durableRequiresGrpc opt-in and getClien…

ff3ab8f

…t glue Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

YunchuWang commented Jul 7, 2026

View reviewed changes

Comment thread packages/azure-functions-durable/CHANGELOG.md

YunchuWang commented Jul 7, 2026

View reviewed changes

Comment thread packages/azure-functions-durable/README.md

YunchuWang commented Jul 7, 2026

View reviewed changes

YunchuWang and others added 7 commits July 7, 2026 16:25

Enhance createHttpManagementPayload to support classic v3 single-argu…

11a042d

…ment call style and update tests

Add classic (v3) lifecycle aliases and purgeInstanceHistoryBy method …

b98583a

…to DurableFunctionsClient

Merge branch 'yunchuwang/functions-grpc-support' of https://github.co…

4ca9a62

…m/microsoft/durabletask-js into pr/282/yunchuwang/functions-grpc-support

Add deprecated alias getClientResponseLinks for createHttpManagementP…

708a950

…ayload in DurableFunctionsClient

YunchuWang requested review from andystaples, halspang and torosent July 8, 2026 16:54

YunchuWang and others added 4 commits July 8, 2026 15:42

Export v3-compatible ActivityHandler/OrchestrationHandler/Orchestrati…

073bf25

…onContext type aliases Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Fix wrapOrchestrator to drive classic v3 orchestrators via async gene…

cd2b6ff

…rator Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Add EntityContext/EntityHandler/DurableClient aliases and replay-safe…

bfc4e3b

… context.log to classic orchestration context Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Fix purgeInstanceHistoryBy to accept an OrchestrationFilter object (v…

701cd13

…3-compatible) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Functions gRPC core helpers#282

Add Functions gRPC core helpers#282
YunchuWang wants to merge 20 commits into
mainfrom
yunchuwang/functions-grpc-support

YunchuWang commented Jun 29, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

YunchuWang Jul 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

YunchuWang commented Jun 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

API

Design (aligned with Python #155)

Deliberately NOT included (kept minimal)

Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

YunchuWang Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

YunchuWang commented Jun 29, 2026 •

edited

Loading