adding before hooks in engine and all the connections

Author: cblanquera

examples/with-mysql2/package.json

@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@stackpress/inquire-mysql2": "0.7.2",
-    "mysql2": "3.16.0"
+    "mysql2": "3.22.0"
   },
   "devDependencies": {
     "@types/node": "25.0.3",

packages/inquire-mysql2/package.json

@@ -76,7 +76,7 @@
     "chai": "4.5.0",
     "mocha": "10.8.2",
     "ts-mocha": "10.0.0",
-    "mysql2": "3.16.0",
+    "mysql2": "3.22.0",
     "ts-node": "10.9.2",
     "tsx": "4.21.0",
     "typescript": "5.9.3"

packages/inquire-mysql2/src/Connection.ts

@@ -18,6 +18,16 @@ export default class Mysql2Connection implements Connection<Resource> {
   protected _lastId?: number|string;
   //the database connection
   protected _resource: Connector;
+  //A hook used for logging purposes. Can also manipulate the final 
+  // query before execution.
+  protected _before = async (_request: QueryObject) => {};
+
+  /**
+   * Returns the before hook
+   */
+  public get before() {
+    return this._before;
+  }
 
   /**
    * Get the last inserted id
@@ -26,6 +36,13 @@ export default class Mysql2Connection implements Connection<Resource> {
     return this._lastId;
   }
 
+  /**
+   * Sets the before hook
+   */
+  public set before(before: (request: QueryObject) => Promise<void>) {
+    this._before = before;
+  }
+
   /**
    * Set the connection
    */
@@ -108,8 +125,13 @@ export default class Mysql2Connection implements Connection<Resource> {
    * Call the database. If no values are provided, use exec
    */
   protected async _query<R = unknown>(request: QueryObject) {
+    //allow last minute request manipulation
+    await this._before(request);
+    //extract the query and values from the request
     const { query, values = [] } = request;
+    //get the proprietary resource
     const resource = await this.resource();
+    //query the database and return the results
     const results = await resource.execute(query, values);
     if (Array.isArray(results[0])) {
       return results as Results<R>;

packages/inquire-pg/src/Connection.ts

@@ -15,6 +15,16 @@ export default class PGConnection implements Connection<Resource> {
   public readonly dialect: Dialect = Pgsql;
   //the database connection
   protected _resource: Connector;
+  //A hook used for logging purposes. Can also manipulate the final 
+  // query before execution.
+  protected _before = async (_request: QueryObject) => {};
+
+  /**
+   * Returns the before hook
+   */
+  public get before() {
+    return this._before;
+  }
 
   /**
    * Get the last inserted id
@@ -23,6 +33,13 @@ export default class PGConnection implements Connection<Resource> {
     return undefined;
   }
 
+  /**
+   * Sets the before hook
+   */
+  public set before(before: (request: QueryObject) => Promise<void>) {
+    this._before = before;
+  }
+
   /**
    * Set the connection
    */
@@ -116,8 +133,13 @@ export default class PGConnection implements Connection<Resource> {
    * Call the database. If no values are provided, use exec
    */
   protected async _query<R = unknown>(request: QueryObject) {
+    //allow last minute request manipulation
+    await this._before(request);
+    //extract the query and values from the request
     const { query, values = [] } = request;
+    //get the proprietary resource
     const resource = await this.resource();
+    //query the database and return the results
     return (await resource.query(query, values)) as Results<R>;
   }
 }

packages/inquire-pglite/src/Connection.ts

@@ -17,6 +17,16 @@ export default class PGLiteConnection implements Connection<Resource> {
   public readonly dialect: Dialect = Pgsql;
   //the database connection
   protected _resource: Connector;
+  //A hook used for logging purposes. Can also manipulate the final 
+  // query before execution.
+  protected _before = async (_request: QueryObject) => {};
+
+  /**
+   * Returns the before hook
+   */
+  public get before() {
+    return this._before;
+  }
 
   /**
    * Get the last inserted id
@@ -25,6 +35,13 @@ export default class PGLiteConnection implements Connection<Resource> {
     return undefined;
   }
 
+  /**
+   * Sets the before hook
+   */
+  public set before(before: (request: QueryObject) => Promise<void>) {
+    this._before = before;
+  }
+
   /**
    * Set the connection
    */
@@ -122,7 +139,11 @@ export default class PGLiteConnection implements Connection<Resource> {
     request: QueryObject, 
     resource: Resource|TX
   ) {
+    //allow last minute request manipulation
+    await this._before(request);
+    //extract the query and values from the request
     const { query, values = [] } = request;
+    //query the database and return the results
     return values.length === 0
       ? (await resource.exec(query))[0] as Results<R>
       : await resource.query(query, values) as Results<R>;

packages/inquire-sqlite3/src/Connection.ts

@@ -16,6 +16,16 @@ export default class BetterSqlite3Connection implements Connection<Resource> {
   protected _lastId?: number|string;
   //the database connection
   protected _resource: Connector;
+  //A hook used for logging purposes. Can also manipulate the final 
+  // query before execution.
+  protected _before = async (_request: QueryObject) => {};
+
+  /**
+   * Returns the before hook
+   */
+  public get before() {
+    return this._before;
+  }
 
   /**
    * Get the last inserted id
@@ -24,6 +34,13 @@ export default class BetterSqlite3Connection implements Connection<Resource> {
     return this._lastId;
   }
 
+  /**
+   * Sets the before hook
+   */
+  public set before(before: (request: QueryObject) => Promise<void>) {
+    this._before = before;
+  }
+
   /**
    * Set the connection
    */
@@ -107,7 +124,11 @@ export default class BetterSqlite3Connection implements Connection<Resource> {
    * Call the database. If no values are provided, use exec
    */
   protected async _query<R = unknown>(request: QueryObject) {
+    //allow last minute request manipulation
+    await this._before(request);
+    //extract the query and values from the request
     const { query, values = [] } = request;
+    //query the database and return the results
     const resource = await this.resource();
     const stmt = resource.prepare(query);
     const QUERY = query.toUpperCase();

packages/inquire/src/Engine.ts

@@ -17,6 +17,19 @@ import { jsonCompare } from './helpers.js';
 export default class Engine<R = unknown> {
   //database connection
   public readonly connection: Connection<R>;
+  //A hook used for logging purposes. Can also manipulate the final 
+  // query before execution. Can also provide the results of the query, 
+  // in which case the database will not be queried.
+  protected _before: <R = unknown>(
+    request: QueryObject
+  ) => Promise<R[] | void> = async (_request: QueryObject) => {};
+
+  /**
+   * Returns the before hook
+   */
+  public get before() {
+    return this._before;
+  }
 
   /**
    * Returns sql dialect
@@ -25,6 +38,15 @@ export default class Engine<R = unknown> {
     return this.connection.dialect;
   }
 
+  /**
+   * Sets the before hook
+   */
+  public set before(before: <R = unknown>(
+    request: QueryObject
+  ) => Promise<R[] | void>) {
+    this._before = before;
+  }
+
   /**
    * Sets the query callback
    */
@@ -183,13 +205,19 @@ export default class Engine<R = unknown> {
    * native database engine connection. Any code that uses
    * this library should not care about the kind of database.
    */
-  public query<R = unknown>(query: QueryObject): Promise<R[]>;
-  public query<R = unknown>(query: string, values?: Value[]): Promise<R[]>;
-  public query<R = unknown>(query: string|QueryObject, values: Value[] = []) {
+  public async query<R = unknown>(query: QueryObject): Promise<R[]>;
+  public async query<R = unknown>(query: string, values?: Value[]): Promise<R[]>;
+  public async query<R = unknown>(query: string|QueryObject, values: Value[] = []) {
     if (typeof query === 'string') {
       query = { query, values };
     }
-    return this.connection.query<R>(query);
+    //allow last minute request manipulation and 
+    // possibly short circuit the query with results
+    const results = await this._before(query);
+    //if results were provided, return them
+    if (results) return results;
+    //otherwise, query the database
+    return await this.connection.query<R>(query);
   }
 
   /**

packages/inquire/src/types.ts

@@ -181,11 +181,13 @@ export interface Connection<R = unknown> {
   //sql language dialect
   dialect: Dialect;
 
-  /**
-   * Get the last inserted id
-   */
+  //Get the last inserted id
   lastId: string | number | undefined;
 
+  //A hook used for logging purposes. Can also manipulate the final 
+  // query before execution.
+  before: (request: QueryObject) => Promise<void>;
+
   /**
    * Formats the query to what the database connection understands
    * Formats the values to what the database connection accepts