Skip to content

Conversation

ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Aug 21, 2025

Link issues

fixes #6664

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 a CanWrite filter to the EnsureInitialized extension to skip read-only properties and update tests to confirm only writable properties are initialized.

Bug Fixes:

  • Prevent initialization of read-only properties during object creation

Enhancements:

  • Only consider writable class-type properties in the EnsureInitialized method

Tests:

  • Add a unit test to verify that CreateInstance initializes writable properties and skips read-only ones

@Copilot Copilot AI review requested due to automatic review settings August 21, 2025 09:23
@bb-auto bb-auto bot added the enhancement New feature or request label Aug 21, 2025
@bb-auto bb-auto bot added this to the 9.9.0 milestone Aug 21, 2025
Copy link
Contributor

sourcery-ai bot commented Aug 21, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR refines the EnsureInitialized extension by filtering out non-writable class properties during initialization and adds corresponding unit tests to verify this behavior.

Sequence diagram for EnsureInitialized property initialization with CanWrite filter

sequenceDiagram
    participant Caller
    participant ObjectExtensions
    participant PropertyInfo
    Caller->>ObjectExtensions: EnsureInitialized(instance, isAutoInitialize)
    ObjectExtensions->>PropertyInfo: GetProperties()
    loop For each property
        ObjectExtensions->>PropertyInfo: Check PropertyType.IsClass
        ObjectExtensions->>PropertyInfo: Check PropertyType != string
        ObjectExtensions->>PropertyInfo: Check CanWrite
        alt Property is class, not string, and writable
            ObjectExtensions->>PropertyInfo: GetValue(instance)
            ObjectExtensions->>PropertyInfo: SetValue(instance, newValue)
        else Property is not writable
            ObjectExtensions-->>PropertyInfo: Skip initialization
        end
    end
Loading

Class diagram for updated EnsureInitialized property filtering

classDiagram
    class ObjectExtensions {
        +EnsureInitialized(instance, isAutoInitialize)
    }
    class PropertyInfo {
        +PropertyType: Type
        +CanWrite: bool
    }
    ObjectExtensions --> PropertyInfo : uses
    PropertyInfo : PropertyType.IsClass
    PropertyInfo : PropertyType != typeof(string)
    PropertyInfo : CanWrite
Loading

File-Level Changes

Change Details Files
Add CanWrite filter to EnsureInitialized property enumeration
  • Extend the LINQ predicate to include p.CanWrite
  • Reformat Where clause into multi-line for readability
ObjectExtensions.cs
Expand unit tests to cover writable filter behavior
  • Introduce MockObject class with read-only and read-write properties
  • Assert that only writable properties are initialized
ObjectExtensionsTest.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6664 Add a CanWrite filter to the EnsureInitialized logic so that only writable properties are initialized.

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

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!


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

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds a CanWrite filter to the EnsureInitialized method to prevent initialization attempts on read-only properties, along with a version update from beta to release.

  • Added CanWrite property filter in ObjectExtensions.EnsureInitialized method
  • Added unit test to verify behavior with read-only properties
  • Updated version from 9.9.3-beta03 to 9.9.3

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
src/BootstrapBlazor/Extensions/ObjectExtensions.cs Added CanWrite filter to prevent initialization of read-only properties
test/UnitTest/Extensions/ObjectExtensionsTest.cs Added test case and MockObject class with read-only property to verify the fix
src/BootstrapBlazor/BootstrapBlazor.csproj Version update from beta to release

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

{
public string? Name { get; set; }

public Foo? Foo { get; set; }
Copy link
Preview

Copilot AI Aug 21, 2025

Choose a reason for hiding this comment

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

The property references type 'Foo' which is not defined in the test file or visible imports. This will cause a compilation error.

Copilot uses AI. Check for mistakes.


public Foo? Foo { get; set; }

public Foo? Bar { get; }
Copy link
Preview

Copilot AI Aug 21, 2025

Choose a reason for hiding this comment

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

The property references type 'Foo' which is not defined in the test file or visible imports. This will cause a compilation error.

Copilot uses AI. Check for mistakes.

@ArgoZhang ArgoZhang merged commit dd729e2 into main Aug 21, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the feat-table branch August 21, 2025 09:24
Copy link

codecov bot commented Aug 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (7d225d9) to head (0fc674d).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6665   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          739       739           
  Lines        31672     31674    +2     
  Branches      4459      4459           
=========================================
+ Hits         31672     31674    +2     
Flag Coverage Δ
BB 100.00% <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.

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(EnsureInitialized): add CanWrite filter
1 participant