mirror of https://github.com/abpframework/abp.git
Browse Source
# Conflicts: # abp_io/AbpIoLocalization/AbpIoLocalization/Admin/Localization/Resources/en.json # framework/src/Volo.Abp.Core/Volo.Abp.Core.csprojissue-#6768
Emre KARA
1 year ago
464 changed files with 6702 additions and 3969 deletions
@ -0,0 +1,86 @@ |
|||
# ABP.IO Platform 9.2 Final Has Been Released! |
|||
|
|||
We are glad to announce that [ABP](https://abp.io/) 9.2 stable version has been released today. |
|||
|
|||
## What's New With Version 9.2? |
|||
|
|||
All the new features were explained in detail in the [9.2 RC Announcement Post](https://abp.io/community/articles/abp-platform-9.2-rc-has-been-released-jpq072nh), so there is no need to review them again. You can check it out for more details. |
|||
|
|||
## Getting Started with 9.2 |
|||
|
|||
### Creating New Solutions |
|||
|
|||
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) to create new solutions. |
|||
|
|||
### How to Upgrade an Existing Solution |
|||
|
|||
You can upgrade your existing solutions with either ABP Studio or ABP CLI. In the following sections, both approaches are explained: |
|||
|
|||
### Upgrading via ABP Studio |
|||
|
|||
If you are already using the ABP Studio, you can upgrade it to the latest version. ABP Studio periodically checks for updates in the background, and when a new version of ABP Studio is available, you will be notified through a modal. Then, you can update it by confirming the opened modal. See [the documentation](https://abp.io/docs/latest/studio/installation#upgrading) for more info. |
|||
|
|||
After upgrading the ABP Studio, then you can open your solution in the application, and simply click the **Upgrade ABP Packages** action button to instantly upgrade your solution: |
|||
|
|||
 |
|||
|
|||
### Upgrading via ABP CLI |
|||
|
|||
Alternatively, you can upgrade your existing solution via ABP CLI. First, you need to install the ABP CLI or upgrade it to the latest version. |
|||
|
|||
If you haven't installed it yet, you can run the following command: |
|||
|
|||
```bash |
|||
dotnet tool install -g Volo.Abp.Studio.Cli |
|||
``` |
|||
|
|||
Or to update the existing CLI, you can run the following command: |
|||
|
|||
```bash |
|||
dotnet tool update -g Volo.Abp.Studio.Cli |
|||
``` |
|||
|
|||
After installing/updating the ABP CLI, you can use the [`update` command](https://abp.io/docs/latest/CLI#update) to update all the ABP related NuGet and NPM packages in your solution as follows: |
|||
|
|||
```bash |
|||
abp update |
|||
``` |
|||
|
|||
You can run this command in the root folder of your solution to update all ABP related packages. |
|||
|
|||
## Migration Guides |
|||
|
|||
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.x: [ABP Version 9.2 Migration Guide](https://abp.io/docs/9.2/release-info/migration-guides/abp-9-2) |
|||
|
|||
## Community News |
|||
|
|||
### New ABP Community Articles |
|||
|
|||
As always, exciting articles have been contributed by the ABP community. I will highlight some of them here: |
|||
|
|||
* [Liming Ma](https://github.com/maliming) has published 3 new articles: |
|||
* [Integrating .NET AI Chat Template with ABP Framework](https://abp.io/community/articles/integrating-.net-ai-chat-template-with-abp-framework-qavb5p2j) |
|||
* [Resolving Tenant from Route in ABP Framework](https://abp.io/community/articles/resolving-tenant-from-route-in-abp-framework-ah7oru97) |
|||
* [Common Errors in JWT Bearer Authentication](https://abp.io/community/articles/common-errors-in-jwt-bearer-authentication-4u3wrbs5) |
|||
* [Engincan Veske](https://engincanveske.substack.com/) has published 3 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) |
|||
* [Implementing Custom Tenant Logo Feature in ABP Framework: A Step-by-Step Guide](https://abp.io/community/articles/implementing-custom-tenant-logo-feature-in-abp-framework-a-stepbystep-guide-sba96ac9) |
|||
* [Berkan Şaşmaz](https://berkansasmaz.com/) has published 2 new articles: |
|||
* [Understanding the Domain and Application Layers in ABP Framework](https://abp.io/community/articles/understanding-the-domain-and-application-layers-in-abp-1fipc4x4) |
|||
* [How Do We Maintain Code Quality and Technical Debt in Our .NET Codebase?](https://abp.io/community/articles/how-do-we-maintain-code-quality-and-technical-debt-in-our-.net-codebase-z7glpya1) |
|||
* [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) |
|||
* [Ariful Islam](https://abp.io/community/members/arif) has published 2 new articles: |
|||
* [Multi-Workspace Management for ABP Applications](https://abp.io/community/articles/multiworkspace-management-for-abp-applications-eghgty3j) |
|||
* [Using Semantic Kernel in the ABP Framework](https://abp.io/community/articles/using-semantic-kernel-in-the-abp-framework-qo5cnuzs) |
|||
* [Guide to Add Custom Modules in ABP.IO App](https://abp.io/community/articles/guide-to-add-custom-modules-in-abp.io-app-sttetffa) by [Harsh Gupta](https://abp.io/community/members/harshgupta) |
|||
* [Debugging NuGet Packages in ABP.IO: A Complete Guide](https://abp.io/community/articles/debugging-nuget-packages-in-abp.io-a-complete-guide-h13y2033) by [Suhaib Mousa](https://suhaibmousa.com/) |
|||
* [Using Microsoft AI Extensions Library and OpenAI to Summarize User Comments](https://abp.io/community/articles/using-microsoft-ai-extensions-library-and-openai-to-summarize-user-comments-gj1lusg7) by [Halil Ibrahim Kalkan](https://twitter.com/hibrahimkalkan) |
|||
|
|||
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. |
|||
|
|||
## About the Next Version |
|||
|
|||
The next feature version will be 9.3. You can follow the [release planning here](https://github.com/abpframework/abp/milestones). Please [submit an issue](https://github.com/abpframework/abp/issues/new) if you have any problems with this version. |
|||
|
After Width: | Height: | Size: 492 KiB |
|
After Width: | Height: | Size: 34 KiB |
@ -0,0 +1,97 @@ |
|||
# Announcing ABP Studio 1.0 General Availability 🚀 |
|||
|
|||
It's the moment you've been waiting for! We are thrilled to announce the stable release of ABP Studio v1.0. This milestone marks a significant step forward in our mission to provide a first-class, integrated development environment for ABP developers. Paired with the recently released [ABP v9.2](https://abp.io/community/articles/announcing-abp-9-2-stable-release-061qmtzb), ABP Studio v1.0 brings new features and improvements that will make your development work faster and more efficient. |
|||
|
|||
For the past several months, our core ABP team has been hard at work, focusing on the features that matter most to you, our community of developers. This release is the peak of that effort, bringing a host of improvements and new capabilities to the forefront. Let's dive in and explore what's new in ABP Studio v1.0. |
|||
|
|||
## What's New with ABP Studio v1.0? |
|||
|
|||
ABP Studio v1.0 is all about enhancing your development experience, from project creation to deployment. Here, we'll walk you through some of the latest features we've implemented, along with other key enhancements that make this release truly special. |
|||
|
|||
### ❤️ Solution Runner with Ready/Health Checks |
|||
|
|||
ABP Studio's Solution Runner now provides visual health monitoring that makes tracking your applications' status easily. When you start an application, a spinner indicates it's "starting", then in the *Overall* tab, you can see the application's health (✅ for healthy, ⚠️ for unhealthy) that displays real-time health status: |
|||
|
|||
 |
|||
|
|||
With [pre-configured health checks](https://abp.io/docs/9.2/solution-templates/layered-web-application/health-check-configuration) in ABP solution templates including database connectivity tests, you get instant feedback on your applications' health. |
|||
|
|||
When health check UI is configured, you can access comprehensive health dashboards with a dedicated "Browse Health UI" command or see the last health response from the "Show Latest Health Check Response" command: |
|||
|
|||
 |
|||
|
|||
When you restart applications that are open in your browser, ABP Studio automatically refreshes the pages for you. |
|||
|
|||
### 🎨 Theme Style Selection on Project Creation |
|||
|
|||
When creating a new solution, you can now choose your theme, theme style, and layout right from the project creation wizard instead of having to configure these settings later. ABP Studio lets you pick from [ABP's officially provided themes including Basic, LeptonX Lite, and LeptonX](https://abp.io/docs/latest/ui-themes). |
|||
|
|||
 |
|||
|
|||
If you select Basic or LeptonX Lite themes, only the theme will be changed. However, if you select the LeptonX theme, you'll get additional options to fine-tune your setup: |
|||
|
|||
- **Theme Style Configuration** - Pick from **System, Light, Dim, or Dark** styles to match how you like your development environment |
|||
- **Layout Options** - **Sidebar menu** / **Top menu** |
|||
|
|||
### 📦 "Container" Application Type for Solution Runner |
|||
|
|||
ABP Studio v1.0 introduces a dedicated "Container" application type that gives you better control over your Docker containers directly from the Solution Runner. Instead of managing all your containers through PowerShell scripts or running them all together, you can now see and control each container individually in the Solution Runner panel. |
|||
|
|||
 |
|||
|
|||
This new feature replaces the previous _Infrastructure_ folder approach with a cleaner, more intuitive container section. You can now: |
|||
|
|||
- **Start and stop containers individually** - No more starting all containers at once when you only need specific services |
|||
- **Monitor container status** - See which containers are running, stopped, or have issues directly in the UI |
|||
- **Manage container dependencies** - Control the order and timing of container startup based on your application needs |
|||
|
|||
Whether you're working with databases, message brokers, or other containerized services, the new Container application type makes it much easier to manage your development environment. This is especially useful for microservice architectures where you might want to run only specific services during development or testing. |
|||
|
|||
### ⚙️ Handle Multiple DbContexts When Adding/Removing/Applying Migrations |
|||
|
|||
When working with ABP solutions that have multiple DbContexts (such as when using the separate tenant database option), ABP Studio now intelligently prompts you to select the appropriate DbContext for migration operations. This enhancement ensures you're always working with the correct database context and helps prevent common mistakes when managing multiple databases. |
|||
|
|||
 |
|||
|
|||
The context selection dialog appears automatically when you perform any of these Entity Framework operations: |
|||
|
|||
- **Adding a new migration** - Choose which DbContext the new migration should target |
|||
- **Removing an existing migration** - Select the DbContext from which to remove the migration |
|||
- **Updating the database** - Specify which database context should be updated |
|||
|
|||
## Get Started with ABP Studio v1.0 Today! |
|||
|
|||
ABP Studio v1.0 is built on the solid foundation of the [latest version of ABP Framework, which is v9.2](https://abp.io/community/articles/announcing-abp-9-2-stable-release-061qmtzb). This means that when you create a new project with ABP Studio, you're getting all the latest features, performance improvements, and bug fixes that come with v9.2. This includes updates to dependencies, enhancements to the core framework, and improvements to application modules. |
|||
|
|||
We are incredibly excited for you to get your hands on ABP Studio v1.0. We believe these new features will make a real difference in your day-to-day development workflow. |
|||
|
|||
### ⬇️ Download ABP Studio 1.0 |
|||
|
|||
Ready to get started? You can download the stable v1.0 release right now from the official ABP Studio website: **[https://abp.io/studio](https://abp.io/studio)** |
|||
|
|||
 |
|||
|
|||
If you are an existing ABP Studio user, it's even easier. You don't need to download the installer again. Simply launch ABP Studio, and it will prompt you to update to the latest version directly from the UI. |
|||
|
|||
> Alternatively, you can click to the *Help -> Check for Updates* context menu item to check for updates and install the latest version: |
|||
> |
|||
>  |
|||
|
|||
### 🔮 What's Next? |
|||
|
|||
ABP Studio v1.0 represents just the beginning of our journey. We're committed to continuously evolving the platform, adding features that directly address real-world development challenges and enhance your workflow. Our goal is to make ABP Studio the go-to development environment for .NET and ABP Framework developers. |
|||
|
|||
We will keep releasing new versions with exciting features based on our roadmap and your valuable feedback. To give you a sneak peek into what's planned for future releases, you can expect to see: |
|||
|
|||
- **Environment Variable Management:** A dedicated UI to easily manage environment variables for your solutions. |
|||
- **OpenTelemetry Integration:** We'll be integrating OpenTelemetry support directly into the startup templates, making distributed tracing and observability a seamless part of your application from day one. |
|||
- **LeptonX Theme Builder**: Allowing users to determine styling, colour palette and easily override their project's theme styles. |
|||
- **Monitor dashboards of the tools used in the solution (e.g. Kubernetes, Redis, Grafana, etc...)** |
|||
- **Pre-configured .NET Aspire for the Microservice Startup Template** |
|||
- **and more...** |
|||
|
|||
We are incredibly excited about the future of ABP Studio and can't wait to share the next set of features with you. Your comments and suggestions are invaluable to us. If you have any feedback, please drop a comment below. |
|||
|
|||
Thank you for being part of our community and happy coding! |
|||
|
|||
**The Volosoft Team** |
|||
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 282 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 455 KiB |
|
After Width: | Height: | Size: 207 KiB |
|
After Width: | Height: | Size: 913 KiB |
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 107 KiB |
@ -0,0 +1,134 @@ |
|||
# Integrating .NET AI Chat Template with ABP Framework |
|||
|
|||
This article demonstrates how to integrate the [.NET AI Chat Template](https://devblogs.microsoft.com/dotnet/announcing-dotnet-ai-template-preview2/) into an ABP Framework application, enabling powerful AI chat capabilities in your ABP-based solution. |
|||
|
|||
 |
|||
|
|||
## Step 1: Create a New ABP Project |
|||
|
|||
First, let's create a new [single-layer Blazor Server project](https://abp.io/docs/latest/solution-templates/single-layer-web-application/overview) named `AbpAiChat` using ABP Studio, You can also use the following ABP CLI command to create the project: |
|||
|
|||
```bash |
|||
abp new AbpAiChat -t app-nolayers --ui-framework blazor-server --use-open-source-template |
|||
``` |
|||
|
|||
## Step 2: Integrate AI Chat Template |
|||
|
|||
The integration process involves copying and adapting the .NET AI Chat Template code into our ABP project. The template code is already included in our sample project, so you don't need to install it separately. |
|||
|
|||
### 2.1 Project Structure Changes |
|||
|
|||
1. Copy Blazor components to the `Components` folder |
|||
2. Copy AI service classes to the `Services` folder |
|||
3. Add required entities(`IngestedDocument`, `IngestedRecord`) to the `AbpAiChatDbContext` and add new migration |
|||
4. Copy frontend resources to the `wwwroot` folder |
|||
5. Adjust some styles to capatible with the ABP theme |
|||
|
|||
### 2.2 Required NuGet Packages |
|||
|
|||
Add the following packages to `AbpAiChat.csproj`: |
|||
|
|||
```xml |
|||
<PackageReference Include="Microsoft.Extensions.AI.OpenAI" Version="9.4.3-preview.1.25230.7" /> |
|||
<PackageReference Include="Microsoft.EntityFrameworkCore.Sqlite" Version="9.0.4" /> |
|||
<PackageReference Include="Microsoft.Extensions.AI" Version="9.4.3-preview.1.25230.7" /> |
|||
<PackageReference Include="Microsoft.SemanticKernel.Core" Version="1.47.0" /> |
|||
<PackageReference Include="PdfPig" Version="0.1.9" /> |
|||
<PackageReference Include="System.Linq.Async" Version="6.0.1" /> |
|||
``` |
|||
|
|||
### 2.3 Configure AI Services |
|||
|
|||
Add the following configuration to `AbpAiChatModule.cs`: |
|||
|
|||
```csharp |
|||
private void ConfigureAi(ServiceConfigurationContext context) |
|||
{ |
|||
var credential = new ApiKeyCredential(context.Services.GetConfiguration()["GitHubToken"] ?? throw new InvalidOperationException("Missing configuration: GitHubToken. See the README for details.")); |
|||
var openAiOptions = new OpenAIClientOptions() |
|||
{ |
|||
Endpoint = new Uri("https://models.inference.ai.azure.com") |
|||
}; |
|||
|
|||
var ghModelsClient = new OpenAIClient(credential, openAiOptions); |
|||
var chatClient = ghModelsClient.GetChatClient("gpt-4o-mini").AsIChatClient(); |
|||
var embeddingGenerator = ghModelsClient.GetEmbeddingClient("text-embedding-3-small").AsIEmbeddingGenerator(); |
|||
|
|||
var vectorStore = new JsonVectorStore(Path.Combine(AppContext.BaseDirectory, "vector-store")); |
|||
|
|||
context.Services.AddSingleton<IVectorStore>(vectorStore); |
|||
context.Services.AddScoped<DataIngestor>(); |
|||
context.Services.AddSingleton<SemanticSearch>(); |
|||
context.Services.AddChatClient(chatClient).UseFunctionInvocation().UseLogging(); |
|||
context.Services.AddEmbeddingGenerator(embeddingGenerator); |
|||
|
|||
context.Services.Configure<AbpAspNetCoreContentOptions>(options => |
|||
{ |
|||
options.ContentTypeMaps.Add(".mjs", "application/javascript"); |
|||
}); |
|||
} |
|||
``` |
|||
|
|||
The `ConfigureAi` method is called in the `ConfigureServices` method of `AbpAiChatModule`. It sets up the AI services, including the OpenAI client, chat client, embedding generator, and vector store. |
|||
|
|||
### 2.4 Configure GitHub Token |
|||
|
|||
Add your GitHub Personal Access Token to `appsettings.json`: |
|||
|
|||
```json |
|||
{ |
|||
"GitHubToken": "your-github-token" |
|||
} |
|||
``` |
|||
|
|||
You can obtain your token from [GitHub Personal Access Tokens](https://github.com/settings/personal-access-tokens). |
|||
|
|||
## Step 3: Add Custom AI Functionality |
|||
|
|||
Let's add a custom AI function to retrieve the current user's information. Update the `Chat.razor` component: |
|||
|
|||
```csharp |
|||
chatOptions.Tools = |
|||
[ |
|||
AIFunctionFactory.Create(SearchAsync), |
|||
AIFunctionFactory.Create(GetWeather), |
|||
AIFunctionFactory.Create(GetCurrentUserInfo) |
|||
]; |
|||
|
|||
[Description("Get current user information")] |
|||
private Task<string> GetCurrentUserInfo() |
|||
{ |
|||
return Task.FromResult(CurrentUser.IsAuthenticated ? |
|||
$"UserId: {CurrentUser.Id}, Name: {CurrentUser.UserName}, Email: {CurrentUser.Email}, Roles: {string.Join(", ", CurrentUser.Roles)}" : |
|||
"No user information available."); |
|||
} |
|||
``` |
|||
|
|||
## Step 4: Add Navigation |
|||
|
|||
Add a `Chat` menu item in `AbpAiChatMenuContributor` to navigate to the AI Chat component. |
|||
|
|||
## Running the Application |
|||
|
|||
After completing the integration, you can run the application and access the AI chat functionality. The chat interface allows you to: |
|||
|
|||
- Get weather information |
|||
- Ask questions about PDF content |
|||
- Retrieve current user information |
|||
- And more! |
|||
|
|||
 |
|||
|
|||
## Conclusion |
|||
|
|||
This integration demonstrates how to leverage the power of AI in your ABP Framework applications. The .NET AI Chat Template provides a solid foundation for building intelligent chat interfaces, and ABP Framework makes it more powerful. |
|||
|
|||
## References |
|||
|
|||
- [ABP Single Layer Solution](https://abp.io/docs/latest/solution-templates/single-layer-web-application/overview) |
|||
- [.NET AI Template Documentation](https://devblogs.microsoft.com/dotnet/announcing-dotnet-ai-template-preview1/) |
|||
- [GitHub Personal Access Tokens Guide](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) |
|||
|
|||
## Source Code |
|||
|
|||
- [AbpAiChat Source Code](https://github.com/abpframework/abp-samples/tree/master/AIChat) |
|||
|
After Width: | Height: | Size: 236 KiB |
|
After Width: | Height: | Size: 1.8 MiB |
@ -0,0 +1,38 @@ |
|||
You Asked, We Delivered: Introducing Our New Training Bootcamp\! |
|||
|
|||
Over the past months we’ve heard from countless freelancers, individuals and small teams asking for a focused, high-impact training without the overwhelming commitment or high costs of traditional bootcamps. So here we are\! |
|||
|
|||
We're excited to introduce **ABP Bootcamp: Mastering Infrastructure & Features**, a full training experience designed to help developers level up fast with practical knowledge they can apply immediately. |
|||
|
|||
This live, instructor-led program delivers four days of in-depth, real-world training on ABP’s infrastructure and core features. |
|||
|
|||
**Bootcamp Details** |
|||
|
|||
Dates: July 1,2,3,4 2025 |
|||
Time: 17:00-19:00 (UTC) each day |
|||
Format: Live, online sessions |
|||
Price: $399 (discounted $799) |
|||
Seats: Limited to a small group |
|||
|
|||
### **What You’ll Learn** |
|||
|
|||
By the end of this bootcamp, you’ll have: |
|||
|
|||
\-A solid understanding of ABP’s infrastructure, systems, and design patterns |
|||
\-Practical experience with features like dependency injection, configuration, logging, and localization |
|||
\-The ability to implement email templating, event bus, caching, and custom settings in real applications |
|||
\-Knowledge of best practices for building scalable, maintainable, and high-performance solutions with ABP |
|||
|
|||
### **Who It’s For** |
|||
|
|||
This bootcamp is ideal for: |
|||
|
|||
\-Developers and freelancers using ABP in their daily work |
|||
\-Teams looking to speed up onboarding and improve development efficiency |
|||
\-Anyone who wants practical ABP knowledge without committing to long-format training programs |
|||
|
|||
### **Reserve Your Spot** |
|||
|
|||
Seats are limited to keep the experience interactive and personalized. With the current 50% discount, this is the most accessible way to gain hands-on ABP experience with expert guidance. |
|||
|
|||
**Registration is now open. Secure your place today and master the infrastructure that powers ABP. Register here: [https://docs.google.com/forms/d/e/1FAIpQLSckMZChdqIJIuWiEvg\_KsSDmrxagRdc5WBYceAemHLrmT1oiA/viewform](https://docs.google.com/forms/d/e/1FAIpQLSckMZChdqIJIuWiEvg_KsSDmrxagRdc5WBYceAemHLrmT1oiA/viewform)** |
|||
|
After Width: | Height: | Size: 30 KiB |
@ -0,0 +1,93 @@ |
|||
# Solving MongoDB GUID Issues After an ABP Framework Upgrade |
|||
|
|||
So, you've just upgraded your ABP Framework application to a newer version (like v9.2.0+) and suddenly, your application can't read data from its MongoDB database. You're seeing strange deserialization errors, especially related to `Guid` types. What's going on? |
|||
|
|||
You've likely run into a classic compatibility issue with the MongoDB .NET driver. |
|||
|
|||
### The Problem: Legacy vs. Standard GUIDs |
|||
|
|||
Here's the short version: |
|||
|
|||
* **Old MongoDB Drivers** (used in older ABP versions) stored `Guid` values in a format called `CSharpLegacy`. |
|||
* **New MongoDB Drivers** (v3.0+), now default to a universal `Standard` format. |
|||
|
|||
When your newly upgraded app tries to read old data, the new driver expects the `Standard` format but finds `CSharpLegacy`. The byte orders don't match, and... boom. Deserialization fails. |
|||
|
|||
The ABP Framework team has an excellent official guide covering this topic in detail. We highly recommend reading their **[MongoDB Driver 2 to 3 Migration Guide](https://abp.io/docs/latest/release-info/migration-guides/MongoDB-Driver-2-to-3)** for a full understanding. |
|||
|
|||
Our tip below serves as a fast, application-level fix if you need to get your system back online quickly without performing a full data migration. |
|||
|
|||
### The Quick Fix: Tell the Driver to Use the Old Format |
|||
|
|||
Instead of changing your data, you can simply tell the new driver to continue using the old `CSharpLegacy` format for all `Guid` and `Guid?` properties. This provides immediate backward compatibility without touching your database. |
|||
|
|||
It’s a simple, two-step process. |
|||
|
|||
#### Step 1: Create a Custom Convention |
|||
|
|||
First, create this class in your `.MongoDb` project. It tells the serializer how to handle `Guid` types. |
|||
|
|||
```csharp |
|||
using MongoDB.Bson; |
|||
using MongoDB.Bson.Serialization; |
|||
using MongoDB.Bson.Serialization.Conventions; |
|||
using MongoDB.Bson.Serialization.Serializers; |
|||
using System; |
|||
|
|||
public class LegacyGuidConvention : ConventionBase, IMemberMapConvention |
|||
{ |
|||
public void Apply(BsonMemberMap memberMap) |
|||
{ |
|||
if (memberMap.MemberType == typeof(Guid)) |
|||
{ |
|||
memberMap.SetSerializer(new GuidSerializer(GuidRepresentation.CSharpLegacy)); |
|||
} |
|||
else if (memberMap.MemberType == typeof(Guid?)) |
|||
{ |
|||
var guidSerializer = new GuidSerializer(GuidRepresentation.CSharpLegacy); |
|||
var nullableGuidSerializer = new NullableSerializer<Guid>(guidSerializer); |
|||
memberMap.SetSerializer(nullableGuidSerializer); |
|||
} |
|||
} |
|||
} |
|||
``` |
|||
|
|||
#### Step 2: Register the Convention at Startup |
|||
|
|||
Now, register this convention in your `YourProjectMongoDbModule.cs` file. Add this code to the top of the `ConfigureServices` method. This ensures your rule is applied globally as soon as the application starts. |
|||
|
|||
```csharp |
|||
using Volo.Abp.Modularity; |
|||
using MongoDB.Bson.Serialization; |
|||
using MongoDB.Bson.Serialization.Conventions; |
|||
|
|||
public class YourProjectMongoDbModule : AbpModule |
|||
{ |
|||
public override void ConfigureServices(ServiceConfigurationContext context) |
|||
{ |
|||
// Fix Start |
|||
var conventionPack = new ConventionPack { new LegacyGuidConvention() }; |
|||
ConventionRegistry.Register( |
|||
"LegacyGuidConvention", |
|||
conventionPack, |
|||
t => true); // Apply to all types |
|||
// Fix End |
|||
|
|||
// ... Your existing ConfigureServices code |
|||
} |
|||
} |
|||
``` |
|||
|
|||
### An Alternative to Full Data Migration |
|||
|
|||
It's important to note that the method described here is an **application-level fix**. It's a fantastic alternative to performing a full data migration, which involves writing scripts to convert every legacy GUID in your database. |
|||
|
|||
If you are interested in the more permanent, data-centric approach, the ABP.IO community has a detailed guide on [**Migrating MongoDB GUIDs from Legacy to Standard Format**](https://abp.io/community/articles/migrating-mongodb-guids-from-legacy-to-standard-format-mongodb-v2-to-v3-dqwybdtw). |
|||
|
|||
Our quick fix is ideal for getting a system back online fast or when a database migration is too complex. The full migration is better for long-term standards compliance. Choose the path that best fits your project's needs! |
|||
|
|||
### That's It! |
|||
|
|||
Restart your application, and the errors should be gone. Your app can now correctly read its old `Guid` data, and it will continue to write new data in the same legacy format, ensuring consistency. |
|||
|
|||
This approach is a lifesaver for existing projects, saving you from a risky and time-consuming data migration. For brand-new projects, you might consider starting with the `Standard` representation, but for everything else, this is a clean and effective fix. Happy coding! |
|||
@ -0,0 +1,113 @@ |
|||
# 🚀 New in ABP Studio: Modular Docker Container Management |
|||
|
|||
We're excited to announce a new improvement to Docker integration in **ABP Studio**! |
|||
With the latest update, you can now manage Docker containers **individually**, add or remove them dynamically, and launch them **either separately or collectively** — all within the Studio. |
|||
|
|||
 |
|||
|
|||
------ |
|||
|
|||
## 🔄 What Has Changed? |
|||
|
|||
In previous versions, Docker dependencies were handled using a **single `docker-compose.override.yml` file**, which was **automatically generated** when creating a new solution if it is needed. |
|||
|
|||
By default, this file included common development dependencies like PostgreSQL, Redis, RabbitMQ, etc., and was executed through a predefined script named `docker-dependencies` in the Solution Runner. |
|||
|
|||
While this approach worked well for simple setups, it had some limitations: |
|||
|
|||
- All services were bundled into a **single compose file**. |
|||
- Adding or removing services required modifying this central file. |
|||
- It wasn't possible to **start or stop individual containers independently**. |
|||
|
|||
------ |
|||
|
|||
## ✅ What's New? |
|||
|
|||
With the latest ABP Studio update: |
|||
|
|||
- Each Docker container can now be defined in its **own `docker-compose` file**. |
|||
- Compose files can be **added or removed** from the Studio UI. |
|||
- Containers can be: |
|||
- **Started or stopped individually**. |
|||
- **Started/stopped in bulk**. |
|||
- The **Solution Runner** recognizes Docker containers and can run them alongside application projects. |
|||
|
|||
------ |
|||
|
|||
## ⚠️ Important Notes Before You Start |
|||
|
|||
### Required: Use `container_name` for Docker Service Matching |
|||
|
|||
When working with the new modular Docker system in ABP Studio, each service **must define a `container_name`**. |
|||
This name is used by ABP Studio to **identify and map** Docker containers to their corresponding service entries in the Studio UI. |
|||
|
|||
#### Why is this mandatory? |
|||
|
|||
- ABP Studio relies on `container_name` to: |
|||
- Detect whether the service is stopped or continue running. |
|||
- Perform **start**, **stop**, and **status check** operations reliably. |
|||
- Match Studio UI entries with actual running Docker containers. |
|||
- Without a `container_name`, container discovery may fail and **service management features might not work as expected**. |
|||
|
|||
#### Example: |
|||
|
|||
``` |
|||
services: |
|||
redis: |
|||
container_name: redis |
|||
image: redis:7 |
|||
ports: |
|||
- "6379:6379" |
|||
networks: |
|||
- my-network |
|||
``` |
|||
|
|||
> If you do **not** define `container_name`, ABP Studio will be unable to track or control the service properly. |
|||
|
|||
------ |
|||
|
|||
## 📥 Migrating from the Old System |
|||
|
|||
If you're using the old method with a centralized compose file: |
|||
|
|||
Before: |
|||
|
|||
``` |
|||
docker-compose -f docker-compose.override.yml up -d |
|||
``` |
|||
|
|||
Now: |
|||
|
|||
1. Create separate `docker-compose` files for each service |
|||
(e.g., `docker-compose.postgres.yml`, `docker-compose.redis.yml`). |
|||
2. Go to the **Solution Runner tab in ABP Studio**. |
|||
3. Use the **“Add Docker Service”** option in Studio to register each file. |
|||
4. Optionally remove or archive the old monolithic compose file. |
|||
|
|||
> If your original `docker-compose.override.yml` contains multiple services, you can split it into individual files — Docker Compose and ABP Studio both support modular composition. |
|||
|
|||
------ |
|||
|
|||
## ⚙️ Advanced: Shared Network |
|||
|
|||
If your containers need to communicate over a shared network, you can define an external network in each compose file like this: |
|||
|
|||
``` |
|||
networks: |
|||
my-network: |
|||
external: true |
|||
``` |
|||
|
|||
ABP Studio automatically creates the network if they do no exist. But if you like you can create the network once using: |
|||
|
|||
``` |
|||
docker network create my-network |
|||
``` |
|||
|
|||
------ |
|||
|
|||
## 📚 Additional Resources |
|||
|
|||
- Docker Compose Documentation |
|||
- ABP Studio Documentation (link to updated docs when ready) |
|||
- [Report Issues on GitHub](https://github.com/abpframework/abp/issues) |
|||
|
After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 200 KiB After Width: | Height: | Size: 141 KiB |
|
Before Width: | Height: | Size: 296 KiB After Width: | Height: | Size: 183 KiB |
@ -0,0 +1,54 @@ |
|||
using System.Collections.Generic; |
|||
using Microsoft.Extensions.Options; |
|||
|
|||
namespace Volo.Abp.EventBus.RabbitMq; |
|||
|
|||
public class PostConfigureAbpRabbitMqEventBusOptions : IPostConfigureOptions<AbpRabbitMqEventBusOptions> |
|||
{ |
|||
private readonly HashSet<string> _uint64QueueArguments = |
|||
[ |
|||
"x-delivery-limit", |
|||
"x-expires", |
|||
"x-message-ttl", |
|||
"x-max-length", |
|||
"x-max-length-bytes", |
|||
"x-quorum-initial-group-size", |
|||
"x-quorum-target-group-size", |
|||
"x-stream-filter-size-bytes", |
|||
"x-stream-max-segment-size-bytes", |
|||
]; |
|||
|
|||
private readonly HashSet<string> _boolQueueArguments = |
|||
[ |
|||
"x-single-active-consumer" |
|||
]; |
|||
|
|||
public virtual void PostConfigure(string? name, AbpRabbitMqEventBusOptions options) |
|||
{ |
|||
ParseBoolQueueArguments(options); |
|||
ParseIntegerQueueArguments(options); |
|||
} |
|||
|
|||
protected virtual void ParseBoolQueueArguments(AbpRabbitMqEventBusOptions options) |
|||
{ |
|||
foreach (var argument in _boolQueueArguments) |
|||
{ |
|||
if (options.QueueArguments.TryGetValue(argument, out var value) && value is string stringValue && bool.TryParse(stringValue, out var boolValue)) |
|||
{ |
|||
options.QueueArguments[argument] = boolValue; |
|||
} |
|||
} |
|||
} |
|||
|
|||
protected virtual void ParseIntegerQueueArguments(AbpRabbitMqEventBusOptions options) |
|||
{ |
|||
foreach (var argument in _uint64QueueArguments) |
|||
{ |
|||
if (options.QueueArguments.TryGetValue(argument, out var value) && value is string stringValue && int.TryParse(stringValue, out var intValue)) |
|||
{ |
|||
options.QueueArguments[argument] = intValue; |
|||
} |
|||
} |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,44 @@ |
|||
using System.Collections.Concurrent; |
|||
using System.Threading.Tasks; |
|||
using Microsoft.Extensions.Options; |
|||
using MongoDB.Driver; |
|||
using Volo.Abp.DependencyInjection; |
|||
|
|||
namespace Volo.Abp.MongoDB.Clients; |
|||
|
|||
public class AbpMongoClientFactory : IAbpMongoClientFactory, ISingletonDependency |
|||
{ |
|||
protected ConcurrentDictionary<string, MongoClient> ClientCache { get; } |
|||
protected AbpMongoDbContextOptions Options { get; } |
|||
|
|||
public AbpMongoClientFactory(IOptions<AbpMongoDbContextOptions> options) |
|||
{ |
|||
Options = options.Value; |
|||
ClientCache = new ConcurrentDictionary<string, MongoClient>(); |
|||
} |
|||
|
|||
public virtual Task<MongoClient> GetAsync(MongoUrl mongoUrl) |
|||
{ |
|||
Check.NotNull(mongoUrl, nameof(mongoUrl)); |
|||
|
|||
return Task.FromResult( |
|||
ClientCache.GetOrAdd(mongoUrl.ToString(), _ => |
|||
{ |
|||
var mongoClientSettings = MongoClientSettings.FromUrl(mongoUrl); |
|||
Options.MongoClientSettingsConfigurer?.Invoke(mongoClientSettings); |
|||
return new MongoClient(mongoClientSettings); |
|||
})); |
|||
} |
|||
|
|||
public virtual MongoClient Get(MongoUrl mongoUrl) |
|||
{ |
|||
Check.NotNull(mongoUrl, nameof(mongoUrl)); |
|||
|
|||
return ClientCache.GetOrAdd(mongoUrl.ToString(), _ => |
|||
{ |
|||
var mongoClientSettings = MongoClientSettings.FromUrl(mongoUrl); |
|||
Options.MongoClientSettingsConfigurer?.Invoke(mongoClientSettings); |
|||
return new MongoClient(mongoClientSettings); |
|||
}); |
|||
} |
|||
} |
|||
@ -0,0 +1,13 @@ |
|||
using System; |
|||
using System.Threading.Tasks; |
|||
using MongoDB.Driver; |
|||
|
|||
namespace Volo.Abp.MongoDB.Clients; |
|||
|
|||
public interface IAbpMongoClientFactory |
|||
{ |
|||
Task<MongoClient> GetAsync(MongoUrl mongoUrl); |
|||
|
|||
[Obsolete("Use GetAsync method")] |
|||
MongoClient Get(MongoUrl mongoUrl); |
|||
} |
|||
@ -0,0 +1,8 @@ |
|||
namespace Volo.Abp.AspNetCore.Mvc.WebClientInfoProvider; |
|||
|
|||
public class WebClientInfoProviderDto |
|||
{ |
|||
public string BrowserInfo { get; set; } |
|||
|
|||
public string DeviceInfo { get; set; } |
|||
} |
|||
@ -0,0 +1,26 @@ |
|||
using System.Threading.Tasks; |
|||
using Microsoft.AspNetCore.Mvc; |
|||
using Volo.Abp.AspNetCore.WebClientInfo; |
|||
|
|||
namespace Volo.Abp.AspNetCore.Mvc.WebClientInfoProvider; |
|||
|
|||
[Route("api/web-client-info")] |
|||
public class WebClientInfoProviderTestController : AbpController |
|||
{ |
|||
private IWebClientInfoProvider _webClientInfoProvider { get; } |
|||
|
|||
public WebClientInfoProviderTestController(IWebClientInfoProvider webClientInfoProvider) |
|||
{ |
|||
_webClientInfoProvider = webClientInfoProvider; |
|||
} |
|||
|
|||
[HttpGet] |
|||
public Task<WebClientInfoProviderDto> GetAsync() |
|||
{ |
|||
return Task.FromResult(new WebClientInfoProviderDto |
|||
{ |
|||
BrowserInfo = _webClientInfoProvider.BrowserInfo, |
|||
DeviceInfo = _webClientInfoProvider.DeviceInfo |
|||
}); |
|||
} |
|||
} |
|||
@ -0,0 +1,36 @@ |
|||
using System.Net; |
|||
using System.Net.Http; |
|||
using System.Text.Json; |
|||
using System.Threading.Tasks; |
|||
using Shouldly; |
|||
using Xunit; |
|||
|
|||
namespace Volo.Abp.AspNetCore.Mvc.WebClientInfoProvider; |
|||
|
|||
public class WebClientInfoProviderTestController_Tests : AspNetCoreMvcTestBase |
|||
{ |
|||
[Theory] |
|||
[InlineData("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36", "Windows 10 Chrome")] |
|||
[InlineData("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/137.0.0.0 Safari/537.36", "Mac OS X Chrome")] |
|||
[InlineData("PostmanRuntime/7.43.4", "PostmanRuntime/7.43.4")] |
|||
[InlineData("curl/7.64.1", "curl/7.64.1")] |
|||
[InlineData("Mozilla/5.0 (compatible; MojeekBot/0.11; +mojeek.com/bot.html)", "MojeekBot")] |
|||
public async Task TestAsync(string ua, string device) |
|||
{ |
|||
var clientInfo = await GetWebClientInfoAsync(ua); |
|||
clientInfo.ShouldNotBeNull(); |
|||
clientInfo.BrowserInfo.ShouldBe(ua); |
|||
clientInfo.DeviceInfo.ShouldBe(device); |
|||
} |
|||
|
|||
private async Task<WebClientInfoProviderDto> GetWebClientInfoAsync(string userAgent ) |
|||
{ |
|||
using (var requestMessage = new HttpRequestMessage(HttpMethod.Get, "api/web-client-info")) |
|||
{ |
|||
requestMessage.Headers.Add("User-Agent", userAgent); |
|||
var response = await Client.SendAsync(requestMessage); |
|||
response.StatusCode.ShouldBe(HttpStatusCode.OK); |
|||
return JsonSerializer.Deserialize<WebClientInfoProviderDto>(await response.Content.ReadAsStringAsync(), JsonSerializerOptions.Web); |
|||
} |
|||
} |
|||
} |
|||
@ -0,0 +1,79 @@ |
|||
using System; |
|||
using System.Threading.Tasks; |
|||
using MongoDB.Driver; |
|||
using Xunit; |
|||
|
|||
namespace Volo.Abp.MongoDB.Clients; |
|||
|
|||
[Collection(MongoTestCollection.Name)] |
|||
public class MongoClient_Factory_Tests : MongoDbTestBase |
|||
{ |
|||
private readonly IAbpMongoClientFactory _factory; |
|||
|
|||
public MongoClient_Factory_Tests() |
|||
{ |
|||
_factory = GetRequiredService<IAbpMongoClientFactory>(); |
|||
} |
|||
|
|||
[Fact] |
|||
public async Task Should_Return_Same_Instance_For_Same_ConnectionString() |
|||
{ |
|||
// Arrange
|
|||
var mongoUrl = new MongoUrl("mongodb://localhost:27017/my-db"); |
|||
|
|||
// Act
|
|||
var client1 = await _factory.GetAsync(mongoUrl); |
|||
var client2 = await _factory.GetAsync(mongoUrl); |
|||
|
|||
// Assert
|
|||
Assert.Same(client1, client2); |
|||
} |
|||
|
|||
[Fact] |
|||
public async Task Should_Return_Different_Instances_For_Different_ConnectionStrings() |
|||
{ |
|||
// Arrange
|
|||
var mongoUrl1 = new MongoUrl("mongodb://localhost:27017/db1"); |
|||
var mongoUrl2 = new MongoUrl("mongodb://localhost:27017/db2"); |
|||
|
|||
// Act
|
|||
var client1 = await _factory.GetAsync(mongoUrl1); |
|||
var client2 = await _factory.GetAsync(mongoUrl2); |
|||
|
|||
// Assert
|
|||
Assert.NotSame(client1, client2); |
|||
} |
|||
|
|||
[Fact] |
|||
public async Task Should_Not_Throw_For_Valid_But_Unreachable_Connection() |
|||
{ |
|||
// Arrange
|
|||
var mongoUrl = new MongoUrl("mongodb://unreachablehost:12345/any"); |
|||
|
|||
// Act
|
|||
var client = await _factory.GetAsync(mongoUrl); |
|||
|
|||
// Assert
|
|||
Assert.NotNull(client); // Even though it's not connectable now, the instance can be created
|
|||
} |
|||
|
|||
[Fact] |
|||
public async Task Should_Be_ThreadSafe_When_Accessed_Concurrently() |
|||
{ |
|||
var mongoUrl = new MongoUrl("mongodb://localhost:27017/threadsafe"); |
|||
var results = new MongoClient[100]; |
|||
|
|||
await Parallel.ForAsync(0, 100, async (i, _) => |
|||
{ |
|||
results[i] = await _factory.GetAsync(mongoUrl); |
|||
}); |
|||
|
|||
Assert.All(results, client => Assert.Same(results[0], client)); |
|||
} |
|||
|
|||
[Fact] |
|||
public async Task Should_Throw_If_ConnectionString_Is_Null_Or_Empty() |
|||
{ |
|||
await Assert.ThrowsAsync<ArgumentNullException>(() => _factory.GetAsync(null!)); |
|||
} |
|||
} |
|||
@ -0,0 +1,9 @@ |
|||
namespace Volo.Abp.AuditLogging; |
|||
|
|||
public static class AuditLogExcelFileConsts |
|||
{ |
|||
/// <summary>
|
|||
/// Default value: 256
|
|||
/// </summary>
|
|||
public static int MaxFileNameLength { get; set; } = 256; |
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue