fix: convert BR tags to proper markdown line breaks in event description #22682

rahulrshetty45 · 2025-07-23T02:56:13Z

fix: convert BR tags to proper markdown line breaks in event descriptions

Changed tags to convert to ' \n' (markdown soft break) instead of literal ''
Changed to convert to '\n\n' (markdown paragraph break)
Added cleanup for excessive newlines and trailing whitespace
Fixes validation errors when event descriptions contain line breaks

This ensures HTML tags are not preserved in markdown content, preventing "The request failed schema validation" errors.

What does this PR do?

This PR fixes a validation error that occurs when event descriptions contain
tags. The turndown service was preserving
tags as literal HTML strings within markdown content, which was
causing schema validation failures. Now, these tags are properly converted to markdown-compliant line breaks.

Fixes "The request failed schema validation" when meeting description contains #22681 (GitHub issue number)

Visual Demo (For contributors especially)

Image Demo (if applicable):

Before: When users press Shift+Enter in the editor, it creates
tags that get sent as "Line 1
Line 2" causing validation errors.

After: The same input is now converted to proper markdown: "Line 1 \nLine 2" (two spaces + newline), which passes validation.

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
I have updated the developer docs in /docs if this PR makes changes that would require a https://cal.com/docs. If N/A, write N/A here and check the checkbox. N/A
I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

Create or edit an event type
In the description field, type some text and press Shift+Enter to create a line break
Add more text after the line break
Save the event type
Expected: The event type saves successfully without validation errors
Before fix: Would show "The request failed schema validation" error

Alternative test:

Create multi-line descriptions using the rich text editor
Ensure line breaks are preserved when viewing the event type
Verify no HTML tags appear in the saved description

Checklist

I have read the https://github.com/calcom/cal.com/blob/main/CONTRIBUTING.md
My code follows the style guidelines of this project
I have commented my code, particularly in hard-to-understand areas
I have checked if my changes generate no new warnings

Fixes #22681

…ions - Changed tags to convert to ' \n' (markdown soft break) instead of literal ' ' - Changed to convert to '\n\n' (markdown paragraph break) - Added cleanup for excessive newlines and trailing whitespace - Fixes validation errors when event descriptions contain line breaks This ensures HTML tags are not preserved in markdown content, preventing "The request failed schema validation" errors. Fixes calcom#22681

vercel · 2025-07-23T02:56:19Z

@rahulrshetty45 is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

CLAassistant · 2025-07-23T02:56:20Z

All committers have signed the CLA.

coderabbitai · 2025-07-23T02:56:20Z

Walkthrough

The changes update the post-processing logic in the turndown function of packages/lib/turndownService.ts. Instead of removing or replacing specific HTML string patterns such as " ", the function now collapses any sequence of three or more newlines into two and trims trailing spaces or tabs at the end of each line. Additionally, the two custom Turndown rules for handling   elements were modified: the shift+enter rule now outputs two spaces and a newline (" \n"), and the normal enter rule now outputs two newlines ("\n\n"), both replacing previous HTML string replacements.

Estimated code review effort

2 (~15 minutes)

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/lib/turndownService.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-playwright".

(The package "eslint-plugin-playwright" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-playwright@latest --save-dev

The plugin "eslint-plugin-playwright" was referenced from the config file in ".eslintrc.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

📜 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 fa47456 and c40c7e3.

📒 Files selected for processing (1)

packages/lib/turndownService.ts (3 hunks)

📓 Path-based instructions (1)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/review.mdc)

Flag excessive Day.js use in performance-critical code. Functions like .add, .diff, .isBefore, and .isAfter are slow, especially in timezone mode. Prefer .utc() for better performance. Where possible, replace with native Date and direct .valueOf() comparisons for faster execution. Recommend using native methods or Day.js .utc() consistently in hot paths like loops.

Files:

packages/lib/turndownService.ts

🧰 Additional context used

📓 Path-based instructions (1)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit Inference Engine (.cursor/rules/review.mdc)

Flag excessive Day.js use in performance-critical code. Functions like .add, .diff, .isBefore, and .isAfter are slow, especially in timezone mode. Prefer .utc() for better performance. Where possible, replace with native Date and direct .valueOf() comparisons for faster execution. Recommend using native methods or Day.js .utc() consistently in hot paths like loops.

Files:

packages/lib/turndownService.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

GitHub Check: Install dependencies / Yarn install & cache
GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (3)

packages/lib/turndownService.ts (3)

7-12: LGTM! Improved cleanup approach.

The new general cleanup logic is more robust than the previous string replacement approach. The regex patterns correctly handle:

Collapsing excessive newlines while preserving paragraph breaks

Trimming trailing whitespace without affecting intentional line breaks

This change aligns well with the PR objective of proper markdown formatting.

22-22: LGTM! Correct markdown soft line break implementation.

The change from " " to " \n" properly implements markdown soft line breaks according to the CommonMark specification. This directly addresses the HTML tag preservation issue mentioned in the PR objectives.

31-31: LGTM! Correct markdown paragraph break implementation.

The change from " " to "\n\n" properly implements markdown paragraph breaks. Combined with the shift+enter rule, this creates a coherent system where:

Normal enter → paragraph break (\n\n)

Shift+enter → soft line break ( \n)

This resolves the HTML tag preservation issue and aligns with markdown standards.

✨ Finishing Touches

📝 Generate Docstrings

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

graphite-app · 2025-07-23T03:00:11Z

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (07/23/25)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add community label" took an action on this PR • (07/23/25)

1 label was added to this PR based on Keith Williams's automation.

kart1ka · 2025-07-23T04:23:26Z

Hi @rahulrshetty45, Thanks for the PR. Could you pls attach a loom video showing before and after your fix?

github-actions · 2025-08-07T00:27:47Z

This PR is being marked as stale due to inactivity.

graphite-app bot requested a review from a team July 23, 2025 02:56

graphite-app bot added the community Created by Linear-GitHub Sync label Jul 23, 2025

github-actions bot added calendar-apps area: calendar, google calendar, outlook, lark, microsoft 365, apple calendar emails area: emails, cancellation email, reschedule email, inbox, spam folder, not getting email 🐛 bug Something isn't working labels Jul 23, 2025

github-actions bot added the Stale label Aug 7, 2025

kart1ka marked this pull request as draft August 7, 2025 04:20

github-actions bot removed the Stale label Aug 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: convert BR tags to proper markdown line breaks in event description #22682

fix: convert BR tags to proper markdown line breaks in event description #22682

rahulrshetty45 commented Jul 23, 2025 •

edited

Loading

Uh oh!

vercel bot commented Jul 23, 2025

Uh oh!

CLAassistant commented Jul 23, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 23, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

graphite-app bot commented Jul 23, 2025

Uh oh!

kart1ka commented Jul 23, 2025

Uh oh!

github-actions bot commented Aug 7, 2025

Uh oh!

Uh oh!

fix: convert BR tags to proper markdown line breaks in event description #22682

Are you sure you want to change the base?

fix: convert BR tags to proper markdown line breaks in event description #22682

Conversation

rahulrshetty45 commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Jul 23, 2025

Uh oh!

CLAassistant commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Estimated code review effort

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

graphite-app bot commented Jul 23, 2025

Graphite Automations

Uh oh!

kart1ka commented Jul 23, 2025

Uh oh!

github-actions bot commented Aug 7, 2025

Uh oh!

Uh oh!

rahulrshetty45 commented Jul 23, 2025 •

edited

Loading

CLAassistant commented Jul 23, 2025 •

edited

Loading

coderabbitai bot commented Jul 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)