Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(ast): fix visitor merging on mutable node replacements #4124

Merged
merged 2 commits into from
May 21, 2024
Merged

fix(ast): fix visitor merging on mutable node replacements #4124

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a47c709
fix(ast): fix visitor merging on mutable node replacements
char0n May 20, 2024
cc13869
Merge branch 'main' into char0n/4120-fix
char0n May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 91 additions & 17 deletions packages/apidom-ast/src/traversal/visitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export const cloneNode = (node: any) =>
* parallel. Each visitor will be visited for each node before moving on.
*
* If a prior visitor edits a node, no following visitors will see that node.
* `exposeEdits=true` can be used to exoise the edited node from the previous visitors.
* `exposeEdits=true` can be used to expose the edited node from the previous visitors.
*/

export interface MergeAllSync {
Expand Down Expand Up @@ -108,16 +108,32 @@ export const mergeAll: MergeAllSync = ((
const skipping = new Array(visitors.length).fill(skipSymbol);

return {
enter(node: any, ...rest: any[]) {
enter(node: any, key: any, parent: any, path: any, ancestors: any, link: any) {
let currentNode = node;
let hasChanged = false;

const linkProxy = {
...link,
replaceWith(newNode: any, replacer?: any) {
link.replaceWith(newNode, replacer);
currentNode = newNode;
},
};

for (let i = 0; i < visitors.length; i += 1) {
if (skipping[i] === skipSymbol) {
const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), false);

if (typeof visitFn === 'function') {
const result: any = visitFn.call(visitors[i], currentNode, ...rest);
const result: any = visitFn.call(
visitors[i],
currentNode,
key,
parent,
path,
ancestors,
linkProxy,
);

// check if the visitor is async
if (typeof result?.then === 'function') {
Expand All @@ -128,7 +144,7 @@ export const mergeAll: MergeAllSync = ((
}

if (result === skipVisitingNodeSymbol) {
skipping[i] = node;
skipping[i] = currentNode;
} else if (result === breakSymbol) {
skipping[i] = breakSymbol;
} else if (result === deleteNodeSymbol) {
Expand All @@ -147,13 +163,31 @@ export const mergeAll: MergeAllSync = ((

return hasChanged ? currentNode : undefined;
},
leave(node: any, ...rest: any[]) {
leave(node: any, key: any, parent: any, path: any, ancestors: any, link: any) {
let currentNode = node;

const linkProxy = {
...link,
replaceWith(newNode: any, replacer?: any) {
link.replaceWith(newNode, replacer);
currentNode = newNode;
},
};

for (let i = 0; i < visitors.length; i += 1) {
if (skipping[i] === skipSymbol) {
const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(node), true);
const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), true);

if (typeof visitFn === 'function') {
const result = visitFn.call(visitors[i], node, ...rest);
const result = visitFn.call(
visitors[i],
currentNode,
key,
parent,
path,
ancestors,
linkProxy,
);

// check if the visitor is async
if (typeof result?.then === 'function') {
Expand All @@ -169,7 +203,7 @@ export const mergeAll: MergeAllSync = ((
return result;
}
}
} else if (skipping[i] === node) {
} else if (skipping[i] === currentNode) {
skipping[i] = skipSymbol;
}
}
Expand All @@ -194,20 +228,36 @@ const mergeAllAsync: MergeAllAsync = (
const skipping = new Array(visitors.length).fill(skipSymbol);

return {
async enter(node: any, ...rest: any[]) {
async enter(node: any, key: any, parent: any, path: any, ancestors: any, link: any) {
let currentNode = node;
let hasChanged = false;

const linkProxy = {
...link,
replaceWith(newNode: any, replacer?: any) {
link.replaceWith(newNode, replacer);
currentNode = newNode;
},
};

for (let i = 0; i < visitors.length; i += 1) {
if (skipping[i] === skipSymbol) {
const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), false);

if (typeof visitFn === 'function') {
// eslint-disable-next-line no-await-in-loop
const result: any = await visitFn.call(visitors[i], currentNode, ...rest);
const result: any = await visitFn.call(
visitors[i],
currentNode,
key,
parent,
path,
ancestors,
linkProxy,
);

if (result === skipVisitingNodeSymbol) {
skipping[i] = node;
skipping[i] = currentNode;
} else if (result === breakSymbol) {
skipping[i] = breakSymbol;
} else if (result === deleteNodeSymbol) {
Expand All @@ -226,21 +276,39 @@ const mergeAllAsync: MergeAllAsync = (

return hasChanged ? currentNode : undefined;
},
async leave(node: any, ...rest: any[]) {
async leave(node: any, key: any, parent: any, path: any, ancestors: any, link: any) {
let currentNode = node;

const linkProxy = {
...link,
replaceWith(newNode: any, replacer?: any) {
link.replaceWith(newNode, replacer);
currentNode = newNode;
},
};

for (let i = 0; i < visitors.length; i += 1) {
if (skipping[i] === skipSymbol) {
const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(node), true);
const visitFn = visitFnGetter(visitors[i], nodeTypeGetter(currentNode), true);

if (typeof visitFn === 'function') {
// eslint-disable-next-line no-await-in-loop
const result = await visitFn.call(visitors[i], node, ...rest);
const result = await visitFn.call(
visitors[i],
currentNode,
key,
parent,
path,
ancestors,
linkProxy,
);
if (result === breakSymbol) {
skipping[i] = breakSymbol;
} else if (result !== undefined && result !== skipVisitingNodeSymbol) {
return result;
}
}
} else if (skipping[i] === node) {
} else if (skipping[i] === currentNode) {
skipping[i] = skipSymbol;
}
}
Expand Down Expand Up @@ -453,7 +521,10 @@ export const visit = (
} else if (parent) {
parent[key] = newNode;
}
node = newNode;

if (!isLeaving) {
node = newNode;
}
},
};

Expand Down Expand Up @@ -631,7 +702,10 @@ visit[Symbol.for('nodejs.util.promisify.custom')] = async (
} else if (parent) {
parent[key] = newNode;
}
node = newNode;

if (!isLeaving) {
node = newNode;
}
},
};

Expand Down