Blog Subscription Widget: deprecate widget and transform to block

[arcangelini]

Changes proposed in this Pull Request:

With the new current widget block editor, the Blog Subscription widget is redundant. The current Subscription Form block already exists and offers the same functions. This PR removes it from the core/legacy-widget and adds the widget to the REST API to allow a block transforms: to be created.

This will preserve the following settings that exist in the block: show_subscribers_total, subscribe_button, subscribe_placeholder.

Jetpack product discussion

Part of the widget => block project #21069

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

Nope

Testing instructions:

• Before switching to this PR, go to Customizer ⇢ Widgets and add Legacy Widget choosing Blog Subscription from the dropdown. Be sure to save changes
• Next switch to this PR and view your customizer.
• You should see that Blog Subscription is no longer an option in the Legacy Widget block.
• Now click the previously added Legacy Blog Subscription and use the Transform button to change to the Subscription Form block.

[matticbot]

Caution: This PR has changes that must be merged to WordPress.com
Hello arcangelini! These changes need to be synced to WordPress.com - If you 're an a11n, please commandeer and confirm D67356-code works as expected before merging this PR. Once this PR is merged, please commit the changes to WP.com. Thank you!
This revision will be updated with each commit to this PR

[github-actions]

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.
  
• ⚠️ All commits were linted before commit.
  
• ✅ 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 (other than "Required review") 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 you’ve done so, switch to the "[Status] Needs Review" label; someone from Jetpack Crew will then review this PR and merge it to be included in the next Jetpack release.

---

Jetpack plugin:

• Next scheduled release: November 2, 2021.
• Scheduled code freeze: October 25, 2021.

[arcangelini]

The WPCOM test will fail due to the check against widget_types_to_hide_from_legacy_widget_block. After this PR is ready to merge I will add the widget instance to the array in WPCOM test.

Also, the Subscription Form block does not appear to have a section for a success message. Am I missing that somewhere, or is this not a setting available?

[jeherve]

the Subscription Form block does not appear to have a section for a success message. Am I missing that somewhere, or is this not a setting available?

We did not implement that setting for the block yet. I logged this here:
#21187

[arcangelini]

Rebased and removed widget from Legacy block. Tested and everything is working great.

[jeherve]

This works well for me. Do you think we could also keep the widget title, in a heading block?

[amustaque97]

@arcangelini 👋 have you tried changing it to some different custom string!
Example: submitButtonText: 'Subscribe to my newsletter'.
I tried something similar but it is not working for me somehow! 😞 submitButtonText value is set to default value that you mentioned in the attributes.js file
Can you please try at your end and confirm?
Thanks

[arcangelini]

Yeah, if you look at my last screenshot it shows the placeholder text as "Placeholder" and the submit button as "Button".

I can test again though!

[amustaque97]

I'm trying to understand what this block of code does?

return createBlock( 'jetpack/subscriptions', {
    showSubscribersTotal: instance.raw.show_subscribers_total,
    submitButtonText: instance.raw.subscribe_button,
    subscribePlaceholder: instance.raw.subscribe_placeholder,
} );

If you see in the screenshot, I have commented default value of submitButtonText and if it has to read the value from index.js file instance.raw.subscribe_button then I have given some hard coded value custom button value which is not getting reflected. Button text is empty actually.

[amustaque97]

@arcangelini, no need to test it again. It is working as expected. I understand now when that block of code is going to run.
Thank You 😄

[arcangelini]

@jeherve I could, but the problem we have run into is that this heading block doesn't not get placed immediately above the subscription block. The only way to get it to do this would be using a Group block, but due to the way Gutenberg checks the transforms output we can not transform directly to a group block.

In the future, I think there will be a Widget group block to transform to, but this has not gone live in core yet so I have opted to not use this.

This is what it looks like:

[sdixon194]

This works for me! Shame we don't have an option for transforming to a group block just yet (maybe we can open an issue to track that when it's available) but not sure that's a blocker for this PR. What do you think @jeherve ?

[jeherve]

Thanks for the explanation. Let's move forward without the titles then! 👍

[arcangelini]

🥳 Deployed to WPCOM r233512-wpcom

[github-actions]

Great news! One last step: head over to your WordPress.com diff, D67356-code, and commit it.
Once you've done so, come back to this PR and add a comment with your changeset ID.

Thank you!