Fix infinite recursive loop on UMD module init #505
Merged
+124
−35
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
darcythomas
reviewed
Sep 10, 2023
darcythomas
reviewed
Sep 10, 2023
xenolightning
suggested changes
Sep 11, 2023
xenolightning
previously approved these changes
Sep 12, 2023
Hamish-taylor
force-pushed
the
ht/fix-recursive-loop-on-umd-init
branch
from
78183bc
to
143d78e
Compare
xenolightning
approved these changes
Sep 12, 2023
|
Both Darcy and Sean have looked into this and ran unit tests. @Hamish-taylor , do at least the following before releasing: (1) presoaking a prerelease to our website (at least a day ) and (2) also try to deploy a test website that would have triggered the error to test it's ok. Then, first release on npm and nuget; wait for a couple of days and then release on CDN. Keep CS informed on each step @CmdrKeen FYI |
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.
This PR is to solve an issue first surfaced in issue #473.
The problem
We are assuming rg4js is loaded when
document.readyStateis marked ascomplete. However, this is not true, it's not loaded until after theloadevent has been triggered. According to the speccompleteindicates that theloadevent is about to fire. This leaves a small gap where if our code is executed between the document state being marked as complete and theloadevent firing, an infinite recursive loop is started that will hang the application.The fix
The current fix I have in mind for this is to add a variable to the window that is set to true after we know for sure rg4js is initialized. The UMD initialization code will then wait for this rather than
document.readyState === 'complete'