@alertlogic/al-collector-js 3.0.6 → 3.0.7

package/README.md

@@ -25,7 +25,9 @@ const {
     AzcollectC,
     EndpointsC,
     AlLog,
-    Parse 
+    Parse ,
+    RestServiceClient,
+    CollectorStatusC
 } = require('@alertlogic/al-collector-js');
 ```
 
@@ -90,6 +92,14 @@ const azCollectClient = new AzcollectC(apiEndpoint, aimsCreds, collectorType, se
 ```javascript
 const alEndpointsClient = EndpointsC(apiEndpoint, aimsCreds, retryOption);
 ```
+## CollectorStatusC
+* @param {string} apiEndpoint - Alert Logic API hostname.
+* @param {Object} aimsCreds - Alert Logic API credentials object, refer to AimsC.
+* @param {*} retryOptions.
+
+```javascript
+const alCollectorStatusClient = CollectorStatusC(apiEndpoint, aimsCreds, retryOption);
+```
 
 ## AlLog
 *  @param hostId - host uuid obtained at collector registration

package/al_util.js

@@ -15,6 +15,7 @@ let MAX_CONNS_PER_SERVICE = 128;
 
 /**
  * @default Refer to https://www.npmjs.com/package/retry
+ * set maxRetryTime to 180seconds(3min) to avoid lambda timeout.
  */
 let DEFAULT_RETRY = {
     // Default values
@@ -22,7 +23,8 @@ let DEFAULT_RETRY = {
     factor: 7,
     minTimeout: 300,
     retries: 2,
-    maxTimeout: 10000
+    maxTimeout: 10000,
+    maxRetryTime: 180000 // Maximum time to spend retrying in milliseconds.
 };
 
 /**

package/collector_statusc.js

@@ -31,7 +31,9 @@ class CollectorStatusC extends AlServiceC {
             },
             body: data
         };
-        return this.put(`/statuses/${statusId}/streams/${stream}`, payload);
+        // Few collector stream contain `/` which not excepted by collectors_status service. so Encode the stream before making the api call.It will encodes special characters including: , / ? : @ & = + $ # 
+        const encodedStream = encodeURIComponent(stream);
+        return this.put(`/statuses/${statusId}/streams/${encodedStream}`, payload);
     }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alertlogic/al-collector-js",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "license": "MIT",
   "description": "Alert Logic Collector Common Library",
   "repository": {

package/test/al_mock.js

@@ -159,6 +159,10 @@ const AIMS_RESPONSE_200 = {
           }
         };
 
+const SERVER_ERROR_500 = {
+    statusCode: 500,
+    message: "Internal Server Error"
+};
 function gen_auth_response() {
     return {
         authentication : {
@@ -188,6 +192,7 @@ module.exports = {
     AZURE_CHECKIN_VALUES: AZURE_CHECKIN_VALUES,
     SEND_COLLECTOR_STATUS_BODY_DATA: SEND_COLLECTOR_STATUS_BODY_DATA,
     COLLECTOR_STATUS_API: COLLECTOR_STATUS_API,
+    SERVER_ERROR_500: SERVER_ERROR_500,
 
     gen_auth_response : gen_auth_response
 };

package/test/al_util_test.js

@@ -132,5 +132,51 @@ describe('Unit Tests', function() {
             done();
         });
 
+        it('check it should return server error after retry', function (done) {
+            var restC = new RestServiceClient(m_alMock.AL_API);
+
+            nock('https://' + m_alMock.AL_API, {
+                reqheaders: {
+                    'accept': 'application/json',
+                    'host': m_alMock.AL_API,
+                    'some_header': 'some_value'
+                }
+            })
+                .post(TEST_PATH, TEST_BODY)
+                .reply(500, m_alMock.SERVER_ERROR_500);
+
+            restC.post(TEST_PATH, {
+                headers: { 'some_header': 'some_value' },
+                body: TEST_BODY
+            })
+                .catch(err => {
+                    console.log(`err ${err}`);
+                    done();
+                });
+        });
+
+        it('check it should success if last response is successful after server error 500', function (done) {
+            var restC = new RestServiceClient(m_alMock.AL_API);
+            var restMock = nock('https://' + m_alMock.AL_API, {
+                reqheaders: {
+                    'accept': 'application/json',
+                    'host': m_alMock.AL_API,
+                    'content-type': 'application/json',
+                    'some_header': 'some_value'
+                }
+            })
+                .post(TEST_PATH, TEST_BODY)
+                .reply(500, m_alMock.SERVER_ERROR_500)
+                .post(TEST_PATH, TEST_BODY)
+                .reply(200, m_alMock.AIMS_RESPONSE_200);
+
+            restC.post(TEST_PATH, {
+                headers: { 'some_header': 'some_value' },
+                body: TEST_BODY
+            }).then(res => {
+                assert.ok(restMock.isDone());
+                done();
+            });
+        });
     });
 });

package/test/collector_statusc_test.js

@@ -54,6 +54,24 @@ describe('Unit Tests', function () {
             });
         });
 
+        it('it should encode the stream if it contain special char', function (done) {
+            let stream = 'projects/appliance-builds';
+            const encodedStream = encodeURIComponent(stream);
+            fakePut = sinon.stub(AlServiceC.prototype, 'put').callsFake(
+                function fakeFn(path, extraOptions) {
+                    assert.equal(extraOptions.body, m_alMock.SEND_COLLECTOR_STATUS_BODY_DATA);
+                    assert.equal(path, `/statuses/${m_alMock.SEND_COLLECTOR_STATUS_BODY_DATA.status_id}/streams/${encodedStream}`);
+                    done();
+                });
+
+            var aimsc = new AimsC(m_alMock.AL_API, m_alMock.AIMS_CREDS);
+            var collectorStatus = new CollectorStatusC(m_alMock.COLLECTOR_STATUS_API, aimsc);
+            m_alMock.SEND_COLLECTOR_STATUS_BODY_DATA.stream = stream;
+            collectorStatus.sendStatus(m_alMock.SEND_COLLECTOR_STATUS_BODY_DATA.status_id, m_alMock.SEND_COLLECTOR_STATUS_BODY_DATA.stream, m_alMock.SEND_COLLECTOR_STATUS_BODY_DATA).then(res => {
+                fakePut.restore();
+            });
+        });
+
         it('If sequence of parameter is not correct then api throw the error', function (done) {
             const error = {
                 "errorinfo": {

package/test/request_retry_test.js

@@ -14,6 +14,7 @@ const nock = require('nock');
 const m_alMock = require('./al_mock');
 const m_alService = require('../al_servicec');
 const EndpointsC = require('../al_servicec').EndpointsC;
+const moment = require('moment');
 
 describe('HTTP request retry tests', function() {
     beforeEach(function(done) {
@@ -202,4 +203,33 @@ describe('HTTP request retry tests', function() {
                 return done();
             });
     });
+
+    it('Retry 500 with custom retry config with maxRetryTime', function (done) {
+        const maxRetryTime = 1500;
+        const retryOptions = {
+            retries: 3,
+            factor: 2,
+            minTimeout: 300,
+            maxTimeout: 1000,
+            maxRetryTime: maxRetryTime,
+        };
+        nock('https://' + m_alMock.AL_API)
+            .post('/aims/v1/authenticate')
+            .times(4)
+            .reply(500, m_alMock.SERVER_ERROR_500);
+        var startTime = moment();
+        var aimsc = new m_alService.AimsC(
+            m_alMock.AL_API, m_alMock.AIMS_CREDS, '/tmp', retryOptions);
+        aimsc.authenticate()
+            .catch(err => {
+                assert.equal(err.statusCode, 500);
+                var nowMoment = moment();
+                const elapsedTime = nowMoment.diff(startTime, 'milliseconds');
+                assert.ok(
+                    elapsedTime >= maxRetryTime && elapsedTime <= maxRetryTime + retryOptions.maxTimeout,
+                    'Test case failed: Request did not complete within maxRetryTime.'
+                );
+                return done();
+            });
+    });
 });