fix: remove empty paragraphs after inserting file block

[LucasXu0]

Feature Preview

---

PR Checklist

• My code adheres to AppFlowy's Conventions
• I've listed at least one issue that this PR fixes in the description above.
• I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
• All existing tests are passing.

Summary by Sourcery

Improve file block insertion behavior by replacing empty paragraphs with file blocks and maintaining non-empty paragraph content

New Features:

• Add logic to replace empty paragraphs with file blocks when inserting

Bug Fixes:

• Fix issue with unnecessary paragraph creation when inserting file blocks

Tests:

• Add unit tests for file block insertion in different paragraph scenarios

[sourcery-ai]

Reviewer's Guide

This pull request refactors the file block insertion mechanism to prevent the automatic creation of an extra empty paragraph after a file block is inserted. The updated logic checks if the current editor node is an empty paragraph: if true, it's replaced by the file block; otherwise, the file block is inserted after the current node. The previous behavior of always adding a new paragraph after the file block has been removed. Unit tests have been added to validate these changes.

Class Diagram: Changes to EditorState via InsertFile Extension

classDiagram
  class EditorState {
    +transaction : Transaction
    +apply(Transaction) : Future~void~
    +delta : Delta
    +node : Node
    +path : Path
    +Selection : Selection
  }
  class InsertFile {
    <<extension>>
    +insertEmptyFileBlock(GlobalKey key) Future~void~
  }
  EditorState <|-- InsertFile : extends

  class Transaction {
    +insertNode(Path, Node)
    +deleteNode(Node)
    +afterSelection : Selection
  }
  EditorState --> Transaction : uses
  InsertFile --> Transaction : uses

  class Node {
    type
    extraInfos
  }
  InsertFile --> Node : creates fileNode
  EditorState --> Node : references current node (node)

  class Path {
    +next() Path
  }
  EditorState --> Path : references current path (path)
  InsertFile --> Path : uses

  class Selection {
    +collapsed(Position) Selection
  }
  InsertFile --> Selection : uses (conditionally)

  class Position {
    +path : Path
  }
  Selection --> Position : uses

  note for InsertFile "Method `insertEmptyFileBlock` logic updated:\n- If current node (delta.isEmpty && node.type == ParagraphBlockKeys.type), replaces it with file block.
- Else, inserts file block after current node (path.next).
- No longer adds an extra empty paragraph after file block."

Loading

File-Level Changes

Change	Details	Files
Modified file block insertion logic to prevent extraneous empty paragraphs.	If the current node is an empty paragraph, it is replaced by the new file block. If the current node is not an empty paragraph, the file block is inserted after it. Removed the automatic insertion of a new paragraph node after a file block is added.	frontend/appflowy_flutter/lib/plugins/document/presentation/editor_plugins/file/file_selection_menu.dart
Added unit tests for file block insertion.	Added a test case to verify that an empty paragraph is replaced when a file block is inserted into it. Added a test case to verify that a file block is inserted after a non-empty paragraph, preserving the original paragraph.	frontend/appflowy_flutter/test/unit_test/editor/file_block_test.dart

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @LucasXu0 - I've reviewed your changes - here's some feedback:

• Consider explicitly managing afterSelection in the transaction to define cursor behavior after inserting the file block, as the previous explicit selection logic has been removed.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}