Skip to content

Script Loader: Warn when classic scripts depend on modules without footer/defer#11788

Open
itzmekhokan wants to merge 1 commit into
WordPress:trunkfrom
itzmekhokan:fix/trac-65165-module-deps-doing-it-wrong
Open

Script Loader: Warn when classic scripts depend on modules without footer/defer#11788
itzmekhokan wants to merge 1 commit into
WordPress:trunkfrom
itzmekhokan:fix/trac-65165-module-deps-doing-it-wrong

Conversation

@itzmekhokan
Copy link
Copy Markdown

Scripts registered or enqueued with a module_dependencies arg may evaluate before the script modules import map is printed if they are loaded blocking in the document head, causing a "Failed to resolve module specifier" error on dynamic imports.

Trigger _doing_it_wrong() from _wp_scripts_add_args_data() when a classic script provides module_dependencies without setting in_footer to true or using a defer loading strategy, and document this requirement in the wp_register_script() and wp_enqueue_script() docblocks.

Existing tests in wpScriptModules.php that exercised this path are updated to use in_footer => true so they continue to validate the import map behavior without tripping the new warning.

See #65165, #61500.

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

…oter/defer.

Scripts registered or enqueued with a `module_dependencies` arg may evaluate
before the script modules import map is printed if they are loaded blocking
in the document head, causing a "Failed to resolve module specifier" error
on dynamic imports.

Trigger `_doing_it_wrong()` from `_wp_scripts_add_args_data()` when a
classic script provides `module_dependencies` without setting `in_footer`
to true or using a `defer` loading `strategy`, and document this requirement
in the `wp_register_script()` and `wp_enqueue_script()` docblocks.

Existing tests in `wpScriptModules.php` that exercised this path are updated
to use `in_footer => true` so they continue to validate the import map
behavior without tripping the new warning.

See #65165, #61500.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions
Copy link
Copy Markdown

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 khokansardar.

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

@github-actions
Copy link
Copy Markdown

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

  • 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.

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.

1 participant