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

Sharing Block: refactor block markup output #35390

Merged
merged 2 commits into from
Feb 1, 2024
Merged

Conversation

jeherve
Copy link
Member

@jeherve jeherve commented Feb 1, 2024

Follow-up to #35354

Proposed changes:

Add extra fallback values, reorganize, and do not rely on global

  • We really only need the post ID, not the full $post object, so we can update the 2 functions to use only the post ID that is pulled from the block context.
  • Let's add some extra fallback values when some values are not provided by the block context.
  • Let's only add the SVG if it is needed in the markup. When folks are using the text-only style, we do not need to output the SVG in the markup.
  • Let's reorganize the markup output to escape as late as possible, and clearly indicate what is escaped and how. It should make it more readable and easier to understand to new contributors.
  • Update docblock to avoid notices in editor

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

  • N/A

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

  • No

Testing instructions:

  • Enable Beta blocks on your site:
add_filter( 'jetpack_blocks_variation', function () {
	return 'beta';
} );
  • Switch to a block-based theme like Twenty Twenty Four
  • Go to Appearance > Site Editor > Templates > Single Posts
  • Add a Sharing block to your template
  • Add different buttons
  • Play with the different settings:
    • Button style
    • Button size
    • Button color (foreground and background)
  • Ensure that your changes are properly displayed on the frontend.
  • Ensure that clicking on the buttons works.
  • Ensure that when reloading the editor screen, no error shows.

Add extra fallback values, reorganize, and do not rely on global

- We really only the post ID, not the full $post object, so we can update the 2 functions to use only the post ID that is pulled from the block context.
- Let's add some extra fallback values when some values are not provided by the block context.
- Let's only add the SVG if it is needed in the markup. When folks are using the text-only style, we do not need to output the SVG in the markup.
- Let's reorganize the markup output to escape as late as possible, and clearly indicate what is escaped and how. It should make it more readable and easier to understand to new contributors.

Update docblock to avoid notices in editor
@jeherve jeherve added [Feature] Sharing Post sharing, sharing buttons [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal [Status] Needs Team Review [Block] Sharing Buttons [Block] Sharing Button labels Feb 1, 2024
@jeherve jeherve self-assigned this Feb 1, 2024
Copy link
Contributor

github-actions bot commented Feb 1, 2024

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 update/sharing-block-markup branch.

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

    bin/jetpack-downloader test jetpack update/sharing-block-markup
    

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

@jeherve jeherve mentioned this pull request Feb 1, 2024
3 tasks
@github-actions github-actions bot added the [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ label Feb 1, 2024
Copy link
Contributor

github-actions bot commented Feb 1, 2024

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 February 6, 2024 (scheduled code freeze on February 5, 2024).

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

Copy link
Contributor

@andrii-lysenko andrii-lysenko left a comment

Choose a reason for hiding this comment

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

Thanks for working on this. It looks great and tests well.

One nitpick, in class-sharing-source-block we have over overriden function get_link in Share_Email_Block which we probably need to update to use $post_id. For some reason it still works even now, but probably better to update.

@jeherve
Copy link
Member Author

jeherve commented Feb 1, 2024

Good call! Done in 5009edc

@jeherve jeherve enabled auto-merge (squash) February 1, 2024 16:01
Copy link
Contributor

@andrii-lysenko andrii-lysenko left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks!

@jeherve jeherve merged commit d42ded4 into trunk Feb 1, 2024
52 checks passed
@jeherve jeherve deleted the update/sharing-block-markup branch February 1, 2024 16:16
@github-actions github-actions bot removed [Status] Needs Team Review [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Feb 1, 2024
@github-actions github-actions bot added this to the jetpack/13.1 milestone Feb 1, 2024
matticbot pushed a commit to Automattic/jetpack-storybook that referenced this pull request Feb 1, 2024
* Sharing Block: refactor block markup output

Add extra fallback values, reorganize, and do not rely on global

- We really only the post ID, not the full $post object, so we can update the 2 functions to use only the post ID that is pulled from the block context.
- Let's add some extra fallback values when some values are not provided by the block context.
- Let's only add the SVG if it is needed in the markup. When folks are using the text-only style, we do not need to output the SVG in the markup.
- Let's reorganize the markup output to escape as late as possible, and clearly indicate what is escaped and how. It should make it more readable and easier to understand to new contributors.

Update docblock to avoid notices in editor

* Move away from $post object in overwritten method as well

See Automattic/jetpack#35390 (review)

Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/7744283095
matticbot pushed a commit to Automattic/jetpack-production that referenced this pull request Feb 1, 2024
* Sharing Block: refactor block markup output

Add extra fallback values, reorganize, and do not rely on global

- We really only the post ID, not the full $post object, so we can update the 2 functions to use only the post ID that is pulled from the block context.
- Let's add some extra fallback values when some values are not provided by the block context.
- Let's only add the SVG if it is needed in the markup. When folks are using the text-only style, we do not need to output the SVG in the markup.
- Let's reorganize the markup output to escape as late as possible, and clearly indicate what is escaped and how. It should make it more readable and easier to understand to new contributors.

Update docblock to avoid notices in editor

* Move away from $post object in overwritten method as well

See Automattic/jetpack#35390 (review)

Committed via a GitHub action: https://github.com/Automattic/jetpack/actions/runs/7744283095
spsiddarthan pushed a commit that referenced this pull request Feb 15, 2024
* Sharing Block: refactor block markup output

Add extra fallback values, reorganize, and do not rely on global

- We really only the post ID, not the full $post object, so we can update the 2 functions to use only the post ID that is pulled from the block context.
- Let's add some extra fallback values when some values are not provided by the block context.
- Let's only add the SVG if it is needed in the markup. When folks are using the text-only style, we do not need to output the SVG in the markup.
- Let's reorganize the markup output to escape as late as possible, and clearly indicate what is escaped and how. It should make it more readable and easier to understand to new contributors.

Update docblock to avoid notices in editor

* Move away from $post object in overwritten method as well

See #35390 (review)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Sharing Button [Block] Sharing Buttons [Feature] Sharing Post sharing, sharing buttons [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants