GitAuto: [FEATURE] Add custom IoC Container support with HostBuilder.UseServiceProviderFactory method

[gitauto-ai]

Resolves #170

What is the feature

Implement support for a custom Inversion of Control (IoC) container by integrating the .NET method HostBuilder.UseServiceProviderFactory. This feature introduces a custom service provider factory that allows the application to use a tailor-made IoC container, aligning with standards from established IoC libraries without relying on external dependencies.

Why we need the feature

Our current service registry lacks support for UseServiceProviderFactory, limiting our flexibility in dependency management and service configuration. By implementing a custom IoC container, we can:

• Enhance Dependency Management: Provide advanced techniques for managing dependencies, including modular registrations and custom lifecycles.
• Increase Flexibility: Allow developers to customize how services are registered and resolved, accommodating complex scenarios.
• Align with Best Practices: Follow established patterns from well-known IoC containers, improving code maintainability and scalability.
• Avoid External Dependencies: Achieve the benefits of popular IoC libraries without adding external library dependencies to the project.

How to implement and why

Step 1: Design a Custom IoC Container

• Create Core Functionality:

  • Implement classes for dependency registration, resolution, and lifecycle management (singleton, scoped, transient).
  • Ensure the container supports generic type registration and open generic types.

• Adhere to Standards:

  • Follow design patterns from libraries like Autofac and Castle Windsor, such as fluent interfaces for registration and support for advanced scenarios.
  • Implement service interception and decorators if necessary.

Step 2: Implement the UseServiceProviderFactory Method

• Create the Service Provider Factory:

  • Implement the IServiceProviderFactory<TContainerBuilder> interface with our custom container builder.
  • Example:

    public class CustomServiceProviderFactory : IServiceProviderFactory<CustomContainerBuilder>
    {
        public CustomContainerBuilder CreateBuilder(IServiceCollection services)
        {
            var builder = new CustomContainerBuilder();
            builder.Populate(services);
            return builder;
        }
    
        public IServiceProvider CreateServiceProvider(CustomContainerBuilder containerBuilder)
        {
            return containerBuilder.BuildServiceProvider();
        }
    }

• Integrate with HostBuilder:

  • Modify the application's entry point to use the custom service provider factory.

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .UseServiceProviderFactory(new CustomServiceProviderFactory())
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });

Step 3: Extend Service Registration Capabilities

• Implement Registration Methods:

  • Provide methods for registering services with different lifetimes and options.

    public class CustomContainerBuilder
    {
        public void RegisterTransient<TService, TImplementation>() where TImplementation : TService
        {
            // Implementation
        }
    
        public void RegisterScoped<TService, TImplementation>() where TImplementation : TService
        {
            // Implementation
        }
    
        public void RegisterSingleton<TService, TImplementation>() where TImplementation : TService
        {
            // Implementation
        }
    
        public void Populate(IServiceCollection services)
        {
            // Transfer registrations from IServiceCollection to the custom container
        }
    
        public IServiceProvider BuildServiceProvider()
        {
            // Build and return the IServiceProvider
        }
    }

• Support Advanced Features:

  • Enable open generic registrations, conditional registrations, and constructor injection.

Step 4: Test the Integration Thoroughly

• Unit Testing:

  • Write unit tests to verify that services are registered and resolved correctly.
  • Test different lifecycles and ensure that scoped services behave as expected.

• Integration Testing:

  • Validate that the application starts up correctly using the custom IoC container.
  • Ensure that middleware and other framework integrations work without issues.

Step 5: Documentation and Examples

• Provide Clear Documentation:

  • Explain how to register and resolve services using the new IoC container.
  • Include examples of common scenarios and best practices.

• Update Existing Documentation:

  • Modify any existing documentation to reflect the new options available for dependency injection.

About backward compatibility

The introduction of the custom IoC container is designed to be fully backward compatible:

• Optional Adoption: Existing applications can continue using the default service provider without any changes. The custom IoC container is an opt-in feature.
• Non-Intrusive Changes: The implementation does not alter existing service registrations or resolutions unless the custom service provider factory is explicitly used.
• Compatibility Layer: The custom container will respect the registrations made in IServiceCollection, ensuring that services behave as before unless overridden.
• Gradual Migration: Developers can migrate to the custom IoC container at their own pace, testing and verifying functionality in stages.

By ensuring backward compatibility, we allow current users to benefit from the new feature without disrupting existing functionality.

Test these changes locally

git checkout -b gitauto/issue-#170-eb0577d7-c1a9-4900-b082-96a8cc77ee04
git pull origin gitauto/issue-#170-eb0577d7-c1a9-4900-b082-96a8cc77ee04

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (299be3c)	3681	1620	44.01%
Head commit (5eedcee)	3681 (+0)	1620 (+0)	44.01% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#577)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[AppVeyorBot]

❌ Build CrispyWaffle 8.2.198 failed (commit 4c492e73b5 by @gitauto-ai[bot])

[coderabbitai]

Important

Review skipped

Bot user detected.

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.

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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. (Experiment)
• @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.

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

8:29PM INF scanning for exposed secrets...
8:29PM INF 624 commits scanned.
8:29PM INF scan completed in 773ms
8:29PM INF no leaks found

[github-advanced-security]

Sonarcsharp (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[AppVeyorBot]

✅ Build CrispyWaffle 9.1.103 completed (commit db165b52aa by @guibranco)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 40.53%. Comparing base (299be3c) to head (5eedcee).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #577   +/-   ##
=======================================
  Coverage   40.53%   40.53%           
=======================================
  Files          83       83           
  Lines        3631     3631           
  Branches      519      519           
=======================================
  Hits         1472     1472           
  Misses       2057     2057           
  Partials      102      102           

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