Simplify creating content from a blueprint programmatically (#19528)

* Rename `IContentService.CreateContentFromBlueprint` to `CreateBlueprintFromContent`

In reality, this method is used by the core to create a blueprint from content, and not the other way around, which doesn't need new ids. This was causing confusion, so the old name has been marked as deprecated in favor of the new name. If developers want to create content from blueprints they should use `IContentBlueprintEditingService.GetScaffoldedAsync()` instead, which is what is used by the management api.

* Added integration tests to verify that new block ids are generated when creating content from a blueprint

* Return copy of the blueprint in `ContentBlueprintEditingService.GetScaffoldedAsync` instead of the blueprint itself

* Update CreateContentFromBlueprint xml docs to mention both replacement methods

* Fix tests for rich text blocks

* Small re-organization

* Adjusted tests that were still referencing `ContentService.CreateContentFromBlueprint`

* Add default implementation to new CreateBlueprintFromContent method

* Update tests/Umbraco.Tests.Integration/Umbraco.Infrastructure/Services/ContentBlueprintEditingServiceTests.GetScaffold.cs

Co-authored-by: Andy Butland <[email protected]>

---------

Co-authored-by: Andy Butland <[email protected]>

Author: lauraneto

src/Umbraco.Core/Services/ContentBlueprintEditingService.cs

@@ -45,11 +45,13 @@ public ContentBlueprintEditingService(
             return Task.FromResult<IContent?>(null);
         }
 
+        IContent scaffold = blueprint.DeepCloneWithResetIdentities();
+
         using ICoreScope scope = CoreScopeProvider.CreateCoreScope();
-        scope.Notifications.Publish(new ContentScaffoldedNotification(blueprint, blueprint, Constants.System.Root, new EventMessages()));
+        scope.Notifications.Publish(new ContentScaffoldedNotification(blueprint, scaffold, Constants.System.Root, new EventMessages()));
         scope.Complete();
 
-        return Task.FromResult<IContent?>(blueprint);
+        return Task.FromResult<IContent?>(scaffold);
     }
 
     public async Task<Attempt<PagedModel<IContent>?, ContentEditingOperationStatus>> GetPagedByContentTypeAsync(Guid contentTypeKey, int skip, int take)
@@ -112,7 +114,7 @@ public async Task<Attempt<ContentCreateResult, ContentEditingOperationStatus>> C
 
         // Create Blueprint
         var currentUserId = await GetUserIdAsync(userKey);
-        IContent blueprint = ContentService.CreateContentFromBlueprint(content, name, currentUserId);
+        IContent blueprint = ContentService.CreateBlueprintFromContent(content, name, currentUserId);
 
         if (key.HasValue)
         {

src/Umbraco.Core/Services/ContentService.cs

@@ -3654,12 +3654,12 @@ public void DeleteBlueprint(IContent content, int userId = Constants.Security.Su
 
     private static readonly string?[] ArrayOfOneNullString = { null };
 
-    public IContent CreateContentFromBlueprint(IContent blueprint, string name, int userId = Constants.Security.SuperUserId)
+    public IContent CreateBlueprintFromContent(
+        IContent blueprint,
+        string name,
+        int userId = Constants.Security.SuperUserId)
     {
-        if (blueprint == null)
-        {
-            throw new ArgumentNullException(nameof(blueprint));
-        }
+        ArgumentNullException.ThrowIfNull(blueprint);
 
         IContentType contentType = GetContentType(blueprint.ContentType.Alias);
         var content = new Content(name, -1, contentType);
@@ -3672,15 +3672,13 @@ public IContent CreateContentFromBlueprint(IContent blueprint, string name, int
         if (blueprint.CultureInfos?.Count > 0)
         {
             cultures = blueprint.CultureInfos.Values.Select(x => x.Culture);
-            using (ICoreScope scope = ScopeProvider.CreateCoreScope())
+            using ICoreScope scope = ScopeProvider.CreateCoreScope();
+            if (blueprint.CultureInfos.TryGetValue(_languageRepository.GetDefaultIsoCode(), out ContentCultureInfos defaultCulture))
             {
-                if (blueprint.CultureInfos.TryGetValue(_languageRepository.GetDefaultIsoCode(), out ContentCultureInfos defaultCulture))
-                {
-                    defaultCulture.Name = name;
-                }
-
-                scope.Complete();
+                defaultCulture.Name = name;
             }
+
+            scope.Complete();
         }
 
         DateTime now = DateTime.Now;
@@ -3701,6 +3699,11 @@ public IContent CreateContentFromBlueprint(IContent blueprint, string name, int
         return content;
     }
 
+    /// <inheritdoc />
+    [Obsolete("Use IContentBlueprintEditingService.GetScaffoldedAsync() instead. Scheduled for removal in V18.")]
+    public IContent CreateContentFromBlueprint(IContent blueprint, string name, int userId = Constants.Security.SuperUserId)
+        => CreateBlueprintFromContent(blueprint, name, userId);
+
     public IEnumerable<IContent> GetBlueprintsForContentTypes(params int[] contentTypeId)
     {
         using (ScopeProvider.CreateCoreScope(autoComplete: true))

src/Umbraco.Core/Services/IContentService.cs

@@ -55,8 +55,18 @@ public interface IContentService : IContentServiceBase<IContent>
     void DeleteBlueprint(IContent content, int userId = Constants.Security.SuperUserId);
 
     /// <summary>
-    ///     Creates a new content item from a blueprint.
+    ///     Creates a blueprint from a content item.
     /// </summary>
+    // TODO: Remove the default implementation when CreateContentFromBlueprint is removed.
+    IContent CreateBlueprintFromContent(IContent blueprint, string name, int userId = Constants.Security.SuperUserId)
+        => throw new NotImplementedException();
+
+    /// <summary>
+    ///     (Deprecated) Creates a new content item from a blueprint.
+    /// </summary>
+    /// <remarks>If creating content from a blueprint, use <see cref="IContentBlueprintEditingService.GetScaffoldedAsync"/>
+    /// instead. If creating a blueprint from content use <see cref="CreateBlueprintFromContent"/> instead.</remarks>
+    [Obsolete("Use IContentBlueprintEditingService.GetScaffoldedAsync() instead. Scheduled for removal in V18.")]
     IContent CreateContentFromBlueprint(IContent blueprint, string name, int userId = Constants.Security.SuperUserId);
 
     /// <summary>

tests/Umbraco.Tests.Common/Builders/DataTypeBuilder.cs

@@ -1,9 +1,12 @@
 // Copyright (c) Umbraco.
 // See LICENSE for more details.
 
-using System;
+using Umbraco.Cms.Core;
+using Umbraco.Cms.Core.IO;
 using Umbraco.Cms.Core.Models;
+using Umbraco.Cms.Core.PropertyEditors;
 using Umbraco.Cms.Infrastructure.Serialization;
+using Umbraco.Cms.Tests.Common.Builders.Extensions;
 using Umbraco.Cms.Tests.Common.Builders.Interfaces;
 
 namespace Umbraco.Cms.Tests.Common.Builders;
@@ -155,4 +158,100 @@ public override DataType Build()
 
         return dataType;
     }
+
+    public static DataType CreateSimpleElementDataType(
+        IIOHelper ioHelper,
+        string editorAlias,
+        Guid elementKey,
+        Guid? elementSettingKey)
+    {
+        Dictionary<string, object> configuration = editorAlias switch
+        {
+            Constants.PropertyEditors.Aliases.BlockGrid => GetBlockGridBaseConfiguration(),
+            Constants.PropertyEditors.Aliases.RichText => GetRteBaseConfiguration(),
+            _ => [],
+        };
+
+        SetBlockConfiguration(
+            configuration,
+            elementKey,
+            elementSettingKey,
+            editorAlias == Constants.PropertyEditors.Aliases.BlockGrid ? true : null);
+
+
+        var dataTypeBuilder = new DataTypeBuilder()
+            .WithId(0)
+            .WithDatabaseType(ValueStorageType.Nvarchar)
+            .AddEditor()
+            .WithAlias(editorAlias);
+
+        switch (editorAlias)
+        {
+            case Constants.PropertyEditors.Aliases.BlockGrid:
+                dataTypeBuilder.WithConfigurationEditor(
+                    new BlockGridConfigurationEditor(ioHelper) { DefaultConfiguration = configuration });
+                break;
+            case Constants.PropertyEditors.Aliases.BlockList:
+                dataTypeBuilder.WithConfigurationEditor(
+                    new BlockListConfigurationEditor(ioHelper) { DefaultConfiguration = configuration });
+                break;
+            case Constants.PropertyEditors.Aliases.RichText:
+                dataTypeBuilder.WithConfigurationEditor(
+                    new RichTextConfigurationEditor(ioHelper) { DefaultConfiguration = configuration });
+                break;
+        }
+
+        return dataTypeBuilder.Done().Build();
+    }
+
+    private static void SetBlockConfiguration(
+        Dictionary<string, object> dictionary,
+        Guid? elementKey,
+        Guid? elementSettingKey,
+        bool? allowAtRoot)
+    {
+        if (elementKey is null)
+        {
+            return;
+        }
+
+        dictionary["blocks"] = new[] { BuildBlockConfiguration(elementKey.Value, elementSettingKey, allowAtRoot) };
+    }
+
+    private static Dictionary<string, object> GetBlockGridBaseConfiguration() => new() { ["gridColumns"] = 12 };
+
+    private static Dictionary<string, object> GetRteBaseConfiguration()
+    {
+        var dictionary = new Dictionary<string, object>
+        {
+            ["maxImageSize"] = 500,
+            ["mode"] = "Classic",
+            ["toolbar"] = new[]
+            {
+                "styles", "bold", "italic", "alignleft", "aligncenter", "alignright", "bullist", "numlist", "outdent",
+                "indent", "sourcecode", "link", "umbmediapicker", "umbembeddialog"
+            },
+        };
+        return dictionary;
+    }
+
+    private static Dictionary<string, object> BuildBlockConfiguration(
+        Guid? elementKey,
+        Guid? elementSettingKey,
+        bool? allowAtRoot)
+    {
+        var dictionary = new Dictionary<string, object>();
+        if (allowAtRoot is not null)
+        {
+            dictionary.Add("allowAtRoot", allowAtRoot.Value);
+        }
+
+        dictionary.Add("contentElementTypeKey", elementKey.ToString());
+        if (elementSettingKey is not null)
+        {
+            dictionary.Add("settingsElementTypeKey", elementSettingKey.ToString());
+        }
+
+        return dictionary;
+    }
 }

tests/Umbraco.Tests.Integration/Testing/UmbracoIntegrationTestWithContent.cs

@@ -19,6 +19,8 @@ public abstract class UmbracoIntegrationTestWithContent : UmbracoIntegrationTest
 
     protected IContentTypeService ContentTypeService => GetRequiredService<IContentTypeService>();
 
+    protected IDataTypeService DataTypeService => GetRequiredService<IDataTypeService>();
+
     protected IFileService FileService => GetRequiredService<IFileService>();
 
     protected ContentService ContentService => (ContentService)GetRequiredService<IContentService>();

tests/Umbraco.Tests.Integration/Umbraco.Core/Services/ContentServiceTests.cs

@@ -130,7 +130,7 @@ public void Delete_Blueprint()
     }
 
     [Test]
-    public void Create_Content_From_Blueprint()
+    public void Create_Blueprint_From_Content()
     {
         using (var scope = ScopeProvider.CreateScope(autoComplete: true))
         {
@@ -140,22 +140,21 @@ public void Create_Content_From_Blueprint()
             var contentType = ContentTypeBuilder.CreateTextPageContentType(defaultTemplateId: template.Id);
             ContentTypeService.Save(contentType);
 
-            var blueprint = ContentBuilder.CreateTextpageContent(contentType, "hello", Constants.System.Root);
-            blueprint.SetValue("title", "blueprint 1");
-            blueprint.SetValue("bodyText", "blueprint 2");
-            blueprint.SetValue("keywords", "blueprint 3");
-            blueprint.SetValue("description", "blueprint 4");
-
-            ContentService.SaveBlueprint(blueprint);
-
-            var fromBlueprint = ContentService.CreateContentFromBlueprint(blueprint, "hello world");
-            ContentService.Save(fromBlueprint);
-
-            Assert.IsTrue(fromBlueprint.HasIdentity);
-            Assert.AreEqual("blueprint 1", fromBlueprint.Properties["title"].GetValue());
-            Assert.AreEqual("blueprint 2", fromBlueprint.Properties["bodyText"].GetValue());
-            Assert.AreEqual("blueprint 3", fromBlueprint.Properties["keywords"].GetValue());
-            Assert.AreEqual("blueprint 4", fromBlueprint.Properties["description"].GetValue());
+            var originalPage = ContentBuilder.CreateTextpageContent(contentType, "hello", Constants.System.Root);
+            originalPage.SetValue("title", "blueprint 1");
+            originalPage.SetValue("bodyText", "blueprint 2");
+            originalPage.SetValue("keywords", "blueprint 3");
+            originalPage.SetValue("description", "blueprint 4");
+            ContentService.Save(originalPage);
+
+            var fromContent = ContentService.CreateBlueprintFromContent(originalPage, "hello world");
+            ContentService.SaveBlueprint(fromContent);
+
+            Assert.IsTrue(fromContent.HasIdentity);
+            Assert.AreEqual("blueprint 1", fromContent.Properties["title"]?.GetValue());
+            Assert.AreEqual("blueprint 2", fromContent.Properties["bodyText"]?.GetValue());
+            Assert.AreEqual("blueprint 3", fromContent.Properties["keywords"]?.GetValue());
+            Assert.AreEqual("blueprint 4", fromContent.Properties["description"]?.GetValue());
         }
     }
 

tests/Umbraco.Tests.Integration/Umbraco.Core/Services/ElementSwitchValidatorTests.cs

@@ -286,104 +286,12 @@ private async Task SetupDataType(
         Guid elementKey,
         Guid? elementSettingKey)
     {
-        Dictionary<string, object> configuration;
-        switch (editorAlias)
-        {
-            case Constants.PropertyEditors.Aliases.BlockGrid:
-                configuration = GetBlockGridBaseConfiguration();
-                break;
-            case Constants.PropertyEditors.Aliases.RichText:
-                configuration = GetRteBaseConfiguration();
-                break;
-            default:
-                configuration = new Dictionary<string, object>();
-                break;
-        }
-
-        SetBlockConfiguration(
-            configuration,
+        var dataType = DataTypeBuilder.CreateSimpleElementDataType(
+            IOHelper,
+            editorAlias,
             elementKey,
-            elementSettingKey,
-            editorAlias == Constants.PropertyEditors.Aliases.BlockGrid ? true : null);
-
-
-        var dataTypeBuilder = new DataTypeBuilder()
-            .WithId(0)
-            .WithDatabaseType(ValueStorageType.Nvarchar)
-            .AddEditor()
-            .WithAlias(editorAlias);
-
-        switch (editorAlias)
-        {
-            case Constants.PropertyEditors.Aliases.BlockGrid:
-                dataTypeBuilder.WithConfigurationEditor(
-                    new BlockGridConfigurationEditor(IOHelper) { DefaultConfiguration = configuration });
-                break;
-            case Constants.PropertyEditors.Aliases.BlockList:
-                dataTypeBuilder.WithConfigurationEditor(
-                    new BlockListConfigurationEditor(IOHelper) { DefaultConfiguration = configuration });
-                break;
-            case Constants.PropertyEditors.Aliases.RichText:
-                dataTypeBuilder.WithConfigurationEditor(
-                    new RichTextConfigurationEditor(IOHelper) { DefaultConfiguration = configuration });
-                break;
-        }
-
-         var dataType = dataTypeBuilder.Done()
-            .Build();
+            elementSettingKey);
 
         await DataTypeService.CreateAsync(dataType, Constants.Security.SuperUserKey);
     }
-
-    private void SetBlockConfiguration(
-        Dictionary<string, object> dictionary,
-        Guid? elementKey,
-        Guid? elementSettingKey,
-        bool? allowAtRoot)
-    {
-        if (elementKey is null)
-        {
-            return;
-        }
-
-        dictionary["blocks"] = new[] { BuildBlockConfiguration(elementKey.Value, elementSettingKey, allowAtRoot) };
-    }
-
-    private Dictionary<string, object> GetBlockGridBaseConfiguration()
-        => new Dictionary<string, object> { ["gridColumns"] = 12 };
-
-    private Dictionary<string, object> GetRteBaseConfiguration()
-    {
-        var dictionary = new Dictionary<string, object>
-        {
-            ["maxImageSize"] = 500,
-            ["mode"] = "Classic",
-            ["toolbar"] = new[]
-            {
-                "styles", "bold", "italic", "alignleft", "aligncenter", "alignright", "bullist", "numlist",
-                "outdent", "indent", "sourcecode", "link", "umbmediapicker", "umbembeddialog"
-            },
-        };
-        return dictionary;
-    }
-
-    private Dictionary<string, object> BuildBlockConfiguration(
-        Guid? elementKey,
-        Guid? elementSettingKey,
-        bool? allowAtRoot)
-    {
-        var dictionary = new Dictionary<string, object>();
-        if (allowAtRoot is not null)
-        {
-            dictionary.Add("allowAtRoot", allowAtRoot.Value);
-        }
-
-        dictionary.Add("contentElementTypeKey", elementKey.ToString());
-        if (elementSettingKey is not null)
-        {
-            dictionary.Add("settingsElementTypeKey", elementSettingKey.ToString());
-        }
-
-        return dictionary;
-    }
 }