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

Resolves #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

@@ -110,7 +110,7 @@ test('Should throw when trying to register multiple instances without giving a n
   })
 })
 
-test('Should not throw when registering a named instance and an unnamed instance)', (t) => {
+test('Should not throw when registering a named instance and an unnamed instance', (t) => {
   t.plan(1)
 
   const fastify = Fastify()
@@ -191,8 +191,8 @@ test('fastify.pg namespace should exist', (t) => {
   })
 })
 
-test('fastify.pg.test namespace should exist', (t) => {
-  t.plan(6)
+test('fastify.pg custom namespace should exist if a name is set', (t) => {
+  t.plan(7)
 
   const fastify = Fastify()
   t.teardown(() => fastify.close())
@@ -210,5 +210,6 @@ 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/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,
@@ -134,7 +135,7 @@ test('When fastify.pg root namespace is used:', (t) => {
   t.end()
 })
 
-test('When fastify.pg.test namespace is used:', (t) => {
+test('When fastify.pg custom namespace is used:', (t) => {
   t.test('Should be able to connect and perform a query', (t) => {
     t.plan(4)
 

test/req-initialization.test.js

@@ -0,0 +1,74 @@
+'use strict'
+
+const t = require('tap')
+const test = t.test
+const Fastify = require('fastify')
+const fastifyPostgres = require('../index')
+const { connectionString } = require('./helpers')
+
+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 custom 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'))
+  })
+})