Finbuckle.MultiTenant/CHANGELOG.md

8.0.0 (2024-10-12)

Bug Fixes

• BasePathStrategy no longer breaks the strategy chain (#884) (3263eff)
• prevent duplicate key annotation in AdjustKey() (#883) (f75ba2c)
• removed unused parameter from WithPerTenantRemoteAuthenticationConvention (#886) (dd17ab5)

Features

• add GetAllAsync() support for HttpRemoteStore (#848) (4208149)
• added the Echo Store. (#807) (a3e5eee)
• strategies return null on invalid context type (#885) (9834575)

BREAKING CHANGES

• This commit brings the release into alignment with the new version policy. See #887 for details.
• Included strategies for ASP.NET Core would throw an exception if the passed context was not an HttpContext type. Now they will return null indicating no identifier was found.

7.0.2 (2024-08-03)

Bug Fixes

• Preserve annotations when adjusting index (#832) (e765340)
• strategy wrapper no longer throws on a null context, instead passing it to the actual strategy (#863) (2b165c7)

7.0.1 (2024-04-28)

Bug Fixes

• only throw exception in EnforceMultiTenant for null tenant if there are entity changes. (#819) (ca9e9fd)

7.0.0 (2024-04-21)

⚠ BREAKING CHANGES

• (I)MultiTenantContext and (I)TenantInfo are no longer available via dependency injection. Use IMultiTenantContextAccessor instead. MultiTenantDbContext and MultiTenantIdentityDbContext will require a new constructor that injects IMultiTenantContextAccessor or IMultiTenantContext.
• Many namespaces have been updated for consistency. Most code will only need to use the Finbuckle.MultiTenant or Finbuckle.MultiTenant.Abstractions namespace.
• Connection string is removed from ITenantInfo and the default TenantInfo implementation.
• Added support for OptionsBuilder API and more efficient per-tenant options overall.
• WithPerTenantOptions replaced by ConfigurePerTenant service collection extensions methods.
• Unique indexes and the UserLogin primary key in the standard Identity models adjusted to include tenant id.
• IMultiTenantContext nullability reworked and should never be null.

Features

• better options support (#681) (1859017)
• change default MultiTenantIdentityDbContext default index and key behavior (81f5612)
• MultiTenantDbContext and MultiTenantIdentityDbContext support for IMultiTenantContextAccessor DI (9015085)
• namespace cleaned up (b354838)
• refactor DI and improve nullability (eca24bf)
• remove ConnectionString from ITenantInfo and TenantInfo (f4e20db)

Bug Fixes

• AdjustKey correctly adding TenantId to primary and foreign keys (613b4a8)

6.13.1 (2024-01-24)

Bug Fixes

• update dependency to protect against CVE-2024-21319 (#781) (c5e0c8a)

6.13.0 (2023-12-21)

Features

• .net8.0 LTS release support (#770) (d7f08f9)

Bug Fixes

• OnTenantNotResolved not called correctly (#729) (a26081c), closes #628

6.12.0 (2023-08-25)

Features

• AdjustIndex preserves existing filter (#711) (affb66f)
• net8.0 (#712) (a137dae)

6.11.1 (2023-07-06)

Bug Fixes

• make DecorateService public (#671) (c9746d6), closes #668

6.11.0 (2023-07-01)

Features

• add HasResolvedTenant to IMultiTenantContext (#650) (375add5)
• perf improvements in BasePathStrategy and RemoteAuthenticationCallbackStrategy (#654) (ac1c58a)

Bug Fixes

• internal refactoring and improved XML comments for intellisense (c42c53d)
• xml docs corrections (#639) (265d26d)

6.10.0 (2023-01-30)

Features

• add nongeneric IMultiTenantContext for flexibility (b3a198f)

Bug Fixes

• fixes undesired context tracking across EFCoreStore methods (#633) (3605a75)
• remove netcore3.1 (#632) (6c21fe9)

6.9.1 (2022-11-10)

Bug Fixes

• update for final .NET 7 release (#610) (ac32e7d)

6.9.0 (2022-10-23)

Features

• .net7.0 support (#604) (4d7d54d)

Bug Fixes

• BasePathStrategy combine path bug (0628b0f)

6.8.1 (2022-09-17)

Bug Fixes

• XML comment and generation fix (#588) (c1de82d)

6.8.0 (2022-08-28)

Features

• opened efcorestore to allow overriding methods (#577) (7dac251), closes #574

Bug Fixes

• add missing using statement to samples (#581) (ec8e08e)
• adjust logic in per-tenant-authentication conventions (e78a26f)
• environment configuration in samples (#579) (6df8827)
• update authentication.md (#573) (df55b24)

6.7.3 (2022-07-17)

Bug Fixes

• drop .net 5.0 target (#569) (38fa9e1)
• remove reliance on uncaught exceptions (#563) (a675684)

Performance Improvements

• corrected various async/await code (#557) (fe7c01b)

6.7.2 (2022-04-05)

Bug Fixes

• update scheme provider to support decorator pattern (#551) (ead052a)

6.7.1 (2022-03-10)

Bug Fixes

• use web System.Text.Json setttings and update samples (#544) (266e806)

6.7.0 (2022-03-06)

Features

• Added support for named options (#478) (#534) (6f9528d)

6.6.1 (2022-02-19)

Bug Fixes

• change delegate strategy func return type as nullabe and adds unit test (#525) (80c7104)
• remove tenant id value generator (#524) (0d3dcd8)

6.6.0 (2022-02-13)

Features

• add BasePathStrategy option to rebase the AspNetCore Request.PathBase (#510) (dccf414)
• add nullable reference types to all projects (#514) (e6141fe)
• add strategy type and store type to TenantResolvedContext (#508) (ef52fc2)

Bug Fixes

• actually set the strategy and store types on OnTenantResolvedContext (#509) (fd9029e)
• remove dependency on NewtonSoft.Json (#505) (f83f0b1)

6.5.1 (2021-11-17)

Bug Fixes

• ClaimStrategy validation bypass type principle changed to principal (#493) (fbfd022)

6.5.0 (2021-11-08)

Features

• add .NET 6 support (#489) (a2d0416)

6.4.2 (2021-10-25)

Bug Fixes

• change Options types from internal to public (#483) (af9521d)

6.4.1 (2021-10-11)

Bug Fixes

• options not validating (d4c6f30)

6.4.0 (2021-10-07)

Bug Fixes

• ClaimStrategy bypass cookie principal validation (#475) (cd38a7f)

Features

• add optional parameter to specify the ClaimStrategy authentication scheme. (#398) thanks @Valks! (d74ae41)

6.3.1 (2021-09-30)

Bug Fixes

• revert some platform targets to netstandard (#469) (aceff1d)

6.3.0 (2021-09-06)

Changes

• Removed support for .NET Core 2.1 which ended Microsoft support in August 2020.
• Retargeted specifically to .netcoreapp3.1 and .net5.0 across all packages.
• Added AdjustKey, AdjustIndex, AdjustAlIndexes, AdjustUniqueIndexes methods to be chained off IsMultiTenant in EFCore functionality. They add the implicit TenantId to the respective key/indexes.
• Reverted generic version of IsMultiTenant back to non-generic version for more flexibility.
• Improved tenant resolution logging functionality and performance. Thanks to @lahma!
• Fixed a bug with InMemoryStore implementation of TryUpdate. Thanks to @mphill!
• Fixed a bug where ConfigurationStore would throw an exception if there was no default section in the config.
• Fixed a bug where ASP.NET Core Identity security stamp validation would force user logout and raise exceptions. Thanks to @Nivalux for finding the root cause of this bug.
• Fixed a bug where MultiTenantOptionsManager<TOptions> was internal instead of public.
• Fixed problematic references in sample projects.
• Updated and improved documentation.
• Updated and improved tests.
• Added various project files for .NET Foundation on-boarding.

6.2.0 (2021-02-16)

Changes

• Added a new events system. See PR #359 Thanks to @natelaff!
• Some internal refactoring.
• Various documentation fixes.
• Added sourcelink to allow debugging into remote source code.
• Added a security policy.

6.1.0 (2020-11-10)

Changes

• .NET 5.0 support.
• New DistributedCacheStore uses the ASP.NET Core distributed cache for tenant resolution.
• New HeaderStrategy uses HTTP headers for tenant resolution. Thanks to @natelaff!
• Support for inheritance in multitenant Entity Framework Core entity. Thanks to @rchamorro!
• Fixed a conflict between ClaimStrategy and per-tenant authentication.
• Updated docs, samples, and unit tests.

6.0.0 (2020-09-08)

Changes

• Customizable TenantInfo. Implement ITenantInfo as needed or use the basic TenantInfo implementation. Should work with most strategies and stores. This was a major overhaul to the library. See docs for more information.
• Changed NuGet structure: use Finbuckle.MultiTenant.AspNetCore for web apps and if needed add Finbuckle.MultiTenant.EntityFrameworkCore.
• WithPerTenantAuthentication - Adds support for common per-tenant authentication scenarios. See docs for full details.
• Multiple strategies and stores can be registered. They will run in the order registered and the first tenant returned by a strategy/store combination is used.
• New ClaimStrategy checks for a tenant claim to resolve the tenant.
• New SessionStrategy uses a session variable to resolve the tenant.
• Refactored InMemoryStore, removed deprecated configuration functionality.
• Improved Blazor support.
• Improved support for non ASP.NET Core use cases.
• Removed support for ASP.NET 3.0.
• Removed FallbackStrategy, StaticStrategy is a better alternative.
• Bug fixes, refactors, and tweaks.
• Improved unit tests.
• Updated and improved documentation.
• Updated sample. Removed some older ASP.NET Core 2.1 samples.

5.0.4 (2020-02-12)

Changes

• Fixed a conflicting assembly and NuGet versions.
• Minor documentation fix.

5.0.3 (2020-01-21)

Changes

• Fixed a bug where documented static methods were internal rather than public.
• Minor documentation fix.

5.0.1 (2020-01-15)

Changes

• Updated for .NET Core January 2020 Updates adding support for .NET Core 2.1.15, 3.0.2, and 3.1.1.
• Updated dependencies as recommended in security notices for .NET Core January 2020 Updates.
• Finbuckle.MultiTenant.AspNetCore targets netcoreapp3.1, netcoreapp3.0, and netcoreapp2.1.
• Finbuckle.MultiTenant.Core targets netstandard2.1 and netstandard2.0.
• Finbuckle.MultiTenant.EntityFrameworkCore targets netstandard2.1 and netstandard2.0.

5.0.0 (2020-01-12)

Changes

• Added support for ASP.NET Core 3.1.
• Major refactor of how Entity Framework multitenant data isolation works. No longer need to derive from MultiTenantDbContext greatly improving flexibility. IdentityMultiTenantDbContext reworked under this new model and no longer requires or recommends use of multitenant support classes, e.g. MultiTenantIdentityUser. Attempted to minimize impact, but if using IdentityMultiTenantDbContext this may be a breaking change! Thanks @GordonBlahut!
• Simplified EFCoreStore to use TenantInfo directly. This is a breaking change!
• Fixed a bug with user id not being set correctly in legacy IdentityMultiTenantDbContext.
• Added ConfigurationStore to load tenant information from app configuration. The store is read-only in code, but changes in configuration (e.g. appsettings.json) are picked up at runtime. Updated most sample projects to use this store.
• Deprecated InMemoryStore functionality that reads from configuration.
• Added HttpRemoteStore which will make an http request to get a TenantInfo object. It can be extended with DelegatingHandlers (i.e. to add authentication headers). Added sample projects for this store. Thanks to @colindekker!
• Fixed an exception with OpenIdConnect remote authentication if "state" is not returned from the identity provider. The new behavior will result in no tenant found for the request.
• Updated samples.
• Updated documentation.
• Updated unit tests to check against all valid project targets.
• Symbols package included for debugging.

4.0.0 (2019-09-24)

Changes

• Added support for ASP.NET Core 3! Valid project targets are netcoreapp3.0, netcoreapp2.0, and netcoreapp2.1.
• Added a sample app for ASP.NET 3 highlighting the route strategy improvements due to the endpoint routing mechanism.
• Fixed a bug where route strategy could throw an exception when used with Razor Pages. Thanks @stardocs-services!
• Support for configuring multiple multitenant strategies. Each will be tried in the order configured until a non-null tenant identifier is returned. The exception is the fallback strategy which always goes last.
• Refactored component assemblies for better dependency control. EFCore can be excluded by referencing Finbuckle.MultiTenant.AspNetCore instead of Finbuckle.MultiTenant.
• Updated documentation.
• Updated unit tests to check against all valid project targets.
• Symbols package included for debugging.

3.2.0 (2019-09-08)

Changes

• Added support for any preexisting global query filters in MultiTenantDbContext and MultiTenantIdentityDbContext. Thanks @nbarbettini!
• Exposed the inner stores and strategies as a property on the respective StoreInfo and StrategyInfo properties of MultiTenantContext. Previously you could only access the wrapper object for each. Thanks @WalternativE!
• Fixed certain methods on MultiTenantOptionsCache to be external as originally intended. Thanks @chernihiv!
• Fix a bug with TryUpdateAsync in the wrapper store. Thanks @steebwba!
• Updated documentation and fixed typos. Thanks @MesfinMo!

3.1.0 (2019-06-09)

Changes

• Added a strategy wrapper that handles validation and logging for the active strategy. When implementing IMultiTenantStrategy basic validation and logging are automatically provided.
• Added the delegate strategy that accepts a lambda to return the tenant identifier. Configure by calling WithDelegateStrategy(...).
• Added the fallback strategy that provides a tenant identifier if the normal strategy (or remote authentication, if applicable) fails to resolve a tenant. Configure by calling WithFallbackStrategy(...).
• Added TrySetTenantInfo as an extension method to HttpContext. This will set the TenantInfo provided as the current tenant for the request and can optionally reset the service providers so that scoped services are regenerated under the new tenant.
• Updated and improved documentation and sample projects.
• Miscellaneous bug fixes, code improvement, and unit tests.
• Thanks to @nbarbettini for contributing to this release.

3.0.1 (2019-05-05)

Changes

• Refactored the global query filter used in MultiTenantDbContext and MultiTenantIdentityDbContext (Thanks @GordonBlahut!) for better performance and code quality.
• Removed custom IModelCacheKeyFactory as it is no longer needed due to the global query filter changes.
• Updated documentation and samples.

3.0.0 (2019-04-01)

Changes

• Allow resetting option cache per-tenant. This is a breaking change.
• Host strategy can match entire domain as a special case (prior it only matched a single host segment).
• Added a sample project demonstrating a common login page shared by all tenants.
• Overhauled documentation.
• Updated unit and integration tests.
• Switch to Apache 2.0 license.

2.0.2 (2019-02-05)

Changes

• Fixed bug in Identity where UserLogins primary key was not adjusted for multitenant usage.
• Updated and Fixed the IdentityDataIsolation sample project.
• General code and test cleanup.

2.0.1 (2019-01-07)

Changes

• Fixed bug where the TenantInfo constructor did not save the passed Items collection.
• Tested for compatibility with ASP.NET Core 2.2.
• Updated samples for ASP.NET Core 2.2.
• Cleaned up library dependencies to target ASP.NET Core 2.1 or greater.

2.0.0 (2018-12-03)

Changes

• Changed TenantContext to MultiTenantContext which includes TenantInfo, StrategyInfo, and StoreInfo properties.
• Namespace changes (e.g. use of Microsoft.Extensions.DependencyInjection namespace for Configure and ConfigureServices methods).
• Additional and improved unit tests.
• Updated sample project dependencies.
• Various other internal improvements to code and bug fixes.
• TryUpdate method added to IMultiTenantStore interface.
• Added EFCoreStore which allows an Entity Framework Core database context as the tenant store.
• Added sample project demonstrating use of EFCoreStore.
• Custom can be configured with custom dependency injection lifetime (single, scoped, or transient) via WithStore method overloads.
• Custom stores automatically receive logging and error support via internal use of MultiTenantStoreWrapper.
• Use of async/await for strategy execution for improved performance.
• Custom strategies can be configured with custom dependency injection lifetime (single, scoped, or transient) via WithStrategy method overloads.
• Moved route configuration for RouteStrategy from UseMultiTenant to WithRouteStrategy.

1.2.0 (2018-07-22)

Changes

• Added variants of MultiTenantIdentityDbContext which allows more flexible integration with Identity (Thanks @Cpcrook!)
• Added sample project for data isolation with Identity
• Minor refactoring and more unit tests
• Various bug fixes

1.1.1 (2018-05-22)

Changes

• Fixed bug affecting per-tenant data isolation using a shared database
• Added sample project for data isolation
• Added new constructors for MultiTenantDbContext and MultiTenantIdentityDbContext

1.1.0 (2018-04-22)

Changes

• Remote authentication support
• Strategy improvements
• Store improvements
• Per-tenant options improvements
• Logging support
• Updated samples
• Improved unit and integration tests
• Switch to Apache 2.0 license

1.0.0 (2018-01-01)

Changes

• Initial release