Recursively migrate DTGE property values

Author: ronaldbarendse

src/Umbraco.Deploy.Contrib/Migrators/DocTypeGridEditorPropertyTypeMigrator.cs

@@ -1,17 +1,20 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.DependencyInjection;
 using Umbraco.Cms.Core.Deploy;
 using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Models.Blocks;
 using Umbraco.Cms.Core.PropertyEditors;
 using Umbraco.Cms.Core.Serialization;
 using Umbraco.Cms.Core.Services;
 using Umbraco.Cms.Core.Strings;
+using Umbraco.Deploy.Core.Migrators;
 using Umbraco.Deploy.Infrastructure.Migrators;
 using Umbraco.Extensions;
 
@@ -22,7 +25,10 @@ namespace Umbraco.Deploy.Contrib.Migrators;
 /// </summary>
 public class DocTypeGridEditorPropertyTypeMigrator : GridPropertyTypeMigrator
 {
+    private readonly ILogger<GridPropertyTypeMigrator> _logger;
     private readonly IJsonSerializer _jsonSerializer;
+    private readonly PropertyTypeMigratorCollection _propertyTypeMigrators;
+    private IDictionary<string, string>? _propertyEditorAliases;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="DocTypeGridEditorPropertyTypeMigrator" /> class.
@@ -33,9 +39,44 @@ public class DocTypeGridEditorPropertyTypeMigrator : GridPropertyTypeMigrator
     /// <param name="shortStringHelper">The short string helper.</param>
     /// <param name="contentTypeService">The content type service.</param>
     /// <param name="mediaService">The media service.</param>
+    [Obsolete("Use the constructor with all parameters. This will be removed in a future version.")]
     public DocTypeGridEditorPropertyTypeMigrator(ILogger<GridPropertyTypeMigrator> logger, IJsonSerializer jsonSerializer, IDataTypeService dataTypeService, IShortStringHelper shortStringHelper, IContentTypeService contentTypeService, IMediaService mediaService)
+        : this(
+              logger,
+              jsonSerializer,
+              dataTypeService,
+              shortStringHelper,
+              contentTypeService,
+              mediaService,
+              StaticServiceProvider.Instance.GetRequiredService<PropertyTypeMigratorCollection>())
+    { }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DocTypeGridEditorPropertyTypeMigrator" /> class.
+    /// </summary>
+    /// <param name="logger">The logger.</param>
+    /// <param name="jsonSerializer">The JSON serializer.</param>
+    /// <param name="dataTypeService">The data type service.</param>
+    /// <param name="shortStringHelper">The short string helper.</param>
+    /// <param name="contentTypeService">The content type service.</param>
+    /// <param name="mediaService">The media service.</param>
+    /// <param name="propertyTypeMigrators">The property type migrators.</param>
+    public DocTypeGridEditorPropertyTypeMigrator(ILogger<GridPropertyTypeMigrator> logger, IJsonSerializer jsonSerializer, IDataTypeService dataTypeService, IShortStringHelper shortStringHelper, IContentTypeService contentTypeService, IMediaService mediaService, PropertyTypeMigratorCollection propertyTypeMigrators)
         : base(logger, jsonSerializer, dataTypeService, shortStringHelper, contentTypeService, mediaService)
-        => _jsonSerializer = jsonSerializer;
+    {
+        _logger = logger;
+        _jsonSerializer = jsonSerializer;
+        _propertyTypeMigrators = propertyTypeMigrators;
+    }
+
+    /// <inheritdoc />
+    public override object? Migrate(IPropertyType propertyType, object? value, IDictionary<string, string> propertyEditorAliases, IContextCache contextCache)
+    {
+        // Workaround: store property editor aliases for use in MigrateGridControl
+        _propertyEditorAliases = propertyEditorAliases;
+
+        return base.Migrate(propertyType, value, propertyEditorAliases, contextCache);
+    }
 
     /// <inheritdoc />
     protected override BlockItemData? MigrateGridControl(GridValue.GridControl gridControl, BlockGridConfiguration configuration, IContextCache contextCache)
@@ -62,11 +103,28 @@ public DocTypeGridEditorPropertyTypeMigrator(ILogger<GridPropertyTypeMigrator> l
         IContentType contentType = GetContentType(value.ContentTypeAlias, configuration, contextCache)
             ?? throw new InvalidOperationException($"Migrating legacy grid failed, because content type with alias '{value.ContentTypeAlias}' could not be found (in the Block Grid configuration).");
 
+        var propertyValues = new Dictionary<string, object?>(value.Value.Count);
+
+        foreach (IPropertyType propertyType in contentType.CompositionPropertyTypes)
+        {
+            if (value.Value.TryGetValue(propertyType.Alias, out object? propertyValue))
+            {
+                if (_propertyEditorAliases is not null && _propertyTypeMigrators.TryMigrate(propertyType, propertyValue, _propertyEditorAliases, contentType.Alias, contextCache, out var migratedValue))
+                {
+                    _logger.LogDebug("Migrated nested/recursive property {PropertyTypeAlias} on {ContentTypeAlias} to {PropertyEditorAlias}: {Value}.", propertyType.Alias, contentType.Alias, propertyType.PropertyEditorAlias, migratedValue);
+
+                    propertyValue = migratedValue;
+                }
+
+                propertyValues[propertyType.Alias] = propertyValue;
+            }
+        }
+
         return new BlockItemData()
         {
             Udi = Udi.Create(Constants.UdiEntityType.Element, value.Id),
             ContentTypeKey = contentType.Key,
-            RawPropertyValues = value.Value
+            RawPropertyValues = propertyValues
         };
     }