feat(oas2): add support for generateMessageBody

Author: kylef

packages/fury-adapter-swagger/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Fury Swagger Parser Changelog
 
+## Master
+
+### Enhancements
+
+- The parser can now be configured to disable generation of example message
+  bodies by providing an adapter option `generateMessageBody` as `false` during
+  parse.
+
 ## 0.28.3 (2020-03-16)
 
 ### Enhancements

packages/fury-adapter-swagger/lib/parser.js

@@ -23,12 +23,20 @@ const {
 // the input Swagger into Refract elements. The `parse` function is its main
 // interface.
 class Parser {
-  constructor({ namespace, source, generateSourceMap }) {
+  constructor({
+    namespace, source, generateSourceMap, generateMessageBody,
+  }) {
     // Parser options
     this.namespace = namespace;
     this.source = source;
     this.generateSourceMap = generateSourceMap;
 
+    if (generateMessageBody === undefined) {
+      this.generateMessageBody = true;
+    } else {
+      this.generateMessageBody = generateMessageBody;
+    }
+
     // Global scheme requirements
     this.globalSchemes = [];
 
@@ -1110,9 +1118,11 @@ class Parser {
       pushHeader('Content-Type', FORM_CONTENT_TYPE, request, this, 'form-data-content-type');
     }
 
-    const jsonSchema = convertSchema(schema, { definitions: this.definitions },
-      this.referencedSwagger);
-    bodyFromSchema(jsonSchema, request, this, contentType || FORM_CONTENT_TYPE);
+    if (this.generateMessageBody) {
+      const jsonSchema = convertSchema(schema, { definitions: this.definitions },
+        this.referencedSwagger);
+      bodyFromSchema(jsonSchema, request, this, contentType || FORM_CONTENT_TYPE);
+    }
 
     // Generating data structure
     const dataStructure = new DataStructure();
@@ -1609,7 +1619,7 @@ class Parser {
       return;
     }
 
-    if (pushBody) {
+    if (pushBody && this.generateMessageBody) {
       if (cacheKey && this.bodyCache[cacheKey]) {
         const asset = this.bodyCache[cacheKey];
         payload.push(asset.clone());

packages/fury-adapter-swagger/test/adapter-test.js

@@ -16,20 +16,20 @@ const { detect } = adapter;
 
 fury.adapters = [adapter];
 
-function testFixture(description, fixture, generateSourceMap = false) {
+function testFixture(description, fixture, adapterOptions) {
   it(description, (done) => {
     const source = fixture.swagger;
     let expected;
 
-    if (generateSourceMap) {
+    if (adapterOptions && adapterOptions.generateSourceMap) {
       expected = fixture.apiElementsSourceMap;
     } else {
       expected = fixture.apiElements;
     }
 
     const mediaType = 'application/swagger+yaml';
 
-    fury.parse({ source, mediaType, generateSourceMap }, (err, output) => {
+    fury.parse({ source, mediaType, adapterOptions }, (err, output) => {
       if (err && !output) {
         return done(err);
       }
@@ -40,7 +40,7 @@ function testFixture(description, fixture, generateSourceMap = false) {
       if (process.env.GENERATE) {
         expected = fury.minim.toRefract(output);
 
-        if (generateSourceMap) {
+        if (adapterOptions && adapterOptions.generateSourceMap) {
           // eslint-disable-next-line no-param-reassign
           fixture.apiElementsSourceMap = expected;
         } else {
@@ -55,6 +55,24 @@ function testFixture(description, fixture, generateSourceMap = false) {
   });
 }
 
+function testFixtureOptions(swaggerPath, apiElementsPath) {
+  const swagger = fs.readFileSync(swaggerPath, 'utf-8');
+  const options = { swagger };
+
+  Object.defineProperty(options, 'apiElements', {
+    get() {
+      return require(apiElementsPath);
+    },
+
+    set(value) {
+      fs.writeFileSync(apiElementsPath, JSON.stringify(value, null, 2));
+      return value;
+    },
+  });
+
+  return options;
+}
+
 describe('Swagger 2.0 adapter', () => {
   context('detection', () => {
     it('detects JSON', () => {
@@ -141,17 +159,17 @@ describe('Swagger 2.0 adapter', () => {
     const fixtures = swaggerZoo.features();
     fixtures.forEach((fixture) => {
       testFixture(`Parses ${fixture.name}`, fixture);
-      testFixture(`Parses ${fixture.name} with source maps`, fixture, true);
+      testFixture(`Parses ${fixture.name} with source maps`, fixture, { generateSourceMap: true });
     });
   });
 
   describe('can parse regression fixtures', () => {
     const files = glob.sync(path.join(__dirname, 'fixtures', '*.yaml'));
 
-    files.forEach((file) => {
-      const name = path.basename(file, path.extname(file));
+    files.forEach((swaggerPath) => {
+      const name = path.basename(swaggerPath, path.extname(swaggerPath));
 
-      const swagger = fs.readFileSync(file, 'utf-8');
+      const swagger = fs.readFileSync(swaggerPath, 'utf-8');
       const apiElementsPath = path.join(__dirname, 'fixtures', `${name}.json`);
       const apiElementsSourceMapPath = path.join(__dirname, 'fixtures', `${name}.sourcemap.json`);
 
@@ -181,6 +199,26 @@ describe('Swagger 2.0 adapter', () => {
 
       testFixture(`Parses ${name}`, options);
       testFixture(`Parses ${name} with source maps`, options, true);
+      testFixture(`Parses ${name}`, testFixtureOptions(swaggerPath, apiElementsPath));
+    });
+  });
+
+  describe('#adapterOptions', () => {
+    describe('#generateMessageBody', () => {
+      testFixture('generates message body by default', testFixtureOptions(
+        path.join(__dirname, 'fixtures', 'json-body-generation.yaml'),
+        path.join(__dirname, 'fixtures', 'options', 'generateMessageBody-true.json')
+      ));
+
+      testFixture('generates message body when generateMessageBody is true', testFixtureOptions(
+        path.join(__dirname, 'fixtures', 'json-body-generation.yaml'),
+        path.join(__dirname, 'fixtures', 'options', 'generateMessageBody-true.json')
+      ), { generateMessageBody: true });
+
+      testFixture('disables generating message body when requested', testFixtureOptions(
+        path.join(__dirname, 'fixtures', 'json-body-generation.yaml'),
+        path.join(__dirname, 'fixtures', 'options', 'generateMessageBody-false.json')
+      ), { generateMessageBody: false });
     });
   });
 });