Improved API response validation (aws#287)

emdgroup · May 5, 2020 · 6d35667 · 6d35667
1 parent bfbc97d
commit 6d35667
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/packages/core/lib/middleware/sampling/service_connector.js b/packages/core/lib/middleware/sampling/service_connector.js
@@ -43,6 +43,10 @@ var ServiceConnector = {
           callback(err);
         }
 
+        if (dataObj === null) {
+          callback(new Error('AWS X-Ray GetSamplingRules API returned null response'));
+        }
+
         var newRules = assembleRules(dataObj);
         callback(null, newRules);
       });
@@ -79,6 +83,10 @@ var ServiceConnector = {
           callback(err);
         }
 
+        if (dataObj === null || !dataObj['LastRuleModification']) {
+          callback(new Error('AWS X-Ray SamplingTargets API returned invalid response'));
+        }
+
         var targetsMapping = assembleTargets(dataObj);
         var ruleFreshness = dateToEpoch(dataObj['LastRuleModification']);
         callback(null, targetsMapping, ruleFreshness);
@@ -117,7 +125,7 @@ var constructStatisticsDocs = function constructStatisticsDocs(rules) {
 
 var assembleRules = function assembleRules(data) {
   var newRules = [];
-  var ruleList = data['SamplingRuleRecords'];
+  var ruleList = data['SamplingRuleRecords'] || [];
   ruleList.forEach(function(ruleRecord) {
     ruleRecord = ruleRecord['SamplingRule'];
     // For forward compatibility reason right now it only
@@ -141,7 +149,7 @@ var assembleRules = function assembleRules(data) {
 };
 
 var assembleTargets = function assembleTargets(data) {
-  var docs = data['SamplingTargetDocuments'];
+  var docs = data['SamplingTargetDocuments'] || [];
   var targetsMapping = {};
 
   docs.forEach(function(doc) {

diff --git a/packages/core/test/unit/sampling/service_connector.test.js b/packages/core/test/unit/sampling/service_connector.test.js
@@ -2,6 +2,7 @@ var assert = require('chai').assert;
 var expect = require('chai').expect;
 var chai = require('chai');
 var sinon = require('sinon');
+var rewire = require('rewire');
 
 var DaemonConfig = require('../../../lib/daemon_config');
 var ServiceConnector = require('../../../lib/middleware/sampling/service_connector');
@@ -179,6 +180,24 @@ describe('ServiceConnector', function() {
         done();
       });
     });
+
+    it('handles invalid responses from the API gracefully', function() {
+      var rewiredConnector = rewire('../../../lib/middleware/sampling/service_connector');
+      var assembleRules = rewiredConnector.__get__('assembleRules');
+
+      var res = assembleRules({});
+      assert.isArray(res);
+    });
+  });
+
+  describe('fetchSamplingTargets', function() {
+    it('handles invalid responses from the API gracefully', function() {
+      var rewiredConnector = rewire('../../../lib/middleware/sampling/service_connector');
+      var assembleTargets = rewiredConnector.__get__('assembleTargets');
+
+      var res = assembleTargets({});
+      assert.deepEqual(res, {});
+    });
   });
 
   describe('DaemonConfig', function() {