feature(automatic-transactions): Creates a decorator to make transactions easier for the developer

Resolves fastify#75

Author: Toni Sharpe

index.js

@@ -102,6 +102,13 @@ function fastifyPostgres (fastify, options, next) {
     }
   }
 
+  if (!fastify.hasRequestDecorator('pg')) {
+    fastify.decorateRequest('pg', null)
+    fastify.addHook('onRequest', async (req, reply) => {
+      req.pg = fastify.pg
+    })
+  }
+
   next()
 }
 

package.json

@@ -5,6 +5,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {
+    "testonly": "tap -J test/*.test.js && npm run test:typescript",
     "test": "standard && tap -J test/*.test.js && npm run test:typescript",
     "test:typescript": "tsd",
     "test:report": "standard && tap -J --coverage-report=html test/*.test.js",

test/initialization.test.js

@@ -192,7 +192,7 @@ test('fastify.pg namespace should exist', (t) => {
 })
 
 test('fastify.pg.test namespace should exist', (t) => {
-  t.plan(6)
+  t.plan(7)
 
   const fastify = Fastify()
   t.teardown(() => fastify.close())
@@ -210,5 +210,73 @@ test('fastify.pg.test namespace should exist', (t) => {
     t.ok(fastify.pg.test.connect)
     t.ok(fastify.pg.test.pool)
     t.ok(fastify.pg.test.Client)
+    t.ok(fastify.hasRequestDecorator('pg'))
+  })
+})
+
+test('fastify request should have the correct decoration', t => {
+  t.plan(5)
+  const fastify = Fastify()
+  t.teardown(() => fastify.close())
+
+  fastify.register(fastifyPostgres, {
+    connectionString
+  })
+
+  fastify.route({
+    method: 'GET',
+    url: '/users',
+    handler: (req, reply) => {
+      reply.send('response!')
+      t.ok(req.pg)
+      t.ok(req.pg.query)
+    }
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/users'
+  }, (err, res) => {
+    t.error(err)
+  })
+
+  fastify.ready((err) => {
+    t.error(err)
+
+    t.ok(fastify.hasRequestDecorator('pg'))
+  })
+})
+
+test('fastify request should have the correct decoration at the specified namespace', t => {
+  t.plan(5)
+  const fastify = Fastify()
+  t.teardown(() => fastify.close())
+
+  fastify.register(fastifyPostgres, {
+    connectionString,
+    name: 'test'
+  })
+
+  fastify.route({
+    method: 'GET',
+    url: '/users',
+    handler: (req, reply) => {
+      reply.send('response!')
+      t.ok(req.pg.test)
+      t.ok(req.pg.test.query)
+    }
+  })
+
+  fastify.inject({
+    method: 'GET',
+    url: '/users'
+  }, (err, res) => {
+    t.error(err)
+  })
+
+  fastify.ready((err) => {
+    t.error(err)
+
+    t.ok(fastify.hasRequestDecorator('pg'))
   })
 })

test/query.test.js

@@ -4,6 +4,7 @@ const t = require('tap')
 const test = t.test
 const Fastify = require('fastify')
 const fastifyPostgres = require('../index')
+
 const {
   BAD_DB_NAME,
   connectionString,
@@ -260,3 +261,182 @@ test('When fastify.pg.test namespace is used:', (t) => {
 
   t.end()
 })
+
+test('When req.pg root namespace is used:', (t) => {
+  t.test('Should be able to connect and perform a query', (t) => {
+    t.plan(4)
+    const fastify = Fastify()
+    t.teardown(() => fastify.close())
+
+    fastify.register(fastifyPostgres, {
+      connectionString,
+      name: 'test'
+    })
+
+    fastify.route({
+      method: 'GET',
+      url: '/users',
+      handler: (req, reply) => {
+        reply.send('response!')
+        t.ok(req.pg.test)
+        req.pg.test.query('SELECT NOW()', (err, result) => {
+          t.error(err)
+          t.ok(result.rows)
+        })
+      }
+    })
+
+    fastify.inject({
+      method: 'GET',
+      url: '/users'
+    }, (err, res) => {
+      t.error(err)
+    })
+  })
+
+  t.test('Should be able to use query util with a callback', (t) => {
+    t.plan(4)
+    const fastify = Fastify()
+    t.teardown(() => fastify.close())
+
+    fastify.register(fastifyPostgres, {
+      connectionString,
+      name: 'test'
+    })
+
+    fastify.route({
+      method: 'GET',
+      url: '/users',
+      handler: (req, reply) => {
+        reply.send('response!')
+        t.ok(req.pg.test)
+        req.pg.test.query('SELECT NOW()', (err, result) => {
+          t.error(err)
+          t.ok(result.rows)
+        })
+      }
+    })
+
+    fastify.inject({
+      method: 'GET',
+      url: '/users'
+    }, (err, res) => {
+      t.error(err)
+    })
+  })
+
+  t.test('Should be able to use query util with promises', (t) => {
+    t.plan(3)
+
+    const fastify = Fastify()
+    t.teardown(() => fastify.close())
+
+    fastify.register(fastifyPostgres, {
+      connectionString,
+      name: 'test'
+    })
+
+    fastify.route({
+      method: 'GET',
+      url: '/users',
+      handler: (req, reply) => {
+        reply.send('response!')
+        t.ok(req.pg.test)
+
+        req.pg.test
+          .query('SELECT NOW()')
+          .then((result) => {
+            t.ok(result.rows)
+          })
+          .catch((err) => {
+            t.fail(err)
+          })
+      }
+    })
+
+    fastify.inject({
+      method: 'GET',
+      url: '/users'
+    }, (err, res) => {
+      t.error(err)
+    })
+  })
+
+  t.test('Should be able to use native module', (t) => {
+    t.plan(3)
+
+    const fastify = Fastify()
+    t.teardown(() => fastify.close())
+
+    fastify.register(fastifyPostgres, {
+      connectionString,
+      name: 'test',
+      native: true
+    })
+
+    fastify.route({
+      method: 'GET',
+      url: '/users',
+      handler: (req, reply) => {
+        reply.send('response!')
+        t.ok(req.pg.test)
+
+        req.pg.test
+          .query('SELECT NOW()')
+          .then((result) => {
+            t.ok(result.rows)
+          })
+          .catch((err) => {
+            t.fail(err)
+          })
+      }
+    })
+
+    fastify.inject({
+      method: 'GET',
+      url: '/users'
+    }, (err, res) => {
+      t.error(err)
+    })
+  })
+
+  t.test('Should throw when pg fails to perform an operation with promises', (t) => {
+    t.plan(4)
+
+    const fastify = Fastify()
+    t.teardown(() => fastify.close())
+
+    fastify.register(fastifyPostgres, {
+      connectionString: connectionStringBadDbName,
+      name: 'test'
+    })
+
+    fastify.route({
+      method: 'GET',
+      url: '/users',
+      handler: (req, reply) => {
+        reply.send('response!')
+        t.ok(req.pg.test)
+
+        req.pg.test
+          .query('SELECT NOW()')
+          .then((result) => {
+            t.fail(result)
+          })
+          .catch((err) => {
+            t.ok(err)
+            t.is(err.message, `database "${BAD_DB_NAME}" does not exist`)
+          })
+      }
+    })
+
+    fastify.inject({
+      method: 'GET',
+      url: '/users'
+    }, (err, res) => {
+      t.error(err)
+    })
+  })
+
+  t.end()
+})