Added tree.

This commit is contained in:
SamTV12345 2024-03-21 08:56:05 +01:00
parent 81a9ef924f
commit f9fd9805c0
2 changed files with 515 additions and 472 deletions

View file

@ -29,6 +29,7 @@
import {MapArrayType} from "../types/MapType"; import {MapArrayType} from "../types/MapType";
import {SettingsNode, SettingsTree} from "./SettingsTree"; import {SettingsNode, SettingsTree} from "./SettingsTree";
import {coerce} from "semver";
const absolutePaths = require('./AbsolutePaths'); const absolutePaths = require('./AbsolutePaths');
const deepEqual = require('fast-deep-equal/es6'); const deepEqual = require('fast-deep-equal/es6');
@ -53,13 +54,15 @@ const nonSettings = [
// This is a function to make it easy to create a new instance. It is important to not reuse a // This is a function to make it easy to create a new instance. It is important to not reuse a
// config object after passing it to log4js.configure() because that method mutates the object. :( // config object after passing it to log4js.configure() because that method mutates the object. :(
const defaultLogConfig = (level:string) => ({appenders: {console: {type: 'console'}}, const defaultLogConfig = (level: string) => ({
appenders: {console: {type: 'console'}},
categories: { categories: {
default: {appenders: ['console'], level}, default: {appenders: ['console'], level},
}}); }
});
const defaultLogLevel = 'INFO'; const defaultLogLevel = 'INFO';
const initLogging = (config:any) => { const initLogging = (config: any) => {
// log4js.configure() modifies exports.logconfig so check for equality first. // log4js.configure() modifies exports.logconfig so check for equality first.
log4js.configure(config); log4js.configure(config);
log4js.getLogger('console'); log4js.getLogger('console');
@ -490,7 +493,7 @@ exports.getGitCommit = () => {
version = ref; version = ref;
} }
version = version.substring(0, 7); version = version.substring(0, 7);
} catch (e:any) { } catch (e: any) {
logger.warn(`Can't get git version for server header\n${e.message}`); logger.warn(`Can't get git version for server header\n${e.message}`);
} }
return version; return version;
@ -506,7 +509,7 @@ exports.getEpVersion = () => require('../../package.json').version;
* This code refactors a previous version that copied & pasted the same code for * This code refactors a previous version that copied & pasted the same code for
* both "settings.json" and "credentials.json". * both "settings.json" and "credentials.json".
*/ */
const storeSettings = (settingsObj:any) => { const storeSettings = (settingsObj: any) => {
for (const i of Object.keys(settingsObj || {})) { for (const i of Object.keys(settingsObj || {})) {
if (nonSettings.includes(i)) { if (nonSettings.includes(i)) {
logger.warn(`Ignoring setting: '${i}'`); logger.warn(`Ignoring setting: '${i}'`);
@ -545,7 +548,7 @@ const storeSettings = (settingsObj:any) => {
* short syntax "${ABIWORD}", and not "${ABIWORD:null}": the latter would result * short syntax "${ABIWORD}", and not "${ABIWORD:null}": the latter would result
* in the literal string "null", instead. * in the literal string "null", instead.
*/ */
const coerceValue = (stringValue:string) => { const coerceValue = (stringValue: string) => {
// cooked from https://stackoverflow.com/questions/175739/built-in-way-in-javascript-to-check-if-a-string-is-a-valid-number // cooked from https://stackoverflow.com/questions/175739/built-in-way-in-javascript-to-check-if-a-string-is-a-valid-number
// @ts-ignore // @ts-ignore
const isNumeric = !isNaN(stringValue) && !isNaN(parseFloat(stringValue) && isFinite(stringValue)); const isNumeric = !isNaN(stringValue) && !isNaN(parseFloat(stringValue) && isFinite(stringValue));
@ -557,11 +560,16 @@ const coerceValue = (stringValue:string) => {
} }
switch (stringValue) { switch (stringValue) {
case 'true': return true; case 'true':
case 'false': return false; return true;
case 'undefined': return undefined; case 'false':
case 'null': return null; return false;
default: return stringValue; case 'undefined':
return undefined;
case 'null':
return null;
default:
return stringValue;
} }
}; };
@ -602,7 +610,7 @@ const coerceValue = (stringValue:string) => {
* see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter * see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter
*/ */
const lookupEnvironmentVariables = (obj: MapArrayType<any>) => { const lookupEnvironmentVariables = (obj: MapArrayType<any>) => {
const replaceEnvs = (obj: MapArrayType<any>)=> { const replaceEnvs = (obj: MapArrayType<any>) => {
for (let [key, value] of Object.entries(obj)) { for (let [key, value] of Object.entries(obj)) {
/* /*
* the first invocation of replacer() is with an empty key. Just go on, or * the first invocation of replacer() is with an empty key. Just go on, or
@ -691,7 +699,7 @@ const lookupEnvironmentVariables = (obj: MapArrayType<any>) => {
replaceEnvs(obj); replaceEnvs(obj);
const envVars:MapArrayType<any> = {} const envVars: MapArrayType<any> = {}
// Add plugin ENV variables // Add plugin ENV variables
@ -699,11 +707,11 @@ const lookupEnvironmentVariables = (obj: MapArrayType<any>) => {
* If the key contains a double underscore, it's a plugin variable * If the key contains a double underscore, it's a plugin variable
* E.g. * E.g.
*/ */
let treeEntries = new Map<string, string|undefined> let treeEntries = new Map<string, string | undefined>
const root = new SettingsNode("EP") const root = new SettingsNode("EP")
for (let [env,envVal] of Object.entries(process.env)) { for (let [env, envVal] of Object.entries(process.env)) {
if(!env.startsWith("EP")) continue if (!env.startsWith("EP")) continue
treeEntries.set(env, envVal) treeEntries.set(env, envVal)
} }
@ -715,21 +723,12 @@ const lookupEnvironmentVariables = (obj: MapArrayType<any>) => {
currentNode.addChild(pathToKey, value!) currentNode.addChild(pathToKey, value!)
}) })
console.log("Root is", JSON.stringify(root, (k,v)=>{ console.log(root.collectFromLeafsUpwards())
if(v instanceof Map) {
return {
dataType: 'Map',
value: Array.from(v.entries()), // or with spread: value: [...value]
};
} else {
return v;
}
}))
obj = Object.assign(obj, envVars) obj = Object.assign(obj, envVars)
return obj; return obj;
}; };
/** /**
* - reads the JSON configuration file settingsFilename from disk * - reads the JSON configuration file settingsFilename from disk
* - strips the comments * - strips the comments
@ -738,7 +737,7 @@ const lookupEnvironmentVariables = (obj: MapArrayType<any>) => {
* *
* The isSettings variable only controls the error logging. * The isSettings variable only controls the error logging.
*/ */
const parseSettings = (settingsFilename:string, isSettings:boolean) => { const parseSettings = (settingsFilename: string, isSettings: boolean) => {
let settingsStr = ''; let settingsStr = '';
let settingsType, notFoundMessage, notFoundFunction; let settingsType, notFoundMessage, notFoundFunction;
@ -771,7 +770,7 @@ const parseSettings = (settingsFilename:string, isSettings:boolean) => {
logger.info(`${settingsType} loaded from: ${settingsFilename}`); logger.info(`${settingsType} loaded from: ${settingsFilename}`);
return lookupEnvironmentVariables(settings); return lookupEnvironmentVariables(settings);
} catch (e:any) { } catch (e: any) {
logger.error(`There was an error processing your ${settingsType} ` + logger.error(`There was an error processing your ${settingsType} ` +
`file from ${settingsFilename}: ${e.message}`); `file from ${settingsFilename}: ${e.message}`);
@ -864,7 +863,8 @@ exports.reloadSettings = () => {
try { try {
exports.sessionKey = fs.readFileSync(sessionkeyFilename, 'utf8'); exports.sessionKey = fs.readFileSync(sessionkeyFilename, 'utf8');
logger.info(`Session key loaded from: ${sessionkeyFilename}`); logger.info(`Session key loaded from: ${sessionkeyFilename}`);
} catch (err) { /* ignored */ } } catch (err) { /* ignored */
}
const keyRotationEnabled = exports.cookie.keyRotationInterval && exports.cookie.sessionLifetime; const keyRotationEnabled = exports.cookie.keyRotationInterval && exports.cookie.sessionLifetime;
if (!exports.sessionKey && !keyRotationEnabled) { if (!exports.sessionKey && !keyRotationEnabled) {
logger.info( logger.info(

View file

@ -1,3 +1,5 @@
import {MapArrayType} from "../types/MapType";
export class SettingsTree { export class SettingsTree {
private children: Map<string, SettingsNode>; private children: Map<string, SettingsNode>;
constructor() { constructor() {
@ -24,46 +26,87 @@ export class SettingsTree {
export class SettingsNode { export class SettingsNode {
private readonly key: string; private readonly key: string;
private value: string|undefined; private value: string | number | boolean | null | undefined;
private children: Map<string, SettingsNode>; private children: MapArrayType<SettingsNode>;
constructor(key: string, value?: string) { constructor(key: string, value?: string | number | boolean | null | undefined) {
this.key = key; this.key = key;
this.value = value; this.value = value;
this.children = new Map(); this.children = {}
} }
public addChild(key: string[], value?: string) { public addChild(path: string[], value: string) {
let depth = 0 let currentNode:SettingsNode = this;
for (let i = 0; i < path.length; i++) {
while (depth < key.length) { const key = path[i];
const k = key[depth]; /*
const slicedKey = key.slice(depth + 1) Skip the current node if the key is the same as the current node's key
depth++; */
if(this.key === k) { if (key === this.key ) {
console.log("same key")
continue continue
} }
if (this.children.has(k)) { /*
console.log("has child", k) If the current node does not have a child with the key, create a new node with the key
this.children.get(k)!.addChild(slicedKey, value); */
if (!currentNode.hasChild(key)) {
currentNode = currentNode.children[key] = new SettingsNode(key, this.coerceValue(value));
} else { } else {
const newNode = new SettingsNode(k); /*
this.children.set(k, newNode); Else move to the child node
if(slicedKey.length > 0) */
newNode.addChild(slicedKey, value); currentNode = currentNode.getChild(key);
else
newNode.value = value;
this.children.get(k)!.addChild(slicedKey, undefined);
} }
} }
} }
public collectFromLeafsUpwards() {
let collected:MapArrayType<any> = {};
for (const key in this.children) {
const child = this.children[key];
if (child.hasChildren()) {
collected[key] = child.collectFromLeafsUpwards();
} else {
collected[key] = child.value;
}
}
return collected;
}
coerceValue = (stringValue: string) => {
// cooked from https://stackoverflow.com/questions/175739/built-in-way-in-javascript-to-check-if-a-string-is-a-valid-number
// @ts-ignore
const isNumeric = !isNaN(stringValue) && !isNaN(parseFloat(stringValue) && isFinite(stringValue));
if (isNumeric) {
// detected numeric string. Coerce to a number
return +stringValue;
}
switch (stringValue) {
case 'true':
return true;
case 'false':
return false;
case 'undefined':
return undefined;
case 'null':
return null;
default:
return stringValue;
}
};
public hasChildren() {
return Object.keys(this.children).length > 0;
}
public getChild(key: string) { public getChild(key: string) {
return this.children.get(key); return this.children[key];
} }
public hasChild(key: string) { public hasChild(key: string) {
return this.children.has(key); return this.children[key] !== undefined;
} }
} }