@pbvision/fastify-firestore-service 0.0.6 → 0.0.8

package/README.md

@@ -81,7 +81,6 @@ export default async (params) => makeService({
   },
   logging: {
     reportErrorDetail: true, // process.env.NODE_ENV === 'localhost',
-    useUnitTestLogFormat: true, // process.env.NODE_ENV === 'localhost',
     reportAllErrors: true // process.env.NODE_ENV !== 'prod'
   },
   swagger: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pbvision/fastify-firestore-service",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Web Framework using Fastify and Firestore ORM",
   "license": "Apache-2.0",
   "type": "module",
@@ -41,8 +41,8 @@
     "@fastify/static": "^6.12",
     "@fastify/swagger": "^8.1.0",
     "@fastify/swagger-ui": "^2.0.1",
-    "@pbvision/firestore-orm": "^0.0.3",
-    "@pbvision/schema": "^0.1.4",
+    "@pbvision/firestore-orm": "^0.0.6",
+    "@pbvision/schema": "^0.2.15",
     "@sentry/node": "^7.91.0",
     "fastify": "^4.10.0",
     "fastify-plugin": "^4.5.1",
@@ -55,10 +55,11 @@
     "@babel/eslint-parser": "^7.17.0",
     "@babel/plugin-transform-class-properties": "^7.12.1",
     "@babel/preset-env": "^7.17.12",
-    "@pbvision/jest-unit-test": "^0.2.0",
+    "@pbvision/jest-unit-test": "^0.2.3",
     "babel-loader": "^9.1.3",
     "eslint": "^8.22.0",
     "eslint-config-standard": "17.1.0",
+    "eslint-import-resolver-webpack": "^0.13.8",
     "eslint-plugin-import": "^2.22.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
@@ -67,7 +68,6 @@
     "jsdoc": "3.6.11",
     "license-webpack-plugin": "^4.0.2",
     "nodemon": "^3.0.2",
-    "pino-pretty": "^10.3.1",
     "standard": "^17.1.0",
     "superagent-defaults": "^0.1.14",
     "supertest": "^6.3.3",

package/src/make-app.js

@@ -1,8 +1,9 @@
+import Ajv from 'ajv/dist/2020.js'
 import fastify from 'fastify'
 import { v4 as uuidv4 } from 'uuid'
 
 import ComponentRegistrar from './component-registrar.js'
-import makeLogger from './make-logger.js'
+import { makePinoLoggerOptions } from './make-logger.js'
 import compressPlugin from './plugins/compress.js'
 import contentParserPlugin from './plugins/content-parser.js'
 import cookiePlugin from './plugins/cookie.js'
@@ -23,17 +24,19 @@ const COOKIE_CONFIG = {
 
 /**
  * @typedef {object} LoggingConfig
- * @property {boolean} [useUnitTestLogFormat=false] Whether output logs to console with
- *   pretty printing
  * @property {boolean} [reportAllErrors=false] Whether include all API
  *   validation errors in error logging. Recommend to keep it off for production,
  *   on for testing.
  * @property {boolean} [reportErrorDetail=false] Whether include all details
  *   of an error. Recommend to keep it off for remote testing, on for local
  *   testing.
+ * @property {String} [sentryDSN] The Sentry DSN to report errors to
+ * @property {function} [customizePinoOpts] An optional function customize the
+ *   arguments to pass to Pino. Takes as input the options that will be sent
+ *   to be Pino by default (can be modified). Return the new options.
  */
 const LOGGING_CONFIG = {
-  useUnitTestLogFormat: false,
+  customizePinoOpts: null,
   reportAllErrors: false,
   reportErrorDetail: false,
   sentryDSN: null
@@ -67,9 +70,10 @@ const SWAGGER_CONFIG = {
 
 /**
  * @typedef {object} LatencyTrackerConfig
- * @property {boolean} [disabled=false] Whether to add a health check endpoint
- *   that simply returns 200.
- * @property {string} [path='/'] The path to the health check endpoint.
+ * @property {boolean} [disabled=false] Whether to record how long from when we
+ *   start to process a request to when we start to send the response
+ * @property {string} [header='x-latency-ms'] response header to send the
+ *   latency info back in
  */
 const LATENCY_TRACKER_CONFIG = {
   disabled: false,
@@ -142,21 +146,54 @@ export default async function makeService (params = {}) {
   } = params
   const fastifyServerId = uuidv4()
   let requestCount = 0
+  const ajvParams = {
+    removeAdditional: false,
+    allErrors: logging.reportAllErrors,
+    useDefaults: true,
+    strictSchema: false,
+    strictRequired: true
+  }
+  const ajvObjs = {
+    coerceTypes: new Ajv({ ...ajvParams, coerceTypes: true }),
+    noCoerceTypes: new Ajv({ ...ajvParams, coerceTypes: false })
+  }
+  const logger = makePinoLoggerOptions(logging.customizePinoOpts)
   const app = fastify({
-    ignoreTrailingSlash: true,
     disableRequestLogging: true,
-    logger: makeLogger(logging.useUnitTestLogFormat),
-    genReqId: () => `${fastifyServerId}-${++requestCount}`,
-    ajv: {
-      customOptions: {
-        removeAdditional: false,
-        allErrors: logging.reportAllErrors,
-        useDefaults: true,
-        strictSchema: false,
-        strictRequired: true
-      }
-    }
+    logger,
+    genReqId: () => `${fastifyServerId}-${++requestCount}`
   })
+    .setValidatorCompiler(({ httpPart, schema }) => {
+      // header, route, and query string always come as strings; coerce them
+      // to the correct types if possible; body should come exactly in the
+      // right type so don't allow type coercion there
+      const useCoerce = httpPart !== 'body'
+      const ajv = useCoerce ? ajvObjs.coerceTypes : ajvObjs.noCoerceTypes
+      const validate = ajv.compile(schema)
+      return (value) => !validate(value)
+        ? ({ value, error: validate.errors })
+        : ({ value })
+    })
+    .addHook('onResponse', (req, reply, done) => {
+      let objToLog = {}
+      try {
+        objToLog = logger.serializers.res(reply.raw)
+        Object.assign(objToLog, logger.serializers.req(req))
+        // istanbul ignore else
+        if (latencyTracker.header) {
+          // latency in milliseconds
+          objToLog.latency = reply.getHeader(latencyTracker.header)
+        }
+      } catch (err) /* istanbul ignore next */ {
+        // crashes in onResponse() aren't reported or caught unless we do this
+        if (typeof objToLog !== 'object') {
+          objToLog = {}
+        }
+        objToLog.failedToLog = JSON.stringify(err)
+      }
+      req.log.info(objToLog)
+      done()
+    })
 
   const registrar = new RegistrarCls(app, service)
 

package/src/make-logger.js

@@ -1,119 +1,28 @@
-// istanbul ignore file
-import querystring from 'node:querystring'
-
-import pino from 'pino'
-import wrap from 'word-wrap'
-
-// for unit testing, output to the console INSTEAD of to stdout
-// via pino (so that jest captures the output and groups it with the right test
-// suite)
-function getUnitTestLogFormatOverrides () {
-  const prefixText = '/' + process.env.SERVICE + '/src/'
-  function prettifier () {
-    return (obj) => {
-      if (obj.req) {
-        const indent = ''
-        if (!obj.status) {
-          console.log(indent, obj.req.method, obj.req.path)
-        } else {
-          // output the status code and (if any) error message
-          const msgs = wrap(obj.msg || '', { width: 80, indent }).split('\n')
-          console.log(indent, ' \u2514 HTTP', obj.status, msgs[0])
-          msgs.slice(1).forEach(msg => {
-            console.log(indent, msg)
-          })
-          if (obj.error && obj.status >= 500) {
-            console.log(`${indent}Error: ${JSON.stringify(obj.error, null, 2)}`)
-          }
-          if (obj.stack) {
-            for (let i = 0; i < obj.stack.length; i++) {
-              console.log('  ', obj.stack[i])
-            }
-          }
-        }
-      } else {
-        // 1) Get the filename and line number the log message is from
-        // the index of the first non-pino line may change in future versions
-        // of fastify or pino; might be better to search each line until we
-        // find /<service>/src (if present)
-        const firstNonPinoLine = (new Error()).stack.split('\n')[5]
-        const appFolderIdx = firstNonPinoLine.indexOf(prefixText)
-        let prefix = ''
-        if (appFolderIdx !== -1) {
-          // prefix log message with filename and line number when logs
-          // originated in our app's source code
-          prefix = firstNonPinoLine.substring(
-            appFolderIdx + 9,
-            firstNonPinoLine.lastIndexOf(':')) + '  '
-        }
-
-        // 2) Create the logm msg: file, line, log message and log object
-        const indent = '  \u2502 '
-        const logObj = {}
-        const ignoredKeys = ['level', 'msg', 'reqId', 'time', 'v']
-        Object.getOwnPropertyNames(obj).forEach(key => {
-          if (ignoredKeys.indexOf(key) === -1) {
-            logObj[key] = obj[key]
-          }
-        })
-        let msg = indent + prefix + (obj.msg || '')
-        if (Object.keys(logObj).length) {
-          msg += (obj.msg ? ' ' : '') + JSON.stringify(logObj)
-        }
-        if (obj.level < 30) {
-          console.debug(msg)
-        } else if (obj.level >= 50) {
-          console.error(msg)
-        } else if (obj.level >= 40) {
-          console.warn(msg)
-        } else {
-          console.log(msg)
-        }
-      }
-      return '' // skip pino logging
-    }
-  }
-  return {
-    prettifier,
-    transport: {
-      target: 'pino-pretty',
-      options: {
-        colorize: true
-      }
-    }
-  }
-}
-
-export default function makeCustomLogger (useUnitTestLogFormat) {
+export function makePinoLoggerOptions (customizeOpts) {
   function serializeReq (req) {
     const q = req.query
+    // istanbul ignore else
     if (req.raw) {
       req = req.raw
     }
     const path = req.path
-    const qs = req.qs
     return {
       app: req.headers['x-app'] || '',
       uid: req.headers['x-uid'] || '',
       method: req.method,
       ua: req.headers['user-agent'] || '',
       path,
-      q: q || querystring.decode(qs)
+      q
     }
   }
-  const options = {
+  customizeOpts = customizeOpts ?? (x => x)
+  const options = customizeOpts({
     base: null, // omit pino default fields like pid and hostname
-    level: (process.env.NODE_ENV === 'prod') ? 'info' : 'debug',
+    level: 'debug',
     serializers: {
       req: serializeReq,
-      res: (res) => {
-        return { status: res.statusCode, req: serializeReq(res.req) }
-      }
+      res: res => ({ status: res.statusCode })
     }
-  }
-  // on localhost, we customize the logs to optimize for console-based debugging
-  if (useUnitTestLogFormat) {
-    Object.assign(options, getUnitTestLogFormatOverrides())
-  }
-  return pino(options)
+  })
+  return options
 }

package/src/plugins/latency-tracker.js

@@ -27,17 +27,6 @@ export default fp(function (fastify, options, next) {
     return payload
   })
 
-  fastify.addHook('onResponse', (req, reply, done) => {
-    // if errored, then it was already logged
-    if (!reply.raw.logged) {
-      req.log.info({
-        req,
-        status: reply.raw.statusCode,
-        latency: reply.getHeader(header)
-      })
-    }
-    done()
-  })
   next()
 }, {
   fastify: '>=3.x',

package/test/environment.js

@@ -1,3 +1,3 @@
-import '@pbvision/firestore-orm/environment.js'
+import '../node_modules/@pbvision/firestore-orm/environment.js'
 
 process.env.NODE_ENV = 'localhost'