Skip to content

Fix Bit.SourceGenerators issues with interfaces containing properties with attributes (#9916)#9920

Merged
msynk merged 2 commits intobitfoundation:developfrom
yasmoradi:9916
Feb 16, 2025
Merged

Fix Bit.SourceGenerators issues with interfaces containing properties with attributes (#9916)#9920
msynk merged 2 commits intobitfoundation:developfrom
yasmoradi:9916

Conversation

@yasmoradi
Copy link
Member

@yasmoradi yasmoradi commented Feb 16, 2025

closes #9916

Summary by CodeRabbit

  • Bug Fixes

    • Enhanced error handling now captures and reports issues more clearly, improving overall system stability.
  • Refactor

    • Updated internal initialization processes have been streamlined for consistency, resulting in more reliable performance.

@yasmoradi yasmoradi requested a review from msynk February 16, 2025 13:50
@coderabbitai
Copy link

coderabbitai bot commented Feb 16, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The modifications update the collection initializations in syntax receiver classes to use empty array initializers instead of constructor calls. Additionally, error handling in the OnVisitSyntaxNode methods has been enhanced by introducing try-catch blocks. Exceptions during processing are now intercepted and rethrown as InvalidOperationException with contextual information, ensuring that errors are more clearly reported during syntax node processing.

Changes

Files Change Summary
src/.../AutoInjectSyntaxReceiver.cs
src/.../BlazorParameterPropertySyntaxReceiver.cs
Updated property initialization from constructor calls (new(), new List<>) to empty array initializers ([]); added try-catch blocks in OnVisitSyntaxNode for improved error reporting.
src/.../HttpClientProxySyntaxReceiver.cs Wrapped syntax node processing (including nested controller checks) in a try-catch block and restructured processing steps with detailed error messages upon failure.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Code Invoker
    participant SR as SyntaxReceiver
    participant Proc as Processing Logic
    participant Catch as Error Handler

    Caller->>SR: Visit Syntax Node
    SR->>Proc: Execute processing logic (e.g., marking members, properties, classes)
    alt Processing is successful
        Proc-->>SR: Return normal result
        SR->>Caller: Continue normal flow
    else Exception occurs
        Proc-->>SR: Exception thrown
        SR->>Catch: Catch exception in try-catch
        Catch->>SR: Wrap exception with InvalidOperationException (with context)
        SR->>Caller: Propagate error
    end
Loading

Poem

I'm Bunny, tapping keys with glee,
Hopping through code to set errors free.
Arrays now born with a simpler way,
Try-catch ensures no bugs astray.
With each new fix, my heart does sing,
Carrots and code—a joyful spring!
🐇💻 Hop on, dear coder, let the logic ring!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/SourceGenerators/Bit.SourceGenerators/AutoInject/AutoInjectSyntaxReceiver.cs (1)

12-13: Consider using ICollection instead of Collection.

While the collection initialization is correct, consider using ICollection<T> instead of Collection<T> in the property declarations to follow interface-based programming and allow for more flexible implementations.

-    public Collection<ISymbol> EligibleMembers { get; } = [];
-    public Collection<INamedTypeSymbol> EligibleClassesWithBaseClassUsedAutoInject { get; } = [];
+    public ICollection<ISymbol> EligibleMembers { get; } = [];
+    public ICollection<INamedTypeSymbol> EligibleClassesWithBaseClassUsedAutoInject { get; } = [];
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c42f399 and 4b2c774.

📒 Files selected for processing (3)
  • src/SourceGenerators/Bit.SourceGenerators/AutoInject/AutoInjectSyntaxReceiver.cs (2 hunks)
  • src/SourceGenerators/Bit.SourceGenerators/Blazor/BlazorParameterPropertySyntaxReceiver.cs (2 hunks)
  • src/SourceGenerators/Bit.SourceGenerators/HttpClientProxy/HttpClientProxySyntaxReceiver.cs (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build and test
🔇 Additional comments (4)
src/SourceGenerators/Bit.SourceGenerators/Blazor/BlazorParameterPropertySyntaxReceiver.cs (2)

19-46: LGTM! Enhanced error handling with detailed context.

The try-catch block provides valuable debugging information by including both the property name and file path in the error message.


12-12:

Details

✅ Verification successful

Verify .NET version compatibility.

The code uses C# 12's collection expression syntax []. Ensure that the project targets .NET 8 or later to support this feature.


🏁 Script executed:

#!/bin/bash
# Check target framework version in project file
fd -e csproj | xargs cat | grep -A 5 "TargetFramework"

Length of output: 26725


.NET Target Frameworks Confirm Compatibility

The project is targeting .NET 8.0 and .NET 9.0, both of which support C# 12’s collection expression syntax. No further changes are required for the syntax used in this file.

src/SourceGenerators/Bit.SourceGenerators/AutoInject/AutoInjectSyntaxReceiver.cs (1)

17-26: LGTM! Comprehensive error handling for all marking operations.

The try-catch block effectively wraps all marking operations and provides clear error context with the file path.

src/SourceGenerators/Bit.SourceGenerators/HttpClientProxy/HttpClientProxySyntaxReceiver.cs (1)

17-99: LGTM! Enhanced error handling and improved code structure.

The changes improve the code in two ways:

  1. Added comprehensive error handling with detailed context
  2. Better code organization with explicit condition checking for controllers

@msynk msynk changed the title Fix Bit.SourceGenerators issue with interfaces containing properties wit attributes (#9916) Fix Bit.SourceGenerators issues with interfaces containing properties with attributes (#9916) Feb 16, 2025
@msynk msynk merged commit 817f3eb into bitfoundation:develop Feb 16, 2025
3 checks passed
@yasmoradi yasmoradi deleted the 9916 branch February 16, 2025 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bit source generator issue with interfaces containing property

2 participants