Skip to content

Sync: silence the call to gzinflate #34186

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
Merged
merged 7 commits into from
Nov 24, 2023
Merged

Sync: silence the call to gzinflate #34186

merged 7 commits into from
Nov 24, 2023

Conversation

@bor0
Copy link
Member

@bor0 bor0 commented Nov 17, 2023 •
edited
Loading

Proposed changes:

Silence the call to gzinflate:

  • Can't always assume that the input is a valid compressed string
  • There are no functions that we can use to check if the data is valid
  • WordPress core also uses @gzinflate.

Should fix a few warnings :)

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)?

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

No

Testing instructions:

N/A

@bor0
Silence the call to gzinflate
4e699aa 
- Can't always assume that the input is a valid compressed string
- There are [no functions](https://www.php.net/manual/en/function.gzinflate.php) that we can use to check if the data is valid
- WordPress core also uses `@gzinflate`.
@bor0 bor0 requested a review from fgiannar November 17, 2023 12:41
@github-actions
Copy link
Contributor

github-actions bot commented Nov 17, 2023 •
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 silence-inflate branch.

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

    bin/jetpack-downloader test jetpack silence-inflate

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
Copy link
Contributor

github-actions bot commented Nov 17, 2023 •
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 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.

@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Nov 17, 2023
@bor0 bor0 added [Action] Required Review [Status] Needs Review This PR is ready for review. [Status] Needs Team Review Obsolete. Use Needs Review instead. labels Nov 17, 2023
@github-actions github-actions bot removed the [Status] Needs Review This PR is ready for review. label Nov 17, 2023
@bor0 bor0 removed the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Nov 17, 2023
@github-actions github-actions bot added the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Nov 17, 2023
@bor0 bor0 removed the [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. label Nov 17, 2023
@fgiannar fgiannar added the [Status] Needs Review This PR is ready for review. label Nov 17, 2023
anomiex
anomiex reviewed Nov 17, 2023
View reviewed changes
projects/packages/sync/src/class-json-deflate-array-codec.php Outdated
*/
public function decode( $input ) {
return $this->json_unserialize( gzinflate( base64_decode( $input ) ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_decode
return $this->json_unserialize( @gzinflate( base64_decode( $input ) ) ); // phpcs:ignore
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's not use generic phpcs:ignore. Better to be clear about what exactly we're ignoring.

Also, it seems like it might make more sense to store the result of gzinflate in a variable and check for false so we could skip trying to json_unserialize that.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you! I agree. Addressed these in 436ac0e.

@bor0 bor0 mentioned this pull request Nov 17, 2023
Closed
@jeherve jeherve changed the title Silence the call to gzinflate Sync: silence the call to gzinflate Nov 20, 2023
fgiannar
fgiannar previously approved these changes Nov 23, 2023
View reviewed changes
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 👍

Apologies for the late review. Give me a ping to re-approve after resolving conflicts if needed

@fgiannar fgiannar added [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. and removed [Status] Needs Review This PR is ready for review. [Status] Needs Team Review Obsolete. Use Needs Review instead. labels Nov 23, 2023
fgiannar
fgiannar previously approved these changes Nov 23, 2023
View reviewed changes
@fgiannar fgiannar added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. labels Nov 23, 2023
@bor0 bor0 enabled auto-merge (squash) November 24, 2023 13:24
fgiannar
fgiannar approved these changes Nov 24, 2023
View reviewed changes
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

@bor0 bor0 merged commit 8cd57bf into trunk Nov 24, 2023
@bor0 bor0 deleted the silence-inflate branch November 24, 2023 13:45
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anomiex anomiex anomiex left review comments

@fgiannar fgiannar fgiannar approved these changes

Assignees

No one assigned

Labels

[Action] Required Review [Package] Sync

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bor0 @anomiex @fgiannar