@rest-vir/run-service 0.11.4 → 0.12.0

package/dist/handle-request/handle-endpoint.d.ts

@@ -1,4 +1,4 @@
-import { ImplementedEndpoint } from '@rest-vir/implement-service';
+import { ImplementedEndpoint, type RunningServerInfo } from '@rest-vir/implement-service';
 import { EndpointHandlerParams, type HandledOutput } from './endpoint-handler.js';
 /**
  * Handles an endpoint's implementation execution.
@@ -7,7 +7,8 @@ import { EndpointHandlerParams, type HandledOutput } from './endpoint-handler.js
  * @category Package : @rest-vir/run-service
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
-export declare function handleEndpointRequest(this: void, { endpoint, request, response, attachId, }: Readonly<Omit<EndpointHandlerParams, 'route'> & {
+export declare function handleEndpointRequest(this: void, { endpoint, request, response, attachId, server, }: Readonly<Omit<EndpointHandlerParams, 'route'> & {
     attachId: string;
     endpoint: Readonly<ImplementedEndpoint>;
+    server: Readonly<RunningServerInfo>;
 }>): Promise<HandledOutput>;

package/dist/handle-request/handle-endpoint.js

@@ -9,7 +9,7 @@ import { assertValidShape } from 'object-shape-tester';
  * @category Package : @rest-vir/run-service
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
-export async function handleEndpointRequest({ endpoint, request, response, attachId, }) {
+export async function handleEndpointRequest({ endpoint, request, response, attachId, server, }) {
     try {
         const restVirContext = request.restVirContext?.[attachId];
         assert.isDefined(restVirContext, 'restVirContext is not defined');
@@ -28,6 +28,7 @@ export async function handleEndpointRequest({ endpoint, request, response, attac
             log: endpoint.service.logger,
             context,
             searchParams,
+            server,
         };
         const endpointResult = (await endpoint.implementation(endpointParams));
         if (isErrorHttpStatus(endpointResult.statusCode)) {

package/dist/handle-request/handle-route.d.ts

@@ -1,4 +1,4 @@
-import { ImplementedEndpoint, ServerRequest, ServerResponse, type ImplementedWebSocket } from '@rest-vir/implement-service';
+import { ImplementedEndpoint, ImplementedWebSocket, RunningServerInfo, ServerRequest, ServerResponse } from '@rest-vir/implement-service';
 import { type WebSocket as WsWebSocket } from 'ws';
 import { HandleRouteOptions } from './endpoint-handler.js';
 /**
@@ -12,4 +12,4 @@ export declare function handleRoute(
 /** Endpoint requests won't have a `WebSocket`. */
 webSocket: WsWebSocket | undefined, request: ServerRequest, 
 /** `WebSocket` requests won't have a response. */
-response: ServerResponse | undefined, route: Readonly<ImplementedEndpoint | ImplementedWebSocket>, attachId: string, options?: Readonly<Pick<HandleRouteOptions, 'throwErrorsForExternalHandling'>>): Promise<void>;
+response: ServerResponse | undefined, route: Readonly<ImplementedEndpoint | ImplementedWebSocket>, attachId: string, server: Readonly<RunningServerInfo>, options?: Readonly<Pick<HandleRouteOptions, 'throwErrorsForExternalHandling'>>): Promise<void>;

package/dist/handle-request/handle-route.js

@@ -16,7 +16,7 @@ export async function handleRoute(
 /** Endpoint requests won't have a `WebSocket`. */
 webSocket, request, 
 /** `WebSocket` requests won't have a response. */
-response, route, attachId, options = {}) {
+response, route, attachId, server, options = {}) {
     try {
         const workerPid = cluster.isPrimary ? '' : process.pid;
         const webSocketMarker = route.isWebSocket ? '(ws)' : '';
@@ -34,6 +34,7 @@ response, route, attachId, options = {}) {
                 response,
                 endpoint: route,
                 attachId,
+                server,
             });
             const sentResponse = handleHandlerResult(result, response);
             if (sentResponse) {
@@ -47,6 +48,7 @@ response, route, attachId, options = {}) {
                 implementedWebSocket: route,
                 webSocket,
                 attachId,
+                server,
             });
         }
         /* node:coverage ignore next: this can't actually be triggered but it should be covered as a potential future edge case. */

package/dist/handle-request/handle-web-socket.d.ts

@@ -1,4 +1,4 @@
-import { ImplementedWebSocket, ServerRequest } from '@rest-vir/implement-service';
+import { ImplementedWebSocket, ServerRequest, type RunningServerInfo } from '@rest-vir/implement-service';
 import { type WebSocket as WsWebSocket } from 'ws';
 /**
  * Handles a WebSocket request.
@@ -7,9 +7,10 @@ import { type WebSocket as WsWebSocket } from 'ws';
  * @category Package : @rest-vir/run-service
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
-export declare function handleWebSocketRequest(this: void, { attachId, request, implementedWebSocket, webSocket: wsWebSocket, }: Readonly<{
+export declare function handleWebSocketRequest(this: void, { attachId, request, implementedWebSocket, webSocket: wsWebSocket, server, }: Readonly<{
     request: ServerRequest;
     attachId: string;
     implementedWebSocket: Readonly<ImplementedWebSocket>;
     webSocket: WsWebSocket;
+    server: Readonly<RunningServerInfo>;
 }>): Promise<void>;

package/dist/handle-request/handle-web-socket.js

@@ -10,7 +10,7 @@ import { assertValidShape } from 'object-shape-tester';
  * @category Package : @rest-vir/run-service
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
-export async function handleWebSocketRequest({ attachId, request, implementedWebSocket, webSocket: wsWebSocket, }) {
+export async function handleWebSocketRequest({ attachId, request, implementedWebSocket, webSocket: wsWebSocket, server, }) {
     const restVirContext = request.restVirContext?.[attachId];
     assert.isDefined(restVirContext, 'restVirContext is not defined');
     const webSocket = overwriteWebSocketMethods(implementedWebSocket, wsWebSocket, WebSocketLocation.OnHost);
@@ -24,6 +24,7 @@ export async function handleWebSocketRequest({ attachId, request, implementedWeb
         webSocket,
         protocols: restVirContext.protocols,
         searchParams: restVirContext.searchParams,
+        server,
     };
     if (implementedWebSocket.implementation.close) {
         webSocket.on('close', async () => {

package/dist/handle-request/pre-handler.d.ts

@@ -1,5 +1,5 @@
 import { type SelectFrom } from '@augment-vir/common';
-import { GenericServiceImplementation, ServerRequest, ServerResponse } from '@rest-vir/implement-service';
+import { GenericServiceImplementation, RunningServerInfo, ServerRequest, ServerResponse } from '@rest-vir/implement-service';
 import { type FastifyReply } from 'fastify';
 /**
  * Handles a request before it gets to the actual route handlers.
@@ -16,4 +16,4 @@ export declare function preHandler(request: ServerRequest, response: ServerRespo
     serviceOrigin: true;
     requiredClientOrigin: true;
     logger: true;
-}>>, attachId: string): Promise<FastifyReply | undefined>;
+}>>, server: Readonly<RunningServerInfo>, attachId: string): Promise<FastifyReply | undefined>;

package/dist/handle-request/pre-handler.js

@@ -14,7 +14,7 @@ import { handleSearchParams } from './handle-search-params.js';
  * @category Package : @rest-vir/run-service
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
-export async function preHandler(request, response, service, attachId) {
+export async function preHandler(request, response, service, server, attachId) {
     response.header(restVirServiceNameHeader, service.serviceName);
     const pathMatch = matchUrlToService(service, request.originalUrl);
     if (!pathMatch) {
@@ -72,6 +72,7 @@ export async function preHandler(request, response, service, attachId) {
         service,
         endpointDefinition: endpointDefinition,
         webSocketDefinition: webSocketDefinition,
+        server,
     };
     const searchParams = handleSearchParams({ request, route });
     if (!('data' in searchParams)) {

package/dist/start-service/attach-service.d.ts

@@ -1,6 +1,6 @@
 import { SelectFrom } from '@augment-vir/common';
-import type { BaseSearchParams } from '@rest-vir/define-service';
-import { GenericServiceImplementation } from '@rest-vir/implement-service';
+import type { BaseSearchParams, MinimalService } from '@rest-vir/define-service';
+import { GenericServiceImplementation, type RunningServerInfo } from '@rest-vir/implement-service';
 import { type FastifyInstance } from 'fastify';
 import { HandleRouteOptions } from '../handle-request/endpoint-handler.js';
 declare module 'fastify' {
@@ -43,3 +43,13 @@ export declare function attachService(server: Readonly<FastifyInstance>, service
     requiredClientOrigin: true;
     logger: true;
 }>>, options?: Readonly<HandleRouteOptions>): Promise<void>;
+/**
+ * Merge the running Fastify server's port with the given service's origin port (if it has a port).
+ *
+ * @category Internal
+ */
+export declare function extractRunningServerInfo(service: Readonly<Pick<MinimalService, 'serviceOrigin'>>, fastify: Readonly<SelectFrom<FastifyInstance, {
+    server: {
+        address: true;
+    };
+}>>): RunningServerInfo;

package/dist/start-service/attach-service.js

@@ -1,6 +1,8 @@
+import { check } from '@augment-vir/assert';
 import { ensureError, extractErrorMessage, getEnumValues, getObjectTypedKeys, HttpMethod, HttpStatus, randomString, } from '@augment-vir/common';
 import fastifyWs from '@fastify/websocket';
 import { RestVirHandlerError, } from '@rest-vir/implement-service';
+import { buildUrl, parseUrl } from 'url-vir';
 import { handleRoute } from '../handle-request/handle-route.js';
 import { preHandler } from '../handle-request/pre-handler.js';
 const endpointFastifyMethods = getEnumValues(HttpMethod).filter((value) => {
@@ -51,7 +53,7 @@ export async function attachService(server, service, options = {}) {
         }
         server.addHook('preValidation', async (request, response) => {
             try {
-                return await preHandler(request, response, service, attachId);
+                return await preHandler(request, response, service, extractRunningServerInfo(service, server), attachId);
             }
             catch (error) {
                 service.logger.error(ensureError(error));
@@ -76,17 +78,17 @@ export async function attachService(server, service, options = {}) {
                     method: endpointFastifyMethods,
                     url: path,
                     handler(request, response) {
-                        return handleRoute(undefined, request, response, endpoint, attachId, options);
+                        return handleRoute(undefined, request, response, endpoint, attachId, extractRunningServerInfo(service, server), options);
                     },
                 });
                 server.route({
                     method: HttpMethod.Get,
                     url: path,
                     handler(request, response) {
-                        return handleRoute(undefined, request, response, endpoint, attachId, options);
+                        return handleRoute(undefined, request, response, endpoint, attachId, extractRunningServerInfo(service, server), options);
                     },
                     wsHandler(webSocket, request) {
-                        return handleRoute(webSocket, request, undefined, webSocketDefinition, attachId, options);
+                        return handleRoute(webSocket, request, undefined, webSocketDefinition, attachId, extractRunningServerInfo(service, server), options);
                     },
                 });
             }
@@ -98,7 +100,7 @@ export async function attachService(server, service, options = {}) {
                     ],
                     url: path,
                     handler(request, response) {
-                        return handleRoute(undefined, request, response, endpoint, attachId, options);
+                        return handleRoute(undefined, request, response, endpoint, attachId, extractRunningServerInfo(service, server), options);
                     },
                 });
             }
@@ -110,7 +112,7 @@ export async function attachService(server, service, options = {}) {
                         return response.status(HttpStatus.NotFound).send();
                     },
                     wsHandler(webSocket, request) {
-                        return handleRoute(webSocket, request, undefined, webSocketDefinition, attachId, options);
+                        return handleRoute(webSocket, request, undefined, webSocketDefinition, attachId, extractRunningServerInfo(service, server), options);
                     },
                 });
             }
@@ -122,3 +124,25 @@ export async function attachService(server, service, options = {}) {
         throw error;
     }
 }
+/**
+ * Merge the running Fastify server's port with the given service's origin port (if it has a port).
+ *
+ * @category Internal
+ */
+export function extractRunningServerInfo(service, fastify) {
+    const address = fastify.server.address();
+    const { port: originalPort } = parseUrl(service.serviceOrigin);
+    if (!originalPort || check.isString(address) || !address) {
+        return {
+            serviceOrigin: service.serviceOrigin,
+        };
+    }
+    else {
+        const { origin } = buildUrl(service.serviceOrigin, {
+            port: address.port,
+        });
+        return {
+            serviceOrigin: origin,
+        };
+    }
+}

package/dist/start-service/start-service-options.d.ts

@@ -22,7 +22,9 @@ export declare const startServiceOptionsShape: import("object-shape-tester").Sha
      * If this property is set to `false`, no port will be listened to (so you can manually do that
      * later if you wish).
      *
-     * @default 3000
+     * @default
+     * // the service definition's port or
+     * 3000
      */
     port: number;
     /**

package/dist/start-service/start-service-options.js

@@ -25,7 +25,9 @@ export const startServiceOptionsShape = defineShape({
      * If this property is set to `false`, no port will be listened to (so you can manually do that
      * later if you wish).
      *
-     * @default 3000
+     * @default
+     * // the service definition's port or
+     * 3000
      */
     port: 3000,
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/run-service",
-    "version": "0.11.4",
+    "version": "0.12.0",
     "description": "Run a service defined by @rest-vir/define-service and implemented by @rest-vir/implement-service.",
     "keywords": [
         "rest",
@@ -39,25 +39,25 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.10.2",
-        "@augment-vir/common": "^31.10.2",
-        "@augment-vir/node": "^31.10.2",
+        "@augment-vir/assert": "^31.11.0",
+        "@augment-vir/common": "^31.11.0",
+        "@augment-vir/node": "^31.11.0",
         "@fastify/websocket": "^11.0.2",
-        "@rest-vir/define-service": "^0.11.4",
-        "@rest-vir/implement-service": "^0.11.4",
+        "@rest-vir/define-service": "^0.12.0",
+        "@rest-vir/implement-service": "^0.12.0",
         "cluster-vir": "^0.1.0",
         "date-vir": "^7.3.1",
-        "fastify": "^5.2.2",
+        "fastify": "^5.3.0",
         "light-my-request": "^6.6.0",
-        "portfinder": "^1.0.35",
-        "type-fest": "^4.39.1",
+        "portfinder": "^1.0.36",
+        "type-fest": "^4.40.0",
         "url-vir": "^2.1.3"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.10.2",
+        "@augment-vir/test": "^31.11.0",
         "@fastify/multipart": "^9.0.3",
         "@types/connect": "^3.4.38",
-        "@types/node": "^22.14.0",
+        "@types/node": "^22.14.1",
         "@types/ws": "^8.18.1",
         "c8": "^10.1.3",
         "istanbul-smart-text-reporter": "^1.1.5",