https://github.com/pub-dev/mellon.multitenant
A library created to help with multi-tenant applications made in net
https://github.com/pub-dev/mellon.multitenant
azure-app-configuration configuration-loader dotnet dotnet-core hangfire hangfire-dotnet-core hangfire-extension hangfire-multitenant multi-tenant multi-tenant-applications multitenant pub-dev pubdev scharp spring-cloud-config-dotnet
Last synced: 3 months ago
JSON representation
A library created to help with multi-tenant applications made in net
- Host: GitHub
- URL: https://github.com/pub-dev/mellon.multitenant
- Owner: Pub-Dev
- License: mit
- Created: 2022-12-27T02:02:22.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-10T20:03:17.000Z (11 months ago)
- Last Synced: 2025-10-26T21:13:08.476Z (3 months ago)
- Topics: azure-app-configuration, configuration-loader, dotnet, dotnet-core, hangfire, hangfire-dotnet-core, hangfire-extension, hangfire-multitenant, multi-tenant, multi-tenant-applications, multitenant, pub-dev, pubdev, scharp, spring-cloud-config-dotnet
- Language: C#
- Homepage: https://pub-dev.github.io/Mellon.MultiTenant
- Size: 152 KB
- Stars: 41
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![LinkedIn][linkedin-shield]][linkedin-url] [![LinkedIn][linkedin-shield]][linkedin2-url]
## Mellon.MultiTenant by [@PubDev](https://www.youtube.com/@PubDev)
| Package | Version | Alpha |
| :---------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: |
| **Mellon.MultiTenant** | [](https://www.nuget.org/packages/Mellon-MultiTenant) | [](https://www.nuget.org/packages/Mellon-MultiTenant) |
| **Mellon.MultiTenant.Base** | [](https://www.nuget.org/packages/Mellon-MultiTenant-Base) | [](https://www.nuget.org/packages/Mellon-MultiTenant-Base) |
| **Mellon.MultiTenant.ConfigServer** | [](https://www.nuget.org/packages/Mellon-MultiTenant-ConfigServer) | [](https://www.nuget.org/packages/Mellon-MultiTenant-ConfigServer) |
| **Mellon.MultiTenant.Azure** | [](https://www.nuget.org/packages/Mellon-MultiTenant-Azure) | [](https://www.nuget.org/packages/Mellon-MultiTenant-Azure) |
| **Mellon.MultiTenant.Hangfire** | [](https://www.nuget.org/packages/Mellon-MultiTenant-Hangfire) | [](https://www.nuget.org/packages/Mellon-MultiTenant-Hangfire) |
 [](https://raw.githubusercontent.com/1bberto/Mellon.MultiTenant/main/LICENSE) [](https://github.com/Pub-Dev/Mellon.MultiTenant/actions/workflows/buildAndPush.yml)
Why Mellon, mellon is the Sindarin (and Noldorin) word for "friend", yes I'm a big fan of LoR, so let's be friends?
## About The Project
This library was created to supply a set of tools to enable the creation of multi-tenant applications using .net.
### Built With
- [net8](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
- [steeltoe](https://docs.steeltoe.io/api/v3/configuration)
- [Azure App Configuration](https://learn.microsoft.com/en-us/azure/azure-app-configuration/overview)
- [Spring Cloud Config](https://cloud.spring.io/spring-cloud-config/reference/html)
- The most important, Love ❤️
## Getting Started
## Installation
With package Manager:
```
Install-Package Mellon.MultiTenant
```
With .NET CLI:
```
dotnet add package Mellon.MultiTenant
```
### Configurations
There are two ways to configure the settings, via config and through the api
#### Settings
```json
"MultiTenant": {
"ApplicationName": "customer-api",
"HttpHeaderKey": "x-tenant-name",
"CookieKey": "tenant-name",
"QueryStringKey": "tenant-name",
"TenantSource": "Settings",
"SkipTenantCheckPaths": ["^/swagger.*"],
"Tenants": [
"client-a",
"client-b",
"client-c"
]
}
```
| Property | Description | Default |
| :------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------: |
| ApplicationName | Application name | IHostEnvironment.ApplicationName |
| HttpHeaderKey | HTTP Header key, where the tenant name will be passed | `null` |
| CookieKey | HTTP Cookie key, where the tenant name will be passed | `null` |
| QueryStringKey | HTTP Query String key, where the tenant name will be passed | `null` |
| TenantSource | Where the list of possible tenants will be stored, it can be from two sources: `Settings` or `EnvironmentVariables` | `Settings` |
| Tenants | When the property `TenantSource` is set to `Settings` this property must contain the list of tenants | `null` |
| WithDefaultTenant | When the tenant is not defined by the caller the lib will set the tenant as the tenant defined within this property, use it just when actually needed 😉👍 | `null` |
| SkipTenantCheckPaths | Endpoints which the tenant do not need to be identified, for example: Swagger endpoints, you can use a regex string `^/swagger.*` | `null` |
When `TenantSource` is set to `EnvironmentVariables` it will get the tenant list from the environment variable `MULTITENANT_TENANTS`, this environment variable must contain the list of possible tenants in a single string, separating the tenants using `,`
for example:
```
$Env:MULTITENANT_TENANTS = 'client-a,client-b,client-c'
```
### Using the API
You can also set the settings using these options while you are adding the services
```csharp
builder.Services
.AddMultiTenant(options =>
options
.WithApplicationName("customer-api")
.WithHttpHeader("x-tenant-name")
.WithCookie("tenant-name")
.WithQueryString("tenant-name")
.WithDefaultTenant("client-a")
.LoadFromSettings()
);
```
#### `WithApplicationName(string)`
- Set the application name
#### `WithHttpHeader(string)`
- Set the HTTP Header key, where the tenant name will be passed
#### `WithCookie(string)`
- Set the HTTP Cookie key, where the tenant name will be passed
#### `WithQueryString(string)`
- Set the HTTP Query String key, where the tenant name will be passed
#### `WithDefaultTenant(string)`
- Set for when the tenant is not defined by the caller the lib will set the tenant as the tenant defined within this property, use it just when needed 😉👍
### `WithSkipTenantCheckPaths(string)`
- Add a path that will be skipped during the tenant identification
### `WithSkipTenantCheckPaths(params string[])`
- Add paths that will be skipped during the tenant identification
#### `LoadFromSettings`
- Set for when the tenant list will be loaded from the settings **MultiTenant:Tenants**
#### `LoadFromEnvironmentVariable`
- Set for when the tenant list will be loaded from the environment variable **MULTITENANT_TENANTS**
#### `LoadFromEndpoint(Func func)` and `LoadFromEndpoint(Func func)`
- Define a Func or pass a type to define how the tenant list will be loaded from a http endpoint, to make it work you need to pass a new set of properties on the app settings
```json
"MultiTenant": {
// other settings...
"Endpoint": {
"Url": "[endpoint]",
"Method": "GET",
"Authorization": "Basic $user $password"
},
// other settings...
}
```
If the endpoint has authorization you can set the credencials on the property `Authorization`
You can pass the Func and do what you see fit when getting the list of tenants
Example:
```csharp
services
.AddMultiTenant(options => options.LoadFromEndpoint((endpointOptions, configuration) =>
{
var request = new HttpRequestMessage()
{
RequestUri = new Uri(endpointOptions.Url),
Method = new HttpMethod(endpointOptions.Method),
};
if (!string.IsNullOrEmpty(endpointOptions.Authorization))
{
request.Headers.Add("Authorization", endpointOptions.Authorization);
}
using (var client = new HttpClient())
{
var result = client.Send(request);
if (result.IsSuccessStatusCode)
{
var data = result.Content.ReadFromJsonAsync>().GetAwaiter().GetResult();
return data!.Select(x => x.Id).ToArray();
}
else
{
var statusCode = result.StatusCode;
var reason = result.ReasonPhrase;
var content = result.Content.ReadAsStringAsync().GetAwaiter().GetResult();
throw new Exception($@"Error to load tenants from the url {endpointOptions.Url} StatusCode: {statusCode} Reason: {reason} Content: {content}");
}
}
}));
```
Or if your use case does not require customization you can just call the other method, Which behind the scene does basically a http request to the endpoint set on the `Endpoint` settings, respecting the `Url`, `Method` and `Authorization`
Example:
```csharp
services
.AddMultiTenant(options => options.LoadFromEndpoint(x => x.TenantId));
```
#### `WithHttpContextLoad(Func func)`
- When all the possibilities above do not meet your need you can create a custom "Middleware" to identify the tenant based on a `HttpContext`
#### `WithCustomTenantConfigurationSource()`
- `T` must be an implementation of the interface `ITenantConfigurationSource` use it to define new a source of configurations for the tenants, for example, if the tenant settings are stored on XML files you could create something like this:
```csharp
public class LocalXmlTenantSource : ITenantConfigurationSource
{
private readonly IHostEnvironment _hostEnvironment;
public LocalTenantSource(
IHostEnvironment hostEnvironment)
{
_hostEnvironment = hostEnvironment;
}
public IConfigurationBuilder AddSource(
string tenant,
IConfigurationBuilder builder)
{
builder.AddXmlFile($"appsettings.{tenant}.xml", true);
builder.AddXmlFile($"appsettings.{tenant}.{_hostEnvironment.EnvironmentName}.xml", true);
return builder;
}
}
```
### Local
This is the default source of settings for the tenants, there is no need to enable it, it will search for the settings on the application following this pattern:
- `appsettings.{tenant}.json`
- `appsettings.{tenant}.{_hostEnvironment.EnvironmentName}.json`
It is also worth mentioning that the configurations will also contain:
- `appsettings.json`
- `appsettings.[environment].json`
- `environment variables`
### Spring Cloud Config
You can also load the settings from a **Spring Cloud Config Server**!
To enable the usage you need to install an extra package:
With package Manager:
```
Install-Package Mellon.MultiTenant.ConfigServer
```
With .NET CLI:
```
dotnet add package Mellon.MultiTenant.ConfigServer
```
Once the package is installed you need to configure its services
```csharp
builder.Services
.AddMultiTenant()
.AddMultiTenantSpringCloudConfig();
```
To setup [Spring Cloud Config](https://cloud.spring.io/spring-cloud-config/reference/html) on your environment check this reporitory [DotNet-ConfigServer](https://github.com/Pub-Dev/Lesson-DotNet-ConfigServer)
The application name for spring cloud config will be based on the settings _**MultiTenant.ApplicationName**_ and the label will be tenant name.
Example:
_customer-api-client-a.yaml_
being:
- _customer-api_ the application name
- _client-a_ the tenant name
Moreover, it is worth mentioning that the settings for each customer will also have the settings of the current files:
- appsettings.json
- appsettings.[environment].json
- environment variables
### Azure App Configuration
You can also use it as a source of configuration the **Azure App Configuration**
With package Manager:
```
Install-Package Mellon.MultiTenant.Azure
```
With .NET CLI:
```
dotnet add package Mellon.MultiTenant.Azure
```
Once the package is installed you need to configure its services
```csharp
builder.Services
.AddMultiTenant()
.AddMultiTenantAzureAppConfiguration();
```
#### `AddMultiTenantAzureAppConfiguration(Action action = null)`
if the action is not passed, the connection string used to connect on azure will be loaded from `AzureAppConfigurationConnectionString`
if you want to elaborate more, on how you are going to connect on Azure, you can use the `AzureMultiTenantOptions`, there is a property, which is a `Func>`, where the first parameter is the ServiceProvider, where you can extract the services; a string, being the tenant name; and the return of this `Func` must be an `Action`.
For example:
```csharp
builder.Services
.AddMultiTenant()
.AddMultiTenantAzureAppConfiguration(options =>
options.AzureAppConfigurationOptions = (serviceProvider, tenant) =>
{
var configuration = serviceProvider.GetRequiredService();
return azureOptions => azureOptions
.Connect(configuration["AzureAppConfigurationConnectionString"])
.Select("*", tenant);
}
);
```
## Hangfire
If you need to work with jobs with the concept of multi-tenant using **Hangfire**
To enable the usage you need to install an extra package:
With package Manager:
```
Install-Package Mellon.MultiTenant.Hangfire
```
With .NET CLI:
```
dotnet add package Mellon.MultiTenant.Hangfire
```
Once the package is installed you need to configure its services
```csharp
builder.Services
.AddMultiTenant()
.AddMultiTenantHangfire();
```
And when adding the Service `AddHangfire` you need to call the method `UseMultiTenant` passing the `IServiceProvider`
```csharp
builder.Services.AddHangfire((serviceProvider, config) =>
{
// some code
config.UseMultiTenant(serviceProvider);
// some code
});
```
To create the Worker, you need to pass the queues with the tenant names
```csharp
builder.Services.AddHangfireServer((serviceProvider, config) =>
{
var multiTenantSettings = serviceProvider.GetRequiredService();
var queues = new List(multiTenantSettings.Tenants);
// if you want to add more queues
queues.Add("cron");
queues.Add("default");
config.Queues = tenants.ToArray();
// some code
});
```
For **ScheduleJobs** and **BackgroundJob** the queue name will be the _tenant name_
For **RecurringJobs** the default queue could vary from job to job
### RecurringJobs 🗓️
To create Recurring Jobs you just need to use the interface `IMultiTenantRecurringJobManager`, this interface will have the following methods and extension methods:
#### `AddOrUpdateForAllTenants(string recurringJobId,Expression> methodCall, string cronExpression, TimeZoneInfo timeZone = null,string queue = "default")`
It will create a recurring job from the type `T.Method` for all the tenants
#### `AddOrUpdateForAllTenants(string recurringJobId, Job job, string cronExpression, TimeZoneInfo timeZone)`
It will create a recurring job for all the tenants
#### `AddOrUpdate(string recurringJobId,Expression> methodCall, string cronExpression, TimeZoneInfo timeZone = null,string queue = "default")`
It will create a recurring job from the type `T.Method` for the current tenant
#### `AddOrUpdate(string recurringJobId, Job job, string cronExpression, TimeZoneInfo timeZone)`
It will create a recurring job for the current tenant
#### `RemoveIfExistsForAllTenants(string recurringJobId)`
It will remove the recurring job for all the tenants
#### `RemoveIfExists(string recurringJobId)`
It will remove the recurring job for the current tenants
#### `TriggerForAllTenants(string recurringJobId)`
It will enqueue the recurring job for all the tenants
#### `Trigger(string recurringJobId)`
It will enqueue the recurring job for the current tenants
### Background Jobs ⚙️
To create Background Jobs you just need to use the interface `IMultiTenantBackgroundJobManager`, this interface will have the following methods and extension methods:
#### `EnqueueForAllTenants(Expression methodCall)`
It will enqueue a job execution for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId created for that tenant
#### `EnqueueForAllTenants(Expression> methodCall)`
It will enqueue a job execution for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId created for that tenant
#### `EnqueueForAllTenants(Expression> methodCall)`
It will enqueue a job execution of type `T.Method` for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId created for that tenant
#### `EnqueueForAllTenants(Expression> methodCall)`
It will enqueue a job execution of type `T.Task` for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId created for that tenant
#### `Enqueue(Expression methodCall)`
It will enqueue a job execution for the current tenant, sending the job for a queue with the tenant's name, the return the jobId
#### `Enqueue(Expression> methodCall)`
It will enqueue a job execution for the current tenant, sending the job for a queue with the tenant's name, the return the jobId
#### `Enqueue(Expression> methodCall)`
It will enqueue a job execution of type `T.Method` for the current tenant, sending the job for a queue with the tenant's name, the return the jobId
#### `Enqueue(Expression> methodCall)`
It will enqueue a job execution of type `T.Task` for the current tenant, sending the job for a queue with the tenant's name, the return the jobId
### Schedule Jobs ⌚
To Schedule Jobs you just need to use the interface `IMultiTenantBackgroundJobManager`, this interface will have the following methods and extension methods:
#### `ScheduleForAllTenants(Expression methodCall, TimeSpan delay)`
It will Schedule a job execution for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId Scheduled for that tenant
#### `ScheduleForAllTenants((Expression> methodCall, TimeSpan delay)`
It will Schedule a job execution for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId Scheduled for that tenant
#### `ScheduleForAllTenants(Expression> methodCall, TimeSpan delay)`
It will Schedule a job execution of type `T.Method` for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId Scheduled for that tenant
#### `ScheduleForAllTenants(Expression> methodCall, TimeSpan delay)`
It will Schedule a job execution of type `T.Task` for all the tenant, sending the jobs for a queue with the tenant's name, the return object with consist in a list containing the tenant and the JobId Scheduled for that tenant
#### `Schedule(Expression methodCall, TimeSpan delay)`
It will Schedule a job execution for the current tenant, sending the job for a queue with the tenant's name, returning the Scheduled JobId
#### `Schedule(Expression> methodCall, TimeSpan delay)`
It will enqueue a job execution for the current tenant, sending the job for a queue with the tenant's name, returning the Scheduled JobId
#### `Schedule(Expression> methodCall, TimeSpan delay)`
It will enqueue a job execution of type `T.Method` for the current tenant, sending the job for a queue with the tenant's name, returning the Scheduled JobId
#### `Schedule(Expression> methodCall, TimeSpan delay)`
It will enqueue a job execution of type `T.Task` for the current tenant, sending the job for a queue with the tenant's name, returning the Scheduled JobId
## Usage / Samples
You can find some examples of how to use this library in the folder `/samples` with WebApi and Hangfire examples
### Web API
To enable it on your api you first need to add the services:
```csharp
builder.Services.AddMultiTenant();
```
then you need also to register the middleware used to identify the tenant based on the `HttpContext`
```csharp
app.UseMultiTenant();
```
Once that is done you will be able to use the interface `IMultiTenantConfiguration`, this interface will behave the same as the `IConfiguration` interface, but contain only the current tenant settings:
Example:
```csharp
app.MapGet("/", (IMultiTenantConfiguration configuration) =>
{
return new
{
Tenant = configuration.Tenant,
Message = configuration["Message"],
};
});
```
### EF Core Migrations:
To use it with EF Core is quite simple, you need to use the interface `IMultiTenantConfiguration` as mentioned above to setup your EF Context
#### Setup
```csharp
builder.Services.AddDbContext(
(IServiceProvider serviceProvider, DbContextOptionsBuilder options) =>
{
var configuration = serviceProvider.GetRequiredService();
options.UseSqlServer(configuration?["ConnectionStrings:DefaultConnection"]);
});
```
#### Migrations
To apply the migrations, you only need to do this:
```csharp
var tenants = app.Services.GetRequiredService();
foreach (var tenant in tenants.Tenants)
{
using (var scope = app.Services.CreateScope())
{
var tenantSettings = scope.ServiceProvider.GetRequiredService();
tenantSettings.SetCurrentTenant(tenant);
var db = scope.ServiceProvider.GetRequiredService();
await db.Database.MigrateAsync();
}
}
app.Run();
```
## Extras
We know that settings can be changed all the time, but to get our applications running on with the latest settings we need to restart the application, it caused downtime and it's not very practical. Keeping that in mind, we added also an endpoint that when called will refresh all the settings for all the tenants or a specific tenant:
- `/refresh-settings`
- `/refresh-settings/{tenantName}`
PS: this will work only with AzureAppConfiguration and SpringCloudConfig
## Roadmap
- [ ] Add unit tests 🧪
- [x] Add new Config Source
- [x] Load the Tenants from a web-api request
- [x] Enable the usage with HangFire
- [x] Update documentation with new features
See the [open issues](https://github.com/Pub-Dev/Mellon.MultiTenant/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Contact
- Humberto Rodrigues - [@1bberto](https://instagram.com/1bberto) - humberto_henrique1@live.com
- Rafael Nagai - [@naganaga](https://instagram.com/rafakenji23) - rafakenji23@gmail.com
Project Page: [https://pub-dev.github.io/Mellon.MultiTenant](https://pub-dev.github.io/Mellon.MultiTenant)
[contributors-shield]: https://img.shields.io/github/contributors/1bberto/Mellon.MultiTenant.svg?style=for-the-badge
[contributors-url]: https://github.com/Pub-Dev/Mellon.MultiTenant/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/1bberto/Mellon.MultiTenant.svg?style=for-the-badge
[forks-url]: https://github.com/Pub-Dev/Mellon.MultiTenant/network/members
[stars-shield]: https://img.shields.io/github/stars/1bberto/Mellon.MultiTenant.svg?style=for-the-badge
[stars-url]: https://github.com/Pub-Dev/Mellon.MultiTenant/stargazers
[issues-shield]: https://img.shields.io/github/issues/1bberto/Mellon.MultiTenant.svg?style=for-the-badge
[issues-url]: https://github.com/Pub-Dev/Mellon.MultiTenant/issues
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/humbberto
[linkedin2-url]: https://br.linkedin.com/in/rafakenji