@autofleet/node-common 2.0.0 → 3.0.0

package/README.md

@@ -18,35 +18,6 @@ Currently we suppurt:
   }
 ```
 
-## Network
-Server 2 Servers communication.
-
-Implemented:
-* Retriving service urls from environment
-* Retry - Using https://github.com/softonic/axios-retry
-* Caching - TBD
-* Syntatic response for fail - TBD
-* Circuit Breaking - TBD
-
-The API is just like [axios](https://github.com/axios/axios) api but the creation of new instance **must** have either `serviceName` or `serviceUrl` in options.
-
-In case `serviceName` used the constractor will look for an environment varible with the the name `<SERVICE_NAME>_SERVICE_HOST`.
-
-For Example:
-```
-const { Network } = require('@autofleet/node-common');
-
-n = new Network({ serviceName: 'TEST' });
-
-n.get('/posts/1');
-```
-.env file:
-```
-RIDE_SERVICE_HOST=jsonplaceholder.typicode.com
-```
-
-To learn more [click here](https://blog.risingstack.com/designing-microservices-architecture-for-failure/).
-
 ## Settings
 
 ### Adding settings

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "@autofleet/node-common",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "",
   "scripts": {
     "coverage": "jest --coverage --forceExit --runInBand",
     "test": "jest --forceExit --runInBand",
     "test-auto": "jest --watch --runInBand",
-    "linter": "./node_modules/.bin/eslint ."
+    "linter": "eslint ."
   },
   "jest": {
-    "setupTestFrameworkScriptFile": "jest-extended",
-    "testURL": "http://localhost:8085/"
+    "setupFilesAfterEnv": [
+      "jest-extended"
+    ],
+    "testEnvironmentOptions": {
+      "url": "http://localhost:8085/"
+    }
   },
   "repository": {
     "type": "git",
@@ -23,25 +27,24 @@
   },
   "homepage": "https://github.com/Autofleet/node-common",
   "dependencies": {
-    "axios": "^0.18.0",
+    "axios": "^0.28.1",
     "axios-retry": "^3.1.0",
     "dotenv": "^5.0.1",
-    "express": "^4.16.2",
-    "jest": "^22.4.4",
-    "mock-socket": "^7.1.0",
-    "node-cache": "^4.2.0",
-    "node-resque": "^5.4.1",
-    "portfinder": "^1.0.13",
-    "qs": "^6.5.2",
-    "timekeeper": "^2.1.2",
-    "winston": "^3.0.0",
-    "ws": "^5.2.1"
+    "express": "^4.19.2",
+    "node-cache": "^4.2.0"
   },
   "devDependencies": {
-    "eslint": "^4.19.1",
-    "eslint-config-airbnb": "^16.1.0",
-    "eslint-plugin-import": "^2.11.0",
+    "@autofleet/logger": "^4.0.6",
+    "@autofleet/network": "^1.5.1",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.29.1",
+    "jest": "^29.7.0",
     "jest-extended": "^0.7.1",
     "nock": "^10.0.2"
+  },
+  "peerDependencies": {
+    "@autofleet/logger": ">=4.0.6",
+    "@autofleet/network": ">=1.0.0"
   }
 }

package/router/index.js

@@ -1,5 +1,7 @@
 const { Router } = require('express');
-const logger = require('../logger')();
+const { default: Logger } = require('@autofleet/logger');
+
+const logger = Logger();
 
 const METHODS = [
   'all',
@@ -12,8 +14,16 @@ const METHODS = [
   'head',
 ];
 
+/**
+ * @param {(
+ *  req: import('express').Request,
+ *  res: import('express').Response,
+ *  nextFn: import('express').NextFunction
+ * ) => void | PromiseLike<void>} func
+ * @returns {import('express').Handler}
+ */
 // eslint-disable-next-line consistent-return
-const AfEntryPoint = func => async (req, res, next) => {
+const AfEntryPoint = (func) => async (req, res, next) => {
   try {
     await func(req, res, next);
   } catch (e) {
@@ -25,6 +35,11 @@ const AfEntryPoint = func => async (req, res, next) => {
   }
 };
 
+/**
+ * @param {Parameters<typeof Router>[0]} [options]
+ * @returns {Router} a monkey-patched express router that
+ *  will handle async routes (and force a 400 status for codes <500)
+ */
 const AfRouter = (options) => {
   const myRouter = Router({ mergeParams: true, ...options });
   METHODS.map((method) => {

package/settings/index.js

@@ -1,7 +1,7 @@
 const EventEmitter = require('events');
 const NodeCache = require('node-cache');
-const Network = require('../network');
-const Logger = require('../logger');
+const Network = require('@autofleet/network');
+const { default: Logger } = require('@autofleet/logger');
 // const keysMap = require('./map');
 
 const util = require('util');
@@ -14,9 +14,9 @@ require('dotenv').config();
 const fiveMinutes = 60 * 5;
 const waitingToNetwork = 'waitingToNetwork';
 
-const findUrl = serviceUrl => 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/');
+const findUrl = (serviceUrl) => serviceUrl
+  || (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/');
 
 class SettingsManager {
   static get NEVER_DEFAULT_VALUE() {
@@ -33,6 +33,9 @@ class SettingsManager {
     return returnValue;
   }
 
+  /**
+   * @param {{ serviceUrl: string; ttl?: number }} param0
+   */
   constructor({ serviceUrl, ttl = fiveMinutes } = {}) {
     const localServiceUrl = findUrl(serviceUrl);
 

package/settings/index.test.js

@@ -72,7 +72,6 @@ describe('Settings', () => {
     expect(value2).toEqual('value1');
   });
 
-
   it('Use only one request for similar keys', async () => {
     const m = mockSetting('key1EM', 'value1EM');
     const settings = new Settings({
@@ -119,7 +118,7 @@ describe('Settings', () => {
       .rejects.toEqual(new Error('Cannot find value from network or cache, default value is set to never'));
   });
 
-  it('Throws an error if network error and no default value and success the next time', async (done) => {
+  it('Throws an error if network error and no default value and success the next time', (done) => {
     const settings = new Settings({
       serviceUrl: `http://${serviceUrl}/`,
     });
@@ -128,7 +127,6 @@ describe('Settings', () => {
     expect(f())
       .rejects.toEqual(new Error('Cannot find value from network or cache, default value is set to never'));
 
-
     setTimeout(async () => {
       const m = mockSetting('key1', 'value1');
       expect(await settings.get('key1', settings.NEVER_DEFAULT_VALUE)).toEqual('value1');