@kravc/dos 1.8.1 → 1.8.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kravc/dos",
-  "version": "1.8.1",
+  "version": "1.8.3",
   "description": "Convention-based, easy-to-use library for building API-driven serverless services.",
   "keywords": [
     "Service",
@@ -20,7 +20,7 @@
     "src": "src"
   },
   "scripts": {
-    "test": "eslint src/ examples/ && NODE_APP_INSTANCE=test NODE_PATH=./ nyc mocha \"./src/**/*.spec.js\""
+    "test": "eslint src/ examples/ && NODE_APP_INSTANCE=test NODE_PATH=./ nyc --skip-full mocha \"./src/**/*.spec.js\""
   },
   "author": "Alexander Kravets <a@kra.vc>",
   "license": "ISC",

package/src/Service.spec.js

@@ -259,7 +259,9 @@ describe('Service', () => {
       expect(response.statusCode).to.eql(200)
     })
 
-    it('supports spec middleware', async () => {
+    it('supports spec middleware in dev environment', async () => {
+      process.env.NODE_APP_INSTANCE = 'dev'
+
       const lambdaFunction = request => service.handler(request)
 
       let request
@@ -272,6 +274,7 @@ describe('Service', () => {
 
       response = await lambdaFunction(request)
       expect(response.statusCode).to.eql(200)
+      expect(response.body.startsWith('<!DOCTYPE')).to.be.true
 
       request = {
         path:       '/Spec',
@@ -280,6 +283,56 @@ describe('Service', () => {
 
       response = await lambdaFunction(request)
       expect(response.statusCode).to.eql(200)
+
+      const body = JSON.parse(response.body)
+      expect(body.swagger).to.exist
+
+      process.env.NODE_APP_INSTANCE = undefined
+    })
+
+    it('does not expose spec middleware in non-dev environment', async () => {
+      const lambdaFunction = request => service.handler(request)
+
+      let request
+      let response
+
+      request = {
+        url:        'http://localhost:3000/',
+        httpMethod: 'GET'
+      }
+
+      response = await lambdaFunction(request)
+      expect(response.statusCode).to.eql(200)
+      expect(response.body).to.eql('healthy')
+
+      request = {
+        path:       '/Spec',
+        httpMethod: 'GET'
+      }
+
+      response = await lambdaFunction(request)
+      expect(response.statusCode).to.eql(200)
+
+      const body = JSON.parse(response.body)
+      expect(body.swagger).to.not.exist
+    })
+
+    it('logs operation input in non-test environment', async () => {
+      process.env.NODE_APP_INSTANCE = 'dev'
+
+      const lambdaFunction = request => service.handler(request)
+
+      await lambdaFunction({
+        url: 'http://localhost:3000/api/Health',
+        httpMethod: 'GET'
+      })
+
+      const id = 'HELLO_WORLD'
+      await exec('CreateProfile', {
+        mutation: { id, name: 'Hello, world!' }
+      }, { authorization })
+
+      process.env.NODE_APP_INSTANCE = undefined
     })
   })
 })

package/src/helpers/logRequest.js

@@ -1,9 +1,9 @@
 'use strict'
 
-const isTestEnvironment = process.env.NODE_APP_INSTANCE === 'test'
+const isTestEnvironment = () => process.env.NODE_APP_INSTANCE === 'test'
 
 const logRequest = context => {
-  if (isTestEnvironment) {
+  if (isTestEnvironment()) {
     return
   }
 

package/src/helpers/specMiddleware.js

@@ -7,32 +7,42 @@ const SWAGGER_UI_TEMPLATE_PATH = resolve(__dirname, '../../assets/index.html')
 const SWAGGER_UI_TEMPLATE = readFileSync(SWAGGER_UI_TEMPLATE_PATH, { encoding: 'utf8' })
 
 const ROOT_PATH = process.cwd()
-const { name: title } = require(`${ROOT_PATH}/package.json`)
+const { name: title, version } = require(`${ROOT_PATH}/package.json`)
 
 const SWAGGER_UI_HTML = SWAGGER_UI_TEMPLATE.replace('$TITLE', title)
 
+const isDevelopment = () => process.env.NODE_APP_INSTANCE === 'dev' || !process.env.NODE_APP_INSTANCE
+
+const _getHomeBody = () => isDevelopment() ? SWAGGER_UI_HTML : 'healthy'
+
+const _getSpecBody = (service) => isDevelopment() ? service.spec : { info: { title, version } }
+
 const specMiddleware = (service, context) => {
   const { httpPath, httpMethod } = context
 
   if (httpMethod !== 'get') { return null }
 
   if (httpPath === '/') {
+    const bodyText = _getHomeBody()
+
     return {
       headers: {
         'Content-Type': 'text/html; charset=UTF-8'
       },
       statusCode: 200,
-      body: SWAGGER_UI_HTML
+      body: bodyText,
     }
   }
 
   if (httpPath === '/Spec') {
+    const bodyJson = JSON.stringify(_getSpecBody(service), null, 2)
+
     return {
       headers: {
         'Content-Type': 'application/json; charset=utf-8'
       },
       statusCode: 200,
-      body: JSON.stringify(service.spec, null, 2)
+      body: bodyJson,
     }
   }