Ghost icon indicating copy to clipboard operation
Ghost copied to clipboard

fix: remove partial HTML entity in excerpt

Open im-adithya opened this issue 8 months ago • 2 comments

Fixes https://github.com/TryGhost/Ghost/issues/21955

Description

We cannot remove the escape since it has been added for preventing XSS attacks here: https://github.com/TryGhost/Ghost/pull/17190

So I just added a check to see if the text ends with ampersand and only consider till there.

Screenshots

Screenshot 2025-03-16 at 11 59 39 PM Screenshot 2025-03-16 at 11 59 11 PM

Checklist

  • [x] There's a clear use-case for this code change, explained below
  • [x] Commit message has a short title & references relevant issues
  • [x] The build will pass (run yarn test:all and yarn lint)

im-adithya avatar Mar 16 '25 18:03 im-adithya

Walkthrough

The changes modify the logic within the excerpt function to handle improperly formatted HTML entities. Instead of immediately returning the result as a SafeString, the function now stores the output of the excerpt retrieval in a variable. It then checks the stored result for any ampersand that is not immediately followed by a semicolon. If such a case is detected, the code truncates the excerpt at the last occurrence of the ampersand to avoid returning a malformed HTML entity. Finally, the cleaned result is wrapped in a new SafeString and returned. No changes were made to any exported or public entity declarations.

Assessment against linked issues

Objective Addressed Explanation
Correct handling of incomplete HTML entities in excerpt (#21955)

[!TIP]

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments. - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Mar 16 '25 18:03 coderabbitai[bot]

@vershwal can you please have a look :D

im-adithya avatar Mar 17 '25 11:03 im-adithya

Hi @im-adithya, I'm aware you made several updates a few months ago, but most of them didn't have tests. As I explained in this comment we don't accept PRs without tests. I've left this open for a bit in case you wanted to update it but am having a bit of a clear out today.

You're welcome to re-open the PR with tests anytime and we can look to review it!

ErisDS avatar Aug 04 '25 10:08 ErisDS