Skip to content

Commit 3d7bc3f

Browse files
github-actions[bot]github-actions[bot]
committed
deploy: 17d519e 
1 parent 4f692d1 commit 3d7bc3f

168 files changed

Lines changed: 329 additions & 537 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎2.0/llms-full.txt‎

Lines changed: 0 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1189,110 +1189,6 @@ $runId = $workflow->runId();
11891189

11901190
Use the instance id when you want the stable public handle for the workflow. Use the run id when you need to inspect one concrete execution.
11911191

1192-
`WorkflowStub::load($instanceId)` is instance-centric. When you want to pin one concrete execution explicitly, you can either load it by run id or by the instance-plus-selected-run pair:
1193-
1194-
```php
1195-
use Workflow\V2\WorkflowStub;
1196-
1197-
$current = WorkflowStub::loadSelection($instanceId);
1198-
$current->runId(); // Current selected run for the instance
1199-
1200-
$selectedRun = WorkflowStub::loadSelection($instanceId, $runId);
1201-
$selectedRun->runId(); // Selected run id
1202-
$selectedRun->currentRunId(); // Current run id for the instance
1203-
$selectedRun->currentRunIsSelected(); // true when the selected run is still current
1204-
1205-
$sameSelectedRun = WorkflowStub::loadRun($runId);
1206-
```
1207-
1208-
That instance-scoped selector is useful when another system already stored the public instance id and later wants to pin a historical run without changing the outer workflow address.
1209-
1210-
All three loaders accept an optional `namespace` parameter. When provided, loading is scoped to the given namespace at the query level — a workflow belonging to a different namespace will not be found. See [Namespace](../configuration/options.md#namespace) for details.
1211-
1212-
Instance-scoped current-run selection no longer trusts only the mutable `workflow_instances.current_run_id` pointer. `load($instanceId)`, `currentRunId()`, Waterline instance routes, and other instance-targeted current-run actions resolve the newest durable run in the instance chain, so continue-as-new navigation still lands on the right run even if that pointer is temporarily stale or null.
1213-
1214-
That same distinction applies to query methods:
1215-
1216-
```php
1217-
$current = WorkflowStub::load($instanceId);
1218-
$current->currentStage(); // Queries the current run for that instance
1219-
1220-
$historical = WorkflowStub::loadSelection($instanceId, $runId);
1221-
$historical->currentStage(); // Queries the selected run explicitly
1222-
```
1223-
1224-
## Webhook Routes
1225-
1226-
The webhook surface supports both instance-targeted and run-targeted command routes:
1227-
1228-
```text
1229-
POST /webhooks/instances/{workflowId}/signals/{signal}
1230-
POST /webhooks/instances/{workflowId}/updates/{update}
1231-
POST /webhooks/instances/{workflowId}/cancel
1232-
POST /webhooks/instances/{workflowId}/terminate
1233-
POST /webhooks/instances/{workflowId}/runs/{runId}/signals/{signal}
1234-
POST /webhooks/instances/{workflowId}/runs/{runId}/updates/{update}
1235-
POST /webhooks/instances/{workflowId}/runs/{runId}/cancel
1236-
POST /webhooks/instances/{workflowId}/runs/{runId}/terminate
1237-
```
1238-
1239-
## Waterline Routes
1240-
1241-
Waterline's canonical detail route is instance-scoped with an explicit selected run:
1242-
1243-
```text
1244-
/waterline/flows/instances/{instanceId}/runs/{runId}
1245-
```
1246-
1247-
The matching API routes are:
1248-
1249-
```text
1250-
GET /waterline/api/instances/{instanceId}
1251-
GET /waterline/api/instances/{instanceId}/history-export
1252-
GET /waterline/api/instances/{instanceId}/runs/{runId}
1253-
POST /waterline/api/instances/{instanceId}/cancel
1254-
POST /waterline/api/instances/{instanceId}/repair
1255-
POST /waterline/api/instances/{instanceId}/terminate
1256-
POST /waterline/api/instances/{instanceId}/runs/{runId}/cancel
1257-
POST /waterline/api/instances/{instanceId}/runs/{runId}/repair
1258-
POST /waterline/api/instances/{instanceId}/runs/{runId}/terminate
1259-
```
1260-
1261-
Legacy Waterline bucket preview routes such as `/waterline/running/{flowId}` still work as compatibility aliases, but they now hydrate through the same selected-run payload and redirect onto the canonical instance/run detail route.
1262-
1263-
`GET /waterline/api/instances/{instanceId}/history-export` follows the same current-run selection contract as `GET /waterline/api/instances/{instanceId}`. If continue-as-new lineage proves the current run, the history export follows that lineage; if there is no lineage evidence, it falls back to durable run ordering. Historical exports remain explicitly run-scoped under `/waterline/api/instances/{instanceId}/runs/{runId}/history-export`.
1264-
1265-
## Persisting IDs
1266-
1267-
Persist the instance id when another system needs to address the workflow again later. Persist the run id when you need to pin one specific execution, such as a Waterline detail view or a command-history entry.
1268-
1269-
Run-targeted command responses return both identities:
1270-
1271-
```json
1272-
{
1273-
"workflow_id": "order-123",
1274-
"run_id": "01J10000000000000000000021",
1275-
"requested_run_id": "01J10000000000000000000021",
1276-
"resolved_run_id": "01J10000000000000000000021",
1277-
"command_id": "01J40000000000000000000021",
1278-
"target_scope": "run",
1279-
"command_status": "accepted",
1280-
"rejection_reason": null
1281-
}
1282-
```
1283-
1284-
That contract is what Waterline uses for canonical selected-run actions, so an operator action can always be tied back to both the stable public instance id and the concrete run id that accepted or rejected the command. When a historical selected run rejects as `rejected_not_current`, `requested_run_id` keeps the run the caller addressed and `resolved_run_id` points at the current run that should be used next.
1285-
1286-
## Durable Type Stability
1287-
1288-
Keep the public instance id stable independently from the workflow's PHP class name. Class renames are survivable only when the durable `workflow_type` stays stable and the new class is still registered under that durable key through `#[Type(...)]` and/or `workflows.v2.types.workflows`. Once that mapping is in place, new starts and `continueAsNew()` generations rewrite the stored `workflow_class` for the next run to the resolved class instead of keeping the stale missing FQCN alive indefinitely.
1289-
1290-
Run-targeted commands reject with `target_scope = run`, `outcome = rejected_not_current`, and `rejection_reason = selected_run_not_current` when the selected run is no longer the instance's current run. The run-targeted webhook routes and Waterline's canonical selected-run operator routes both use that same durable rejection payload, with `requested_run_id` preserving the rejected historical selection and `resolved_run_id` naming the current run that won the race.
1291-
1292-
## Waterline Detail Controls
1293-
1294-
Waterline only shows mutable controls when the selected run is still current and still open. If you navigate to a historical run by run id, or if the current selected run is already closed, the detail payload stays read-only and points at the current active run when one exists. The detail payload exposes per-action mutability fields such as `can_cancel`, `cancel_blocked_reason`, `can_terminate`, `terminate_blocked_reason`, `can_signal`, `signal_blocked_reason`, `can_update`, `update_blocked_reason`, `can_repair`, `repair_blocked_reason`, the durable/searchable `repair_attention` bridge, and the companion `repair_blocked` metadata object, with `can_issue_terminal_commands` retained only as the coarse compatibility bridge for existing clients. The detail payload also includes `run_navigation`, so the UI can show the instance's ordered run chain without inferring it from legacy bucket routes or one-hop lineage links.
1295-
12961192
## Accessing IDs Inside Activities and Workflows
12971193

12981194
Inside an activity:

‎404.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@
1313

1414

1515
<link rel="search" type="application/opensearchdescription+xml" title="Durable Workflow" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.bdb910b5.css">
16-
<link rel="preload" href="/assets/js/runtime~main.ae0aabb3.js" as="script">
16+
<link rel="preload" href="/assets/js/runtime~main.d3168ff7.js" as="script">
1717
<link rel="preload" href="/assets/js/main.f3ccfcab.js" as="script">
1818
</head>
1919
<body class="navigation-with-keyboard">
2020
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
2121
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Durable Workflow</b></a><a class="navbar__item navbar__link" href="/docs/installation/">Docs</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/introduction/">1.x</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/2.0/introduction/">2.0</a></li><li><a class="dropdown__link" href="/docs/introduction/">1.x</a></li></ul></div><a class="navbar__item navbar__link" href="/blog/">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__item navbar__link" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__link navbar-github-star-link--mobile-topbar" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><div class="toggle_vylO colorModeToggle_x44X"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/introduction/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation/">Installation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/xu5aDDpqVy" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://x.com/DurableWorkflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">X<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://durable-workflow.com/llms-full.txt" target="_blank" rel="noopener noreferrer" class="footer__link-item">LLM Docs<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://packagist.org/packages/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">Packagist<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://durable-workflow.com">Durable Workflow</a>.</div></div></div></footer></div></div>
22-
<script src="/assets/js/runtime~main.ae0aabb3.js"></script>
22+
<script src="/assets/js/runtime~main.d3168ff7.js"></script>
2323
<script src="/assets/js/main.f3ccfcab.js"></script>
2424
</body>
2525
</html>

0 commit comments

Comments
 (0)