Add better logger (#55)

README.md

@@ -10,10 +10,12 @@ traditional ORM.
 `workers-qb` is not intended to provide ORM-like functionality, rather to make it easier to interact with the database
 from code for direct SQL access using convenient wrapper methods.
 
-Currently, 2 databases are supported:
+Currently, 3 databases are supported:
 
-- [Cloudflare D1](https://developers.cloudflare.com/d1/)
-- [PostgreSQL (using node-postgres)](https://developers.cloudflare.com/workers/databases/connect-to-postgres/)
+- [Cloudflare D1](https://workers-qb.massadas.com/databases/cloudflare-d1/)
+- [Cloudflare Durable Objects](https://workers-qb.massadas.com/databases/cloudflare-do/)
+- [PostgreSQL (using node-postgres)](https://workers-qb.massadas.com/databases/postgresql/)
+- [Bring your own Database](https://workers-qb.massadas.com/databases/bring-your-own-database/)
 
 ## Features
 
@@ -22,11 +24,9 @@ Currently, 2 databases are supported:
 - [x] [Type Checks for data read](https://workers-qb.massadas.com/type-check/)
 - [x] [Create/drop tables](https://workers-qb.massadas.com/basic-queries/#dropping-and-creating-tables)
 - [x] [Insert/Bulk Inserts/Update/Select/Delete/Join queries](https://workers-qb.massadas.com/basic-queries/)
+- [x] [Modular selects](https://workers-qb.massadas.com/modular-selects/)
 - [x] [On Conflict for Inserts and Updates](https://workers-qb.massadas.com/advanced-queries/onConflict/)
 - [x] [Upsert](https://workers-qb.massadas.com/advanced-queries/upsert/)
-- [x] [Support for Cloudflare Workers D1](https://workers-qb.massadas.com/databases/cloudflare-d1/)
-- [x] [Support for Cloudflare Workers PostgreSQL (using node-postgres)](https://workers-qb.massadas.com/databases/postgresql/)
-- [ ] Named parameters (waiting for full support in D1)
 
 ## Installation
 

docs/mkdocs.yml

@@ -37,7 +37,7 @@ nav:
   - type-check.md
   - basic-queries.md
   - modular-selects.md
-  - utility-methods.md
+  - utilities.md
   - Advanced Queries:
       - advanced-queries/fields.md
       - advanced-queries/join.md
@@ -52,7 +52,7 @@ nav:
       - advanced-queries/raw-sql.md
   - Supported Databases:
       - databases/cloudflare-d1.md
-      - databases/cloudflare-do-srs.md
+      - databases/cloudflare-do.md
       - databases/postgresql.md
       - databases/bring-your-own-database.md
 markdown_extensions:

docs/pages/databases/cloudflare-d1.md

@@ -1,3 +1,5 @@
+# Cloudflare D1
+
 ## Create a database
 
 ```bash

docs/pages/databases/cloudflare-do-srs.md → docs/pages/databases/cloudflare-do.md

@@ -1,3 +1,5 @@
+# Cloudflare Durable Objects
+
 ## Write queries within your DO
 
 ```ts

docs/pages/databases/postgresql.md

@@ -1,3 +1,5 @@
+# PostgreSQL
+
 ## Create a database
 
 After creating your database, you must allow access from outside the private network, due to limitations on accessing

docs/pages/getting-started.md

@@ -34,6 +34,9 @@ export default {
       })
       .execute()
 
+    // Or in a modular approach
+    const employeeList = await qb.select<Employee>('employees').where('active = ?', true).execute()
+
     // You get IDE type hints on each employee data, like:
     // employeeList.results[0].name
 

docs/pages/index.md

@@ -1,5 +1,7 @@
 # workers-qb
 
+### [Read the documentation here!](https://workers-qb.massadas.com/)
+
 Zero dependencies Query Builder for [Cloudflare Workers](https://developers.cloudflare.com/workers/)
 
 This module provides a simple standardized interface while keeping the benefits and speed of using raw queries over a
@@ -8,10 +10,12 @@ traditional ORM.
 `workers-qb` is not intended to provide ORM-like functionality, rather to make it easier to interact with the database
 from code for direct SQL access using convenient wrapper methods.
 
-Currently, 2 databases are supported:
+Currently, 3 databases are supported:
 
-- [Cloudflare D1](https://developers.cloudflare.com/d1/)
-- [PostgreSQL (using node-postgres)](https://developers.cloudflare.com/workers/databases/connect-to-postgres/)
+- [Cloudflare D1](https://workers-qb.massadas.com/databases/cloudflare-d1/)
+- [Cloudflare Durable Objects](https://workers-qb.massadas.com/databases/cloudflare-do/)
+- [PostgreSQL (using node-postgres)](https://workers-qb.massadas.com/databases/postgresql/)
+- [Bring your own Database](https://workers-qb.massadas.com/databases/bring-your-own-database/)
 
 ## Features
 
@@ -20,8 +24,6 @@ Currently, 2 databases are supported:
 - [x] [Type Checks for data read](https://workers-qb.massadas.com/type-check/)
 - [x] [Create/drop tables](https://workers-qb.massadas.com/basic-queries/#dropping-and-creating-tables)
 - [x] [Insert/Bulk Inserts/Update/Select/Delete/Join queries](https://workers-qb.massadas.com/basic-queries/)
+- [x] [Modular selects](https://workers-qb.massadas.com/modular-selects/)
 - [x] [On Conflict for Inserts and Updates](https://workers-qb.massadas.com/advanced-queries/onConflict/)
 - [x] [Upsert](https://workers-qb.massadas.com/advanced-queries/upsert/)
-- [x] [Support for Cloudflare Workers D1](https://workers-qb.massadas.com/databases/cloudflare-d1/)
-- [x] [Support for Cloudflare Workers PostgreSQL (using node-postgres)](https://workers-qb.massadas.com/databases/postgresql/)
-- [ ] Named parameters (waiting for full support in D1)

docs/pages/utilities.md

@@ -0,0 +1,75 @@
+## .count()
+
+On selects, you have the option to `.count()` the rows without having to build a new query everytime.
+
+```ts
+import { OrderTypes } from 'workers-qb'
+const qb = new D1QB(env.DB)
+
+type EmployeeRoles = {
+  role: string
+  count: number
+}
+
+async function listEmployees(page = 0) {
+  const qs = qb.fetchAll<EmployeeRoles>({
+    tableName: 'employees',
+    limit: 20,
+    offset: page * 20,
+  })
+
+  const thisPageEmployees = await qs.execute()
+  const employeeCount = await qs.count()
+
+  return {
+    employees: thisPageEmployees.results,
+    total: employeeCount.results.total,
+  }
+}
+```
+
+## Logger
+
+To enable simple `console.log(...)` with the query and execution duration
+
+```ts
+const qb = new D1QB(env.DB)
+qb.setDebugger(true) // This call will define the default logger
+
+await qb
+  .fetchAll<EmployeeRoles>({
+    tableName: 'employees',
+    fields: ['id', 'name'],
+  })
+  .execute()
+```
+
+Running the example above will print into the console this:
+
+```
+[workers-qb][34ms] {"query": "SELECT id, name FROM employees"}
+```
+
+### Advanced Logger
+
+You can overwrite the default `console.log()` by passing a parameter to the query builder initializer
+
+```ts
+import { RawQuery, QueryLoggerMeta } from 'workers-qb'
+
+const qb = new D1QB(env.DB, {
+  logger: async (query: RawQuery, meta: QueryLoggerMeta) => {
+    // run your own logic
+    // query timmings available in meta.duration in milliseconds
+  },
+})
+
+await qb
+  .fetchAll<EmployeeRoles>({
+    tableName: 'employees',
+    fields: ['id', 'name'],
+  })
+  .execute()
+```
+
+With this, your function will always be called after the query is executed, even if the query throws an error.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "workers-qb",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "description": "Zero dependencies Query Builder for Cloudflare Workers",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

src/builder.ts

@@ -12,6 +12,8 @@ import {
   InsertWithoutReturning,
   Join,
   OneResult,
+  QueryBuilderOptions,
+  QueryLoggerMeta,
   RawQuery,
   RawQueryFetchAll,
   RawQueryFetchOne,
@@ -28,10 +30,44 @@ import { Query, QueryWithExtra, Raw } from './tools'
 import { SelectBuilder } from './modularBuilder'
 
 export class QueryBuilder<GenericResultWrapper> {
-  _debugger = false
+  protected options: QueryBuilderOptions
+
+  constructor(options?: QueryBuilderOptions) {
+    this.options = options || {}
+  }
 
   setDebugger(state: boolean): void {
-    this._debugger = state
+    if (state === true) {
+      if (this.options.logger) {
+        // a logger already exists, so it shouldn't be overwritten
+        return
+      }
+
+      this.options.logger = (query: RawQuery, meta: QueryLoggerMeta) => {
+        console.log(`[workers-qb][${meta.duration}ms] ${JSON.stringify(query)}`)
+      }
+    } else {
+      this.options.logger = undefined
+    }
+  }
+
+  async loggerWrapper(query: Query | Query[], innerFunction: () => any) {
+    const start = Date.now()
+    try {
+      return await innerFunction()
+    } catch (e) {
+      throw e
+    } finally {
+      if (this.options.logger) {
+        if (Array.isArray(query)) {
+          for (const q of query) {
+            await this.options.logger(q.toObject(), { duration: Date.now() - start })
+          }
+        } else {
+          await this.options.logger(query.toObject(), { duration: Date.now() - start })
+        }
+      }
+    }
   }
 
   async execute(query: Query): Promise<any> {