Skip to content

fix: issue with node path keys updated on unrelated paths#16814

Merged
nicolo-ribaudo merged 1 commit intobabel:mainfrom
DylanPiercey:fix-node-path-keys
Sep 8, 2024
Merged

fix: issue with node path keys updated on unrelated paths#16814
nicolo-ribaudo merged 1 commit intobabel:mainfrom
DylanPiercey:fix-node-path-keys

Conversation

@DylanPiercey
Copy link
Contributor

@DylanPiercey DylanPiercey commented Sep 6, 2024 •
edited
Loading

Q                       A
Fixed Issues?
Patch: Bug Fix? 👍
Major: Breaking Change?
Minor: New Feature?
Tests Added + Pass? 👍
Documentation PR Link
Any Dependency Changes?
License MIT

Fixes a bug where unrelated NodePath.key properties were being incremented / decremented when the ast was mutated through the NodePath apis (eg pushContainer). This caused other apis that relied on NodePath.key to break (in my case getNextSibling and getPrevSibling).

The bug is that updateSiblingKeys was unconditionally updating any "sibling" that had a number key property without first checking that it's actually in the same container / list as the current NodePath.

This means that mutating any node via the NodePath apis where the original AST node has more than one directly nested array of data (eg template literal in the example test) would incorrectly update the key property.

The test I added shows that mutating the expressions of a TemplateLiteral causes it's quasis to also be impacted and returns the incorrect next sibling.

Here's also an AST Explorer gist that shows the incorrect behavior with more logs https://astexplorer.net/#/gist/a99fad01e220f92a602900f0702a25a6/8f741050ed43f4e1091748e6e354642c3b7e64d5

@babel-bot
Copy link
Collaborator

babel-bot commented Sep 6, 2024 •
edited
Loading

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/57875

JLHwung
JLHwung approved these changes Sep 6, 2024
View reviewed changes
Copy link
Contributor

@JLHwung JLHwung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@JLHwung JLHwung added PR: Bug Fix 🐛 A type of pull request used for our changelog categories pkg: traverse labels Sep 6, 2024
liuxingbaoyu
liuxingbaoyu approved these changes Sep 7, 2024
View reviewed changes
Copy link
Member

@liuxingbaoyu liuxingbaoyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

@nicolo-ribaudo nicolo-ribaudo merged commit e69a7e5 into babel:main Sep 8, 2024
@DylanPiercey
Copy link
Contributor Author

DylanPiercey commented Sep 8, 2024

Thanks all for getting this in so quickly!

zemnmez-renovate-bot added a commit to zemn-me/monorepo that referenced this pull request Oct 2, 2024
@zemnmez-renovate-bot
chore(deps): update dependency @babel/preset-typescript to v7.25.7
afe1ed4 
##### [`v7.25.7](https://github.com/babel/babel/blob/HEAD/CHANGELOG.md#v7257-2024-10-02)

##### 🐛 Bug Fix

-   `babel-helper-validator-identifier`
    -   [#16825](babel/babel#16825) fix: update identifier to unicode 16 ([@JLHwung](https://github.com/JLHwung))
-   `babel-traverse`
    -   [#16814](babel/babel#16814) fix: issue with node path keys updated on unrelated paths ([@DylanPiercey](https://github.com/DylanPiercey))
-   `babel-plugin-transform-classes`
    -   [#16797](babel/babel#16797) Use an inclusion rather than exclusion list for `super()` check ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
-   `babel-generator`
    -   [#16788](babel/babel#16788) Fix printing of TS `infer` in compact mode ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
    -   [#16785](babel/babel#16785) Print TS type annotations for destructuring in assignment pattern ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
    -   [#16778](babel/babel#16778) Respect `[no LineTerminator here]` after nodes ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))

##### 💅 Polish

-   `babel-types`
    -   [#16852](babel/babel#16852) Add deprecated JSDOC for fields ([@liuxingbaoyu](https://github.com/liuxingbaoyu))

##### 🏠 Internal

-   `babel-core`
    -   [#16820](babel/babel#16820) Allow sync loading of ESM when `--experimental-require-module` ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
-   `babel-helper-compilation-targets`, `babel-helper-plugin-utils`, `babel-preset-env`
    -   [#16858](babel/babel#16858) Add browserslist config to external dependency ([@JLHwung](https://github.com/JLHwung))
-   `babel-plugin-proposal-destructuring-private`, `babel-plugin-syntax-decimal`, `babel-plugin-syntax-import-reflection`, `babel-standalone`
    -   [#16809](babel/babel#16809) Archive syntax-import-reflection and syntax-decimal ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
-   `babel-generator`
    -   [#16779](babel/babel#16779) Simplify logic for `[no LineTerminator here]` before nodes ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))

##### 🏃‍♀️ Performance

-   `babel-plugin-transform-typescript`
    -   [#16875](babel/babel#16875) perf: Avoid extra cloning of namespaces ([@liuxingbaoyu](https://github.com/liuxingbaoyu))
-   `babel-types`
    -   [#16842](babel/babel#16842) perf: Improve [@babel/types](https://github.com/babel/types) builders ([@liuxingbaoyu](https://github.com/liuxingbaoyu))
    -   [#16828](babel/babel#16828) Only access `BABEL_TYPES_8_BREAKING` at startup ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
github-merge-queue bot pushed a commit to zemn-me/monorepo that referenced this pull request Oct 2, 2024
@zemnmez-renovate-bot
chore(deps): update dependency @babel/preset-typescript to v7.25.7
289dbb1 
##### [`v7.25.7](https://github.com/babel/babel/blob/HEAD/CHANGELOG.md#v7257-2024-10-02)

##### 🐛 Bug Fix

-   `babel-helper-validator-identifier`
    -   [#16825](babel/babel#16825) fix: update identifier to unicode 16 ([@JLHwung](https://github.com/JLHwung))
-   `babel-traverse`
    -   [#16814](babel/babel#16814) fix: issue with node path keys updated on unrelated paths ([@DylanPiercey](https://github.com/DylanPiercey))
-   `babel-plugin-transform-classes`
    -   [#16797](babel/babel#16797) Use an inclusion rather than exclusion list for `super()` check ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
-   `babel-generator`
    -   [#16788](babel/babel#16788) Fix printing of TS `infer` in compact mode ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
    -   [#16785](babel/babel#16785) Print TS type annotations for destructuring in assignment pattern ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
    -   [#16778](babel/babel#16778) Respect `[no LineTerminator here]` after nodes ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))

##### 💅 Polish

-   `babel-types`
    -   [#16852](babel/babel#16852) Add deprecated JSDOC for fields ([@liuxingbaoyu](https://github.com/liuxingbaoyu))

##### 🏠 Internal

-   `babel-core`
    -   [#16820](babel/babel#16820) Allow sync loading of ESM when `--experimental-require-module` ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
-   `babel-helper-compilation-targets`, `babel-helper-plugin-utils`, `babel-preset-env`
    -   [#16858](babel/babel#16858) Add browserslist config to external dependency ([@JLHwung](https://github.com/JLHwung))
-   `babel-plugin-proposal-destructuring-private`, `babel-plugin-syntax-decimal`, `babel-plugin-syntax-import-reflection`, `babel-standalone`
    -   [#16809](babel/babel#16809) Archive syntax-import-reflection and syntax-decimal ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
-   `babel-generator`
    -   [#16779](babel/babel#16779) Simplify logic for `[no LineTerminator here]` before nodes ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))

##### 🏃‍♀️ Performance

-   `babel-plugin-transform-typescript`
    -   [#16875](babel/babel#16875) perf: Avoid extra cloning of namespaces ([@liuxingbaoyu](https://github.com/liuxingbaoyu))
-   `babel-types`
    -   [#16842](babel/babel#16842) perf: Improve [@babel/types](https://github.com/babel/types) builders ([@liuxingbaoyu](https://github.com/liuxingbaoyu))
    -   [#16828](babel/babel#16828) Only access `BABEL_TYPES_8_BREAKING` at startup ([@nicolo-ribaudo](https://github.com/nicolo-ribaudo))
@davidjbradshaw davidjbradshaw mentioned this pull request Oct 6, 2024
Closed
@NOUIY NOUIY mentioned this pull request Oct 23, 2024
Open
This was referenced Oct 24, 2024
Open
Open
@trabab trabab mentioned this pull request Oct 24, 2024
Open
This was referenced Oct 24, 2024
Open
Open
Open
Open
Open
This was referenced Oct 24, 2024
Open
Open
Open
This was referenced Oct 25, 2024
Open
Open
Open
@gkarat gkarat mentioned this pull request Oct 25, 2024
Merged
@YoYBaBy YoYBaBy mentioned this pull request Oct 25, 2024
Open
@tiff-es tiff-es mentioned this pull request Nov 10, 2024
Open
This was referenced Nov 10, 2024
Open
Open
Open
Open
Open
Open
This was referenced Nov 11, 2024
Open
Open
Open
Open
This was referenced Nov 11, 2024
Open
Open
This was referenced Nov 12, 2024
Open
Open
This was referenced Nov 12, 2024
Open
Open
Open
Open
Open
Open
@DevangPatelUK DevangPatelUK mentioned this pull request Nov 12, 2024
Open
This was referenced Nov 12, 2024
Open
Open
@ali8889 ali8889 mentioned this pull request Nov 13, 2024
Open
@sebastianthulin sebastianthulin mentioned this pull request Nov 13, 2024
Merged
@maismas maismas mentioned this pull request Nov 13, 2024
Merged
@NOUIY NOUIY mentioned this pull request Nov 13, 2024
Open
@github-actions github-actions bot added the outdated A closed issue/PR that is archived due to age. Recommended to make a new issue label Dec 9, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@JLHwung JLHwung JLHwung approved these changes

@liuxingbaoyu liuxingbaoyu liuxingbaoyu approved these changes

Assignees

No one assigned

Labels

outdated A closed issue/PR that is archived due to age. Recommended to make a new issue pkg: traverse PR: Bug Fix 🐛 A type of pull request used for our changelog categories

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@DylanPiercey @babel-bot @JLHwung @liuxingbaoyu @nicolo-ribaudo