Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,20 @@ project follows [Semantic Versioning](https://semver.org/).

## [Unreleased]

## [3.22.0] - 2026-11-19

Signal-with-start and durable signal-external need native Server 3.15.0 or
later, the first published Server that advertises `signal_with_start` and
`signal_external_workflow`. The supported Server baseline is unchanged. On an
older Server both refuse before anything is sent.

### Added

- `WorkflowContext::signalExternalWorkflow($workflowId, $signalName, $arguments, runId: null)`
signals another workflow in the namespace from workflow code as a durable
`signal_external_workflow` command (durable-workflow/.github#223, Server
#1134). The runtime records the signal, delivers it and records the outcome,
then gives the sender a new turn. The call returns an `ExternalSignalResult`
#1134; native Server 3.15.0 or later). The runtime records the signal,
delivers it and records the outcome, then gives the sender a new turn. The call returns an `ExternalSignalResult`
whose `ExternalSignalOutcome` is `delivered`, `target_not_found`,
`target_closed` or `rejected`, with the recorded `reason`, target run,
target command and signal IDs. A failed outcome is a returned value, not an
Expand All @@ -31,8 +38,8 @@ project follows [Semantic Versioning](https://semver.org/).
- `Client::signalWithStart()` starts a workflow or reuses its open run and records one
signal on it in a single Server transaction, so the run cannot close between a separate
start and signal (durable-workflow/.github#222, server#1133). It needs a Server that
advertises `signal_with_start` (`ClusterInfo::supportsSignalWithStart()`, native Server)
and throws `ServerCapabilityUnavailable` before sending otherwise. An open run, including
advertises `signal_with_start` (`ClusterInfo::supportsSignalWithStart()`, native Server
3.15.0 or later) and throws `ServerCapabilityUnavailable` before sending otherwise. An open run, including
the newest run after continue-as-new, is reused with its input and deadlines unchanged;
the `fail` duplicate policy refuses it. A closed run is refused with `run_not_active`
unless the closed run policy is `start_new_run`, which starts a fresh run after it. The
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
}
},
"durable-workflow": {
"product-train": "3.21.0",
"product-train": "3.22.0",
"supported-server-versions": "2.5.0",
"supported-server-release-baselines": {
"2": "2.5.0",
Expand Down
2 changes: 1 addition & 1 deletion docs/laravel-adoption-contract.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
},
"service_v2": {
"package": "durable-workflow/sdk",
"channel": "^3.21",
"channel": "^3.22",
"state_owner": "server_or_cloud"
}
},
Expand Down
12 changes: 10 additions & 2 deletions docs/portal/build/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ $client->workflowHandle('order-1001')->signal('approve', ['Ada']);

Signals are appropriate when the caller only needs acknowledgement that the runtime accepted the event.

To start a workflow and signal it atomically, `$client->signalWithStart($type,
$workflowId, $taskQueue, $signalName, $signalArguments, $input)` starts the
workflow or reuses its open run and records the signal in one Server
transaction, so the run cannot close between a separate start and signal. It
needs native Server 3.15.0 or later, which advertises `signal_with_start`; on
an older Server it throws `ServerCapabilityUnavailable` before sending
anything. A refusal throws `SignalWithStartFailed` with the Server's reason.

## Signal another workflow from workflow code

Workflow code signals another workflow in the same namespace with a durable
Expand Down Expand Up @@ -89,8 +97,8 @@ replay with `NonDeterministicWorkflow` reason `external_signal_mismatch`. The
call cannot run inside `all()`, `parallel()` or `select()` groups and is not a
cancellation-scope member.

This needs a runtime that advertises `signal_external_workflow` (native Server
with Server #1134). PHP Server 2.x does not. Without it, the worker abandons the
This needs a runtime that advertises `signal_external_workflow`: native Server
3.15.0 or later. PHP Server 2.x does not. Without it, the worker abandons the
task with `signal_external_workflow_unavailable` before it submits anything, so
nothing is signalled.

Expand Down
6 changes: 3 additions & 3 deletions docs/quickstart-contract.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"schema_version": 2,
"package": {
"name": "durable-workflow/sdk",
"published_version": "3.21.0",
"composer_requirement": "3.21.0",
"onboarding_requirement": "^3.21"
"published_version": "3.22.0",
"composer_requirement": "3.22.0",
"onboarding_requirement": "^3.22"
},
"runtime_targets": {
"server": {
Expand Down
5 changes: 4 additions & 1 deletion docs/sdk-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -741,7 +741,10 @@ returns the recorded result without sending the signal again, and a changed
target, run, name or arguments fails replay with `external_signal_mismatch`.
The worker refuses the command with `signal_external_workflow_unavailable`
before submitting it when the runtime does not advertise
`signal_external_workflow`.
`signal_external_workflow`; native Server 3.15.0 and later advertise it.
`Client::signalWithStart()` likewise needs native Server 3.15.0 or later,
which advertises `signal_with_start`, and throws `ServerCapabilityUnavailable`
before sending anything on an older Server.

The PHP SDK does not expose update-validator authoring. Worker registration
therefore declares an empty `update_validators` list for every workflow type;
Expand Down