Subscriptions: add block binding returning subscriber count

[simison]

Adds new block binding API for subscriptions, available in WP 6.5. (Dev note)

With block:

<!-- wp:paragraph {"metadata":{"bindings":{"content":{"source":"jetpack/subscribers","args":{"key":"count"}}}}} -->
<p>Subscribers</p>
<!-- /wp:paragraph -->

You would get in the frontend of the post:

Same text should appear in the editor, but at least for me I just see binding paragraph but no text:

Proposed changes:

• Adds new block binding API for subscriptions, available in WP 6.5

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:

• You need to run WP 6.5 RC for this to work.

[github-actions[bot]]

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 try/block-bindings-api-for-subscriptions branch.

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

  bin/jetpack-downloader test jetpack try/block-bindings-api-for-subscriptions
  

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[bot]]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• :white_check_mark: Include a description of your PR changes.
  
• :white_check_mark: Add a "[Status]" label (In Progress, Needs Team Review, ...).
  
• :white_check_mark: Add testing instructions.
  
• :white_check_mark: Specify whether this PR includes any changes to data or privacy.
  
• :white_check_mark: 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 :robot:

---

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 July 2, 2024 (scheduled code freeze on July 1, 2024).

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

[nerrad]

Same text should appear in the editor, but at least for me I just see binding paragraph but no text:

I think that's expected, the fallback content is what gets displayed in the editor because depending on the source, the rendered value can only be derived from the context. There are exceptions, like your example, since count of subscribers is a global thing but I imagine that's something that could be iterated on upstream.

[simison]

Yeah, I figured the text doesn't show in editor either because of some combo of WP trunk/ Gutenberg trunk I had, or indeed because I'm not actually pulling a post meta but more of a global thing.

This kind of binding would be indeed more useful in site editor templates or pages, rather than in blog posts, anyway.

[retrofox]

If I'm not wrong, you need to register the handler in the client, as core does when registering the core/post-meta handler here.

The action hasn't been exposed and it's usable internally for now 😬

[retrofox]

This kind of binding would be indeed more useful in site editor templates or pages, rather than in blog posts, anyway.

I kind of disagree :-D. I imagine many cases where API can be used in the context of the post editor. For instance, all blocks that pull the data from the post entity (core/post-title, core/post-excerpt, etc) could be replaced by classic blocks (core/paragraph, core/heading) simply by binding the attribute with the proper entity property (tongue twister for free)

[simison]

@retrofox I totally agree with you on those points but I meant for subscriber count specifically, which is the kind of info publishers would be presented outside the post content most of the time. :-)

Example:

[retrofox]

got it now!

[simison]

If I'm not wrong, you need to register the handler in the client, as core does when registering the core/post-meta handler here.

Thanks! Makes sense. I wonder if it would make sense for editor side to just handle that registration automatically, since all the information sort of exists in the backend binding already, and there's the concept of "backend rendered blocks" in the client side already. 🤔

[retrofox]

If I'm not wrong, you need to register the handler in the client, as core does when registering the core/post-meta handler here.

Thanks! Makes sense. I wonder if it would make sense for editor side to just handle that registration automatically, since all the information sort of exists in the backend binding already, and there's the concept of "backend rendered blocks" in the client side already. 🤔

Yeah, do you mean dynamic blocks? For instance, how does the core/post-title pull the data from the entity? It would be nice when registering the source, the register_block_bindings_source() function accepts a parameter to always pull the data from the get_value_callback. Just thinking loud.

[github-actions[bot]]

This PR has been marked as stale. This happened because:

• It has been inactive for the past 3 months.
• It hasn’t been labeled `[Pri] BLOCKER`, `[Pri] High`, etc.

If this PR is still useful, please do a [trunk merge or rebase](https://github.com/Automattic/jetpack/blob/trunk/docs/git-workflow.md#keeping-your-branch-up-to-date) and otherwise make sure it's up to date and has clear testing instructions. You may also want to ping possible reviewers in case they've forgotten about it. Please close this PR if you think it's not valid anymore — if you do, please add a brief explanation.

If the PR is not updated (or at least commented on) in another month, it will be automatically closed.

[github-actions[bot]]

This PR has been marked as stale. This happened because:

• It has been inactive for the past 3 months.
• It hasn’t been labeled `[Pri] BLOCKER`, `[Pri] High`, etc.

If this PR is still useful, please do a [trunk merge or rebase](https://github.com/Automattic/jetpack/blob/trunk/docs/git-workflow.md#keeping-your-branch-up-to-date) and otherwise make sure it's up to date and has clear testing instructions. You may also want to ping possible reviewers in case they've forgotten about it. Please close this PR if you think it's not valid anymore — if you do, please add a brief explanation.

If the PR is not updated (or at least commented on) in another month, it will be automatically closed.