feat: add ctx property on request and response

Author: thetutlage

adonis-typings/request.ts

@@ -15,6 +15,7 @@ declare module '@ioc:Adonis/Core/Request' {
   import { UrlWithStringQuery } from 'url'
   import { MacroableConstructorContract } from 'macroable'
   import { EncryptionContract } from '@ioc:Adonis/Core/Encryption'
+  import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
   import { IncomingHttpHeaders, IncomingMessage, ServerResponse } from 'http'
 
   /**
@@ -24,7 +25,8 @@ declare module '@ioc:Adonis/Core/Request' {
     parsedUrl: UrlWithStringQuery
     request: IncomingMessage
     response: ServerResponse
-    id (): string | undefined,
+    ctx?: HttpContextContract
+    id (): string | undefined
     setInitialBody (body: any): void
     updateBody (body: any): void
     updateRawBody (body: string): void

adonis-typings/response.ts

@@ -15,6 +15,7 @@ declare module '@ioc:Adonis/Core/Response' {
   import { CookieOptions } from '@poppinss/cookie'
   import { ServerResponse, IncomingMessage } from 'http'
   import { MacroableConstructorContract } from 'macroable'
+  import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 
   /**
    * Types from which response header can be casted to a
@@ -57,6 +58,7 @@ declare module '@ioc:Adonis/Core/Response' {
     isPending: boolean
     request: IncomingMessage
     response: ServerResponse
+    ctx?: HttpContextContract
 
     getHeader (key: string): string | string[] | number | undefined
     header (key: string, value: CastableHeader): this

package-lock.json

@@ -92,7 +92,7 @@
     "anyBranch": false
   },
   "dependencies": {
-    "@poppinss/cookie": "^1.0.7",
+    "@poppinss/cookie": "^1.0.8",
     "@poppinss/utils": "^2.1.2",
     "accepts": "^1.3.7",
     "clone-deep": "^4.0.1",

package.json

@@ -53,6 +53,14 @@ export class HttpContext extends Macroable implements HttpContextContract {
     public profiler: ProfilerRowContract,
   ) {
     super()
+    /**
+     * Creating the circular reference. We do this, since request and response
+     * are meant to be extended and at times people would want to access
+     * other ctx properties like `logger`, `profiler` inside those
+     * extended methods.
+     */
+    this.request.ctx = this
+    this.response.ctx = this
   }
 
   /**

src/HttpContext/index.ts

@@ -33,6 +33,7 @@ import { parse as parseCookie } from '@poppinss/cookie'
 import { ServerResponse, IncomingMessage, IncomingHttpHeaders } from 'http'
 
 import { EncryptionContract } from '@ioc:Adonis/Core/Encryption'
+import { HttpContextContract } from '@ioc:Adonis/Core/HttpContext'
 import { RequestContract, RequestConfigContract } from '@ioc:Adonis/Core/Request'
 
 import { trustProxy } from '../helpers'
@@ -47,13 +48,6 @@ import { trustProxy } from '../helpers'
  * using `request.request` property.
  */
 export class Request extends Macroable implements RequestContract {
-  /**
-   * Parses copy of the URL with query string as a string and not
-   * object. This is done to build URL's with query string without
-   * stringifying the object
-   */
-  public parsedUrl: UrlWithStringQuery = parse(this.request.url!, false)
-
   /**
    * Request body set using `setBody` method
    */
@@ -100,6 +94,19 @@ export class Request extends Macroable implements RequestContract {
   protected static macros = {}
   protected static getters = {}
 
+  /**
+   * Parses copy of the URL with query string as a string and not
+   * object. This is done to build URL's with query string without
+   * stringifying the object
+   */
+  public parsedUrl: UrlWithStringQuery = parse(this.request.url!, false)
+
+  /**
+   * The ctx will be set by the context itself. It creates a circular
+   * reference
+   */
+  public ctx?: HttpContextContract
+
   constructor (
     public request: IncomingMessage,
     public response: ServerResponse,

src/Request/index.ts

@@ -110,6 +110,12 @@ class HttpException extends Exception {
  * 3. The call to `finish` method is a noop.
  */
 export class Response extends Macroable implements ResponseContract {
+  protected static macros = {}
+  protected static getters = {}
+
+  private headers: any = {}
+  private explicitStatus = false
+
   /**
    * Lazy body is used to set the response body. However, do not
    * write it on the socket immediately unless `response.finish`
@@ -119,11 +125,11 @@ export class Response extends Macroable implements ResponseContract {
    */
   public lazyBody: LazyBody | null = null
 
-  protected static macros = {}
-  protected static getters = {}
-
-  private headers: any = {}
-  private explicitStatus = false
+  /**
+   * The ctx will be set by the context itself. It creates a circular
+   * reference
+   */
+  public ctx?: HttpContextContract
 
   constructor (
     public request: IncomingMessage,

src/Response/index.ts

@@ -56,4 +56,13 @@ test.group('Http Context', () => {
     assert.equal(ctx.request.url(), '/1')
     assert.deepEqual(ctx.params, { id: '1' })
   })
+
+  test('pass ctx to request and response', async (assert) => {
+    const logger = new Logger({ enabled: true, name: 'adonis', level: 'trace' })
+    const profiler = new Profiler(__dirname, logger, {})
+
+    const ctx = HttpContext.create('/', {}, logger, profiler.create('ctx'), encryption)
+    assert.deepEqual(ctx.request.ctx, ctx)
+    assert.deepEqual(ctx.response.ctx, ctx)
+  })
 })