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.

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

fix: for of with iterableIsArray and shadowing variable #16011

Merged
merged 8 commits into from Dec 5, 2023

Conversation

liuxingbaoyu
Copy link
Member

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

@liuxingbaoyu liuxingbaoyu added the PR: Bug Fix 🐛 A type of pull request used for our changelog categories label Sep 29, 2023
bodyPath.scope.hasOwnBinding(id),
)
Object.keys(path.getBindingIdentifiers())
.concat(Object.keys(path.get("right").getBindingIdentifiers()))
Copy link
Member Author

Choose a reason for hiding this comment

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

Should we fix this in getBindingIdentifiers?

Copy link
Member

Choose a reason for hiding this comment

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

I'm not 100% sure about what's happening here. right does not introduce new bindings, because it cannot contain variable declarations.

Copy link
Member

Choose a reason for hiding this comment

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

I think the fix should be to force memoization in

let array: t.Identifier | t.ThisExpression =
if t.isIdentifier(right) and body.scope.hasOwnBinding(right.name).

@babel-bot
Copy link
Collaborator

babel-bot commented Sep 29, 2023

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

liuxingbaoyu and others added 2 commits October 25, 2023 11:05
Co-authored-by: Nicolò Ribaudo <nicolo.ribaudo@gmail.com>
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.

We probably need skipTransparentExprWrapperNodes for the right-is-identifier check. Otherwise it looks good to me.

An alternative solution is to wrap the original for-of body within a new lexical scope whenever it might shadow the right variable, so we can insert any new declarations directly.

@@ -0,0 +1,3 @@
for (let o of arr) {
arr = null;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this test already passing in the main branch? I will be surprised if the arr binding is constant given then reassignment.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, this is passed in the main branch, I made some bad attempts so adding this test to avoid regressions.

@liuxingbaoyu
Copy link
Member Author

An alternative solution is to wrap the original for-of body within a new lexical scope whenever it might shadow the right variable, so we can insert any new declarations directly.

I initially tried doing this, but I found that this duplicated what maybeGenerateMemoised did, and the behavior now is that the output is a bit smaller when targets==node 4. I will add skipTransparentExprWrapperNodes.

@liuxingbaoyu liuxingbaoyu force-pushed the fix-for-of-array-scoping branch 2 times, most recently from 44c0302 to d333b33 Compare December 4, 2023 04:41
@JLHwung JLHwung merged commit 380d186 into babel:main Dec 5, 2023
48 checks passed
Vylpes pushed a commit to Vylpes/random-bunny that referenced this pull request Jan 16, 2024
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [@babel/traverse](https://babel.dev/docs/en/next/babel-traverse) ([source](https://github.com/babel/babel)) | resolutions | patch | [`7.23.5` -> `7.23.7`](https://renovatebot.com/diffs/npm/@babel%2ftraverse/7.23.5/7.23.7) |

---

### Release Notes

<details>
<summary>babel/babel (@&#8203;babel/traverse)</summary>

### [`v7.23.7`](https://github.com/babel/babel/blob/HEAD/CHANGELOG.md#v7237-2023-12-29)

[Compare Source](babel/babel@v7.23.6...v7.23.7)

##### 🐛 Bug Fix

-   `babel-traverse`
    -   [#&#8203;16191](babel/babel#16191) fix: Crash when removing without `Program` ([@&#8203;liuxingbaoyu](https://github.com/liuxingbaoyu))
-   `babel-helpers`, `babel-plugin-proposal-decorators`
    -   [#&#8203;16180](babel/babel#16180) fix: Class decorator `ctx.kind` is wrong ([@&#8203;liuxingbaoyu](https://github.com/liuxingbaoyu))
-   `babel-plugin-proposal-decorators`
    -   [#&#8203;16170](babel/babel#16170) Fix decorator initProto usage in derived classes ([@&#8203;JLHwung](https://github.com/JLHwung))
-   `babel-core`
    -   [#&#8203;16167](babel/babel#16167) Avoid unpreventable `unhandledRejection` events ([@&#8203;nicolo-ribaudo](https://github.com/nicolo-ribaudo))

##### 🏠 Internal

-   `babel-helper-create-class-features-plugin`
    -   [#&#8203;16186](babel/babel#16186) chore: Update deps ([@&#8203;liuxingbaoyu](https://github.com/liuxingbaoyu))
-   `babel-helper-create-class-features-plugin`, `babel-plugin-proposal-decorators`
    -   [#&#8203;16177](babel/babel#16177) Merge decorators into class features ([@&#8203;JLHwung](https://github.com/JLHwung))

### [`v7.23.6`](https://github.com/babel/babel/blob/HEAD/CHANGELOG.md#v7236-2023-12-11)

[Compare Source](babel/babel@v7.23.5...v7.23.6)

##### 👓 Spec Compliance

-   `babel-generator`, `babel-parser`, `babel-types`
    -   [#&#8203;16154](babel/babel#16154) Remove `TSPropertySignature.initializer` ([@&#8203;fisker](https://github.com/fisker))
-   `babel-helpers`, `babel-plugin-proposal-decorators`, `babel-plugin-transform-class-properties`, `babel-plugin-transform-class-static-block`, `babel-plugin-transform-runtime`, `babel-preset-env`, `babel-runtime-corejs2`, `babel-runtime-corejs3`, `babel-runtime`, `babel-types`
    -   [#&#8203;16139](babel/babel#16139) Apply `toPropertyKey` on decorator context name ([@&#8203;JLHwung](https://github.com/JLHwung))

##### 🐛 Bug Fix

-   `babel-generator`
    -   [#&#8203;16166](babel/babel#16166) fix: Correctly indenting when `retainLines` is enabled ([@&#8203;liuxingbaoyu](https://github.com/liuxingbaoyu))
-   `babel-helpers`, `babel-plugin-proposal-explicit-resource-management`
    -   [#&#8203;16150](babel/babel#16150) `using`: Allow looking up `Symbol.dispose` on a function ([@&#8203;odinho](https://github.com/odinho))
-   `babel-plugin-proposal-decorators`, `babel-plugin-transform-class-properties`
    -   [#&#8203;16161](babel/babel#16161) Ensure the `[[@&#8203;@&#8203;toPrimitive]]` call of a decorated class member key is invoked once ([@&#8203;JLHwung](https://github.com/JLHwung))
    -   [#&#8203;16148](babel/babel#16148) Support named evaluation for decorated anonymous class exp ([@&#8203;JLHwung](https://github.com/JLHwung))
-   `babel-plugin-transform-for-of`, `babel-preset-env`
    -   [#&#8203;16011](babel/babel#16011) fix: `for of` with `iterableIsArray` and shadowing variable  ([@&#8203;liuxingbaoyu](https://github.com/liuxingbaoyu))
-   `babel-helpers`, `babel-plugin-proposal-decorators`, `babel-runtime-corejs2`, `babel-runtime-corejs3`, `babel-runtime`
    -   [#&#8203;16144](babel/babel#16144) Set function name for decorated private non-field elements ([@&#8203;JLHwung](https://github.com/JLHwung))
-   `babel-plugin-transform-typescript`
    -   [#&#8203;16137](babel/babel#16137) Fix references to enum values with merging ([@&#8203;nicolo-ribaudo](https://github.com/nicolo-ribaudo))

##### 🔬 Output optimization

-   `babel-helper-create-class-features-plugin`, `babel-plugin-transform-class-properties`
    -   [#&#8203;16159](babel/babel#16159) Reuse computed key memoiser ([@&#8203;JLHwung](https://github.com/JLHwung))
-   `babel-helpers`, `babel-plugin-proposal-decorators`
    -   [#&#8203;16160](babel/babel#16160) Optimize decorator helper size ([@&#8203;liuxingbaoyu](https://github.com/liuxingbaoyu))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=-->

Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/129
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
@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 Mar 5, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated A closed issue/PR that is archived due to age. Recommended to make a new issue PR: Bug Fix 🐛 A type of pull request used for our changelog categories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: iterableIsArray assumption with shadowing variable generates invalid code
4 participants