ABP Commercial Version 8.0 Migration Guide

This document is a guide for upgrading ABP Commercial v7.x solutions to ABP Commercial v8.0. Please read them all carefully since v8.0 has some changes that you should take care of.

ABP Commercial upgraded to .NET 8.0, so you need to move your solutions to .NET 8.0 if you want to use the ABP 8.0. You can check the Migrate from ASP.NET Core 7.0 to 8.0 documentation. Also, see the ABP Framework migration guide for the changes made in the ABP Framework.

Upgraded to OpenIddict to 5.0.0

The 5.0 release of OpenIddict is a major release that introduces breaking changes.

See OpenIddict 4.x to 5.x Migration Guide for more information.

Replaced IdentityUserLookupAppService with the IIdentityUserIntegrationService

Integration Services are built for module-to-module (or microservice-to-microservice) communication rather than consumed from a UI or a client application as Application Services are intended to do.

In that regard, we are discarding the IIdentityUserLookupAppService in the Identity Module and moving its functionality to the IIdentityUserIntegrationService. Therefore, if you have used that application service directly, use the integration service (IIdentityUserIntegrationService) instead. IIdentityUserLookupAppService will be removed in thes next versions, so you may need to create a similar service in your application.

Notice that integration services have no authorization and are not exposed as HTTP API by default.

Also, if you have overridden the IdentityUserLookupAppService and IdentityUserIntegrationService classes in your application, you should update these classes' constructors as follows:

IdentityUserLookupAppService.cs

    public IdentityUserLookupAppService(IIdentityUserIntegrationService identityUserIntegrationService)
    {
        IdentityUserIntegrationService = identityUserIntegrationService;
    }

IdentityUserIntegrationService.cs

    public IdentityUserIntegrationService(
        IIdentityUserRepository userRepository, 
+       IdentityUserRepositoryExternalUserLookupServiceProvider userLookupServiceProvider)
    {
        UserRepository = userRepository;
+       UserLookupServiceProvider = userLookupServiceProvider;
    }

CMS Kit Pro: Moved Public Components Under the Common Projects

We have revised the project structure of the CMS Kit Pro module and decided to create common projects to share common components between the public and backoffice applications. Therefore, we have moved some components under these common projects and this development led to modification in the namespaces of the CMS Kit Pro components and their associated DTOs.

As a result, the following namespaces and sub-namespaces were changed as in the following and if you have used these components, you should make the related namespace changes in your application:

Volo.CmsKit.Pro.Public.Web.Pages.Public.Shared.Components -> Volo.CmsKit.Pro.Web.Pages.Public.Shared.Components

The client-proxy.js file was also updated as follows:

client-proxies/cms-kit-pro-proxy.js -> client-proxies/cms-kit-pro-common-proxy.js

CMS Kit Pro: Changed Route Convention for Poll Feature

We have made some improvements on the CMS Kit Pro's Poll Feature such as preventing adding more than one poll with the same date range to a widget, or not rendering a widget without any active poll. During the development, we revised the Poll Feature and noticed that the route convention was not following the REST API Route URI Convention and this led us to update the routes.

You can see the following changes and if you are making a request to the following routes, you can change them as stated below:

/api/cms-kit-public/poll/findbywidget -> /api/cms-kit-public/poll/by-available-widget-name

/api/cms-kit-public/poll/findbycode -> /api/cms-kit-public/poll/by-code

/api/cms-kit-public/poll/showresult -> /api/cms-kit-public/poll/result/{id}

Switch Ocelot to YARP for the API Gateway (Microservice Solution Template)

Until this version, ABP Commercial was using the Ocelot for the API Gateway, in the Microservice Startup Template. Since the Ocelot library is not actively maintained, we have searched for an alternative and decided to switch from Ocelot to YARP for the API Gateway.

You don't need to make any changes in your solution regarding this migration. However, if you want to migrate your existing microservice application's API Gateway from Ocelot to YARP, then you can read the Migrating to YARP documentation.

Added the AccountAdminApplicationModule & AccountAdminHttpApiModule to Auth Server Project

In this version, the Volo.Abp.Account.Pro.Admin.HttpApi and Volo.Abp.Account.Pro.Admin.HttpApi packages have been added to the AuthServer project in the microservice startup template.

/apps/auth-server/src/MyCompanyName.MyProjectName.AuthServer/MyCompanyName.MyProjectName.AuthServer.csproj:

<ItemGroup>
+    <PackageReference Include="Volo.Abp.Account.Pro.Admin.HttpApi" Version="8.0.*"/>
+    <PackageReference Include="Volo.Abp.Account.Pro.Admin.Application" Version="8.0.*"/>
</ItemGroup>

/apps/auth-server/src/MyCompanyName.MyProjectName.AuthServer/MyProjectNameAuthServerModule.cs:

[DependsOn(
    //other module definitions...
+   typeof(AbpAccountAdminApplicationModule),
+   typeof(AbpAccountAdminHttpApiModule),
)]
public class MyProjectNameAuthServerModule : AbpModule
{
}

Upgraded NuGet Dependencies

You can see the following list of NuGet libraries that have been upgraded with .NET 8.0 upgrade, if you are using one of these packages explicitly, you may consider upgrading them in your solution: