@nsshunt/stsconfig 1.9.0 → 1.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsshunt/stsconfig",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "",
   "main": "stsconfig.js",
   "dependencies": {
@@ -13,11 +13,11 @@
     "parser": "@babel/eslint-parser"
   },
   "devDependencies": {
-    "@babel/core": "^7.17.2",
+    "@babel/core": "^7.17.5",
     "@babel/eslint-parser": "^7.17.0",
     "@babel/plugin-proposal-class-properties": "^7.16.7",
     "@babel/plugin-proposal-private-methods": "^7.16.11",
-    "eslint": "^8.8.0",
+    "eslint": "^8.10.0",
     "jest": "^27.5.1"
   },
   "scripts": {

package/stsconfig.js

@@ -3,6 +3,12 @@ const { accessSync, constants, readFileSync } = require('fs');
 const debug = require('debug')(`proc:${process.pid}`);
 require('colors');
 
+// Order for config settings
+// -------------------------
+// Passwords;
+//   Use password specified within a database password file (if present)
+//   Fall back to use a password from an environment variable
+
 // Add tthe STSENVFILE to script run commands in order to use the require .env file for configuration
 let envfile = (process.env.STSENVFILE === undefined ? '../stsglobalresources/.env' : process.env.STSENVFILE);
 let yamlfile = (process.env.STSYAMLFILE === undefined ? '../stsglobalresources/config.yml' : process.env.STSYAMLFILE);
@@ -21,32 +27,30 @@ try {
 const defconfig = 
 {
 	// Node runtime environment
-	isProduction: process.env.NODE_ENV === 'production'
+	isProduction: (process.env.NODE_ENV === 'production')
 	// Log error messages to the console within the microservice
 	,consoleLogErrors: (process.env.CONSOLE_LOG_ERRORS === undefined ? false : (process.env.CONSOLE_LOG_ERRORS === "true" ? true : false ))
 	// Database username.
-	,dbuser: process.env.DB_USER
+	,dbuser: (process.env.DB_USER === undefined ? 'postgres' : process.env.DB_USER)
 	// Database password.
-	,dbpassword: process.env.DB_PASSWORD
+	,dbpassword: (process.env.DB_PASSWORD === undefined ? 'password' : process.env.DB_PASSWORD)
+	// Database password file.
+	,dbpasswordfile: process.env.DB_PASSWORD_FILE
 	// Database host.
-	,dbhost: process.env.DB_HOST
+	,dbhost: (process.env.DB_HOST === undefined ? 'localhost' : process.env.DB_HOST)
 	// Database port.
-	,dbport: process.env.DB_PORT
+	,dbport: (process.env.DB_PORT === undefined ? '5432' : process.env.DB_PORT)
 	// Database name.
-	,database: process.env.DB_DATABASE
+	,database: (process.env.DB_DATABASE === undefined ? 'stsrestmsdb01' : process.env.DB_DATABASE) // STS REST MicroService Database 01
 	// Database connection string to be used in production mode.
 	,databaseUrl: process.env.DATABASE_URL
-	// Computed connection string to be used in development mode.
-	,connectionString: `postgresql://${process.env.DB_USER}:${process.env.DB_PASSWORD}@${process.env.DB_HOST}:${process.env.DB_PORT}/${process.env.DB_DATABASE}`
-	// Default computed connection string for postgres. Database name = postgres.
-	,defaultDatabaseConnectionString: `postgresql://${process.env.DB_USER}:${process.env.DB_PASSWORD}@${process.env.DB_HOST}:${process.env.DB_PORT}/postgres`
 	// Database script(s) folder
 	,databasescriptfolder: (process.env.DB_SCRIPT_FOLDER === undefined ? "/var/lib/sts/stsglobalresources/db-scripts" : process.env.DB_SCRIPT_FOLDER)
 
 	// Use the on-screen UI for the server. Set to false for head-less mode (i.e. inside cluster etc.)
 	,useui: (process.env.USEUI === undefined ? true : (process.env.USEUI === "true" ? true : false ))
 	// The maximum pool size for pg. There will be one pool per thread.
-	,poolSize: (process.env.POOL_SIZE === undefined ? 20 : parseInt(process.env.POOL_SIZE))
+	,poolSize: (process.env.POOL_SIZE === undefined ? 500 : parseInt(process.env.POOL_SIZE))
 	// Maximum number of CPUs (incl. logical processors) to use within the Microservice. 
 	// Use -1 to use all available within the runtime container. Each CPU will spawn a node work thread.
 	,useCPUs: (process.env.MAX_CPU === undefined ? -1 : parseFloat(process.env.MAX_CPU))
@@ -113,23 +117,51 @@ const defconfig =
 	*/
 
 	// STSREST01 Server endpoint
-	,rest01endpoint: (process.env.REST01_ENDPOINT === undefined ? "http://localhost" : process.env.REST01_ENDPOINT)
+	,rest01endpoint: (process.env.REST01_ENDPOINT === undefined ?
+		(process.env.ENDPOINT === undefined ? "http://localhost" : process.env.ENDPOINT)
+		: process.env.REST01_ENDPOINT)
 	// STSREST01 Server port (listen port for the service)
-	,rest01hostport: (process.env.REST01_HOST_PORT === undefined ? "3000" : process.env.REST01_HOST_PORT)
+	,rest01hostport: (process.env.REST01_HOST_PORT === undefined ?
+		(process.env.HOST_PORT === undefined ? "3000" : process.env.HOST_PORT)
+		: process.env.REST01_HOST_PORT)
 	// STSREST01 Server port (client port to access the service)
-	,rest01port: (process.env.REST01_PORT === undefined ? "3000" : process.env.REST01_PORT)
+	,rest01port: (process.env.REST01_PORT === undefined ?
+		(process.env.PORT === undefined ? "3000" : process.env.PORT)
+		: process.env.REST01_PORT)
 	// STSREST01 Server endpoint
-	,rest01apiroot: (process.env.REST01_APIROOT === undefined ? "/stsrest01/v1/im" : process.env.REST01_APIROOT)
+	,rest01apiroot: (process.env.REST01_APIROOT === undefined ?
+		(process.env.APIROOT === undefined ? "/stsrest01/v1/im" : process.env.APIROOT)
+		: process.env.REST01_APIROOT)
+	// STSREST01 Prometheus metric support
+	,rest01prometheussupport: (process.env.REST01_PROM_SUPPORT === undefined ?
+		(process.env.PROM_SUPPORT === undefined ? true : (process.env.PROM_SUPPORT === "true" ? true : false))
+		: (process.env.REST01_PROM_SUPPORT === "true" ? true : false))
+	// STSREST01 Cluster Server port (port used for cluster prometheus scrapes). Service will listen on this port at mount point /metrics
+	,rest01prometheusclusterport: (process.env.REST01_PROM_CLUSTER_PORT === undefined ?
+		(process.env.PROM_CLUSTER_PORT === undefined ? "3010" : process.env.PROM_CLUSTER_PORT)
+		: process.env.REST01_PROM_CLUSTER_PORT)
 	// STSREST01 Service Name
-	,rest01servicename: (process.env.REST01_SERVICE_NAME === undefined ? "STSRest01" : process.env.REST01_SERVICE_NAME)
+	,rest01servicename: (process.env.REST01_SERVICE_NAME === undefined ?
+		(process.env.SERVICE_NAME === undefined ? "STSRest01" : process.env.SERVICE_NAME)
+		: process.env.REST01_SERVICE_NAME)
 	// STSREST01 Service Version
-	,rest01serviceversion: (process.env.REST01_SERVICE_VERSION === undefined ? "1.0.0" : process.env.REST01_SERVICE_VERSION)
+	,rest01serviceversion: (process.env.REST01_SERVICE_VERSION === undefined ?
+		(process.env.SERVICE_VERSION === undefined ? "1.0.0" : process.env.SERVICE_VERSION)
+		: process.env.REST01_SERVICE_VERSION)
 	// STSREST01 Service Credentials
 	// -----------------------------
 	// STSREST01 Server username email
-	,rest01email: (process.env.REST01_EMAIL === undefined ? "K6TestUser@sts" : process.env.REST01_EMAIL)
+	,rest01email: (process.env.REST01_EMAIL === undefined ?
+		(process.env.EMAIL === undefined ? "K6TestUser@sts" : process.env.EMAIL)
+		: process.env.REST01_EMAIL)
 	// STSREST01 Server username password
-	,rest01password: (process.env.REST01_PASSWORD === undefined ? "K6TestUserPassword" : process.env.REST01_PASSWORD)
+	,rest01password: (process.env.REST01_PASSWORD === undefined ?
+		(process.env.PASSWORD === undefined ? "K6TestUserPassword" : process.env.PASSWORD)
+		: process.env.REST01_PASSWORD)
+	// STSREST01 Server username password file
+	,rest01passwordfile: (process.env.REST01_PASSWORD_FILE === undefined ?
+		( process.env.PASSWORD_FILE === undefined ? "rest01passwordfile" : process.env.PASSWORD_FILE)
+		: process.env.REST01_PASSWORD_FILE)
 	
 	
 	// STS Instrument Manager Service endpoint
@@ -140,6 +172,10 @@ const defconfig =
 	,import: (process.env.IM_PORT === undefined ? "3001" : process.env.IM_PORT)
 	// STS Instrument Manager Service endpoint
 	,imapiroot: (process.env.IM_APIROOT === undefined ? "/stsinstrumentmanager/v1" : process.env.IM_APIROOT)
+	// STS Instrument Manager Prometheus metric support
+	,imprometheussupport: (process.env.IM_PROM_SUPPORT === undefined ? true : (process.env.IM_PROM_SUPPORT === "true" ? true : false ))
+	// STS Instrument Manager Cluster Server port (port used for cluster prometheus scrapes)
+	,imprometheusclusterport: (process.env.IM_PROM_CLUSTER_PORT === undefined ? "3010" : process.env.IM_PROM_CLUSTER_PORT)
 	// STS Instrument Manager Service Name
 	,imservicename: (process.env.IM_SERVICE_NAME === undefined ? "STSInstrumentManager" : process.env.IM_SERVICE_NAME)
 	// STS Instrument Manager Service Version
@@ -159,6 +195,10 @@ const defconfig =
 	,toport: (process.env.TO_PORT === undefined ? "3004" : process.env.TO_PORT)
 	// STS Test Orchestrator Service endpoint
 	,toapiroot: (process.env.TO_APIROOT === undefined ? "/ststestorchestrator/v1" : process.env.TO_APIROOT)
+	// STS Test Orchestrator Prometheus metric support
+	,toprometheussupport: (process.env.TO_PROM_SUPPORT === undefined ? true : (process.env.TO_PROM_SUPPORT === "true" ? true : false ))
+	// STS Test Orchestrator Cluster Server port (port used for cluster prometheus scrapes)
+	,toprometheusclusterport: (process.env.TO_PROM_CLUSTER_PORT === undefined ? "3010" : process.env.TO_PROM_CLUSTER_PORT)
 	// STS Test Orchestrator Service Name
 	,toservicename: (process.env.TO_SERVICE_NAME === undefined ? "STSTestOrchestrator" : process.env.TO_SERVICE_NAME)
 	// STS Test Orchestrator Service Version
@@ -178,6 +218,10 @@ const defconfig =
 	,asport: (process.env.AS_PORT === undefined ? "3002" : process.env.AS_PORT)
 	// Auth Server endpoint
 	,asapiroot: (process.env.AS_APIROOT === undefined ? "/stsauth/v1" : process.env.AS_APIROOT)
+	// Auth Server Prometheus metric support
+	,asprometheussupport: (process.env.AS_PROM_SUPPORT === undefined ? true : (process.env.AS_PROM_SUPPORT === "true" ? true : false ))
+	// Auth Prometheus Cluster Server port (port used for cluster prometheus scrapes)
+	,asprometheusclusterport: (process.env.AS_PROM_CLUSTER_PORT === undefined ? "3012" : process.env.AS_PROM_CLUSTER_PORT)
 	// STSAuth Service Name
 	,asservicename: (process.env.AS_SERVICE_NAME === undefined ? "STSAuth" : process.env.AS_SERVICE_NAME)
 	// STSAuth Service Version
@@ -189,6 +233,10 @@ const defconfig =
 	// Auth Server username password
 	,aspassword: (process.env.AS_PASSWORD === undefined ? "K6TestUserPassword" : process.env.AS_PASSWORD)
 
+	// STS Test Runner Prometheus metric support
+	,trprometheussupport: (process.env.TR_PROM_SUPPORT === undefined ? true : (process.env.TR_PROM_SUPPORT === "true" ? true : false ))
+	// STS Test Runner Cluster Server port (port used for cluster prometheus scrapes)
+	,trprometheusclusterport: (process.env.TR_PROM_CLUSTER_PORT === undefined ? "3010" : process.env.TR_PROM_CLUSTER_PORT)
 	// STS Test Runner Service Name
 	,trservicename: (process.env.TR_SERVICE_NAME === undefined ? "STSRestRunner" : process.env.TR_SERVICE_NAME)
 	// STS Test Runner Service Version
@@ -265,7 +313,26 @@ const defconfig =
 	// timeout <number> Socket timeout in milliseconds. This will set the timeout when the socket is created.
 }
 
+if (defconfig.dbpasswordfile !== undefined)
+{
+	try {
+		accessSync(defconfig.dbpasswordfile, constants.R_OK);
+		const data = readFileSync(defconfig.dbpasswordfile, 'utf8');
+		defconfig.dbpassword = data;
+		debug(`Successfully loaded database password file: [${defconfig.dbpasswordfile}]`.green);
+	} catch (err) {
+		debug(`Problem loading database password file: [${defconfig.dbpasswordfile}], Error: [${err}]`.red);
+	}
+}
+
 // Preference order is YAML file then .env file
-const $options = {...deffileconfig, ...defconfig};
+const $options = {
+	...deffileconfig, 
+	...defconfig
+	// Computed connection string to be used in development mode.
+	,connectionString: `postgresql://${defconfig.dbuser}:${defconfig.dbpassword}@${defconfig.dbhost}:${defconfig.dbport}/${defconfig.database}`
+	// Default computed connection string for postgres. Database name = postgres. Used by utilites that create and/or update the STS database(s).
+	,defaultDatabaseConnectionString: `postgresql://${defconfig.dbuser}:${defconfig.dbpassword}@${defconfig.dbhost}:${defconfig.dbport}/postgres`
+}
 
 module.exports = { $options }