Repository navigation
fix: restore file upload button after failed drop or paste #3247
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
nperez0111
wants to merge
1
commit into
main
Choose a base branch
from
reproduce/issue-3246-stuck-loading-file-block
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.
+104
−4
Open
Changes from all commits
Commits
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
89 changes: 89 additions & 0 deletions
89
packages/core/src/api/clipboard/fromClipboard/handleFileInsertion.browser.test.ts
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,89 @@ | ||
| import { afterEach, describe, expect, it, vi } from "vite-plus/test"; | ||
|
|
||
| import "../../../style.css"; | ||
| import { BlockNoteEditor } from "../../../editor/BlockNoteEditor.js"; | ||
| import { handleFileInsertion } from "./handleFileInsertion.js"; | ||
|
|
||
| let editor: BlockNoteEditor | undefined; | ||
| let root: HTMLDivElement | undefined; | ||
|
|
||
| afterEach(() => { | ||
| editor?._tiptapEditor.destroy(); | ||
| root?.remove(); | ||
| editor = undefined; | ||
| root = undefined; | ||
| }); | ||
|
|
||
| // Reproduces #3246 in the real file insertion handler and vanilla node view. | ||
| // Await the handler directly so its rejected promise can be asserted rather | ||
| // than becoming an unhandled rejection in the test runner. | ||
| describe.each(["drop", "paste"] as const)("file %s", (eventType) => { | ||
| it.each(["empty URL", "rejection", "success"] as const)( | ||
| "settles the loading preview after %s", | ||
| async (outcome) => { | ||
| const uploadFile = vi.fn(async () => { | ||
| if (outcome === "rejection") { | ||
| throw new Error("rejected"); | ||
| } | ||
| return outcome === "success" ? "https://example.com/test.txt" : ""; | ||
| }); | ||
| editor = BlockNoteEditor.create({ | ||
| initialContent: [{ id: "target", type: "paragraph" }], | ||
| uploadFile, | ||
| }); | ||
| root = document.createElement("div"); | ||
| document.body.append(root); | ||
| editor.mount(root); | ||
| editor.setTextCursorPosition("target"); | ||
| const onUploadEnd = vi.fn(); | ||
| editor.onUploadEnd(onUploadEnd); | ||
|
|
||
| const data = new DataTransfer(); | ||
| data.items.add(new File(["test"], "test.txt", { type: "text/plain" })); | ||
| const target = root.querySelector('[data-id="target"]'); | ||
| if (!target) { | ||
| throw new Error("Target block was not rendered"); | ||
| } | ||
| const rect = target.getBoundingClientRect(); | ||
| const event = | ||
| eventType === "drop" | ||
| ? new DragEvent("drop", { | ||
| dataTransfer: data, | ||
| clientX: rect.left + rect.width / 2, | ||
| clientY: rect.top + rect.height / 2, | ||
| cancelable: true, | ||
| }) | ||
| : new ClipboardEvent("paste", { | ||
| clipboardData: data, | ||
| cancelable: true, | ||
| }); | ||
| // Firefox strips file data from constructed ClipboardEvents. Supply the | ||
| // original DataTransfer when calling the handler directly. | ||
| if (eventType === "paste") { | ||
| Object.defineProperty(event, "clipboardData", { value: data }); | ||
| } | ||
|
|
||
| const insertion = handleFileInsertion(event, editor); | ||
| expect(uploadFile).toHaveBeenCalledOnce(); | ||
| expect(root.querySelector(".bn-file-loading-preview")?.textContent).toBe( | ||
| "Loading...", | ||
| ); | ||
| const result = await insertion.then( | ||
| () => "resolved", | ||
| () => "rejected", | ||
| ); | ||
|
|
||
| expect(onUploadEnd).toHaveBeenCalledOnce(); | ||
| expect.soft(result).toBe("resolved"); | ||
| expect.soft(root.querySelector(".bn-file-loading-preview")).toBeNull(); | ||
| if (outcome !== "success") { | ||
| expect.soft(root.querySelector(".bn-add-file-button")).not.toBeNull(); | ||
| } else { | ||
| expect(editor.document[0].props).toMatchObject({ | ||
| name: "test.txt", | ||
| url: "https://example.com/test.txt", | ||
| }); | ||
| } | ||
| }, | ||
| ); | ||
| }); |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Keep the loader visible until all uploads for the block end.
If two
editor.uploadFilecalls use the same block ID, the first upload-end event restores the add-file button while the second upload is still running. The editor emits an upload-end event for each call. Track active uploads for this block, and restore the button only after the last upload ends. (raw.githubusercontent.com)🤖 Prompt for AI Agents