@uscreen.de/create-fastify-app 0.2.14 → 0.3.0

package/.gitignore

@@ -2,3 +2,4 @@
 .DS_Store
 yarn-error.log
 /.nyc_output
+/skeleton/yarn.lock

package/README.md

@@ -68,6 +68,11 @@ $ make logs
 
 ## Changelog
 
+### v0.3.0
+
+- upgraded to fastify 3.x
+- upgraded to node 12.x (LTS)
+
 ### v0.2.0
 
 - added instructions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uscreen.de/create-fastify-app",
-  "version": "0.2.14",
+  "version": "0.3.0",
   "description": "cli to create a new @uscreen.de/fastify-app",
   "main": "index.js",
   "bin": {

package/skeleton/.eslintrc.js

@@ -1,12 +1,12 @@
 module.exports = {
-    root: true,
-    env: {
-        node: true
-    },
-    extends: ['standard', 'plugin:prettier/recommended'],
-    rules: {
-        'generator-star-spacing': 'off',
-        'space-before-function-paren': 'off',
-        'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
-    }
+  root: true,
+  env: {
+    node: true
+  },
+  extends: ['standard', 'plugin:prettier/recommended'],
+  rules: {
+    'generator-star-spacing': 'off',
+    'space-before-function-paren': 'off',
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
+  }
 }

package/skeleton/app/app.js

@@ -4,7 +4,7 @@ const fastifyApp = require('@uscreen.de/fastify-app')
 const fp = require('fastify-plugin')
 const schemas = require('./schemas')
 
-module.exports = fp(async (fastify, opts, next) => {
+module.exports = fp((fastify, opts, next) => {
   /**
    * add schemas
    */

package/skeleton/app/config.js

@@ -6,21 +6,11 @@ const envSchema = require('env-schema')
 const schema = {
   type: 'object',
   properties: {
-    httpPort: {
-      default: 3000
-    },
-    httpBind: {
-      default: '127.0.0.1'
-    },
-    prefix: {
-      default: '/api'
-    },
-    logEnabled: {
-      default: true
-    },
-    logLevel: {
-      default: 'info'
-    }
+    httpPort: { default: 3000 },
+    httpBind: { default: '127.0.0.1' },
+    prefix: { default: '/api' },
+    logEnabled: { default: true },
+    logLevel: { default: 'info' }
   }
 }
 
@@ -40,7 +30,7 @@ config.swagger = {
   addModels: true
 }
 
-config.healthCheck = {
+config.health = {
   exposeStatusRoute: `${config.prefix}/health`
 }
 

package/skeleton/app/plugins/noop.js

@@ -3,7 +3,7 @@
 const fp = require('fastify-plugin')
 
 module.exports = fp(
-  async (fastify, opts, next) => {
+  (fastify, opts, next) => {
     fastify.decorate('noop', () => {
       return 'Hello Universe'
     })

package/skeleton/app/schemas.js

@@ -1,41 +1,36 @@
 'use strict'
 
 const fp = require('fastify-plugin')
+const S = require('fluent-schema')
 
 /**
  * Usage of the Globaly Shared Schema feature
  */
 
-module.exports = fp(async (fastify, opts, next) => {
-  fastify.addSchema({
-    $id: 'http200',
-    type: 'object',
-    properties: {
-      statusCode: {
-        type: 'integer',
-        example: 200
-      }
-    }
-  })
+module.exports = fp((fastify, opts, next) => {
+  const addSchema = (schema) => {
+    fastify.addSchema(schema)
+    return schema
+  }
 
-  fastify.addSchema({
-    $id: 'http404',
-    type: 'object',
-    properties: {
-      statusCode: {
-        type: 'integer',
-        example: 404
-      },
-      error: {
-        type: 'string',
-        example: 'Not Found'
-      },
-      message: {
-        type: 'string',
-        example: 'Not Found'
-      }
-    }
-  })
+  /**
+   * add generic schemas
+   */
+  const noop = addSchema(S.object().id('noop').prop('noop'))
+
+  const plugin = addSchema(S.object().id('plugin').prop('plugin'))
+
+  /**
+   * combine and extend schemas
+   */
+  addSchema(
+    S.object()
+      .id('noopNplugin')
+      .required(['noop'])
+      // .prop('property') // --> strip it
+      .extend(noop)
+      .extend(plugin)
+  )
 
   next()
 })

package/skeleton/app/server.js

@@ -1,15 +1,26 @@
 'use strict'
 
 const fastify = require('fastify')
+const hyperid = require('hyperid')
 const { name, version } = require('../package.json')
 const config = require('./config')
 const app = require('./app')
 
+const instance = hyperid({ urlSafe: true })
+
 const server = fastify({
+  genReqId() {
+    return instance()
+  },
+
   logger: config.logEnabled
     ? {
         level: config.logLevel,
-        name: `${name} (v${version}) ${process.env.NODE_APP_INSTANCE}`
+        name: `${name} (v${version}) ${process.env.NODE_APP_INSTANCE}`,
+        redact: {
+          paths: ['pattern'], // limit hemeras verbosity
+          remove: true
+        }
       }
     : false
 })
@@ -19,7 +30,7 @@ server.register(app, config)
 /**
  * post-treatment
  */
-server.ready(err => {
+server.ready((err) => {
   if (err) throw err
   server.log.debug('server ready, routes are set:\n' + server.printRoutes())
 })

package/skeleton/app/services/noop.js

@@ -1,7 +1,24 @@
 'use strict'
 
-module.exports = async fastify => {
-  fastify.get('/noop', async (req, res) => {
-    return { noop: 'Hello world', plugin: fastify.noop() }
-  })
+module.exports = (fastify, opts, next) => {
+  fastify.get(
+    '/noop',
+    {
+      schema: {
+        response: {
+          200: { $ref: 'noopNplugin#' } // fastest and json-schema spec compatiple way, or use 'fastify.getSchema()'
+          // 200: fastify.getSchema('noopNplugin')
+        }
+      }
+    },
+    async (req, res) => {
+      return {
+        noop: 'Hello world',
+        plugin: fastify.noop(),
+        property: 'should be stripped from response'
+      }
+    }
+  )
+
+  next()
 }

package/skeleton/package.json

@@ -3,10 +3,12 @@
   "version": "0.0.0",
   "main": "app/server.js",
   "dependencies": {
-    "@uscreen.de/fastify-app": "^0.4.3",
+    "@uscreen.de/fastify-app": "^0.5.0",
     "env-schema": "^1.0.0",
-    "fastify": "^2.15.3",
-    "fastify-plugin": "^1.6.0"
+    "fastify": "^3.2.0",
+    "fastify-plugin": "^2.2.0",
+    "fluent-schema": "^1.0.4",
+    "hyperid": "^2.0.5"
   },
   "devDependencies": {
     "eslint": "^7.6.0",

package/skeleton/test/{noop.test.js → app/noop.test.js}

@@ -1,20 +1,20 @@
 const tap = require('tap')
-const { build } = require('./helper')
+const { build } = require('../helper')
 
-tap.test('Test Setup', t => {
+tap.test('Test Setup', (t) => {
   t.strictEqual(true, true, 'Tests and assertions should work')
   t.end()
 })
 
-tap.test('Healthcheck', async t => {
-  const fastify = build(t)
-  await fastify.ready()
+tap.test('Healthcheck', async (t) => {
+  const fastify = await build(t)
+  const { prefix } = fastify.config
 
-  t.test('a valid GET Request', t => {
+  t.test('a valid GET Request', (t) => {
     fastify.inject(
       {
         method: 'GET',
-        url: '/api/health'
+        url: `${prefix}/health`
       },
       (e, response) => {
         t.error(e)
@@ -26,15 +26,15 @@ tap.test('Healthcheck', async t => {
   })
 })
 
-tap.test('Noop Service', async t => {
-  const fastify = build(t)
-  await fastify.ready()
+tap.test('Noop Service', async (t) => {
+  const fastify = await build(t)
+  const { prefix } = fastify.config
 
-  t.test('a valid GET Request', t => {
+  t.test('a valid GET Request', (t) => {
     fastify.inject(
       {
         method: 'GET',
-        url: '/api/noop'
+        url: `${prefix}/noop`
       },
       (e, response) => {
         t.error(e)

package/skeleton/test/helper.js

@@ -10,19 +10,31 @@ const fp = require('fastify-plugin')
 const App = require('../app/app')
 const Config = require('../app/config')
 
+// overwrite some config option(s) on tests
+Config.hemeralogLevel = 'fatal'
+Config.hemeraNS = `test-${process.env.TAP_CHILD_ID}`
+
 // automatically build and tear down our instance
-function build(t, ConfigOverwrite = {}) {
-  const app = Fastify()
+const build = async (t, featureSwitches = {}, ConfigOverwrite = {}) => {
+  return new Promise((resolve, reject) => {
+    const app = Fastify()
 
-  // setup to register YOUR app
-  app.register(fp(App), { ...Config, ...ConfigOverwrite })
+    // setup to register YOUR app
+    app.register(fp(App), { ...Config, ...ConfigOverwrite })
 
-  // tear down our app after we are done
-  t.tearDown(app.close.bind(app))
+    // tear down our app after we are done
+    t.tearDown(app.close.bind(app))
 
-  return app
+    app.ready((err) => {
+      if (err) throw err
+      resolve(app)
+    })
+  })
 }
 
+const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
+
 module.exports = {
-  build
+  build,
+  wait
 }