@adonis-agora/durable 0.60.0 → 1.0.0-rc.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @adonis-agora/durable
 
+## 1.0.0-rc.0
+
+### Major Changes
+
+- [#487](https://github.com/DavideCarvalho/adonis-agora-durable/pull/487) [`d01974a`](https://github.com/DavideCarvalho/adonis-agora-durable/commit/d01974ad24e271371a7288c642c29fe4ca71982e) Thanks [@DavideCarvalho](https://github.com/DavideCarvalho)! - 1.0. The breaking changes, with before/after snippets, are in [Migrating to 1.0](https://davidecarvalho.github.io/agora/docs/durable/migrating-to-1-0).
+  
+  `@adonis-agora/durable`:
+  
+  - **`Wf.start` throws when the run does not complete.** Outside a workflow, a run that ends `failed`, `cancelled` or `dead` now throws the same `FatalError` `ctx.child` throws (`run "<runId>" failed: <reason>`, with the run error's `code` and `details`) instead of resolving with `undefined`. `Wf.start` also takes `timeoutMs` (new `WorkflowStartOptions` type), which bounds the wait.
+  - **The Redis control plane channel includes the namespace.** `controlPlanes.redis` / `RedisControlPlane` broadcast on `<prefix>-<namespace>-control` when the engine has a namespace, matching the `bullmq` transport's names and the NestJS and Python workers. A namespace-less or `default` engine stays on `<prefix>-control`. Wire change: deploy every pod of a namespace together, and drop a `prefix: 'durable-<namespace>'` workaround. A message about a run (cancel, enqueue nudge, the run's lifecycle events) is published on the channel of that run's namespace, so a console with no namespace reaches a namespaced worker at once; messages with no run stay on the publisher's channel. A process that mounts the durable dashboard, or an engine with no namespace, observes every namespace (it also pattern-subscribes to `<prefix>-*-control`); any other namespaced engine observes only its own channel. `controlPlanes.redis({ observe: 'all' | 'own' })` overrides it, and `engine.observeAllNamespaces()` is what the dashboard provider calls. New `namespace` option (it picks the channel an instance listens on), an optional `ControlPlane.useNamespace` hook the engine calls, and an optional `target` argument to `ControlPlane.publishControl`.
+  - **The dashboard update route is `POST <path>/api/runs/:id/updates/:name`** (was `update/:name`), matching the Aviary dashboard API. No alias.
+  - **The transports' `group` option is removed** from `transports.queue`, `transports.db`, `transports.eventEmitter` and the `QueueTransport`, `DbTransport` and `EventEmitterTransport` constructors. It had no effect; use `partition` for separate worker pools.
+  - **`RunSchedulesOptions.sleep` is removed.** It was no longer called.
+  - **`@adonis-agora/filter` is now a range dependency** (`>=0.11.2 <2.0.0 || >=1.0.0-rc.0 <2.0.0`, was pinned to `0.11.2`), so an app that installs filter 1.x shares its copy with durable instead of getting a second one nested inside it.
+  - **`ProxyRunGateway` no longer reads the pre-0.50 unknown-verb reply** (an `unknown run-request verb` message with no `code`), nor an empty `ok` reply, as "the control plane does not know this verb". It relies on the `unsupported-request` code every 0.50+ control plane sends, so upgrade a control plane older than 0.50 before its tenant pods.
+  
+  `@adonis-agora/durable-dashboard`: the console's `update` call targets `POST <path>/api/runs/:id/updates/:name`, which only a 1.0 server answers.
+  
+  `@adonis-agora/durable-eslint-plugin`: no breaking changes; released as 1.0 with the rest of the family.
+
 ## 0.60.0
 
 ### Minor Changes