Muonroi.Tenancy.SiteProfile.SourceGenerators 2.0.2

Muonroi.Tenancy.SiteProfile.SourceGenerators

Roslyn source generators and analyzers that make multi-site ISiteProfile registration AOT-safe and type-checked at compile time.

This package is an analyzer/source-generator-only assembly (targets netstandard2.0, placed under analyzers/dotnet/cs). It ships four incremental source generators and eight diagnostic analyzers for the Muonroi.Tenancy.SiteProfile ecosystem. There is no runtime API — all behavior is compile-time code generation and static analysis.

Installation

dotnet add package Muonroi.Tenancy.SiteProfile.SourceGenerators --prerelease

The package is resolved as a Roslyn analyzer/generator reference. No <PackageReference> with OutputItemType="Analyzer" is required — the NuGet metadata handles placement automatically.

Quick Start

1. Declare a site profile with [GenerateSiteProfile]

using Muonroi.Tenancy.SiteProfile;

[GenerateSiteProfile("TCI", typeof(TciDbContext))]
[SiteProfileBehavior(typeof(TciCacheBehavior))]
public partial class TciSiteProfile : ISiteProfile
{
    public string SiteId => "TCI";

    // Generated partial void RegisterAdditionalServices(...) is your extension hook.
    // The generator emits RegisterServices(...) — do not write it manually.
    partial void RegisterAdditionalServices(
        IServiceCollection services, IConfiguration configuration)
    {
        services.AddKeyedScoped<IOrderService, TciOrderService>("TCI");
    }
}

The generator emits TciSiteProfile.RegisterServices.g.cs containing a RegisterServices(IServiceCollection, IConfiguration) implementation that calls SiteProfileBootstrap.RegisterSiteServices(...) and then invokes your RegisterAdditionalServices hook.

2. Register all discovered profiles (AOT-safe, no reflection)

// Program.cs — replaces reflection-based AddMultiSiteProfiles(Assembly[])
builder.Services.AddGeneratedSiteProfiles(
    builder.Configuration,
    siteCodeAccessor: sp => sp.GetRequiredService<ISiteProfileResolver>().CurrentSiteId);

AddGeneratedSiteProfiles is emitted by SiteProfileRegistrationGenerator into SiteProfileRegistrationExtensions.g.cs. It instantiates each discovered ISiteProfile via new TProfile() — no Activator.CreateInstance.

3. Use the generated SiteIds constants

// Instead of: services.AddKeyedScoped<IOrderService, TciOrderService>("TCI");
// Use:
services.AddKeyedScoped<IOrderService, TciOrderService>(SiteIds.TCI);

Analyzer MSP001 warns whenever a raw string literal matches a known SiteId value but SiteIds.<NAME> is not used.

Features

• SiteProfileRegistrationGenerator — scans all ISiteProfile implementations and emits:
  • SiteProfileRegistrationExtensions.g.cs with AddGeneratedSiteProfiles(IServiceCollection, IConfiguration, Func<IServiceProvider, string?>) — AOT-safe alternative to reflection-based registration
  • SiteIds.g.cs with internal static class SiteIds containing one const string per discovered profile
  • SiteDbContextTypeRegistry.g.cs with GetAllSiteDbContextTypes() — AOT-safe migration runner support
  • SiteGrpcServiceRegistry.g.cs with GetAllSiteGrpcServices() — discovers [SiteGrpcService] from both local source and referenced assemblies
  • SiteEntityTypeRegistry.g.cs with GetAllSiteEntityTypes() — entity hierarchy mappings from [SiteEntityMap]
• SiteProfileScaffoldingGenerator — for each class decorated with [GenerateSiteProfile("siteId", typeof(DbContext))], emits a per-class partial RegisterServices(...) implementation plus an optional ApplyEntityHierarchy(ModelBuilder) method when [SiteEntityMap] attributes are present
• SiteProfileAliasGenerator — for classes decorated with [SiteProfileAlias("TARGET")], emits a RegisterAliasServices(IServiceCollection) partial method that forwards keyed service registrations from the target site; enforces MSP030/MSP031
• SiteGrpcFacadeGenerator — for partial interfaces decorated with [GenerateSiteGrpcFacade(SharedClient = typeof(X))], emits a partial interface completion with async RPC signatures plus a concrete {Name}Facade class that delegates each call to the correct inner gRPC client

Diagnostics

API Reference

This package has no runtime API. All public surface is Roslyn generator/analyzer infrastructure.

Samples

No dedicated sample project is provided for this package. The generated extension methods (AddGeneratedSiteProfiles, SiteIds, RegisterAdditionalServices) are exercised in the host project of any service that references Muonroi.Tenancy.SiteProfile.

Compatibility

• Target framework: netstandard2.0
• Roslyn component (<IsRoslynComponent>true</IsRoslynComponent>)
• License: Apache-2.0 (OSS)

Related Packages

• Muonroi.Tenancy.SiteProfile — defines ISiteProfile, ISiteProfileResolver, AddSiteResolvedService<T>(), and AddMultiSiteProfiles() — required runtime counterpart
• Muonroi.Tenancy.SiteProfile.Generated.Runtime — provides SiteProfileBootstrap.RegisterSiteServices(...) and SiteProfileManifestRunner.Register(...) called by the generated code
• Muonroi.Tenancy.SiteProfile.Web — adds AddSiteProfileWeb(), per-request middleware, EF Core / Dapper per-site DI helpers

Ecosystem Combinations

+ SiteProfile → Generated Registration Code

Source generators scan for ISiteProfile implementations and emit partial classes with RegisterSiteServices() calls — replacing the entire manual AddSiteProfile<T>() boilerplate.

+ SiteProfile.Web → Generated Middleware Wiring

Generated code includes the middleware registration order for SiteProfileStateMiddleware — no manual app.UseSiteProfile() calls needed.

+ Data.EntityFrameworkCore → Generated DbContext Registration

For each ISiteProfile, the generator emits code to register AddSiteDbContext<T>() with the correct connection string from the site profile.

Samples

• Quickstart.Tenancy.SiteProfile

License

Apache-2.0. See LICENSE-APACHE.