-
-
Notifications
You must be signed in to change notification settings - Fork 3.1k
fix(markdown): never parse to an empty document (fixes setContent crash) #8017
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.
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
Open
codewithsupra
wants to merge
10
commits into
ueberdosis:main
Choose a base branch
from
codewithsupra:fix/markdown-whitespace-empty-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
a3e7d4c
fix(markdown): never parse to an empty document (fixes setContent crash)
codewithsupra 06f37b5
style(markdown): shorten empty document fallback comment
cursoragent 7402393
fix(markdown): validate fallback content is actually block-shaped, ex…
codewithsupra d309f1b
fix(markdown): include extensions registered directly via registerExt…
codewithsupra f838438
fix(markdown): fix DTS build type error in empty-doc fallback check
codewithsupra 9c60ad3
fix(markdown): simplify the block-content check to a plain type !== '…
codewithsupra c7b7dfd
fix: use the 'group' field to determine if a node is a block node
arnaugomez ee025bc
test(extension-table): register heading for markdown parsing
arnaugomez 331bdcf
Merge branch 'main' into fix/markdown-whitespace-empty-doc
arnaugomez f8e66e4
test(extension-table): register heading for markdown parsing
arnaugomez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@tiptap/markdown": patch | ||
| --- | ||
|
|
||
| Fix `MarkdownManager.parse()` returning a document with empty `content` for markdown that yields no renderable blocks — whitespace-only input, or input whose only token has no registered handler (e.g. a leading-whitespace-indented line parsed as a code block when no code-block extension is present). A `doc` node requires at least one block child, so the empty document made `setContent` throw `RangeError: Invalid content for node doc: <>`. `parse()` now falls back to a single empty paragraph in that case, matching how an empty markdown string is represented. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| import { Editor } from '@tiptap/core' | ||
| import { Document } from '@tiptap/extension-document' | ||
| import { Paragraph } from '@tiptap/extension-paragraph' | ||
| import { Text } from '@tiptap/extension-text' | ||
| import { Markdown, MarkdownManager } from '@tiptap/markdown' | ||
| import { afterEach, describe, expect, it } from 'vitest' | ||
|
|
||
| /** | ||
| * Regression tests for #7914. | ||
| * | ||
| * A `doc` node requires at least one block child, so markdown that yields no | ||
| * renderable blocks must not parse to a doc with empty content — that makes | ||
| * `setContent` throw `RangeError: Invalid content for node doc: <>`. | ||
| */ | ||
| describe('markdown parse never yields an empty document (#7914)', () => { | ||
| let editor: Editor | undefined | ||
| afterEach(() => editor?.destroy()) | ||
|
|
||
| const mm = new MarkdownManager({ extensions: [Document, Paragraph, Text] }) | ||
|
|
||
| it.each([[' / '], [' \\'], [' '], ['']])( | ||
| 'parse(%j) returns a valid doc with at least one block', | ||
| input => { | ||
| const json = mm.parse(input) | ||
| expect(json.type).toBe('doc') | ||
| expect(json.content!.length).toBeGreaterThanOrEqual(1) | ||
| expect(json.content![0].type).toBe('paragraph') | ||
| }, | ||
| ) | ||
|
|
||
| it('setContent with whitespace+slash markdown does not throw', () => { | ||
| expect(() => { | ||
| editor = new Editor({ | ||
| extensions: [Document, Paragraph, Text, Markdown], | ||
| content: ' / ', | ||
| contentType: 'markdown', | ||
| }) | ||
| }).not.toThrow() | ||
| expect(editor!.getJSON().content![0].type).toBe('paragraph') | ||
| }) | ||
|
|
||
| it('still parses meaningful single-character content', () => { | ||
| expect(mm.parse('/')).toMatchObject({ | ||
| type: 'doc', | ||
| content: [{ type: 'paragraph', content: [{ type: 'text', text: '/' }] }], | ||
| }) | ||
| }) | ||
| }) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -348,10 +348,17 @@ export class MarkdownManager { | |
| // Convert tokens to Tiptap JSON | ||
| const content = this.parseTokens(tokens, true) | ||
|
|
||
| // Return a document node containing the parsed content | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do not delete this comment |
||
| // A `doc` node requires at least one block child (`block+`), so an empty | ||
| // `content` array produces an invalid document that makes `setContent` | ||
| // throw `RangeError: Invalid content for node doc: <>`. This happens for | ||
| // input that yields no renderable blocks — whitespace-only markdown, or | ||
| // markdown whose only token has no registered handler (e.g. an indented | ||
| // code block when no code-block extension is present, as with a line of | ||
| // leading whitespace followed by text). Fall back to a single empty | ||
| // paragraph, matching how an empty markdown string is represented. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Move this comment to just before "content", and re-write it to make it shorter. |
||
| return { | ||
| type: 'doc', | ||
| content, | ||
| content: content.length > 0 ? content : [{ type: 'paragraph' }], | ||
|
arnaugomez marked this conversation as resolved.
Outdated
|
||
| } | ||
| } finally { | ||
| this.activeParseLexer = previousParseLexer | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.