@rest-vir/run-service 0.20.0 → 0.21.0

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

@@ -22,7 +22,7 @@ export function handleRequestMethod({ route, request, }) {
                 [HttpMethod.Get]: true,
             };
     if (!requestMethod || !allowedMethods[requestMethod]) {
-        route.service.logger.error(new RestVirHandlerError(route, `Method '${requestMethod}' rejected: '${request.originalUrl}'`, HttpStatus.MethodNotAllowed));
+        route.service.logger.error(new RestVirHandlerError(route, `Method '${request.method.toUpperCase()}' rejected: '${request.originalUrl}'`, HttpStatus.MethodNotAllowed));
         return {
             statusCode: HttpStatus.MethodNotAllowed,
         };

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

@@ -1,6 +1,6 @@
 import { assert, check } from '@augment-vir/assert';
 import { ensureError, HttpStatus } from '@augment-vir/common';
-import { RestVirHandlerError, } from '@rest-vir/implement-service';
+import { RejectRequestError, RestVirHandlerError, } from '@rest-vir/implement-service';
 import cluster from 'node:cluster';
 import { handleHandlerOutput, handleHandlerOutputWithoutSending, } from './endpoint-handler.js';
 import { handleEndpointRequest } from './handle-endpoint.js';
@@ -25,7 +25,7 @@ export async function handleRoute({ webSocket, request, response, route, attachI
         ].filter(check.isTruthy);
         route.service.logger.info(logParts.join('\t'));
         if (route.isEndpoint) {
-            assert.isDefined(response);
+            assert.isDefined(response, 'no response object');
             const result = await handleEndpointRequest({
                 request,
                 response,
@@ -71,6 +71,11 @@ export async function handleRoute({ webSocket, request, response, route, attachI
         throw new RestVirHandlerError(route, 'Request was not handled.');
     }
     catch (error) {
+        if (error instanceof RejectRequestError) {
+            assert.isDefined(response, 'no response object');
+            await handleHandlerOutput({ statusCode: error.httpStatus, body: error.responseErrorMessage }, response);
+            return;
+        }
         route.service.logger.error(ensureError(error));
         if (options.throwErrorsForExternalHandling) {
             throw error;

package/dist/handle-request/run-post-hook.js

@@ -1,7 +1,11 @@
-import { assert, assertWrap } from '@augment-vir/assert';
+import { assert, checkWrap } from '@augment-vir/assert';
 import { matchUrlToService } from '@rest-vir/define-service';
 import { HttpMethod, } from '@rest-vir/implement-service';
 export async function runPostHook({ request, response, attachId, server, postHook, service, originalBody, originalStatus, }) {
+    const method = checkWrap.isEnumValue(request.method.toUpperCase(), HttpMethod);
+    if (!method) {
+        return undefined;
+    }
     const restVirContext = request.restVirContext?.[attachId];
     assert.isDefined(restVirContext, 'restVirContext is not defined');
     const context = restVirContext.context;
@@ -20,7 +24,7 @@ export async function runPostHook({ request, response, attachId, server, postHoo
         : undefined;
     const postHookParams = {
         pathParams: request.params,
-        method: assertWrap.isEnumValue(request.method.toUpperCase(), HttpMethod),
+        method,
         request,
         requestData,
         requestHeaders: request.headers,

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

@@ -1,5 +1,5 @@
 import { assert, check } from '@augment-vir/assert';
-import { ensureError, extractErrorMessage, getEnumValues, getObjectTypedKeys, HttpMethod, HttpStatus, randomString, } from '@augment-vir/common';
+import { ensureError, ensureErrorClass, 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';
@@ -81,7 +81,12 @@ export async function attachService(server, service, options = {}) {
                 return handleHandlerOutput(preHandlerResult, response);
             }
             catch (error) {
-                service.logger.error(ensureError(error));
+                service.logger.error(ensureErrorClass(error, RestVirHandlerError, {
+                    isEndpoint: undefined,
+                    isWebSocket: undefined,
+                    path: request.originalUrl,
+                    service,
+                }, 'Unexpected error'));
                 if (options.throwErrorsForExternalHandling) {
                     throw error;
                     /* node:coverage ignore next 5 */

package/dist/test/test-service.d.ts

@@ -250,6 +250,20 @@ export type ConnectTestServiceWebSocket<Service extends SelectFrom<GenericServic
 export type TestServiceOptions = Overwrite<StartServiceUserOptions, {
     port?: number | undefined | false;
 }>;
+export type ServiceTestSuite<Service extends Readonly<SelectFrom<GenericServiceImplementation, {
+    webSockets: true;
+    endpoints: true;
+    serviceName: true;
+    createContext: true;
+    serviceOrigin: true;
+    requiredClientOrigin: true;
+    logger: true;
+    postHook: true;
+}>>> = {
+    fetchEndpoint: FetchTestService<Service>;
+    connectWebSocket: ConnectTestServiceWebSocket<Service>;
+    server: Readonly<FastifyInstance>;
+};
 /**
  * Test your service with actual Request and Response objects! The returned object includes
  * utilities for sending fetch requests and WebSocket connections to the service.
@@ -288,10 +302,9 @@ export declare function testService<const Service extends Readonly<SelectFrom<Ge
 }>>>(service: Readonly<Service>, testServiceOptions?: Readonly<Omit<PartialWithUndefined<StartServiceUserOptions>, 'workerCount' | 'preventWorkerRespawn' | ''>>): Promise<{
     /** Kill the server being tested. This should always be called after your tests are finished. */
     kill(this: void): Promise<void>;
-    /** Send a request to the service. */
     fetchEndpoint: FetchTestService<Service>;
-    /** Connect to a service WebSocket. */
     connectWebSocket: ConnectTestServiceWebSocket<Service>;
+    server: Readonly<FastifyInstance>;
 }>;
 /**
  * Similar to {@link testService} but used to test against a Fastify server that you've already
@@ -315,12 +328,7 @@ export declare function testExistingServer<const Service extends Readonly<Select
     requiredClientOrigin: true;
     logger: true;
     postHook: true;
-}>>>(server: Readonly<FastifyInstance>, service: Readonly<Service>, options?: Readonly<HandleRouteOptions & Omit<PartialWithUndefined<StartServiceOptions>, 'workerCount' | 'preventWorkerRespawn'>>): Promise<{
-    /** Send a request to the service. */
-    fetchEndpoint: FetchTestService<Service>;
-    /** Connect to a service WebSocket. */
-    connectWebSocket: ConnectTestServiceWebSocket<Service>;
-}>;
+}>>>(server: Readonly<FastifyInstance>, service: Readonly<Service>, options?: Readonly<HandleRouteOptions & Omit<PartialWithUndefined<StartServiceOptions>, 'workerCount' | 'preventWorkerRespawn'>>): Promise<ServiceTestSuite<Service>>;
 /**
  * Use this in conjunction with
  * [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test) or the Node.js built-in
@@ -364,4 +372,6 @@ export declare function describeService<const Service extends Readonly<SelectFro
 }, describeCallback: (params: {
     /** Send a request to the service. */
     fetchEndpoint: FetchTestService<Service>;
+    getServer: () => Promise<Readonly<FastifyInstance>>;
+    service: Readonly<Service>;
 }) => void | undefined): void;

package/dist/test/test-service.js

@@ -126,7 +126,6 @@ export async function testExistingServer(server, service, options = {}) {
         }).origin;
     const fetchEndpoint = mapObjectValues(service.endpoints, (endpointPath, endpoint) => {
         return async (...args) => {
-            await server.ready();
             const overwrittenOriginEndpoint = mergeDeep(endpoint, fetchOrigin
                 ? {
                     service: {
@@ -170,7 +169,6 @@ export async function testExistingServer(server, service, options = {}) {
         }).origin;
     const connectWebSocket = mapObjectValues(service.webSockets, (webSocketPath, webSocketDefinition) => {
         return async (...args) => {
-            await server.ready();
             const [{ protocols = [], listeners } = {}] = args;
             const overwrittenOriginWebSocket = mergeDeep(webSocketDefinition, webSocketOrigin
                 ? {
@@ -205,11 +203,13 @@ export async function testExistingServer(server, service, options = {}) {
             return finalized;
         };
     });
+    await server.ready();
     return {
         /** Send a request to the service. */
         fetchEndpoint,
         /** Connect to a service WebSocket. */
         connectWebSocket,
+        server,
     };
 }
 /**
@@ -249,6 +249,10 @@ export function describeService({ service, options, }, describeCallback) {
     describe(service.serviceName, () => {
         describeCallback({
             fetchEndpoint: fetchServiceObject,
+            async getServer() {
+                return (await servicePromise).server;
+            },
+            service,
         });
         /**
          * The built-in Node.js test runner runs `it` calls sequentially so this will always be

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/run-service",
-    "version": "0.20.0",
+    "version": "0.21.0",
     "description": "Run a service defined by @rest-vir/define-service and implemented by @rest-vir/implement-service.",
     "keywords": [
         "rest",
@@ -39,30 +39,30 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.20.0",
-        "@augment-vir/common": "^31.20.0",
-        "@augment-vir/node": "^31.20.0",
-        "@fastify/websocket": "^11.0.2",
-        "@rest-vir/define-service": "^0.20.0",
-        "@rest-vir/implement-service": "^0.20.0",
+        "@augment-vir/assert": "^31.28.0",
+        "@augment-vir/common": "^31.28.0",
+        "@augment-vir/node": "^31.28.0",
+        "@fastify/websocket": "^11.2.0",
+        "@rest-vir/define-service": "^0.21.0",
+        "@rest-vir/implement-service": "^0.21.0",
         "cluster-vir": "^0.1.0",
-        "date-vir": "^7.3.1",
-        "fastify": "^5.3.3",
+        "date-vir": "^7.4.0",
+        "fastify": "^5.4.0",
         "light-my-request": "^6.6.0",
         "portfinder": "^1.0.37",
         "type-fest": "^4.41.0",
         "url-vir": "^2.1.3"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.20.0",
+        "@augment-vir/test": "^31.28.0",
         "@fastify/multipart": "^9.0.3",
         "@types/connect": "^3.4.38",
-        "@types/node": "^22.15.21",
+        "@types/node": "^24.1.0",
         "@types/ws": "^8.18.1",
         "c8": "^10.1.3",
         "istanbul-smart-text-reporter": "^1.1.5",
         "markdown-code-example-inserter": "^3.0.3",
-        "object-shape-tester": "^5.1.5"
+        "object-shape-tester": "^5.3.0"
     },
     "peerDependencies": {
         "@augment-vir/test": ">=30",