Skip to content

Conversation

jkmassel
Copy link
Contributor

@jkmassel jkmassel commented Sep 15, 2025

When the Jetpack endpoint types are listed, some are encoded like:

{"description":"Enable automatic rules - Protect your site against untrusted traffic sources with automatic security rules.","type":"boolean","default":false,"required":false}

while others are encoded like:

{"description":"Allow list - Allow a specific request IP.","type":"boolean","default":0,"required":false}

Typed JSON parsers will encode default: 0 as an integer, not a boolean so the type matters here.

This patch properly types these endpoint arguments.

Proposed changes:

  • Uses the proper types for endpoint arguments.

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?

No.

Testing instructions:

  • Install the plugin on a test site
  • Visit /wp-json
  • Validate that the jetpack_waf_ip_allow_list_enabled argument has a default of false, not 0

Copy link
Contributor

github-actions bot commented Sep 15, 2025

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 WoA dev 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 (Jetpack), and enable the fix/endpoint-boolean-arg-types branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack fix/endpoint-boolean-arg-types

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 [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress labels Sep 15, 2025
Copy link
Contributor

github-actions bot commented Sep 15, 2025

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 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 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!


Jetpack plugin:

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

  • WordPress.com Simple releases happen as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: October 7, 2025
    • Code freeze: October 6, 2025

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

@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 Sep 15, 2025
Copy link

jp-launch-control bot commented Sep 15, 2025

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

When the Jetpack endpoint types are listed, some are encoded like:

```
{"description":"Enable automatic rules - Protect your site against untrusted traffic sources with automatic security rules.","type":"boolean","default":false,"required":false}
```

while others are encoded like:

```
{"description":"Allow list - Allow a specific request IP.","type":"boolean","default":0,"required":false}
```

Typed JSON parsers will encode `default: 0` as an integer, not a boolean so the type matters here.

This patch properly types these endpoint arguments.
@jkmassel jkmassel force-pushed the fix/endpoint-boolean-arg-types branch from 7843150 to e933bdb Compare September 15, 2025 21:44
@jkmassel jkmassel marked this pull request as ready for review September 17, 2025 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant