@empyria/restate 0.4.20 → 0.4.22

package/README.md

@@ -125,9 +125,10 @@ Cron expressions are `croner` patterns (five fields, or six with seconds for tes
 ### Serving and registering an endpoint
 
 `setupRestate({ restateAdminURL, serviceURL: 'https://agent-service.internal:9080', services })` takes one complete URL, the
-address Restate reaches the endpoint at. It is registered as given and the endpoint listens on its port, so the scheme and
-an explicit port are required (there is no separate host or port option); the health endpoint listens on the next port
-unless `healthPort` is set.
+address Restate reaches the endpoint at. It is registered as given and the endpoint listens on its port (80 or 443 when
+the URL has none or states the scheme's default), so the scheme is required (there is no separate host or port option);
+pass `port` when the endpoint listens on another port than the one in the URL (a container behind a Service or proxy). The
+health endpoint listens on the port after that unless `healthPort` is set.
 
 It 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

package/lib/Admin.js

@@ -620,9 +620,11 @@ export function defaultHealthCheck(req, res, { isHealthy, deploymentId, services
  * that was removed or renamed cannot resume.
  * @param {Object} params
  * @param {string} params.restateAdminURL
- * @param {string} params.serviceURL Complete URL Restate uses to reach this endpoint, scheme and port included
- *   (e.g. `https://agent-service.internal:9080`). It is registered as given, and the endpoint listens on its port, so
- *   the port must be explicit. Scheme and port are the caller's to state, never guessed here.
+ * @param {string} params.serviceURL Complete URL Restate uses to reach this endpoint (e.g.
+ *   `https://agent-service.internal:9080`). It is registered as given, and the endpoint listens on its port: 80 or 443
+ *   when the URL has none or states the scheme's default (listening there needs the privilege to bind it).
+ * @param {number} [params.port] Port the endpoint listens on. Defaults to the port of `serviceURL`; set it when they
+ *   differ (a container port behind a Service or proxy on another port).
  * @param {number} [params.healthPort] - Defaults to `port + 1`.
  * @param {Parameters<typeof restate.createEndpointHandler>[0]['services']} [params.services]
  * @param {() => void} [params.shutdownCallbackFn]
@@ -639,6 +641,7 @@ export function defaultHealthCheck(req, res, { isHealthy, deploymentId, services
 export async function setupRestate({
 	restateAdminURL,
 	serviceURL: serviceURLParam,
+	port: portParam,
 	healthPort: healthPortParam,
 	services = [],
 	shutdownCallbackFn,
@@ -647,7 +650,8 @@ export async function setupRestate({
 	keepDeploymentOnShutdown = false,
 	forceRegistration = false,
 }) {
-	const { serviceURL, port } = parseServiceURL(serviceURLParam)
+	const { serviceURL, port: serviceURLPort } = parseServiceURL(serviceURLParam)
+	const port = portParam ?? serviceURLPort
 	const healthPort = healthPortParam ?? port + 1
 
 	const handler = restate.createEndpointHandler({ services })
@@ -792,10 +796,9 @@ export async function setupRestate({
 
 /**
  * Validates the URL `setupRestate` registers with Restate and returns it with the port the endpoint listens on.
- * @param {string} serviceURL Complete http(s) URL including an explicit port
+ * @param {string} serviceURL Complete http(s) URL; a port left out (or equal to the scheme's default) means 80/443
  * @returns {{serviceURL: string, port: number}} `serviceURL` unchanged
- * @throws {Error} If it is missing, not an absolute http(s) URL, or has no explicit port (the scheme's default would
- *   be a guess)
+ * @throws {Error} If it is missing or not an absolute http(s) URL
  */
 export function parseServiceURL(serviceURL) {
 	if (!serviceURL) {
@@ -814,12 +817,9 @@ export function parseServiceURL(serviceURL) {
 	if (url.protocol !== 'http:' && url.protocol !== 'https:') {
 		throw new Error(`serviceURL must use http or https, got '${serviceURL}'`)
 	}
-	if (!url.port) {
-		throw new Error(
-			`serviceURL '${serviceURL}' has no explicit port: the endpoint listens on the port in the URL`,
-		)
-	}
-	return { serviceURL, port: Number(url.port) }
+	// `URL.port` is '' for the scheme's default port, written or not; that is the port Restate dials, so listen on it.
+	const port = url.port ? Number(url.port) : url.protocol === 'https:' ? 443 : 80
+	return { serviceURL, port }
 }
 
 /**

package/package.json

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

package/test/Admin.test.js

@@ -566,9 +566,11 @@ describe('parseServiceURL', () => {
 		expect(() => parseServiceURL('ftp://svc:21')).toThrow(/http or https/)
 	})
 
-	test('refuses to guess the scheme default when the URL has no explicit port', () => {
-		expect(() => parseServiceURL('https://svc.example.com')).toThrow(/no explicit port/)
-		expect(() => parseServiceURL('http://svc:80')).toThrow(/no explicit port/)
+	test("uses the scheme's default port when the URL has none or states it", () => {
+		expect(parseServiceURL('https://svc.example.com').port).toBe(443)
+		expect(parseServiceURL('https://svc.example.com:443').port).toBe(443)
+		expect(parseServiceURL('http://svc').port).toBe(80)
+		expect(parseServiceURL('http://svc:80').port).toBe(80)
 	})
 })