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.

Sign up for GitHub

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

Jump to bottom

Phan: functionify and statusify exit() and die() #41167

Merged
merged 15 commits into from
Jan 20, 2025
Merged

Phan: functionify and statusify exit() and die() #41167

merged 15 commits into from
Jan 20, 2025

Conversation

tbradsha
Copy link
Contributor

@tbradsha tbradsha commented Jan 17, 2025 •
edited
Loading

Due to phan/phan#4888, running Phan on PHP 8.4 resulted in many false-positives. This PR changes our codebase to use the following:

  • exit → exit( 0 )
  • exit() → exit( 0 )
  • die → die( 0 )
  • die() → die( 0 )

While we don't have plans to enforce this syntax going forward, it doesn't hurt to be consistent. The function-style calls have been around since PHP 4, and PHP 8.4 changed them to be behave more like functions:

https://www.php.net/manual/en/migration84.incompatible.php#migration84.incompatible.core.exit

Likewise, while the status code isn't required, it does default to 0 and being explicit is arguably good practice anyway.

I also updated some code that was surfacing errors likely related to the known Phan bug.

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

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

Testing instructions:

  • Is CI pleased?
  • Does a local run on PHP 8.4 show the same errors as a local run on PHP 8.2?

In trunk one gets 701 errors from Phan when running PHP 8.4.

@tbradsha tbradsha added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial labels Jan 17, 2025
@tbradsha tbradsha requested a review from a team January 17, 2025 20:01
@tbradsha tbradsha self-assigned this Jan 17, 2025
@github-actions github-actions bot added [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] Super Cache A fast caching plugin for WordPress. [Plugin] VaultPress [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh [Tests] Includes Tests Admin Page React-powered dashboard under the Jetpack menu E2E Tests labels Jan 17, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 17, 2025 •
edited
Loading

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/functionify_and_statusify_exit_and_die 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 fix/functionify_and_statusify_exit_and_die

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/functionify_and_statusify_exit_and_die

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 17, 2025 •
edited
Loading

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 a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ 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!

Beta plugin:

  • Next scheduled release: none scheduled.

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

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for February 4, 2025 (scheduled code freeze on February 4, 2025).

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

Debug Helper plugin:

  • Next scheduled release: none scheduled.

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

Backup plugin:

  • Next scheduled release: none scheduled.

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

Vaultpress plugin:

  • Next scheduled release: none scheduled.

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

Boost plugin:

  • Next scheduled release: none scheduled.

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

Search plugin:

  • Next scheduled release: none scheduled.

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

Social plugin:

  • Next scheduled release: none scheduled.

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

Starter Plugin plugin:

  • Next scheduled release: none scheduled.

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

Protect plugin:

  • Next scheduled release: none scheduled.

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

Videopress plugin:

  • Next scheduled release: none scheduled.

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

Super Cache plugin:

  • Next scheduled release: none scheduled.

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

Wpcomsh plugin:

  • Next scheduled release: Atomic deploys happen twice daily on weekdays (p9o2xV-2EN-p2).

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

Automattic For agencies client plugin:

  • Next scheduled release: none scheduled.

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

Classic Theme helper plugin plugin:

  • Next scheduled release: none scheduled.

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

@tbradsha tbradsha requested a review from a team as a code owner January 17, 2025 21:38
zinigor
zinigor reviewed Jan 20, 2025
View reviewed changes
projects/packages/patchwork-redefine-exit/tests/php/fixtures/die.php
@@ -4,5 +4,6 @@
// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
die( $arg );
} else {
// @phan-suppress-current-line UnusedPluginSuppression @phan-suppress-next-line PhanParamTooFewInternal -- Phan bug with PHP 8.4: https://github.com/phan/phan/issues/4888
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why you went with suppression here instead of adding a zero as with everywhere else?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case it's a test specifically for the no-arg variant of die() (a valid variant despite what Phan claims on PHP 8.4), so adding an arg defaults the point of that test.

zinigor
zinigor requested changes Jan 20, 2025
View reviewed changes
Copy link
Member

@zinigor zinigor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left two separate comments before, then found another thing and decided to start a review in case I found more. And of course I didn't find anything else.
Also, I wasn't aware of how much CRM likes to exit! Oh boy!

@tbradsha tbradsha requested a review from zinigor January 20, 2025 14:19
@tbradsha tbradsha merged commit d2c7b02 into trunk Jan 20, 2025
77 checks passed
@tbradsha tbradsha deleted the fix/functionify_and_statusify_exit_and_die branch January 20, 2025 15:39
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Jan 20, 2025
@tbradsha tbradsha mentioned this pull request Jan 22, 2025
Merged
3 tasks
coder-karen pushed a commit that referenced this pull request Jan 24, 2025
@tbradsha @coder-karen
Phan: functionify and statusify exit() and die() (#41167)
e5a6fa0 
* non-CRM: exit → exit( 0 )

* CRM: exit → exit( 0 )

* non-CRM: exit() → exit( 0 )

* CRM: exit() → exit( 0 )

* die → die(0)

* Suppress invalid Phan error on valid tests

* die() → die(0)

* Add changelogs

* Suppress unneeded suppression warnings on PHP 8.2

* Oops

* Rework code to satisfy Phan bug

* Remove redundant exits

* Correct PHPDoc

* Update baseline

* Remove comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zinigor zinigor zinigor approved these changes

Assignees

@tbradsha tbradsha

Labels
Admin Page React-powered dashboard under the Jetpack menu [Block] Map [Block] Sharing Button [Boost Feature] Critical CSS Issues involving the Critical CSS feature in Boost [Boost Feature] Page Cache [CRM] API [CRM] Automations Module [CRM] Givewp Module [CRM] MailPoet Module [CRM] Portal Module [CRM] WooSync Module E2E Tests [Feature] Ad [Feature] Comments [Feature] Contact Form [Feature] Extra Sidebar Widgets [Feature] Infinite Scroll [Feature] Likes [Feature] Masterbar WordPress.com Toolbar and Dashboard customizations [Feature] Publicize Now Jetpack Social, auto-sharing [Feature] Related Posts [Feature] Sharing Post sharing, sharing buttons [Feature] Sitemaps [Feature] SSO [Feature] Subscriptions All subscription-related things such as paid and unpaid, user management, and newsletter settings. [Feature] Theme Tools [Feature] WooCommerce Analytics [Focus] Compatibility Ensuring our products play well with third-parties [mu wpcom Feature] Coming Soon [mu wpcom Feature] Custom Css [mu wpcom Feature] Random Redirect [mu wpcom Feature] WordPress.com Block Editor [Package] Analyzer [Package] Autoloader [Package] Backup [Package] Classic Theme Helper [Package] Connection [Package] Forms [Package] Jetpack mu wpcom WordPress.com Features [Package] Licensing [Package] Masterbar [Package] Patchwork Redefine Exit [Package] Plugin Deactivation [Package] Publicize [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] Status [Package] Sync [Package] VideoPress [Package] WAF [Plugin] Automattic For Agencies Client [Plugin] Backup A plugin that allows users to save every change and get back online quickly with one-click restores. [Plugin] Beta For serving live branches and the beta versions. https://github.com/automattic/jetpack-beta [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Classic Theme Helper Plugin [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Debug Helper Debug Tools plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Plugin] Protect A plugin with features to protect a site: brute force protection, security scanning, and a WAF. [Plugin] Search A plugin to add an instant search modal to your site to help visitors find content faster. [Plugin] Social Issues about the Jetpack Social plugin [Plugin] Starter Plugin [Plugin] Super Cache A fast caching plugin for WordPress. [Plugin] VaultPress [Plugin] VideoPress A standalone plugin to add high-quality VideoPress videos to your site. [Plugin] Wpcomsh [Tests] Includes Tests [Type] Janitorial
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tbradsha @zinigor