feat: add way to register data context in routes

.github/workflows/cd.yml

@@ -5,6 +5,10 @@ on:
     branches:
       - main
 
+permissions:
+  contents: read
+  id-token: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -18,6 +22,9 @@ jobs:
           node-version: '21.x'
           registry-url: 'https://registry.npmjs.org'
 
+      - name: Update npm
+        run: npm i -g npm@latest
+
       - name: Install dependencies
         run: npm install
 
@@ -32,8 +39,7 @@ jobs:
         id: release
 
       - name: Publish to NPM Registry
-        run: cd build && npm publish --access public
+        run: cd build && npm publish --provenance --access public
         if: steps.release.outputs.released == 'true'
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
           name: Deploy

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/http",
-  "version": "5.40.0",
+  "version": "5.41.0",
   "description": "The Athenna Http server. Built on top of fastify.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

src/router/Route.ts

@@ -29,6 +29,7 @@ export class Route extends Macroable {
    */
   public route: {
     url?: string
+    data?: Record<string, any>
     methods: HTTPMethods[]
     handler?: RequestHandler
     name?: string
@@ -48,6 +49,7 @@ export class Route extends Macroable {
     this.route = {
       url,
       methods,
+      data: {},
       deleted: false,
       prefixes: [],
       middlewares: {
@@ -117,6 +119,30 @@ export class Route extends Macroable {
     return this
   }
 
+  /**
+   * Define data values for the route. Data values will be available in the
+   * request context.
+   *
+   * @example
+   * ```ts
+   * Route.data({ permission: 'post:create' }).post('/posts', ({ data }) => {
+   *  console.log(data.permission)
+   * })
+   * ```
+   *
+   */
+  public data(data: Record<string, any> | string, value?: any): Route {
+    if (Is.String(data)) {
+      this.route.data[data] = value
+
+      return this
+    }
+
+    this.route.data = data
+
+    return this
+  }
+
   /**
    * Set a prefix for the route.
    *
@@ -608,6 +634,7 @@ export class Route extends Macroable {
   public toJSON(): RouteJson {
     return {
       url: this.getUrl(),
+      data: this.route.data,
       methods: this.route.methods,
       name: this.route.name,
       deleted: this.route.deleted,

src/server/ServerImpl.ts

@@ -31,7 +31,7 @@ import type {
 
 import type { AddressInfo } from 'node:net'
 import type { FastifyVite } from '@athenna/vite'
-import { Options, Macroable } from '@athenna/common'
+import { Options, Macroable, Is } from '@athenna/common'
 import { FastifyHandler } from '#src/handlers/FastifyHandler'
 
 export class ServerImpl extends Macroable {
@@ -278,6 +278,9 @@ export class ServerImpl extends Macroable {
     const { middlewares, interceptors, terminators } = options.middlewares
 
     const route: RouteOptions = {
+      onSend: [],
+      preHandler: [],
+      onResponse: [],
       url: options.url,
       method: options.methods,
       handler: FastifyHandler.request(options.handler)
@@ -295,6 +298,13 @@ export class ServerImpl extends Macroable {
       route.onResponse = terminators.map(t => FastifyHandler.terminate(t))
     }
 
+    if (options.data && Is.Array(route.preHandler)) {
+      route.preHandler?.unshift((req, _, done) => {
+        req.data = options.data
+        done()
+      })
+    }
+
     this.fastify.route({ ...route, ...options.fastify })
   }
 

src/types/router/RouteJson.ts

@@ -12,6 +12,7 @@ import type { RequestHandler, MiddlewareRecord } from '#src/types'
 
 export type RouteJson = {
   url: string
+  data?: Record<string, any>
   methods?: HTTPMethods[]
   name?: string
   deleted?: boolean

tests/fixtures/controllers/HelloController.ts

@@ -53,4 +53,8 @@ export class HelloController {
   async vanillaError() {
     throw new Error('error')
   }
+
+  async data(ctx: Context) {
+    return ctx.response.send({ data: ctx.data })
+  }
 }

tests/unit/router/RouteTest.ts

@@ -175,7 +175,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         responses: { '200': { description: 'Default Response' } },
         parameters: [
@@ -202,7 +202,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         responses: { '200': { description: 'Default Response' } },
         parameters: [
@@ -227,7 +227,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         responses: {
           '200': {
@@ -261,7 +261,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         responses: {
           '200': {
@@ -295,7 +295,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         responses: {
           '200': {
@@ -335,7 +335,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         responses: {
           '200': {
@@ -367,7 +367,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         security: [{ apiKey: ['123', '321'] }],
         responses: { '200': { description: 'Default Response' } }
@@ -383,7 +383,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         responses: { '200': { description: 'Default Response' } },
         externalDocs: { url: 'https://athenna.io', description: 'Athenna documentation' }
@@ -399,7 +399,7 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         consumes: ['json', 'yaml'],
         responses: { '200': { description: 'Default Response' } }
@@ -415,11 +415,22 @@ export default class RouteTest {
 
     const swagger = await Server.getSwagger()
 
-    assert.containsSubset(swagger.paths['/test'], {
+    assert.containSubset(swagger.paths['/test'], {
       post: {
         produces: ['json', 'yaml'],
         responses: { '200': { description: 'Default Response' } }
       }
     })
   }
+
+  @Test()
+  public async shouldBeAbleToSetDataInTheRoute({ assert }: Context) {
+    Route.post('test', new HelloController().data).data({ permission: 'post:create' })
+
+    Route.register()
+
+    const response = await Server.request({ path: '/test', method: 'post' })
+
+    assert.deepEqual(await response.json(), { data: { permission: 'post:create' } })
+  }
 }