@thzero/library_server 0.14.4 → 0.14.8

package/boot/index.js

@@ -1,4 +1,6 @@
-import internalIp from 'internal-ip';
+// import internalIp from 'internal-ip';
+// Until author fixes the issue with version 7+
+import {internalIpV6, internalIpV4} from '@thzero/library_server/utility/internalIp';
 
 import { createTerminus } from '@godaddy/terminus';
 
@@ -105,7 +107,7 @@ class BootMain {
 		await listen(this.port);
 		this.address = serverHttp.address() ? serverHttp.address().address : null;
 		if (this.address === '::')
-			this.address = await internalIp.v4();
+			this.address = await internalIpV4();
 
 		await this._initServer(serverHttp);
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@thzero/library_server",
-  "version": "0.14.4",
+  "version": "0.14.8",
   "version_major": 0,
   "version_minor": 14,
-  "version_patch": 4,
-  "version_date": "10/13/2021",
+  "version_patch": 8,
+  "version_date": "10/20/2021",
   "description": "An opinionated library of common functionality to bootstrap a Koa based API application using MongoDb and Firebase.",
   "author": "thZero",
   "license": "MIT",
@@ -32,16 +32,17 @@
     "config": "^3.3.6",
     "dayjs": "^1.10.7",
     "dayjs-plugin-utc": "^0.1.2",
+    "default-gateway": "^6.0.3",
     "easy-rbac": "^3.1.1",
     "esm": "^3.2.25",
-    "internal-ip": "^6.2.0",
-    "koa": "^2.13.3",
+    "ipaddr.js": "^2.0.1",
+    "koa": "^2.13.4",
     "koa-body": "^4.2.0",
     "koa-helmet": "^6.1.0",
     "koa-static": "^5.0.0"
   },
   "devDependencies": {
-    "@thzero/library_cli": "^0.13.20"
+    "@thzero/library_cli": "^0.13.21"
   },
   "peerDependencies": {
     "@thzero/library_common": "^0.14",
@@ -50,10 +51,10 @@
     "@babel/plugin-proposal-class-properties": "^7.14.5",
     "@babel/preset-env": "^7.15.8",
     "babel-loader": "^8.2.2",
-    "eslint": "^8.0.0",
+    "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.1.0",
-    "pino-pretty": "^7.0.1",
-    "webpack": "^5.58.1",
-    "webpack-cli": "^4.9.0"
+    "pino-pretty": "^7.1.0",
+    "webpack": "^5.59.0",
+    "webpack-cli": "^4.9.1"
   }
 }

package/utility/internalIp/index.js

@@ -0,0 +1,49 @@
+import {networkInterfaces} from 'os';
+import defaultGateway from 'default-gateway';
+import ip from 'ipaddr.js';
+
+function findIp(gateway) {
+	const gatewayIp = ip.parse(gateway);
+
+	// Look for the matching interface in all local interfaces.
+	for (const addresses of Object.values(networkInterfaces())) {
+		for (const {cidr} of addresses) {
+			const net = ip.parseCIDR(cidr);
+
+			// eslint-disable-next-line unicorn/prefer-regexp-test
+			if (net[0] && net[0].kind() === gatewayIp.kind() && gatewayIp.match(net)) {
+				return net[0].toString();
+			}
+		}
+	}
+}
+
+async function async(family) {
+	try {
+		const {gateway} = await defaultGateway[family]();
+		return findIp(gateway);
+	} catch {}
+}
+
+function sync(family) {
+	try {
+		const {gateway} = defaultGateway[family].sync();
+		return findIp(gateway);
+	} catch {}
+}
+
+export async function internalIpV6() {
+	return async('v6');
+}
+
+export async function internalIpV4() {
+	return async('v4');
+}
+
+export function internalIpV6Sync() {
+	return sync('v6');
+}
+
+export function internalIpV4Sync() {
+	return sync('v4');
+}

package/boot/index.js.bak

@@ -1,362 +0,0 @@
-import internalIp from 'internal-ip';
-
-import { createTerminus } from '@godaddy/terminus';
-
-import config from 'config';
-
-import LibraryConstants from '../constants';
-import LibraryCommonServiceConstants from '@thzero/library_common_service/constants';
-
-import Utility from '@thzero/library_common/utility';
-
-import NotImplementedError from '@thzero/library_common/errors/notImplemented';
-
-require('@thzero/library_common/utility/string');
-import injector from '@thzero/library_common/utility/injector';
-
-import usageMetricsRepository from '../repository/usageMetrics/devnull';
-
-import configService from '../service/config';
-import loggerService from '@thzero/library_common_service/service/logger';
-import usageMetricsService from '../service/usageMetrics';
-
-class BootMain {
-	async start(...args) {
-		process.on('uncaughtException', function(err) {
-			console.log('Caught exception', err);
-			return process.exit(99);
-		});
-
-		this._injector = injector;
-
-		// https://github.com/lorenwest/node-config/wiki
-		this._appConfig = new configService(config.get('app'));
-
-		this._servicesPost = new Map();
-
-		const plugins = this._determinePlugins(args);
-		await await this._initPlugins(plugins);
-
-		const app = await this._initApp(args, plugins);
-
-		this.port = this._appConfig.get('port');
-		this.loggerServiceI.info2(`config.port: ${this.port}`);
-		this.loggerServiceI.info2(`process.env.PORT: ${process.env.PORT}`);
-		this.port = process.env.PORT || this.port;
-		this.loggerServiceI.info2(`selected.port: ${this.port}`);
-		const serverHttp = require('http').createServer(app.callback());
-
-		function onSignal() {
-			this.loggerServiceI.info2(`server is starting cleanup`);
-			const cleanupFuncs = [];
-			this._initCleanup(cleanupFuncs);
-			this._initCleanupDiscovery(cleanupFuncs);
-			return Promise.all(cleanupFuncs);
-		}
-
-		function onShutdown() {
-			this._initShutdown();
-			this.loggerServiceI.info2(`cleanup finished, server is shutting down`);
-		}
-
-		function healthCheck() {
-			return Promise.resolve(
-				// optionally include a resolve value to be included as
-				// info in the health check response
-			)
-		}
-
-		const healthcheckPath = this._appConfig.get('healthcheck.path', LibraryConstants.HealthCheck.DefaultPath);
-		if (!healthcheckPath.startsWith('/'))
-			healthcheckPath = '/' + healthcheckPath;
-
-		const healthCheckOptions = {
-			verbatim: true // [optional = false] use object returned from /healthcheck verbatim in response
-		};
-		if (healthCheck)
-			healthCheckOptions[healthcheckPath] = healthCheck;
-
-		const terminusOptions = {
-			// health check options
-			// healthChecks: {
-			// 	healthcheckPath: healthCheck, // a function returning a promise indicating service health,
-			// 	verbatim: true // [optional = false] use object returned from /healthcheck verbatim in response
-			// },
-			healthChecks: healthCheckOptions,
-
-			// cleanup options
-			signals: [ 'SIGINT', 'SIGTERM' ],
-			onSignal: onSignal.bind(this), // [optional] cleanup function, returning a promise (used to be onSigterm)
-			onShutdown: onShutdown.bind(this) // [optional] called right before exiting
-		};
-
-		createTerminus(serverHttp, terminusOptions);
-
-		const listen = async (port) => new Promise((resolve, reject) => {
-			serverHttp.listen(port, (err) => {
-				if (err) {
-					reject(err);
-					return;
-				}
-
-				resolve();
-			});
-		});
-		await listen(this.port);
-		this.address = serverHttp.address() ? serverHttp.address().address : null;
-		if (this.address === '::')
-			this.address = await internalIp.v4();
-
-		await this._initServer(serverHttp);
-
-		for (const [key, value] of this._servicesPost) {
-			console.log(`services.init.post - ${key}`);
-			if (value.initPost)
-				await value.initPost();
-		}
-		this._initAppPost(app, args);
-
-		await this._initServerDiscovery(serverHttp);
-
-		this.loggerServiceI.info2(`Starting HTTP on: `, this.address);
-	}
-
-	async _initApp(args, plugins) {
-		throw new NotImplementedError();
-	}
-
-	async _initAppPost(app, args) {
-	}
-
-	_determinePlugins(args) {
-		let obj;
-		const results = [];
-		for (const plugin of args) {
-			obj = new plugin();
-			obj.init(this._appConfig, injector);
-			results.push(obj);
-		}
-		return results;
-	}
-
-	async _initPlugins(plugins) {
-		try {
-			injector.addSingleton(LibraryCommonServiceConstants.InjectorKeys.SERVICE_CONFIG, this._appConfig);
-
-			this._repositories = new Map();
-
-			for (const pluginRepository of plugins)
-				await pluginRepository.initRepositories(this._repositories);
-
-			await this._initRepositories();
-			this._injectRepository(LibraryConstants.InjectorKeys.REPOSITORY_USAGE_METRIC, this._initRepositoriesUsageMetrics());
-
-			this._services = new Map();
-
-			this.loggerServiceI = this._initServicesLogger();
-			this._initServicesLoggers();
-			this._injectService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_LOGGER, this.loggerServiceI);
-
-			const monitoringService = this._initServicesMonitoring();
-			if (monitoringService)
-				this._injectService(LibraryCommonServiceConstants.InjectorKeys.SERVICE_MONITORING, monitoringService);
-
-			this.usageMetricsServiceI = this._initServicesUsageMetrics();
-			this._injectService(LibraryConstants.InjectorKeys.SERVICE_USAGE_METRIC, this.usageMetricsServiceI);
-
-			this.resourceDiscoveryServiceI = this._initServicesDiscoveryResources();
-			if (this.resourceDiscoveryServiceI)
-				this._injectService(LibraryConstants.InjectorKeys.SERVICE_DISCOVERY_RESOURCES, this.resourceDiscoveryServiceI);
-
-			this.mdnsDiscoveryServiceI = this._initServicesDiscoveryMdns();
-			if (this.mdnsDiscoveryServiceI)
-				this._injectService(LibraryConstants.InjectorKeys.SERVICE_DISCOVERY_MDNS, this.mdnsDiscoveryServiceI);
-
-			for (const pluginService of plugins)
-				await pluginService.initServices(this._services);
-
-			await this._initServices();
-
-			for (const [key, value] of this._repositories) {
-				console.log(`repositories.init - ${key}`);
-				await value.init(injector);
-			}
-
-			for (const [key, value] of this._services) {
-				console.log(`services.init - ${key}`);
-				await value.init(injector);
-
-				this._servicesPost.set(key, value);
-			}
-
-			this._services = new Map();
-
-			await this._initServicesSecondary();
-
-			for (const pluginService of plugins)
-				await pluginService.initServicesSecondary(this._services);
-
-			for (const [key, value] of this._services) {
-				if (value.initialized)
-					continue;
-
-				console.log(`services.init.secondary - ${key}`);
-				await value.init(injector);
-
-				this._servicesPost.set(key, value);
-			}
-
-			Utility.initDateTime();
-		}
-		finally {
-			this._repositories = null;
-			this._services = null;
-		}
-	}
-
-	_initCleanup(cleanupFuncs) {
-		// your clean logic, like closing database connections
-	}
-
-	_initCleanupDiscovery(cleanupFuncs) {
-		if (this.resourceDiscoveryServiceI)
-			cleanupFuncs.push(this.resourceDiscoveryServiceI.cleanup());
-		if (this.mdnsDiscoveryServiceI)
-			cleanupFuncs.push(this.mdnsDiscoveryServiceI.cleanup());
-	}
-
-	_initPostAuth(app) {
-	}
-
-	_initPreAuth(app) {
-	}
-
-	_initPostRoutes(app) {
-	}
-
-	_initPreRoutes(app) {
-	}
-
-	async _initRepositories() {
-	}
-
-	_initRepositoriesUsageMetrics() {
-		return new usageMetricsRepository();
-	}
-
-	_initRoute(route) {
-	}
-
-	async _initRoutes() {
-	}
-
-	async _initServices() {
-	}
-
-	async _initServicesSecondary() {
-	}
-
-	_initServicesDiscoveryResources() {
-		return null;
-	}
-
-	_initServicesDiscoveryMdns() {
-		return null;
-	}
-
-	_initServicesLogger() {
-		return new loggerService();
-	}
-
-	_initServicesLoggers() {
-		throw new NotImplementedError();
-	}
-
-	_initServicesMonitoring() {
-		return null;
-	}
-
-	_initServicesUsageMetrics() {
-		return new usageMetricsService();
-	}
-
-	async _initServer(serverHttp) {
-	}
-
-	async _initServerDiscovery(serverHttp) {
-		if (!this.resourceDiscoveryServiceI && !this.mdnsDiscoveryServiceI)
-			return;
-
-		const opts = await this._initServerDiscoveryOpts();
-
-		await this._initServerDiscoveryMdns(Utility.cloneDeep(opts));
-		await this._initServerDiscoveryResources(Utility.cloneDeep(opts));
-	}
-
-	async _initServerDiscoveryMdns(opts) {
-		if (!this.mdnsDiscoveryServiceI)
-			return;
-
-		await this.mdnsDiscoveryServiceI.initialize(Utility.generateId(), await this._initServerDiscoveryOptsMdns(opts));
-	}
-
-	async _initServerDiscoveryOpts() {
-		const dns = this._appConfig.get('dns', null);
-		const grpc = this._appConfig.get('grpc', null);
-		const secure = this._appConfig.get('secure', false);
-
-		const opts = {
-			address: this.address,
-			port: this.port,
-			healthCheck: 'healthcheck',
-			secure: secure ? secure : false,
-			dns: dns
-		};
-
-		if (grpc) {
-			opts.grpc = {
-				port: grpc ? grpc.port : null,
-				secure: grpc ? (grpc.secure ? grpc.secure : false) : false
-			};
-		}
-
-		return opts;
-	}
-
-	async _initServerDiscoveryOptsMdns(opts) {
-		return opts;
-	}
-
-	async _initServerDiscoveryOptsResources(opts) {
-		return opts;
-	}
-
-	async _initServerDiscoveryResources(opts) {
-		if (!this.resourceDiscoveryServiceI)
-			return;
-
-		await this.resourceDiscoveryServiceI.initialize(Utility.generateId(), await this._initServerDiscoveryOptsResources(opts));
-	}
-
-	_injectRepository(key, repository) {
-		console.log(`repositories.inject - ${key}`);
-		this._repositories.set(key, repository);
-		injector.addSingleton(key, repository);
-	}
-
-	_injectService(key, service) {
-		console.log(`services.inject - ${key}`);
-		this._services.set(key, service);
-		injector.addSingleton(key, service);
-	}
-
-	_initShutdown() {
-	}
-
-	_registerServicesLogger(key, service) {
-		this._injectService(key, service);
-		this.loggerServiceI.register(key);
-	}
-}
-
-export default BootMain;