feat: adding profiler to the core

Author: thetutlage

adonis-typings/index.ts

@@ -19,6 +19,7 @@
 /// <reference path="./http-context.ts" />
 /// <reference path="./logger.ts" />
 /// <reference path="./middleware-store.ts" />
+/// <reference path="./profiler.ts" />
 /// <reference path="./request-logger.ts" />
 /// <reference path="./request.ts" />
 /// <reference path="./response.ts" />

adonis-typings/profiler.ts

@@ -0,0 +1,25 @@
+/*
+* @adonisjs/core
+*
+* (c) Harminder Virk <[email protected]>
+*
+* For the full copyright and license information, please view the LICENSE
+* file that was distributed with this source code.
+*/
+
+/**
+ * The binding for the given module is defined inside `providers/AppProvider.ts`
+ * file.
+ */
+declare module '@ioc:Adonis/Core/Profiler' {
+  import { ProfilerContract as BaseContract, ProfilerConfig } from '@poppinss/profiler'
+
+  const Profiler: ProfilerContract
+
+  /**
+   * Module exports
+   */
+  export interface ProfilerContract extends BaseContract {}
+  export { ProfilerConfig as ProfilerConfigContract }
+  export default Profiler
+}

config/app.txt

@@ -11,6 +11,7 @@ import { LoggerConfigContract } from '@ioc:Adonis/Core/Logger'
 import { RequestConfigContract } from '@ioc:Adonis/Core/Request'
 import { ResponseConfigContract } from '@ioc:Adonis/Core/Response'
 import { RequestLoggerConfigContract } from '@ioc:Adonis/Core/RequestLogger'
+import { ProfilerConfigContract } from '@ioc:Adonis/Core/Profiler'
 
 type HttpOptions = RequestConfigContract & ResponseConfigContract & RequestLoggerConfigContract
 
@@ -193,3 +194,42 @@ export const logger: LoggerConfigContract = {
   */
   prettyPrint: Env.get('NODE_ENV') === 'development',
 }
+
+/*
+|--------------------------------------------------------------------------
+| Profiler
+|--------------------------------------------------------------------------
+*/
+export const profiler: ProfilerConfigContract = {
+  /*
+  |--------------------------------------------------------------------------
+  | Toggle profiler
+  |--------------------------------------------------------------------------
+  |
+  | Enable or disable profiler
+  |
+  */
+  enabled: true,
+
+  /*
+  |--------------------------------------------------------------------------
+  | Blacklist actions/row labels
+  |--------------------------------------------------------------------------
+  |
+  | Define an array of actions or row labels that you want to disable from
+  | getting profiled.
+  |
+  */
+  blacklist: [],
+
+  /*
+  |--------------------------------------------------------------------------
+  | Whitelist actions/row labels
+  |--------------------------------------------------------------------------
+  |
+  | Define an array of actions or row labels that you want to whitelist for
+  | the profiler. When whitelist is defined, then `blacklist` is ignored.
+  |
+  */
+  whitelist: [],
+}

package-lock.json

@@ -86,8 +86,9 @@
     "@poppinss/env": "^1.0.5",
     "@poppinss/events": "^1.0.1",
     "@poppinss/hash": "^1.0.3",
-    "@poppinss/http-server": "^1.2.0",
+    "@poppinss/http-server": "^1.2.1",
     "@poppinss/logger": "^1.1.2",
+    "@poppinss/profiler": "^1.0.0",
     "@poppinss/utils": "^1.0.4",
     "find-package-json": "^1.2.0",
     "ms": "^2.1.2",

package.json

@@ -17,6 +17,7 @@ import { requireAll } from '@poppinss/utils'
 import { IocContract } from '@adonisjs/fold'
 import { Response } from '@poppinss/response'
 import { ApplicationContract } from '@poppinss/application'
+import { Profiler } from '@poppinss/profiler'
 import { Server, HttpContext, MiddlewareStore, Router, routePreProcessor } from '@poppinss/http-server'
 
 import { envLoader } from '../src/envLoader'
@@ -63,6 +64,16 @@ export default class AppProvider {
     })
   }
 
+  /**
+   * Register profiler under `Adonis/Core/Profiler` namespace
+   */
+  protected $registerProfiler () {
+    this.$container.singleton('Adonis/Core/Profiler', () => {
+      const Config = this.$container.use('Adonis/Core/Config')
+      return new Profiler(Config.get('app.profiler', {}))
+    })
+  }
+
   /**
    * Registering the env binding to the container. We also parse the
    * contents of the `.env` and `.env.testing` files.
@@ -112,6 +123,7 @@ export default class AppProvider {
         this.$container.use('Adonis/Core/Route'),
         this.$container.use('Adonis/Core/MiddlewareStore'),
         this.$container.use('Adonis/Core/Logger'),
+        this.$container.use('Adonis/Core/Profiler'),
         Object.assign({ secret }, httpConfig),
       )
     })
@@ -179,6 +191,7 @@ export default class AppProvider {
     this.$registerEnv()
     this.$registerConfigProvider()
     this.$registerLogger()
+    this.$registerProfiler()
     this.$registerRequestResponse()
     this.$registerRouter()
     this.$registerMiddlewareStore()