add "privateTags" config option on swagger_raw to drop tagged objects, drops "x-private" by default

Author: theganyo

fittings/swagger_raw.js

@@ -7,6 +7,9 @@ var _ = require('lodash');
 // default filter just drops all the x- labels
 var DROP_SWAGGER_EXTENSIONS = /^(?!x-.*)/;
 
+// default filter drops anything labeled x-private
+var X_PRIVATE = ['x-private'];
+
 module.exports = function create(fittingDef, bagpipes) {
 
   debug('config: %j', fittingDef);
@@ -16,7 +19,8 @@ module.exports = function create(fittingDef, bagpipes) {
     filter = new RegExp(fittingDef.filter);
   }
   debug('swagger doc filter: %s', filter);
-  var filteredSwagger = filterKeysRecursive(bagpipes.config.swaggerNodeRunner.swagger, filter);
+  var privateTags = fittingDef.privateTags || X_PRIVATE;
+  var filteredSwagger = filterKeysRecursive(bagpipes.config.swaggerNodeRunner.swagger, filter, privateTags);
 
   if (!filteredSwagger) { return next(null, ''); }
 
@@ -41,15 +45,25 @@ module.exports = function create(fittingDef, bagpipes) {
   }
 };
 
-function filterKeysRecursive(object, regex) {
+function filterKeysRecursive(object, dropTagRegex, privateTags) {
   if (_.isPlainObject(object)) {
-    var result = {};
-    _.each(object, function(value, key) {
-      if (regex.test(key)) {
-        result[key] = filterKeysRecursive(value, regex);
-      }
-    });
-    return result;
+    if (_.any(privateTags, function(tag) { return object[tag]; })) {
+      object = undefined;
+    } else {
+      var result = {};
+      _.each(object, function(value, key) {
+        if (dropTagRegex.test(key)) {
+          var v = filterKeysRecursive(value, dropTagRegex, privateTags);
+          if (v !== undefined) {
+            result[key] = v;
+          } else {
+            debug('dropping object at %s', key);
+            delete(result[key]);
+          }
+        }
+      });
+      return result;
+    }
   }
   return object;
 }

test/assets/project/api/swagger/swagger.yaml

@@ -262,6 +262,7 @@ paths:
   /invalid_response_code:
     x-swagger-router-controller: hello_world
     get:
+      x-hidden: true
       description: Returns 'Hello' to the caller
       operationId: hello
       parameters:
@@ -276,6 +277,7 @@ paths:
           schema:
             $ref: "#/definitions/ErrorResponse"
   /invalid_header:
+    x-private: true
     x-swagger-router-controller: hello_world
     get:
       description: Returns 'Hello' to the caller

test/fittings/swagger_raw.js

@@ -16,15 +16,18 @@ describe('swagger_raw', function() {
     var bagpipes = { config: { swaggerNodeRunner: { swagger: swagger }}};
     swaggerDoc = swagger_raw({}, bagpipes);
 
-    // hokey algorithm, but at least it's different than the one it's testing
     var filteredSwagger = _.cloneDeep(swagger);
-    var OMIT = ['x-swagger-router-controller', 'x-swagger-pipe'];
+    delete(filteredSwagger.paths['/invalid_header']);
+
+    // hokey algorithm, but at least it's different than the one it's testing
+    var OMIT = ['x-swagger-router-controller', 'x-swagger-pipe', 'x-hidden', 'x-private'];
     _.forEach(filteredSwagger.paths, function(element, name) {
       filteredSwagger.paths[name] = _.omit(element, OMIT);
       _.forEach(filteredSwagger.paths[name], function(element, subName) {
         filteredSwagger.paths[name][subName] = _.omit(element, OMIT);
       });
     });
+
     yaml = YAML.safeDump(filteredSwagger, { indent: 2 });
     json = JSON.stringify(filteredSwagger, null, 2);
   });
@@ -83,7 +86,42 @@ describe('swagger_raw', function() {
       should.not.exist(err);
       'application/yaml'.should.eql(context.headers['Content-Type']);
 
-      var yaml = YAML.safeDump(swagger, { indent: 2 });
+      var filteredSwagger = _.cloneDeep(swagger);
+      delete(filteredSwagger.paths['/invalid_header']);
+      should.exist(filteredSwagger.paths['/invalid_response_code'].get)
+      var yaml = YAML.safeDump(filteredSwagger, { indent: 2 });
+
+      output.should.eql(yaml);
+      done();
+    });
+  });
+
+  it('should be able to modify privateTags & apply to operations', function(done) {
+
+    var context = {
+      headers: {},
+      request: {
+        headers: { accept: 'application/yaml' }
+      }
+    };
+
+    config = {
+      filter: '.*',
+      privateTags: [ 'x-private', 'x-hidden' ]
+    };
+
+    var bagpipes = { config: { swaggerNodeRunner: { swagger: swagger }}};
+    var swaggerDoc = swagger_raw(config, bagpipes);
+
+    swaggerDoc(context, function(err, output) {
+      should.not.exist(err);
+      'application/yaml'.should.eql(context.headers['Content-Type']);
+
+      var filteredSwagger = _.cloneDeep(swagger);
+      delete(filteredSwagger.paths['/invalid_header']);
+      delete(filteredSwagger.paths['/invalid_response_code'].get);
+      var yaml = YAML.safeDump(filteredSwagger, { indent: 2 });
+
       output.should.eql(yaml);
       done();
     });