@uscreen.de/create-fastify-app 0.0.0 → 0.1.0

package/.gitlab-ci.yml.example

@@ -0,0 +1,15 @@
+# image: node:10
+
+# cache:
+#   paths:
+#     - node_modules/
+
+# stages:
+#   - test
+
+# test:
+#   stage: test
+#   script:
+#     - yarn install
+#     - yarn test:ci
+#   coverage: '/^Statements\s*:\s*([^%]+)/'

package/bin/cli.js

@@ -1,23 +1,162 @@
 #!/usr/bin/env node
 
+const path = require('path')
 const cli = require('commander')
+const readPkgUp = require('read-pkg-up')
+const writePackage = require('write-pkg')
+const fs = require('fs-extra')
 
-let nameValue
-let optValue
+const { spawn } = require('child_process')
 
+let root
+let skeleton
+
+/**
+ * init new git
+ */
+const initializeGitRepository = path =>
+  new Promise((resolve, reject) => {
+    const git = spawn('git', ['init', path])
+    git.stdout.on('data', data => process.stdout.write(data))
+    git.stderr.on('data', data => process.stderr.write(data))
+    git.on('close', code => {
+      if (code === 0) return resolve(code)
+      reject(code)
+    })
+  })
+
+/**
+ * init new yarn project
+ */
+const initializeYarn = path =>
+  new Promise((resolve, reject) => {
+    const yarn = spawn('yarn', ['init'], {
+      cwd: path,
+      stdio: [0, 1, 2]
+    })
+    yarn.on('close', code => {
+      if (code === 0) return resolve(code)
+      reject(code)
+    })
+  })
+
+/**
+ * install extra dev packages from skeleleton
+ */
+const installDevPackages = (appPath, skelPath) => {
+  const skelPack = readPkgUp.sync({ cwd: skelPath })
+  const devDependencies = Object.keys(skelPack.packageJson.devDependencies)
+  return new Promise((resolve, reject) => {
+    const yarn = spawn('yarn', ['add', ...devDependencies, '-D'], {
+      cwd: appPath
+    })
+    yarn.stdout.on('data', data => process.stdout.write(data))
+    yarn.stderr.on('data', data => process.stderr.write(data))
+    yarn.on('close', code => {
+      if (code === 0) return resolve(code)
+      reject(code)
+    })
+  })
+}
+
+/**
+ * install extra prod packages from skeleleton
+ */
+const installPackages = (appPath, skelPath) => {
+  const skelPack = readPkgUp.sync({ cwd: skelPath })
+  const dependencies = Object.keys(skelPack.packageJson.dependencies)
+  return new Promise((resolve, reject) => {
+    const yarn = spawn('yarn', ['add', ...dependencies], {
+      cwd: appPath
+    })
+    yarn.stdout.on('data', data => process.stdout.write(data))
+    yarn.stderr.on('data', data => process.stderr.write(data))
+    yarn.on('close', code => {
+      if (code === 0) return resolve(code)
+      reject(code)
+    })
+  })
+}
+
+/**
+ * configure package.json to use linting, testing, stuff
+ */
+const addPackageConfig = (path, skelPath) => {
+  const skelPack = readPkgUp.sync({ cwd: skelPath })
+  const pack = readPkgUp.sync({ cwd: path })
+  delete pack.packageJson._id
+  delete pack.packageJson.readme
+
+  pack.packageJson.main = skelPack.packageJson.main
+
+  pack.packageJson.scripts = Object.assign(pack.packageJson.scripts || {}, {
+    start: 'pm2 start pm2-dev.config.js',
+    stop: 'pm2 delete pm2-dev.config.js',
+    logs: `pm2 logs ${pack.packageJson.name} --raw | pino-pretty -t`,
+    lint: "eslint '**/*.js' --fix",
+    test: 'tap test/**/*.test.js',
+    'test:cov': 'tap --coverage-report=html test/**/*.test.js',
+    'test:ci': 'tap --coverage-report=text-summary test/**/*.test.js',
+    deploy: 'pm2 deploy pm2.config.js',
+    postdeploy: 'pm2 reload pm2.config.js'
+  })
+  pack.packageJson.gitHooks = {
+    'pre-commit': 'lint-staged'
+  }
+  pack.packageJson['lint-staged'] = {
+    '*.{js}': ['eslint --fix', 'git add']
+  }
+  return writePackage(pack.path, pack.packageJson)
+}
+
+/**
+ * copy app skeleton to destination
+ */
+const copySkeleton = (appPath, skelPath) => {
+  return fs.copy(skelPath, appPath, { overwrite: false })
+}
+
+/**
+ * define the command
+ */
 cli
   .version('0.1.0')
   .arguments('<name> [opt]')
-  .action(function(name, opt) {
-    nameValue = name
-    optValue = opt
+  .action(async (name, opt) => {
+    if (typeof name === 'undefined') {
+      console.error('please specify your new apps name...')
+      process.exit(1)
+    }
+
+    /**
+     * the root directory of new project
+     */
+    root = path.resolve(process.cwd(), name)
+
+    /**
+     * the root directory of chosen skeleton
+     */
+    skeleton = path.join(__dirname, '..', 'skeleton')
+
+    /**
+     * setup new app
+     */
+    await initializeGitRepository(root)
+    await initializeYarn(root)
+    await installDevPackages(root, skeleton)
+    await installPackages(root, skeleton)
+    await addPackageConfig(root, skeleton)
+    await copySkeleton(root, skeleton)
   })
 
+/**
+ * read args
+ */
 cli.parse(process.argv)
 
-if (typeof nameValue === 'undefined') {
-  console.error('please specify your new apps name...')
-  process.exit(1)
+/**
+ * output help as default
+ */
+if (!process.argv.slice(2).length) {
+  cli.help()
 }
-console.log('name:', nameValue)
-console.log('opt:', optValue)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uscreen.de/create-fastify-app",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "cli to create a new @uscreen.de/fastify-app",
   "main": "index.js",
   "bin": {
@@ -25,7 +25,10 @@
     ]
   },
   "dependencies": {
-    "commander": "^3.0.2"
+    "commander": "^3.0.2",
+    "fs-extra": "^8.1.0",
+    "read-pkg-up": "^7.0.0",
+    "write-pkg": "^4.0.0"
   },
   "devDependencies": {
     "eslint": "^6.5.1",

package/skeleton/.env.example

@@ -0,0 +1,4 @@
+# @see ./app/config.js for defaults and options
+
+logLevel = debug
+

package/skeleton/.gitlab-ci.yml.example

@@ -0,0 +1,15 @@
+# image: node:10
+
+# cache:
+#   paths:
+#     - node_modules/
+
+# stages:
+#   - test
+
+# test:
+#   stage: test
+#   script:
+#     - yarn install
+#     - yarn test:ci
+#   coverage: '/^Statements\s*:\s*([^%]+)/'

package/skeleton/Makefile

@@ -0,0 +1,29 @@
+start:
+	yarn
+	yarn start
+
+stop:
+	yarn stop
+
+logs:
+	yarn logs
+
+test:
+	yarn test
+
+test.coverage:
+	yarn test:cov
+
+deploy:
+	yarn deploy stage
+
+deploy.setup:
+	yarn deploy stage setup
+
+live.deploy:
+	yarn deploy live
+
+live.deploy.setup:
+	yarn deploy live setup
+
+.PHONY: test

package/skeleton/app/app.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const fastifyApp = require('@uscreen.de/fastify-app')
+const fp = require('fastify-plugin')
+const schemas = require('./schemas')
+
+module.exports = fp(async (fastify, opts, next) => {
+  /**
+   * add schemas
+   */
+  fastify.register(schemas)
+
+  /**
+   * register app
+   */
+  fastify.register(fastifyApp, opts)
+
+  next()
+})

package/skeleton/app/config.js

@@ -0,0 +1,47 @@
+'use strict'
+
+const path = require('path')
+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'
+    }
+  }
+}
+
+const config = envSchema({
+  schema: schema,
+  dotenv: true
+})
+
+config.autoloads = [
+  path.join(__dirname, 'plugins'),
+  path.join(__dirname, 'services')
+]
+
+config.swagger = {
+  routePrefix: '/api/docs',
+  exposeRoute: true,
+  addModels: true
+}
+
+config.healthCheck = {
+  exposeStatusRoute: '/api/health'
+}
+
+module.exports = config

package/skeleton/app/plugins/noop.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+
+module.exports = fp(async (fastify, opts, next) => {
+  fastify.decorate('noop', () => {
+    return 'Hello Universe'
+  })
+
+  next()
+})

package/skeleton/app/schemas.js

@@ -0,0 +1,41 @@
+'use strict'
+
+const fp = require('fastify-plugin')
+
+/**
+ * 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
+      }
+    }
+  })
+
+  fastify.addSchema({
+    $id: 'http404',
+    type: 'object',
+    properties: {
+      statusCode: {
+        type: 'integer',
+        example: 404
+      },
+      error: {
+        type: 'string',
+        example: 'Not Found'
+      },
+      message: {
+        type: 'string',
+        example: 'Not Found'
+      }
+    }
+  })
+
+  next()
+})

package/skeleton/app/server.js

@@ -0,0 +1,28 @@
+'use strict'
+
+const fastify = require('fastify')
+const config = require('./config')
+const myapp = require('./app')
+
+const app = fastify({
+  logger: config.logEnabled
+    ? {
+        level: config.logLevel
+      }
+    : false
+})
+
+app.register(myapp, config)
+
+/**
+ * post-treatment
+ */
+app.ready(err => {
+  if (err) throw err
+  app.log.debug('Application ready, routes are set:\n' + app.printRoutes())
+})
+
+/**
+ * start http server
+ */
+app.listen(config.httpPort, config.httpBind)

package/skeleton/app/services/noop.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = async fastify => {
+  fastify.get('/noop', async (req, res) => {
+    return { noop: 'Hello world', plugin: fastify.noop() }
+  })
+}

package/skeleton/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "new-fastify-app",
+  "version": "0.0.0",
+  "main": "app/server.js",
+  "license": "MIT",
+  "dependencies": {
+    "@uscreen.de/fastify-app": "^0.2.9",
+    "env-schema": "^1.0.0",
+    "fastify": "^2.9.0",
+    "fastify-plugin": "^1.6.0"
+  },
+  "devDependencies": {
+    "eslint": "^6.5.1",
+    "eslint-config-prettier": "^6.3.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-node": "^10.0.0",
+    "eslint-plugin-prettier": "^3.1.1",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1",
+    "lint-staged": "^9.4.1",
+    "pm2": "^3.5.1",
+    "prettier": "^1.18.2",
+    "tap": "^14.6.9",
+    "yorkie": "^2.0.0"
+  },
+  "scripts": {
+    "start": "pm2 start pm2-dev.config.js",
+    "stop": "pm2 delete pm2-dev.config.js",
+    "logs": "pm2 logs new-fastify-app --raw | pino-pretty -t",
+    "lint": "eslint '**/*.js' --fix",
+    "test": "tap test/**/*.test.js",
+    "test:cov": "tap --coverage-report=html test/**/*.test.js",
+    "test:ci": "tap --coverage-report=text-summary test/**/*.test.js",
+    "deploy": "pm2 deploy pm2.config.js",
+    "postdeploy": "pm2 reload pm2.config.js"
+  },
+  "gitHooks": {
+    "pre-commit": "lint-staged"
+  },
+  "lint-staged": {
+    "*.{js}": [
+      "eslint --fix",
+      "git add"
+    ]
+  }
+}

package/skeleton/pm2-dev.config.js

@@ -0,0 +1,16 @@
+const { name, main } = require('./package.json')
+
+module.exports = {
+  apps: [
+    {
+      name,
+      script: main,
+      merge_logs: true,
+      watch: ['app'],
+      ignore_watch: ['.git', 'app/*.pid'],
+      env: {
+        NODE_ENV: 'development'
+      }
+    }
+  ]
+}

package/skeleton/pm2.config.js

@@ -0,0 +1,28 @@
+const { name, main, repository } = require('./package.json')
+
+module.exports = {
+  apps: [
+    {
+      name,
+      script: main,
+      merge_logs: true,
+      ignore_watch: ['.git', 'app/*.pid'],
+      env: {
+        NODE_ENV: 'production'
+      }
+    }
+  ],
+  deploy: {
+    stage: {
+      user: 'user',
+      host: 'server-stage.example.com',
+      ref: 'origin/master',
+      repo: repository,
+      path: `/home/user/${name}`,
+      'pre-setup': 'yarn add pm2 pino-pretty;',
+      'post-setup':
+        'cp ./.env.example ../shared/.env; ln -s ../shared/.env ./.env',
+      'post-deploy': 'yarn install --production; yarn postdeploy'
+    }
+  }
+}

package/skeleton/test/helper.js

@@ -0,0 +1,28 @@
+'use strict'
+
+// This file contains code that we reuse
+// between our tests.
+
+const Fastify = require('fastify')
+const fp = require('fastify-plugin')
+
+// setup to require YOUR app
+const App = require('../app/app')
+const Config = require('../app/config')
+
+// automatically build and tear down our instance
+function build(t, ConfigOverwrite = {}) {
+  const app = Fastify()
+
+  // 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))
+
+  return app
+}
+
+module.exports = {
+  build
+}

package/skeleton/test/noop.test.js

@@ -0,0 +1,54 @@
+const tap = require('tap')
+const { build } = require('./helper')
+
+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()
+
+  t.test('a valid GET Request', t => {
+    fastify.inject(
+      {
+        method: 'GET',
+        url: '/api/health'
+      },
+      (e, response) => {
+        t.error(e)
+        t.same(response.statusCode, 200, 'response ok')
+        t.same(JSON.parse(response.body), { status: 'ok' }, 'payload ok')
+        t.end()
+      }
+    )
+  })
+})
+
+tap.test('Noop Service', async t => {
+  const fastify = build(t)
+  await fastify.ready()
+
+  t.test('a valid GET Request', t => {
+    fastify.inject(
+      {
+        method: 'GET',
+        url: '/api/noop'
+      },
+      (e, response) => {
+        t.error(e)
+        t.same(response.statusCode, 200, 'response ok')
+        t.same(
+          JSON.parse(response.body),
+          {
+            noop: 'Hello world',
+            plugin: 'Hello Universe'
+          },
+          'payload ok'
+        )
+        t.end()
+      }
+    )
+  })
+})