#1095 retry on network error (#22)

* #1095 added request retry on network error

* #1095 ci node ver update

* #1095 circleci 2.0

* #1095 circleci 2.0

* #1095 circleci 2.0

* #1095 circleci 2.0

* #1095 fixed deps

* #1095 updated node version

* #725 requests keep-alive

* version fix

* #725 minor fix

Author: zuker

lib/client.js

@@ -1,6 +1,10 @@
+const _ = require('lodash');
+const { STRATEGIES } = require('./retryStrategies');
+
 module.exports = ElasticIO;
 
 ElasticIO.API_DEFAULT_BASE_URL = 'https://api.elastic.io';
+ElasticIO.RETRY_STRATEGIES = STRATEGIES;
 
 var resources = {
     accounts: require('./resources/accounts'),
@@ -18,7 +22,7 @@ var resources = {
     users: require('./resources/users')
 };
 
-function ElasticIO(user, password) {
+function ElasticIO(user, password, options = {}) {
     var self = this;
     var baseUri = process.env.ELASTICIO_API_URI || ElasticIO.API_DEFAULT_BASE_URL;
     baseUri = baseUri.replace(/\/+$/, '');
@@ -28,12 +32,13 @@ function ElasticIO(user, password) {
         basePath: baseUri
     };
 
-    prepareResources(self, resources);
+
+    prepareResources(self, resources, options);
 
     return this;
 }
 
-function prepareResources(container, resources) {
+function prepareResources(container, resources, options = {}) {
     var self = this;
 
     for (var next in resources) {
@@ -44,6 +49,7 @@ function prepareResources(container, resources) {
             container[name] = {};
             prepareResources(container[name], value);
         } else {
+            self.options = _.defaults(self.options || {}, options);
             container[name] = new resources[next](self);
         }
     }

lib/resource.js

@@ -1,40 +1,19 @@
-const Q = require('q');
 const util = require('util');
 const httpRequest = require('requestretry');
 const API_VERSION = 'v1';
+const _ = require('lodash');
+const {
+    MAP: RETRY_STRATEGIES_MAP,
+    STRATEGIES: { ON_HTTP_OR_NETWORK_ERROR }
+} = require('./retryStrategies');
 
 module.exports = ApiResource;
 
+
 function ApiResource(client) {
     this.client = client;
 }
 
-ApiResource.prototype.request = function request(method, path) {
-    var api = this.client._api;
-
-    var requestMethod = request[method];
-
-    function createRequestOptions() {
-        var options = {
-            url: util.format("%s/%s", api.basePath, path),
-            json: true,
-            auth: {
-                username: api.user,
-                password: api.password
-            }
-        };
-
-        return options;
-    }
-
-    function prepareResponse(response, body) {
-        console.log(response);
-    }
-
-    return Q.nfcall(requestMethod, createRequestOptions())
-        .spread(prepareResponse);
-};
-
 var hasOwn = {}.hasOwnProperty;
 
 ApiResource.extend = function extend(sub) {
@@ -61,11 +40,13 @@ ApiResource.extend = function extend(sub) {
 };
 
 ApiResource.method = function method(spec) {
-    var verb = spec.method || ApiResource.GET;
+    const verb = spec.method || ApiResource.GET;
     async function sendRequest(...args) {
+        const defaultOptions = this.client.options || {};
         var self = this;
         var api = self.client._api;
         var path = self.path || '';
+
         function provideOptions() {
             if (!path) {
                 throw new Error("A resource must define 'path'");
@@ -78,7 +59,7 @@ ApiResource.method = function method(spec) {
             path = interpolatePath(path, args);
             const [requestBody, options] = args;
 
-            return createRequestOptions(verb, api, path, requestBody, options);
+            return createRequestOptions(verb, api, path, requestBody, _.defaults(options || {}, defaultOptions));
         }
 
 
@@ -125,18 +106,33 @@ ApiResource.method = function method(spec) {
         return path;
     }
 
-    function createRequestOptions(verb, api, path, body, { retryCount, retryDelay } = {}) {
+    function createRequestOptions(
+        verb,
+        api,
+        path,
+        body,
+        {
+            retryCount,
+            retryDelay,
+            retryStrategy
+        } = {}
+    ) {
+        const defaultRetryStrategy = RETRY_STRATEGIES_MAP[ON_HTTP_OR_NETWORK_ERROR];
         var options = {
             url: util.format("%s/%s", api.basePath, path),
             method: verb,
             json: true,
+            forever: true,
+            headers: {
+                Connection: 'Keep-Alive'
+            },
             auth: {
                 username: api.user,
                 password: api.password
             },
             maxAttempts: retryCount || 3,
             retryDelay: retryDelay || 100,
-            retryStrategy: httpRequest.RetryStrategies.NetworkError,
+            retryStrategy: retryStrategy ? RETRY_STRATEGIES_MAP[retryStrategy] : defaultRetryStrategy,
             fullResponse: true
         };
 

lib/retryStrategies.js

@@ -0,0 +1,17 @@
+const httpRequest = require('requestretry');
+const ON_NETWORK_ERROR = Symbol('ON_NETWORK_ERROR');
+const ON_HTTP_OR_NETWORK_ERROR = Symbol('ON_HTTP_OR_NETWORK_ERROR');
+const ON_HTTP_ERROR = Symbol('ON_HTTP_ERROR');
+
+module.exports = {
+    MAP: {
+        [ON_NETWORK_ERROR]: httpRequest.RetryStrategies.NetworkError,
+        [ON_HTTP_OR_NETWORK_ERROR]: httpRequest.RetryStrategies.HTTPOrNetworkError,
+        [ON_HTTP_ERROR]: httpRequest.RetryStrategies.HTTPError
+    },
+    STRATEGIES: {
+        ON_NETWORK_ERROR,
+        ON_HTTP_OR_NETWORK_ERROR,
+        ON_HTTP_ERROR
+    }
+};

package-lock.json

@@ -1,7 +1,7 @@
 {
     "name": "elasticio-rest-node",
     "description": "elastic.io REST API client",
-    "version": "1.2.1",
+    "version": "1.2.3",
     "author": "elastic.io GmbH <[email protected]>",
     "engines": {
         "node": ">=10.15.0"

package.json

@@ -20,6 +20,7 @@ describe('/accounts', function () {
             ];
 
             nock('https://api.elastic.io')
+                .matchHeader('Connection', 'Keep-Alive')
                 .get('/v1/accounts/')
                 .basicAuth({
                     user: 'root',
@@ -58,6 +59,7 @@ describe('/accounts', function () {
             };
 
             nock('https://api.elastic.io')
+                .matchHeader('Connection', 'Keep-Alive')
                 .get('/v1/accounts/55083c567aea6f030000001a')
                 .basicAuth({
                     user: 'root',
@@ -101,6 +103,7 @@ describe('/accounts', function () {
             };
 
             nock('https://api.elastic.io')
+                .matchHeader('Connection', 'Keep-Alive')
                 .put('/v1/accounts/55083c567aea6f030000001a', input)
                 .basicAuth({
                     user: 'root',
@@ -144,6 +147,7 @@ describe('/accounts', function () {
             };
 
             nock('https://api.elastic.io')
+                .matchHeader('Connection', 'Keep-Alive')
                 .post('/v1/accounts/', input)
                 .basicAuth({
                     user: 'root',