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

fix: Prevent undefined get_current_screen function errors #39228

Merged

Conversation

dcalhoun
Copy link
Member

@dcalhoun dcalhoun commented Sep 4, 2024

Proposed changes:

Guard against invocations of an undefined get_current_screen function.

This function is undefined in certain contexts -- e.g., a REST API
request that results in enqueueing assets. Referencing an undefined
function results in a fatal error. With the get_current_screen
function specifically, it is common practice to check the function's
existence prior to invoking the it.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

N/A, no product discussion occurred for this bug fix.

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

Verify feature stability with testing instructions similar to #38475.

  1. Apply these changes to your testing environment.
  2. Create a new page on your test site: <site_domain>/wp-admin/post-new.php?post_type=page.
  3. Verify the page templates displayed match those in production and function as expected (e.g., clicking one inserts the content into the block editor).

This function is undefined in certain contexts -- e.g., a REST API
request that results in enqueueing assets. Referencing an undefined
function results in a fatal error. With the `get_current_screen`
function specifically, it is common practice to check the function's
existence prior to invoking the it.

https://developer.wordpress.org/reference/functions/get_current_screen/#comment-5424
@dcalhoun dcalhoun added [Type] Bug When a feature is broken and / or not performing as intended [Plugin] mu wpcom jetpack-mu-wpcom plugin [mu wpcom Feature] Starter Page Templates labels Sep 4, 2024
Copy link
Contributor

github-actions bot commented Sep 4, 2024

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/prevent-undefined-get-current-screen-function-errors branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.
  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/prevent-undefined-get-current-screen-function-errors
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

github-actions bot commented Sep 4, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Mu Wpcom plugin:

  • Next scheduled release: WordPress.com Simple releases happen daily.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@dcalhoun dcalhoun marked this pull request as ready for review September 4, 2024 19:02
@dcalhoun
Copy link
Member Author

dcalhoun commented Sep 4, 2024

👋🏻 @miksansegundo. This is my first time modifying jetpack-mu-wpcom. Given your experience with #38475, I hoped to receive your review and help testing these changes — primarily ensuring there are no unintended regressions for the web product. Would you be willing to help?

Thank you! 🙇🏻‍♂️

@dcalhoun dcalhoun added the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Sep 9, 2024
@kraftbj kraftbj merged commit 5ee714f into trunk Sep 11, 2024
61 checks passed
@kraftbj kraftbj deleted the fix/prevent-undefined-get-current-screen-function-errors branch September 11, 2024 16:46
@github-actions github-actions bot removed [Status] In Progress [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Sep 11, 2024
gogdzl pushed a commit that referenced this pull request Oct 25, 2024
* fix: Prevent undefined `get_current_screen` function errors

This function is undefined in certain contexts -- e.g., a REST API
request that results in enqueueing assets. Referencing an undefined
function results in a fatal error. With the `get_current_screen`
function specifically, it is common practice to check the function's
existence prior to invoking the it.

https://developer.wordpress.org/reference/functions/get_current_screen/#comment-5424

* docs: Add change log entry
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[mu wpcom Feature] Starter Page Templates [Package] Jetpack mu wpcom WordPress.com Features [Plugin] mu wpcom jetpack-mu-wpcom plugin [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants