@autofleet/node-common 1.1.3 → 1.1.5

package/index.js

@@ -1,7 +1,9 @@
 const Network = require('./network');
 const Logger = require('./logger');
+const Settings = require('./settings');
 
 module.exports = {
   Network,
   Logger,
+  Settings,
 };

package/network/index.js

@@ -1,6 +1,7 @@
 const axios = require('axios');
 const axiosRetry = require('axios-retry');
 const Logger = require('../logger');
+const qs = require('qs');
 const httpAdapter = require('axios/lib/adapters/http');
 require('dotenv').config();
 /**
@@ -24,6 +25,7 @@ const HTTPMethods = [
 const defaultSettings = {
   timeout: 2500,
   headers: { 'X-AF-AUTH': 'ANYONE' },
+  paramsSerializer: params => qs.stringify(params),
 };
 
 module.exports = class Network {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/node-common",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "",
   "scripts": {
     "coverage": "jest --coverage --forceExit --runInBand",
@@ -26,6 +26,8 @@
     "axios-retry": "^3.1.0",
     "dotenv": "^5.0.1",
     "jest": "^22.4.3",
+    "node-cache": "^4.2.0",
+    "qs": "^6.5.2",
     "winston": "^3.0.0-rc4"
   },
   "devDependencies": {

package/settings/example.js

@@ -0,0 +1,30 @@
+/* eslint no-console: 0 */
+const Settings = require('./index');
+
+const settings = new Settings({
+  serviceUrl: 'http://setting-ms.autofleet.io/',
+});
+
+const fleetId = 'e7bbfcad-98a8-421d-962f-fd1c7790c789';
+
+const testSettings = async () => {
+  const generalSetting = await settings.get('ride.matching_retry', 1);
+  const fleetSetting = await settings.get('ride.matching_retry', 1, [{ fleetId }]);
+  const notFoundKey = await settings.get('not.found.key', 1, [{ fleetId }]);
+  await settings.get('not.found.key', 1, [{ fleetId }, { dor: 1 }]);
+
+  try {
+    await settings.get('not.found.key');
+  } catch (error) {
+    console.log(error);
+  }
+
+  console.log(generalSetting);
+  console.log(fleetSetting);
+  console.log(notFoundKey);
+};
+
+testSettings();
+setTimeout(() => {
+  testSettings();
+}, 500);

package/settings/index.js

@@ -0,0 +1,52 @@
+const NodeCache = require('node-cache');
+const Network = require('../network');
+const Logger = require('../logger');
+
+const logger = Logger();
+require('dotenv').config();
+
+const fiveMinutes = 60 * 5;
+
+module.exports = class SettingsManager {
+  constructor({ serviceUrl, ttl = fiveMinutes } = {}) {
+    const localServiceUrl = serviceUrl || process.env.SETTING_MS_SERVICE_HOST;
+
+    this.ttl = ttl;
+    this.settingsCache = new NodeCache();
+    this.network = new Network({
+      serviceUrl: localServiceUrl,
+    });
+  }
+
+  async get(key, defaultValue, labels = []) {
+    if (!defaultValue) {
+      throw new Error('Can\'t get a key without defaultValue');
+    }
+
+    const cacheKey = `${key}_${JSON.stringify(labels)}`;
+    const cacheValue = this.settingsCache.get(cacheKey);
+    if (cacheValue !== undefined) {
+      return cacheValue;
+    }
+
+    let networkValue;
+    try {
+      const networkReponse = await this.network.get(`/api/v1/settings/get-setting/${key}`, {
+        params: {
+          labels,
+        },
+      });
+      networkValue = networkReponse.data.value;
+    } catch (error) {
+      logger.error('Cant get setting from network', error);
+    }
+
+    const returnValue = networkValue || defaultValue;
+    this.settingsCache.set(cacheKey, returnValue, this.ttl);
+    return returnValue;
+  }
+
+  flush() {
+    return this.settingsCache.flushAll();
+  }
+};

package/settings/index.test.js

@@ -0,0 +1,94 @@
+const nock = require('nock');
+const Settings = require('./index');
+
+const serviceUrl = 'http://localhost:8085';
+
+const mockSetting = (key, value, labels, response = 200) => nock(serviceUrl)
+  .get(`/api/v1/setting/get-setting/${key}`)
+  .query(labels ? { labels } : undefined)
+  .reply(response, { value });
+
+describe('Settings', () => {
+  it('Throws exeption if there is no defualt value', async () => {
+    const settings = new Settings({
+      serviceUrl,
+    });
+
+    expect(settings.get('key1'))
+      .rejects.toEqual(new Error('Can\'t get a key without defaultValue'));
+  });
+
+  it('Uses env.SETTING_MS_SERVICE_HOST as serivce host if no one defind', async () => {
+    const m = mockSetting('key1', 'value1');
+    process.env.SETTING_MS_SERVICE_HOST = serviceUrl;
+    const settings = new Settings();
+
+    const value = await settings.get('key1', 'dv');
+    expect(value).toEqual('value1');
+    expect(m.isDone()).toBeTruthy();
+    process.env.SETTING_MS_SERVICE_HOST = '';
+  });
+
+  it('Get a key from server', async () => {
+    const m = mockSetting('key1', 'value1');
+    const settings = new Settings({
+      serviceUrl,
+    });
+
+    const value = await settings.get('key1', 'dv');
+    expect(value).toEqual('value1');
+    expect(m.isDone()).toBeTruthy();
+  });
+
+  it('Cache from server', async () => {
+    const m = mockSetting('key1', 'value1');
+    const settings = new Settings({
+      serviceUrl,
+    });
+
+    const value = await settings.get('key1', 'dv');
+    expect(value).toEqual('value1');
+    expect(m.isDone()).toBeTruthy();
+
+    const value2 = await settings.get('key1', 'dv');
+    expect(value2).toEqual('value1');
+  });
+
+  it('Finds with labels', async () => {
+    const m = mockSetting('key1', 'value1', [{ fleetId: 'uuid' }]);
+    const settings = new Settings({
+      serviceUrl,
+    });
+
+    const value = await settings.get('key1', 'dv', [{ fleetId: 'uuid' }]);
+    expect(value).toEqual('value1');
+    expect(m.isDone()).toBeTruthy();
+  });
+
+  it('Returns default value when network error', async () => {
+    const settings = new Settings({
+      serviceUrl,
+    });
+
+    const value = await settings.get('key1', 'dv', [{ fleetId: 'uuid' }]);
+    expect(value).toEqual('dv');
+  });
+
+  it('Values can be flushed', async () => {
+    const m1 = mockSetting('key1', 'value1');
+    const settings = new Settings({
+      serviceUrl,
+    });
+
+    const value = await settings.get('key1', 'dv');
+    expect(value).toEqual('value1');
+    expect(m1.isDone()).toBeTruthy();
+
+    settings.flush();
+    const m2 = mockSetting('key1', 'value2');
+
+    const value2 = await settings.get('key1', 'dv');
+    expect(value2).toEqual('value2');
+    expect(m2.isDone()).toBeTruthy();
+  });
+});