Skip to content

feat(Editor): update return type nullable#538

Merged
ArgoZhang merged 3 commits intomasterfrom
refactor-editor
Aug 20, 2025
Merged

feat(Editor): update return type nullable#538
ArgoZhang merged 3 commits intomasterfrom
refactor-editor

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Aug 20, 2025

Link issues

fixes #537

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Allow ImageUpload to return null and streamline JS stream reference creation in the SummerNote editor component.

Bug Fixes:

Enhancements:

  • Modify the JavaScript side to pass the file directly to DotNet.createJSStreamReference, removing the extra arrayBuffer allocation

@bb-auto bb-auto Bot added the enhancement New feature or request label Aug 20, 2025
@bb-auto bb-auto Bot added this to the v9.2.0 milestone Aug 20, 2025
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Aug 20, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the ImageUpload API to return a genuinely nullable string and simplifies the JS implementation by passing the File object directly to the .NET stream reference.

Sequence diagram for updated image upload interaction

sequenceDiagram
    participant JS as JavaScript
    participant Editor as .NET Editor
    JS->>Editor: ImageUpload(name, contentType, size, JSStreamReference(file))
    Editor->>Editor: OpenReadStreamAsync(size)
    Editor->>Editor: OnFileUpload(file)
    Editor-->>JS: string? (nullable result)
Loading

Class diagram for updated Editor component ImageUpload method

classDiagram
    class Editor {
        +Task<string?> ImageUpload(string name, string contentType, long size, IJSStreamReference stream)
    }
Loading

File-Level Changes

Change Details Files
Allow ImageUpload to return null instead of defaulting to an empty string
  • Changed ImageUpload signature to return Task<string?>
  • Removed the fallback return of empty string
  • Adjusted return statement to propagate null when no file is uploaded
src/components/BootstrapBlazor.SummerNote/Components/Editor/Editor.razor.cs
Streamline .NET stream reference creation in JavaScript
  • Removed manual arrayBuffer() call
  • Passed the File object directly to DotNet.createJSStreamReference
src/components/BootstrapBlazor.SummerNote/Components/Editor/Editor.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#537 Update the return type of the Editor component's ImageUpload method to be nullable (string?).

Possibly linked issues


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

@ArgoZhang ArgoZhang merged commit 46bea10 into master Aug 20, 2025
1 check passed
@ArgoZhang ArgoZhang deleted the refactor-editor branch August 20, 2025 00:56
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Editor): update return type nullable

1 participant