refactor: use unscoped profiler by default

adonis-typings/querybuilder.ts

@@ -10,7 +10,7 @@
 declare module '@ioc:Adonis/Addons/DatabaseQueryBuilder' {
   import * as knex from 'knex'
   import { Dictionary } from 'ts-essentials'
-  import { ProfilerRowContract } from '@poppinss/profiler'
+  import { ProfilerRowContract, ProfilerContract } from '@poppinss/profiler'
 
   /**
    * The types for values for the aggregates. We need this coz of
@@ -927,7 +927,7 @@ declare module '@ioc:Adonis/Addons/DatabaseQueryBuilder' {
     /**
      * Custom profiler to time queries
      */
-    profiler?: ProfilerRowContract
+    profiler?: ProfilerRowContract | ProfilerContract
 
     /**
      * Tells if client is a transaction client or not

package.json

@@ -29,7 +29,7 @@
   "homepage": "https://github.com/adonisjs/adonis-lucid#readme",
   "dependencies": {
     "@poppinss/logger": "^1.1.2",
-    "@poppinss/profiler": "^1.0.0",
+    "@poppinss/profiler": "^1.1.0",
     "@poppinss/utils": "^1.0.4",
     "knex": "^0.19.2",
     "knex-dynamic-connection": "^1.0.0",

src/Database/index.ts

@@ -67,12 +67,12 @@ export class Database implements DatabaseContract {
    */
   public connection (
     connection: string = this.primaryConnectionName,
-    options?: Partial<{ mode: 'read' | 'write', profiler: ProfilerRowContract }>,
+    options?: Partial<{ mode: 'read' | 'write', profiler: ProfilerRowContract | ProfilerContract }>,
   ) {
     options = options || {}
 
     if (!options.profiler) {
-      options.profiler = this._profiler.create('')
+      options.profiler = this._profiler
     }
 
     /**

src/QueryClient/index.ts

@@ -11,7 +11,7 @@
 
 import * as knex from 'knex'
 import { Exception } from '@poppinss/utils'
-import { ProfilerRowContract } from '@poppinss/profiler'
+import { ProfilerRowContract, ProfilerContract } from '@poppinss/profiler'
 import { resolveClientNameWithAliases } from 'knex/lib/helpers'
 
 import {
@@ -47,7 +47,7 @@ export class QueryClient implements QueryClientContract {
   /**
    * The profiler to be used for profiling queries
    */
-  public profiler?: ProfilerRowContract
+  public profiler?: ProfilerRowContract | ProfilerContract
 
   /**
    * Name of the connection in use
@@ -121,7 +121,10 @@ export class QueryClient implements QueryClientContract {
    */
   public async transaction (): Promise<TransactionClientContract> {
     const trx = await this.getWriteClient().transaction()
-    return new TransactionClient(trx, this.dialect, this.connectionName)
+    const transaction = new TransactionClient(trx, this.dialect, this.connectionName)
+    transaction.profiler = this.profiler
+
+    return transaction
   }
 
   /**

src/TransactionClient/index.ts

@@ -10,7 +10,7 @@
 /// <reference path="../../adonis-typings/database.ts" />
 
 import * as knex from 'knex'
-import { ProfilerRowContract } from '@poppinss/profiler'
+import { ProfilerRowContract, ProfilerContract } from '@poppinss/profiler'
 import { TransactionClientContract } from '@ioc:Adonis/Addons/DatabaseQueryBuilder'
 
 import {
@@ -42,7 +42,7 @@ export class TransactionClient implements TransactionClientContract {
   /**
    * The profiler to be used for profiling queries
    */
-  public profiler?: ProfilerRowContract
+  public profiler?: ProfilerRowContract | ProfilerContract
 
   constructor (
     public knexClient: knex.Transaction,
@@ -110,7 +110,9 @@ export class TransactionClient implements TransactionClientContract {
    */
   public async transaction (): Promise<TransactionClientContract> {
     const trx = await this.knexClient.transaction()
-    return new TransactionClient(trx, this.dialect, this.connectionName)
+    const transaction = new TransactionClient(trx, this.dialect, this.connectionName)
+    transaction.profiler = this.profiler
+    return transaction
   }
 
   /**

src/utils/index.ts

@@ -10,7 +10,7 @@
 /// <reference path="../../adonis-typings/database.ts" />
 
 import * as knex from 'knex'
-import { ProfilerRowContract } from '@poppinss/profiler'
+import { ProfilerRowContract, ProfilerContract } from '@poppinss/profiler'
 import { ProfilerActionContract } from '@poppinss/profiler/build/src/Contracts'
 import { QueryClientContract } from '@ioc:Adonis/Addons/DatabaseQueryBuilder'
 
@@ -20,7 +20,7 @@ import { QueryClientContract } from '@ioc:Adonis/Addons/DatabaseQueryBuilder'
  */
 function getProfilerAction (
   builder: knex.QueryBuilder | knex.Raw,
-  profiler?: ProfilerRowContract,
+  profiler?: ProfilerRowContract | ProfilerContract,
   profilerData?: any,
 ) {
   if (!profiler) {
@@ -63,7 +63,7 @@ export function isInTransaction (
 export async function executeQuery (
   builder: knex.QueryBuilder | knex.Raw,
   knexClient?: knex,
-  profiler?: ProfilerRowContract,
+  profiler?: ProfilerRowContract | ProfilerContract,
   profilerData?: any,
 ) {
   let action = getProfilerAction(builder, profiler, profilerData)

test/database.spec.ts

@@ -151,4 +151,72 @@ test.group('Database', (group) => {
     assert.isDefined(result)
     await db.manager.closeAll()
   })
+
+  test('pass profiler to query client', async (assert) => {
+    const config = {
+      connection: 'primary',
+      connections: { primary: getConfig() },
+    }
+
+    const profiler = getProfiler()
+    const db = new Database(config, getLogger(), profiler)
+    const client = db.connection('primary')
+    assert.deepEqual(client.profiler, profiler)
+
+    await db.manager.closeAll()
+  })
+
+  test('pass custom profiler to query client', async (assert) => {
+    const config = {
+      connection: 'primary',
+      connections: { primary: getConfig() },
+    }
+
+    const profiler = getProfiler()
+    const row = profiler.create('scoped')
+
+    const db = new Database(config, getLogger(), profiler)
+    const client = db.connection('primary', { profiler: row })
+    assert.deepEqual(client.profiler, row)
+
+    await db.manager.closeAll()
+  })
+
+  test('forward profiler to transaction client', async (assert) => {
+    const config = {
+      connection: 'primary',
+      connections: { primary: getConfig() },
+    }
+
+    const profiler = getProfiler()
+
+    const db = new Database(config, getLogger(), profiler)
+    const client = db.connection('primary')
+    const trx = await client.transaction()
+    assert.equal(trx.profiler, profiler)
+
+    await trx.rollback()
+    await db.manager.closeAll()
+  })
+
+  test('forward profiler to nested transaction client', async (assert) => {
+    const config = {
+      connection: 'primary',
+      connections: { primary: getConfig() },
+    }
+
+    const profiler = getProfiler()
+
+    const db = new Database(config, getLogger(), profiler)
+    const client = db.connection('primary')
+    const trx = await client.transaction()
+    const trx1 = await trx.transaction()
+
+    assert.equal(trx.profiler, profiler)
+    assert.equal(trx1.profiler, profiler)
+
+    await trx1.rollback()
+    await trx.rollback()
+    await db.manager.closeAll()
+  })
 })