@thzero/library_server_fastify 0.17.5 → 0.17.6

package/package.json

@@ -1,42 +1,42 @@
-{
-  "name": "@thzero/library_server_fastify",
-  "type": "module",
-  "version": "0.17.5",
-  "version_major": 0,
-  "version_minor": 17,
-  "version_patch": 5,
-  "version_date": "03/18/2023",
-  "description": "An opinionated library of common functionality to bootstrap a Fastify based API application.",
-  "author": "thZero",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thzero/library_server_fastify.git"
-  },
-  "bugs": {
-    "url": "https://github.com/thzero/library_server_fastify/issues"
-  },
-  "homepage": "https://github.com/thzero/library_server_fastify#readme",
-  "engines": {
-    "node": ">=12.8.3"
-  },
-  "scripts": {
-    "cli-update": "library-cli --updateversion --pi",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "dependencies": {
-    "@fastify/auth": "^4.2.0",
-    "@fastify/compress": "^6.2.0",
-    "@fastify/cors": "^8.2.0",
-    "@fastify/helmet": "^10.1.0",
-    "@fastify/routes": "^5.1.0",
-    "@fastify/static": "^6.9.0",
-    "async-mutex": "^0.4.0",
-    "fastify": "^4.14.1"
-  },
-  "peerDependencies": {
-    "@thzero/library_common": "^0.17",
-    "@thzero/library_common_service": "^0.17",
-    "@thzero/library_server": "^0.17"
-  }
+{
+  "name": "@thzero/library_server_fastify",
+  "type": "module",
+  "version": "0.17.6",
+  "version_major": 0,
+  "version_minor": 17,
+  "version_patch": 6,
+  "version_date": "03/18/2023",
+  "description": "An opinionated library of common functionality to bootstrap a Fastify based API application.",
+  "author": "thZero",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thzero/library_server_fastify.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thzero/library_server_fastify/issues"
+  },
+  "homepage": "https://github.com/thzero/library_server_fastify#readme",
+  "engines": {
+    "node": ">=12.8.3"
+  },
+  "scripts": {
+    "cli-update": "library-cli --updateversion --pi",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@fastify/auth": "^4.2.0",
+    "@fastify/compress": "^6.2.0",
+    "@fastify/cors": "^8.2.1",
+    "@fastify/helmet": "^10.1.0",
+    "@fastify/routes": "^5.1.0",
+    "@fastify/static": "^6.9.0",
+    "async-mutex": "^0.4.0",
+    "fastify": "^4.14.1"
+  },
+  "peerDependencies": {
+    "@thzero/library_common": "^0.17",
+    "@thzero/library_common_service": "^0.17",
+    "@thzero/library_server": "^0.17"
+  }
 }

package/plugins/apiKey.js

@@ -1,49 +1,49 @@
-import fastifyPlugin from 'fastify-plugin';
-
-import LibraryServerConstants from '@thzero/library_server/constants.js';
-
-export default fastifyPlugin((instance, opts, done) => {
-	instance.addHook('onRequest', (request, reply, next) => {
-		if (request.originalUrl === '/favicon.ico') {
-			next();
-			return;
-		}
-
-		const key = request.headers[LibraryServerConstants.Headers.AuthKeys.API];
-		// opts.logger.debug('KoaBootMain', 'start', 'auth-api-token.key', key);
-		if (!String.isNullOrEmpty(key)) {
-			const auth = request.config.get('auth');
-			if (auth) {
-				const apiKey = auth.apiKey;
-				// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.apiKey', apiKey);
-				// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.key===apiKey', (key === apiKey));
-				if (key === apiKey) {
-					request.apiKey = key;
-					next();
-					return;
-				}
-			}
-		}
-
-		(async () => {
-			const usageMetrics = {
-				url: request.routerPath,
-				correlationId: request.correlationId,
-				href: request.url,
-				headers: request.headers,
-				host: request.hostname,
-				hostname: request.hostname,
-				querystring: request.query,
-				token: request.token
-			};
-			await opts.usageMetrics.register(usageMetrics).catch((err) => {
-				opts.logger.error('FastifyBootMain', 'start', 'usageMetrics', err);
-			});
-		})();
-
-		console.log('Unauthorized... auth-api-token failure');
-		reply.status(401).send();
-	});
-
-	done();
+import fastifyPlugin from 'fastify-plugin';
+
+import LibraryServerConstants from '@thzero/library_server/constants.js';
+
+export default fastifyPlugin((instance, opts, done) => {
+	instance.addHook('onRequest', (request, reply, next) => {
+		if (request.originalUrl === '/favicon.ico') {
+			next();
+			return;
+		}
+
+		const key = request.headers[LibraryServerConstants.Headers.AuthKeys.API];
+		// opts.logger.debug('KoaBootMain', 'start', 'auth-api-token.key', key);
+		if (!String.isNullOrEmpty(key)) {
+			const auth = request.config.get('auth');
+			if (auth) {
+				const apiKey = auth.apiKey;
+				// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.apiKey', apiKey);
+				// this.loggerServiceI.debug('KoaBootMain', 'start', 'auth-api-token.key===apiKey', (key === apiKey));
+				if (key === apiKey) {
+					request.apiKey = key;
+					next();
+					return;
+				}
+			}
+		}
+
+		(async () => {
+			const usageMetrics = {
+				url: request.routerPath,
+				correlationId: request.correlationId,
+				href: request.url,
+				headers: request.headers,
+				host: request.hostname,
+				hostname: request.hostname,
+				querystring: request.query,
+				token: request.token
+			};
+			await opts.usageMetrics.register(usageMetrics).catch((err) => {
+				opts.logger.error('FastifyBootMain', 'start', 'usageMetrics', err);
+			});
+		})();
+
+		console.log('Unauthorized... auth-api-token failure');
+		reply.status(401).send();
+	});
+
+	done();
 });

package/plugins/auth.js

@@ -1,125 +1,125 @@
-'use strict'
-
-// const fp = require('fastify-plugin')
-import fp from 'fastify-plugin'
-// const reusify = require('reusify')
-import reusify from 'reusify'
-
-function checkAuth (fastify, opts, next) {
-  fastify.decorate('auth', auth)
-  next()
-}
-
-function auth (functions, opts) {
-  if (!Array.isArray(functions)) {
-    throw new Error('You must give an array of functions to the auth function')
-  }
-  if (!functions.length) {
-    throw new Error('Missing auth functions')
-  }
-
-  const options = Object.assign({
-    relation: 'or',
-    run: null
-  }, opts)
-
-  if (options.relation !== 'or' && options.relation !== 'and') {
-    throw new Error('The value of options.relation should be one of [\'or\', \'and\']')
-  }
-  if (options.run && options.run !== 'all') {
-    throw new Error('The value of options.run must be \'all\'')
-  }
-
-  /* eslint-disable-next-line no-var */
-  for (var i = 0; i < functions.length; i++) {
-    functions[i] = functions[i].bind(this)
-  }
-
-  const instance = reusify(Auth)
-
-  function _auth (request, reply, done) {
-    const obj = instance.get()
-
-    obj.request = request
-    obj.reply = reply
-    obj.done = done
-    obj.functions = this.functions
-    obj.options = this.options
-    obj.i = 0
-    obj.start = true
-    obj.firstResult = null
-
-    obj.nextAuth()
-  }
-
-  return _auth.bind({ functions, options })
-
-  function Auth () {
-    this.next = null
-    this.i = 0
-    this.start = true
-    this.functions = []
-    this.options = {}
-    this.request = null
-    this.reply = null
-    this.done = null
-    this.firstResult = null
-
-    const that = this
-
-    this.nextAuth = function nextAuth (err) {
-      const func = that.functions[that.i++]
-
-      if (!func) {
-        that.completeAuth(err)
-        return
-      }
-
-      const maybePromise = func(that.request, that.reply, that.onAuth, that.options)
-
-      if (maybePromise && typeof maybePromise.then === 'function') {
-        maybePromise.then(results => that.onAuth(null, results), that.onAuth)
-      }
-    }
-
-    this.onAuth = function onAuth (err, results) {
-      if (that.options.relation === 'or') {
-        if (err) {
-          return that.nextAuth(err)
-        }
-
-        return that.completeAuth()
-      } else {
-        if (err) {
-          return that.completeAuth(err)
-        }
-
-        return that.nextAuth(err)
-      }
-    }
-
-    this.completeAuth = function (err) {
-      if (that.start) {
-        that.start = false
-        that.firstResult = err
-      }
-
-      if (that.options.run === 'all' && that.i < that.functions.length) {
-        return that.nextAuth(err)
-      }
-
-      if (that.firstResult && (!that.reply.raw.statusCode || that.reply.raw.statusCode < 400)) {
-        that.reply.code(401)
-      } else if (!that.firstResult && that.reply.raw.statusCode && that.reply.raw.statusCode >= 400) {
-        that.reply.code(200)
-      }
-
-      that.done(that.firstResult)
-      instance.release(that)
-    }
-  }
-}
-
-export default fp(checkAuth, {
-	fastify: '4.x'
+'use strict'
+
+// const fp = require('fastify-plugin')
+import fp from 'fastify-plugin'
+// const reusify = require('reusify')
+import reusify from 'reusify'
+
+function checkAuth (fastify, opts, next) {
+  fastify.decorate('auth', auth)
+  next()
+}
+
+function auth (functions, opts) {
+  if (!Array.isArray(functions)) {
+    throw new Error('You must give an array of functions to the auth function')
+  }
+  if (!functions.length) {
+    throw new Error('Missing auth functions')
+  }
+
+  const options = Object.assign({
+    relation: 'or',
+    run: null
+  }, opts)
+
+  if (options.relation !== 'or' && options.relation !== 'and') {
+    throw new Error('The value of options.relation should be one of [\'or\', \'and\']')
+  }
+  if (options.run && options.run !== 'all') {
+    throw new Error('The value of options.run must be \'all\'')
+  }
+
+  /* eslint-disable-next-line no-var */
+  for (var i = 0; i < functions.length; i++) {
+    functions[i] = functions[i].bind(this)
+  }
+
+  const instance = reusify(Auth)
+
+  function _auth (request, reply, done) {
+    const obj = instance.get()
+
+    obj.request = request
+    obj.reply = reply
+    obj.done = done
+    obj.functions = this.functions
+    obj.options = this.options
+    obj.i = 0
+    obj.start = true
+    obj.firstResult = null
+
+    obj.nextAuth()
+  }
+
+  return _auth.bind({ functions, options })
+
+  function Auth () {
+    this.next = null
+    this.i = 0
+    this.start = true
+    this.functions = []
+    this.options = {}
+    this.request = null
+    this.reply = null
+    this.done = null
+    this.firstResult = null
+
+    const that = this
+
+    this.nextAuth = function nextAuth (err) {
+      const func = that.functions[that.i++]
+
+      if (!func) {
+        that.completeAuth(err)
+        return
+      }
+
+      const maybePromise = func(that.request, that.reply, that.onAuth, that.options)
+
+      if (maybePromise && typeof maybePromise.then === 'function') {
+        maybePromise.then(results => that.onAuth(null, results), that.onAuth)
+      }
+    }
+
+    this.onAuth = function onAuth (err, results) {
+      if (that.options.relation === 'or') {
+        if (err) {
+          return that.nextAuth(err)
+        }
+
+        return that.completeAuth()
+      } else {
+        if (err) {
+          return that.completeAuth(err)
+        }
+
+        return that.nextAuth(err)
+      }
+    }
+
+    this.completeAuth = function (err) {
+      if (that.start) {
+        that.start = false
+        that.firstResult = err
+      }
+
+      if (that.options.run === 'all' && that.i < that.functions.length) {
+        return that.nextAuth(err)
+      }
+
+      if (that.firstResult && (!that.reply.raw.statusCode || that.reply.raw.statusCode < 400)) {
+        that.reply.code(401)
+      } else if (!that.firstResult && that.reply.raw.statusCode && that.reply.raw.statusCode >= 400) {
+        that.reply.code(200)
+      }
+
+      that.done(that.firstResult)
+      instance.release(that)
+    }
+  }
+}
+
+export default fp(checkAuth, {
+	fastify: '4.x'
 })

package/plugins/responseTime.js

@@ -1,112 +1,112 @@
-// https://github.com/lolo32/fastify-response-time
-import fastifyPlugin from 'fastify-plugin';
-
-const symbolRequestTime = Symbol('RequestTimer');
-const symbolServerTiming = Symbol('ServerTiming');
-
-/**
- *
- * @param {string} name
- * @param {number|string} duration
- * @param {string} description
- * @return {string}
- */
-const genTick = (name, duration, description) => {
-	let val = name;
-	// Parse duration. If could not be converted to float, does not add it
-	duration = parseFloat(duration);
-	if (!isNaN(duration)) {
-		val += `;dur=${duration}`;
-	}
-	// Parse the description. If empty, doest not add it. If string with space, double quote value
-	if ('string' === typeof description) {
-		val += `;desc=${description.includes(' ') ? `'${description}'` : description}`;
-	}
-
-	return val;
-};
-
-/**
- * Decorators
- *
- * @param {fastify} instance
- * @param {function} instance.decorateReply
- * @param {Object} opts
- * @param {function} next
- */
-export default fastifyPlugin((instance, opts, done) => {
-	// Check the options, and corrects with the default values if inadequate
-	if (isNaN(opts.digits) || 0 > opts.digits) {
-		opts.digits = 2;
-	}
-	opts.header = opts.header || 'X-Response-Time';
-
-	// Hook to be triggered on request (start time)
-	instance.addHook('onRequest', (request, reply, next) => {
-		// Store the start timer in nanoseconds resolution
-		// istanbul ignore next
-		if (request.raw && reply.raw) {
-			// support fastify >= v2
-			request.raw[symbolRequestTime] = process.hrtime();
-			reply.raw[symbolServerTiming] = {};
-		} 
-		else if (request.req && reply.res) {
-			// support fastify >= v2
-			request.req[symbolRequestTime] = process.hrtime();
-			reply.res[symbolServerTiming] = {};
-		} 
-		else {
-			request[symbolRequestTime] = process.hrtime();
-			reply[symbolServerTiming] = {};
-		}
-
-		next();
-	});
-
-	// Hook to be triggered just before response to be send
-	instance.addHook('onSend', (request, reply, payload, next) => {
-		const headers = [];
-
-		// check if Server-Timing need to be added
-		const serverTiming = (reply.raw ? reply.raw[symbolServerTiming] : reply.res[symbolServerTiming]);
-		if (serverTiming) {
-			for (const name of Object.keys(serverTiming)) {
-				headers.push(serverTiming[name]);
-			}
-			if (headers.length) {
-				reply.header('Server-Timing', headers.join(','));
-			}
-		}
-
-		// Calculate the duration, in nanoseconds …
-		const hrDuration = (request.raw ? request.raw[symbolRequestTime] : request.req[symbolRequestTime]);
-		if (hrDuration) {
-			// … convert it to milliseconds …
-			const duration = (hrDuration[0] * 1e3 + hrDuration[1] / 1e6).toFixed(opts.digits);
-			// … add the header to the response
-			reply.header(opts.header, duration);
-
-			opts.logger.info2(`${request.method} ${request.url} - ${duration}`);
-		}
-
-		next();
-	});
-
-	// Can be used to add custom timing information
-	instance.decorateReply('setServerTiming', function (name, duration, description) {
-		// Reference to the res object storing values …
-		const serverTiming = this.res[symbolServerTiming];
-		// … return if value already exists (all subsequent occurrences MUST be ignored without signaling an error) …
-		if (serverTiming.hasOwnProperty(name)) {
-			return false;
-		}
-		// … add the value the the list to send later
-		serverTiming[name] = genTick(name, duration, description);
-		// … return true, the value was added to the list
-		return true;
-	});
-
-	done();
-});
-// Not before 0.31 (onSend hook added to this version)
+// https://github.com/lolo32/fastify-response-time
+import fastifyPlugin from 'fastify-plugin';
+
+const symbolRequestTime = Symbol('RequestTimer');
+const symbolServerTiming = Symbol('ServerTiming');
+
+/**
+ *
+ * @param {string} name
+ * @param {number|string} duration
+ * @param {string} description
+ * @return {string}
+ */
+const genTick = (name, duration, description) => {
+	let val = name;
+	// Parse duration. If could not be converted to float, does not add it
+	duration = parseFloat(duration);
+	if (!isNaN(duration)) {
+		val += `;dur=${duration}`;
+	}
+	// Parse the description. If empty, doest not add it. If string with space, double quote value
+	if ('string' === typeof description) {
+		val += `;desc=${description.includes(' ') ? `'${description}'` : description}`;
+	}
+
+	return val;
+};
+
+/**
+ * Decorators
+ *
+ * @param {fastify} instance
+ * @param {function} instance.decorateReply
+ * @param {Object} opts
+ * @param {function} next
+ */
+export default fastifyPlugin((instance, opts, done) => {
+	// Check the options, and corrects with the default values if inadequate
+	if (isNaN(opts.digits) || 0 > opts.digits) {
+		opts.digits = 2;
+	}
+	opts.header = opts.header || 'X-Response-Time';
+
+	// Hook to be triggered on request (start time)
+	instance.addHook('onRequest', (request, reply, next) => {
+		// Store the start timer in nanoseconds resolution
+		// istanbul ignore next
+		if (request.raw && reply.raw) {
+			// support fastify >= v2
+			request.raw[symbolRequestTime] = process.hrtime();
+			reply.raw[symbolServerTiming] = {};
+		} 
+		else if (request.req && reply.res) {
+			// support fastify >= v2
+			request.req[symbolRequestTime] = process.hrtime();
+			reply.res[symbolServerTiming] = {};
+		} 
+		else {
+			request[symbolRequestTime] = process.hrtime();
+			reply[symbolServerTiming] = {};
+		}
+
+		next();
+	});
+
+	// Hook to be triggered just before response to be send
+	instance.addHook('onSend', (request, reply, payload, next) => {
+		const headers = [];
+
+		// check if Server-Timing need to be added
+		const serverTiming = (reply.raw ? reply.raw[symbolServerTiming] : reply.res[symbolServerTiming]);
+		if (serverTiming) {
+			for (const name of Object.keys(serverTiming)) {
+				headers.push(serverTiming[name]);
+			}
+			if (headers.length) {
+				reply.header('Server-Timing', headers.join(','));
+			}
+		}
+
+		// Calculate the duration, in nanoseconds …
+		const hrDuration = (request.raw ? request.raw[symbolRequestTime] : request.req[symbolRequestTime]);
+		if (hrDuration) {
+			// … convert it to milliseconds …
+			const duration = (hrDuration[0] * 1e3 + hrDuration[1] / 1e6).toFixed(opts.digits);
+			// … add the header to the response
+			reply.header(opts.header, duration);
+
+			opts.logger.info2(`${request.method} ${request.url} - ${duration}`);
+		}
+
+		next();
+	});
+
+	// Can be used to add custom timing information
+	instance.decorateReply('setServerTiming', function (name, duration, description) {
+		// Reference to the res object storing values …
+		const serverTiming = this.res[symbolServerTiming];
+		// … return if value already exists (all subsequent occurrences MUST be ignored without signaling an error) …
+		if (serverTiming.hasOwnProperty(name)) {
+			return false;
+		}
+		// … add the value the the list to send later
+		serverTiming[name] = genTick(name, duration, description);
+		// … return true, the value was added to the list
+		return true;
+	});
+
+	done();
+});
+// Not before 0.31 (onSend hook added to this version)
 // }, '>= 0.31');