Replace require with import in MarkdownEditor's FormattingTools component
#2334
Conversation
This file contains hidden or 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
This comment was marked as outdated.
This comment was marked as outdated.
Contributor
size-limit report 📦
|
iansan5653
commented
Sep 14, 2022
| // To prevent double-registering while the promise is pending, set it before importing | ||
| hasRegisteredToolbarElement = true | ||
| // requiring this module will register the custom element; we don't want to do that until the component mounts in the DOM | ||
| await import('@github/markdown-toolbar-element') |
Contributor
Author
There was a problem hiding this comment.
I considered wrapping this import() call in a try and setting hasRegisteredToolbarElement = false on failure. But I don't think it's really beneficial to keep retrying if this fails -- this isn't an API request that might eventually succeed.
iansan5653
force-pushed
the
formatting-tools-import
branch
2 times, most recently
from
e6d99a4 to
48d31e7
Compare
Contributor
Author
|
The Jest unit tests are failing with a segmentation fault, most likely due to nodejs/node#35889. This is a known bug in the V8 engine with no workaround so this strategy is sadly a no-go. |
4 tasks
6 tasks
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.
The
FormattingToolscomponent (owned byMarkdownEditor) depends on themarkdown-toolbar-element. This library performs DOM-based side-effects on render, so it cannot be imported at the top level of the file - it must be imported in an effect.I originally tried to use
import()inside auseEffectfor this but ran into problems so I usedrequire()instead. Now, we've started running into problems with the mix ofrequireandimportin a file and I'd like to revisit trying to useimport.It seems to be working fine so far - Storybook, Gatsby docs, and tests all build alright. I think that the issue I was running into before was likely not due to the use of
importbut rather that I had forgotten toawaittheimportbecause I didn't realize that it was aynchronous. If that is the case, then it should be fine to switch the strategy and I think it will solve a lot of complications.