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

Subscriptions: allow pre-selecting newsletter categories in block settings #41567

Merged
merged 17 commits into from
Feb 12, 2025

Conversation

holdercp
Copy link
Contributor

@holdercp holdercp commented Feb 5, 2025

Closes Automattic/loop#378

New to block development and Jetpack so please review with a critical eye.

Works in concert with 172401-gh-Automattic/wpcom

Proposed changes:

  • Adds new options in the Subscriptions block settings that will allow site owners to select newsletter categories that this subscription form will automatically subscribe users to
  • These selected categories will be exposed to the subscription form so the category selection modal can be bypassed when this new option is enabled
image

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

  • pe7F0s-2tV-p2 (current project)
  • pe7F0s-2t7-p2 (abandoned project but has some of the discussion around this change)

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

Testing instructions:

  • Follow documentation to checkout this branch on your sandbox
  • Enable Newsletter Categories for your site and add a few
  • Add a Subscribe block to a post
  • In the Subscribe settings sidebar, under Settings, verify the new "Pre-select Categories" toggle works as expected
    • If enabled, you should be able to selected specific categories for the block
    • If disabled, you should not be able selected specific categories and they should be hidden
    • If enabled but all categories become unselected, it will become disabled automatically
    • Make sure when you save the block and visit it again the settings persist
    • Test that existing Subscribe blocks do not regress.
  • These block settings have no effect currently but you can verify the correct category ids are being selected by examining the markup from the block. There will be a hidden input with the selected ids named selected_newsletter_categories

@holdercp holdercp self-assigned this Feb 5, 2025
Copy link
Contributor

github-actions bot commented Feb 5, 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 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 add/newsletter-cats-to-sub-block branch.

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

    bin/jetpack-downloader test jetpack add/newsletter-cats-to-sub-block
    

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

github-actions bot commented Feb 5, 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 Team 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 🤖


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.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? 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 semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

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 Feb 5, 2025
@holdercp holdercp added the [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it label Feb 5, 2025
Copy link
Contributor

github-actions bot commented Feb 5, 2025

Code Coverage Summary

Coverage changed in 5 files.

File Coverage Δ% Δ Uncovered
projects/plugins/jetpack/extensions/blocks/subscriptions/subscriptions.php 10/622 (1.61%) -0.01% 4 💔
projects/plugins/jetpack/extensions/blocks/subscriptions/controls.js 19/24 (79.17%) 4.17% 1 💔
projects/plugins/jetpack/extensions/blocks/subscriptions/view.js 0/43 (0.00%) 0.00% 1 💔
projects/plugins/jetpack/extensions/blocks/subscriptions/edit.js 45/54 (83.33%) 0.98% 0 💚
projects/plugins/jetpack/extensions/store/membership-products/resolvers.js 65/106 (61.32%) 8.49% -9 💚

Full summary · PHP report · JS report

@holdercp holdercp 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 Feb 5, 2025
@holdercp
Copy link
Contributor Author

holdercp commented Feb 6, 2025

This will need to be released after backend changes are in place. Leaving as draft for now but I would love a review to catch any obvious issues that will need to be addressed.

@holdercp holdercp added the [Status] Needs Team Review Obsolete. Use Needs Review instead. label Feb 6, 2025
@holdercp holdercp force-pushed the add/newsletter-cats-to-sub-block branch from 52a99c9 to b4c974d Compare February 7, 2025 22:47
@holdercp holdercp force-pushed the add/newsletter-cats-to-sub-block branch from b4c974d to 97ca4c2 Compare February 7, 2025 22:55
@holdercp holdercp marked this pull request as ready for review February 7, 2025 23:13
Copy link
Contributor

@eoigal eoigal left a comment

Choose a reason for hiding this comment

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

One thing I noticed is that when I unchecked all categories, the pre-select option didn't uncheck as I expected.

Screenshot 2025-02-08 at 20 12 01

@holdercp
Copy link
Contributor Author

@eoigal Good suggested improvement. I've added it in 28bf74f.

@holdercp holdercp added the [Status] Needs Review This PR is ready for review. label Feb 11, 2025
Copy link
Contributor

@eoigal eoigal left a comment

Choose a reason for hiding this comment

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

WFM, nice job!

@holdercp holdercp merged commit f495e5c into trunk Feb 12, 2025
67 checks passed
@holdercp holdercp deleted the add/newsletter-cats-to-sub-block branch February 12, 2025 18:01
@github-actions github-actions bot removed [Status] Needs Review This PR is ready for review. [Status] Needs Team Review Obsolete. Use Needs Review instead. labels Feb 12, 2025
@jeherve
Copy link
Member

jeherve commented Feb 13, 2025

@holdercp I'm coming to this PR late, sorry, but I had a question about the user experience. Are you planning on updating the Jetpack settings in Jetpack > Settings > Newsletter to expand the Newsletter categories a bit? Right now, I don't think it's very clear that you can enable newsletter categories, and then have different groups of subscribers depending on the different subscribe blocks you set up on your site:

Screenshot 2025-02-13 at 19 45 30

I wonder if it would also be worth updating the subscription modal as well. Right now it's not very clear what you're subscribing to with the different options:

Screenshot 2025-02-13 at 19 20 00

Overall I think it's a great and useful new feature, we're essentially introducing a way to have multiple subscription lists on a single site, but I don't think we currently highlight that at all anywhere.

@holdercp
Copy link
Contributor Author

@jeherve Those are great observations. I think the corresponding wpcom settings could be more clear as well:
image

Regarding the modal, I believe the idea is that the topic/category selection is abstracted away from the visitor and has already been pre-selected by the author. For example, an author could configure the subscribe blocks on their posts related to "Cooking" to automatically subscribe visitors subscribing via those blocks to the "Cooking" category.

There is a "Select which topics to subscribe to" screen in the modal flow, which will show up when newsletter categories are enabled and that is the default experience. Only when authors configure a subscribe block to automatically subscribe visitors to specific categories will that screen in the modal be skipped.

@davemart-in We don't really have a good "link" to the subscribe block feature from these settings screens. It's not very clear that visitors will get to choose which categories they want to subscribe to (in the default case, through the modal screen) or that authors can now pre-select specific categories that visitors will be automatically subscribed to if they configure the block to do so.

Maybe a copy update and a link to the subscribe block documentation might suffice here? What do you think?

@davemart-in
Copy link
Contributor

I like that idea @holdercp. What do you think of updating the test to read:

Newsletter categories let visitors subscribe to specific topics. When enabled, only posts in the selected categories will be emailed. By default, subscribers can choose from your selected categories, or you can pre-select categories in the subscribe block.

@holdercp
Copy link
Contributor Author

holdercp commented Feb 18, 2025

@davemart-in

Sounds great. I'll create some tickets.

Edit: ticket

@zinigor zinigor added this to the jetpack/14.4 milestone Feb 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Subscriptions [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests [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.

5 participants