refactor: parameterize http message origin of "getBodyType"

Author: artem-zakharchenko

lib/api/test/unit/units/validateBody.test.js

@@ -72,7 +72,7 @@ describe('validateBody', () => {
             it('has explanatory message', () => {
               assert.match(
                 res.results[0].message,
-                /^Real body 'Content-Type' header is 'application\/json' but body is not a parseable JSON:/
+                /^Can't validate: real body 'Content-Type' header is 'application\/json' but body is not a parseable JSON:/
               );
             });
           });
@@ -142,7 +142,7 @@ describe('validateBody', () => {
             it('has explanatory message', () => {
               assert.match(
                 res.results[0].message,
-                /^Real body 'Content-Type' header is 'application\/hal\+json' but body is not a parseable JSON:/
+                /^Can't validate: real body 'Content-Type' header is 'application\/hal\+json' but body is not a parseable JSON:/
               );
             });
           });

lib/api/test/unit/units/validateBody/getBodySchemaType.test.js

@@ -39,7 +39,7 @@ describe('getBodySchemaType', () => {
     it('returns parsing error', () => {
       assert.match(
         res[0],
-        /^Can't validate. Expected body JSON Schema is not a parseable JSON:/
+        /^Can't validate: expected body JSON Schema is not a parseable JSON:/
       );
     });
 

lib/api/test/unit/units/validateBody/getBodyType.test.js

@@ -10,7 +10,7 @@ describe('getBodyType', () => {
     jsonTypes.forEach((jsonType) => {
       describe(`when given "${jsonType}" content type`, () => {
         describe('and parsable json body', () => {
-          const res = getBodyType('{ "foo": "bar" }', jsonType);
+          const res = getBodyType('{ "foo": "bar" }', jsonType, 'real');
 
           it('returns no errors', () => {
             assert.isNull(res[0]);
@@ -22,14 +22,14 @@ describe('getBodyType', () => {
         });
 
         describe('and non-parsable json body', () => {
-          const res = getBodyType('abc', jsonType);
+          const res = getBodyType('abc', jsonType, 'real');
 
           it('returns parsing error', () => {
             assert.match(
               res[0],
               new RegExp(
                 /* eslint-disable no-useless-escape */
-                `^Real body 'Content-Type' header is \'${jsonType.replace(
+                `^Can't validate: real body 'Content-Type' header is \'${jsonType.replace(
                   /(\/|\+)/g,
                   '\\$1'
                 )}\' but body is not a parseable JSON:`
@@ -50,7 +50,7 @@ describe('getBodyType', () => {
     nonJsonTypes.forEach((nonJsonType) => {
       describe(`when given "${nonJsonType}" content type`, () => {
         describe('and parsable json body', () => {
-          const res = getBodyType('{ "foo": "bar" }', nonJsonType);
+          const res = getBodyType('{ "foo": "bar" }', nonJsonType, 'real');
 
           it('returns no errors', () => {
             assert.isNull(res[0]);
@@ -62,7 +62,7 @@ describe('getBodyType', () => {
         });
 
         describe('and a non-json body', () => {
-          const res = getBodyType('abc', nonJsonType);
+          const res = getBodyType('abc', nonJsonType, 'real');
 
           it('returns no errors', () => {
             assert.isNull(res[0]);

lib/api/units/validateBody.js

@@ -62,9 +62,10 @@ function isJsonContentType(contentType) {
  * on the given body and normalized headers.
  * @param {string} body
  * @param {Object} headers
+ * @param {'real'|'expected'} bodyType
  * @returns {[error, bodyType]}
  */
-function getBodyType(body, contentType) {
+function getBodyType(body, contentType, httpMessageOrigin) {
   const hasJsonContentType = isJsonContentType(contentType);
 
   try {
@@ -77,16 +78,9 @@ function getBodyType(body, contentType) {
   } catch (parsingError) {
     const fallbackMediaType = mediaTyper.parse('text/plain');
     const error = hasJsonContentType
-      ? /**
-         * @TODO The same message for real/expected
-         * body assertion. Real/expected must be reflected
-         * in the error message.
-         */
-        `\
-Real body 'Content-Type' header is '${contentType}' \
+      ? `Can't validate: ${httpMessageOrigin} body 'Content-Type' header is '${contentType}' \
 but body is not a parseable JSON:
-${parsingError.message}\
-        `
+${parsingError.message}`
       : null;
 
     return [error, fallbackMediaType];
@@ -110,7 +104,7 @@ function getBodySchemaType(bodySchema) {
     jph.parse(bodySchema);
     return [null, jsonSchemaType];
   } catch (exception) {
-    const error = `Can't validate. Expected body JSON Schema is not a parseable JSON:\n${
+    const error = `Can't validate: expected body JSON Schema is not a parseable JSON:\n${
       exception.message
     }`;
 
@@ -165,13 +159,15 @@ function validateBody(real, expected) {
 
   const [realTypeError, realType] = getBodyType(
     real.body,
-    real.headers && real.headers['content-type']
+    real.headers && real.headers['content-type'],
+    'real'
   );
   const [expectedTypeError, expectedType] = expected.bodySchema
     ? getBodySchemaType(expected.bodySchema)
     : getBodyType(
         expected.body,
-        expected.headers && expected.headers['content-type']
+        expected.headers && expected.headers['content-type'],
+        'expected'
       );
 
   if (realTypeError) {