Break eager cycle for "deprecate" function #20714
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There is a module cycle involving `@ember/debug/index` and `@ember/debug/lib/deprecate`, and it's somewhat intentional since both are sharing mutable state with the other that's intended to allow users to replace the implementations. The cycle wouldn't be a big deal except for the fact that index **eagerly** consumes the `deprecate` function from `lib/deprecate`, which means that if you get unlucky in the evaluation order it just explodes. There's no need to eagerly consume it. This PR makes the consumption lazy. In general `export function` is resilient to cycles in a way that `export let` is not. There are a bunch more places in `@ember/debug` that are using `export let` when they should probably be using `export function` instead, especially because these function are supposed to *always* be present (even in prod they are no-ops, not missing).
simonihmig
approved these changes
Jul 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is a module cycle involving
@ember/debug/indexand@ember/debug/lib/deprecate, and it's somewhat intentional since both are sharing mutable state with the other that's intended to allow users to replace the implementations.The cycle wouldn't be a big deal except for the fact that index eagerly consumes the
deprecatefunction fromlib/deprecate, which means that if you get unlucky in the evaluation order it just explodes.There's no need to eagerly consume it. This PR makes the consumption lazy.
In general
export functionis resilient to cycles in a way thatexport letis not. There are a bunch more places in@ember/debugthat are usingexport letwhen they should probably be usingexport functioninstead, especially because these function are supposed to always be present (even in prod they are no-ops, not missing).(All of this is only noticeable when running with real ES modules under embroider. The classic build happens to have a reliable ordering that doesn't break.)