build: Support custom mobile Demo editor setup configuration #54957
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
Applying optional setup configuration files allows developers to modify the Demo editor environment via Hooks, e.g. to set custom `initialHtml` for the editor.
dcalhoun
added
[Type] Build Tooling
|
Size Change: +22.5 kB (+1%) Total Size: 1.65 MB
ℹ️ View Unchanged
|
The `require.context` function is undefined in the test environment, as it is a Metro-specific capability. The most straightforward way to avoid test failures is to disable this code that relates to the local development workflow.
fluiddot
approved these changes
Oct 5, 2023
There was a problem hiding this comment.
LGTM 🎊 ! Thanks @dcalhoun for investigating a workaround for the optional require, and introducing this feature 🏅 !
Apart from running the testing instructions, I also checked that modifications to the setup-local.js file are applied live when running the Metro server 🎊.
| @@ -27,6 +27,7 @@ module.exports = { | |||
| inlineRequires: false, | |||
| }, | |||
| } ), | |||
| unstable_allowRequireContext: true, // Used for optional setup configuration. | |||
There was a problem hiding this comment.
We'd need to keep an eye on this unstable parameter when upgrading Metro (probably in the next React Native upgrade effort), in case it produces a failure in loading the local setup.
Contributors will likely never discover or benefit from this customization ability if it is not documented.
dcalhoun
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
Flaky tests detected in 92725d2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6421741322
|
dcalhoun
deleted the
build/support-mobile-demo-editor-setup-configuration
branch
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.
What?
Support custom mobile Demo editor setup configuration.
Why?
Applying optional setup configuration files allows developers to modify
the Demo editor environment via Hooks, e.g. to set custom
initialHtmlfor the editor.
How?
Rely upon the experimental
unstable_allowRequireContextMetro configuration toenable searching for the optional
setup-local.jsconfiguration file viarequire.context.This approach is a workaround as loading the optional configuration file fails
when using
allowOptionalDependencies, as outlined in facebook/metro#666 (comment).Testing Instructions
Without custom configuration
npm run native start:reset.npm run native iosornpm run native android.initial-htmlconfiguration, displaying the expected blocks.
With custom configuration
Example setup configuration
packages/react-native-editor/src/setup-local.jsnpm run native start:reset.npm run native iosornpm run native android.the blocks within the custom configuration.
Testing Instructions for Keyboard
n/a
Screenshots or screencast
n/a