Skip to content

🐛Fixed mis-encoded apostrophes in emailed paywall #23121

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 1, 2025
Merged

🐛Fixed mis-encoded apostrophes in emailed paywall #23121

merged 2 commits into from
May 1, 2025

Conversation

cathysarisky
Copy link
Member

When I wrapped the emailed paywall a few weeks ago, I missed a spot that needed {{{ }}} to preserve the encoding of apostophes. This two-character PR fixes that.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 30, 2025 •
edited
Loading

Walkthrough

The change updates the paywall email template by altering how the translation helper is invoked for a paragraph of text. Specifically, it replaces the use of double curly braces {{t ...}}, which escape HTML, with triple curly braces {{{t ...}}}, which render the translation output as raw, unescaped HTML. This modification affects only the rendering behavior of the translated content within that paragraph, allowing any embedded HTML in the translation string to be output directly. No other aspects of the template, such as its structure, styling, or other content, were modified. There are no changes to exported or public entities in the codebase.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d571068 and 123c90b.

📒 Files selected for processing (1)
  • ghost/email-service/lib/email-templates/partials/paywall.hbs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: Ghost-CLI tests
  • GitHub Check: Unit tests (Node 22.13.1)
  • GitHub Check: Unit tests (Node 20.11.1)
  • GitHub Check: Regression tests (Node 20.11.1, sqlite3)
  • GitHub Check: Database tests (Node 20.11.1, sqlite3)
  • GitHub Check: Regression tests (Node 20.11.1, mysql8)
  • GitHub Check: Database tests (Node 22.13.1, mysql8)
  • GitHub Check: Database tests (Node 20.11.1, mysql8)
  • GitHub Check: Lint
🔇 Additional comments (1)
ghost/email-service/lib/email-templates/partials/paywall.hbs (1)

7-7: Good fix for the apostrophe encoding issue.

This change correctly addresses the issue of mis-encoded apostrophes by switching from double curly braces {{t ...}} to triple curly braces {{{t ...}}}. In Handlebars templates, double curly braces HTML-escape their content while triple curly braces render the raw, unescaped HTML. This change allows apostrophes in the translation string to be rendered correctly.

The PR perfectly implements the fix for the specific issue mentioned in the PR objectives.

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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

@cathysarisky cathysarisky changed the title 🐛Fix mis-encoded apostrophes in emailed paywall 🐛Fixed mis-encoded apostrophes in emailed paywall Apr 30, 2025
ErisDS
ErisDS approved these changes May 1, 2025
View reviewed changes
Copy link
Member

@ErisDS ErisDS left a comment

Choose a reason for hiding this comment

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

Would obviously be great to do some testing here, but I have no idea how big the lift is.

I think you have more context for the 2 char change than anyone, and I'm happy for you to make and merge fixes to changes you made :)

@cathysarisky cathysarisky merged commit 9114c98 into TryGhost:main May 1, 2025
26 checks passed
@coderabbitai coderabbitai bot mentioned this pull request May 1, 2025
Merged
cathysarisky added a commit that referenced this pull request May 1, 2025
@cathysarisky
✅Added new tests for email encoding related to i18n (#23145)
bf64591 
ref #23121
* Added additional tests to cover the newly-translated paywall and bugfix.
* Apostrophes in strings are worth explicitly testing, because double-encoding is too easy to do.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ErisDS ErisDS ErisDS approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cathysarisky @ErisDS