chore: add query to error if enabled in debug (#469)

Author: bombillazo

client/error.ts

@@ -35,12 +35,18 @@ export class PostgresError extends Error {
    */
   public fields: Notice;
 
+  /**
+   * The query that caused the error
+   */
+  public query: string | undefined;
+
   /**
    * Create a new PostgresError
    */
-  constructor(fields: Notice) {
+  constructor(fields: Notice, query?: string) {
     super(fields.message);
     this.fields = fields;
+    this.query = query;
     this.name = "PostgresError";
   }
 }

connection/connection.ts

@@ -694,7 +694,15 @@ export class Connection {
     while (current_message.type !== INCOMING_QUERY_MESSAGES.READY) {
       switch (current_message.type) {
         case ERROR_MESSAGE:
-          error = new PostgresError(parseNoticeMessage(current_message));
+          error = new PostgresError(
+            parseNoticeMessage(current_message),
+            isDebugOptionEnabled(
+                "queryInError",
+                this.#connection_params.controls?.debug,
+              )
+              ? query.text
+              : undefined,
+          );
           break;
         case INCOMING_QUERY_MESSAGES.COMMAND_COMPLETE: {
           result.handleCommandComplete(
@@ -881,7 +889,15 @@ export class Connection {
     while (current_message.type !== INCOMING_QUERY_MESSAGES.READY) {
       switch (current_message.type) {
         case ERROR_MESSAGE: {
-          error = new PostgresError(parseNoticeMessage(current_message));
+          error = new PostgresError(
+            parseNoticeMessage(current_message),
+            isDebugOptionEnabled(
+                "queryInError",
+                this.#connection_params.controls?.debug,
+              )
+              ? query.text
+              : undefined,
+          );
           break;
         }
         case INCOMING_QUERY_MESSAGES.BIND_COMPLETE:

debug.ts

@@ -8,12 +8,14 @@
 export type DebugControls = DebugOptions | boolean;
 
 type DebugOptions = {
-  /** Log queries */
+  /** Log all queries */
   queries?: boolean;
-  /** Log INFO, NOTICE, and WARNING raised database messages */
+  /** Log all INFO, NOTICE, and WARNING raised database messages */
   notices?: boolean;
-  /** Log results */
+  /** Log all results */
   results?: boolean;
+  /** Include the SQL query that caused an error in the PostgresError object */
+  queryInError?: boolean;
 };
 
 export const isDebugOptionEnabled = (

docs/README.md

@@ -1403,8 +1403,10 @@ enabled by using the `debug` option in the Client `controls` parameter. Pass
 options:
 
 - `queries` : Logs all SQL queries executed by the client
-- `notices` : Logs database messages (INFO, NOTICE, WARNING))
-- `results` : Logs the result of the queries
+- `notices` : Logs all database messages (INFO, NOTICE, WARNING))
+- `results` : Logs all the result of the queries
+- `queryInError` : Includes the SQL query that caused an error in the
+  PostgresError object
 
 ### Example
 
@@ -1419,7 +1421,6 @@ const client = new Client({
   port: 5432,
   password: "postgres",
   controls: {
-    // the same as `debug: true`
     debug: {
       queries: true,
       notices: true,
@@ -1430,7 +1431,7 @@ const client = new Client({
 
 await client.connect();
 
-const result = await client.queryObject`SELECT public.get_some_user()`;
+await client.queryObject`SELECT public.get_uuid()`;
 
 await client.end();
 ```

tests/query_client_test.ts

@@ -8,6 +8,7 @@ import {
 import {
   assert,
   assertEquals,
+  assertInstanceOf,
   assertObjectMatch,
   assertRejects,
   assertThrows,
@@ -284,6 +285,43 @@ Deno.test(
   ),
 );
 
+Deno.test(
+  "Debug query not in error",
+  withClient(async (client) => {
+    const invalid_query = "SELECT this_has $ 'syntax_error';";
+    try {
+      await client.queryObject(invalid_query);
+    } catch (error) {
+      assertInstanceOf(error, PostgresError);
+      assertEquals(error.message, 'syntax error at or near "$"');
+      assertEquals(error.query, undefined);
+    }
+  }),
+);
+
+Deno.test(
+  "Debug query in error",
+  withClient(
+    async (client) => {
+      const invalid_query = "SELECT this_has $ 'syntax_error';";
+      try {
+        await client.queryObject(invalid_query);
+      } catch (error) {
+        assertInstanceOf(error, PostgresError);
+        assertEquals(error.message, 'syntax error at or near "$"');
+        assertEquals(error.query, invalid_query);
+      }
+    },
+    {
+      controls: {
+        debug: {
+          queryInError: true,
+        },
+      },
+    },
+  ),
+);
+
 Deno.test(
   "Array arguments",
   withClient(async (client) => {

tests/test_deps.ts

@@ -2,6 +2,7 @@ export * from "../deps.ts";
 export {
   assert,
   assertEquals,
+  assertInstanceOf,
   assertNotEquals,
   assertObjectMatch,
   assertRejects,