Site Editor: Expose edit-site store #28722

david-szabo97 · 2021-02-04T09:20:04Z

Description

In Gutenberg all the stores are exposed from the store file, except a few like core/edit-site. This PR aims to refactor core/edit-site store to work the same way as other stores.

Rather than preloading the settings into the store, we are passing the initial state to the editor which takes care of updating the settings in the store.

This change allows us to use the store object properly together with select etc. (No more hacky global variable)

How has this been tested?

Make sure tests are passing, CI passing, and smoke test!

Screenshots

Types of changes

Code quality

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.
I've included developer documentation if appropriate.
I've updated all React Native files affected by any refactorings/renamings in this PR.

github-actions · 2021-02-04T09:31:25Z

Size Change: +168 B (0%)

Total Size: 1.37 MB

Filename	Size	Change
`build/block-editor/index.js`	124 kB	+41 B (0%)
`build/block-editor/style-rtl.css`	12 kB	+41 B (0%)
`build/block-editor/style.css`	12 kB	+42 B (0%)
`build/block-library/index.js`	144 kB	-10 B (0%)
`build/blocks/index.js`	48.3 kB	+15 B (0%)
`build/data/index.js`	8.86 kB	-5 B (0%)
`build/edit-site/index.js`	24.3 kB	+37 B (0%)
`build/edit-widgets/index.js`	20.1 kB	-1 B (0%)
`build/hooks/index.js`	2.28 kB	+8 B (0%)

ℹ️

View Unchanged

Filename	Size	Change
`build/a11y/index.js`	1.14 kB	0 B
`build/annotations/index.js`	3.77 kB	0 B
`build/api-fetch/index.js`	3.4 kB	0 B
`build/autop/index.js`	2.84 kB	0 B
`build/blob/index.js`	665 B	0 B
`build/block-directory/index.js`	9.08 kB	0 B
`build/block-directory/style-rtl.css`	1.01 kB	0 B
`build/block-directory/style.css`	1.01 kB	0 B
`build/block-library/blocks/archives/editor-rtl.css`	61 B	0 B
`build/block-library/blocks/archives/editor.css`	60 B	0 B
`build/block-library/blocks/audio/editor-rtl.css`	58 B	0 B
`build/block-library/blocks/audio/editor.css`	58 B	0 B
`build/block-library/blocks/audio/style-rtl.css`	103 B	0 B
`build/block-library/blocks/audio/style.css`	103 B	0 B
`build/block-library/blocks/block/editor-rtl.css`	161 B	0 B
`build/block-library/blocks/block/editor.css`	161 B	0 B
`build/block-library/blocks/button/editor-rtl.css`	475 B	0 B
`build/block-library/blocks/button/editor.css`	474 B	0 B
`build/block-library/blocks/button/style-rtl.css`	453 B	0 B
`build/block-library/blocks/button/style.css`	451 B	0 B
`build/block-library/blocks/buttons/editor-rtl.css`	227 B	0 B
`build/block-library/blocks/buttons/editor.css`	227 B	0 B
`build/block-library/blocks/buttons/style-rtl.css`	297 B	0 B
`build/block-library/blocks/buttons/style.css`	297 B	0 B
`build/block-library/blocks/calendar/style-rtl.css`	208 B	0 B
`build/block-library/blocks/calendar/style.css`	208 B	0 B
`build/block-library/blocks/categories/editor-rtl.css`	84 B	0 B
`build/block-library/blocks/categories/editor.css`	83 B	0 B
`build/block-library/blocks/categories/style-rtl.css`	79 B	0 B
`build/block-library/blocks/categories/style.css`	79 B	0 B
`build/block-library/blocks/code/style-rtl.css`	90 B	0 B
`build/block-library/blocks/code/style.css`	90 B	0 B
`build/block-library/blocks/columns/editor-rtl.css`	190 B	0 B
`build/block-library/blocks/columns/editor.css`	190 B	0 B
`build/block-library/blocks/columns/style-rtl.css`	421 B	0 B
`build/block-library/blocks/columns/style.css`	421 B	0 B
`build/block-library/blocks/cover/editor-rtl.css`	392 B	0 B
`build/block-library/blocks/cover/editor.css`	393 B	0 B
`build/block-library/blocks/cover/style-rtl.css`	1.25 kB	0 B
`build/block-library/blocks/cover/style.css`	1.25 kB	0 B
`build/block-library/blocks/embed/editor-rtl.css`	486 B	0 B
`build/block-library/blocks/embed/editor.css`	486 B	0 B
`build/block-library/blocks/embed/style-rtl.css`	396 B	0 B
`build/block-library/blocks/embed/style.css`	395 B	0 B
`build/block-library/blocks/file/editor-rtl.css`	199 B	0 B
`build/block-library/blocks/file/editor.css`	198 B	0 B
`build/block-library/blocks/file/style-rtl.css`	248 B	0 B
`build/block-library/blocks/file/style.css`	248 B	0 B
`build/block-library/blocks/freeform/editor-rtl.css`	2.45 kB	0 B
`build/block-library/blocks/freeform/editor.css`	2.45 kB	0 B
`build/block-library/blocks/gallery/editor-rtl.css`	679 B	0 B
`build/block-library/blocks/gallery/editor.css`	679 B	0 B
`build/block-library/blocks/gallery/style-rtl.css`	1.07 kB	0 B
`build/block-library/blocks/gallery/style.css`	1.06 kB	0 B
`build/block-library/blocks/group/editor-rtl.css`	318 B	0 B
`build/block-library/blocks/group/editor.css`	317 B	0 B
`build/block-library/blocks/group/style-rtl.css`	57 B	0 B
`build/block-library/blocks/group/style.css`	57 B	0 B
`build/block-library/blocks/heading/editor-rtl.css`	129 B	0 B
`build/block-library/blocks/heading/editor.css`	129 B	0 B
`build/block-library/blocks/heading/style-rtl.css`	76 B	0 B
`build/block-library/blocks/heading/style.css`	76 B	0 B
`build/block-library/blocks/html/editor-rtl.css`	281 B	0 B
`build/block-library/blocks/html/editor.css`	281 B	0 B
`build/block-library/blocks/image/editor-rtl.css`	717 B	0 B
`build/block-library/blocks/image/editor.css`	716 B	0 B
`build/block-library/blocks/image/style-rtl.css`	477 B	0 B
`build/block-library/blocks/image/style.css`	478 B	0 B
`build/block-library/blocks/latest-comments/editor-rtl.css`	159 B	0 B
`build/block-library/blocks/latest-comments/editor.css`	158 B	0 B
`build/block-library/blocks/latest-comments/style-rtl.css`	269 B	0 B
`build/block-library/blocks/latest-comments/style.css`	269 B	0 B
`build/block-library/blocks/latest-posts/editor-rtl.css`	137 B	0 B
`build/block-library/blocks/latest-posts/editor.css`	137 B	0 B
`build/block-library/blocks/latest-posts/style-rtl.css`	523 B	0 B
`build/block-library/blocks/latest-posts/style.css`	522 B	0 B
`build/block-library/blocks/list/editor-rtl.css`	65 B	0 B
`build/block-library/blocks/list/editor.css`	65 B	0 B
`build/block-library/blocks/list/style-rtl.css`	63 B	0 B
`build/block-library/blocks/list/style.css`	63 B	0 B
`build/block-library/blocks/media-text/editor-rtl.css`	191 B	0 B
`build/block-library/blocks/media-text/editor.css`	191 B	0 B
`build/block-library/blocks/media-text/style-rtl.css`	535 B	0 B
`build/block-library/blocks/media-text/style.css`	532 B	0 B
`build/block-library/blocks/more/editor-rtl.css`	434 B	0 B
`build/block-library/blocks/more/editor.css`	434 B	0 B
`build/block-library/blocks/navigation-link/editor-rtl.css`	392 B	0 B
`build/block-library/blocks/navigation-link/editor.css`	394 B	0 B
`build/block-library/blocks/navigation-link/style-rtl.css`	704 B	0 B
`build/block-library/blocks/navigation-link/style.css`	702 B	0 B
`build/block-library/blocks/navigation/editor-rtl.css`	1.38 kB	0 B
`build/block-library/blocks/navigation/editor.css`	1.37 kB	0 B
`build/block-library/blocks/navigation/style-rtl.css`	174 B	0 B
`build/block-library/blocks/navigation/style.css`	174 B	0 B
`build/block-library/blocks/nextpage/editor-rtl.css`	395 B	0 B
`build/block-library/blocks/nextpage/editor.css`	395 B	0 B
`build/block-library/blocks/paragraph/editor-rtl.css`	109 B	0 B
`build/block-library/blocks/paragraph/editor.css`	109 B	0 B
`build/block-library/blocks/paragraph/style-rtl.css`	273 B	0 B
`build/block-library/blocks/paragraph/style.css`	273 B	0 B
`build/block-library/blocks/post-author/editor-rtl.css`	209 B	0 B
`build/block-library/blocks/post-author/editor.css`	209 B	0 B
`build/block-library/blocks/post-author/style-rtl.css`	183 B	0 B
`build/block-library/blocks/post-author/style.css`	184 B	0 B
`build/block-library/blocks/post-comments-form/style-rtl.css`	249 B	0 B
`build/block-library/blocks/post-comments-form/style.css`	249 B	0 B
`build/block-library/blocks/post-content/editor-rtl.css`	139 B	0 B
`build/block-library/blocks/post-content/editor.css`	139 B	0 B
`build/block-library/blocks/post-excerpt/editor-rtl.css`	73 B	0 B
`build/block-library/blocks/post-excerpt/editor.css`	73 B	0 B
`build/block-library/blocks/post-featured-image/editor-rtl.css`	338 B	0 B
`build/block-library/blocks/post-featured-image/editor.css`	338 B	0 B
`build/block-library/blocks/post-featured-image/style-rtl.css`	100 B	0 B
`build/block-library/blocks/post-featured-image/style.css`	100 B	0 B
`build/block-library/blocks/preformatted/style-rtl.css`	63 B	0 B
`build/block-library/blocks/preformatted/style.css`	63 B	0 B
`build/block-library/blocks/pullquote/editor-rtl.css`	183 B	0 B
`build/block-library/blocks/pullquote/editor.css`	183 B	0 B
`build/block-library/blocks/pullquote/style-rtl.css`	316 B	0 B
`build/block-library/blocks/pullquote/style.css`	316 B	0 B
`build/block-library/blocks/query-loop/editor-rtl.css`	90 B	0 B
`build/block-library/blocks/query-loop/editor.css`	89 B	0 B
`build/block-library/blocks/query-loop/style-rtl.css`	315 B	0 B
`build/block-library/blocks/query-loop/style.css`	317 B	0 B
`build/block-library/blocks/query-pagination-numbers/editor-rtl.css`	122 B	0 B
`build/block-library/blocks/query-pagination-numbers/editor.css`	121 B	0 B
`build/block-library/blocks/query-pagination/editor-rtl.css`	270 B	0 B
`build/block-library/blocks/query-pagination/editor.css`	262 B	0 B
`build/block-library/blocks/query-pagination/style-rtl.css`	168 B	0 B
`build/block-library/blocks/query-pagination/style.css`	168 B	0 B
`build/block-library/blocks/query/editor-rtl.css`	159 B	0 B
`build/block-library/blocks/query/editor.css`	160 B	0 B
`build/block-library/blocks/quote/editor-rtl.css`	61 B	0 B
`build/block-library/blocks/quote/editor.css`	61 B	0 B
`build/block-library/blocks/quote/style-rtl.css`	169 B	0 B
`build/block-library/blocks/quote/style.css`	169 B	0 B
`build/block-library/blocks/rss/editor-rtl.css`	201 B	0 B
`build/block-library/blocks/rss/editor.css`	202 B	0 B
`build/block-library/blocks/rss/style-rtl.css`	290 B	0 B
`build/block-library/blocks/rss/style.css`	290 B	0 B
`build/block-library/blocks/search/editor-rtl.css`	165 B	0 B
`build/block-library/blocks/search/editor.css`	165 B	0 B
`build/block-library/blocks/search/style-rtl.css`	342 B	0 B
`build/block-library/blocks/search/style.css`	344 B	0 B
`build/block-library/blocks/separator/editor-rtl.css`	99 B	0 B
`build/block-library/blocks/separator/editor.css`	99 B	0 B
`build/block-library/blocks/separator/style-rtl.css`	236 B	0 B
`build/block-library/blocks/separator/style.css`	236 B	0 B
`build/block-library/blocks/shortcode/editor-rtl.css`	504 B	0 B
`build/block-library/blocks/shortcode/editor.css`	504 B	0 B
`build/block-library/blocks/site-logo/editor-rtl.css`	201 B	0 B
`build/block-library/blocks/site-logo/editor.css`	201 B	0 B
`build/block-library/blocks/site-logo/style-rtl.css`	117 B	0 B
`build/block-library/blocks/site-logo/style.css`	117 B	0 B
`build/block-library/blocks/social-link/editor-rtl.css`	164 B	0 B
`build/block-library/blocks/social-link/editor.css`	165 B	0 B
`build/block-library/blocks/social-links/editor-rtl.css`	711 B	0 B
`build/block-library/blocks/social-links/editor.css`	712 B	0 B
`build/block-library/blocks/social-links/style-rtl.css`	1.37 kB	0 B
`build/block-library/blocks/social-links/style.css`	1.37 kB	0 B
`build/block-library/blocks/spacer/editor-rtl.css`	302 B	0 B
`build/block-library/blocks/spacer/editor.css`	302 B	0 B
`build/block-library/blocks/spacer/style-rtl.css`	48 B	0 B
`build/block-library/blocks/spacer/style.css`	48 B	0 B
`build/block-library/blocks/subhead/editor-rtl.css`	99 B	0 B
`build/block-library/blocks/subhead/editor.css`	99 B	0 B
`build/block-library/blocks/subhead/style-rtl.css`	80 B	0 B
`build/block-library/blocks/subhead/style.css`	80 B	0 B
`build/block-library/blocks/table/editor-rtl.css`	489 B	0 B
`build/block-library/blocks/table/editor.css`	489 B	0 B
`build/block-library/blocks/table/style-rtl.css`	386 B	0 B
`build/block-library/blocks/table/style.css`	386 B	0 B
`build/block-library/blocks/tag-cloud/editor-rtl.css`	118 B	0 B
`build/block-library/blocks/tag-cloud/editor.css`	118 B	0 B
`build/block-library/blocks/tag-cloud/style-rtl.css`	94 B	0 B
`build/block-library/blocks/tag-cloud/style.css`	94 B	0 B
`build/block-library/blocks/template-part/editor-rtl.css`	680 B	0 B
`build/block-library/blocks/template-part/editor.css`	679 B	0 B
`build/block-library/blocks/text-columns/editor-rtl.css`	95 B	0 B
`build/block-library/blocks/text-columns/editor.css`	95 B	0 B
`build/block-library/blocks/text-columns/style-rtl.css`	166 B	0 B
`build/block-library/blocks/text-columns/style.css`	166 B	0 B
`build/block-library/blocks/verse/editor-rtl.css`	62 B	0 B
`build/block-library/blocks/verse/editor.css`	62 B	0 B
`build/block-library/blocks/verse/style-rtl.css`	87 B	0 B
`build/block-library/blocks/verse/style.css`	87 B	0 B
`build/block-library/blocks/video/editor-rtl.css`	504 B	0 B
`build/block-library/blocks/video/editor.css`	503 B	0 B
`build/block-library/blocks/video/style-rtl.css`	193 B	0 B
`build/block-library/blocks/video/style.css`	193 B	0 B
`build/block-library/common-rtl.css`	1.01 kB	0 B
`build/block-library/common.css`	1.01 kB	0 B
`build/block-library/editor-rtl.css`	9.06 kB	0 B
`build/block-library/editor.css`	9.05 kB	0 B
`build/block-library/style-rtl.css`	8.62 kB	0 B
`build/block-library/style.css`	8.62 kB	0 B
`build/block-library/theme-rtl.css`	748 B	0 B
`build/block-library/theme.css`	748 B	0 B
`build/block-serialization-default-parser/index.js`	1.88 kB	0 B
`build/block-serialization-spec-parser/index.js`	3.06 kB	0 B
`build/components/index.js`	279 kB	0 B
`build/components/style-rtl.css`	15.5 kB	0 B
`build/components/style.css`	15.5 kB	0 B
`build/compose/index.js`	11.2 kB	0 B
`build/core-data/index.js`	16.8 kB	0 B
`build/data-controls/index.js`	827 B	0 B
`build/date/index.js`	31.8 kB	0 B
`build/deprecated/index.js`	768 B	0 B
`build/dom-ready/index.js`	570 B	0 B
`build/dom/index.js`	4.93 kB	0 B
`build/edit-navigation/index.js`	11.2 kB	0 B
`build/edit-navigation/style-rtl.css`	1.01 kB	0 B
`build/edit-navigation/style.css`	1.01 kB	0 B
`build/edit-post/index.js`	307 kB	0 B
`build/edit-post/style-rtl.css`	6.79 kB	0 B
`build/edit-post/style.css`	6.78 kB	0 B
`build/edit-site/style-rtl.css`	4.04 kB	0 B
`build/edit-site/style.css`	4.04 kB	0 B
`build/edit-widgets/style-rtl.css`	3.2 kB	0 B
`build/edit-widgets/style.css`	3.2 kB	0 B
`build/editor/editor-styles-rtl.css`	543 B	0 B
`build/editor/editor-styles.css`	545 B	0 B
`build/editor/index.js`	41.9 kB	0 B
`build/editor/style-rtl.css`	3.89 kB	0 B
`build/editor/style.css`	3.89 kB	0 B
`build/element/index.js`	4.61 kB	0 B
`build/escape-html/index.js`	735 B	0 B
`build/format-library/index.js`	6.77 kB	0 B
`build/format-library/style-rtl.css`	637 B	0 B
`build/format-library/style.css`	639 B	0 B
`build/html-entities/index.js`	622 B	0 B
`build/i18n/index.js`	3.74 kB	0 B
`build/is-shallow-equal/index.js`	698 B	0 B
`build/keyboard-shortcuts/index.js`	2.54 kB	0 B
`build/keycodes/index.js`	1.93 kB	0 B
`build/list-reusable-blocks/index.js`	3.15 kB	0 B
`build/list-reusable-blocks/style-rtl.css`	629 B	0 B
`build/list-reusable-blocks/style.css`	628 B	0 B
`build/media-utils/index.js`	5.35 kB	0 B
`build/notices/index.js`	1.85 kB	0 B
`build/nux/index.js`	3.41 kB	0 B
`build/nux/style-rtl.css`	731 B	0 B
`build/nux/style.css`	727 B	0 B
`build/plugins/index.js`	2.54 kB	0 B
`build/primitives/index.js`	1.42 kB	0 B
`build/priority-queue/index.js`	790 B	0 B
`build/redux-routine/index.js`	2.84 kB	0 B
`build/reusable-blocks/index.js`	2.92 kB	0 B
`build/rich-text/index.js`	13.4 kB	0 B
`build/server-side-render/index.js`	2.77 kB	0 B
`build/shortcode/index.js`	1.7 kB	0 B
`build/token-list/index.js`	1.27 kB	0 B
`build/url/index.js`	3.01 kB	0 B
`build/viewport/index.js`	1.86 kB	0 B
`build/warning/index.js`	1.14 kB	0 B
`build/wordcount/index.js`	1.22 kB	0 B

_{compressed-size-action}

gziolo

Nice work! I will wait with 👍🏻 until someone confirms the changes applied to Editor are correct. Everything else looks good.

gziolo · 2021-02-04T12:17:06Z

packages/edit-site/src/components/editor/index.js

@@ -48,7 +48,7 @@ const interfaceLabels = {
 	drawer: __( 'Navigation Sidebar' ),
 };

-function Editor() {
+function Editor( { initialSettings } ) {


I would appreciate a sanity check from someone familiar with the edit site's editor initialization.

ntsekouras · 2021-02-04T16:27:54Z

packages/edit-site/src/components/editor/index.js

+	);
+	useEffect( () => {
+		updateSettings( initialSettings );
+	}, [ initialSettings ] );


Why have initialSettings as dependency? Shouldn't an empty array to run once be enough?

It should be enough 🤔 Let's give it a try

ntsekouras · 2021-02-04T16:29:08Z

packages/edit-site/src/components/editor/index.js

@@ -152,6 +157,11 @@ function Editor() {
 		onClose: () => setIsInserterOpened( false ),
 	} );

+	// Don't render the Editor until the settings are set and loaded
+	if ( ! settings?.siteUrl ) {


I'm just curious about this. Was it needed because something was breaking or an optimization?

Yes, rendering the Editor component without settings results in crash.

Expose edit site store

Loading status checks…

938d27e

david-szabo97 force-pushed the try/edit-site-store-without-initialize-function branch from 54e36bf to 938d27e Feb 4, 2021

Remove calls to registerEditSiteStore

Loading status checks…

381c5c2

gziolo added [Package] Edit Site [Type] Code Quality labels Feb 4, 2021

david-szabo97 self-assigned this Feb 4, 2021

david-szabo97 marked this pull request as ready for review Feb 4, 2021

david-szabo97 requested review from vindl, jeyip, mattwiebe, Addison-Stavlo, Copons and gziolo Feb 4, 2021

gziolo reviewed Feb 4, 2021

View changes

ntsekouras reviewed Feb 4, 2021

View changes

Only run once

Loading status checks…

4762d21

WordPress / gutenberg

Site Editor: Expose edit-site store #28722

Site Editor: Expose edit-site store #28722

david-szabo97 commented Feb 4, 2021 •

edited

github-actions bot commented Feb 4, 2021 •

edited

gziolo left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

WordPress / gutenberg

Site Editor: Expose edit-site store #28722

Site Editor: Expose edit-site store #28722

Conversation

david-szabo97 commented Feb 4, 2021 • edited

Description

How has this been tested?

Screenshots

Types of changes

Checklist:

github-actions bot commented Feb 4, 2021 • edited

gziolo left a comment

This comment has been minimized.

gziolo Feb 4, 2021 Member

This comment has been minimized.

ntsekouras Feb 4, 2021 Contributor

This comment has been minimized.

david-szabo97 Feb 4, 2021 Author Member

This comment has been minimized.

ntsekouras Feb 4, 2021 Contributor

This comment has been minimized.

david-szabo97 Feb 4, 2021 Author Member

david-szabo97 commented Feb 4, 2021 •

edited

github-actions bot commented Feb 4, 2021 •

edited

gziolo Feb 4, 2021
Member

ntsekouras Feb 4, 2021
Contributor

david-szabo97 Feb 4, 2021
Author Member

ntsekouras Feb 4, 2021
Contributor

david-szabo97 Feb 4, 2021
Author Member