Merge pull request #31 from kristoffer-tungland/codex/implement-dependency-injection-feature

Refine factory generation to use cached ObjectFactory

Author: Frederik91

DependencyInjection.SourceGenerator.Benchmarks/DependencyInjection.SourceGenerator.Benchmarks.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <OutputType>Exe</OutputType>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.7" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.1" />
+    <!-- Reference the source generator project as an analyzer so generated code is available at compile time -->
+    <ProjectReference Include="..\DependencyInjection.SourceGenerator.Microsoft\DependencyInjection.SourceGenerator.Microsoft.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
+  </ItemGroup>
+
+</Project>

DependencyInjection.SourceGenerator.Benchmarks/FactoryBenchmarks.cs

@@ -0,0 +1,27 @@
+using BenchmarkDotNet.Attributes;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace DependencyInjection.SourceGenerator.Benchmarks;
+
+[MemoryDiagnoser]
+public class FactoryBenchmarks
+{
+    private ITestServiceFactory _factory = null!;
+
+    [GlobalSetup]
+    public void Setup()
+    {
+        var services = new ServiceCollection();
+        // The generator will emit an extension named based on the assembly name
+        // For this project the generator produces: AddDependencyInjectionSourceGeneratorBenchmarks()
+        services.AddDependencyInjectionSourceGeneratorBenchmarks();
+        var provider = services.BuildServiceProvider();
+        _factory = provider.GetRequiredService<ITestServiceFactory>();
+    }
+
+    [Benchmark]
+    public TestService CreateWithFactory()
+    {
+        return _factory.Create(42);
+    }
+}

DependencyInjection.SourceGenerator.Benchmarks/Program.cs

@@ -0,0 +1,11 @@
+using BenchmarkDotNet.Running;
+
+namespace DependencyInjection.SourceGenerator.Benchmarks;
+
+public class Program
+{
+    public static void Main(string[] args)
+    {
+        var summary = BenchmarkRunner.Run<FactoryBenchmarks>();
+    }
+}

DependencyInjection.SourceGenerator.Benchmarks/TestService.cs

@@ -0,0 +1,19 @@
+using Microsoft.Extensions.DependencyInjection;
+
+namespace DependencyInjection.SourceGenerator.Benchmarks;
+
+#pragma warning disable CS9113 
+
+[Register]
+public class TestService
+{
+    public TestService(TestDependency _, [FactoryArgument] int value)
+    {
+        Value = value;
+    }
+
+    public int Value { get; }
+}
+
+[Register]
+public class TestDependency(IServiceProvider _) { };

DependencyInjection.SourceGenerator.Microsoft.Demo/Program.cs

@@ -1,2 +1,11 @@
 // See https://aka.ms/new-console-template for more information
-Console.WriteLine("Hello, World!");
+using DependencyInjection.SourceGenerator.Microsoft.Demo;
+using Microsoft.Extensions.DependencyInjection;
+
+var services = new ServiceCollection();
+services.AddDependencyInjectionSourceGeneratorMicrosoftDemo();
+var provider = services.BuildServiceProvider();
+
+var factory = provider.GetRequiredService<ITestServiceFactory>();
+var testService = factory.Create(42);
+Console.WriteLine(testService.Value);

DependencyInjection.SourceGenerator.Microsoft.Demo/TestService.cs

@@ -1,7 +1,19 @@
-namespace DependencyInjection.SourceGenerator.Microsoft.Demo;
+using Microsoft.Extensions.DependencyInjection;
 
-[global::Microsoft.Extensions.DependencyInjection.Register]
+namespace DependencyInjection.SourceGenerator.Microsoft.Demo;
+
+#pragma warning disable CS9113 
+
+[Register]
 public class TestService
 {
+    public TestService(TestDependency _, [FactoryArgument] int value)
+    {
+        Value = value;
+    }
+
+    public int Value { get; }
+}
 
-}
+[Register]
+public class TestDependency(IServiceProvider _) { };

DependencyInjection.SourceGenerator.Microsoft.Tests/DependencyInjectionRegistrationGeneratorTests.cs

@@ -1,4 +1,5 @@
 using Microsoft.CodeAnalysis;
+using System;
 using System.Collections.Immutable;
 using FluentAssertions;
 using Microsoft.CodeAnalysis.CSharp;
@@ -55,13 +56,22 @@ private static async Task RunTestAsync(string code, [CallerMemberName] string me
 
         foreach (var syntaxTree in outputCompilation.SyntaxTrees)
         {
-            if (syntaxTree.FilePath.EndsWith("ServiceRegistrations.g.cs") == false)
+            var fileName = Path.GetFileName(syntaxTree.FilePath);
+            if (fileName is null)
+            {
                 continue;
+            }
+
+            if (fileName.EndsWith("ServiceRegistrations.g.cs", StringComparison.Ordinal) == false &&
+                fileName.EndsWith("Factory.g.cs", StringComparison.Ordinal) == false)
+            {
+                continue;
+            }
 
             var generatedSource = syntaxTree.ToString().Replace("\r\n", "\n");
             var settings = new VerifySettings();
             settings.UseDirectory("TestResults");
-            settings.UseFileName(methodName + "_" + Path.GetFileNameWithoutExtension(syntaxTree.FilePath));
+            settings.UseFileName(methodName + "_" + Path.GetFileNameWithoutExtension(fileName));
             await Verifier.Verify(generatedSource, settings);
         }
     }
@@ -121,6 +131,34 @@ namespace DependencyInjection.SourceGenerator.Microsoft.Demo;
 public class Service : IService {}
 public interface IService {}
 
+""";
+
+        await RunTestAsync(code);
+    }
+
+    [Fact]
+    public async Task Register_WithFactoryArguments()
+    {
+        var code = """
+using global::Microsoft.Extensions.DependencyInjection;
+
+namespace DependencyInjection.SourceGenerator.Microsoft.Demo;
+
+[Register(ServiceType = typeof(IReportJob), Lifetime = ServiceLifetime.Scoped)]
+public sealed class ReportJob : IReportJob
+{
+    public ReportJob(IDependency dependency, [FactoryArgument] System.Guid reportId)
+    {
+    }
+}
+
+public interface IReportJob
+{
+}
+
+public interface IDependency
+{
+}
 """;
 
         await RunTestAsync(code);

DependencyInjection.SourceGenerator.Microsoft.Tests/TestResults/Register_WithFactoryArguments_DependencyInjection_SourceGenerator_Microsoft_Demo_ReportJobFactory.g.verified.txt

@@ -0,0 +1,25 @@
+// <auto-generated/>
+#pragma warning disable
+#nullable enable
+namespace DependencyInjection.SourceGenerator.Microsoft.Demo;
+public interface IReportJobFactory
+{
+    global::DependencyInjection.SourceGenerator.Microsoft.Demo.IReportJob Create(global::System.Guid reportId);
+}
+
+[global::System.CodeDom.Compiler.GeneratedCode("DependencyInjection.SourceGenerator.Microsoft", "3.1.0.0")]
+[global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+public sealed class ReportJobFactory : IReportJobFactory
+{
+    private static readonly global::Microsoft.Extensions.DependencyInjection.ObjectFactory _objectFactory = global::Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateFactory(typeof(global::DependencyInjection.SourceGenerator.Microsoft.Demo.ReportJob), new global::System.Type[] { typeof(global::System.Guid) });
+    private readonly global::System.IServiceProvider _serviceProvider;
+    public ReportJobFactory(global::System.IServiceProvider serviceProvider)
+    {
+        _serviceProvider = serviceProvider;
+    }
+
+    public global::DependencyInjection.SourceGenerator.Microsoft.Demo.IReportJob Create(global::System.Guid reportId)
+    {
+        return (global::DependencyInjection.SourceGenerator.Microsoft.Demo.IReportJob)_objectFactory(_serviceProvider, new object[] { reportId });
+    }
+}

DependencyInjection.SourceGenerator.Microsoft.Tests/TestResults/Register_WithFactoryArguments_ServiceRegistrations.g.verified.txt

@@ -0,0 +1,14 @@
+// <auto-generated/>
+#pragma warning disable
+#nullable enable
+namespace Microsoft.Extensions.DependencyInjection;
+using global::Microsoft.Extensions.DependencyInjection;
+
+public static partial class ServiceCollectionExtensions
+{
+    public static global::Microsoft.Extensions.DependencyInjection.IServiceCollection AddTestProject(this global::Microsoft.Extensions.DependencyInjection.IServiceCollection services)
+    {
+        services.AddScoped<global::DependencyInjection.SourceGenerator.Microsoft.Demo.IReportJobFactory, global::DependencyInjection.SourceGenerator.Microsoft.Demo.ReportJobFactory>();
+        return services;
+    }
+}

DependencyInjection.SourceGenerator.Microsoft/Attributes/FactoryArgumentAttribute.cs

@@ -0,0 +1,6 @@
+namespace Microsoft.Extensions.DependencyInjection;
+
+[AttributeUsage(AttributeTargets.Parameter)]
+internal sealed class FactoryArgumentAttribute : Attribute
+{
+}