fix: Better error messages (#172)

* chore: cleaner logging output

- emit a string level rather than numeric (i.e. 'error' instead of 50)
- emit a readable ISO8601 timestamp instead of unix epoch time

* chore: better request logging when pg header is absent or malformed

* chore: better error message if query is not provided

Author: darora

src/server/app.ts

@@ -20,7 +20,7 @@ const app = fastify({
 })
 
 app.setErrorHandler((error, request, reply) => {
-  app.log.error({ error, request: extractRequestForLogging(request) })
+  app.log.error({ error: error.toString(), request: extractRequestForLogging(request) })
   reply.code(500).send({ error: error.message })
 })
 

src/server/routes/index.ts

@@ -1,4 +1,4 @@
-import CryptoJS from 'crypto-js'
+import * as CryptoJS from 'crypto-js'
 import { FastifyInstance } from 'fastify'
 import { PG_CONNECTION, CRYPTO_KEY } from '../constants'
 
@@ -8,9 +8,17 @@ export default async (fastify: FastifyInstance) => {
     // Node converts headers to lowercase
     const encryptedHeader = request.headers['x-connection-encrypted']?.toString()
     if (encryptedHeader) {
-      request.headers.pg = CryptoJS.AES.decrypt(encryptedHeader, CRYPTO_KEY).toString(
-        CryptoJS.enc.Utf8
-      )
+      try {
+        request.headers.pg = CryptoJS.AES.decrypt(encryptedHeader, CRYPTO_KEY).toString(
+          CryptoJS.enc.Utf8
+        )
+      } catch (e: any) {
+        request.log.warn({
+          message: 'failed to parse encrypted connstring',
+          error: e.toString(),
+        })
+        throw new Error('failed to process upstream connection details')
+      }
     } else {
       request.headers.pg = PG_CONNECTION
     }

src/server/routes/query.ts

@@ -1,16 +1,23 @@
-import { FastifyInstance } from 'fastify'
+import { FastifyInstance, FastifyRequest } from 'fastify'
 import { PostgresMeta } from '../../lib'
 import * as Parser from '../../lib/Parser'
 import { DEFAULT_POOL_CONFIG } from '../constants'
 import { extractRequestForLogging } from '../utils'
 
+const errorOnEmptyQuery = (request: FastifyRequest) => {
+  if (!(request.body as any).query) {
+    throw new Error('query not found')
+  }
+}
+
 export default async (fastify: FastifyInstance) => {
   fastify.post<{
     Headers: { pg: string }
     Body: {
       query: string
     }
   }>('/', async (request, reply) => {
+    errorOnEmptyQuery(request)
     const connectionString = request.headers.pg
 
     const pgMeta = new PostgresMeta({ ...DEFAULT_POOL_CONFIG, connectionString })
@@ -31,6 +38,7 @@ export default async (fastify: FastifyInstance) => {
       query: string
     }
   }>('/format', async (request, reply) => {
+    errorOnEmptyQuery(request)
     const { data, error } = Parser.Format(request.body.query)
 
     if (error) {
@@ -48,6 +56,7 @@ export default async (fastify: FastifyInstance) => {
       query: string
     }
   }>('/parse', async (request, reply) => {
+    errorOnEmptyQuery(request)
     const { data, error } = Parser.Parse(request.body.query)
 
     if (error) {

src/server/utils.ts

@@ -1,8 +1,18 @@
 import { parse } from 'pg-connection-string'
 import { FastifyRequest } from 'fastify'
 
-export const extractRequestForLogging = (request: FastifyRequest) => ({
-  method: request.method,
-  url: request.url,
-  pg: parse(request.headers.pg as string).host,
-})
+export const extractRequestForLogging = (request: FastifyRequest) => {
+  let pg: string = 'unknown'
+  try {
+    if (request.headers.pg) {
+      pg = parse(request.headers.pg as string).host || pg
+    }
+  } catch (e: any) {
+    console.warn('failed to parse PG connstring for ' + request.url)
+  }
+  return {
+    method: request.method,
+    url: request.url,
+    pg,
+  }
+}