Skip to content

Commit

Permalink
fix(core): always perform immutable async traversal (#3164)
Browse files Browse the repository at this point in the history 
Part of this PR addresses alignment with dereference strategies
and new immutable traversal.

Refs #3110
  • Loading branch information
@char0n
char0n committed Sep 29, 2023
1 parent 90e522d commit a47f870
Show file tree
Hide file tree
Showing 10 changed files with 399 additions and 229 deletions.
5 changes: 4 additions & 1 deletion packages/apidom-ast/src/traversal/visitor.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,7 @@ export const visit = (
if (!nodePredicate(node)) {
throw new ApiDOMError(`Invalid AST Node: ${JSON.stringify(node)}`);
}

// cycle detected; skipping over a sub-tree to avoid recursion
if (detectCycles && ancestors.includes(node)) {
path.pop();
Expand Down Expand Up @@ -342,7 +343,7 @@ export const visit = (
} while (stack !== undefined);

if (edits.length !== 0) {
[, newRoot] = edits[edits.length - 1];
[, newRoot] = edits.at(-1);
}

return newRoot;
Expand Down Expand Up @@ -441,11 +442,13 @@ visit[Symbol.for('nodejs.util.promisify.custom')] = async (
if (!nodePredicate(node)) {
throw new ApiDOMError(`Invalid AST Node: ${JSON.stringify(node)}`);
}

// cycle detected; skipping over a sub-tree to avoid recursion
if (detectCycles && ancestors.includes(node)) {
path.pop();
continue;
}

const visitFn = visitFnGetter(visitor, nodeTypeGetter(node), isLeaving);
if (visitFn) {
// assign state
Expand Down
1 change: 1 addition & 0 deletions packages/apidom-core/src/traversal/visitor.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ visit[Symbol.for('nodejs.util.promisify.custom')] = async (
// @ts-ignore
nodeTypeGetter: getNodeType,
nodePredicate: isNode,
nodeCloneFn: cloneNode,
...rest,
});
};
132 changes: 72 additions & 60 deletions packages/apidom-reference/src/dereference/strategies/asyncapi-2/visitor.ts
View file
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
import stampit from 'stampit';
import { propEq } from 'ramda';
import {
cloneDeep,
cloneShallow,
Element,
isElement,
isMemberElement,
isPrimitiveElement,
isStringElement,
visit,
Element,
isElement,
cloneShallow,
cloneDeep,
} from '@swagger-api/apidom-core';
import { evaluate, uriToPointer } from '@swagger-api/apidom-json-pointer';
import {
ChannelItemElement,
getNodeType,
isChannelItemElementExternal,
isReferenceElementExternal,
isReferenceLikeElement,
keyMap,
ReferenceElement,
ChannelItemElement,
SchemaElement,
isReferenceElementExternal,
isChannelItemElementExternal,
} from '@swagger-api/apidom-ns-asyncapi-2';

import { Reference as IReference } from '../../../types';
import { MaximumDereferenceDepthError, MaximumResolverDepthError } from '../../../util/errors';
import { AncestorLineage } from '../../util';
import * as url from '../../../util/url';
import parse from '../../../parse';
import Reference from '../../../Reference';
Expand All @@ -38,12 +39,12 @@ const AsyncApi2DereferenceVisitor = stampit({
options: null,
ancestors: null,
},
init({ indirections = [], reference, namespace, options, ancestors = [] }) {
init({ indirections = [], reference, namespace, options, ancestors = new AncestorLineage() }) {
this.indirections = indirections;
this.namespace = namespace;
this.reference = reference;
this.options = options;
this.ancestors = [...ancestors];
this.ancestors = new AncestorLineage(...ancestors);
},
methods: {
toAncestorLineage(ancestors) {
Expand All @@ -52,7 +53,7 @@ const AsyncApi2DereferenceVisitor = stampit({
* Ancestors are flatten to unwrap all Element instances.
*/
const directAncestors = new WeakSet(ancestors.filter(isElement));
const ancestorsLineage = [...this.ancestors, directAncestors];
const ancestorsLineage = new AncestorLineage(...this.ancestors, directAncestors);

return [ancestorsLineage, directAncestors];
},
Expand Down Expand Up @@ -101,8 +102,7 @@ const AsyncApi2DereferenceVisitor = stampit({
const [ancestorsLineage, directAncestors] = this.toAncestorLineage([...ancestors, parent]);

// detect possible cycle in traversal and avoid it
if (ancestorsLineage.some((ancs: WeakSet<Element>) => ancs.has(referencingElement))) {
// skip processing this schema and all it's child schemas
if (ancestorsLineage.includesCycle(referencingElement)) {
return false;
}

Expand Down Expand Up @@ -171,17 +171,32 @@ const AsyncApi2DereferenceVisitor = stampit({

this.indirections.pop();

referencedElement = cloneShallow(referencedElement);
const mergeAndAnnotateReferencedElement = <T extends Element>(refedElement: T): T => {
const copy = cloneShallow(refedElement);

// annotate referenced element with info about original referencing element
copy.setMetaProperty('ref-fields', {
$ref: referencingElement.$ref?.toValue(),
});
// annotate fragment with info about origin
copy.setMetaProperty('ref-origin', reference.uri);

return copy;
};

// attempting to create cycle
if (ancestorsLineage.includes(referencedElement)) {
if (isMemberElement(parent)) {
parent.value = mergeAndAnnotateReferencedElement(referencedElement); // eslint-disable-line no-param-reassign
} else if (Array.isArray(parent)) {
parent[key] = mergeAndAnnotateReferencedElement(referencedElement); // eslint-disable-line no-param-reassign
}

// annotate referenced element with info about original referencing element
referencedElement.setMetaProperty('ref-fields', {
$ref: referencingElement.$ref?.toValue(),
});
// annotate fragment with info about origin
referencedElement.setMetaProperty('ref-origin', reference.uri);
return false;
}

// transclude referencing element with merged referenced element
return referencedElement;
return mergeAndAnnotateReferencedElement(referencedElement);
},

async ChannelItemElement(
Expand All @@ -199,8 +214,7 @@ const AsyncApi2DereferenceVisitor = stampit({
}

// detect possible cycle in traversal and avoid it
if (ancestorsLineage.some((ancs: WeakSet<Element>) => ancs.has(referencingElement))) {
// skip processing this schema and all it's child schemas
if (ancestorsLineage.includesCycle(referencingElement)) {
return false;
}

Expand Down Expand Up @@ -258,47 +272,45 @@ const AsyncApi2DereferenceVisitor = stampit({

this.indirections.pop();

// merge fields from referenced Channel Item with referencing one
const mergedResult = new ChannelItemElement(
// @ts-ignore
[...referencedElement.content],
cloneDeep(referencedElement.meta),
cloneDeep(referencedElement.attributes),
);
// existing keywords from referencing ChannelItemElement overrides ones from referenced ChannelItemElement
referencingElement.forEach((value: Element, keyElement: Element, item: Element) => {
mergedResult.remove(keyElement.toValue());
mergedResult.content.push(item);
});
mergedResult.remove('$ref');

// annotate referenced element with info about original referencing element
mergedResult.setMetaProperty('ref-fields', {
$ref: referencingElement.$ref?.toValue(),
});
// annotate referenced with info about origin
mergedResult.setMetaProperty('ref-origin', reference.uri);

// transclude referencing element with merged referenced element
return mergedResult;
},

async SchemaElement(
referencingElement: SchemaElement,
key: any,
parent: any,
path: any,
ancestors: any[],
) {
const [ancestorsLineage] = this.toAncestorLineage([...ancestors, parent]);
const mergeAndAnnotateReferencedElement = <T extends Element>(
refedElement: T,
): ChannelItemElement => {
// merge fields from referenced Channel Item with referencing one
const mergedElement = new ChannelItemElement(
[...refedElement.content] as any,
cloneDeep(refedElement.meta),
cloneDeep(refedElement.attributes),
);
// existing keywords from referencing ChannelItemElement overrides ones from referenced ChannelItemElement
referencingElement.forEach((value: Element, keyElement: Element, item: Element) => {
mergedElement.remove(keyElement.toValue());
mergedElement.content.push(item);
});
mergedElement.remove('$ref');

// annotate referenced element with info about original referencing element
mergedElement.setMetaProperty('ref-fields', {
$ref: referencingElement.$ref?.toValue(),
});
// annotate referenced with info about origin
mergedElement.setMetaProperty('ref-origin', reference.uri);

return mergedElement;
};

// attempting to create cycle
if (ancestorsLineage.includes(referencedElement)) {
if (isMemberElement(parent)) {
parent.value = mergeAndAnnotateReferencedElement(referencedElement); // eslint-disable-line no-param-reassign
} else if (Array.isArray(parent)) {
parent[key] = mergeAndAnnotateReferencedElement(referencedElement); // eslint-disable-line no-param-reassign
}

// detect possible cycle in traversal and avoid it
if (ancestorsLineage.some((ancs: WeakSet<Element>) => ancs.has(referencingElement))) {
// skip processing this schema and all it's child schemas
return false;
}

return undefined;
// transclude referencing element with merged referenced element
return mergeAndAnnotateReferencedElement(referencedElement);
},
},
});
Expand Down

0 comments on commit a47f870

Please sign in to comment.