Social Previews: Decode entities in post titles, excerpts, and descriptions

sixhours commented 2 days ago

Fixes https://github.com/Automattic/jetpack/issues/26760

Proposed changes:

Run decodeEntities on post title & description before showing them in the Social Previews panel.
Core seems to encode special characters in post meta while Jetpack does not.
I'm posing this as a proof of concept because I'm concerned it's not as secure as it could be. I see we're using decodeEntities elsewhere in the plugin, so it's probably okay? But I wonder about the potential for XSS issues sneaking through. Answered in comments.

Before

After

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:

Apply this patch to your sandbox and sandbox the API
Create a new post in the editor on a Simple site with a Business plan. Ensure the post title and description include a special character like &
Publish the post
Go to the Jetpack toolbar
Go to Social Previews
Click Preview to see the modal
The special characters should be rendered/decoded rather than showing as encoded (like &)

github-actions[bot] commented 2 days ago

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 fix/decode-entitles-title branch.

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

bin/jetpack-downloader test jetpack fix/decode-entitles-title

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] commented 2 days ago

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.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
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.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

manzoorwanijk commented 1 day ago

I'm posing this as a proof of concept because I'm concerned it's not as secure as it could be. I see we're using decodeEntities elsewhere in the plugin, so it's probably okay? But I wonder about the potential for XSS issues sneaking through.

Thank you for considering that. Since the text is passed to and rendered by React components, it's safe to decode the HTML entities.

sixhours commented 12 hours ago

FYI I'm on vacation next week. If this gets approved before I get back, please feel free to merge on my behalf!

Automattic / jetpack