feat(reference): apply dereferencing architecture 2.0 to AsyncAPI 2.x (#3933)

Refs #3932

Author: char0n

packages/apidom-reference/src/dereference/strategies/apidom/index.ts

@@ -28,66 +28,63 @@ const ApiDOMDereferenceStrategy: stampit.Stamp<IDereferenceStrategy> = stampit(
       },
 
       async dereference(file: IFile, options: IReferenceOptions): Promise<Element> {
-        const refSet = options.dereference.refSet ?? ReferenceSet();
+        const immutableRefSet = options.dereference.refSet ?? ReferenceSet();
+        const mutableRefsSet = ReferenceSet();
+        let refSet = immutableRefSet;
         let reference;
 
         // determine the initial reference
-        if (!refSet.has(file.uri)) {
+        if (!immutableRefSet.has(file.uri)) {
           reference = Reference({ uri: file.uri, value: file.parseResult });
-          refSet.add(reference);
+          immutableRefSet.add(reference);
         } else {
           // pre-computed refSet was provided as configuration option
-          reference = refSet.find((ref) => ref.uri === file.uri);
+          reference = immutableRefSet.find((ref) => ref.uri === file.uri);
         }
 
         /**
          * Clone refSet due the dereferencing process being mutable.
          * We don't want to mutate the original refSet and the references.
          */
         if (options.dereference.immutable) {
-          const immutableRefs = refSet.refs.map((ref) =>
-            Reference({
-              ...ref,
-              uri: `immutable://${ref.uri}`,
-            }),
-          );
-          const mutableRefs = refSet.refs.map((ref) =>
-            Reference({
-              ...ref,
-              value: cloneDeep(ref.value),
-            }),
-          );
-
-          refSet.clean();
-          mutableRefs.forEach((ref) => refSet.add(ref));
-          immutableRefs.forEach((ref) => refSet.add(ref));
-          reference = refSet.find((ref) => ref.uri === file.uri);
+          immutableRefSet.refs
+            .map((ref) =>
+              Reference({
+                ...ref,
+                value: cloneDeep(ref.value),
+              }),
+            )
+            .forEach((ref) => mutableRefsSet.add(ref));
+          reference = mutableRefsSet.find((ref) => ref.uri === file.uri);
+          refSet = mutableRefsSet;
         }
 
         const visitor = ApiDOMDereferenceVisitor({ reference, options });
         const dereferencedElement = await visitAsync(refSet.rootRef.value, visitor);
 
-        if (options.dereference.refSet === null) {
-          /**
-           * Release all memory if this refSet was not provided as a configuration option.
-           * If provided as configuration option, then provider is responsible for cleanup.
-           */
-          refSet.clean();
-        } else if (options.dereference.immutable) {
-          /**
-           * If immutable option is set, then we need to remove mutable refs from the refSet.
-           */
-          const immutableRefs = refSet.refs
+        /**
+         * If immutable option is set, replay refs from the refSet.
+         */
+        if (options.dereference.immutable) {
+          mutableRefsSet.refs
             .filter((ref) => ref.uri.startsWith('immutable://'))
             .map((ref) =>
               Reference({
                 ...ref,
                 uri: ref.uri.replace(/^immutable:\/\//, ''),
               }),
-            );
+            )
+            .forEach((ref) => immutableRefSet.add(ref));
+          reference = immutableRefSet.find((ref) => ref.uri === file.uri);
+          refSet = immutableRefSet;
+        }
 
-          refSet.clean();
-          immutableRefs.forEach((ref) => refSet.add(ref));
+        /**
+         * Release all memory if this refSet was not provided as a configuration option.
+         * If provided as configuration option, then provider is responsible for cleanup.
+         */
+        if (options.dereference.refSet === null) {
+          immutableRefSet.clean();
         }
 
         return dereferencedElement;

packages/apidom-reference/src/dereference/strategies/asyncapi-2/index.ts

@@ -1,6 +1,5 @@
 import stampit from 'stampit';
-import { defaultTo, propEq } from 'ramda';
-import { createNamespace, visit, Element } from '@swagger-api/apidom-core';
+import { createNamespace, visit, Element, cloneDeep } from '@swagger-api/apidom-core';
 import asyncApi2Namespace, {
   getNodeType,
   isAsyncApi2Element,
@@ -40,15 +39,34 @@ const AsyncApi2DereferenceStrategy: stampit.Stamp<IDereferenceStrategy> = stampi
 
       async dereference(file: IFile, options: IReferenceOptions): Promise<Element> {
         const namespace = createNamespace(asyncApi2Namespace);
-        const refSet = defaultTo(ReferenceSet(), options.dereference.refSet);
+        const immutableRefSet = options.dereference.refSet ?? ReferenceSet();
+        const mutableRefsSet = ReferenceSet();
+        let refSet = immutableRefSet;
         let reference;
 
-        if (!refSet.has(file.uri)) {
+        if (!immutableRefSet.has(file.uri)) {
           reference = Reference({ uri: file.uri, value: file.parseResult });
-          refSet.add(reference);
+          immutableRefSet.add(reference);
         } else {
           // pre-computed refSet was provided as configuration option
-          reference = refSet.find(propEq(file.uri, 'uri'));
+          reference = immutableRefSet.find((ref) => ref.uri === file.uri);
+        }
+
+        /**
+         * Clone refSet due the dereferencing process being mutable.
+         * We don't want to mutate the original refSet and the references.
+         */
+        if (options.dereference.immutable) {
+          immutableRefSet.refs
+            .map((ref) =>
+              Reference({
+                ...ref,
+                value: cloneDeep(ref.value),
+              }),
+            )
+            .forEach((ref) => mutableRefsSet.add(ref));
+          reference = mutableRefsSet.find((ref) => ref.uri === file.uri);
+          refSet = mutableRefsSet;
         }
 
         const visitor = AsyncApi2DereferenceVisitor({ reference, namespace, options });
@@ -58,11 +76,28 @@ const AsyncApi2DereferenceStrategy: stampit.Stamp<IDereferenceStrategy> = stampi
         });
 
         /**
-         * Release all memory if this refSet was not provided as an configuration option.
+         * If immutable option is set, replay refs from the refSet.
+         */
+        if (options.dereference.immutable) {
+          mutableRefsSet.refs
+            .filter((ref) => ref.uri.startsWith('immutable://'))
+            .map((ref) =>
+              Reference({
+                ...ref,
+                uri: ref.uri.replace(/^immutable:\/\//, ''),
+              }),
+            )
+            .forEach((ref) => immutableRefSet.add(ref));
+          reference = immutableRefSet.find((ref) => ref.uri === file.uri);
+          refSet = immutableRefSet;
+        }
+
+        /**
+         * Release all memory if this refSet was not provided as a configuration option.
          * If provided as configuration option, then provider is responsible for cleanup.
          */
         if (options.dereference.refSet === null) {
-          refSet.clean();
+          immutableRefSet.clean();
         }
 
         return dereferencedElement;