Skip to content

Newsletter Settings: fix REST API bug #44152

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

Open
wants to merge 6 commits into
base: trunk
Choose a base branch
from

Conversation

arcangelini
Copy link
Contributor

@arcangelini arcangelini commented Jul 1, 2025

Fixes CML-621

Proposed changes:

  • If newsletter category is not associative array ( $newsletter_category['term_id'] ) then return the value.

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

p1751296364493759-slack-C03NLNTPZ2T

Currently on Simple sites we are saving newsletter category ID's as array of objects with term_id's this is being handled in WPCOM_JSON_API_Site_Settings_Endpoint. However the Jetpack/Atomic setting is saving it as a flat array of integers in Jetpack_Core_API_Data.n This is causing a mismatch and leading the PHP warnings.

This PR will add a case to convert the array to the proper format.

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

No

Testing instructions:

  1. Apply this change to an Atomic site
  2. Go to Newsletter Settings page wordpress.com/settings/newsletter/[YOUR_SITE]
  3. Enable the "Enable newsletter categories" toggle and check some categories
  4. Save settings
  5. Go to https://developer.wordpress.com/docs/api/console/
  6. Query the settings from WP.COM API ⇢ v1.4 ⇢ GET ⇢ /sites/$site-slug/settings and look for wpcom_newsletter_categories in the results.
Before After
Screen Shot 2025-06-30 at 23 03 10 Screen Shot 2025-06-30 at 23 01 07

@arcangelini arcangelini self-assigned this Jul 1, 2025
Copy link
Contributor

github-actions bot commented Jul 1, 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/newsletter-category-php-warnings branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack fix/newsletter-category-php-warnings

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] WPCOM API [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ labels Jul 1, 2025
Copy link
Contributor

github-actions bot commented Jul 1, 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: August 5, 2025
    • Code freeze: August 4, 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 Jul 1, 2025
@arcangelini arcangelini added [Status] Needs Review This PR is ready for review. Bug 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 Jul 1, 2025
@github-actions github-actions bot 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. labels Jul 1, 2025
Copy link

jp-launch-control bot commented Jul 1, 2025

Code Coverage Summary

Coverage changed in 1 file.

File Coverage Δ% Δ Uncovered
projects/plugins/jetpack/_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php 163/891 (18.29%) -0.52% 29 💔

Full summary · PHP report · JS report

If appropriate, add one of these labels to override the failing coverage check: Covered by non-unit tests Use to ignore the Code coverage requirement check when E2Es or other non-unit tests cover the code Coverage tests to be added later Use to ignore the Code coverage requirement check when tests will be added in a follow-up PR I don't care about code coverage for this PR Use this label to ignore the check for insufficient code coveage.

@arcangelini arcangelini requested a review from a team July 1, 2025 04:05
@jeherve jeherve added [Type] Bug When a feature is broken and / or not performing as intended [Status] Needs Review This PR is ready for review. 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 Jul 1, 2025
return $newsletter_category['term_id'];
return $newsletter_category['term_id'] ?? $newsletter_category;
Copy link
Member

Choose a reason for hiding this comment

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

I wonder if we should also do some check / casting on $newsletter_category, or can we always expect it to be in the right format?

@jeherve jeherve added [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Pri] Normal and removed [Status] Needs Review This PR is ready for review. labels Jul 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug [Feature] WPCOM API [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Status] Needs Author Reply We need more details from you. This label will be auto-added until the PR meets all requirements. [Type] Bug When a feature is broken and / or not performing as intended
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants