fix(oas3): prevent throwing during freeze for required annotations

Related to apiaryio/dredd#1762
apiaryio · Jun 23, 2020 · 6824791 · 6824791
1 parent 47223e4
commit 6824791
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/packages/openapi3-parser/lib/parser/parseObject.js b/packages/openapi3-parser/lib/parser/parseObject.js
@@ -41,7 +41,7 @@ const hasMember = R.curry((object, key) => {
 const validateObjectContainsRequiredKeys = R.curry((namespace, path, requiredKeys, sendWarning, object) => {
   const missingKeys = R.reject(hasMember(object), requiredKeys);
   const createAnnotation = sendWarning ? createWarning : createError;
-  const annotationFromKey = key => createAnnotation(namespace, `'${path}' is missing required property '${key}'`, object);
+  const annotationFromKey = key => createAnnotation(namespace, `'${path}' is missing required property '${key}'`, object.clone());
 
   if (missingKeys.length > 0) {
     return new namespace.elements.ParseResult(

diff --git a/packages/openapi3-parser/test/unit/parser/parseObject-test.js b/packages/openapi3-parser/test/unit/parser/parseObject-test.js
@@ -18,6 +18,9 @@ describe('#parseObject', () => {
       name: 'Doe',
       message: 'Hello',
     });
+    object.attributes.set('sourceMap', [
+      new namespace.elements.SourceMap([[0, 10]]),
+    ]);
   });
 
   it('provides warning when given element is non-object', () => {
@@ -141,6 +144,13 @@ describe('#parseObject', () => {
         "'Example Object' is missing required property 'required1'",
         "'Example Object' is missing required property 'required2'",
       ]);
+
+      // assert errors can be frozen (we're testing that the source map
+      // for object was cloned instead of referenced)
+      parseResult.freeze();
+
+      expect(parseResult.errors.get(0)).to.have.sourceMap([[0, 10]]);
+      expect(parseResult.errors.get(1)).to.have.sourceMap([[0, 10]]);
     });
 
     it('fails object parsing when member parse cannot parse required key', () => {