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

Phan: try using 6.3 stubs #36515

Closed
wants to merge 1 commit into from
Closed

Phan: try using 6.3 stubs #36515

wants to merge 1 commit into from

Conversation

kraftbj
Copy link
Contributor

@kraftbj kraftbj commented Mar 22, 2024

Supports #36514

Does not address how to ensure this is updated when it should be.

Proposed changes:

  • Downgrade stubs to WP 6.3 for Phan.

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

pf4qpu-mj-p2

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

n/a

Testing instructions:

  • jetpack phan when using the trunk version of the two JP files changed by this PR with this PR's version of composer.*

@kraftbj kraftbj added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Pri] Normal [Tools] Monorepo Setup Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. labels Mar 22, 2024
@kraftbj kraftbj self-assigned this Mar 22, 2024
@kraftbj kraftbj requested a review from a team March 22, 2024 03:51
Copy link
Contributor

github-actions bot commented Mar 22, 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 update/phan-stubs-63 branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack update/phan-stubs-63
    

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 bot added [Feature] Google Fonts [Feature] SSO [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Mar 22, 2024
Copy link
Contributor

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 April 2, 2024 (scheduled code freeze on April 1, 2024).

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

*/
public function print_font_faces() {
$fonts = WP_Font_Face_Resolver::get_fonts_from_theme_json();
$fonts = WP_Font_Face_Resolver::get_fonts_from_theme_json(); // // @phan-suppress-current-line PhanUndeclaredClassMethod
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
$fonts = WP_Font_Face_Resolver::get_fonts_from_theme_json(); // // @phan-suppress-current-line PhanUndeclaredClassMethod
$fonts = WP_Font_Face_Resolver::get_fonts_from_theme_json(); // @phan-suppress-current-line PhanUndeclaredClassMethod

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, if this method might not be available, shouldn't we wrap it in a check to prevent errors?

We could also do the same for wp_print_font_faces(), but really we should abort prior to that point.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I didn't since the include is further up the stack after a version check.

Copy link
Contributor

@tbradsha tbradsha left a comment

Choose a reason for hiding this comment

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

Unless I'm missing something, the WP_Font_Face_Resolver::get_fonts_from_theme_json line will throw an error if < WP 6.4.0 (since it doesn't exist, so we'd want to prevent that as well.

@kraftbj
Copy link
Contributor Author

kraftbj commented Mar 22, 2024

Closing to defer to #36530

@kraftbj kraftbj closed this Mar 22, 2024
@kraftbj kraftbj deleted the update/phan-stubs-63 branch March 22, 2024 20:55
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Google Fonts [Feature] SSO [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal Reviewer Can Merge PR author indicates the reviewer is free to merge/deploy if they want to own the change. [Tools] Monorepo Setup [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants