Better errors - include origin, query, parameters

porsager · porsager · commit 7845fc704b6d · 2020-02-04T00:44:58.000+01:00
Fixes porsager#17
diff --git a/README.md b/README.md
@@ -493,6 +493,10 @@ sql.unsafe('select ' + danger + ' from users where id = ' + dragons)
 
 Errors are all thrown to related queries and never globally. Errors coming from PostgreSQL itself are always in the [native Postgres format](https://www.postgresql.org/docs/current/errcodes-appendix.html), and the same goes for any [Node.js errors](https://nodejs.org/api/errors.html#errors_common_system_errors) eg. coming from the underlying connection.
 
+Query errors will contain a stored error with the origin of the query to aid in tracing errors.
+
+Query errors will also contain the `query` string and the `parameters` which are not enumerable to avoid accidentally leaking confidential information in logs. To log these it is required to specifically access `error.query` and `error.parameters`.
+
 There are also the following errors specifically for this library.
 
 ##### MESSAGE_NOT_SUPPORTED
diff --git a/lib/connection.js b/lib/connection.js
@@ -108,6 +108,8 @@ function Connection(options = {}) {
   }
 
   function send(query, { sig, str, args = [] }) {
+    query.str = str
+    query.args = args
     query.result = []
     query.result.count = null
     timeout && clearTimeout(timer)
@@ -158,9 +160,24 @@ function Connection(options = {}) {
   }
 
   function onready(err) {
-    err
-      ? (backend.query ? backend.query.reject(err) : error(err))
-      : (backend.query && backend.query.resolve(backend.query.results || backend.query.result))
+    if (err) {
+      if (backend.query) {
+        err.origin = backend.query.origin
+        Object.defineProperty(err, 'query', {
+          value: backend.query.str,
+          enumerable: false
+        })
+        Object.defineProperty(err, 'parameters', {
+          value: backend.query.args,
+          enumerable: false
+        })
+        backend.query.reject(err)
+      } else {
+        error(err)
+      }
+    } else if (backend.query) {
+      backend.query.resolve(backend.query.results || backend.query.result)
+    }
 
     backend.query = backend.error = null
     timeout && queries.length === 0 && idle()
diff --git a/lib/index.js b/lib/index.js
@@ -159,6 +159,7 @@ function Postgres(a, b) {
   }
 
   function query(query, connection, xs, args) {
+    query.origin = new Error('Query failed')
     if (!query.raw && (!Array.isArray(xs) || !Array.isArray(xs.raw)))
       return nested(xs, args)
 
diff --git a/tests/index.js b/tests/index.js
@@ -874,3 +874,28 @@ t('numeric is returned as string', async() => [
   'string',
   typeof (await sql`select 1.2 as x`)[0].x
 ])
+
+t('Error contains origin', async() => [
+  true,
+  (await sql`selec 1`.catch(err => 'origin' in err))
+])
+
+t('Error contains query string', async() => [
+  'selec 1',
+  (await sql`selec 1`.catch(err => err.query))
+])
+
+t('Error contains query parameters', async() => [
+  '1',
+  (await sql`selec ${ 1 }`.catch(err => err.parameters[0].value))
+])
+
+t('Query string is not enumerable', async() => [
+  -1,
+  (await sql`selec 1`.catch(err => Object.keys(err).indexOf('query')))
+])
+
+t('Query parameters are not enumerable', async() => [
+  -1,
+  (await sql`selec ${ 1 }`.catch(err => Object.keys(err).indexOf('parameters')))
+])

Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,7 @@ function Postgres(a, b) {`
`159`	`159`	`}`
`160`	`160`
`161`	`161`	`function query(query, connection, xs, args) {`
	`162`	`+ query.origin = new Error('Query failed')`
`162`	`163`	`if (!query.raw && (!Array.isArray(xs) \|\| !Array.isArray(xs.raw)))`
`163`	`164`	`return nested(xs, args)`
`164`	`165`