Introduce ExperimentalBlockEditorProvider #47319
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
adamziel
requested review from
draganescu,
talldan,
tellthemachines,
kevin940726,
getdave,
noisysocks and
ellatrix
as code owners
adamziel
added
[Package] Block editor
adamziel
commented
Jan 20, 2023
packages/editor/src/index.js
Outdated
| import { ExperimentalEditorProvider } from './components/provider'; | ||
| import { lock } from './experiments'; | ||
|
|
||
| export const experiments = {}; |
There was a problem hiding this comment.
This export is in here and not in experiments.js to avoid a circular dependency between experiments.js and ./components/provider/index.ts
There was a problem hiding this comment.
I'd prefer this to be consistent across packages so maybe we should export experiments from index.js in all the other packages too?
Or split experiments.js into experiments.js and lock-unlock.js.
There was a problem hiding this comment.
Agreed, let's make it consistent across packages. That's out of scope here, though – let's do it in a follow up PR
|
Size Change: +894 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
noisysocks
reviewed
Jan 23, 2023
ntsekouras
reviewed
Jan 24, 2023
ntsekouras
force-pushed
the
add/experimental-editor-settings
branch
from
2513840
to
2c0f39a
Compare
|
Flaky tests detected in 9e1fa36. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4016530130
|
|
I added unit tests. There's still a problem with the native tests. |
This was referenced Jan 25, 2023
|
This PR is blocked by #47421 |
adamziel
force-pushed
the
add/experimental-editor-settings
branch
from
718cc49
to
f50bb1f
Compare
This PR introduces `ExperimentalBlockEditorProvider` that prevents mixing experimental editor settings and the public `BlockEditorProvider` component. The actual filtering is handled in a private `__experimentalUpdateSettings` selector in the block-editor store. Experimental settings may still be set via a PHP plugin – limiting this vector would require a separate PR.
adamziel
force-pushed
the
add/experimental-editor-settings
branch
from
f50bb1f
to
cc28354
Compare
ntsekouras
reviewed
Jan 26, 2023
ntsekouras
reviewed
Jan 26, 2023
ntsekouras
approved these changes
Jan 26, 2023
jhnstn
approved these changes
Jan 26, 2023
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.
Description
This PR introduces
ExperimentalBlockEditorProviderthat prevents mixing experimental editor settings and the publicBlockEditorProvidercomponent. The actual filtering is handled in a private__experimentalUpdateSettingsselector in the block-editor store.Experimental settings may still be set via a PHP plugin – limiting this vector would require a separate PR.
Rationale
WordPress extenders cannot update the experimental block settings on their own. The
updateSettings()actions of the@wordpress/block-editorstore will filter out all the settings that are not a part of the public API. The only way to actually store them is via private action.__experimentalUpdateSettings().To privatize a block editor setting, add it to the
privateSettingslist in/packages/block-editor/src/store/actions.js:
Mobile apps
This PR updates a few
.native.jsfiles. Mobile apps choose to import the.native.jsfiles over their.jscounterparts whenever possible. At the same time, this PR introduced the expectation of having two extra named exports:ExperimentalEditorProviderandExperimentalBlockEditorProvider. I updated the native files to export the regular Provider component under the experimental name. This works because the settings filtering is restricted to the web – it doesn't make sense in context of mobile apps anyway.Testing instructions
cc @ntsekouras @youknowriad