Merge branch 'develop'

autofac · Jul 18, 2022 · b720b52 · b720b52
2 parents e909cfd + a370c4d
commit b720b52
Show file tree

Hide file tree

Showing 58 changed files with 1,509 additions and 1,176 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -1,28 +1,199 @@
-; EditorConfig to support per-solution formatting.
-; Use the EditorConfig VS add-in to make this work.
-; http://editorconfig.org/
-
-; This is the default for the codeline.
-root = true
-
-[*]
-end_of_line = CRLF
-
-[*.{config,cs,xml}]
-indent_style = space
-indent_size = 4
-trim_trailing_whitespace = true
-
-[*.{proj,props,sln,targets}]
-indent_style = tab
-trim_trailing_whitespace = true
-
-[*.{kproj,csproj,json,ps1,psd1,psm1,resx,rst}]
-indent_style = space
-indent_size = 2
-trim_trailing_whitespace = true
-
-[NuGet.Config]
-indent_style = space
-indent_size = 2
-trim_trailing_whitespace = true
+; EditorConfig to support per-solution formatting.
+; Use the EditorConfig VS add-in to make this work.
+; http://editorconfig.org/
+
+; This is the default for the codeline.
+root = true
+
+[*]
+indent_style = space
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+; .NET Code - almost, but not exactly, the same suggestions as corefx
+; https://github.com/dotnet/corefx/blob/master/.editorconfig
+[*.cs]
+indent_size = 4
+charset = utf-8-bom
+
+; New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+
+; Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = one_less_than_current
+
+; Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+
+; Avoid this. unless absolutely necessary
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_event = false:suggestion
+
+; Types: use keywords instead of BCL types, using var is fine.
+csharp_style_var_when_type_is_apparent = false:none
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+
+; Name all constant fields using PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = warning
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds   = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+; Static fields should be _camelCase
+dotnet_naming_rule.static_fields_should_be_camel_case.severity = warning
+dotnet_naming_rule.static_fields_should_be_camel_case.symbols  = static_fields
+dotnet_naming_rule.static_fields_should_be_camel_case.style    = camel_case_underscore_style
+dotnet_naming_symbols.static_fields.applicable_kinds   = field
+dotnet_naming_symbols.static_fields.required_modifiers = static
+dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
+
+; Static readonly fields should be PascalCase
+dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.severity = warning
+dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.symbols  = static_readonly_fields
+dotnet_naming_rule.static_readonly_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_symbols.static_readonly_fields.applicable_kinds   = field
+dotnet_naming_symbols.static_readonly_fields.required_modifiers = static, readonly
+dotnet_naming_symbols.static_readonly_fields.applicable_accessibilities = private, internal, private_protected
+
+; Internal and private fields should be _camelCase
+dotnet_naming_rule.camel_case_for_private_internal_fields.severity = warning
+dotnet_naming_rule.camel_case_for_private_internal_fields.symbols  = private_internal_fields
+dotnet_naming_rule.camel_case_for_private_internal_fields.style    = camel_case_underscore_style
+dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
+dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
+dotnet_naming_style.camel_case_underscore_style.required_prefix = _
+dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+; Code style defaults
+csharp_using_directive_placement = outside_namespace:suggestion
+dotnet_sort_system_directives_first = true
+csharp_prefer_braces = true:refactoring
+csharp_preserve_single_line_blocks = true:none
+csharp_preserve_single_line_statements = false:none
+csharp_prefer_static_local_function = true:suggestion
+csharp_prefer_simple_using_statement = false:none
+csharp_style_prefer_switch_expression = true:suggestion
+
+; Code quality
+dotnet_style_readonly_field = true:suggestion
+dotnet_code_quality_unused_parameters = non_public:suggestion
+
+; Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:refactoring
+dotnet_style_prefer_conditional_expression_over_return = true:refactoring
+csharp_prefer_simple_default_expression = true:suggestion
+
+# Expression-bodied members
+csharp_style_expression_bodied_methods = true:refactoring
+csharp_style_expression_bodied_constructors = true:refactoring
+csharp_style_expression_bodied_operators = true:refactoring
+csharp_style_expression_bodied_properties = true:refactoring
+csharp_style_expression_bodied_indexers = true:refactoring
+csharp_style_expression_bodied_accessors = true:refactoring
+csharp_style_expression_bodied_lambdas = true:refactoring
+csharp_style_expression_bodied_local_functions = true:refactoring
+
+# Pattern matching
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+
+# Null checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Other features
+csharp_style_namespace_declarations = file_scoped:suggestion
+csharp_style_prefer_index_operator = false:none
+csharp_style_prefer_range_operator = false:none
+csharp_style_pattern_local_over_anonymous_function = false:none
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = do_not_ignore
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+; .NET project files and MSBuild - match defaults for VS
+[*.{csproj,nuspec,proj,projitems,props,shproj,targets,vbproj,vcxproj,vcxproj.filters,vsixmanifest,vsct}]
+indent_size = 2
+
+; .NET solution files - match defaults for VS
+[*.sln]
+indent_style = tab
+
+; Config - match XML and default nuget.config template
+[*.config]
+indent_size = 2
+
+; Resources - match defaults for VS
+[*.resx]
+indent_size = 2
+
+; Static analysis rulesets - match defaults for VS
+[*.ruleset]
+indent_size = 2
+
+; HTML, XML - match defaults for VS
+[*.{cshtml,html,xml}]
+indent_size = 4
+
+; JavaScript and JS mixes - match eslint settings; JSON also matches .NET Core templates
+[*.{js,json,ts,vue}]
+indent_size = 2
+
+; Markdown - match markdownlint settings
+[*.{md,markdown}]
+indent_size = 2
+
+; PowerShell - match defaults for New-ModuleManifest and PSScriptAnalyzer Invoke-Formatter
+[*.{ps1,psd1,psm1}]
+indent_size = 4
+charset = utf-8-bom
+
+; ReStructuredText - standard indentation format from examples
+[*.rst]
+indent_size = 2
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1,21 +1,5 @@
 {
   "configurations": [
-    {
-      "cwd": "${workspaceFolder}",
-      "env": {
-        "ASPNETCORE_ENVIRONMENT": "Development",
-        "ASPNETCORE_URLS": "http://localhost:5555"
-      },
-      "launchBrowser": {
-        "enabled": false
-      },
-      "name": "Sandbox 2.1-2.2",
-      "preLaunchTask": "build",
-      "program": "${workspaceFolder}/samples/Sandbox.AspNetCore2_1_To_2_2/bin/Debug/netcoreapp2.1/Sandbox.AspNetCore2_1_To_2_2.dll",
-      "request": "launch",
-      "stopAtEntry": false,
-      "type": "coreclr"
-    },
     {
       "cwd": "${workspaceFolder}",
       "env": {

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,7 +1,13 @@
 {
   "cSpell.words": [
     "autofac",
-    "multitenant"
+    "cref",
+    "langword",
+    "multitenancy",
+    "multitenant",
+    "paramref",
+    "seealso",
+    "xunit"
   ],
   "dotnet-test-explorer.runInParallel": true,
   "dotnet-test-explorer.testProjectPath": "test/**/*.Test.csproj"

diff --git a/Autofac.AspNetCore.Multitenant.sln b/Autofac.AspNetCore.Multitenant.sln
@@ -29,8 +29,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{BD32
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sandbox.Shared", "samples\Sandbox.Shared\Sandbox.Shared.csproj", "{C1C581D6-57C2-4448-BF83-59C39CED7ABC}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Sandbox.AspNetCore2_1_To_2_2", "samples\Sandbox.AspNetCore2_1_To_2_2\Sandbox.AspNetCore2_1_To_2_2.csproj", "{FB888CA9-A343-4A84-A411-D970A278EFC6}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "build", "build", "{29F190E3-F654-446C-B226-2B9B772BDCDC}"
 ProjectSection(SolutionItems) = preProject
 	build\Analyzers.ruleset = build\Analyzers.ruleset
@@ -65,10 +63,6 @@ Global
 		{C1C581D6-57C2-4448-BF83-59C39CED7ABC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C1C581D6-57C2-4448-BF83-59C39CED7ABC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C1C581D6-57C2-4448-BF83-59C39CED7ABC}.Release|Any CPU.Build.0 = Release|Any CPU
-		{FB888CA9-A343-4A84-A411-D970A278EFC6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{FB888CA9-A343-4A84-A411-D970A278EFC6}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{FB888CA9-A343-4A84-A411-D970A278EFC6}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{FB888CA9-A343-4A84-A411-D970A278EFC6}.Release|Any CPU.Build.0 = Release|Any CPU
 		{B64B6D62-AD07-49BE-AF65-3E4C92284AD5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{B64B6D62-AD07-49BE-AF65-3E4C92284AD5}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{B64B6D62-AD07-49BE-AF65-3E4C92284AD5}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -82,7 +76,6 @@ Global
 		{BA923A91-3A4B-40CE-8788-70A641694945} = {5227B99C-6D0F-4E7B-9DF8-82C53488E173}
 		{12445470-D348-467F-8D3F-FBD6EF525CEE} = {BD3275CD-8B4C-4CEA-8DDB-BEF386DD48B5}
 		{C1C581D6-57C2-4448-BF83-59C39CED7ABC} = {BD3275CD-8B4C-4CEA-8DDB-BEF386DD48B5}
-		{FB888CA9-A343-4A84-A411-D970A278EFC6} = {BD3275CD-8B4C-4CEA-8DDB-BEF386DD48B5}
 		{B64B6D62-AD07-49BE-AF65-3E4C92284AD5} = {BD3275CD-8B4C-4CEA-8DDB-BEF386DD48B5}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 ASP.NET Core support for multitenant DI via [Autofac.Multitenant](https://github.com/autofac/Autofac.Multitenant).
 
-[![Build status](https://ci.appveyor.com/api/projects/status/u6epu5sc9f9sgav3?svg=true)](https://ci.appveyor.com/project/Autofac/autofac-aspnetcore-multitenant) [![codecov](https://codecov.io/gh/Autofac/Autofac.AspNetCore.Multitenant/branch/develop/graph/badge.svg)](https://codecov.io/gh/Autofac/Autofac.AspNetCore.Multitenant) [![Open in Visual Studio Code](https://open.vscode.dev/badges/open-in-vscode.svg)](https://open.vscode.dev/autofac/Autofac.AspNetCore.Multitenant)
+[![Build status](https://ci.appveyor.com/api/projects/status/u6epu5sc9f9sgav3?svg=true)](https://ci.appveyor.com/project/Autofac/autofac-aspnetcore-multitenant) [![codecov](https://codecov.io/gh/Autofac/Autofac.AspNetCore.Multitenant/branch/develop/graph/badge.svg)](https://codecov.io/gh/Autofac/Autofac.AspNetCore.Multitenant)
 
 Please file issues and pull requests for this package in this repository rather than in the Autofac core repo.
 
@@ -14,10 +14,81 @@ Unfortunately, that means the `IServiceScopeFactory` is created/resolved at the
 
 This package provides a different request services middleware that ensures the `IHttpContextAccessor.HttpContext` is set and defers creation of the request lifetime scope until as late as possible so anything needed for tenant identification can be established.
 
+## Quick Start
+
+When creating your application host, use the multitenant service provider factory. Your `Startup` will register common dependencies, but you'll need to provide a static method to initialize the tenant-specific overrides.
+
+```c#
+var host = Host.CreateDefaultBuilder(args)
+    .UseServiceProviderFactory(new AutofacMultitenantServiceProviderFactory(MultitenantContainerSetup.ConfigureMultitenantContainer))
+    .ConfigureWebHostDefaults(webHostBuilder => webHostBuilder.UseStartup<Startup>())
+    .Build();
+```
+
+In your `Startup` class, make sure to use the multitenant request services middleware and register your common dependencies.
+
+```c#
+public class Startup
+{
+  public void ConfigureServices(IServiceCollection services)
+  {
+    // Add the multitenant request services handler.
+    services
+      .AddAutofacMultitenantRequestServices()
+      .AddControllers();
+  }
+
+  public void ConfigureContainer(ContainerBuilder builder)
+  {
+    // Register tenant-shared dependencies and defaults.
+    builder.RegisterType<CommonDependency>()
+      .As<IDependency>()
+      .InstancePerLifetimeScope();
+  }
+
+  public void Configure(IApplicationBuilder app)
+  {
+      app.UseRouting();
+      app.UseEndpoints(builder => builder.MapControllers());
+  }
+}
+```
+
+Provide a method to override things for tenant-specific dependencies. This is what gets passed to the multitenant service provider factory.
+
+```c#
+public static class MultitenantContainerSetup
+{
+  public static MultitenantContainer ConfigureMultitenantContainer(IContainer container)
+  {
+    // Define how you're going to identify tenants.
+    var strategy = new QueryStringTenantIdentificationStrategy(
+        container.Resolve<IHttpContextAccessor>(),
+        container.Resolve<ILogger<QueryStringTenantIdentificationStrategy>>());
+
+    // Create the multitenant container.
+    var multitenantContainer = new MultitenantContainer(strategy, container);
+
+    // Register tenant overrides.
+    multitenantContainer.ConfigureTenant(
+        "some-tenant",
+        cb => cb
+          .RegisterType<OverrideDependency>()
+          .As<IDependency>()
+          .WithProperty("Id", "some-tenant")
+          .InstancePerLifetimeScope());
+
+    // Return the built container for use in the app.
+    return multitenantContainer;
+  }
+}
+```
+
 ## Reference
 
 - [Documentation for Autofac.Multitenant](https://autofac.readthedocs.io/en/latest/advanced/multitenant.html)
 - [Documentation for ASP.NET Core Integration](https://autofac.readthedocs.io/en/latest/integration/aspnetcore.html)
 - [Original explanation of why multitenancy failed in ASP.NET Core](https://stackoverflow.com/questions/38940241/autofac-multitenant-in-an-aspnet-core-application-does-not-seem-to-resolve-tenan/38960122#38960122)
 - [NuGet](https://www.nuget.org/packages/Autofac.AspNetCore.Multitenant)
 - [Contributing](https://autofac.readthedocs.io/en/latest/contributors.html)
+- [Open in Visual Studio Code](https://open.vscode.dev/autofac/Autofac.AspNetCore.Multitenant)