@autofleet/settings 2.0.1 → 3.0.1

package/src/index.ts

@@ -1,257 +0,0 @@
-// 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, { once } from 'events';
-import moment from 'moment';
-import h3 from 'h3-js';
-
-dotenv.config();
-
-const logger = Logger();
-
-const fiveMinutes = 60 * 5;
-const waitingToNetwork = 'waitingToNetwork';
-
-const findUrl = (serviceUrl?: string) => serviceUrl
-  || (process.env.SETTING_MS_SERVICE_HOST && process.env.SETTING_MS_SERVICE_HOST.length > 0 ? `http://${process.env.SETTING_MS_SERVICE_HOST}/` : undefined)
-  || (process.env.NODE_ENV !== 'test' ? 'http://setting-ms.autofleet.io/' : 'http://localhost:9999/');
-
-interface SettingsClassOptions {
-  serviceUrl?: string;
-  ttl?: number;
-  disableTestEnvCheck?: boolean;
-}
-
-type SettingValue = string | boolean | number | any[] | any;
-
-interface Location {
-  lat: number;
-  lng: number;
-}
-interface Label {
-  businessModelId?: string;
-  demandSourceId?: string;
-  fleetId?: string;
-  vendorId?: string;
-  time?: string | Date;
-  location?: Location;
-  contextId?: string;
-}
-
-type LabelsArray = Label[];
-
-interface GetSettingOption {
-  timeout?: number;
-  rejectOnFail?: boolean;
-}
-
-class CannotGetNetworkValueError extends Error {}
-
-class SettingsManager {
-  ttl: number;
-
-  settingsCache: NodeCache;
-
-  networkEvents: EventEmitter;
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  network: any;
-
-  NEVER_DEFAULT_VALUE: string;
-
-  disableTestEnvCheck: boolean;
-
-  static get NEVER_DEFAULT_VALUE(): 'NEVER_DEFAULT_VALUE' {
-    return 'NEVER_DEFAULT_VALUE';
-  }
-
-  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');
-    }
-
-    return returnValue;
-  }
-
-  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({
-      serviceUrl: localServiceUrl,
-    });
-  }
-
-  async get(
-    key: SettingValue,
-    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');
-    }
-
-    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 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;
-    }
-
-    let networkValue;
-    try {
-      this.settingsCache.set(cacheKey, waitingToNetwork, this.ttl);
-      const networkResponse = await this.network.get(`/api/v1/settings/get-setting/${key}`, {
-        params: {
-          labels: labels.map((label) => JSON.stringify(label)),
-        },
-        timeout,
-      });
-      networkValue = networkResponse.data.value;
-    } catch (error) {
-      logger.error('Cant get setting from network', { error, rejectOnFail, key });
-      if (rejectOnFail) {
-        const errorToThrow = new CannotGetNetworkValueError();
-        this.networkEvents.emit(cacheKey, errorToThrow);
-        throw errorToThrow;
-      }
-    }
-
-    this.networkEvents.emit(cacheKey, networkValue);
-    let returnValue;
-    try {
-      returnValue = SettingsManager.readNetworkValue(networkValue, defaultValue, key);
-    } catch (e) {
-      this.settingsCache.del(cacheKey);
-      throw e;
-    }
-    this.settingsCache.set(cacheKey, returnValue, this.ttl);
-    return returnValue;
-  }
-
-  async getMultiple(
-    settingsToGet: {
-      key: SettingValue,
-      defaultValue: any,
-    }[],
-    labels: LabelsArray,
-    { timeout = 5000, rejectOnFail = false } : GetSettingOption = {},
-  ): Promise<any> {
-    const settingsToReturn = new Map();
-    const settingsToFetch: any[] = [];
-
-    settingsToGet.forEach((obj) => {
-      const cacheKey = this.getCacheKey(obj.key, labels);
-      const cacheValue = this.settingsCache.get(cacheKey);
-      if (cacheValue !== undefined && cacheValue !== waitingToNetwork) {
-        settingsToReturn.set(obj.key, cacheValue);
-      } else {
-        settingsToFetch.push(obj.key);
-      }
-    });
-
-    if (process.env.NODE_ENV === 'test') {
-      return settingsToGet.map((obj) => (settingsToReturn.get(obj.key) !== undefined ? settingsToReturn.get(obj.key) : obj.defaultValue));
-    }
-
-    if (settingsToFetch.length > 0) {
-      let values: any[];
-      try {
-        const { data } = await this.network.post('/api/v1/settings/get-settings/_multiple', {
-          keys: settingsToFetch,
-          labels,
-          skipEntityQueryAddition: true,
-        }, {
-          timeout,
-        });
-        values = data;
-
-        settingsToFetch.forEach((key, index) => {
-          settingsToReturn.set(key, values[index].value);
-        });
-      } catch (err) {
-        logger.error('Cant get setting from network', { err, settingsToFetch, labels });
-        if (rejectOnFail) {
-          throw new CannotGetNetworkValueError();
-        }
-      }
-    }
-
-    return settingsToGet.map((setting: any) => {
-      const cacheKey = this.getCacheKey(setting.key, labels);
-      let returnValue;
-      try {
-        returnValue = SettingsManager.readNetworkValue(settingsToReturn.get(setting.key), setting.defaultValue, setting.key);
-      } catch (err) {
-        this.settingsCache.del(cacheKey);
-        throw err;
-      }
-      if (settingsToFetch.indexOf(setting.key) !== -1) {
-        this.settingsCache.set(cacheKey, returnValue, this.ttl);
-      }
-      return returnValue;
-    });
-  }
-
-  setLocal(key: string, labels: LabelsArray, value: SettingValue): void {
-    const cacheKey = this.getCacheKey(key, labels);
-    this.settingsCache.set(cacheKey, value, this.ttl);
-  }
-
-  flush(): void {
-    return this.settingsCache.flushAll();
-  }
-
-  getCacheKey(key: SettingValue, labels: LabelsArray): string {
-    const newLabels = labels.map((l) => {
-      if (l.time) {
-        return {
-          ...l,
-          time: moment(l.time).startOf('hour').format(),
-          day: moment(l.time).day(),
-        };
-      }
-
-      if (l.location?.lat && l.location?.lng) {
-        const h3Index = h3.latLngToCell(l.location.lat, l.location.lng, 8);
-        return {
-          ...l,
-          location: h3Index,
-        };
-      }
-
-      return l;
-    });
-
-    const cacheKey = `${key}_${JSON.stringify(newLabels)}`;
-    return cacheKey;
-  }
-}
-
-export default SettingsManager;

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es6",
-    "module": "commonjs",
-    "declaration": true,
-    "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-  }
-}