Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

j4587698
Copy link
Collaborator

@j4587698 j4587698 commented Aug 17, 2025

Link issues

fixes #6637

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

Add file upload callback support to the Editor sample demonstration, enabling uploaded files to be saved to a timestamped path under wwwroot/images/uploader.

New Features:

  • Implement OnFileUpload handler in Editors.razor.cs to store uploaded files and return their URL

Enhancements:

  • Inject IOptionsMonitor into the Razor sample to retrieve WebRootPath
  • Pass the OnFileUpload callback to the Editor component in Editors.razor

Copy link

bb-auto bot commented Aug 17, 2025

Thanks for your PR, @j4587698. Someone from the team will get assigned to your PR shortly and we'll get it reviewed.

Copy link
Contributor

sourcery-ai bot commented Aug 17, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds an OnFileUpload callback to the Editor sample by implementing a method to save uploads with timestamped names using WebsiteOptions and wiring the callback in the Razor component.

Sequence diagram for Editor file upload with OnFileUpload callback

sequenceDiagram
    participant User
    participant EditorComponent
    participant OnFileUploadMethod
    participant FileSystem

    User->>EditorComponent: Uploads file
    EditorComponent->>OnFileUploadMethod: Calls OnFileUpload(uploadFile)
    OnFileUploadMethod->>FileSystem: Save file with timestamped name
    FileSystem-->>OnFileUploadMethod: Returns success/failure
    OnFileUploadMethod-->>EditorComponent: Returns file URL or empty string
    EditorComponent-->>User: Displays uploaded file (if successful)
Loading

Class diagram for Editor file upload callback integration

classDiagram
    class EditorUploadFile {
        +string FileName
        +Task<bool> SaveToFile(string fileName)
    }
    class WebsiteOptions {
        +string WebRootPath
    }
    class Editors {
        +Task<string> OnFileUpload(EditorUploadFile uploadFile)
    }
    Editors --> EditorUploadFile : uses
    Editors --> WebsiteOptions : uses
Loading

File-Level Changes

Change Details Files
Implement OnFileUpload callback to save uploaded files and return their URL
  • Define OnFileUpload method accepting EditorUploadFile
  • Construct timestamped path under images/uploader using WebsiteOptions
  • Invoke SaveToFile and return the URL or an empty string on failure
src/BootstrapBlazor.Server/Components/Samples/Editors.razor.cs
Enable upload callback in the Razor sample
  • Inject IOptionsMonitor for web root path resolution
  • Add OnFileUpload attribute to the component to wire the callback
src/BootstrapBlazor.Server/Components/Samples/Editors.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#6637 Add support for a callback function to the built-in image upload feature in the Editor component.

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

@bb-auto bb-auto bot requested a review from ArgoZhang August 17, 2025 07:49
@bb-auto bb-auto bot added the enhancement New feature or request label Aug 17, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 17, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Aug 17, 2025
Copy link
Contributor

@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!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor.Server/Components/Samples/Editors.razor.cs:116` </location>
<code_context>

+    private async Task<string> OnFileUpload(EditorUploadFile uploadFile)
+    {
+        var url = Path.Combine("images", "uploader",
+            $"{Path.GetFileNameWithoutExtension(uploadFile.FileName)}-{DateTimeOffset.Now:yyyyMMddHHmmss}{Path.GetExtension(uploadFile.FileName)}");
+        var fileName = Path.Combine(WebsiteOption.CurrentValue.WebRootPath, url);
+        var ret = await uploadFile.SaveToFile(fileName);
+        return ret ? url : "";
</code_context>

<issue_to_address>
Path.Combine may produce platform-specific separators in URLs.

Path.Combine may introduce backslashes on Windows, leading to invalid URLs. Use a method that consistently produces forward slashes for web URLs.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
        var url = Path.Combine("images", "uploader",
            $"{Path.GetFileNameWithoutExtension(uploadFile.FileName)}-{DateTimeOffset.Now:yyyyMMddHHmmss}{Path.GetExtension(uploadFile.FileName)}");
=======
        var url = $"images/uploader/{Path.GetFileNameWithoutExtension(uploadFile.FileName)}-{DateTimeOffset.Now:yyyyMMddHHmmss}{Path.GetExtension(uploadFile.FileName)}";
>>>>>>> REPLACE

</suggested_fix>

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.

Copy link

codecov bot commented Aug 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@eb8cbcb). Learn more about missing BASE report.
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main     #6638   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?       739           
  Lines           ?     31674           
  Branches        ?      4459           
========================================
  Hits            ?     31674           
  Misses          ?         0           
  Partials        ?         0           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang changed the title Editor增加Upload回调 feat(Editor): add OnFileUpload parameter Aug 18, 2025
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): 自带的图片上传支持回调
2 participants