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

Jetpack: Replace HEREDOC syntax with strings #37396

Merged
merged 3 commits into from
May 20, 2024

Conversation

bindlegirl
Copy link
Contributor

@bindlegirl bindlegirl commented May 15, 2024

Fixes https://github.com/Automattic/vulcan/issues/336

Proposed changes:

  • Replaced HEREDOC syntax with multiline strings.

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:

  • Does it make sense?
  • Does it break anything (logo or module syncing)?

Copy link
Contributor

github-actions bot commented May 15, 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/heredoc-replacements 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 update/heredoc-replacements
    
    bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/heredoc-replacements
    

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 May 15, 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.


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.

@bindlegirl bindlegirl marked this pull request as ready for review May 15, 2024 09:38
@bindlegirl bindlegirl requested a review from a team May 15, 2024 09:38
@bindlegirl bindlegirl added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] In Progress labels May 15, 2024
@bindlegirl bindlegirl force-pushed the update/heredoc-replacements branch from c64a38f to 7847fc1 Compare May 17, 2024 15:22
Copy link
Contributor

@coder-karen coder-karen left a comment

Choose a reason for hiding this comment

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

I both checked the JP logo on a test site and changed modules then scheduled a checksum and fix with the Jetpack debugger, and that had no issues, but I'm not so familiar with sync so perhaps there is a better way to do that?

Also, you should be able to remove the disabled sniff PEAR.Functions.FunctionCallSignature.Indent just by indenting the SQL in those two blocks by three tabs :) (unless of course that affects functionality somehow, I can't see how it would from similar searches)

@fgiannar
Copy link
Contributor

I both checked the JP logo on a test site and changed modules then scheduled a checksum and fix with the Jetpack debugger, and that had no issues, but I'm not so familiar with sync so perhaps there is a better way to do that?

The changes are related with the Full Sync behaviour, so we can test this when the PR is ready for another review by triggering a Full Sync of all modules via the JB Debugger's Full Sync section :)

@fgiannar fgiannar added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels May 20, 2024
@bindlegirl
Copy link
Contributor Author

Thanks for checking it out @coder-karen ! I indented the SQL code as you suggested and tested the Full Sync as @fgiannar suggested.

@bindlegirl bindlegirl added [Status] Needs Review To request a review from Crew. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels May 20, 2024
Copy link
Contributor

@fgiannar fgiannar left a comment

Choose a reason for hiding this comment

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

LGTM 🚢

@fgiannar fgiannar added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from Crew. Label will be renamed soon. labels May 20, 2024
@bindlegirl bindlegirl merged commit f8ac1b6 into trunk May 20, 2024
73 checks passed
@bindlegirl bindlegirl deleted the update/heredoc-replacements branch May 20, 2024 12:38
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants