Skip to content

fix: Optimize image uploads in Editor#7129

Merged
sriramveeraghanta merged 5 commits intopreviewfrom
fix/file-upload
May 28, 2025
Merged

fix: Optimize image uploads in Editor#7129
sriramveeraghanta merged 5 commits intopreviewfrom
fix/file-upload

Conversation

@aaryan610
Copy link
Member

@aaryan610 aaryan610 commented May 28, 2025

Description

This PR fixes the bug where multiple upload calls happen for an image upload.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)

Summary by CodeRabbit

  • Chores

    • Updated package resolution settings for improved dependency management.
  • Refactor

    • Improved the structure of the image uploader component for better maintainability.
    • Enhanced the file upload hook to ensure callbacks update correctly when their dependencies change.
    • Corrected type naming inconsistencies in image-related components for improved code clarity.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 28, 2025

Walkthrough

The updates include adding a new "chokidar" version resolution to the package configuration, refactoring a React component to extract inline callbacks into named hooks, fixing typos in type imports and aliases across several components, and updating a dependency array in a custom hook to include a missing callback. No changes were made to exported or public APIs beyond type alias corrections.

Changes

File(s) Change Summary
package.json Added "chokidar" version "3.6.0" to the "resolutions" field.
packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx Refactored to extract inline callbacks into named useCallback hooks for useUploader options; added explicit invalid file handler.
packages/editor/src/core/hooks/use-file-upload.ts Added onInvalidFile to the dependency array of the uploadFile callback in the useUploader hook.
packages/editor/src/core/extensions/custom-image/components/image-block.tsx Fixed typo in import and type alias from CustoBaseImageNodeViewProps to CustomBaseImageNodeViewProps.
packages/editor/src/core/extensions/custom-image/components/image-node.tsx Fixed typo in exported type names and updated dependent type aliases from CustoBaseImageNodeViewProps to CustomBaseImageNodeViewProps.

Suggested labels

regression

Suggested reviewers

  • prateekshourya29
  • sriramveeraghanta

Poem

A bunny hopped through code today,
Tidying callbacks along the way.
With chokidar now set just right,
And hooks refactored, neat and tight.
Typos fixed with care and grace,
The code now runs in perfect place!
🐇✨


📜 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 67f2094 and 6d33aac.

📒 Files selected for processing (3)
  • packages/editor/src/core/extensions/custom-image/components/image-block.tsx (2 hunks)
  • packages/editor/src/core/extensions/custom-image/components/image-node.tsx (2 hunks)
  • packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • packages/editor/src/core/extensions/custom-image/components/image-block.tsx
  • packages/editor/src/core/extensions/custom-image/components/image-node.tsx
🚧 Files skipped from review as they are similar to previous changes (1)
  • packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx
✨ 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
🪧 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 26b62c4 and 67f2094.

📒 Files selected for processing (3)
  • package.json (1 hunks)
  • packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx (2 hunks)
  • packages/editor/src/core/hooks/use-file-upload.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx (3)
packages/editor/src/core/helpers/get-extension-storage.ts (1)
  • getExtensionStorage (5-8)
packages/editor/src/core/hooks/use-file-upload.ts (1)
  • useUploader (20-89)
packages/editor/src/core/constants/config.ts (1)
  • ACCEPTED_IMAGE_MIME_TYPES (11-11)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (4)
packages/editor/src/core/hooks/use-file-upload.ts (1)

77-85: Excellent fix for preventing stale closures and multiple upload calls.

Adding onInvalidFile to the dependency array ensures the uploadFile callback always references the current version of this function, preventing stale closures that could lead to multiple upload attempts or inconsistent error handling. This directly addresses the PR objective of fixing multiple file upload calls.

packages/editor/src/core/extensions/custom-image/components/image-uploader.tsx (3)

10-11: Good organization of imports.

Moving the getExtensionStorage import to group with other helpers improves code organization and readability.


76-86: Excellent refactoring to prevent multiple upload calls.

Extracting these inline callbacks into proper useCallback hooks prevents unnecessary re-renders and ensures stable function references. This directly addresses the PR objective by eliminating a common cause of multiple upload calls - inline functions that create new references on every render.

The dependency arrays are correctly specified:

  • uploadImageEditorCommand depends on editor and imageEntityId
  • handleProgressStatus depends on editor

92-93: Perfect implementation of the extracted callbacks.

Using the extracted useCallback hooks instead of inline functions ensures stable references and prevents the useUploader hook from unnecessarily re-executing its internal logic, which was likely causing the multiple upload calls issue.

@sriramveeraghanta sriramveeraghanta changed the title fix: multiple file upload calls fix: Optimize image uploads in Editor May 28, 2025
@sriramveeraghanta sriramveeraghanta merged commit 141cb17 into preview May 28, 2025
4 of 5 checks passed
@sriramveeraghanta sriramveeraghanta deleted the fix/file-upload branch May 28, 2025 13:33
lifeiscontent pushed a commit that referenced this pull request Aug 18, 2025
* fix: memoize file upload functions

* chore: update extension name

* chore: update notation

* chore: resolve chokidar package

* fix: spelling mistakes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants