add examples

Author: matthyk

examples/override-hook.js

@@ -0,0 +1,45 @@
+const fastifyOverride = require('../index')
+const t = require('tap')
+const Fastify = require('fastify')
+
+const adminArea = async app => {
+  app.addHook('onRequest', (req, reply) => {
+    // Some auth strategy
+    // ...
+
+    reply.status(401).send('You are not authenticated!')
+  })
+
+  app.get('/health', async () => {
+    return 'You are a admin!'
+  })
+}
+
+const server = async (app) => {
+  app.register(adminArea, {
+    prefix: 'admin'
+  })
+}
+
+t.test('test admin health endpoint', async t => {
+  const app = Fastify()
+
+  await app.register(fastifyOverride, {
+    override: {
+      hooks: {
+        // just bypass the authentication hook
+        onRequest: async () => {}
+      }
+    }
+  })
+
+  app.register(server)
+
+  const response = await app.inject({
+    url: 'admin/health',
+    method: 'GET'
+  })
+
+  t.equal(response.statusCode, 200)
+  t.equal(response.body, 'You are a admin!')
+})

examples/override-plugin.js

@@ -0,0 +1,98 @@
+const fastifyOverride = require('../index')
+const t = require('tap')
+const Fastify = require('fastify')
+const fp = require('fastify-plugin')
+
+// This simulates the @fastify/postgres plugin https://github.com/fastify/fastify-postgres
+const fastifyPostgres = fp((app) => {}, {
+  name: '@fastify/postgres'
+})
+
+const users = async app => {
+  app.get('/', {
+    schema: {
+      response: {
+        200: {
+          type: 'array',
+          items: {
+            type: 'object',
+            properties: {
+              id: {
+                type: 'number'
+              },
+              name: {
+                type: 'string'
+              }
+            }
+          }
+        }
+      }
+    }
+  }, async function () {
+    return (await this.pg.query('SELECT * from "users" LIMIT 10')).rows
+  })
+}
+
+const server = async (app) => {
+  app.register(fastifyPostgres, {
+    connectionString: 'postgres://postgres@localhost/postgres'
+  })
+
+  app.register(users, {
+    prefix: 'users'
+  })
+}
+
+t.test('GET /users - 200', async t => {
+  const app = Fastify()
+
+  await app.register(fastifyOverride, {
+    override: {
+      plugins: {
+        '@fastify/postgres': fp(async (instance) => {
+          instance.decorate('pg', {
+            query: async () => {
+              return {
+                rows: [
+                  {
+                    id: 1,
+                    name: 'Matthias',
+                    password: 'test123'
+                  },
+                  {
+                    id: 3,
+                    name: 'Max',
+                    password: 'alligator2'
+                  }
+                ]
+              }
+            }
+          })
+        })
+      }
+    }
+  })
+
+  app.register(server)
+
+  const response = await app.inject({
+    url: '/users',
+    method: 'GET'
+  })
+
+  const body = response.json()
+
+  t.equal(response.statusCode, 200)
+  t.equal(body.length, 2)
+  t.matchOnly(body, [
+    {
+      id: /\d+/,
+      name: /.+/
+    },
+    {
+      id: /\d+/,
+      name: /.+/
+      // password: /.*/ <-- this would fail
+    }
+  ])
+})