Add durable-functions@4.0.0 — Azure Functions Durable provider on the gRPC core (+ core host helpers, E2E CI, and release pipeline) (#282)

Author: YunchuWang

.github/workflows/functions-e2e-tests.yaml

@@ -4,22 +4,31 @@ name: 🧪 Functions Host E2E Tests
 # test/e2e-functions/test-app (backed by Azurite / AzureStorage) and drives the
 # app over HTTP, porting the extension repo's `BasicNode` app + xUnit tests.
 #
-# The test-app depends on the PUBLISHED `durable-functions` + `@azure/functions`
-# packages, so it installs and runs without any in-repo package build. The suite
-# self-gates: each spec SKIPS cleanly when the Azure Functions Core Tools (`func`)
-# or the Azurite storage emulator are unavailable, and RUNS when both are present.
-# In CI below we install and start both, so the suite runs for real; the self-skip
-# is the safety net that keeps the job green if a prerequisite fails to come up.
+# The test-app consumes the IN-REPO `durable-functions` (compat) package and core
+# `@microsoft/durabletask-js` via `file:` links, so those packages must be BUILT
+# before the test-app install (see the build step below). The suite self-gates:
+# each spec SKIPS cleanly when the Azure Functions Core Tools (`func`) or the
+# Azurite storage emulator are unavailable, and RUNS when both are present. In CI
+# below we install and start both, so the suite runs for real; the self-skip is
+# the safety net that keeps the job green if a prerequisite fails to come up.
 #
-# Triggering: this suite is run ad hoc (manual dispatch) for now while it beds in,
-# so it does not gate day-to-day PRs. Start it from the Actions tab via "Run
-# workflow" (workflow_dispatch). To re-enable automatic runs on pull requests
-# later, add a `pull_request` trigger scoped to `test/e2e-functions/**` and this
-# workflow file. NOTE: workflow_dispatch only appears in the Actions UI once this
-# file exists on the repository's default branch.
+# Triggering: this suite runs automatically on pull requests that touch the
+# Functions surface (`test/e2e-functions/**`, `packages/azure-functions-durable/**`,
+# or this workflow file), and can also be started ad hoc from the Actions tab via
+# "Run workflow" (workflow_dispatch). It is intentionally scoped to the Functions
+# surface and does NOT gate core-only PRs, which have their own suites. A small set
+# of terminal/invalid-state control-plane specs are skipped pending a server-side
+# gRPC status-detail fix (tracked separately); everything else runs for real. NOTE:
+# workflow_dispatch only appears in the Actions UI once this file exists on the
+# repository's default branch.
 
 on:
   workflow_dispatch:
+  pull_request:
+    paths:
+      - "test/e2e-functions/**"
+      - "packages/azure-functions-durable/**"
+      - ".github/workflows/functions-e2e-tests.yaml"
 
 permissions:
   contents: read
@@ -43,19 +52,28 @@ jobs:
           node-version: ${{ matrix.node-version }}
           registry-url: "https://registry.npmjs.org"
 
-      # Root install provides jest + ts-jest used to run the spec files. The specs
-      # do not depend on the core durabletask-js packages, so no workspace build is
-      # required here.
+      # Root install provides jest + ts-jest used to run the spec files, and lets
+      # the workspace build below resolve the in-repo packages the test-app links
+      # via `file:` refs.
       - name: ⚙️ Install dependencies
         run: npm ci
 
+      # Build the in-repo compat package (`durable-functions`); its build script
+      # runs `build:core` first, so this also builds `packages/durabletask-js` into
+      # dist/. Both must exist before the test-app's `file:`-linked install below.
+      - name: "🏗️ Build in-repo durable-functions (+ core) for file: linking"
+        run: npm run build -w durable-functions
+
       - name: 🔧 Install Azurite and Azure Functions Core Tools
         run: npm install -g azurite azure-functions-core-tools@4
 
+      # --skipApiVersionCheck: the preview extension bundle's Azure Storage SDK
+      # targets a newer REST API version than current Azurite accepts; without the
+      # flag Azurite rejects the calls and every orchestration times out.
       - name: 🗄️ Start Azurite
         run: |
           mkdir -p /tmp/azurite
-          azurite --silent --location /tmp/azurite \
+          azurite --silent --skipApiVersionCheck --location /tmp/azurite \
             --blobPort 10000 --queuePort 10001 --tablePort 10002 &
           echo "Waiting for Azurite blob endpoint..."
           for i in $(seq 1 30); do
@@ -66,8 +84,9 @@ jobs:
             sleep 1
           done
 
-      # Installs the PUBLISHED durable-functions / @azure/functions packages and
-      # compiles the ported BasicNode app to dist/ (consumed by `func start`).
+      # Installs the in-repo `durable-functions` (+ core `@microsoft/durabletask-js`)
+      # packages via the test-app's `file:` refs and compiles the ported BasicNode
+      # app to dist/ (consumed by `func start`).
       - name: 📦 Install + build test-app
         working-directory: test/e2e-functions/test-app
         run: |

README.md

@@ -5,7 +5,23 @@
 
 This repo contains a JavaScript/TypeScript 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 TypeScript/JavaScript 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 JavaScript SDK for Azure Durable Functions, please see [this repo](https://github.com/Azure/azure-functions-durable-js).
+> Note that the core `@microsoft/durabletask-js` package does **not** provide the [Azure Durable Functions](https://learn.microsoft.com/azure/azure-functions/durable/durable-functions-overview) programming model, decorators, or worker-indexing metadata — it exposes low-level TaskHubSidecarService gRPC/protobuf helpers that host integrations can reuse (Node.js 22+). For the Azure Durable Functions programming model on the gRPC core, this repository also contains the **`durable-functions`** provider package under [`packages/azure-functions-durable`](./packages/azure-functions-durable). The classic v3 (extension-HTTP) predecessor lives at [azure-functions-durable-js](https://github.com/Azure/azure-functions-durable-js).
+
+## Low-level host integration APIs
+
+Host integrations that already own trigger metadata and transport encoding can depend on the `@microsoft/durabletask-js` package directly. `TaskHubGrpcWorker` registers orchestrators, activities, and entities, and can process raw TaskHubSidecarService protobuf payloads without starting the long-running gRPC worker loop:
+
+```typescript
+const worker = new TaskHubGrpcWorker();
+worker.addOrchestrator(myOrchestrator);
+worker.addActivity(myActivity);
+worker.addEntity(myEntity);
+
+const orchestrationResponseBytes = await worker.processOrchestratorRequest(orchestrationRequestBytes);
+const entityResponseBytes = await worker.processEntityBatchRequest(entityBatchRequestBytes);
+```
+
+`TaskHubGrpcClient` already exposes orchestration start/query/event/terminate/suspend/resume/purge APIs and entity signal/read/query/clean APIs through its existing `hostAddress` and `metadataGenerator` options. Host integrations that need task-hub routing metadata should provide it through `metadataGenerator`, keeping host-specific metadata policy outside the core client. Azure-managed scheduler connection strings remain in `@microsoft/durabletask-js-azuremanaged`.
 
 ## npm packages
 

eng/ci/release.yml

@@ -84,3 +84,34 @@ extends:
             serviceendpointurl: 'https://api.esrp.microsoft.com'
             mainpublisher: 'durabletask-java'
             domaintenantid: '33e01921-4d64-4f8c-a055-5bdaffd5e33d'
+
+      - job: durable_functions
+        displayName: 'Release durable-functions'
+        templateContext:
+          type: releaseJob
+          isProduction: true
+          inputs:
+          - input: pipelineArtifact
+            pipeline: DurableTaskJSBuildPipeline
+            artifactName: drop
+            targetPath: $(System.DefaultWorkingDirectory)/drop
+
+        steps:
+        - task: SFP.release-tasks.custom-build-release-task.EsrpRelease@9
+          displayName: 'ESRP Release durable-functions'
+          inputs:
+            connectedservicename: 'dtfx-internal-esrp-prod'
+            usemanagedidentity: true
+            keyvaultname: 'durable-esrp-akv'
+            signcertname: 'dts-esrp-cert'
+            clientid: '0b3ed1a4-0727-4a50-b82a-02c2bd9dec89'
+            intent: 'PackageDistribution'
+            contenttype: 'npm'
+            contentsource: 'Folder'
+            folderlocation: '$(System.DefaultWorkingDirectory)/drop/buildoutputs/azure-functions-durable'
+            waitforreleasecompletion: true
+            owners: 'wangbill@microsoft.com'
+            approvers: 'kaibocai@microsoft.com'
+            serviceendpointurl: 'https://api.esrp.microsoft.com'
+            mainpublisher: 'durabletask-java'
+            domaintenantid: '33e01921-4d64-4f8c-a055-5bdaffd5e33d'

eng/templates/build.yml

@@ -44,6 +44,12 @@ jobs:
               npm pack
             displayName: "pack @microsoft/durabletask-js-azuremanaged"
           
+          # Pack durable-functions
+          - script: |
+              cd packages/azure-functions-durable
+              npm pack
+            displayName: "pack durable-functions"
+          
           # Copy each package to its own staging subfolder
           - task: CopyFiles@2
             displayName: "Copy durabletask-js to staging"
@@ -56,4 +62,10 @@ jobs:
             inputs:
                 SourceFolder: $(System.DefaultWorkingDirectory)/packages/durabletask-js-azuremanaged
                 Contents: "*.tgz"
-                TargetFolder: $(Build.ArtifactStagingDirectory)/buildoutputs/durabletask-js-azuremanaged
+                TargetFolder: $(Build.ArtifactStagingDirectory)/buildoutputs/durabletask-js-azuremanaged
+          - task: CopyFiles@2
+            displayName: "Copy azure-functions-durable to staging"
+            inputs:
+                SourceFolder: $(System.DefaultWorkingDirectory)/packages/azure-functions-durable
+                Contents: "*.tgz"
+                TargetFolder: $(Build.ArtifactStagingDirectory)/buildoutputs/azure-functions-durable

package-lock.json

@@ -0,0 +1,5 @@
+# Changelog
+
+## TBD
+
+- Details to be finalized at release time.

packages/azure-functions-durable/CHANGELOG.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Microsoft Corporation.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.