Skip to content

Fix incorrect function hoisting in some case statements#16363

Merged
nicolo-ribaudo merged 1 commit intobabel:mainfrom
luiscubal:fix-14960-case-hoisting
Mar 27, 2024
Merged

Fix incorrect function hoisting in some case statements#16363
nicolo-ribaudo merged 1 commit intobabel:mainfrom
luiscubal:fix-14960-case-hoisting

Conversation

@luiscubal
Copy link
Contributor

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

The linked issue #14960 shows a case where babel breaks the behavior of a code snippet:

switch ('what') {
default:
    console.log(a())
    function a() { return 1; }
}

The issue is that function a() {} gets converted into var a = function() {}, but isn't hoisted to the top as it should. Babel currently hoists functions correctly when they are in block statements, but not in case statements.
Fixing this problem in all cases is difficult, due to the issue pointed to in an answer to that ticket:

switch (x) {
  case 0:
    let num = 3;
    log(0);
  default:
    log(1);
    function log(s) { console.log(s || num) }
}

In the example above, moving log to the first case breaks the second, but keeping the log in the second case does not address the first.

Nevertheless, the current behavior is a problem. This Pull Request addresses this by hoisting the function to the start of the matching case. This does not address all issues, but it shouldn't break anything that isn't already broken, and it should fix issues as the function is "more hoisted" than it used to be. Notably, this fixes issues with functions that are only ever referenced in the same case that declares them, which is the case I encountered.

@babel-bot
Copy link
Collaborator

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

@luiscubal
Copy link
Contributor Author

jest failed, but I believe it has since been fixed by this: jestjs/jest#14976

@nicolo-ribaudo
Copy link
Member

Yes 👍

Copy link
Member

@nicolo-ribaudo nicolo-ribaudo left a comment

Choose a reason for hiding this comment

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

This is still wrong but until when we have a better solution (that I'm not even convinced is possible to have) it's better than the current behavior.

@nicolo-ribaudo nicolo-ribaudo added the PR: Bug Fix 🐛 A type of pull request used for our changelog categories label Mar 20, 2024
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.

I'm not sure if changing babel-plugin-transform-block-scoped-functions would be better.

@luiscubal
Copy link
Contributor Author

I'm not sure if changing babel-plugin-transform-block-scoped-functions would be better.

It could be done there too, but it would mean moving the logic of hoisting there.
Moving it there seems doable, but it would mean the equivalent bug (if there is one) for "Annex B.3.3" code would not be fixed or would need a duplicated fix.

@nicolo-ribaudo nicolo-ribaudo merged commit b8eb831 into babel:main Mar 27, 2024
@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 Jun 27, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 27, 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.

5 participants