Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(EyeDropper): remove EyeDropper component #4545

Merged
merged 8 commits into from
Oct 25, 2024
Merged

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Oct 25, 2024

remove EyeDropper component

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4544

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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

Remove the EyeDropper component and refactor the EyeDropperService to improve its functionality by using JSModule for JavaScript interactions. Update the associated test to reflect the changes in the service.

Enhancements:

  • Refactor EyeDropperService to use JSModule for invoking JavaScript functions.

Tests:

  • Update EyeDropperServiceTest to verify the new color value returned by the EyeDropperService.

Copy link

sourcery-ai bot commented Oct 25, 2024

Reviewer's Guide by Sourcery

This PR removes the EyeDropper component while maintaining the EyeDropper functionality through a service-based approach. The implementation simplifies the architecture by eliminating the component-based solution and moves to a more streamlined service implementation that directly interfaces with the JavaScript module.

Updated class diagram for EyeDropperService

classDiagram
    class EyeDropperService {
        - JSModule? _module
        + EyeDropperService(IJSRuntime jSRuntime)
        + Task<string?> PickAsync(CancellationToken token = default)
    }
Loading

File-Level Changes

Change Details Files
Refactored EyeDropperService to use direct JS module interaction
  • Removed inheritance from BootstrapServiceBase
  • Added constructor injection for IJSRuntime
  • Added support for CancellationToken in PickAsync method
  • Implemented lazy loading of JS module
  • Simplified the service implementation by removing EyeDropperOption dependency
src/BootstrapBlazor/Services/EyeDropperService.cs
Updated JavaScript module implementation
  • Added explicit null return when EyeDropper API is not supported
src/BootstrapBlazor/wwwroot/modules/eye-dropper.js
Removed EyeDropper component references and files
  • Removed EyeDropper component from BootstrapBlazorRoot
  • Deleted EyeDropper component file
  • Deleted EyeDropperOption class file
src/BootstrapBlazor/Components/BaseComponents/BootstrapBlazorRoot.razor
src/BootstrapBlazor/Components/EyeDropper/EyeDropper.cs
src/BootstrapBlazor/Components/EyeDropper/EyeDropperOption.cs
Updated unit tests to reflect new service implementation
  • Renamed test class to match service naming
  • Removed component rendering from test
  • Updated test assertion to use color value
test/UnitTest/Services/EyeDropperServiceTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4544 Remove the EyeDropper 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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 Oct 25, 2024
@bb-auto bb-auto bot added this to the v8.10.0 milestone Oct 25, 2024
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Oct 25, 2024
Copy link

@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 - here's some feedback:

Overall Comments:

  • Since this removes the EyeDropper component, please document this breaking change in the changelog and provide migration guidance for users moving from the component to the EyeDropperService.
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.

Copy link

codecov bot commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.99%. Comparing base (02a8024) to head (c510b4d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4545   +/-   ##
=======================================
  Coverage   99.99%   99.99%           
=======================================
  Files         626      624    -2     
  Lines       26964    26949   -15     
  Branches     3922     3922           
=======================================
- Hits        26963    26948   -15     
  Partials        1        1           

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

@ArgoZhang ArgoZhang merged commit 59ce9a0 into main Oct 25, 2024
6 checks passed
@ArgoZhang ArgoZhang deleted the refactor-eyedropper branch October 25, 2024 04:24
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(EyeDropper): remove EyeDropper component
1 participant