mirror of https://github.com/abpframework/abp.git
selman koc
1 year ago
committed by
GitHub
GitHub
108 changed files with 1157 additions and 302 deletions
@ -0,0 +1,203 @@ |
|||||
|
# ABP Platform 9.3 RC Has Been Released |
||||
|
|
||||
|
We are happy to release [ABP](https://abp.io) version **9.3 RC** (Release Candidate). This blog post introduces the new features and important changes in this new version. |
||||
|
|
||||
|
Try this version and provide feedback for a more stable version of ABP v9.3! Thanks to you in advance. |
||||
|
|
||||
|
## Get Started with the 9.3 RC |
||||
|
|
||||
|
You can check the [Get Started page](https://abp.io/get-started) to see how to get started with ABP. You can either download [ABP Studio](https://abp.io/get-started#abp-studio-tab) (**recommended**, if you prefer a user-friendly GUI application - desktop application) or use the [ABP CLI](https://abp.io/docs/latest/cli). |
||||
|
|
||||
|
By default, ABP Studio uses stable versions to create solutions. Therefore, if you want to create a solution with a preview version, first you need to create a solution and then switch your solution to the preview version from the ABP Studio UI: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
## Migration Guide |
||||
|
|
||||
|
There are a few breaking changes in this version that may affect your application. Please read the migration guide carefully, if you are upgrading from v9.2 or earlier: [ABP Version 9.3 Migration Guide](https://abp.io/docs/9.3/release-info/migration-guides/abp-9-3) |
||||
|
|
||||
|
## What's New with ABP v9.3? |
||||
|
|
||||
|
In this section, I will introduce some major features released in this version. |
||||
|
Here is a brief list of titles explained in the next sections: |
||||
|
|
||||
|
* Cron Expression Support for Background Workers |
||||
|
* Docs Module: PDF Export |
||||
|
* Angular UI: Standalone Package Structure |
||||
|
* Upgraded to Blazorise v1.7.7 |
||||
|
* Audit Logging Module: Excel Export |
||||
|
|
||||
|
### Cron Expression Support for Background Workers |
||||
|
|
||||
|
We've enhanced the [Background Workers System](https://abp.io/docs/9.3/framework/infrastructure/background-workers) by adding support for Cron expressions when using [Hangfire](https://abp.io/docs/9.3/framework/infrastructure/background-workers/hangfire) or [Quartz](https://abp.io/docs/9.3/framework/infrastructure/background-workers/quartz) as the background worker manager. This new feature provides more flexibility in scheduling background tasks compared to the simple period-based timing system. |
||||
|
|
||||
|
Now you can define complex scheduling patterns using standard Cron expressions. For example, you can schedule a task to run: "Every day at midnight", "Every Monday at 9 AM", or "First day of every month". |
||||
|
|
||||
|
Here's how you can use it in your background worker: |
||||
|
|
||||
|
```csharp |
||||
|
public class MyPeriodicBackgroundWorker : AsyncPeriodicBackgroundWorkerBase |
||||
|
{ |
||||
|
public MyPeriodicBackgroundWorker( |
||||
|
AbpAsyncTimer timer, |
||||
|
IServiceScopeFactory serviceScopeFactory) |
||||
|
: base(timer, serviceScopeFactory) |
||||
|
{ |
||||
|
// You can either use Period for simple intervals |
||||
|
Timer.Period = 600000; //10 minutes |
||||
|
|
||||
|
// 👇 or use CronExpression for more complex scheduling 👇 |
||||
|
CronExpression = "0 0/10 * * * ?"; //Run every 10 minutes |
||||
|
} |
||||
|
|
||||
|
protected async override Task DoWorkAsync( |
||||
|
PeriodicBackgroundWorkerContext context) |
||||
|
{ |
||||
|
// Your background work... |
||||
|
} |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
The `CronExpression` property takes precedence over the `Period` property when both are set. This feature is available when you use either the [Hangfire](https://abp.io/docs/9.3/framework/infrastructure/background-workers/hangfire) or [Quartz](https://abp.io/docs/9.3/framework/infrastructure/background-workers/quartz) background worker managers. |
||||
|
|
||||
|
> See the [Background Workers documentation](https://abp.io/docs/9.3/framework/infrastructure/background-workers) for more information about configuring and using background workers with Cron expressions. |
||||
|
|
||||
|
### Docs Module: PDF Export |
||||
|
|
||||
|
We're excited to introduce a new feature in the Docs Module that allows users to export documentation as PDF files. This feature makes it easier for users to access documentation offline or share it with team members who might not have immediate access to the online documentation system. |
||||
|
|
||||
|
**Administrators can generate PDF files from the back-office side**: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
and **then a "Download PDF" button appears in the document system** (as shown in the image below - the bottom right of the navigation menu -), allowing users to download the compiled documentation as a PDF file: |
||||
|
|
||||
|
 |
||||
|
|
||||
|
The feature supports multiple versions of documentation, different language variants, and ensures proper formatting of all content including code blocks and technical documentation. |
||||
|
|
||||
|
### Angular UI: Standalone Package Structure |
||||
|
|
||||
|
ABP v9.3 introduces support for Angular's standalone components architecture while maintaining **full compatibility with existing module-based applications**. This update aligns with Angular's strategic direction toward standalone components as the recommended approach for building Angular applications. |
||||
|
|
||||
|
The key improvements include: |
||||
|
|
||||
|
* **Dual-support routing configurations** that work seamlessly with both module-based and standalone approaches |
||||
|
* **ABP Suite integration** for generating code that supports standalone components |
||||
|
* **Updated schematics** that provide templates for both development patterns |
||||
|
|
||||
|
This enhancement gives developers the flexibility to choose their preferred Angular architecture. Existing module-based applications **continue to work without modifications**, while new projects can leverage the standalone approach for simplified dependency management, reduced boilerplate code, and better lazy-loading capabilities. |
||||
|
|
||||
|
> For developers interested in migrating to standalone components or starting new projects, we'll be publishing a comprehensive blog post with detailed guidance and best practices. In the meantime, you can check [#22829](https://github.com/abpframework/abp/pull/22829) for implementation details of the standalone package structure and make the necessary changes to your project. |
||||
|
|
||||
|
### Upgraded to Blazorise v1.7.7 |
||||
|
|
||||
|
Upgraded the [Blazorise](https://blazorise.com/) library to v1.7.7 for Blazor UI. If you are upgrading your project to v9.3.0, please ensure that all the Blazorise-related packages are using v1.7.7 in your application. Otherwise, you might get errors due to incompatible versions. |
||||
|
|
||||
|
> See [#23013](https://github.com/abpframework/abp/pull/23013) for the updated NuGet packages. |
||||
|
|
||||
|
### Audit Logging Module: Excel Export |
||||
|
|
||||
|
In this version, we've added Excel export capabilities to the [Audit Logging Module](https://abp.io/docs/latest/modules/audit-logging-pro), allowing administrators to export audit logs and entity changes to Excel files for further analysis or reporting purposes. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
This feature enables users to: |
||||
|
|
||||
|
- Export audit logs with filtering options |
||||
|
- Export entity changes with detailed information |
||||
|
- Receive email notifications when exports are completed or fail |
||||
|
- Download exported files via secure links |
||||
|
|
||||
|
The export process runs in the background, and once completed, users receive an email with a download link. This approach ensures that even large audit log exports don't block the UI or time out during processing. |
||||
|
|
||||
|
You can configure various aspects of this feature using the `AuditLogExcelFileOptions` in your module's configuration: |
||||
|
|
||||
|
```csharp |
||||
|
Configure<AuditLogExcelFileOptions>(options => |
||||
|
{ |
||||
|
// How long to keep exported files before cleanup |
||||
|
options.FileRetentionHours = 48; |
||||
|
|
||||
|
// Base URL for download links in notification emails |
||||
|
options.DownloadBaseUrl = "https://yourdomain.com"; |
||||
|
|
||||
|
// Configure the cleanup worker schedule |
||||
|
options.ExcelFileCleanupOptions.Period = (int)TimeSpan.FromHours(24).TotalMilliseconds; |
||||
|
|
||||
|
// Use cron expression for more advanced scheduling (requires Hangfire or Quartz) |
||||
|
options.ExcelFileCleanupOptions.CronExpression = "0 2 * * *"; // Run at 2 AM daily |
||||
|
}); |
||||
|
``` |
||||
|
|
||||
|
The module includes pre-configured email templates for notifications about completed or failed exports, ensuring users are always informed about the status of their export requests. |
||||
|
|
||||
|
> **Note**: This feature requires a configured BLOB storage provider to store the generated Excel files. See the [BLOB Storing documentation](https://abp.io/docs/9.3/framework/infrastructure/blob-storing) for more information. |
||||
|
|
||||
|
For more details about the Audit Logging Module and its Excel export capabilities, please refer to the [official documentation](https://abp.io/docs/9.3/modules/audit-logging-pro). |
||||
|
|
||||
|
## Community News |
||||
|
|
||||
|
### Announcing ABP Studio 1.0 General Availability 🚀 |
||||
|
|
||||
|
 |
||||
|
|
||||
|
We are thrilled to announce that ABP Studio has reached version 1.0 and is now generally available! This marks a significant milestone for our integrated development environment designed specifically for ABP developers. The stable release brings several powerful features including: |
||||
|
|
||||
|
* Enhanced Solution Runner with health monitoring capabilities |
||||
|
* Theme style selection during project creation (Basic, LeptonX Lite, and LeptonX Themes) |
||||
|
* New "Container" application type for better Docker container management |
||||
|
* Improved handling of multiple DbContexts for migration operations |
||||
|
|
||||
|
> For a detailed overview of these features and to learn more about what's coming next, check out our [announcement post](https://abp.io/community/articles/announcing-abp-studio-1-0-general-availability-82yw62bt). |
||||
|
|
||||
|
### ABP Community Talks 2025.05: Empower Elsa Workflows with AI in .NET + ABP Framework |
||||
|
|
||||
|
In this episode of ABP Community Talks, 2025.05, we are thrilled to host [**Sipke Schoorstra**](https://github.com/sfmskywalker), the creator of the [Elsa Workflows](https://docs.elsaworkflows.io/) library! This month's session is all about **"Empower Elsa Workflows with AI in .NET + ABP Framework"**. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
Sipke will join us to demonstrate how you can leverage AI within Elsa Workflows using .NET and the ABP Framework. The session will explore practical techniques and showcase how to integrate AI capabilities to enhance and automate your business processes within the Elsa workflow engine. |
||||
|
|
||||
|
> 👉 Don't miss this opportunity to learn directly from the creator of Elsa and see real-world examples of building intelligent, automated workflows! You can register from [here](https://kommunity.com/volosoft/events/abp-community-talks-202505empower-elsa-workflows-with-ai-in-netabp-framework-3965dd32). |
||||
|
|
||||
|
### ABP Bootcamp: Mastering Infrastructure & Features |
||||
|
|
||||
|
We are excited to announce the very first **ABP Bootcamp: Mastering Infrastructure & Features**! This is a live training program designed to give you hands-on, practical experience with ABP's core infrastructure and features. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
Join the ABP Bootcamp to learn directly from the core team in a focused, hands-on program designed for busy developers. Over four days, you'll gain a deep understanding of ABP's infrastructure, best practices, and practical skills you can immediately apply to your projects. |
||||
|
|
||||
|
> **Seats are limited!** Don't miss this opportunity to level up your ABP skills with direct guidance from the experts. |
||||
|
> |
||||
|
> 👉 [See full details and reserve your seat!](https://abp.io/bootcamp) |
||||
|
|
||||
|
### New ABP Community Articles |
||||
|
|
||||
|
There are exciting articles contributed by the ABP community as always. I will highlight some of them here: |
||||
|
|
||||
|
* [Prabhjot Singh](https://abp.io/community/members/prabhjot) has published 3 new articles: |
||||
|
* [Accessing Multiple Remote ABP based Backends Using HttpApi.Client](https://abp.io/community/articles/consume-multi-backends-using-clients-6f4vcggh) |
||||
|
* [Adopting the new .slnx format to organize applications and services](https://abp.io/community/articles/adopting-the-new-.slnx-format-to-organize-applications-6cm3vl8k) |
||||
|
* [Replacing Dynamic client proxies with Static client proxies](https://abp.io/community/articles/replacing-dynamic-client-proxies-with-static-client-proxies-g30lf0vx) |
||||
|
* [Liming Ma](https://github.com/maliming) has published 2 new articles: |
||||
|
* [Resolving Tenant from Route in ABP Framework](https://abp.io/community/articles/resolving-tenant-from-route-in-abp-framework-ah7oru97) |
||||
|
* [Integrating .NET AI Chat Template with ABP Framework](https://abp.io/community/articles/integrating-.net-ai-chat-template-with-abp-framework-qavb5p2j) |
||||
|
* [Engincan Veske](https://engincanveske.substack.com/) has published 2 new articles: |
||||
|
* [Understanding HttpApi.Client Project & Remote Services in an ABP Based Application](https://abp.io/community/articles/http-api-client-and-remote-services-in-abp-based-application-xkknsp6m) |
||||
|
* [Using Elsa 3 with the ABP Framework: A Comprehensive Guide](https://abp.io/community/articles/using-elsa-3-workflow-with-abp-framework-usqk8afg) |
||||
|
* [Enis Necipoğlu](https://github.com/enisn) has published 2 new articles: |
||||
|
* [White Labeling in ABP Framework](https://abp.io/community/articles/white-labeling-in-abp-framework-5trwmrfm) by [Enis Necipoğlu](https://github.com/enisn) |
||||
|
* [You do it wrong! Customizing ABP Login Page Correctly](https://abp.io/community/articles/you-do-it-wrong-customizing-abp-login-page-correctly-bna7wzt5) |
||||
|
* [New in ABP Studio: Docker Container Management](https://abp.io/community/articles/abp-studio-docker-container-management-ex7r27y8) by [Yunus Emre Kalkan](https://github.com/yekalkan) |
||||
|
* [Solving MongoDB GUID Issues After an ABP Framework Upgrade](https://abp.io/community/articles/solving-mongodb-guid-issues-after-an-abp-framework-upgrade-tv8waw1n) by [Burak Demir](https://abp.io/community/members/burakdemir) |
||||
|
|
||||
|
|
||||
|
Thanks to the ABP Community for all the content they have published. You can also [post your ABP-related (text or video) content](https://abp.io/community/posts/create) to the ABP Community. |
||||
|
|
||||
|
## Conclusion |
||||
|
|
||||
|
This version comes with some new features and a lot of enhancements to the existing features. You can see the [Road Map](https://abp.io/docs/9.3/release-info/road-map) documentation to learn about the release schedule and planned features for the next releases. Please try ABP v9.3 RC and provide feedback to help us release a more stable version. |
||||
|
|
||||
|
Thanks for being a part of this community! |
||||
|
After Width: | Height: | Size: 455 KiB |
|
After Width: | Height: | Size: 147 KiB |
|
After Width: | Height: | Size: 300 KiB |
|
After Width: | Height: | Size: 239 KiB |
|
After Width: | Height: | Size: 676 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 23 KiB |
|
After Width: | Height: | Size: 34 KiB |
@ -0,0 +1,250 @@ |
|||||
|
# Using Hangfire Dashboard in ABP API Website 🚀 |
||||
|
|
||||
|
## Introduction |
||||
|
|
||||
|
In this article, I'll show you how to integrate and use the Hangfire Dashboard in an ABP API website. |
||||
|
|
||||
|
Typically, API websites use `JWT Bearer` authentication, but the Hangfire Dashboard isn't compatible with `JWT Bearer` authentication. Therefore, we need to implement `Cookies` and `OpenIdConnect` authentication for the Hangfire Dashboard access. |
||||
|
|
||||
|
## Creating a New ABP Demo Project 🛠️ |
||||
|
|
||||
|
We'll create a new ABP Demo `Tiered` project that includes `AuthServer`, `API`, and `Web` projects. |
||||
|
|
||||
|
```bash |
||||
|
abp new AbpHangfireDemoApp -t app --tiered |
||||
|
``` |
||||
|
|
||||
|
Now let's add the Hangfire Dashboard to the `API` project and configure it to use `Cookies` and `OpenIdConnect` authentication for accessing the dashboard. |
||||
|
|
||||
|
## Adding a New Hangfire Application 🔧 |
||||
|
|
||||
|
We need to add a new Hangfire application to the `appsettings.json` file in the `DbMigrator` project: |
||||
|
|
||||
|
> **Note:** Replace `44371` with your `API` project's port. |
||||
|
|
||||
|
```json |
||||
|
"OpenIddict": { |
||||
|
"Applications": { |
||||
|
//... |
||||
|
"AbpHangfireDemoApp_Hangfire": { |
||||
|
"ClientId": "AbpHangfireDemoApp_Hangfire", |
||||
|
"RootUrl": "https://localhost:44371/" |
||||
|
} |
||||
|
//... |
||||
|
} |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
2. Update the `OpenIddictDataSeedContributor`'s `CreateApplicationsAsync` method in the `Domain` project to seed the new Hangfire application. |
||||
|
|
||||
|
```csharp |
||||
|
//Hangfire Client |
||||
|
var hangfireClientId = configurationSection["AbpHangfireDemoApp_Hangfire:ClientId"]; |
||||
|
if (!hangfireClientId.IsNullOrWhiteSpace()) |
||||
|
{ |
||||
|
var hangfireClientRootUrl = configurationSection["AbpHangfireDemoApp_Hangfire:RootUrl"]!.EnsureEndsWith('/'); |
||||
|
|
||||
|
await CreateApplicationAsync( |
||||
|
applicationType: OpenIddictConstants.ApplicationTypes.Web, |
||||
|
name: hangfireClientId!, |
||||
|
type: OpenIddictConstants.ClientTypes.Confidential, |
||||
|
consentType: OpenIddictConstants.ConsentTypes.Implicit, |
||||
|
displayName: "Hangfire Application", |
||||
|
secret: configurationSection["AbpHangfireDemoApp_Hangfire:ClientSecret"] ?? "1q2w3e*", |
||||
|
grantTypes: new List<string> //Hybrid flow |
||||
|
{ |
||||
|
OpenIddictConstants.GrantTypes.AuthorizationCode, OpenIddictConstants.GrantTypes.Implicit |
||||
|
}, |
||||
|
scopes: commonScopes, |
||||
|
redirectUris: new List<string> { $"{hangfireClientRootUrl}signin-oidc" }, |
||||
|
postLogoutRedirectUris: new List<string> { $"{hangfireClientRootUrl}signout-callback-oidc" }, |
||||
|
clientUri: hangfireClientRootUrl, |
||||
|
logoUri: "/images/clients/aspnetcore.svg" |
||||
|
); |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
3. Run the `DbMigrator` project to seed the new Hangfire application. |
||||
|
|
||||
|
### Adding Hangfire Dashboard to the `API` Project 📦 |
||||
|
|
||||
|
1. Add the following packages and modules dependencies to the `API` project: |
||||
|
|
||||
|
```bash |
||||
|
<PackageReference Include="Volo.Abp.BackgroundJobs.HangFire" Version="9.2.0" /> |
||||
|
<PackageReference Include="Volo.Abp.AspNetCore.Authentication.OpenIdConnect" Version="9.2.0" /> |
||||
|
<PackageReference Include="Hangfire.SqlServer" Version="1.8.20" /> |
||||
|
``` |
||||
|
|
||||
|
```cs |
||||
|
typeof(AbpBackgroundJobsHangfireModule), |
||||
|
typeof(AbpAspNetCoreAuthenticationOpenIdConnectModule) |
||||
|
``` |
||||
|
|
||||
|
2. Add the `HangfireClientId` and `HangfireClientSecret` to the `appsettings.json` file in the `API` project: |
||||
|
|
||||
|
```csharp |
||||
|
"AuthServer": { |
||||
|
"Authority": "https://localhost:44358", |
||||
|
"RequireHttpsMetadata": true, |
||||
|
"MetaAddress": "https://localhost:44358", |
||||
|
"SwaggerClientId": "AbpHangfireDemoApp_Swagger", |
||||
|
"HangfireClientId": "AbpHangfireDemoApp_Hangfire", |
||||
|
"HangfireClientSecret": "1q2w3e*" |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
3. Add the `ConfigureHangfire` method to the `API` project to configure Hangfire: |
||||
|
|
||||
|
```csharp |
||||
|
public override void ConfigureServices(ServiceConfigurationContext context) |
||||
|
{ |
||||
|
var configuration = context.Services.GetConfiguration(); |
||||
|
var hostingEnvironment = context.Services.GetHostingEnvironment(); |
||||
|
|
||||
|
//... |
||||
|
|
||||
|
//Add Hangfire |
||||
|
ConfigureHangfire(context, configuration); |
||||
|
//... |
||||
|
} |
||||
|
|
||||
|
private void ConfigureHangfire(ServiceConfigurationContext context, IConfiguration configuration) |
||||
|
{ |
||||
|
context.Services.AddHangfire(config => |
||||
|
{ |
||||
|
config.UseSqlServerStorage(configuration.GetConnectionString("Default")); |
||||
|
}); |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
4. Modify the `ConfigureAuthentication` method to add new `Cookies` and `OpenIdConnect` authentication schemes: |
||||
|
|
||||
|
```csharp |
||||
|
private void ConfigureAuthentication(ServiceConfigurationContext context, IConfiguration configuration) |
||||
|
{ |
||||
|
context.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme) |
||||
|
.AddAbpJwtBearer(options => |
||||
|
{ |
||||
|
options.Authority = configuration["AuthServer:Authority"]; |
||||
|
options.RequireHttpsMetadata = configuration.GetValue<bool>("AuthServer:RequireHttpsMetadata"); |
||||
|
options.Audience = "AbpHangfireDemoApp"; |
||||
|
|
||||
|
options.ForwardDefaultSelector = httpContext => httpContext.Request.Path.StartsWithSegments("/hangfire", StringComparison.OrdinalIgnoreCase) |
||||
|
? CookieAuthenticationDefaults.AuthenticationScheme |
||||
|
: null; |
||||
|
}) |
||||
|
.AddCookie(CookieAuthenticationDefaults.AuthenticationScheme) |
||||
|
.AddAbpOpenIdConnect(OpenIdConnectDefaults.AuthenticationScheme, options => |
||||
|
{ |
||||
|
options.Authority = configuration["AuthServer:Authority"]; |
||||
|
options.RequireHttpsMetadata = Convert.ToBoolean(configuration["AuthServer:RequireHttpsMetadata"]); |
||||
|
options.ResponseType = OpenIdConnectResponseType.Code; |
||||
|
|
||||
|
options.ClientId = configuration["AuthServer:HangfireClientId"]; |
||||
|
options.ClientSecret = configuration["AuthServer:HangfireClientSecret"]; |
||||
|
|
||||
|
options.UsePkce = true; |
||||
|
options.SaveTokens = true; |
||||
|
options.GetClaimsFromUserInfoEndpoint = true; |
||||
|
|
||||
|
options.Scope.Add("roles"); |
||||
|
options.Scope.Add("email"); |
||||
|
options.Scope.Add("phone"); |
||||
|
options.Scope.Add("AbpHangfireDemoApp"); |
||||
|
|
||||
|
options.SignInScheme = CookieAuthenticationDefaults.AuthenticationScheme; |
||||
|
}); |
||||
|
|
||||
|
//... |
||||
|
} |
||||
|
``` |
||||
|
|
||||
|
5. Add a custom middleware and `UseAbpHangfireDashboard` after `UseAuthorization` in the `OnApplicationInitialization` method: |
||||
|
|
||||
|
```csharp |
||||
|
//... |
||||
|
app.UseAuthorization(); |
||||
|
|
||||
|
app.Use(async (httpContext, next) => |
||||
|
{ |
||||
|
if (httpContext.Request.Path.StartsWithSegments("/hangfire", StringComparison.OrdinalIgnoreCase)) |
||||
|
{ |
||||
|
var authenticateResult = await httpContext.AuthenticateAsync(CookieAuthenticationDefaults.AuthenticationScheme); |
||||
|
if (!authenticateResult.Succeeded) |
||||
|
{ |
||||
|
await httpContext.ChallengeAsync( |
||||
|
OpenIdConnectDefaults.AuthenticationScheme, |
||||
|
new AuthenticationProperties |
||||
|
{ |
||||
|
RedirectUri = httpContext.Request.Path + httpContext.Request.QueryString |
||||
|
}); |
||||
|
return; |
||||
|
} |
||||
|
} |
||||
|
await next.Invoke(); |
||||
|
}); |
||||
|
app.UseAbpHangfireDashboard("/hangfire", options => |
||||
|
{ |
||||
|
options.AsyncAuthorization = new[] |
||||
|
{ |
||||
|
new AbpHangfireAuthorizationFilter() |
||||
|
}; |
||||
|
}); |
||||
|
|
||||
|
//... |
||||
|
``` |
||||
|
|
||||
|
Perfect! 🎉 Now you can run the `AuthServer` and `API` projects and access the Hangfire Dashboard at `https://localhost:44371/hangfire`. |
||||
|
|
||||
|
> **Note:** Replace `44371` with your `API` project's port. |
||||
|
|
||||
|
The first time you access the Hangfire Dashboard, you'll be redirected to the login page of the `AuthServer` project. After you log in, you'll be redirected back to the Hangfire Dashboard. |
||||
|
|
||||
|
 |
||||
|
|
||||
|
## Key Points 🔑 |
||||
|
|
||||
|
### 1. Authentication Scheme Selection |
||||
|
|
||||
|
The default authentication scheme in API websites is `JWT Bearer`. We've implemented `Cookies` and `OpenIdConnect` specifically for the Hangfire Dashboard. |
||||
|
|
||||
|
We've configured the `JwtBearerOptions`'s `ForwardDefaultSelector` to use `CookieAuthenticationDefaults.AuthenticationScheme` for Hangfire Dashboard requests. |
||||
|
|
||||
|
This means that if the request path starts with `/hangfire`, the request will be authenticated using the `Cookies` authentication scheme; otherwise, it will use the `JwtBearer` authentication scheme. |
||||
|
|
||||
|
```csharp |
||||
|
options.ForwardDefaultSelector = httpContext => httpContext.Request.Path.StartsWithSegments("/hangfire", StringComparison.OrdinalIgnoreCase) |
||||
|
? CookieAuthenticationDefaults.AuthenticationScheme |
||||
|
: null; |
||||
|
``` |
||||
|
|
||||
|
### 2. Custom Middleware for Authentication |
||||
|
|
||||
|
We've also implemented a custom middleware to handle `Cookies` authentication for the Hangfire Dashboard. If the current request isn't authenticated with the `Cookies` authentication scheme, it will be redirected to the login page. |
||||
|
|
||||
|
```csharp |
||||
|
app.Use(async (httpContext, next) => |
||||
|
{ |
||||
|
if (httpContext.Request.Path.StartsWithSegments("/hangfire", StringComparison.OrdinalIgnoreCase)) |
||||
|
{ |
||||
|
var authenticateResult = await httpContext.AuthenticateAsync(CookieAuthenticationDefaults.AuthenticationScheme); |
||||
|
if (!authenticateResult.Succeeded) |
||||
|
{ |
||||
|
await httpContext.ChallengeAsync( |
||||
|
OpenIdConnectDefaults.AuthenticationScheme, |
||||
|
new AuthenticationProperties |
||||
|
{ |
||||
|
RedirectUri = httpContext.Request.Path + httpContext.Request.QueryString |
||||
|
}); |
||||
|
return; |
||||
|
} |
||||
|
} |
||||
|
await next.Invoke(); |
||||
|
}); |
||||
|
``` |
||||
|
|
||||
|
## References 📚 |
||||
|
|
||||
|
- [ABP Hangfire Background Job Manager](https://abp.io/docs/latest/framework/infrastructure/background-jobs/hangfire) |
||||
|
- [Use cookie authentication in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/security/authentication/cookie?view=aspnetcore-9.0) |
||||
|
After Width: | Height: | Size: 4.9 MiB |
@ -1,53 +1,49 @@ |
|||||
using System; |
using System; |
||||
|
using System.Collections.Generic; |
||||
using System.Threading.Tasks; |
using System.Threading.Tasks; |
||||
using Hangfire.Dashboard; |
using Hangfire.Dashboard; |
||||
|
using Microsoft.AspNetCore.Authorization; |
||||
using Microsoft.Extensions.DependencyInjection; |
using Microsoft.Extensions.DependencyInjection; |
||||
using Volo.Abp.Authorization.Permissions; |
using Volo.Abp.Authorization; |
||||
using Volo.Abp.Users; |
using Volo.Abp.MultiTenancy; |
||||
|
|
||||
namespace Volo.Abp.Hangfire; |
namespace Volo.Abp.Hangfire; |
||||
|
|
||||
public class AbpHangfireAuthorizationFilter : IDashboardAsyncAuthorizationFilter |
public class AbpHangfireAuthorizationFilter : IDashboardAsyncAuthorizationFilter |
||||
{ |
{ |
||||
private readonly bool _enableTenant; |
private readonly bool _enableTenant; |
||||
private readonly string? _requiredPermissionName; |
private readonly AuthorizationPolicyBuilder _policyBuilder; |
||||
|
|
||||
public AbpHangfireAuthorizationFilter(bool enableTenant = false, string? requiredPermissionName = null) |
public virtual AuthorizationPolicyBuilder PolicyBuilder => _policyBuilder; |
||||
{ |
|
||||
_enableTenant = requiredPermissionName.IsNullOrWhiteSpace() ? enableTenant : true; |
|
||||
_requiredPermissionName = requiredPermissionName; |
|
||||
} |
|
||||
|
|
||||
public async Task<bool> AuthorizeAsync(DashboardContext context) |
public AbpHangfireAuthorizationFilter(bool enableTenant = false, string? requiredPermissionName = null, params string[]? requiredRoleNames) |
||||
{ |
{ |
||||
if (!IsLoggedIn(context, _enableTenant)) |
_enableTenant = enableTenant; |
||||
|
_policyBuilder = new AuthorizationPolicyBuilder().RequireAuthenticatedUser(); |
||||
|
if (!requiredPermissionName.IsNullOrWhiteSpace()) |
||||
{ |
{ |
||||
return false; |
_policyBuilder.Requirements.Add(new PermissionRequirement(requiredPermissionName)); |
||||
} |
} |
||||
|
|
||||
if (_requiredPermissionName.IsNullOrEmpty()) |
if (!requiredRoleNames.IsNullOrEmpty()) |
||||
{ |
{ |
||||
return true; |
foreach (var roleName in requiredRoleNames!) |
||||
|
{ |
||||
|
_policyBuilder.RequireRole(roleName); |
||||
|
} |
||||
} |
} |
||||
|
|
||||
return await IsPermissionGrantedAsync(context, _requiredPermissionName!); |
|
||||
} |
} |
||||
|
|
||||
private static bool IsLoggedIn(DashboardContext context, bool enableTenant) |
public virtual async Task<bool> AuthorizeAsync(DashboardContext context) |
||||
{ |
{ |
||||
var currentUser = context.GetHttpContext().RequestServices.GetRequiredService<ICurrentUser>(); |
var currentTenant = context.GetHttpContext().RequestServices.GetRequiredService<ICurrentTenant>(); |
||||
|
if (currentTenant.IsAvailable && !_enableTenant) |
||||
if (!enableTenant) |
|
||||
{ |
{ |
||||
return currentUser.IsAuthenticated && !currentUser.TenantId.HasValue; |
return false; |
||||
} |
} |
||||
|
|
||||
return currentUser.IsAuthenticated; |
var authorizationService = context.GetHttpContext().RequestServices.GetRequiredService<IAuthorizationService>(); |
||||
} |
var authorizationPolicy = _policyBuilder.Build(); |
||||
|
return (await authorizationService.AuthorizeAsync(context.GetHttpContext().User, authorizationPolicy)).Succeeded; |
||||
private static async Task<bool> IsPermissionGrantedAsync(DashboardContext context, string requiredPermissionName) |
|
||||
{ |
|
||||
var permissionChecker = context.GetHttpContext().RequestServices.GetRequiredService<IPermissionChecker>(); |
|
||||
return await permissionChecker.IsGrantedAsync(requiredPermissionName); |
|
||||
} |
} |
||||
} |
} |
||||
|
|||||
@ -0,0 +1,10 @@ |
|||||
|
using System; |
||||
|
using System.Collections.Generic; |
||||
|
using System.Text; |
||||
|
|
||||
|
namespace Volo.Abp.MultiTenancy; |
||||
|
|
||||
|
public static class TenantResolverNames |
||||
|
{ |
||||
|
public const string FallbackTenant = "FallbackTenant"; |
||||
|
} |
||||
@ -0,0 +1,79 @@ |
|||||
|
using System; |
||||
|
using System.Collections.Generic; |
||||
|
using System.Linq; |
||||
|
using System.Reflection; |
||||
|
using System.Reflection.Emit; |
||||
|
using Microsoft.AspNetCore.Mvc.ApplicationParts; |
||||
|
using NSubstitute; |
||||
|
using Shouldly; |
||||
|
using Volo.Abp.Modularity; |
||||
|
using Volo.Abp.VirtualFileSystem; |
||||
|
using Xunit; |
||||
|
|
||||
|
namespace Volo.Abp.AspNetCore.Mvc.ApplicationPart; |
||||
|
|
||||
|
public class ApplicationPartSorter_Tests |
||||
|
{ |
||||
|
[Fact] |
||||
|
public void Should_Sort_ApplicationParts_By_Module_Dependencies() |
||||
|
{ |
||||
|
var moduleDescriptors = new List<IAbpModuleDescriptor>(); |
||||
|
var partManager = new ApplicationPartManager(); |
||||
|
|
||||
|
for (var i = 0; i < 10; i++) |
||||
|
{ |
||||
|
var assembly = AssemblyBuilder.DefineDynamicAssembly(new AssemblyName($"ModuleA{i}.dll"), AssemblyBuilderAccess.Run); |
||||
|
partManager.ApplicationParts.Add(new AssemblyPart(assembly)); |
||||
|
moduleDescriptors.Add(CreateModuleDescriptor(assembly)); |
||||
|
} |
||||
|
var randomApplicationParts = partManager.ApplicationParts.OrderBy(x => Guid.NewGuid()).ToList(); // Shuffle the parts
|
||||
|
|
||||
|
// Additional part
|
||||
|
randomApplicationParts.AddFirst(new CompiledRazorAssemblyPart(typeof(AbpAspNetCoreModule).Assembly)); |
||||
|
randomApplicationParts.Insert(5, new CompiledRazorAssemblyPart(typeof(AbpAspNetCoreMvcModule).Assembly)); |
||||
|
randomApplicationParts.AddLast(new CompiledRazorAssemblyPart(typeof(AbpVirtualFileSystemModule).Assembly)); |
||||
|
|
||||
|
partManager.ApplicationParts.Clear(); |
||||
|
foreach (var part in randomApplicationParts) |
||||
|
{ |
||||
|
partManager.ApplicationParts.Add(part); |
||||
|
} |
||||
|
|
||||
|
var moduleContainer = CreateFakeModuleContainer(moduleDescriptors); |
||||
|
|
||||
|
ApplicationPartSorter.Sort(partManager, moduleContainer); |
||||
|
|
||||
|
// Act
|
||||
|
partManager.ApplicationParts.Count.ShouldBe(13); // 10 modules + 3 additional parts
|
||||
|
|
||||
|
var applicationParts = partManager.ApplicationParts.Reverse().ToList(); // Reverse the order to match the expected output
|
||||
|
|
||||
|
applicationParts[0].ShouldBeOfType<CompiledRazorAssemblyPart>().Assembly.ShouldBe(typeof(AbpAspNetCoreModule).Assembly); |
||||
|
applicationParts[1].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA0"); |
||||
|
applicationParts[2].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA1"); |
||||
|
applicationParts[3].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA2"); |
||||
|
applicationParts[4].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA3"); |
||||
|
applicationParts[5].ShouldBeOfType<CompiledRazorAssemblyPart>().Assembly.ShouldBe(typeof(AbpAspNetCoreMvcModule).Assembly); |
||||
|
applicationParts[6].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA4"); |
||||
|
applicationParts[7].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA5"); |
||||
|
applicationParts[8].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA6"); |
||||
|
applicationParts[9].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA7"); |
||||
|
applicationParts[10].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA8"); |
||||
|
applicationParts[11].ShouldBeOfType<AssemblyPart>().Assembly.GetName().Name.ShouldStartWith("ModuleA9"); |
||||
|
applicationParts[12].ShouldBeOfType<CompiledRazorAssemblyPart>().Assembly.ShouldBe(typeof(AbpVirtualFileSystemModule).Assembly); |
||||
|
} |
||||
|
|
||||
|
private static IModuleContainer CreateFakeModuleContainer(List<IAbpModuleDescriptor> moduleDescriptors) |
||||
|
{ |
||||
|
var fakeModuleContainer = Substitute.For<IModuleContainer>(); |
||||
|
fakeModuleContainer.Modules.Returns(moduleDescriptors); |
||||
|
return fakeModuleContainer; |
||||
|
} |
||||
|
|
||||
|
private static IAbpModuleDescriptor CreateModuleDescriptor(Assembly assembly) |
||||
|
{ |
||||
|
var moduleDescriptor = Substitute.For<IAbpModuleDescriptor>(); |
||||
|
moduleDescriptor.Assembly.Returns(assembly); |
||||
|
return moduleDescriptor; |
||||
|
} |
||||
|
} |
||||
@ -0,0 +1,87 @@ |
|||||
|
using System; |
||||
|
using System.Collections.Generic; |
||||
|
using System.Linq; |
||||
|
using System.Text; |
||||
|
using System.Threading.Tasks; |
||||
|
using Microsoft.Extensions.DependencyInjection; |
||||
|
using Microsoft.Extensions.Options; |
||||
|
using Shouldly; |
||||
|
using Volo.Abp.MultiTenancy.ConfigurationStore; |
||||
|
using Xunit; |
||||
|
|
||||
|
namespace Volo.Abp.MultiTenancy; |
||||
|
|
||||
|
public class FallbackTenantResolveContributor_Tests : MultiTenancyTestBase |
||||
|
{ |
||||
|
private readonly Guid _testTenantId = Guid.NewGuid(); |
||||
|
private readonly string _testTenantName = "acme"; |
||||
|
private readonly string _testTenantNormalizedName = "ACME"; |
||||
|
|
||||
|
private readonly AbpTenantResolveOptions _options; |
||||
|
private readonly ITenantResolver _tenantResolver; |
||||
|
|
||||
|
public FallbackTenantResolveContributor_Tests() |
||||
|
{ |
||||
|
_options = ServiceProvider.GetRequiredService<IOptions<AbpTenantResolveOptions>>().Value; |
||||
|
_tenantResolver = ServiceProvider.GetRequiredService<ITenantResolver>(); |
||||
|
} |
||||
|
|
||||
|
protected override void BeforeAddApplication(IServiceCollection services) |
||||
|
{ |
||||
|
services.Configure<AbpDefaultTenantStoreOptions>(options => |
||||
|
{ |
||||
|
options.Tenants = new[] |
||||
|
{ |
||||
|
new TenantConfiguration(_testTenantId, _testTenantName, _testTenantNormalizedName) |
||||
|
}; |
||||
|
}); |
||||
|
|
||||
|
services.Configure<AbpTenantResolveOptions>(options => |
||||
|
{ |
||||
|
options.FallbackTenant = _testTenantName; |
||||
|
}); |
||||
|
} |
||||
|
|
||||
|
[Fact] |
||||
|
public async Task Should_Resolve_To_Fallback_Tenant_If_No_Other_Contributor_Succeeds() |
||||
|
{ |
||||
|
var result = await _tenantResolver.ResolveTenantIdOrNameAsync(); |
||||
|
|
||||
|
result.TenantIdOrName.ShouldBe(_testTenantName); |
||||
|
result.AppliedResolvers.ShouldContain(TenantResolverNames.FallbackTenant); |
||||
|
} |
||||
|
|
||||
|
[Fact] |
||||
|
public async Task Should_Not_Override_Resolved_Tenant() |
||||
|
{ |
||||
|
// Arrange
|
||||
|
var customTenantName = "resolved-tenant"; |
||||
|
_options.TenantResolvers.Insert(0, new TestTenantResolveContributor(customTenantName)); |
||||
|
|
||||
|
// Act
|
||||
|
var result = await _tenantResolver.ResolveTenantIdOrNameAsync(); |
||||
|
|
||||
|
// Assert
|
||||
|
result.TenantIdOrName.ShouldBe(customTenantName); |
||||
|
result.AppliedResolvers.First().ShouldBe("Test"); |
||||
|
result.AppliedResolvers.ShouldNotContain(TenantResolverNames.FallbackTenant); |
||||
|
} |
||||
|
|
||||
|
public class TestTenantResolveContributor : TenantResolveContributorBase |
||||
|
{ |
||||
|
private readonly string _tenant; |
||||
|
|
||||
|
public TestTenantResolveContributor(string tenant) |
||||
|
{ |
||||
|
_tenant = tenant; |
||||
|
} |
||||
|
|
||||
|
public override string Name => "Test"; |
||||
|
|
||||
|
public override Task ResolveAsync(ITenantResolveContext context) |
||||
|
{ |
||||
|
context.TenantIdOrName = _tenant; |
||||
|
return Task.CompletedTask; |
||||
|
} |
||||
|
} |
||||
|
} |
||||
@ -1,16 +1,22 @@ |
|||||
using OpenIddict.Abstractions; |
using System; |
||||
|
using OpenIddict.Abstractions; |
||||
|
|
||||
namespace Volo.Abp.OpenIddict.Applications; |
namespace Volo.Abp.OpenIddict.Applications; |
||||
|
|
||||
public class AbpApplicationDescriptor : OpenIddictApplicationDescriptor |
public class AbpApplicationDescriptor : OpenIddictApplicationDescriptor |
||||
{ |
{ |
||||
|
/// <summary>
|
||||
|
/// Gets or sets the front-channel logout URI associated with the application.
|
||||
|
/// </summary>
|
||||
|
public virtual Uri FrontChannelLogoutUri { get; set; } |
||||
|
|
||||
/// <summary>
|
/// <summary>
|
||||
/// URI to further information about client.
|
/// URI to further information about client.
|
||||
/// </summary>
|
/// </summary>
|
||||
public string ClientUri { get; set; } |
public virtual string ClientUri { get; set; } |
||||
|
|
||||
/// <summary>
|
/// <summary>
|
||||
/// URI to client logo.
|
/// URI to client logo.
|
||||
/// </summary>
|
/// </summary>
|
||||
public string LogoUri { get; set; } |
public virtual string LogoUri { get; set; } |
||||
} |
} |
||||
|
|||||
@ -1,6 +1,7 @@ |
|||||
module.exports = { |
module.exports = { |
||||
mappings: { |
mappings: { |
||||
"@node_modules/jquery-validation/dist/jquery.validate.js": "@libs/jquery-validation/", |
"@node_modules/jquery-validation/dist/jquery.validate.js": "@libs/jquery-validation/", |
||||
"@node_modules/jquery-validation/dist/localization/*.*": "@libs/jquery-validation/localization/" |
"@node_modules/jquery-validation/dist/localization/*.*": "@libs/jquery-validation/localization/", |
||||
|
"@node_modules/@abp/jquery-validation/src/*.*": "@libs/jquery-validation/" |
||||
} |
} |
||||
} |
} |
||||
@ -0,0 +1,27 @@ |
|||||
|
$.validator.methods.range = function (value, element, param) { |
||||
|
if (this.optional(element)) { |
||||
|
return true; |
||||
|
} |
||||
|
|
||||
|
// Remove thousands separators and convert decimal separators
|
||||
|
var cleanValue = value.replace(/[.,](?=.*[.,])/g, '').replace(/[.,](?!.*[.,])/g, '.'); |
||||
|
var numericValue = parseFloat(cleanValue); |
||||
|
|
||||
|
// Check if conversion was successful and value is within range
|
||||
|
return !isNaN(numericValue) && (numericValue >= param[0] && numericValue <= param[1]); |
||||
|
}; |
||||
|
|
||||
|
$.validator.methods.number = function (value, element) { |
||||
|
if (this.optional(element)) { |
||||
|
return true; |
||||
|
} |
||||
|
|
||||
|
// 1. Period as decimal separator, comma as thousands separator (e.g., 1,234.56 or -1,234.56)
|
||||
|
// 2. Comma as decimal separator, period as thousands separator (e.g., 1.234,56 or -1.234,56)
|
||||
|
// 3. Pure numbers (integers)
|
||||
|
var pattern1 = /^(?:-?\d+|-?\d{1,3}(?:,\d{3})+)?(?:-?\.\d+)?$/; |
||||
|
var pattern2 = /^(?:-?\d+|-?\d{1,3}(?:\.\d{3})+)?(?:-?,\d+)?$/; |
||||
|
var pattern3 = /^-?\d+$/; |
||||
|
|
||||
|
return pattern1.test(value) || pattern2.test(value) || pattern3.test(value); |
||||
|
} |
||||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue