Merge pull request #213 from AthennaIO/develop

feat: add @fastify/multipart

Author: jlenon7

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "5.27.0",
+  "version": "5.28.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -85,6 +85,7 @@
     "@athenna/vite": "^5.13.0",
     "@fastify/cors": "^10.0.2",
     "@fastify/helmet": "^13.0.1",
+    "@fastify/multipart": "^9.0.3",
     "@fastify/rate-limit": "^10.2.2",
     "@fastify/static": "^8.0.4",
     "@fastify/swagger": "^9.4.2",

package.json

@@ -7,9 +7,15 @@
  * file that was distributed with this source code.
  */
 
+import type {
+  SavedMultipartFile,
+  FastifyMultipartBaseOptions
+} from '@fastify/multipart'
+
 import type { AddressInfo } from 'node:net'
 import type { FastifyRequest } from 'fastify'
 import { Is, Json, Macroable } from '@athenna/common'
+import type { BusboyConfig } from '@fastify/busboy'
 
 export class Request extends Macroable {
   /**
@@ -351,6 +357,69 @@ export class Request extends Macroable {
     return body
   }
 
+  /**
+   * Check if the request is multipart.
+   */
+  public isMultipart() {
+    return this.request.isMultipart()
+  }
+
+  /**
+   * Get the form data from the request.
+   */
+  public formData(): Promise<FormData> {
+    return this.request.formData()
+  }
+
+  /**
+   * Get the parts from the request.
+   */
+  public parts(options?: Omit<BusboyConfig, 'headers'>) {
+    return this.request.parts(options)
+  }
+
+  /**
+   * Get the file from the request.
+   */
+  public file(
+    options?: Omit<BusboyConfig, 'headers'> | FastifyMultipartBaseOptions
+  ) {
+    return this.request.file(options)
+  }
+
+  /**
+   * Get the files from the request.
+   */
+  public files(
+    options?: Omit<BusboyConfig, 'headers'> | FastifyMultipartBaseOptions
+  ) {
+    return this.request.files(options)
+  }
+
+  /**
+   * Save the files from the request.
+   */
+  public saveRequestFiles(
+    options?: Omit<BusboyConfig, 'headers'> & { tmpdir?: string }
+  ) {
+    return this.request.saveRequestFiles(options)
+  }
+
+  /**
+   * Clean the files from the request.
+   */
+  public cleanRequestFiles() {
+    return this.request.cleanRequestFiles()
+  }
+
+  /**
+   * This will get populated as soon as a call to `saveRequestFiles` gets resolved.
+   * Avoiding any future duplicate work
+   */
+  public get savedRequestFiles(): SavedMultipartFile[] | null {
+    return this.request.savedRequestFiles
+  }
+
   /**
    * Get the original fastify request.
    */

src/context/Request.ts

@@ -18,20 +18,13 @@ import { Annotation, type ServiceMeta } from '@athenna/ioc'
 import { File, Path, Module, String } from '@athenna/common'
 import { HttpExceptionHandler } from '#src/handlers/HttpExceptionHandler'
 
-const corsPlugin = await Module.safeImport('@fastify/cors')
-const helmetPlugin = await Module.safeImport('@fastify/helmet')
-const swaggerPlugin = await Module.safeImport('@fastify/swagger')
-const swaggerUiPlugin = await Module.safeImport('@fastify/swagger-ui')
-const rateLimitPlugin = await Module.safeImport('@fastify/rate-limit')
-const staticPlugin = await Module.safeImport('@fastify/static')
-const rTracerPlugin = await Module.safeImport('cls-rtracer')
-const vitePlugin = await Module.safeImport('@athenna/vite/plugins/fastify')
-
 export class HttpKernel {
   /**
    * Register the @fastify/cors plugin in the Http server.
    */
   public async registerCors(): Promise<void> {
+    const corsPlugin = await Module.safeImport('@fastify/cors')
+
     if (Config.is('http.cors.enabled', false)) {
       debug(
         'Not able to register cors plugin. Set the http.cors.enabled configuration as true.'
@@ -53,6 +46,8 @@ export class HttpKernel {
    * Register the @fastify/helmet plugin in the Http server.
    */
   public async registerHelmet(): Promise<void> {
+    const helmetPlugin = await Module.safeImport('@fastify/helmet')
+
     if (Config.is('http.helmet.enabled', false)) {
       debug(
         'Not able to register helmet plugin. Set the http.helmet.enabled configuration as true.'
@@ -76,6 +71,9 @@ export class HttpKernel {
    * Register the @fastify/swagger plugin in the Http server.
    */
   public async registerSwagger(): Promise<void> {
+    const swaggerPlugin = await Module.safeImport('@fastify/swagger')
+    const swaggerUiPlugin = await Module.safeImport('@fastify/swagger-ui')
+
     if (Config.is('http.swagger.enabled', false)) {
       debug(
         'Not able to register swagger plugin. Set the http.swagger.enabled configuration as true.'
@@ -129,6 +127,8 @@ export class HttpKernel {
    * Register the @fastify/rate-limit plugin in the Http server.
    */
   public async registerRateLimit(): Promise<void> {
+    const rateLimitPlugin = await Module.safeImport('@fastify/rate-limit')
+
     if (Config.is('http.rateLimit.enabled', false)) {
       debug(
         'Not able to register rate limit plugin. Set the http.rateLimit.enabled configuration as true.'
@@ -152,6 +152,8 @@ export class HttpKernel {
    * Register the @fastify/static plugin in the Http server.
    */
   public async registerStatic(): Promise<void> {
+    const staticPlugin = await Module.safeImport('@fastify/static')
+
     if (Config.is('http.static.enabled', false)) {
       debug(
         'Not able to register static plugin. Set the http.static.enabled configuration as true.'
@@ -175,6 +177,8 @@ export class HttpKernel {
    * Register the cls-rtracer plugin in the Http server.
    */
   public async registerRTracer(trace?: boolean): Promise<void> {
+    const rTracerPlugin = await Module.safeImport('cls-rtracer')
+
     if (trace === false) {
       debug(
         'Not able to register rTracer plugin. Set the trace option as true in your http server options.'
@@ -209,6 +213,8 @@ export class HttpKernel {
    * Register the @athenna/vite plugin in the Http server.
    */
   public async registerVite(trace?: boolean): Promise<void> {
+    const vitePlugin = await Module.safeImport('@athenna/vite/plugins/fastify')
+
     if (trace === false) {
       debug(
         'Not able to register vite plugin. Set the trace option as true in your http server options.'
@@ -234,6 +240,31 @@ export class HttpKernel {
     await Server.plugin(vitePlugin, this.getConfig('http.vite'))
   }
 
+  /**
+   * Register the @fastify/multipart plugin in the Http server.
+   */
+  public async registerMultipart(): Promise<void> {
+    const multipartPlugin = await Module.safeImport('@fastify/multipart')
+
+    if (Config.is('http.multipart.enabled', false)) {
+      debug(
+        'Not able to register multipart plugin. Set the http.multipart.enabled configuration as true.'
+      )
+
+      return
+    }
+
+    if (!multipartPlugin) {
+      debug(
+        'Not able to register multipart plugin. Install @fastify/multipart package.'
+      )
+
+      return
+    }
+
+    await Server.plugin(multipartPlugin, this.getConfig('http.multipart'))
+  }
+
   /**
    * Register the global log terminator in the Http server.
    */

src/kernels/HttpKernel.ts

@@ -61,6 +61,14 @@ export default class HttpKernelTest {
     assert.isTrue(Server.fastify.hasPlugin('@fastify/helmet'))
   }
 
+  @Test()
+  public async shouldBeAbleToRegisterTheFastifyMultipartPluginInTheHttpServer({ assert }: Context) {
+    const kernel = new HttpKernel()
+    await kernel.registerMultipart()
+
+    assert.isTrue(Server.fastify.hasPlugin('@fastify/multipart'))
+  }
+
   @Test()
   public async shouldBeAbleToRegisterTheFastifySwaggerPluginInTheHttpServer({ assert }: Context) {
     const kernel = new HttpKernel()
@@ -178,6 +186,18 @@ export default class HttpKernelTest {
     assert.isFalse(Server.fastify.hasPlugin('@fastify/helmet'))
   }
 
+  @Test()
+  @Cleanup(() => Config.set('http.multipart.enabled', true))
+  public async shouldNotRegisterTheFastifyMultipartPluginIfTheConfigurationIsDisabled({ assert }: Context) {
+    Config.set('http.multipart.enabled', false)
+
+    const { HttpKernel } = await import(`../../../src/kernels/HttpKernel.js?v=${Math.random()}`)
+    const kernel = new HttpKernel()
+    await kernel.registerMultipart()
+
+    assert.isFalse(Server.fastify.hasPlugin('@fastify/multipart'))
+  }
+
   @Test()
   public async shouldNotRegisterTheFastifySwaggerPluginIfThePackageIsNotInstalled({ assert }: Context) {
     Mock.when(Module, 'safeImport').resolve(null)