@rest-vir/run-service 0.6.0 → 0.8.0

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

@@ -1,6 +1,6 @@
 import { assertWrap } from '@augment-vir/assert';
 import { ensureErrorAndPrependMessage, extractErrorMessage, HttpStatus, stringify, wrapInTry, } from '@augment-vir/common';
-import { matchUrlToService, restVirServiceNameHeader, } from '@rest-vir/define-service';
+import { isFormDataShape, matchUrlToService, restVirServiceNameHeader, } from '@rest-vir/define-service';
 import { HttpMethod, RestVirHandlerError, } from '@rest-vir/implement-service';
 import { assertValidShape, isValidShape } from 'object-shape-tester';
 import { handleHandlerResult } from './endpoint-handler.js';
@@ -55,7 +55,7 @@ export async function preHandler(request, response, service, attachId) {
         }), response).responseSent) {
         return;
     }
-    const requestData = wrapInTry(() => extractRequestData(request.body, route));
+    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)}`));
         response.statusCode = HttpStatus.BadRequest;
@@ -102,7 +102,7 @@ export async function preHandler(request, response, service, attachId) {
         throw ensureErrorAndPrependMessage(error, 'Failed to generate request context.');
     }
 }
-function extractRequestData(body, route) {
+function extractRequestData(body, headers, route) {
     const dataShape = 'requestDataShape' in route ? route.requestDataShape : undefined;
     if (!dataShape) {
         if (body) {
@@ -112,7 +112,10 @@ function extractRequestData(body, route) {
             return undefined;
         }
     }
-    if (!isValidShape(body, dataShape, {
+    if (isFormDataShape(dataShape.shape) && headers['content-type'] === 'multipart/form-data') {
+        return body;
+    }
+    else if (!isValidShape(body, dataShape, {
         /** Allow extra keys for forwards / backwards compatibility. */
         allowExtraKeys: true,
     })) {

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

@@ -1,7 +1,7 @@
 import { type SelectFrom } from '@augment-vir/common';
 import { GenericServiceImplementation } from '@rest-vir/implement-service';
 import { ClusterManager, type WorkerRunner } from 'cluster-vir';
-import { type FastifyInstance } from 'fastify';
+import { type FastifyInstance, type FastifyPluginCallback } from 'fastify';
 import { StartServiceUserOptions } from './start-service-options.js';
 /**
  * Output of {@link startService}.
@@ -42,6 +42,15 @@ export type StartServiceOutput = {
     /** A function that will kill the service even if it's using multiple workers. */
     kill: () => void;
 };
+/**
+ * A list of plugins and their options that will be registered on the internal fastify instance
+ * created by {@link startService}.
+ *
+ * @category Internal
+ * @category Package : @rest-vir/run-service
+ * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
+ */
+export type FastifyPlugins = [plugin: FastifyPluginCallback, options?: any][];
 /**
  * Starts the given {@link ServiceImplementation} inside of a backend [Fastify
  * server](https://www.npmjs.com/package/fastify).
@@ -60,4 +69,4 @@ export declare function startService(service: Readonly<SelectFrom<GenericService
     serviceOrigin: true;
     requiredClientOrigin: true;
     logger: true;
-}>>, userOptions?: Readonly<StartServiceUserOptions>): Promise<StartServiceOutput>;
+}>>, userOptions?: Readonly<StartServiceUserOptions>, fastifyPlugins?: Readonly<FastifyPlugins>): Promise<StartServiceOutput>;

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

@@ -1,4 +1,5 @@
 import { check } from '@augment-vir/assert';
+import { awaitedForEach } from '@augment-vir/common';
 import { ClusterManager, runInCluster } from 'cluster-vir';
 import fastify from 'fastify';
 import { getPortPromise } from 'portfinder';
@@ -14,7 +15,7 @@ import { finalizeOptions, } from './start-service-options.js';
  * @category Package : @rest-vir/run-service
  * @package [`@rest-vir/run-service`](https://www.npmjs.com/package/@rest-vir/run-service)
  */
-export async function startService(service, userOptions = {}) {
+export async function startService(service, userOptions = {}, fastifyPlugins = []) {
     const options = finalizeOptions(service.serviceOrigin, userOptions);
     const port = options.lockPort || check.isFalse(options.port)
         ? options.port
@@ -24,7 +25,7 @@ export async function startService(service, userOptions = {}) {
     options.port = port;
     if (options.workerCount === 1 || !check.isNumber(port)) {
         /** Only run a single server. */
-        const result = await startServer(service, options);
+        const result = await startServer(service, options, fastifyPlugins);
         if (options.port) {
             service.logger.info(`${service.serviceName} started on http://localhost:${options.port}`);
         }
@@ -33,7 +34,7 @@ export async function startService(service, userOptions = {}) {
     else {
         /** Run in a cluster. */
         const manager = runInCluster(async () => {
-            const { kill } = await startServer(service, options);
+            const { kill } = await startServer(service, options, fastifyPlugins);
             return () => {
                 kill();
             };
@@ -68,8 +69,11 @@ export async function startService(service, userOptions = {}) {
         }
     }
 }
-async function startServer(service, { host, port }) {
+async function startServer(service, { host, port }, fastifyPlugins) {
     const server = fastify();
+    await awaitedForEach(fastifyPlugins, async ([plugin, options,]) => {
+        await server.register(plugin, options);
+    });
     await attachService(server, service, {
         throwErrorsForExternalHandling: false,
     });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rest-vir/run-service",
-    "version": "0.6.0",
+    "version": "0.8.0",
     "description": "Run a service defined by @rest-vir/define-service and implemented by @rest-vir/implement-service.",
     "keywords": [
         "rest",
@@ -43,8 +43,8 @@
         "@augment-vir/common": "^31.9.4",
         "@augment-vir/node": "^31.9.4",
         "@fastify/websocket": "^11.0.2",
-        "@rest-vir/define-service": "^0.6.0",
-        "@rest-vir/implement-service": "^0.6.0",
+        "@rest-vir/define-service": "^0.8.0",
+        "@rest-vir/implement-service": "^0.8.0",
         "cluster-vir": "^0.1.0",
         "date-vir": "^7.2.1",
         "fastify": "^5.2.1",
@@ -55,6 +55,7 @@
     },
     "devDependencies": {
         "@augment-vir/test": "^31.9.4",
+        "@fastify/multipart": "^9.0.3",
         "@types/connect": "^3.4.38",
         "@types/node": "^22.13.9",
         "@types/ws": "^8.18.0",