Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Framework: Migrate/remove temporary compatibility script initialization #19178

Merged
merged 1 commit into from
Mar 20, 2020

Conversation

aduth
Copy link
Member

@aduth aduth commented Dec 16, 2019

This pull request seeks to...

  1. Remove a persistence script initialization which was incorporated in core as part of WordPress 5.2.0 Edit: This was removed separately as part of Deprecate '@wordpress/nux' package #18981.
  2. Migrate remaining compatibility scripts to compat.php with notes relevant for future removal. This affects API fetch nonce middleware, media upload middleware. Edit: This is now removed altogether in this branch. It was originally slated for removal once support reached WordPress 5.3.0+ minimum (see original commit 3aac816 and associated Trac tickets Trac#48310 and Trac#48076). Since version support was bumped in Plugin: Bump minimum WordPress version to 5.3 #20628 to 5.3.0, it can be assumed to be safely removed.

Implementation Notes:

(Edit: This section does not apply anymore per latest updates)

The rationale for this change is based on the assumption that client-assets.php should be used for the bootstrapping of scripts relevant for Gutenberg, notably:

  • Overriding core WordPress and vendor scripts
  • Overriding core editor initialization

These scripts will always need to exist in the plugin.

Conversely, scripts and filtering which serve a temporary purpose should be isolated in a way that it can be easily removed in future versions as compatibility requirements change. Currently, these are maintained in the lib/compat.php file.

Testing Instructions:

Verify there are no regressions in the behavior of the nonce middleware, media uploads.

@aduth aduth added Backwards Compatibility Issues or PRs that impact backwards compatability [Type] Code Quality Issues or PRs that relate to code quality labels Dec 16, 2019
@aduth aduth force-pushed the remove/compat-editor-inline-scripts branch from 00eafe8 to 7049159 Compare March 16, 2020 19:54
@aduth
Copy link
Member Author

aduth commented Mar 16, 2020

This was left sitting for a while, but I've rebased the branch. Most of the original changes have been impacted by other pull requests (notably #18981 and #20628, cc @noisysocks and @mcsf). I've updated the original comment accordingly.

@github-actions
Copy link

Size Change: 0 B

Total Size: 857 kB

ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 998 B 0 B
build/annotations/index.js 3.43 kB 0 B
build/api-fetch/index.js 3.39 kB 0 B
build/autop/index.js 2.58 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 6.02 kB 0 B
build/block-directory/style-rtl.css 760 B 0 B
build/block-directory/style.css 760 B 0 B
build/block-editor/index.js 100 kB 0 B
build/block-editor/style-rtl.css 10.9 kB 0 B
build/block-editor/style.css 10.9 kB 0 B
build/block-library/editor-rtl.css 7.23 kB 0 B
build/block-library/editor.css 7.24 kB 0 B
build/block-library/index.js 111 kB 0 B
build/block-library/style-rtl.css 7.42 kB 0 B
build/block-library/style.css 7.43 kB 0 B
build/block-library/theme-rtl.css 669 B 0 B
build/block-library/theme.css 671 B 0 B
build/block-serialization-default-parser/index.js 1.65 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 57.6 kB 0 B
build/components/index.js 191 kB 0 B
build/components/style-rtl.css 15.7 kB 0 B
build/components/style.css 15.7 kB 0 B
build/compose/index.js 6.21 kB 0 B
build/core-data/index.js 10.6 kB 0 B
build/data-controls/index.js 1.04 kB 0 B
build/data/index.js 8.2 kB 0 B
build/date/index.js 5.37 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 3.06 kB 0 B
build/edit-post/index.js 91.2 kB 0 B
build/edit-post/style-rtl.css 8.52 kB 0 B
build/edit-post/style.css 8.51 kB 0 B
build/edit-site/index.js 5.07 kB 0 B
build/edit-site/style-rtl.css 2.53 kB 0 B
build/edit-site/style.css 2.53 kB 0 B
build/edit-widgets/index.js 4.43 kB 0 B
build/edit-widgets/style-rtl.css 2.58 kB 0 B
build/edit-widgets/style.css 2.58 kB 0 B
build/editor/editor-styles-rtl.css 381 B 0 B
build/editor/editor-styles.css 382 B 0 B
build/editor/index.js 44 kB 0 B
build/editor/style-rtl.css 3.97 kB 0 B
build/editor/style.css 3.96 kB 0 B
build/element/index.js 4.45 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.09 kB 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 1.93 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.49 kB 0 B
build/is-shallow-equal/index.js 710 B 0 B
build/keyboard-shortcuts/index.js 2.3 kB 0 B
build/keycodes/index.js 1.69 kB 0 B
build/list-reusable-blocks/index.js 2.99 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 4.84 kB 0 B
build/notices/index.js 1.58 kB 0 B
build/nux/index.js 3.01 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.54 kB 0 B
build/primitives/index.js 1.5 kB 0 B
build/priority-queue/index.js 780 B 0 B
build/redux-routine/index.js 2.84 kB 0 B
build/rich-text/index.js 14.3 kB 0 B
build/server-side-render/index.js 2.55 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 4.01 kB 0 B
build/viewport/index.js 1.61 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.18 kB 0 B

compressed-size-action

@aduth
Copy link
Member Author

aduth commented Mar 20, 2020

Just to confirm, I did another pass at the core implementation to ensure that all of the inline scripts being removed here are reflected in WordPress 5.3.0:

https://github.com/WordPress/wordpress-develop/blob/5.3.0/src/wp-includes/script-loader.php#L660

@aduth aduth merged commit 83eb640 into master Mar 20, 2020
@aduth aduth deleted the remove/compat-editor-inline-scripts branch March 20, 2020 12:49
@github-actions github-actions bot added this to the Gutenberg 7.8 milestone Mar 20, 2020
@ellatrix ellatrix mentioned this pull request Jun 16, 2020
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backwards Compatibility Issues or PRs that impact backwards compatability [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants