@autofleet/settings 1.1.4 → 1.2.1

package/dist/index.d.ts

@@ -4,12 +4,14 @@ import EventEmitter from 'events';
 interface SettingsClassOptions {
     serviceUrl?: string;
     ttl?: number;
+    disableTestEnvCheck?: boolean;
 }
 declare type SettingValue = string | boolean | number | any[] | never;
 interface Label {
     businessModelId?: string;
     demandSourceId?: string;
     fleetId?: string;
+    time?: string | Date;
 }
 declare type LabelsArray = Label[];
 interface GetSettingOption {
@@ -22,9 +24,10 @@ declare class SettingsManager {
     networkEvents: EventEmitter;
     network: any;
     NEVER_DEFAULT_VALUE: string;
+    disableTestEnvCheck: boolean;
     static get NEVER_DEFAULT_VALUE(): string;
     static readNetworkValue(networkValue: SettingValue, defaultValue: SettingValue): SettingValue;
-    constructor({ serviceUrl, ttl }?: SettingsClassOptions);
+    constructor({ serviceUrl, ttl, disableTestEnvCheck }?: SettingsClassOptions);
     get(key: SettingValue, defaultValue?: any, labels?: LabelsArray, { timeout, rejectOnFail }?: GetSettingOption): Promise<any>;
     getMultiple(settingsToGet: {
         key: SettingValue;
@@ -32,5 +35,6 @@ declare class SettingsManager {
     }[], labels: LabelsArray, { timeout, rejectOnFail }?: GetSettingOption): Promise<any>;
     setLocal(key: string, labels: LabelsArray, value: SettingValue): void;
     flush(): void;
+    getCacheKey(key: SettingValue, labels: LabelsArray): string;
 }
 export default SettingsManager;

package/dist/index.js

@@ -21,6 +21,7 @@ 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 moment_1 = __importDefault(require("moment"));
 dotenv_1.default.config();
 const nextTick = util_1.default.promisify(process.nextTick);
 const logger = logger_1.default();
@@ -32,10 +33,11 @@ const findUrl = (serviceUrl) => serviceUrl
 class CannotGetNetworkValueError extends Error {
 }
 class SettingsManager {
-    constructor({ serviceUrl, ttl = fiveMinutes } = {}) {
+    constructor({ serviceUrl, ttl = fiveMinutes, disableTestEnvCheck = false } = {}) {
         const localServiceUrl = findUrl(serviceUrl);
         this.NEVER_DEFAULT_VALUE = SettingsManager.NEVER_DEFAULT_VALUE;
         this.ttl = ttl;
+        this.disableTestEnvCheck = disableTestEnvCheck;
         this.settingsCache = new node_cache_1.default();
         this.networkEvents = new events_1.default();
         this.network = new network_1.default({
@@ -57,7 +59,7 @@ class SettingsManager {
             if (typeof defaultValue === 'undefined') {
                 throw new Error('Can\'t get a key without defaultValue');
             }
-            const cacheKey = `${key}_${JSON.stringify(labels)}`;
+            const cacheKey = this.getCacheKey(key, labels);
             const cacheValue = this.settingsCache.get(cacheKey);
             if (cacheValue !== undefined) {
                 if (waitingToNetwork === cacheValue) {
@@ -73,7 +75,7 @@ class SettingsManager {
                 }
                 return cacheValue;
             }
-            if (process.env.NODE_ENV === 'test') {
+            if (!this.disableTestEnvCheck && process.env.NODE_ENV === 'test') {
                 return defaultValue;
             }
             let networkValue;
@@ -113,7 +115,7 @@ class SettingsManager {
             const settingsToReturn = new Map();
             const settingsToFetch = [];
             settingsToGet.map((obj) => {
-                const cacheKey = `${obj.key}_${JSON.stringify(labels)}`;
+                const cacheKey = this.getCacheKey(obj.key, labels);
                 const cacheValue = this.settingsCache.get(cacheKey);
                 if (cacheValue) {
                     settingsToReturn.set(obj.key, cacheValue);
@@ -149,7 +151,7 @@ class SettingsManager {
                 }
             }
             return settingsToGet.map((setting) => {
-                const cacheKey = `${setting.key}_${JSON.stringify(labels)}`;
+                const cacheKey = this.getCacheKey(setting.key, labels);
                 let returnValue;
                 try {
                     returnValue = SettingsManager.readNetworkValue(settingsToReturn.get(setting.key), setting.defaultValue);
@@ -164,11 +166,22 @@ class SettingsManager {
         });
     }
     setLocal(key, labels, value) {
-        const cacheKey = `${key}_${JSON.stringify(labels)}`;
+        const cacheKey = this.getCacheKey(key, labels);
         this.settingsCache.set(cacheKey, value, this.ttl);
     }
     flush() {
         return this.settingsCache.flushAll();
     }
+    // eslint-disable-next-line class-methods-use-this
+    getCacheKey(key, labels) {
+        const newLabels = labels.map((l) => {
+            if (l.time) {
+                return Object.assign(Object.assign({}, l), { time: moment_1.default(l.time).startOf('hour').format(), day: moment_1.default(l.time).day() });
+            }
+            return l;
+        });
+        const cacheKey = `${key}_${JSON.stringify(newLabels)}`;
+        return cacheKey;
+    }
 }
 exports.default = SettingsManager;

package/dist/index.test.js

@@ -105,6 +105,18 @@ describe('Settings', () => {
             expect(value).toEqual('value1');
             expect(m.isDone()).toBeTruthy();
         }));
+        it('Finds with time label', () => __awaiter(void 0, void 0, void 0, function* () {
+            const time = new Date();
+            const labels = [{ fleetId: 'uuid', time }];
+            const m = mockSetting('key1', 'value1', labels);
+            const settings = new index_1.default({
+                serviceUrl: `http://${serviceUrl}/`,
+            });
+            const settingLabel = [{ fleetId: 'uuid', time }];
+            const value = yield settings.get('key1', 'dv', settingLabel);
+            expect(value).toEqual('value1');
+            expect(m.isDone()).toBeTruthy();
+        }));
         it('Returns default value when network error', () => __awaiter(void 0, void 0, void 0, function* () {
             const settings = new index_1.default({
                 serviceUrl: `http://${serviceUrl}/`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/settings",
-  "version": "1.1.4",
+  "version": "1.2.1",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -20,6 +20,7 @@
     "bluebird": "^3.7.2",
     "dotenv": "^8.2.0",
     "jest": "^22.4.4",
+    "moment": "^2.29.1",
     "nock": "^10.0.2",
     "node-cache": "^5.1.2"
   },

package/src/index.test.ts

@@ -117,6 +117,20 @@ describe('Settings', () => {
       expect(m.isDone()).toBeTruthy();
     });
 
+    it('Finds with time label', async () => {
+      const time = new Date();
+      const labels = [{ fleetId: 'uuid', time }];
+      const m = mockSetting('key1', 'value1', labels);
+      const settings = new Settings({
+        serviceUrl: `http://${serviceUrl}/`,
+      });
+
+      const settingLabel = [{ fleetId: 'uuid', time }];
+      const value = await settings.get('key1', 'dv', settingLabel);
+      expect(value).toEqual('value1');
+      expect(m.isDone()).toBeTruthy();
+    });
+
     it('Returns default value when network error', async () => {
       const settings = new Settings({
         serviceUrl: `http://${serviceUrl}/`,

package/src/index.ts

@@ -7,6 +7,7 @@ import Logger from '@autofleet/logger';
 import NodeCache from 'node-cache';
 import EventEmitter from 'events';
 import util from 'util';
+import moment from 'moment';
 
 dotenv.config();
 
@@ -23,6 +24,7 @@ const findUrl = (serviceUrl?: string) => serviceUrl
 interface SettingsClassOptions {
   serviceUrl?: string;
   ttl?: number;
+  disableTestEnvCheck?: boolean;
 }
 
 type SettingValue = string | boolean | number | any[] | never;
@@ -31,6 +33,7 @@ interface Label {
   businessModelId?: string;
   demandSourceId?: string;
   fleetId?: string;
+  time?: string | Date;
 }
 
 type LabelsArray = Label[];
@@ -54,6 +57,8 @@ class SettingsManager {
 
   NEVER_DEFAULT_VALUE: string;
 
+  disableTestEnvCheck: boolean;
+
   static get NEVER_DEFAULT_VALUE() {
     return 'NEVER_DEFAULT_VALUE';
   }
@@ -68,11 +73,12 @@ class SettingsManager {
     return returnValue;
   }
 
-  constructor({ serviceUrl, ttl = fiveMinutes }:SettingsClassOptions = {}) {
+  constructor({ serviceUrl, ttl = fiveMinutes, disableTestEnvCheck = false }:SettingsClassOptions = {}) {
     const localServiceUrl = findUrl(serviceUrl);
 
     this.NEVER_DEFAULT_VALUE = SettingsManager.NEVER_DEFAULT_VALUE;
     this.ttl = ttl;
+    this.disableTestEnvCheck = disableTestEnvCheck;
     this.settingsCache = new NodeCache();
     this.networkEvents = new EventEmitter();
     this.network = new Network({
@@ -90,7 +96,7 @@ class SettingsManager {
       throw new Error('Can\'t get a key without defaultValue');
     }
 
-    const cacheKey = `${key}_${JSON.stringify(labels)}`;
+    const cacheKey = this.getCacheKey(key, labels);
     const cacheValue = this.settingsCache.get(cacheKey);
     if (cacheValue !== undefined) {
       if (waitingToNetwork === cacheValue) {
@@ -107,7 +113,7 @@ class SettingsManager {
       return cacheValue;
     }
 
-    if (process.env.NODE_ENV === 'test') {
+    if (!this.disableTestEnvCheck && process.env.NODE_ENV === 'test') {
       return defaultValue;
     }
 
@@ -154,7 +160,7 @@ class SettingsManager {
     const settingsToFetch: any[] = [];
 
     settingsToGet.map((obj) => {
-      const cacheKey = `${obj.key}_${JSON.stringify(labels)}`;
+      const cacheKey = this.getCacheKey(obj.key, labels);
       const cacheValue = this.settingsCache.get(cacheKey);
       if (cacheValue) {
         settingsToReturn.set(obj.key, cacheValue);
@@ -192,7 +198,7 @@ class SettingsManager {
     }
 
     return settingsToGet.map((setting: any) => {
-      const cacheKey = `${setting.key}_${JSON.stringify(labels)}`;
+      const cacheKey = this.getCacheKey(setting.key, labels);
       let returnValue;
       try {
         returnValue = SettingsManager.readNetworkValue(settingsToReturn.get(setting.key), setting.defaultValue);
@@ -206,13 +212,30 @@ class SettingsManager {
   }
 
   setLocal(key: string, labels: LabelsArray, value: SettingValue) {
-    const cacheKey = `${key}_${JSON.stringify(labels)}`;
+    const cacheKey = this.getCacheKey(key, labels);
     this.settingsCache.set(cacheKey, value, this.ttl);
   }
 
   flush() {
     return this.settingsCache.flushAll();
   }
+
+  // eslint-disable-next-line class-methods-use-this
+  getCacheKey(key: SettingValue, labels: LabelsArray) {
+    const newLabels = labels.map((l) => {
+      if (l.time) {
+        return {
+          ...l,
+          time: moment(l.time).startOf('hour').format(),
+          day: moment(l.time).day(),
+        };
+      }
+      return l;
+    });
+
+    const cacheKey = `${key}_${JSON.stringify(newLabels)}`;
+    return cacheKey;
+  }
 }
 
 export default SettingsManager;