@autofleet/settings 1.4.5 → 2.0.0

package/.eslintrc.json

@@ -21,9 +21,11 @@
     ],
     "@typescript-eslint/no-unused-vars": ["error"],
     "@typescript-eslint/no-var-requires": ["off"],
+    "@typescript-eslint/no-explicit-any": "warn",
     "@typescript-eslint/camelcase": ["off"],
     "max-len": ["off"],
-    "@typescript-eslint/explicit-function-return-type": ["off"]
+    "@typescript-eslint/explicit-function-return-type": ["off"],
+    "class-methods-use-this": "off"
   },
   "overrides": [
     {

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import NodeCache from 'node-cache';
 import EventEmitter from 'events';
 interface SettingsClassOptions {
@@ -31,10 +30,10 @@ declare class SettingsManager {
     network: any;
     NEVER_DEFAULT_VALUE: string;
     disableTestEnvCheck: boolean;
-    static get NEVER_DEFAULT_VALUE(): string;
-    static readNetworkValue(networkValue: SettingValue, defaultValue: SettingValue): any;
+    static get NEVER_DEFAULT_VALUE(): 'NEVER_DEFAULT_VALUE';
+    static readNetworkValue(networkValue: SettingValue, defaultValue: SettingValue, key: string): any;
     constructor({ serviceUrl, ttl, disableTestEnvCheck }?: SettingsClassOptions);
-    get(key: SettingValue, defaultValue?: any, labels?: LabelsArray, { timeout, rejectOnFail }?: GetSettingOption): Promise<any>;
+    get(key: SettingValue, defaultValue?: SettingValue, labels?: LabelsArray, { timeout, rejectOnFail }?: GetSettingOption): Promise<SettingValue>;
     getMultiple(settingsToGet: {
         key: SettingValue;
         defaultValue: any;

package/dist/index.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -12,19 +35,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable consistent-return */
-/* eslint-disable array-callback-return */
 // eslint-disable-next-line max-classes-per-file
 const dotenv_1 = __importDefault(require("dotenv"));
 const network_1 = __importDefault(require("@autofleet/network"));
 const logger_1 = __importDefault(require("@autofleet/logger"));
 const node_cache_1 = __importDefault(require("node-cache"));
-const events_1 = __importDefault(require("events"));
-const util_1 = __importDefault(require("util"));
+const events_1 = __importStar(require("events"));
 const moment_1 = __importDefault(require("moment"));
 const h3_js_1 = __importDefault(require("h3-js"));
 dotenv_1.default.config();
-const nextTick = util_1.default.promisify(process.nextTick);
 const logger = (0, logger_1.default)();
 const fiveMinutes = 60 * 5;
 const waitingToNetwork = 'waitingToNetwork';
@@ -37,8 +56,12 @@ class SettingsManager {
     static get NEVER_DEFAULT_VALUE() {
         return 'NEVER_DEFAULT_VALUE';
     }
-    static readNetworkValue(networkValue, defaultValue) {
-        const returnValue = typeof networkValue !== 'undefined' ? networkValue : defaultValue;
+    static readNetworkValue(networkValue, defaultValue, key) {
+        let returnValue = networkValue;
+        if (typeof networkValue === 'undefined') {
+            returnValue = defaultValue;
+            logger.info('Setting falling back to default as network value was defined', { key, defaultValue });
+        }
         if (returnValue === SettingsManager.NEVER_DEFAULT_VALUE) {
             throw new Error('Cannot find value from network or cache, default value is set to never');
         }
@@ -55,28 +78,27 @@ class SettingsManager {
             serviceUrl: localServiceUrl,
         });
     }
-    get(key, defaultValue, labels = [], { timeout = 5000, rejectOnFail = false } = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
+    get(key_1, defaultValue_1) {
+        return __awaiter(this, arguments, void 0, function* (key, defaultValue, labels = [], { timeout = 5000, rejectOnFail = false } = {}) {
             if (typeof defaultValue === 'undefined') {
                 throw new Error('Can\'t get a key without defaultValue');
             }
             const cacheKey = this.getCacheKey(key, labels);
             const cacheValue = this.settingsCache.get(cacheKey);
             if (cacheValue !== undefined) {
+                logger.info('setting found in cache', { cacheKey });
                 if (waitingToNetwork === cacheValue) {
-                    yield nextTick();
-                    return new Promise((resolve, reject) => {
-                        this.networkEvents.once(cacheKey, (networkValue) => {
-                            if (networkValue instanceof Error && rejectOnFail) {
-                                return reject(networkValue);
-                            }
-                            resolve(SettingsManager.readNetworkValue(networkValue, defaultValue));
-                        });
-                    });
+                    yield Promise.resolve();
+                    const [networkValue] = yield (0, events_1.once)(this.networkEvents, cacheKey);
+                    if (networkValue instanceof Error && rejectOnFail) {
+                        throw networkValue;
+                    }
+                    return SettingsManager.readNetworkValue(networkValue, defaultValue, key);
                 }
                 return cacheValue;
             }
             if (!this.disableTestEnvCheck && process.env.NODE_ENV === 'test') {
+                logger.info('returning default value setting in TEST mode', { cacheKey });
                 return defaultValue;
             }
             let networkValue;
@@ -101,7 +123,7 @@ class SettingsManager {
             this.networkEvents.emit(cacheKey, networkValue);
             let returnValue;
             try {
-                returnValue = SettingsManager.readNetworkValue(networkValue, defaultValue);
+                returnValue = SettingsManager.readNetworkValue(networkValue, defaultValue, key);
             }
             catch (e) {
                 this.settingsCache.del(cacheKey);
@@ -111,11 +133,11 @@ class SettingsManager {
             return returnValue;
         });
     }
-    getMultiple(settingsToGet, labels, { timeout = 5000, rejectOnFail = false } = {}) {
-        return __awaiter(this, void 0, void 0, function* () {
+    getMultiple(settingsToGet_1, labels_1) {
+        return __awaiter(this, arguments, void 0, function* (settingsToGet, labels, { timeout = 5000, rejectOnFail = false } = {}) {
             const settingsToReturn = new Map();
             const settingsToFetch = [];
-            settingsToGet.map((obj) => {
+            settingsToGet.forEach((obj) => {
                 const cacheKey = this.getCacheKey(obj.key, labels);
                 const cacheValue = this.settingsCache.get(cacheKey);
                 if (cacheValue !== undefined && cacheValue !== waitingToNetwork) {
@@ -139,12 +161,12 @@ class SettingsManager {
                         timeout,
                     });
                     values = data;
-                    settingsToFetch.map((key, index) => {
+                    settingsToFetch.forEach((key, index) => {
                         settingsToReturn.set(key, values[index].value);
                     });
                 }
                 catch (err) {
-                    logger.error('Cant get setting from network', { err });
+                    logger.error('Cant get setting from network', { err, settingsToFetch, labels });
                     if (rejectOnFail) {
                         throw new CannotGetNetworkValueError();
                     }
@@ -154,7 +176,7 @@ class SettingsManager {
                 const cacheKey = this.getCacheKey(setting.key, labels);
                 let returnValue;
                 try {
-                    returnValue = SettingsManager.readNetworkValue(settingsToReturn.get(setting.key), setting.defaultValue);
+                    returnValue = SettingsManager.readNetworkValue(settingsToReturn.get(setting.key), setting.defaultValue, setting.key);
                 }
                 catch (err) {
                     this.settingsCache.del(cacheKey);
@@ -174,13 +196,13 @@ class SettingsManager {
     flush() {
         return this.settingsCache.flushAll();
     }
-    // eslint-disable-next-line class-methods-use-this
     getCacheKey(key, labels) {
         const newLabels = labels.map((l) => {
+            var _a, _b;
             if (l.time) {
                 return Object.assign(Object.assign({}, l), { time: (0, moment_1.default)(l.time).startOf('hour').format(), day: (0, moment_1.default)(l.time).day() });
             }
-            if (l.location && l.location.lat && l.location.lng) {
+            if (((_a = l.location) === null || _a === void 0 ? void 0 : _a.lat) && ((_b = l.location) === null || _b === void 0 ? void 0 : _b.lng)) {
                 const h3Index = h3_js_1.default.latLngToCell(l.location.lat, l.location.lng, 8);
                 return Object.assign(Object.assign({}, l), { location: h3Index });
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/settings",
-  "version": "1.4.5",
+  "version": "2.0.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -13,8 +13,11 @@
     "coverage": "jest --coverage --forceExit --runInBand && rm -rf ./coverage",
     "dev": "nodemon"
   },
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "peerDependencies": {
-    "@autofleet/logger": "*"
+    "@autofleet/logger": ">=4.0.0"
   },
   "dependencies": {
     "@autofleet/network": "^1.4.2",
@@ -27,15 +30,16 @@
     "@autofleet/logger": "^4.0.6",
     "@types/jest": "^29.5.12",
     "@types/nock": "^10.0.3",
-    "@typescript-eslint/eslint-plugin": "^4.8.1",
-    "eslint": "^7.13.0",
-    "eslint-config-airbnb-typescript": "^12.0.0",
-    "eslint-plugin-import": "^2.22.1",
+    "@types/node": "^16.18.108",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "eslint": "^8.56.0",
+    "eslint-config-airbnb-typescript": "^18.0.0",
+    "eslint-plugin-import": "^2.30.0",
     "jest": "^29.7.0",
     "nock": "^10.0.2",
     "ts-jest": "^29.2.3",
     "ts-node": "^8.6.2",
-    "typescript": "^4.9.5"
+    "typescript": "^5.5.3"
   },
   "author": "",
   "license": "ISC"

package/src/alltypes.d.ts

@@ -1,2 +1 @@
 declare module '@autofleet/network';
-declare module '@autofleet/logger';

package/src/index.ts

@@ -1,18 +1,14 @@
-/* eslint-disable consistent-return */
-/* eslint-disable array-callback-return */
 // eslint-disable-next-line max-classes-per-file
 import dotenv from 'dotenv';
 import Network from '@autofleet/network';
 import Logger from '@autofleet/logger';
 import NodeCache from 'node-cache';
-import EventEmitter from 'events';
-import util from 'util';
+import EventEmitter, { once } from 'events';
 import moment from 'moment';
 import h3 from 'h3-js';
 
 dotenv.config();
 
-const nextTick = util.promisify(process.nextTick);
 const logger = Logger();
 
 const fiveMinutes = 60 * 5;
@@ -66,12 +62,16 @@ class SettingsManager {
 
   disableTestEnvCheck: boolean;
 
-  static get NEVER_DEFAULT_VALUE() {
+  static get NEVER_DEFAULT_VALUE(): 'NEVER_DEFAULT_VALUE' {
     return 'NEVER_DEFAULT_VALUE';
   }
 
-  static readNetworkValue(networkValue: SettingValue, defaultValue: SettingValue) {
-    const returnValue = typeof networkValue !== 'undefined' ? networkValue : defaultValue;
+  static readNetworkValue(networkValue: SettingValue, defaultValue: SettingValue, key: string) {
+    let returnValue = networkValue;
+    if (typeof networkValue === 'undefined') {
+      returnValue = defaultValue;
+      logger.info('Setting falling back to default as network value was defined', { key, defaultValue });
+    }
 
     if (returnValue === SettingsManager.NEVER_DEFAULT_VALUE) {
       throw new Error('Cannot find value from network or cache, default value is set to never');
@@ -80,7 +80,7 @@ class SettingsManager {
     return returnValue;
   }
 
-  constructor({ serviceUrl, ttl = fiveMinutes, disableTestEnvCheck = false }:SettingsClassOptions = {}) {
+  constructor({ serviceUrl, ttl = fiveMinutes, disableTestEnvCheck = false }: SettingsClassOptions = {}) {
     const localServiceUrl = findUrl(serviceUrl);
 
     this.NEVER_DEFAULT_VALUE = SettingsManager.NEVER_DEFAULT_VALUE;
@@ -95,10 +95,10 @@ class SettingsManager {
 
   async get(
     key: SettingValue,
-    defaultValue?: any,
-    labels:LabelsArray = [],
+    defaultValue?: SettingValue,
+    labels: LabelsArray = [],
     { timeout = 5000, rejectOnFail = false } : GetSettingOption = {},
-  ) {
+  ): Promise<SettingValue> {
     if (typeof defaultValue === 'undefined') {
       throw new Error('Can\'t get a key without defaultValue');
     }
@@ -106,21 +106,20 @@ class SettingsManager {
     const cacheKey = this.getCacheKey(key, labels);
     const cacheValue = this.settingsCache.get(cacheKey);
     if (cacheValue !== undefined) {
+      logger.info('setting found in cache', { cacheKey });
       if (waitingToNetwork === cacheValue) {
-        await nextTick();
-        return new Promise((resolve, reject) => {
-          this.networkEvents.once(cacheKey, (networkValue) => {
-            if (networkValue instanceof Error && rejectOnFail) {
-              return reject(networkValue);
-            }
-            resolve(SettingsManager.readNetworkValue(networkValue, defaultValue));
-          });
-        });
+        await Promise.resolve();
+        const [networkValue] = await once(this.networkEvents, cacheKey);
+        if (networkValue instanceof Error && rejectOnFail) {
+          throw networkValue;
+        }
+        return SettingsManager.readNetworkValue(networkValue, defaultValue, key);
       }
       return cacheValue;
     }
 
     if (!this.disableTestEnvCheck && process.env.NODE_ENV === 'test') {
+      logger.info('returning default value setting in TEST mode', { cacheKey });
       return defaultValue;
     }
 
@@ -146,7 +145,7 @@ class SettingsManager {
     this.networkEvents.emit(cacheKey, networkValue);
     let returnValue;
     try {
-      returnValue = SettingsManager.readNetworkValue(networkValue, defaultValue);
+      returnValue = SettingsManager.readNetworkValue(networkValue, defaultValue, key);
     } catch (e) {
       this.settingsCache.del(cacheKey);
       throw e;
@@ -166,7 +165,7 @@ class SettingsManager {
     const settingsToReturn = new Map();
     const settingsToFetch: any[] = [];
 
-    settingsToGet.map((obj) => {
+    settingsToGet.forEach((obj) => {
       const cacheKey = this.getCacheKey(obj.key, labels);
       const cacheValue = this.settingsCache.get(cacheKey);
       if (cacheValue !== undefined && cacheValue !== waitingToNetwork) {
@@ -192,11 +191,11 @@ class SettingsManager {
         });
         values = data;
 
-        settingsToFetch.map((key, index) => {
+        settingsToFetch.forEach((key, index) => {
           settingsToReturn.set(key, values[index].value);
         });
       } catch (err) {
-        logger.error('Cant get setting from network', { err });
+        logger.error('Cant get setting from network', { err, settingsToFetch, labels });
         if (rejectOnFail) {
           throw new CannotGetNetworkValueError();
         }
@@ -207,7 +206,7 @@ class SettingsManager {
       const cacheKey = this.getCacheKey(setting.key, labels);
       let returnValue;
       try {
-        returnValue = SettingsManager.readNetworkValue(settingsToReturn.get(setting.key), setting.defaultValue);
+        returnValue = SettingsManager.readNetworkValue(settingsToReturn.get(setting.key), setting.defaultValue, setting.key);
       } catch (err) {
         this.settingsCache.del(cacheKey);
         throw err;
@@ -219,17 +218,16 @@ class SettingsManager {
     });
   }
 
-  setLocal(key: string, labels: LabelsArray, value: SettingValue) {
+  setLocal(key: string, labels: LabelsArray, value: SettingValue): void {
     const cacheKey = this.getCacheKey(key, labels);
     this.settingsCache.set(cacheKey, value, this.ttl);
   }
 
-  flush() {
+  flush(): void {
     return this.settingsCache.flushAll();
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  getCacheKey(key: SettingValue, labels: LabelsArray) {
+  getCacheKey(key: SettingValue, labels: LabelsArray): string {
     const newLabels = labels.map((l) => {
       if (l.time) {
         return {
@@ -239,7 +237,7 @@ class SettingsManager {
         };
       }
 
-      if (l.location && l.location.lat && l.location.lng) {
+      if (l.location?.lat && l.location?.lng) {
         const h3Index = h3.latLngToCell(l.location.lat, l.location.lng, 8);
         return {
           ...l,