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.

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

Subscriptions: add block hook to add subscribe block to navigation #37464

Merged
merged 10 commits into from
May 27, 2024
Merged

Subscriptions: add block hook to add subscribe block to navigation #37464

merged 10 commits into from
May 27, 2024

Conversation

simison
Copy link
Member

@simison simison commented May 21, 2024 •
edited

Before merging, whitelist the option on the server side, done at D150073-code

Follow up to:

Proposed changes:

  • Adds a toggle in settings for subscription block hook
  • Adds hook to inject subscription block in the
Screenshot 2024-05-27 at 16 18 02 Screenshot 2024-05-27 at 16 18 34

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:

  • At Jetpack settings -> Newsletters, add URL arg: /wp-admin/admin.php?enable-subscription-navigation=true&page=jetpack#/newsletter
  • See the toggle, enable it
  • See the navigation block in site editor
  • See the navigation block on front of the site

@github-actions github-actions bot added [Feature] WPCOM API [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests Admin Page React-powered dashboard under the Jetpack menu labels May 21, 2024
@github-actions GitHub Actions
Copy link
Contributor

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.

Jetpack plugin:

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

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for June 4, 2024 (scheduled code freeze on June 3, 2024).

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 21, 2024 •
edited

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/subscriber-block-navigation-hook branch.

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

    bin/jetpack-downloader test jetpack add/subscriber-block-navigation-hook

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

@simison simison force-pushed the add/subscriber-block-navigation-hook branch 2 times, most recently from b158a75 to 71156c4 Compare May 27, 2024 12:39
@simison
Copy link
Member Author

simison commented May 27, 2024

@pkuliga Thanks for the good comments! I addressed your feedback

simison
simison commented May 27, 2024
View reviewed changes
projects/plugins/jetpack/extensions/blocks/subscriptions/class-jetpack-subscription-site.php
$is_navigation_anchor_block = isset( $anchor_block['blockName'] ) && $anchor_block['blockName'] === 'core/navigation';

if ( $is_navigation_anchor_block ) {
$class_name = ( ! empty( $hooked_block['attrs'] ) && ! empty( $hooked_block['attrs']['className'] ) )
Copy link
Member Author

Choose a reason for hiding this comment

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

Could be we don't actually need this defence to ensure there wasn't user-defined classname, because when they modify the block it no longer is "hooked"?

Copy link
Contributor

Choose a reason for hiding this comment

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

It might be. It doesn't hurt to have it here but you can test if it's really necessary 😄

@simison
Copy link
Member Author

simison commented May 27, 2024

This PR goes with D150073-code

@simison simison mentioned this pull request May 27, 2024
Merged
3 tasks
pkuliga
pkuliga previously approved these changes May 27, 2024
View reviewed changes
Copy link
Contributor

@pkuliga pkuliga left a comment

Choose a reason for hiding this comment

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

Works well, thanks!

projects/plugins/jetpack/extensions/blocks/subscriptions/class-jetpack-subscription-site.php
$is_navigation_anchor_block = isset( $anchor_block['blockName'] ) && $anchor_block['blockName'] === 'core/navigation';

if ( $is_navigation_anchor_block ) {
$class_name = ( ! empty( $hooked_block['attrs'] ) && ! empty( $hooked_block['attrs']['className'] ) )
Copy link
Contributor

Choose a reason for hiding this comment

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

It might be. It doesn't hurt to have it here but you can test if it's really necessary 😄

@simison simison force-pushed the add/subscriber-block-navigation-hook branch from 24b8470 to e7de3e3 Compare May 27, 2024 14:29
@simison simison added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] In Progress labels May 27, 2024
@simison
Update versions
224f4db 
```
$ tools/fixup-project-versions.sh
```
@simison simison enabled auto-merge (squash) May 27, 2024 16:31
@simison simison merged commit 7066fdb into trunk May 27, 2024
54 checks passed
@simison simison deleted the add/subscriber-block-navigation-hook branch May 27, 2024 16:39
@github-actions github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label May 27, 2024
@github-actions github-actions bot added this to the jetpack/13.5 milestone May 27, 2024
@pkuliga pkuliga mentioned this pull request May 28, 2024
Closed
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kraftbj kraftbj kraftbj approved these changes

@pkuliga pkuliga pkuliga left review comments

Assignees
No one assigned
Labels
Admin Page React-powered dashboard under the Jetpack menu [Block] Subscriptions [Feature] WPCOM API [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests
Projects
None yet
Milestone
jetpack/13.5
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@simison @kraftbj @pkuliga