Merge pull request #177 from apiaryio/honzajavorek/apib-multipart

Work around an APIB parser bug (multipart/form-data)

Author: honzajavorek

src/compile.js

@@ -16,8 +16,8 @@ function findRelevantTransactions(mediaType, apiElements) {
       //
       // This is very specific to API Blueprint and to backwards compatibility
       // of Dredd. There's a plan to migrate to so-called "transaction paths"
-      // in the future (apiaryio/dredd#227), which won't use the concept
-      // of transaction examples anymore.
+      // in the future (https://github.com/apiaryio/dredd/issues/227), which
+      // won't use the concept of transaction examples anymore.
       const transactionExampleNumbers = detectTransactionExampleNumbers(transitionElement);
       const hasMoreExamples = Math.max(...Array.from(transactionExampleNumbers || [])) > 1;
 
@@ -91,6 +91,24 @@ function compileOrigin(mediaType, filename, httpTransactionElement, exampleNo) {
   };
 }
 
+function hasMultipartBody(headers) {
+  return !!headers.filter(({ name, value }) =>
+    name.toLowerCase() === 'content-type'
+    && value.toLowerCase().includes('multipart')
+  ).length;
+}
+
+function compileBody(messageBodyElement, isMultipart) {
+  if (!messageBodyElement) { return ''; }
+
+  const body = messageBodyElement.toValue() || '';
+  if (!isMultipart) { return body; }
+
+  // Fixing manually written 'multipart/form-data' bodies (API Blueprint
+  // issue: https://github.com/apiaryio/api-blueprint/issues/401)
+  return body.replace(/\r?\n/g, '\r\n');
+}
+
 function compileRequest(httpRequestElement) {
   let request;
   const { uri, annotations } = compileUri(httpRequestElement);
@@ -106,11 +124,12 @@ function compileRequest(httpRequestElement) {
   });
 
   if (uri) {
+    const headers = compileHeaders(httpRequestElement.headers);
     request = {
       method: httpRequestElement.method.toValue(),
       uri,
-      headers: compileHeaders(httpRequestElement.headers),
-      body: (httpRequestElement.messageBody ? httpRequestElement.messageBody.toValue() : undefined) || ''
+      headers,
+      body: compileBody(httpRequestElement.messageBody, hasMultipartBody(headers))
     };
   } else {
     request = null;
@@ -120,13 +139,11 @@ function compileRequest(httpRequestElement) {
 }
 
 function compileResponse(httpResponseElement) {
-  const response = {
-    status: (httpResponseElement.statusCode ? httpResponseElement.statusCode.toValue() : undefined) || '200',
-    headers: compileHeaders(httpResponseElement.headers)
-  };
+  const status = (httpResponseElement.statusCode ? httpResponseElement.statusCode.toValue() : undefined) || '200';
+  const headers = compileHeaders(httpResponseElement.headers);
+  const response = { status, headers };
 
-  const body = httpResponseElement.messageBody ?
-    httpResponseElement.messageBody.toValue() : undefined;
+  const body = compileBody(httpResponseElement.messageBody, hasMultipartBody(headers));
   if (body) { response.body = body; }
 
   const schema = httpResponseElement.messageBodySchema ?

test/fixtures/api-blueprint/multipart-form-data.apib

@@ -0,0 +1,39 @@
+FORMAT: 1A
+
+# Sanbox 'multipart/form-data' API
+
+# POST /data
+
++ Request (multipart/form-data; boundary=CUSTOM-BOUNDARY)
+
+    + Body
+
+            --CUSTOM-BOUNDARY
+            Content-Disposition: form-data; name="text"
+            Content-Type: text/plain
+
+            test equals to 42
+            --CUSTOM-BOUNDARY
+            Content-Disposition: form-data; name="json"
+            Content-Type: application/json
+
+            {"test": 42}
+
+            --CUSTOM-BOUNDARY--
+
++ Response 200 (multipart/form-data; boundary=CUSTOM-BOUNDARY)
+
+    + Body
+
+            --CUSTOM-BOUNDARY
+            Content-Disposition: form-data; name="text"
+            Content-Type: text/plain
+
+            test equals to 42
+            --CUSTOM-BOUNDARY
+            Content-Disposition: form-data; name="json"
+            Content-Type: application/json
+
+            {"test": 42}
+
+            --CUSTOM-BOUNDARY--

test/fixtures/index.js

@@ -136,6 +136,10 @@ const fixtures = {
     apiBlueprint: fromFile('./api-blueprint/no-schema.apib'),
     swagger: fromFile('./swagger/no-schema.yml')
   }),
+  multipartFormData: fixture({
+    apiBlueprint: fromFile('./api-blueprint/multipart-form-data.apib'),
+    swagger: fromFile('./swagger/multipart-form-data.yml')
+  }),
 
   // Specific to API Blueprint
   unrecognizable: fixture({

test/fixtures/swagger/multipart-form-data.yml

@@ -0,0 +1,39 @@
+swagger: '2.0'
+info:
+  title: "Sanbox 'multipart/form-data' API"
+  version: '1.0'
+consumes:
+  - multipart/form-data; boundary=CUSTOM-BOUNDARY
+produces:
+  - multipart/form-data; boundary=CUSTOM-BOUNDARY
+paths:
+  '/data':
+    post:
+      parameters:
+        - name: text
+          in: formData
+          type: string
+          required: true
+          x-example: "test equals to 42"
+        - name: json
+          in: formData
+          type: string
+          required: true
+          x-example: '{"test": 42}'
+      responses:
+        200:
+          description: 'Test'
+          examples:
+            multipart/form-data; boundary=CUSTOM-BOUNDARY: |
+              --CUSTOM-BOUNDARY
+              Content-Disposition: form-data; name="text"
+              Content-Type: text/plain
+
+              test equals to 42
+              --CUSTOM-BOUNDARY
+              Content-Disposition: form-data; name="json"
+              Content-Type: application/json
+
+              {"test": 42}
+
+              --CUSTOM-BOUNDARY--

test/integration/compile-test.js

@@ -641,4 +641,60 @@ describe('compile() · all API description formats', () => {
       );
     })
   );
+
+  describe('with \'multipart/form-data\' message bodies', () => {
+    fixtures.multipartFormData.forEachDescribe(({ source, format }) => {
+      let compilationResult;
+      const expectedBody = [
+        '--CUSTOM-BOUNDARY',
+        'Content-Disposition: form-data; name="text"',
+        'Content-Type: text/plain',
+        '',
+        'test equals to 42',
+        '--CUSTOM-BOUNDARY',
+        'Content-Disposition: form-data; name="json"',
+        'Content-Type: application/json',
+        '',
+        '{"test": 42}',
+        '',
+        '--CUSTOM-BOUNDARY--',
+        ''
+      ].join('\r\n');
+
+      before(done =>
+        compileFixture(source, (...args) => {
+          compilationResult = args[1];
+          done(args[0]);
+        })
+      );
+
+      it('produces no annotations and 1 transaction', () =>
+        assert.jsonSchema(compilationResult, createCompilationResultSchema({
+          annotations: 0,
+          transactions: 1
+        }))
+      );
+
+      context('the transaction', () => {
+        it('has the expected request body', () => {
+          // Remove the lines with Content-Type headers as Swagger doesn't
+          // support generating them for 'multipart/form-data' request bodies
+          const expectedRequestBody = format === 'Swagger'
+            ? expectedBody.split('\r\n').filter(line => !line.match(/Content-Type/)).join('\r\n')
+            : expectedBody;
+
+          assert.deepEqual(
+            compilationResult.transactions[0].request.body,
+            expectedRequestBody
+          );
+        });
+        it('has the expected response body', () =>
+          assert.deepEqual(
+            compilationResult.transactions[0].response.body,
+            expectedBody
+          )
+        );
+      });
+    });
+  });
 });