@thzero/library_server_fastify 0.18.11 → 0.18.13

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');

package/plugins/settings.js

@@ -1,13 +1,13 @@
-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) => {
-		request.config = opts.config;
-		request.correlationId = request.headers[LibraryServerConstants.Headers.CorrelationId];
-		next();
-	});
-
-	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) => {
+		request.config = opts.config;
+		request.correlationId = request.headers[LibraryServerConstants.Headers.CorrelationId];
+		next();
+	});
+
+	done();
 });

package/plugins/usageMetrics.js

@@ -1,25 +1,25 @@
-import fastifyPlugin from 'fastify-plugin';
-
-export default fastifyPlugin((instance, opts, done) => {
-	instance.addHook('onSend', (request, reply, payload, next) => {
-		(async () => {
-			const usageMetrics = {
-				url: request.routeOptions.url,
-				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('usageMetrics', 'start', 'usageMetrics', err);
-			});
-		})();
-
-		next();
-	});
-
-	done();
+import fastifyPlugin from 'fastify-plugin';
+
+export default fastifyPlugin((instance, opts, done) => {
+	instance.addHook('onSend', (request, reply, payload, next) => {
+		(async () => {
+			const usageMetrics = {
+				url: request.routeOptions.url,
+				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('usageMetrics', 'start', 'usageMetrics', err);
+			});
+		})();
+
+		next();
+	});
+
+	done();
 });

package/routes/admin/index.js

@@ -1,140 +1,140 @@
-import BaseRoute from '../index.js';
-
-class AdminBaseRoute extends BaseRoute {
-	constructor(urlFragment, role, serviceKey) {
-		if (!urlFragment)
-			throw Error('Invalid url fragment');
-
-		super(`/admin/${urlFragment}`);
-
-		this._options = {
-			role: role,
-			serviceKey: serviceKey
-		}
-
-		// this._service = null;
-	}
-
-	async init(injector, app, config) {
-		await super.init(injector, app, config);
-		this._inject(app, injector, this._options.serviceKey, this._options.serviceKey);
-	}
-
-	_allowsCreate() {
-		return true;
-	}
-
-	_allowsDelete() {
-		return true;
-	}
-
-	_allowsUpdate() {
-		return true;
-	}
-
-	_initializeRoutesCreate(router) {
-		const self = this;
-		router.post(this._join(''),
-			// authentication(true),
-			// authorization([ `${self._options.role}.create` ]),
-			{
-				preHandler: router.auth([
-					router.authenticationDefault,
-					router.authorizationDefault
-				], 
-				{ 
-					relation: 'and',
-					roles: [ `${self._options.role}.create` ]
-				}),
-			},
-			// eslint-disable-next-line
-			async (request, reply) => {
-				const response = (await router[this._options.serviceKey].create(request.correlationId, request.user, request.body)).check(request);
-				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
-				return  this._jsonResponse(reply, response);
-			}
-		);
-	}
-
-	_initializeRoutesDelete(router) {
-		router.delete(this._join('/:id'),
-			// authentication(true),
-			// authorization([ `${this._options.role}.delete` ]),
-			{
-				preHandler: router.auth([
-					router.authenticationDefault,
-					router.authorizationDefault
-				], 
-				{ 
-					relation: 'and',
-					roles: [ `${this._options.role}.delete` ]
-				}),
-			},
-			// eslint-disable-next-line
-			async (request, reply) => {
-				const response = (await router[this._options.serviceKey].delete(request.correlationId, request.user, request.params.id)).check(request);
-				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
-				return  this._jsonResponse(reply, response);
-			}
-		);
-	}
-
-	_initializeRoutesUpdate(router) {
-		router.post(this._join('/:id'),
-			// authentication(true),
-			// authorization([ `${this._options.role}.update` ]),
-			{
-				preHandler: router.auth([
-					router.authenticationDefault,
-					router.authorizationDefault
-				], 
-				{ 
-					relation: 'and',
-					roles: [ `${this._options.role}.update` ]
-				}),
-			},
-			// eslint-disable-next-line
-			async (request, reply) => {
-				const response = (await router[this._options.serviceKey].update(request.correlationId, request.user, request.params.id, request.body)).check(request);
-				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
-				return  this._jsonResponse(reply, response);
-			}
-		);
-	}
-
-	_initializeRoutes(router) {
-		if (this._allowsDelete)
-			this._initializeRoutesDelete(router);
-
-		router.post(this._join('/search'),
-			// authentication(true),
-			// authorization([ `${this._options.role}.search` ]),
-			{
-				preHandler: router.auth([
-					router.authenticationDefault,
-					router.authorizationDefault
-				], 
-				{ 
-					relation: 'and',
-					roles: [ `${this._options.role}.search` ]
-				}),
-			},
-			// eslint-disable-next-line
-			async (request, reply) => {
-				const response = (await router[this._options.serviceKey].search(request.correlationId, request.user, request.body)).check(request);
-				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
-				return  this._jsonResponse(reply, response);
-			}
-		);
-
-		if (this._allowsUpdate())
-			this._initializeRoutesUpdate(router);
-
-		if (this._allowsCreate())
-			this._initializeRoutesCreate(router);
-
-		return router;
-	}
-}
-
-export default AdminBaseRoute;
+import BaseRoute from '../index.js';
+
+class AdminBaseRoute extends BaseRoute {
+	constructor(urlFragment, role, serviceKey) {
+		if (!urlFragment)
+			throw Error('Invalid url fragment');
+
+		super(`/admin/${urlFragment}`);
+
+		this._options = {
+			role: role,
+			serviceKey: serviceKey
+		}
+
+		// this._service = null;
+	}
+
+	async init(injector, app, config) {
+		await super.init(injector, app, config);
+		this._inject(app, injector, this._options.serviceKey, this._options.serviceKey);
+	}
+
+	_allowsCreate() {
+		return true;
+	}
+
+	_allowsDelete() {
+		return true;
+	}
+
+	_allowsUpdate() {
+		return true;
+	}
+
+	_initializeRoutesCreate(router) {
+		const self = this;
+		router.post(this._join(''),
+			// authentication(true),
+			// authorization([ `${self._options.role}.create` ]),
+			{
+				preHandler: router.auth([
+					router.authenticationDefault,
+					router.authorizationDefault
+				], 
+				{ 
+					relation: 'and',
+					roles: [ `${self._options.role}.create` ]
+				}),
+			},
+			// eslint-disable-next-line
+			async (request, reply) => {
+				const response = (await router[this._options.serviceKey].create(request.correlationId, request.user, request.body)).check(request);
+				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
+				return  this._jsonResponse(reply, response);
+			}
+		);
+	}
+
+	_initializeRoutesDelete(router) {
+		router.delete(this._join('/:id'),
+			// authentication(true),
+			// authorization([ `${this._options.role}.delete` ]),
+			{
+				preHandler: router.auth([
+					router.authenticationDefault,
+					router.authorizationDefault
+				], 
+				{ 
+					relation: 'and',
+					roles: [ `${this._options.role}.delete` ]
+				}),
+			},
+			// eslint-disable-next-line
+			async (request, reply) => {
+				const response = (await router[this._options.serviceKey].delete(request.correlationId, request.user, request.params.id)).check(request);
+				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
+				return  this._jsonResponse(reply, response);
+			}
+		);
+	}
+
+	_initializeRoutesUpdate(router) {
+		router.post(this._join('/:id'),
+			// authentication(true),
+			// authorization([ `${this._options.role}.update` ]),
+			{
+				preHandler: router.auth([
+					router.authenticationDefault,
+					router.authorizationDefault
+				], 
+				{ 
+					relation: 'and',
+					roles: [ `${this._options.role}.update` ]
+				}),
+			},
+			// eslint-disable-next-line
+			async (request, reply) => {
+				const response = (await router[this._options.serviceKey].update(request.correlationId, request.user, request.params.id, request.body)).check(request);
+				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
+				return  this._jsonResponse(reply, response);
+			}
+		);
+	}
+
+	_initializeRoutes(router) {
+		if (this._allowsDelete)
+			this._initializeRoutesDelete(router);
+
+		router.post(this._join('/search'),
+			// authentication(true),
+			// authorization([ `${this._options.role}.search` ]),
+			{
+				preHandler: router.auth([
+					router.authenticationDefault,
+					router.authorizationDefault
+				], 
+				{ 
+					relation: 'and',
+					roles: [ `${this._options.role}.search` ]
+				}),
+			},
+			// eslint-disable-next-line
+			async (request, reply) => {
+				const response = (await router[this._options.serviceKey].search(request.correlationId, request.user, request.body)).check(request);
+				// https://github.com/fastify/fastify-compress/issues/215#issuecomment-1210598312
+				return  this._jsonResponse(reply, response);
+			}
+		);
+
+		if (this._allowsUpdate())
+			this._initializeRoutesUpdate(router);
+
+		if (this._allowsCreate())
+			this._initializeRoutesCreate(router);
+
+		return router;
+	}
+}
+
+export default AdminBaseRoute;

package/routes/admin/news.js

@@ -1,22 +1,22 @@
-import LibraryServerConstants from '@thzero/library_server/constants.js';
-
-import AdminRoute from './index.js';
-
-class NewsAdminRoute extends AdminRoute {
-	constructor(urlFragment, role, serviceKey) {
-		urlFragment = urlFragment ? urlFragment : 'news';
-		role = role ? role : 'news';
-		serviceKey = serviceKey ? serviceKey : LibraryServerConstants.InjectorKeys.SERVICE_ADMIN_NEWS;
-		super(urlFragment, role, serviceKey);
-	}
-
-	get id() {
-		return 'admin-news';
-	}
-
-	get _version() {
-		return 'v1';
-	}
-}
-
-export default NewsAdminRoute;
+import LibraryServerConstants from '@thzero/library_server/constants.js';
+
+import AdminRoute from './index.js';
+
+class NewsAdminRoute extends AdminRoute {
+	constructor(urlFragment, role, serviceKey) {
+		urlFragment = urlFragment ? urlFragment : 'news';
+		role = role ? role : 'news';
+		serviceKey = serviceKey ? serviceKey : LibraryServerConstants.InjectorKeys.SERVICE_ADMIN_NEWS;
+		super(urlFragment, role, serviceKey);
+	}
+
+	get id() {
+		return 'admin-news';
+	}
+
+	get _version() {
+		return 'v1';
+	}
+}
+
+export default NewsAdminRoute;