Replace property value artifact migrators with prevalue artifact and property type migrators

Author: ronaldbarendse

src/Umbraco.Deploy.Contrib/Extensions/ArtifactMigratorCollectionBuilderExtensions.cs

@@ -44,8 +44,6 @@ public static ArtifactMigratorCollectionBuilder AddLegacyMigrators(this Artifact
             .Append<TextboxDataTypeArtifactMigrator>()
             .Append<TextboxMultipleDataTypeArtifactMigrator>()
             .Append<TinyMCEv3DataTypeArtifactMigrator>()
-            // Property values
-            .Append<CheckBoxListPropertyValueArtifactMigrator>()
-            .Append<DropDownListFlexiblePropertyValueArtifactMigrator>()
-            .Append<RadioButtonListPropertyValueArtifactMigrator>();
+            // Add prefixes to pre-value property editor aliases, triggering property type migrators
+            .Append<PrevalueArtifactMigrator>();
 }

src/Umbraco.Deploy.Contrib/Extensions/PropertyTypeMigratorCollectionBuilderExtensions.cs

@@ -0,0 +1,20 @@
+using Umbraco.Deploy.Contrib.Migrators.Legacy;
+using Umbraco.Deploy.Core.Migrators;
+
+namespace Umbraco.Extensions;
+
+public static class PropertyTypeMigratorCollectionBuilderExtensions
+{
+    /// <summary>
+    /// Adds the legacy property type migrators to allow importing from Umbraco 7.
+    /// </summary>
+    /// <returns>
+    /// The property type migrator collection builder.
+    /// </returns>
+    public static PropertyTypeMigratorCollectionBuilder AddLegacyMigrators(this PropertyTypeMigratorCollectionBuilder propertyTypeMigratorCollectionBuilder)
+        => propertyTypeMigratorCollectionBuilder
+            // Pre-values to a single value or JSON array
+            .Append<CheckBoxListPropertyTypeMigrator>()
+            .Append<DropDownListFlexiblePropertyTypeMigrator>()
+            .Append<RadioButtonListPropertyTypeMigrator>();
+}

src/Umbraco.Deploy.Contrib/Migrators/Legacy/Content/CheckBoxListPropertyTypeMigrator.cs

@@ -0,0 +1,21 @@
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Serialization;
+
+namespace Umbraco.Deploy.Contrib.Migrators.Legacy;
+
+/// <summary>
+/// Migrates the property value using the <see cref="Constants.PropertyEditors.Aliases.CheckBoxList" /> editor containing prevalues (seperated by <see cref="PrevaluePropertyTypeMigratorBase.Delimiter" />) from Umbraco 7 to a JSON array.
+/// </summary>
+public sealed class CheckBoxListPropertyTypeMigrator : PrevaluePropertyTypeMigratorBase
+{
+    /// <inheritdoc />
+    protected override bool Multiple => true;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CheckBoxListPropertyTypeMigrator" /> class.
+    /// </summary>
+    /// <param name="jsonSerializer">The JSON serializer.</param>
+    public CheckBoxListPropertyTypeMigrator(IJsonSerializer jsonSerializer)
+        : base(Constants.PropertyEditors.Aliases.CheckBoxList, jsonSerializer)
+    { }
+}

src/Umbraco.Deploy.Contrib/Migrators/Legacy/Content/DropDownListFlexiblePropertyTypeMigrator.cs

@@ -0,0 +1,21 @@
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Serialization;
+
+namespace Umbraco.Deploy.Contrib.Migrators.Legacy;
+
+/// <summary>
+/// Migrates the property value using the <see cref="Constants.PropertyEditors.Aliases.DropDownListFlexible" /> editor containing prevalues (seperated by <see cref="PrevaluePropertyTypeMigratorBase.Delimiter" />) from Umbraco 7 to a JSON array.
+/// </summary>
+public sealed class DropDownListFlexiblePropertyTypeMigrator : PrevaluePropertyTypeMigratorBase
+{
+    /// <inheritdoc />
+    protected override bool Multiple => true;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DropDownListFlexiblePropertyTypeMigrator" /> class.
+    /// </summary>
+    /// <param name="jsonSerializer">The JSON serializer.</param>
+    public DropDownListFlexiblePropertyTypeMigrator(IJsonSerializer jsonSerializer)
+        : base(Constants.PropertyEditors.Aliases.DropDownListFlexible, jsonSerializer)
+    { }
+}

src/Umbraco.Deploy.Contrib/Migrators/Legacy/Content/PrevalueArtifactMigrator.cs

@@ -0,0 +1,53 @@
+using System;
+using System.Linq;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Semver;
+using Umbraco.Deploy.Core.Migrators;
+using Umbraco.Deploy.Infrastructure.Artifacts.Content;
+using Umbraco.Extensions;
+
+namespace Umbraco.Deploy.Contrib.Migrators.Legacy;
+
+/// <summary>
+/// Migrates the <see cref="ContentArtifactBase" /> property editor aliases to add a prefix to Umbraco 7 prevalue editors, triggering property type migrators.
+/// </summary>
+public class PrevalueArtifactMigrator : ArtifactMigratorBase<ContentArtifactBase>
+{
+    internal const string EditorAliasPrefix = "MigratePrevalue.";
+
+    private readonly string[] _editorAliases;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PrevalueArtifactMigrator" /> class.
+    /// </summary>
+    public PrevalueArtifactMigrator()
+        : this(
+              Constants.PropertyEditors.Aliases.CheckBoxList,
+              Constants.PropertyEditors.Aliases.DropDownListFlexible,
+              Constants.PropertyEditors.Aliases.RadioButtonList)
+    { }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PrevalueArtifactMigrator" /> class.
+    /// </summary>
+    /// <param name="editorAliases">The editor aliases.</param>
+    protected PrevalueArtifactMigrator(params string[] editorAliases)
+    {
+        _editorAliases = editorAliases;
+
+        MaxVersion = new SemVersion(3, 0, 0);
+    }
+
+    /// <inheritdoc />
+    protected override bool CanMigrateType(Type type)
+        => type.Inherits<ContentArtifactBase>();
+
+    /// <inheritdoc />
+    protected override ContentArtifactBase? Migrate(ContentArtifactBase artifact)
+    {
+        // Add prefix to matching property editor aliases
+        artifact.PropertyEditorAliases = artifact.PropertyEditorAliases?.ToDictionary(x => x.Key, x => _editorAliases.Contains(x.Value) ? EditorAliasPrefix + x.Value : x.Value);
+
+        return artifact;
+    }
+}

src/Umbraco.Deploy.Contrib/Migrators/Legacy/Content/PrevaluePropertyTypeMigratorBase.cs

@@ -0,0 +1,55 @@
+using System;
+using System.Collections.Generic;
+using Umbraco.Cms.Core.Deploy;
+using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Core.Serialization;
+using Umbraco.Deploy.Core.Migrators;
+
+namespace Umbraco.Deploy.Contrib.Migrators.Legacy;
+
+/// <summary>
+/// Migrates the property value containing prevalues (seperated by <see cref="Delimiter" />) from Umbraco 7 to a single value or JSON array.
+/// </summary>
+public abstract class PrevaluePropertyTypeMigratorBase : PropertyTypeMigratorBase
+{
+    private const string EditorAliasPrefix = PrevalueArtifactMigrator.EditorAliasPrefix;
+    private const string Delimiter = ";;";
+
+    private readonly IJsonSerializer _jsonSerializer;
+
+    /// <summary>
+    /// Gets a value indicating whether the property type stores multiple prevalues as a JSON array or single value.
+    /// </summary>
+    /// <value>
+    ///   <c>true</c> if multiple prevalues are stored as a JSON array; otherwise, <c>false</c>.
+    /// </value>
+    protected abstract bool Multiple { get; }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PrevaluePropertyTypeMigratorBase" /> class.
+    /// </summary>
+    /// <param name="editorAlias">The editor alias.</param>
+    /// <param name="jsonSerializer">The JSON serializer.</param>
+    protected PrevaluePropertyTypeMigratorBase(string editorAlias, IJsonSerializer jsonSerializer)
+        : base(EditorAliasPrefix + editorAlias, editorAlias)
+        => _jsonSerializer = jsonSerializer;
+
+    /// <inheritdoc />
+    public override object? Migrate(IPropertyType propertyType, object? value, IDictionary<string, string> propertyEditorAliases, IContextCache contextCache)
+    {
+        if (value is not string stringValue)
+        {
+            return null;
+        }
+
+        var values = stringValue.Split(new[] { Delimiter }, StringSplitOptions.RemoveEmptyEntries);
+        if (values.Length == 0)
+        {
+            return null;
+        }
+
+        return Multiple
+            ? _jsonSerializer.Serialize(values)
+            : values[0];
+    }
+}

src/Umbraco.Deploy.Contrib/Migrators/Legacy/Content/RadioButtonListPropertyTypeMigrator.cs

@@ -0,0 +1,21 @@
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.Serialization;
+
+namespace Umbraco.Deploy.Contrib.Migrators.Legacy;
+
+/// <summary>
+/// Migrates the property value using the <see cref="Constants.PropertyEditors.Aliases.RadioButtonList" /> editor containing prevalues (seperated by <see cref="PrevaluePropertyTypeMigratorBase.Delimiter" />) from Umbraco 7 to a single value.
+/// </summary>
+public sealed class RadioButtonListPropertyTypeMigrator : PrevaluePropertyTypeMigratorBase
+{
+    /// <inheritdoc />
+    protected override bool Multiple => false;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RadioButtonListPropertyTypeMigrator" /> class.
+    /// </summary>
+    /// <param name="jsonSerializer">The JSON serializer.</param>
+    public RadioButtonListPropertyTypeMigrator(IJsonSerializer jsonSerializer)
+        : base(Constants.PropertyEditors.Aliases.RadioButtonList, jsonSerializer)
+    { }
+}