@empyria/restate 0.4.12 → 0.4.13

package/.github/dependabot.yml

@@ -5,7 +5,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "daily"
+    - package-ecosystem: '' # See documentation for possible values
+      directory: '/' # Location of package manifests
+      schedule:
+          interval: 'daily'

package/AGENTS.md

@@ -74,6 +74,11 @@ Attempted to assign to readonly property`). Use `mock.module('@restatedev/restat
 any mocking) if you need to restore it — reading it back off the live `clients` binding later
 may observe an already-mocked value. See `test/Admin.test.js`.
 
+`setupRestate`'s shutdown decision is `shouldDeleteOnShutdown` (unit tested); `keepDeploymentOnShutdown` and
+`forceRegistration` exist because invocations are pinned to their deployment: Restate 1.7 keeps the deployment ID when the
+same address registers again, but only `force: true` updates its handler list. Check both against a live server when
+touching them.
+
 `setupRestate` (in `lib/Admin.js`) is not unit tested: it binds real HTTP/2 + health-check
 ports, installs process-wide `SIGTERM`/`SIGINT` handlers, and its returned `forceClose` calls
 `process.exit()` — none of which are safe to exercise in-process in a test run.

package/README.md

@@ -124,7 +124,15 @@ Cron expressions are `croner` patterns (five fields, or six with seconds for tes
 
 ### An endpoint that does not register itself
 
-`setupRestate` serves, registers the deployment, and deletes it again on SIGINT/SIGTERM. When something else owns
+`setupRestate` serves, registers the deployment, and deletes it again on SIGINT/SIGTERM. Invocations in flight are
+pinned to their deployment, so deleting it strands them: a restarted process cannot finish them and they can only be
+killed. For a process restarted at the same address, pass `keepDeploymentOnShutdown: true` and `forceRegistration: true`:
+Restate keeps the deployment ID when the same address registers again (checked against Restate 1.7), running
+invocations resume on the new process, and `force` updates the services and handlers in place (a plain
+re-registration keeps the old handler list). Only compatible changes are safe this way: an invocation of a removed or
+renamed handler cannot resume.
+
+When something else owns
 registration (a supervisor that registers a process's address once and restarts the process), use
 `serveEndpoint({port, services})` instead: it only serves. Invocations already running on a deployment are pinned to its
 address, so the deployment must survive the process stopping and come back at the same address.

package/lib/Admin.js

@@ -581,7 +581,15 @@ export function defineObject(def) {
 /**
  * Starts the HTTP/2 Restate endpoint, a health-check HTTP server, registers
  * the deployment with the admin API, and wires SIGTERM/SIGINT for graceful
- * shutdown (deregistering the deployment before exiting).
+ * shutdown (deregistering the deployment before exiting, unless `keepDeploymentOnShutdown`).
+ *
+ * Invocations in flight are pinned to their deployment. Deleting it on shutdown means a restarted process cannot
+ * finish them, and they cannot even be cancelled (only killed). For a process that is restarted at the same address
+ * (a dev loop, a service that is redeployed in place), pass `keepDeploymentOnShutdown: true` and
+ * `forceRegistration: true`: Restate keeps the deployment ID when the same address registers again, so running
+ * invocations resume on the new process, and `force` updates the deployment's services and handlers in place (a plain
+ * re-registration keeps the old handler list). Only compatible changes are safe that way: an invocation of a handler
+ * that was removed or renamed cannot resume.
  * @param {Object} params
  * @param {string} params.restateAdminURL
  * @param {string} params.host
@@ -590,6 +598,9 @@ export function defineObject(def) {
  * @param {Parameters<typeof restate.createEndpointHandler>[0]['services']} [params.services]
  * @param {() => void} [params.shutdownCallbackFn]
  * @param {(deploymentId: string) => void} [params.registrationCallbackFn]
+ * @param {boolean} [params.keepDeploymentOnShutdown=false] Leave the deployment registered on SIGINT/SIGTERM.
+ * @param {boolean} [params.forceRegistration=false] Register with `force: true`, updating an existing deployment at
+ *   the same address in place.
  * @returns {Promise<RestateServer>}
  */
 export async function setupRestate({
@@ -600,6 +611,8 @@ export async function setupRestate({
 	services = [],
 	shutdownCallbackFn,
 	registrationCallbackFn,
+	keepDeploymentOnShutdown = false,
+	forceRegistration = false,
 }) {
 	const handler = restate.createEndpointHandler({ services })
 
@@ -647,8 +660,12 @@ export async function setupRestate({
 		isHealthy = false
 
 		try {
-			if (deploymentId && deploymentId !== 'NA') {
+			if (shouldDeleteOnShutdown({ deploymentId, keepDeploymentOnShutdown })) {
 				await deleteDeployment(restateAdminURL, deploymentId)
+			} else if (keepDeploymentOnShutdown && deploymentId) {
+				console.log(
+					`Keeping deployment ${deploymentId}: invocations in flight resume when it comes back`,
+				)
 			}
 		} catch (err) {
 			console.error(err)
@@ -688,7 +705,11 @@ export async function setupRestate({
 
 			for (let attempt = 1; attempt <= attempts; attempt++) {
 				try {
-					const result = await registerDeployment({ restateAdminURL, serviceURL })
+					const result = await registerDeployment({
+						restateAdminURL,
+						serviceURL,
+						force: forceRegistration,
+					})
 
 					try {
 						registrationCallbackFn?.(result.id)
@@ -751,15 +772,27 @@ export async function setupRestate({
 }
 
 /**
- * POSTs this process's HTTP endpoint to the Restate admin API so its services are discoverable.
- * @param {{restateAdminURL: string, serviceURL: string}} params
+ * Whether `setupRestate`'s shutdown removes the deployment: only a real one (registered, not `'NA'`), and not when the
+ * caller keeps it for the next start.
+ * @param {{deploymentId: string|undefined, keepDeploymentOnShutdown?: boolean}} params
+ * @returns {boolean}
+ */
+export function shouldDeleteOnShutdown({ deploymentId, keepDeploymentOnShutdown = false }) {
+	return Boolean(deploymentId) && deploymentId !== 'NA' && !keepDeploymentOnShutdown
+}
+
+/**
+ * POSTs this process's HTTP endpoint to the Restate admin API so its services are discoverable. Registering an
+ * address that is already registered returns the same deployment; with `force` its services and handlers are
+ * updated in place (without it, Restate keeps the ones it knew).
+ * @param {{restateAdminURL: string, serviceURL: string, force?: boolean}} params
  * @returns {Promise<RegisterDeploymentResponse>}
  */
-export async function registerDeployment({ restateAdminURL, serviceURL }) {
+export async function registerDeployment({ restateAdminURL, serviceURL, force = false }) {
 	const uri = serviceURL
 
 	/** @type {RegisterDeploymentRequest} */
-	const body = { uri, force: null }
+	const body = { uri, force: force ? true : null }
 
 	console.log(`Registering: ${uri} at: ${restateAdminURL}/deployments`)
 
@@ -872,7 +905,8 @@ export function createRestateAdmin({ restateAdminURL, restateURL }) {
 		pollInvocation: ({ invocationId, intervalMs }) =>
 			pollInvocation({ restateURL, invocationId, intervalMs }),
 
-		getInvocationOutput: ({ invocationId }) => getInvocationOutput({ restateURL, invocationId }),
+		getInvocationOutput: ({ invocationId }) =>
+			getInvocationOutput({ restateURL, invocationId }),
 
 		sendMessage: ({ name, message, key, payload, idempotencyKey }) =>
 			sendMessage({ restateURL, name, message, key, payload, idempotencyKey }),

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@empyria/restate",
-	"version": "0.4.12",
+	"version": "0.4.13",
 	"description": "Restate.dev helpers for the Empyria nanoservice framework",
 	"license": "MIT",
 	"author": "Imre Fazekas <imre.fazekas@icloud.com>",

package/test/Admin.test.js

@@ -20,6 +20,7 @@ import {
 	sendMessageWithDiscovery,
 	sendMessageAsyncWithDiscovery,
 	registerDeployment,
+	shouldDeleteOnShutdown,
 	sendMessageAsynSafe,
 	defineWorkflow,
 	defineService,
@@ -521,6 +522,42 @@ describe('registerDeployment', () => {
 			registerDeployment({ restateAdminURL: 'http://admin', serviceURL: 'http://svc' }),
 		).rejects.toThrow(/bad uri/)
 	})
+
+	test('sends force: null by default and force: true when asked, to the deployments endpoint', async () => {
+		const sent = []
+		globalThis.fetch = mock(async (url, init) => {
+			sent.push({ url, body: JSON.parse(init.body) })
+			return jsonResponse({ id: 'dep-1', services: [] })
+		})
+		await registerDeployment({ restateAdminURL: 'http://admin', serviceURL: 'http://svc:9080' })
+		await registerDeployment({
+			restateAdminURL: 'http://admin',
+			serviceURL: 'http://svc:9080',
+			force: true,
+		})
+		expect(sent).toEqual([
+			{ url: 'http://admin/deployments', body: { uri: 'http://svc:9080', force: null } },
+			{ url: 'http://admin/deployments', body: { uri: 'http://svc:9080', force: true } },
+		])
+	})
+})
+
+describe('shouldDeleteOnShutdown', () => {
+	test('deletes a registered deployment by default', () => {
+		expect(shouldDeleteOnShutdown({ deploymentId: 'dep-1' })).toBe(true)
+	})
+
+	test('keeps it when asked, so invocations in flight can resume after a restart', () => {
+		expect(
+			shouldDeleteOnShutdown({ deploymentId: 'dep-1', keepDeploymentOnShutdown: true }),
+		).toBe(false)
+	})
+
+	test('never deletes without a real deployment', () => {
+		for (const deploymentId of [undefined, '', 'NA']) {
+			expect(shouldDeleteOnShutdown({ deploymentId })).toBe(false)
+		}
+	})
 })
 
 // `clients` is a live ESM namespace binding (read-only — Object.assign/property