Address PR #282 review: arity fix, parseJson, exports, docs, node bump

Resolves andystaples' review comments plus a ListAll E2E bug on
packages/azure-functions-durable:

- #1 orchestrator arity: detect generator kind (sync=classic v3, async=core
  native) instead of an arity heuristic; driver now handles sync+async
  generators so single-param native orchestrators actually execute.
- #2 parseJson tolerates non-JSON serializedOutput (fixes getStatusAll 400).
- #3 createCheckStatusResponse accepts undefined request (baseUrl fallback).
- #4 createTimer returns TimerTask (cancelable) in its type signature.
- #5 re-export TaskFailedError from core + compat; document removed v3-only
  exports in CHANGELOG/README.
- #6/#7 document getStatus + classic-context breaking changes.
- #8 bump @types/node to ^22 to match engines.node>=22.
- #9 set version 0.4.0 + document release order.
- #10 distinct abandon error for the single work-item execution path.
- #11 revert proto codegen churn to origin/main.

Adds regression tests for items #1/#2/#3/#5/#10.

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

Author: YunchuWang

package-lock.json

@@ -1,5 +1,31 @@
 # Changelog
 
-## 4.0.0-alpha.0
+## 0.4.0
 
-- Added the initial gRPC-consolidated Azure Functions Durable provider package.
+Initial gRPC-consolidated Azure Functions Durable provider, built on `@microsoft/durabletask-js`.
+
+### Requirements
+
+- Node.js >= 22 (drops the Node 18/20 that `durable-functions` v3 supported).
+
+### Breaking changes vs `durable-functions` v3
+
+- Classic orchestration and entity contexts no longer extend `InvocationContext`; they expose only
+  `df` plus replay-safe log helpers (no `invocationId` / `functionName` / `extraInputs`).
+- Task result shape follows the core SDK: use `isComplete` / `isFailed` / `getResult()` (v3 used
+  `isCompleted` / `isFaulted` / `result`). `context.df.createTimer(...)` returns a cancelable
+  `TimerTask`, so the timeout-race pattern (`Task.any` then `timer.cancel()`) keeps working.
+- `client.getStatus()` returns `DurableOrchestrationStatus | undefined` (was non-optional) and honors
+  only `showInput`; `showHistory` / `showHistoryOutput` are ignored and `history` is not populated.
+- `client.startNew()` drops the v3 `version` option.
+- Removed top-level exports: `DummyOrchestrationContext`, `DummyEntityContext`, `DurableError`,
+  `AggregatedError`, `ManagedIdentityTokenSource`, `TokenSource`. `TaskFailedError` is re-exported
+  from the core SDK and aggregate failures surface as JS-native `AggregateError`. For orchestration
+  unit tests, use the core `TestOrchestrationWorker` / `TestOrchestrationClient` in place of the v3
+  dummy contexts.
+
+### Release order
+
+- Publish `@microsoft/durabletask-js` (0.3.0) before this package.
+- Confirm the target `@azure/functions` (^4.16.1) build includes the Durable extension changes
+  (`DurableRequiresGrpc`) required by the consolidated gRPC path.

packages/azure-functions-durable/CHANGELOG.md

@@ -6,7 +6,7 @@ Write [Azure Durable Functions](https://learn.microsoft.com/azure/azure-function
 
 `durable-functions` is the Azure Functions Durable provider for JavaScript, built on `@microsoft/durabletask-js`. You author Durable Functions apps with the familiar `app.orchestration` / `app.activity` / `app.entity` model, and the provider talks to the Durable Task backend over the Functions host's gRPC channel.
 
-This is a new major version that supersedes the legacy [`durable-functions`](https://github.com/Azure/azure-functions-durable-js) package. New and existing (classic v3) orchestration, activity, and entity code all run on the same gRPC engine.
+This package supersedes the legacy [`durable-functions`](https://github.com/Azure/azure-functions-durable-js) package. New and existing (classic v3) orchestration, activity, and entity code all run on the same gRPC engine.
 
 ## Why it is needed
 
@@ -20,6 +20,24 @@ This is a new major version that supersedes the legacy [`durable-functions`](htt
 - **Client** — `getClient(context)` returns a `DurableFunctionsClient` for scheduling, querying, signaling, and managing instances, plus HTTP management-payload helpers (`createCheckStatusResponse`, `createHttpManagementPayload`) for durable HTTP starters.
 - **Classic (v3) compatibility** — orchestrators and entities written in the legacy `context.df.*` style, `RetryOptions`, `EntityId`, and the deprecated client aliases are adapted onto the core engine.
 
+## Migrating from durable-functions v3
+
+This provider keeps classic `context.df.*` orchestrators and entities working, but a few surfaces
+changed. See [`CHANGELOG.md`](./CHANGELOG.md) for the full list; the highlights:
+
+- **Node.js >= 22** is required (v3 supported Node 18/20).
+- **Classic contexts no longer extend `InvocationContext`** — only `df` plus replay-safe log helpers
+  are available (no `invocationId` / `functionName` / `extraInputs`).
+- **Task result shape follows the core SDK** — use `isComplete` / `isFailed` / `getResult()` instead
+  of v3's `isCompleted` / `isFaulted` / `result`. `context.df.createTimer(...)` still returns a
+  cancelable `TimerTask` for the timeout-race pattern.
+- **`client.getStatus()` may return `undefined`** and honors only `showInput` (`showHistory` /
+  `showHistoryOutput` are ignored); **`client.startNew()` drops the `version` option**.
+- **Some v3 top-level exports were removed** — `DummyOrchestrationContext` / `DummyEntityContext`,
+  `DurableError` / `AggregatedError`, and `ManagedIdentityTokenSource` / `TokenSource`.
+  `TaskFailedError` is re-exported from the core SDK; use the core `TestOrchestrationWorker` /
+  `TestOrchestrationClient` for orchestration unit tests.
+
 ## Getting started
 
 ```typescript
@@ -47,4 +65,4 @@ app.http("startHello", {
 
 ## Status
 
-This package is an early preview (`4.0.0-alpha.0`); APIs may change before the stable release.
+This package is an early preview (`0.4.0`); APIs may change before the stable release.

packages/azure-functions-durable/README.md

@@ -1,6 +1,6 @@
 {
   "name": "durable-functions",
-  "version": "4.0.0-alpha.0",
+  "version": "0.4.0",
   "description": "Azure Functions Durable provider for the Durable Task JavaScript SDK",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -55,7 +55,7 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.1",
-    "@types/node": "^18.16.1",
+    "@types/node": "^22.0.0",
     "jest": "^29.5.0",
     "ts-jest": "^29.1.0",
     "typescript": "^5.0.4"

packages/azure-functions-durable/package.json

@@ -9,10 +9,7 @@ import {
   PurgeInstanceCriteria,
   TaskHubGrpcClient,
 } from "@microsoft/durabletask-js";
-import {
-  HttpManagementPayload,
-  createHttpManagementPayload as createPayload,
-} from "./http-management-payload";
+import { HttpManagementPayload, createHttpManagementPayload as createPayload } from "./http-management-payload";
 import { EntityStateResponse } from "./entity-state-response";
 import { createAzureFunctionsMetadataGenerator } from "./metadata";
 import {
@@ -84,8 +81,19 @@ export class DurableFunctionsClient extends TaskHubGrpcClient {
     this.grpcHttpClientTimeout = config.grpcHttpClientTimeout;
   }
 
-  createCheckStatusResponse(request: HttpRequest, instanceId: string): HttpResponse {
-    const payload = this.createHttpManagementPayload(request, instanceId);
+  /**
+   * Builds a 202 HTTP response whose body and `Location` header expose the orchestration's
+   * management URLs (classic Durable Functions v3 `createCheckStatusResponse`).
+   *
+   * @param request - The incoming HTTP request, or `undefined` to build the URLs from the client
+   *   binding's `baseUrl` (v3 accepted an undefined request and fell back to the binding).
+   * @param instanceId - The orchestration instance to build management URLs for.
+   */
+  createCheckStatusResponse(request: HttpRequest | undefined, instanceId: string): HttpResponse {
+    const payload =
+      request === undefined
+        ? this.createHttpManagementPayload(instanceId)
+        : this.createHttpManagementPayload(request, instanceId);
 
     return new HttpResponse({
       status: 202,
@@ -109,10 +117,7 @@ export class DurableFunctionsClient extends TaskHubGrpcClient {
    */
   createHttpManagementPayload(instanceId: string): HttpManagementPayload;
   createHttpManagementPayload(request: HttpRequest, instanceId: string): HttpManagementPayload;
-  createHttpManagementPayload(
-    requestOrInstanceId: HttpRequest | string,
-    instanceId?: string,
-  ): HttpManagementPayload {
+  createHttpManagementPayload(requestOrInstanceId: HttpRequest | string, instanceId?: string): HttpManagementPayload {
     // Classic Durable Functions (v3) accepted a single positional `instanceId`. Detect that call
     // style (a lone string argument) and fall back to the client binding's `baseUrl` when building
     // the payload URLs.
@@ -137,10 +142,7 @@ export class DurableFunctionsClient extends TaskHubGrpcClient {
    *   binding's `baseUrl`.
    * @param instanceId - The orchestration instance to build management URLs for.
    */
-  getClientResponseLinks(
-    request: HttpRequest | undefined,
-    instanceId: string,
-  ): HttpManagementPayload {
+  getClientResponseLinks(request: HttpRequest | undefined, instanceId: string): HttpManagementPayload {
     return request === undefined
       ? this.createHttpManagementPayload(instanceId)
       : this.createHttpManagementPayload(request, instanceId);
@@ -153,11 +155,11 @@ export class DurableFunctionsClient extends TaskHubGrpcClient {
    * @param orchestratorName - The name of the orchestrator to start.
    * @param options - Optional input and instance ID.
    * @returns The instance ID of the started orchestration.
+   *
+   * @remarks
+   * Breaking change from v3: the v3 `version` option is not supported and is silently dropped.
    */
-  async startNew(
-    orchestratorName: string,
-    options?: { input?: unknown; instanceId?: string },
-  ): Promise<string> {
+  async startNew(orchestratorName: string, options?: { input?: unknown; instanceId?: string }): Promise<string> {
     return this.scheduleNewOrchestration(
       orchestratorName,
       options?.input,
@@ -172,6 +174,13 @@ export class DurableFunctionsClient extends TaskHubGrpcClient {
    * @param instanceId - The ID of the orchestration instance to query.
    * @param options - When `showInput` is `false`, input/output payloads are not fetched.
    * @returns The instance status, or `undefined` if the instance does not exist.
+   *
+   * @remarks
+   * Breaking changes from v3:
+   * - The return type is `DurableOrchestrationStatus | undefined` (v3 returned a non-optional value),
+   *   so `(await getStatus(id)).runtimeStatus` must guard against `undefined`.
+   * - Only `showInput` is honored. The v3 `showHistory` / `showHistoryOutput` options are not
+   *   supported and `history` is never populated.
    */
   async getStatus(
     instanceId: string,
@@ -221,10 +230,7 @@ export class DurableFunctionsClient extends TaskHubGrpcClient {
     instanceId: string,
     waitOptions?: { timeoutInMilliseconds?: number },
   ): Promise<HttpResponse> {
-    const timeoutSeconds = Math.max(
-      1,
-      Math.ceil((waitOptions?.timeoutInMilliseconds ?? 10000) / 1000),
-    );
+    const timeoutSeconds = Math.max(1, Math.ceil((waitOptions?.timeoutInMilliseconds ?? 10000) / 1000));
     try {
       const state = await this.waitForOrchestrationCompletion(instanceId, true, timeoutSeconds);
       if (state) {
@@ -261,10 +267,7 @@ export class DurableFunctionsClient extends TaskHubGrpcClient {
    * @param entityId - The target entity instance ID.
    * @param includeState - Whether to include the entity state in the response (default `true`).
    */
-  async readEntityState<T = unknown>(
-    entityId: EntityInstanceId,
-    includeState = true,
-  ): Promise<EntityStateResponse<T>> {
+  async readEntityState<T = unknown>(entityId: EntityInstanceId, includeState = true): Promise<EntityStateResponse<T>> {
     const metadata = await this.getEntity<T>(entityId, includeState);
     if (!metadata) {
       return new EntityStateResponse<T>(false);
@@ -399,11 +402,7 @@ export function getGrpcHostAddress(rpcBaseUrl: string): string {
   }
 }
 
-function getInstanceStatusUrl(
-  request: HttpRequest | undefined,
-  instanceId: string,
-  baseUrl: string,
-): string {
+function getInstanceStatusUrl(request: HttpRequest | undefined, instanceId: string, baseUrl: string): string {
   const encodedInstanceId = encodeURIComponent(instanceId);
   if (request !== undefined) {
     const requestUrl = new URL(request.url);
@@ -473,10 +472,7 @@ function optionalNumber(record: Record<string, unknown>, name: string): number |
   return value;
 }
 
-function optionalStringRecord(
-  record: Record<string, unknown>,
-  name: string,
-): Record<string, string> | undefined {
+function optionalStringRecord(record: Record<string, unknown>, name: string): Record<string, string> | undefined {
   const value = record[name];
   if (value === undefined || value === null) {
     return undefined;
@@ -486,9 +482,7 @@ function optionalStringRecord(
   const result: Record<string, string> = {};
   for (const [key, entry] of Object.entries(valueRecord)) {
     if (typeof entry !== "string") {
-      throw new TypeError(
-        `Durable Functions client configuration field ${name}.${key} must be a string.`,
-      );
+      throw new TypeError(`Durable Functions client configuration field ${name}.${key} must be a string.`);
     }
     result[key] = entry;
   }

packages/azure-functions-durable/src/client.ts

@@ -1,12 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
-import {
-  EntityFactory,
-  EntityInstanceId,
-  ITaskEntity,
-  TaskEntityOperation,
-} from "@microsoft/durabletask-js";
+import { EntityFactory, EntityInstanceId, ITaskEntity, TaskEntityOperation } from "@microsoft/durabletask-js";
 
 /**
  * Classic Durable Functions (v3) entity context, exposed to migrating entity functions as
@@ -94,11 +89,7 @@ export class DurableEntityContext {
    * @param operationName - The name of the operation to invoke.
    * @param operationInput - Optional input for the operation.
    */
-  signalEntity(
-    entityId: EntityInstanceId,
-    operationName: string,
-    operationInput?: unknown,
-  ): void {
+  signalEntity(entityId: EntityInstanceId, operationName: string, operationInput?: unknown): void {
     this._operation.context.signalEntity(entityId, operationName, operationInput);
   }
 
@@ -108,7 +99,13 @@ export class DurableEntityContext {
   }
 }
 
-/** The object passed to a classic (v3) entity function; its `df` is the durable entity context. */
+/**
+ * The object passed to a classic (v3) entity function; its `df` is the durable entity context.
+ *
+ * @remarks
+ * Breaking change from `durable-functions` v3, where the entity context extended `InvocationContext`.
+ * This context exposes only `df`; entity code that read `InvocationContext` members must be updated.
+ */
 export interface ClassicEntityContext {
   df: DurableEntityContext;
 }

packages/azure-functions-durable/src/entity-context.ts

@@ -21,18 +21,18 @@ export { createAzureFunctionsMetadataGenerator } from "./metadata";
 export { DurableFunctionsWorker } from "./worker";
 export { DurableBindingMetadata, addDurableGrpcMetadata } from "./durable-grpc";
 export { RetryOptions } from "./retry-options";
+// Re-exported core error so callers can `instanceof`-guard caught orchestration failures, matching
+// the classic durable-functions v3 top-level `TaskFailedError` export. Note: v3's `DurableError` /
+// `AggregatedError` are intentionally not provided — the core engine surfaces `TaskFailedError` and
+// JS-native `AggregateError`. See the package README/CHANGELOG migration notes.
+export { TaskFailedError } from "@microsoft/durabletask-js";
 export {
   DurableOrchestrationContext,
   ClassicOrchestrationContext,
   ClassicOrchestrator,
   wrapOrchestrator,
 } from "./orchestration-context";
-export {
-  DurableEntityContext,
-  ClassicEntityContext,
-  ClassicEntity,
-  wrapEntity,
-} from "./entity-context";
+export { DurableEntityContext, ClassicEntityContext, ClassicEntity, wrapEntity } from "./entity-context";
 export {
   DurableOrchestrationStatus,
   DurableOrchestrationStatusInit,