Skip to content

Reusable field schema migration improvements #435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
akfakmot merged 4 commits into from
Jun 5, 2025
Merged

Reusable field schema migration improvements #435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
56d6c5b
Add skipping of classes excluded by configuration
akfakmot Jun 5, 2025
8b43afe
Forbid both custom reusable schema builders & config based reusable s…
akfakmot Jun 5, 2025
6b8b88e
Fix formatting
akfakmot Jun 5, 2025
9b6899e
Reusable field schema improvements TW review
DavidBKentico Jun 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions KVA/Migration.Tool.Source/Handlers/MigrateCustomModulesCommandHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ public async Task<CommandResult> Handle(MigrateCustomModulesCommand request, Can

private async Task MigrateClasses(EntityConfiguration entityConfiguration, CancellationToken cancellationToken)
{
var dataClassEntityConfiguration = toolConfiguration.EntityConfigurations.GetEntityConfiguration<DataClassInfo>();
var manualMappings = classMappingProvider.ExecuteMappings();

using var cmsClasses = EnumerableHelper.CreateDeferrableItemWrapper(
Expand Down Expand Up @@ -97,6 +98,12 @@ private async Task MigrateClasses(EntityConfiguration entityConfiguration, Cance
continue;
}

if (dataClassEntityConfiguration.ExcludeCodeNames.Contains(cmsClass.ClassName,
StringComparer.InvariantCultureIgnoreCase))
{
continue;
}

if (!remapped())
{
if (cmsClass.ClassInheritsFromClassID is { } classInheritsFromClassId && !primaryKeyMappingContext.HasMapping<ICmsClass>(c => c.ClassID, classInheritsFromClassId))
Expand Down
11 changes: 10 additions & 1 deletion KVA/Migration.Tool.Source/Handlers/MigrateCustomTablesHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ public class MigrateCustomTablesHandler(
IUmtMapper<CustomTableMapperSource> mapper,
IEntityMapper<ICmsClass, DataClassInfo> dataClassMapper,
PrimaryKeyMappingContext primaryKeyMappingContext,
ClassMappingProvider classMappingProvider
ClassMappingProvider classMappingProvider,
ToolConfiguration toolConfiguration
)
: IRequestHandler<MigrateCustomTablesCommand, CommandResult>
{
Expand Down Expand Up @@ -83,6 +84,8 @@ private async Task<ResourceInfo> EnsureCustomTablesResource()

private async Task MigrateCustomTables()
{
var dataClassEntityConfiguration = toolConfiguration.EntityConfigurations.GetEntityConfiguration<DataClassInfo>();

using var srcClassesDe = EnumerableHelper.CreateDeferrableItemWrapper(
modelFacade.Select<ICmsClass>("ClassIsCustomTable=1", "ClassID ASC")
);
Expand All @@ -105,6 +108,12 @@ private async Task MigrateCustomTables()
continue;
}

if (dataClassEntityConfiguration.ExcludeCodeNames.Contains(ksClass.ClassName,
StringComparer.InvariantCultureIgnoreCase))
{
continue;
}

if (ksClass.ClassInheritsFromClassID is { } classInheritsFromClassId && !primaryKeyMappingContext.HasMapping<ICmsClass>(c => c.ClassID, classInheritsFromClassId))
{
// defer migration to later stage
Expand Down
18 changes: 17 additions & 1 deletion KVA/Migration.Tool.Source/Handlers/MigratePageTypesCommandHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

using Migration.Tool.Common;
using Migration.Tool.Common.Abstractions;
using Migration.Tool.Common.Builders;
using Migration.Tool.Common.Helpers;
using Migration.Tool.Common.MigrationProtocol;
using Migration.Tool.KXP.Api;
Expand All @@ -31,7 +32,8 @@ public class MigratePageTypesCommandHandler(
PageTemplateMigrator pageTemplateMigrator,
ReusableSchemaService reusableSchemaService,
ClassMappingProvider classMappingProvider,
IImporter importer
IImporter importer,
IEnumerable<IReusableSchemaBuilder> reusableSchemaBuilders
)
: IRequestHandler<MigratePageTypesCommand, CommandResult>
{
Expand All @@ -50,6 +52,14 @@ public async Task<CommandResult> Handle(MigratePageTypesCommand request, Cancell
var manuallyMappedSourceClassIDs = new HashSet<int>();
var manuallyMappedSourceClassNames = manualMappings.Values.SelectMany(x => x.mappping.SourceClassNames).ToHashSet();

if (reusableSchemaBuilders.Any() && !string.IsNullOrWhiteSpace(toolConfiguration.CreateReusableFieldSchemaForClasses))
{
logger.LogError("Conversion to reusable field schema using appsettings configuration " +
"is not allowed when custom class mapping reusable schema builders are " +
"used. Use one option or the other. Terminating migration of page types.");
return new CommandFailureResult();
}

while (ksClasses.GetNext(out var di))
{
var (_, ksClass) = di;
Expand All @@ -64,6 +74,12 @@ public async Task<CommandResult> Handle(MigratePageTypesCommand request, Cancell
continue;
}

if (entityConfiguration.ExcludeCodeNames.Contains(ksClass.ClassName,
StringComparer.InvariantCultureIgnoreCase))
{
continue;
}

if (ksClass.ClassInheritsFromClassID is { } classInheritsFromClassId && !(primaryKeyMappingContext.HasMapping<ICmsClass>(c => c.ClassID, classInheritsFromClassId) || manuallyMappedSourceClassIDs.Contains(classInheritsFromClassId)))
{
// defer migration to later stage
Expand Down
Loading