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

Remove legacy webpack DefinePlugin configuration #6904

Closed

Conversation

sirreal
Copy link
Member

@sirreal sirreal commented Jun 25, 2024

WordPress/gutenberg#61486 changed the variables
compiled into Gutenberg packages via the webpack DefinePlugin.

https://core.trac.wordpress.org/changeset/58193 added the new
DefinePlugin configuration, but did not remove the legacy configuration
in order to be compatible with new and old Gutenberg versions before the
packages were updated.

Now that packages have been update, the legacy configuration should be
removed.

Follow-up to https://core.trac.wordpress.org/changeset/58193.

Trac ticket: https://core.trac.wordpress.org/ticket/61262

Testing

You can confirm that these variables have been replaced during build and do not appear in compiled source:

# Install and build
npm ci
npm run build
# Look for patterns that should not exist
# There will only be a couple of comments in non-minified code
grep -RE '(SCRIPT_DEBUG|IS_WORDPRESS_CORE|IS_GUTENBERG_PLUGIN)' build/wp-includes/js/dist/

You can see they are in the packages:

# Lots of results
grep -RE '(SCRIPT_DEBUG|IS_WORDPRESS_CORE|IS_GUTENBERG_PLUGIN)' build/wp-includes/js/dist/

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

WordPress/gutenberg#61486 changed the variables
compiled into Gutenberg packages via the webpack DefinePlugin.

https://core.trac.wordpress.org/changeset/58193 added the new
DefinePlugin configuration, but did not remove the legacy configuration
in order to be compatible with new and old Gutenberg versions before the
packages were updated.

Now that packages have been update, the legacy configuration should be
removed.

Closes https://core.trac.wordpress.org/ticket/61262.

Follow-up to https://core.trac.wordpress.org/changeset/58193.
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props jonsurrell.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@sirreal
Copy link
Member Author

sirreal commented Jun 25, 2024

#6596 added the configuration.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@gziolo
Copy link
Member

gziolo commented Jun 26, 2024

Committed with https://core.trac.wordpress.org/changeset/58577.

@gziolo gziolo closed this Jun 26, 2024
@gziolo gziolo deleted the remove/legacy-webpack-define-vars branch June 26, 2024 08:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants