Jetpack: Fix various PhanUndefined issues #37344

anomiex · 2024-05-10T14:53:09Z

Proposed changes:

Notable changes:

Remove Jetpack_User_Agent_Info::is_OperaMobile(). Janitorial: clean up deprecated code #16434 removed the jetpack-device-detect function this was calling in October 2021, but missed this caller.
Remove jetpack_server_sandbox() and jetpack_server_sandbox_request_parameters(). Due to a wrong namespace in Server Sandbox: Move the server sandbox to the connection package #21128, they'd have thrown fatals since October 2021.
Use $skin instead of $upgrader->skin, it's the same object but not typed as a parent class. Should be no change to functionality.
Add some missing methods to WPCOM_JSON_API.
Add some missing abstract methods to SAL_Site, and implement in Jetpack_Site.
Fix SAL_Token::is_global().
Remove views/admin/deactivation-dialog.php, unused since Jetpack: Extend disconnection dialog component to handle multiple steps and accept more props #21048 in November 2021.
Add @phan-var-force in a lot of "template" files. I'm not entirely happy with this, it pollutes the global scope for any subsequent files processed, but short of writing a Phan plugin that somehow adjusts the scope for only the file I can't find a better idea.

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

None

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

No

Testing instructions:

CI happy?
Stuff still work?

Notable changes: * Remove `Jetpack_User_Agent_Info::is_OperaMobile()`. #16434 removed the jetpack-device-detect function this was calling in October 2021, but missed this caller. * Remove `jetpack_server_sandbox()` and `jetpack_server_sandbox_request_parameters()`. Due to a wrong namespace in #21128, they'd have thrown fatals since October 2021. * Use `$skin` instead of `$upgrader->skin`, it's the same object but not typed as a parent class. Should be no change to functionality. * Add some missing methods to `WPCOM_JSON_API`. * Add some missing abstract methods to SAL_Site, and implement in Jetpack_Site. * Fix `SAL_Token::is_global()`. * Remove `views/admin/deactivation-dialog.php`, unused since #21048 in November 2021. * Add `@phan-var-force` in a lot of "template" files. I'm not entirely happy with this, it pollutes the global scope for any subsequent files processed, but short of writing a Phan plugin that somehow adjusts the scope for only the file I can't find a better idea.

github-actions · 2024-05-10T14:53:56Z

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/misc-phan-undeclared-issues 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/misc-phan-undeclared-issues

bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/misc-phan-undeclared-issues

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 · 2024-05-10T14:54:06Z

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.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

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

WordPress.com Simple releases happen daily.
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for June 4, 2024 (scheduled code freeze on June 3, 2024).

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

…n a different namespace in old phpunit

tbradsha · 2024-05-10T19:26:40Z

projects/plugins/jetpack/_inc/jetpack-server-sandbox.php

+ * The feature formerly here is now found in `Automattic\Jetpack\Connection\Server_Sandbox`
+ * in the jetpack-connection package.


Do we need to keep this file? If so, maybe we should put a "since" mention in the comment so 2 years down the road it's clear it's safe to remove.

Do we need to keep this file?

Not sure.

If so, maybe we should put a "since" mention in the comment so 2 years down the road it's clear it's safe to remove.

Good idea, I'll do that.

…entirely, it hasn't been loaded since 11.4.

tbradsha

A few inline thoughts. I'm also not a fan of phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable without enabling later. Too bad PHPCS can't ignore a specific variable!

projects/plugins/jetpack/_inc/lib/core-api/load-wpcom-endpoints.php

tbradsha · 2024-05-10T20:07:40Z

projects/plugins/jetpack/modules/widgets/simple-payments/form.php

@@ -34,7 +37,7 @@ class="widefat jetpack-simple-payments-products"
 		id="<?php echo esc_attr( $this->get_field_id( 'product_post_id' ) ); ?>"
 		name="<?php echo esc_attr( $this->get_field_name( 'product_post_id' ) ); ?>">
 		<?php foreach ( $product_posts as $product_post ) { ?>
-			<option value="<?php echo esc_attr( $product_post->ID ); ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>
+			<option value="<?php echo esc_attr( (string) $product_post->ID ); ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>


Why not this?

Suggested change

<option value="<?php echo esc_attr( (string) $product_post->ID ); ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>

<option value="<?php echo (int) $product_post->ID; ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>

projects/plugins/jetpack/sal/class.json-api-site-jetpack.php

projects/plugins/jetpack/tests/php/sync/server/class.jetpack-sync-test-replicastore.php

anomiex

I'm also not a fan of phpcs:disable VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable without enabling later. Too bad PHPCS can't ignore a specific variable!

It would have to go at the very end of the files, so it wouldn't make any real difference. As the comment notes, we're relying on Phan to flag undefined globals instead for these.

projects/plugins/jetpack/_inc/lib/core-api/load-wpcom-endpoints.php

anomiex · 2024-05-10T20:37:49Z

projects/plugins/jetpack/modules/widgets/simple-payments/form.php

@@ -34,7 +37,7 @@ class="widefat jetpack-simple-payments-products"
 		id="<?php echo esc_attr( $this->get_field_id( 'product_post_id' ) ); ?>"
 		name="<?php echo esc_attr( $this->get_field_name( 'product_post_id' ) ); ?>">
 		<?php foreach ( $product_posts as $product_post ) { ?>
-			<option value="<?php echo esc_attr( $product_post->ID ); ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>
+			<option value="<?php echo esc_attr( (string) $product_post->ID ); ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>


projects/plugins/jetpack/sal/class.json-api-site-jetpack.php

projects/plugins/jetpack/tests/php/sync/server/class.jetpack-sync-test-replicastore.php

…ared-issues

anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels May 10, 2024

anomiex requested a review from a team May 10, 2024 14:53

anomiex self-assigned this May 10, 2024

anomiex requested a review from a team as a code owner May 10, 2024 14:53

Use PHPUnit\Framework\Assert class instead of the function which is i…

ac638af

…n a different namespace in old phpunit

tbradsha reviewed May 10, 2024

View reviewed changes

Just remove projects/plugins/jetpack/_inc/jetpack-server-sandbox.php …

4eee393

…entirely, it hasn't been loaded since 11.4.

tbradsha reviewed May 10, 2024

View reviewed changes

anomiex commented May 10, 2024

View reviewed changes

Switch esc_attr for int cast

6b8ddc4

tbradsha approved these changes May 11, 2024

View reviewed changes

Merge remote-tracking branch 'origin/trunk' into fix/misc-phan-undecl…

022ddb6

…ared-issues

anomiex merged commit e3d2922 into trunk May 14, 2024
71 of 72 checks passed

anomiex deleted the fix/misc-phan-undeclared-issues branch May 14, 2024 15:33

github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label May 14, 2024

github-actions bot added this to the jetpack/13.5 milestone May 14, 2024

anomiex mentioned this pull request May 17, 2024

Masterbar: Copy module code to package #37342

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Jetpack: Fix various PhanUndefined issues #37344

Jetpack: Fix various PhanUndefined issues #37344

anomiex commented May 10, 2024

github-actions bot commented May 10, 2024 •

edited

Loading

github-actions bot commented May 10, 2024

tbradsha May 10, 2024

anomiex May 10, 2024

tbradsha left a comment

tbradsha May 10, 2024

anomiex May 10, 2024

anomiex left a comment

anomiex May 10, 2024

		* The feature formerly here is now found in `Automattic\Jetpack\Connection\Server_Sandbox`
		* in the jetpack-connection package.

	<option value="<?php echo esc_attr( (string) $product_post->ID ); ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>
	<option value="<?php echo (int) $product_post->ID; ?>" <?php selected( (int) $instance['product_post_id'], $product_post->ID ); ?>>

Jetpack: Fix various PhanUndefined issues #37344

Jetpack: Fix various PhanUndefined issues #37344

Conversation

anomiex commented May 10, 2024

Proposed changes:

Other information:

Jetpack product discussion

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

Testing instructions:

github-actions bot commented May 10, 2024 • edited Loading

github-actions bot commented May 10, 2024

tbradsha May 10, 2024

Choose a reason for hiding this comment

anomiex May 10, 2024

Choose a reason for hiding this comment

tbradsha left a comment

Choose a reason for hiding this comment

tbradsha May 10, 2024

Choose a reason for hiding this comment

anomiex May 10, 2024

Choose a reason for hiding this comment

anomiex left a comment

Choose a reason for hiding this comment

anomiex May 10, 2024

Choose a reason for hiding this comment

github-actions bot commented May 10, 2024 •

edited

Loading