@rest-vir/run-service 0.19.1 → 0.20.0

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

@@ -34,7 +34,7 @@ export async function handleCors({ route, request, }) {
         };
     }
     else {
-        route.service.logger.error(new RestVirHandlerError(route, `CORS rejected for origin '${origin}'.`));
+        route.service.logger.error(new RestVirHandlerError(route, `CORS rejected for origin '${origin}'.`, HttpStatus.Forbidden));
         /** The CORS requirements for this request have not been met. */
         return {
             statusCode: HttpStatus.Forbidden,

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

@@ -11,6 +11,7 @@ import { assertValidShape } from 'object-shape-tester';
  */
 export async function handleEndpointRequest({ endpoint, request, response, attachId, server, }) {
     try {
+        // by this point in the request lifecycle, we know that these properties have been set.
         const restVirContext = request.restVirContext?.[attachId];
         assert.isDefined(restVirContext, 'restVirContext is not defined');
         const context = restVirContext.context;
@@ -36,7 +37,7 @@ export async function handleEndpointRequest({ endpoint, request, response, attac
             throw new RestVirHandlerError(endpoint, 'Missing response status code.');
         }
         if (isErrorHttpStatus(endpointResult.statusCode)) {
-            endpoint.service.logger.error(new RestVirHandlerError(endpoint, `Endpoint implementation returned error status: ${endpointResult.statusCode}`));
+            endpoint.service.logger.error(new RestVirHandlerError(endpoint, `Endpoint implementation returned error status: ${endpointResult.statusCode}`, endpointResult.statusCode));
             return {
                 statusCode: endpointResult.statusCode,
                 body: endpointResult.responseErrorMessage,

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}'`));
+        route.service.logger.error(new RestVirHandlerError(route, `Method '${requestMethod}' rejected: '${request.originalUrl}'`, HttpStatus.MethodNotAllowed));
         return {
             statusCode: HttpStatus.MethodNotAllowed,
         };

package/dist/handle-request/handle-search-params.js

@@ -20,7 +20,7 @@ export function handleSearchParams({ request, route, }) {
         })
         : undefined;
     if (validationError) {
-        route.service.logger.error(new RestVirHandlerError(route, `Search params failed for ${stringify(searchParams)}: ${validationError.message}`));
+        route.service.logger.error(new RestVirHandlerError(route, `Search params failed for ${stringify(searchParams)}: ${validationError.message}`, HttpStatus.BadRequest));
         return {
             body: 'Invalid search params.',
             statusCode: HttpStatus.BadRequest,

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

@@ -11,6 +11,7 @@ import { assertValidShape } from 'object-shape-tester';
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
 export async function handleWebSocketRequest({ attachId, request, implementedWebSocket, webSocket: wsWebSocket, server, }) {
+    // by this point in the request lifecycle, we know that these properties have been set.
     const restVirContext = request.restVirContext?.[attachId];
     assert.isDefined(restVirContext, 'restVirContext is not defined');
     const webSocket = overwriteWebSocketMethods(implementedWebSocket, wsWebSocket, WebSocketLocation.OnHost);

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

@@ -1,5 +1,5 @@
 import { assertWrap } from '@augment-vir/assert';
-import { ensureErrorAndPrependMessage, extractErrorMessage, HttpStatus, stringify, wrapInTry, } from '@augment-vir/common';
+import { ensureErrorAndPrependMessage, extractErrorMessage, getOrSet, HttpStatus, stringify, wrapInTry, } from '@augment-vir/common';
 import { isFormDataShape, matchUrlToService, restVirServiceNameHeader, } from '@rest-vir/define-service';
 import { HttpMethod, RestVirHandlerError, } from '@rest-vir/implement-service';
 import { assertValidShape, isValidShape } from 'object-shape-tester';
@@ -15,6 +15,12 @@ import { handleSearchParams } from './handle-search-params.js';
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
 export async function preHandler({ request, response, service, server, attachId, }) {
+    if (!request.restVirContext) {
+        request.restVirContext = {};
+    }
+    const attachedRestVirContext = getOrSet(request.restVirContext, attachId, () => {
+        return {};
+    });
     response.header(restVirServiceNameHeader, service.serviceName);
     const pathMatch = matchUrlToService(service, request.originalUrl);
     if (!pathMatch) {
@@ -40,12 +46,13 @@ export async function preHandler({ request, response, service, server, attachId,
         }))
         : undefined;
     if (protocolShapeError) {
-        service.logger.error(new RestVirHandlerError(route, extractErrorMessage(ensureErrorAndPrependMessage(protocolShapeError, `WebSocket protocols rejected (${stringify(protocols)}):`))));
+        service.logger.error(new RestVirHandlerError(route, extractErrorMessage(ensureErrorAndPrependMessage(protocolShapeError, `WebSocket protocols rejected (${stringify(protocols)}):`)), HttpStatus.BadRequest));
         return {
             statusCode: HttpStatus.BadRequest,
             body: 'Invalid protocol.',
         };
     }
+    attachedRestVirContext.protocols = protocols;
     const subHandlerResponse = handleHandlerOutputWithoutSending(await handleCors({
         request,
         route,
@@ -59,16 +66,18 @@ export async function preHandler({ request, response, service, server, attachId,
     }
     const requestData = wrapInTry(() => extractRequestData(request.body, request.headers, route));
     if (requestData instanceof Error) {
-        service.logger.error(new RestVirHandlerError(route, `Rejected request body from '${request.originalUrl}': ${stringify(requestData)}`));
+        service.logger.error(new RestVirHandlerError(route, `Rejected request body from '${request.originalUrl}': ${stringify(requestData)}`, HttpStatus.BadRequest));
         return {
             statusCode: HttpStatus.BadRequest,
             body: 'Invalid body.',
         };
     }
+    attachedRestVirContext.requestData = requestData;
     const searchParams = handleSearchParams({ request, route });
     if (!('data' in searchParams)) {
         return handleHandlerOutputWithoutSending(searchParams, response);
     }
+    attachedRestVirContext.searchParams = searchParams.data;
     const contextParams = {
         pathParams: request.params,
         method: assertWrap.isEnumValue(request.method.toUpperCase(), HttpMethod),
@@ -84,23 +93,15 @@ export async function preHandler({ request, response, service, server, attachId,
     };
     try {
         const contextOutput = await service.createContext?.(contextParams);
-        if (!request.restVirContext) {
-            request.restVirContext = {};
-        }
-        request.restVirContext[attachId] = {
-            context: contextOutput?.reject ? undefined : contextOutput?.context,
-            requestData,
-            protocols,
-            searchParams: searchParams.data,
-        };
         if (contextOutput?.reject) {
-            service.logger.error(new RestVirHandlerError(route, `Context creation rejected: '${request.originalUrl}'`));
+            service.logger.error(new RestVirHandlerError(route, `Context creation rejected: '${request.originalUrl}'`, contextOutput.reject.statusCode));
             return handleHandlerOutputWithoutSending({
                 body: contextOutput.reject.responseErrorMessage,
                 statusCode: contextOutput.reject.statusCode,
                 headers: contextOutput.reject.headers,
             }, response);
         }
+        attachedRestVirContext.context = contextOutput?.context;
         return undefined;
     }
     catch (error) {

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

@@ -3,15 +3,23 @@ import { type BaseSearchParams, type MinimalService } from '@rest-vir/define-ser
 import { type GenericServiceImplementation, type RunningServerInfo } from '@rest-vir/implement-service';
 import { type FastifyInstance } from 'fastify';
 import { type HandleRouteOptions } from '../handle-request/endpoint-handler.js';
+/**
+ * Context attached to each fastify request object.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export type RestVirRequestContext = {
+    context: unknown;
+    requestData: unknown;
+    protocols: string[];
+    searchParams: BaseSearchParams;
+};
 declare module 'fastify' {
     interface FastifyRequest {
         restVirContext: {
-            [AttachId in string]: {
-                context: unknown;
-                requestData: unknown;
-                protocols: string[];
-                searchParams: BaseSearchParams;
-            };
+            [AttachId in string]: Partial<RestVirRequestContext>;
         } | undefined;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/run-service",
-    "version": "0.19.1",
+    "version": "0.20.0",
     "description": "Run a service defined by @rest-vir/define-service and implemented by @rest-vir/implement-service.",
     "keywords": [
         "rest",
@@ -39,12 +39,12 @@
         "test:update": "npm test update"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.19.1",
-        "@augment-vir/common": "^31.19.1",
-        "@augment-vir/node": "^31.19.1",
+        "@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.19.1",
-        "@rest-vir/implement-service": "^0.19.1",
+        "@rest-vir/define-service": "^0.20.0",
+        "@rest-vir/implement-service": "^0.20.0",
         "cluster-vir": "^0.1.0",
         "date-vir": "^7.3.1",
         "fastify": "^5.3.3",
@@ -54,10 +54,10 @@
         "url-vir": "^2.1.3"
     },
     "devDependencies": {
-        "@augment-vir/test": "^31.19.1",
+        "@augment-vir/test": "^31.20.0",
         "@fastify/multipart": "^9.0.3",
         "@types/connect": "^3.4.38",
-        "@types/node": "^22.15.18",
+        "@types/node": "^22.15.21",
         "@types/ws": "^8.18.1",
         "c8": "^10.1.3",
         "istanbul-smart-text-reporter": "^1.1.5",