Strip <p> tags from sponsorLabel in CallToActionNode renderer

[ronaldlangeveld]

ref https://linear.app/ghost/issue/PLG-370/fix-sponsor-label-rendering-on-web

• Modified renderCallToActionNode in calltoaction-renderer.js to clean dataset.sponsorLabel using buildCleanBasicHtmlForElement with firstChildInnerContent: true, ensuring <p> tags are removed before rendering.
• Updated buildCleanBasicHtmlForElement.js to accept additionalOptions, merging them with the default createDocument option to support firstChildInnerContent and maintain flexibility.
• Added test in call-to-action.test.js to verify .kg-cta-sponsor-label has <span> as its first child without <p> tags, ensuring correct rendering behavior.

Fixes sponsor label rendering issue where <p> tags persisted in output.

[coderabbitai]

Walkthrough

The pull request updates the call-to-action node’s rendering logic by incorporating HTML cleaning for the sponsor label. A new import statement brings in the buildCleanBasicHtmlForElement function, which is used inside renderCallToActionNode to conditionally clean the dataset.sponsorLabel when a sponsor label exists. The cleaning function now accepts an additional options parameter, increasing its configurability. The modified flow ensures that the cleaned HTML is used when generating the final HTML string via the ctaCardTemplate. Additionally, a new test case has been added to verify that the rendering of the sponsor label produces the expected HTML structure (a <span> element without an enclosing <p> tag).

Possibly related PRs

• Updated html markup for CTA card frontend rendering #1442 – Alters the renderCallToActionNode function, directly paralleling the modifications in this PR.
• Added editable Sponsored Label to CTA Card #1443 – Focuses on changes to sponsor label handling within the call-to-action rendering logic, aligning with the new conditional cleaning process.
• Added CTA Card import serialization #1430 – Modifies the buildCleanBasicHtmlForElement function, impacting the same HTML cleaning process applied to the sponsor label.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/kg-default-nodes/lib/utils/build-clean-basic-html-for-element.js

Oops! Something went wrong! :(

ESLint: 8.57.0

Error: Failed to load parser '@babel/eslint-parser' declared in 'packages/kg-default-nodes/.eslintrc.js': Cannot find module '@babel/eslint-parser'
Require stack:

• /packages/kg-default-nodes/.eslintrc.js
  at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
  at Function.resolve (node:internal/modules/helpers:145:19)
  at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
  at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
  at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
  at _normalizeObjectConfigDataBody.next ()
  at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
  at _normalizeObjectConfigData.next ()
  at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
  at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

packages/kg-default-nodes/lib/nodes/call-to-action/calltoaction-renderer.js

Oops! Something went wrong! :(

ESLint: 8.57.0

Error: Failed to load parser '@babel/eslint-parser' declared in 'packages/kg-default-nodes/.eslintrc.js': Cannot find module '@babel/eslint-parser'
Require stack:

• /packages/kg-default-nodes/.eslintrc.js
  at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
  at Function.resolve (node:internal/modules/helpers:145:19)
  at Object.resolve (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2346:46)
  at ConfigArrayFactory._loadParser (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3325:39)
  at ConfigArrayFactory._normalizeObjectConfigDataBody (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3099:43)
  at _normalizeObjectConfigDataBody.next ()
  at ConfigArrayFactory._normalizeObjectConfigData (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3040:20)
  at _normalizeObjectConfigData.next ()
  at ConfigArrayFactory.loadInDirectory (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:2886:28)
  at CascadingConfigArrayFactory._loadConfigInAncestors (/node_modules/@eslint/eslintrc/dist/eslintrc.cjs:3871:46)

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.

---

📜 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 75b8d0d and e64855b.

📒 Files selected for processing (3)

• packages/kg-default-nodes/lib/nodes/call-to-action/calltoaction-renderer.js (3 hunks)
• packages/kg-default-nodes/lib/utils/build-clean-basic-html-for-element.js (1 hunks)
• packages/kg-default-nodes/test/nodes/call-to-action.test.js (1 hunks)

🔇 Additional comments (6)

packages/kg-default-nodes/lib/utils/build-clean-basic-html-for-element.js (2)

4-4: Good enhancement to function flexibility

The function now accepts additional options, making it more versatile for different use cases while maintaining backward compatibility with existing code.

---

10-11: Clean implementation of options merging

The spread operator correctly merges the additional options with the default options, allowing consumers to override or extend the default behavior.

packages/kg-default-nodes/test/nodes/call-to-action.test.js (1)

384-391: Good test coverage for the new functionality

This test case effectively verifies that the rendering of the sponsor label produces the expected HTML structure without the <p> tag, which directly validates the PR's objective.

packages/kg-default-nodes/lib/nodes/call-to-action/calltoaction-renderer.js (3)

5-5: Appropriate import for the HTML cleaning functionality

The import statement correctly brings in the function needed to strip <p> tags from the sponsor label.

---

237-241: Effective implementation of sponsor label cleaning

The conditional check ensures the cleaning only happens when a sponsor label exists, and the firstChildInnerContent: true option correctly extracts the inner content from the first child element, addressing the issue with <p> tags.

---

242-242: Logical flow of operations

Moving the htmlString declaration after cleaning the sponsor label ensures that the template uses the cleaned data, maintaining the correct execution order.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.