Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented May 31, 2025

Link issues

fixes #6120

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

Implement fallback logic in SelectGeneric to discard invalid text conversions and reset the displayed input value when the conversion callback returns null

New Features:

  • Reset the input display when TextConvertToValueCallback returns null

Enhancements:

  • Allow TextConvertToValueCallback to return null by updating its signature to Task<TValue?>
  • Add a JavaScript resetValue method and invoke it to restore the previous display on null conversions
  • Remove tabindex attribute from the display template container

Tests:

  • Add unit tests to cover scenarios where TextConvertToValueCallback returns null and ensure no state change

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 31, 2025

Reviewer's Guide

This PR augments SelectGeneric to properly handle null conversions from the editable input by updating the callback signature to allow nullable returns, branching on null to invoke a JS reset helper, and ensuring markup and tests align with the new behavior.

Sequence Diagram for Reset Logic on Null TextConvertToValueCallback Result

sequenceDiagram
    actor User
    participant SG as SelectGeneric.razor.cs
    participant TCVCallback as TextConvertToValueCallback
    participant JS as Select.razor.js (JS Interop)

    User->>SG: Inputs text in editable Select & blurs (triggers OnChange)
    SG->>TCVCallback: await TextConvertToValueCallback(inputText)
    TCVCallback-->>SG: return null
    SG->>JS: InvokeVoidAsync("resetValue", InputId, PreviousSelectedText)
    JS->>JS: document.getElementById(InputId).value = PreviousSelectedText
Loading

Updated Class Diagram for SelectGeneric

classDiagram
    class SelectGeneric~TValue~ {
        +TextConvertToValueCallback: Func~string, Task~TValue?~~
        #OnChange(ChangeEventArgs args) Task
    }
Loading

File-Level Changes

Change Details Files
Allow TextConvertToValueCallback to return null and update conversion flow
  • Changed callback type to Func<string, Task<TValue?>>?
  • Adjusted OnChange handler to check for null result
  • Branch: add new item on non-null, reset input on null
SelectGeneric.razor.cs
Introduce resetValue JS helper and invoke on null conversion
  • Implemented resetValue function in Select.razor.js
  • Invoke resetValue via JS interop when conversion yields null
Select.razor.js
SelectGeneric.razor.cs
Streamline component markup by removing tabindex
  • Removed tabindex="0" from display div to simplify focus handling
SelectGeneric.razor
Extend and adjust unit tests for null-return scenario
  • Added tests covering null callback path and reset logic
  • Applied non-null assertions (v!) for existing callback returns
SelectGenericTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6120 When SelectGeneric is enabled with IsEditable, if the input is invalid, it should revert to the original input content.

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 added the enhancement New feature or request label May 31, 2025
@bb-auto bb-auto bot added this to the 9.7.0 milestone May 31, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes May 31, 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 @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented May 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (dae37ad) to head (e0e5f12).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6123   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          703       703           
  Lines        31053     31059    +6     
  Branches      4392      4394    +2     
=========================================
+ Hits         31053     31059    +6     

☔ 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 enabled auto-merge (squash) May 31, 2025 01:23
@ArgoZhang
Copy link
Member Author

@sourcery-ai review

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 @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟡 Testing: 1 issue found
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

@ArgoZhang ArgoZhang merged commit 0289df5 into main May 31, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-select branch May 31, 2025 12:08
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(SelectGeneric): 增加 IsEditable=true 的情况下输入不合法还原的能力

2 participants