OSOE-818: Upgrade to Orchard Core 2.0

Lombiq.ContentEditors.Samples/Controllers/FrontEndDemoContentItemAsyncEditorController.cs

@@ -3,17 +3,17 @@
 using Lombiq.ContentEditors.ViewModels;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
-using OrchardCore.Contents;
 using OrchardCore.Modules;
 using System.Threading.Tasks;
+using static OrchardCore.Contents.CommonPermissions;
 
 namespace Lombiq.ContentEditors.Samples.Controllers;
 
 // In case you want to create an async editor UI on a page other than the admin UI, you can create a similar controller
 // to this one.
 [Feature(FeatureIds.Samples)]
 [Route(Routes.FrontEndContentItemAsyncEditor)]
-public class FrontEndDemoContentItemAsyncEditorController : Controller
+public sealed class FrontEndDemoContentItemAsyncEditorController : Controller
 {
     private readonly IAuthorizationService _authorizationService;
 
@@ -25,7 +25,7 @@ public async Task<IActionResult> Index(string contentItemId)
     {
         if (!ModelState.IsValid) return BadRequest(ModelState);
 
-        if (!await _authorizationService.AuthorizeAsync(User, Permissions.EditContent)) return this.ChallengeOrForbid();
+        if (!await _authorizationService.AuthorizeAsync(User, EditContent)) return this.ChallengeOrForbid();
 
         // You can use the existing ContentItemAsyncEditorViewModel to pass the required data.
         return View(

Lombiq.ContentEditors.Samples/Drivers/SupportTicketPartDisplayDriver.cs

@@ -3,15 +3,15 @@
 using Lombiq.ContentEditors.Samples.ViewModels;
 using OrchardCore.ContentManagement.Display.ContentDisplay;
 using OrchardCore.ContentManagement.Display.Models;
-using OrchardCore.DisplayManagement.ModelBinding;
+using OrchardCore.DisplayManagement.Handlers;
 using OrchardCore.DisplayManagement.Views;
 using System.Threading.Tasks;
 
 namespace Lombiq.ContentEditors.Samples.Drivers;
 
 // This is the driver for the SupportTicketPart. It'll generate and place editor shapes for the respective editor
 // groups.
-public class SupportTicketPartDisplayDriver : ContentPartDisplayDriver<SupportTicketPart>
+public sealed class SupportTicketPartDisplayDriver : ContentPartDisplayDriver<SupportTicketPart>
 {
     // The editor shapes are generated here. The shape is placed from here instead of using the placement.json file.
     public override IDisplayResult Edit(SupportTicketPart part, BuildPartEditorContext context) =>
@@ -27,23 +27,21 @@ public override IDisplayResult Edit(SupportTicketPart part, BuildPartEditorConte
                 viewModel.Description = part.Description;
             }).OnGroup(EditorGroups.SupportTicket.Details).Location("Content"));
 
-    public override async Task<IDisplayResult> UpdateAsync(SupportTicketPart part, IUpdateModel updater, UpdatePartEditorContext context)
+    public override async Task<IDisplayResult> UpdateAsync(SupportTicketPart part, UpdatePartEditorContext context)
     {
         // It's a good idea to check what editor group is being updated. This way you can have different update logic
-        // for different editor groups and you won't update properties that aren't on the current editor group.
+        // for different editor groups, and you won't update properties that aren't on the current editor group.
         switch (context.GroupId)
         {
             case EditorGroups.SupportTicket.Reporter:
-                var reporterViewModel = new EditSupportTicketReporterViewModel();
-                await updater.TryUpdateModelAsync(reporterViewModel, Prefix);
+                var reporterViewModel = await context.CreateModelAsync<EditSupportTicketReporterViewModel>(Prefix);
 
                 part.Name = reporterViewModel.Name;
                 part.Email = reporterViewModel.Email;
 
                 break;
             case EditorGroups.SupportTicket.Details:
-                var detailsViewModel = new EditSupportTicketDetailsViewModel();
-                await updater.TryUpdateModelAsync(detailsViewModel, Prefix);
+                var detailsViewModel = await context.CreateModelAsync<EditSupportTicketDetailsViewModel>(Prefix);
 
                 part.Url = detailsViewModel.Url;
                 part.Description = detailsViewModel.Description;

Lombiq.ContentEditors.Samples/Lombiq.ContentEditors.Samples.csproj

@@ -31,8 +31,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="OrchardCore.Module.Targets" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.Contents" Version="1.8.0" />
+    <PackageReference Include="OrchardCore.Module.Targets" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.Contents" Version="2.0.0" />
   </ItemGroup>
 
   <ItemGroup>

Lombiq.ContentEditors.Samples/Migrations/EmployeeMigrations.cs

@@ -11,7 +11,7 @@
 namespace Lombiq.ContentEditors.Samples.Migrations;
 
 // This is the migration class for the Employee content type. Nothing specific to async editors here.
-public class EmployeeMigrations : DataMigration
+public sealed class EmployeeMigrations : DataMigration
 {
     private readonly IContentDefinitionManager _contentDefinitionManager;
 

Lombiq.ContentEditors.Samples/Migrations/SupportTicketMigrations.cs

@@ -8,7 +8,7 @@
 namespace Lombiq.ContentEditors.Samples.Migrations;
 
 // This is the migration class for the Support Ticket content type. Nothing specific to async editors here.
-public class SupportTicketMigrations : DataMigration
+public sealed class SupportTicketMigrations : DataMigration
 {
     private readonly IContentDefinitionManager _contentDefinitionManager;
 

Lombiq.ContentEditors.Samples/Startup.cs

@@ -16,7 +16,7 @@
 namespace Lombiq.ContentEditors.Samples;
 
 [Feature(FeatureIds.Samples)]
-public class Startup : StartupBase
+public sealed class Startup : StartupBase
 {
     public override void ConfigureServices(IServiceCollection services)
     {
@@ -33,6 +33,6 @@ public override void ConfigureServices(IServiceCollection services)
 
         services.AddTransient<IConfigureOptions<ResourceManagementOptions>, ResourceManagementOptionsConfiguration>();
 
-        services.AddScoped<INavigationProvider, ContentEditorsSamplesNavigationProvider>();
+        services.AddNavigationProvider<ContentEditorsSamplesNavigationProvider>();
     }
 }

Lombiq.ContentEditors.Tests.UI/Extensions/BasicAsyncEditorTestingUITestContextExtensions.cs

@@ -1,6 +1,8 @@
+using Atata;
 using Lombiq.Tests.UI.Extensions;
 using Lombiq.Tests.UI.Services;
 using OpenQA.Selenium;
+using Shouldly;
 using System.Threading.Tasks;
 
 namespace Lombiq.ContentEditors.Tests.UI.Extensions;
@@ -12,7 +14,7 @@ public static Task EnableContentEditorsSamplesFeatureAsync(this UITestContext co
 
     public static async Task<UITestContext> TestDemoContentItemAsyncEditorAsync(this UITestContext context)
     {
-        await context.GoToRelativeUrlAsync("/Admin/ContentItemAsyncEditor/EmployeeAsyncEditorProvider/Employee");
+        await context.GoToAdminRelativeUrlAsync("/ContentItemAsyncEditor/EmployeeAsyncEditorProvider/Employee");
 
         context.Exists(By.XPath("//label[. = 'Name']"));
         context.Exists(By.XPath("//*[contains(@class, 'asyncEditor__groupLink') and contains(., 'Personal Details')]"));
@@ -24,9 +26,11 @@ public static async Task<UITestContext> TestDemoContentItemAsyncEditorAsync(this
         await context.FillInWithRetriesAsync(By.Id("AsyncEditorEmployeePart_Position_Text"), "CEO");
         await context.FillInWithRetriesAsync(By.Id("AsyncEditorEmployeePart_Office_Text"), "Budapest");
         await context.ClickReliablyOnAsync(By.ClassName("asyncEditor__submitAction"));
-        context.Exists(
-            By.XPath(
-                "//*[contains(@class, 'asyncEditor__message') and contains(., 'Editor has been successfully submitted.')]"));
+
+        context.Exists(By.ClassName("asyncEditor__messages"));
+        var errorMessage = context.Get(By.ClassName("asyncEditor__error").Safely());
+        errorMessage?.Text?.ShouldBeNullOrWhiteSpace(errorMessage.GetAttribute("data-error-json"));
+        context.Get(By.ClassName("asyncEditor__message")).Text.Trim().ShouldBe("Editor has been successfully submitted.");
 
         return context;
     }

Lombiq.ContentEditors.Tests.UI/Lombiq.ContentEditors.Tests.UI.csproj

@@ -21,7 +21,7 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(NuGetBuild)' == 'true'">
-    <PackageReference Include="Lombiq.Tests.UI" Version="10.0.1" />
+    <PackageReference Include="Lombiq.Tests.UI" Version="10.0.2-alpha.5.osoe-818" />
   </ItemGroup>
 
   <ItemGroup>

Lombiq.ContentEditors/Assets/Scripts/async-editor/async-editor.js

@@ -11,32 +11,42 @@ class AsyncEditorApiClient {
         this.contentType = parameters.contentType;
     }
 
+    async fetchEditor(callback, contentId, editorGroup, nextEditorGroup, requestOptions, raiseEvent) {
+        try {
+            const response = await fetch(this.createUrl(contentId, editorGroup, nextEditorGroup), requestOptions);
+            const data = await response.json();
+            const success = data.type !== 'Error';
+
+            callback(success, data);
+            if (!success) return;
+
+            if (raiseEvent) {
+                const submittedEditorEvent = new CustomEvent('asyncEditorSubmittedEditor', {
+                    bubbles: true,
+                    cancelable: true,
+                    detail: { asyncEditor: window.asyncEditor },
+                });
+                document.dispatchEvent(submittedEditorEvent);
+            }
+        }
+        catch (error) {
+            callback(false, error);
+        }
+    }
+
     loadEditor(contentId, editorGroup, callback) {
-        return fetch(this.createUrl(contentId, editorGroup))
-            .then((response) => response.json())
-            .then((data) => callback(true, data))
-            .catch((error) => callback(false, error));
+        return this.fetchEditor(callback, contentId, editorGroup);
     }
 
     submitEditor(contentId, editorGroup, nextEditorGroup, formData, callback) {
-        return fetch(this.createUrl(contentId, editorGroup, nextEditorGroup), {
+        const requestOptions = {
             method: 'post',
             headers: {
                 'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
             },
             body: new URLSearchParams(formData),
-        })
-            .then((response) => response.json())
-            .then((data) => callback(true, data))
-            .then(() => {
-                const submittedEditorEvent = new CustomEvent('asyncEditorSubmittedEditor', {
-                    bubbles: true,
-                    cancelable: true,
-                    detail: { asyncEditor: window.asyncEditor },
-                });
-                document.dispatchEvent(submittedEditorEvent);
-            })
-            .catch((error) => callback(false, error));
+        };
+        return this.fetchEditor(callback, contentId, editorGroup, nextEditorGroup, requestOptions, true);
     }
 
     createUrl(contentId, editorGroup, nextEditorGroup) {
@@ -67,6 +77,7 @@ window.asyncEditor.editor = {
             api: null,
             message: '',
             errorText: '',
+            errorJson: '',
             contentId: '',
             editorHtml: '',
             validationSummaryHtml: '',
@@ -166,6 +177,7 @@ window.asyncEditor.editor = {
                 if (shouldUpdateQuery) self.updateQuery();
             }
             else {
+                self.errorJson = JSON.stringify({ error: data, string: data.toString() });
                 self.errorText = self.defaultErrorText;
             }
         },

Lombiq.ContentEditors/Controllers/ContentItemAsyncEditorApiController.cs

@@ -1,9 +1,11 @@
 using Lombiq.ContentEditors.Constants;
 using Lombiq.ContentEditors.Models;
 using Lombiq.ContentEditors.Services;
+using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using OrchardCore.ContentManagement;
 using OrchardCore.Modules;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading.Tasks;
@@ -12,7 +14,7 @@ namespace Lombiq.ContentEditors.Controllers;
 
 [Feature(FeatureIds.AsyncEditor)]
 [Route(Routes.ContentItemAsyncEditorApi)]
-public class ContentItemAsyncEditorApiController : Controller
+public sealed class ContentItemAsyncEditorApiController : Controller
 {
     private readonly IEnumerable<IAsyncEditorProvider<ContentItem>> _providers;
     private readonly IContentManager _contentManager;
@@ -46,32 +48,42 @@ public async Task<ActionResult<RenderedAsyncEditorGroupRequest>> Get([FromQuery]
     [ValidateAntiForgeryToken]
     public async Task<ActionResult> Post([FromQuery] SubmitAsyncEditorRequest request)
     {
-        var provider = GetProvider(request.ProviderName);
-        if (provider == null) return NotFound();
+        try
+        {
+            var provider = GetProvider(request.ProviderName);
+            if (provider == null) return Fail($"Couldn't get the provider \"{request.ProviderName}\".");
 
-        var item = await _contentManager.GetOrCreateAsync(request.ContentId, request.ContentType, VersionOptions.Latest);
-        if (item == null) return NotFound();
+            var item = await _contentManager.GetOrCreateAsync(request.ContentId, request.ContentType, VersionOptions.Latest);
+            if (item == null) return Fail($"Couldn't find the content item \"{request.ContentId}\".");
 
-        var context = PopulateContext(request, item);
-        if (!await provider.CanRenderEditorGroupAsync(context)) return NotFound();
+            var context = PopulateContext(request, item);
+            if (!await provider.CanRenderEditorGroupAsync(context))
+            {
+                return Fail($"The editor group of provider \"{request.ProviderName}\" can't be rendered.");
+            }
 
-        var result = await provider.UpdateEditorAsync(context);
-        if (!result.ModelState.IsValid ||
-            string.IsNullOrEmpty(request.NextEditorGroup) ||
-            request.NextEditorGroup == request.EditorGroup)
-        {
+            var result = await provider.UpdateEditorAsync(context);
+            if (!result.ModelState.IsValid ||
+                string.IsNullOrEmpty(request.NextEditorGroup) ||
+                request.NextEditorGroup == request.EditorGroup)
+            {
+                return await AsyncEditorResultAsync(
+                    context,
+                    provider,
+                    renderedEditor: await result.RenderedEditorShapeFactory(),
+                    message: result.Message);
+            }
+
+            var nextEditorContext = PopulateContext(request, item, request.NextEditorGroup);
             return await AsyncEditorResultAsync(
-                context,
+                !await provider.CanRenderEditorGroupAsync(nextEditorContext) ? context : nextEditorContext,
                 provider,
-                renderedEditor: await result.RenderedEditorShapeFactory(),
                 message: result.Message);
         }
-
-        var nextEditorContext = PopulateContext(request, item, request.NextEditorGroup);
-        return await AsyncEditorResultAsync(
-            !await provider.CanRenderEditorGroupAsync(nextEditorContext) ? context : nextEditorContext,
-            provider,
-            message: result.Message);
+        catch (Exception exception)
+        {
+            return Fail(exception);
+        }
     }
 
     private IAsyncEditorProvider<ContentItem> GetProvider(string name) =>
@@ -116,4 +128,14 @@ private async Task<ViewResult> AsyncEditorResultAsync(
             Message = message,
         });
     }
+
+    /// <summary>
+    /// Provides serialized JSON information during local development, but ony a generic error message in production.
+    /// It's useful to always return JSON, regardless whether the request succeeded or failed.
+    /// </summary>
+    private JsonResult Fail(object data) => Json(new
+    {
+        Type = "Error",
+        Content = HttpContext.IsDevelopmentAndLocalhost() ? data : "Something went wrong.",
+    });
 }

Lombiq.ContentEditors/Controllers/ContentItemAsyncEditorController.cs

@@ -9,7 +9,7 @@ namespace Lombiq.ContentEditors.Controllers;
 [Feature(FeatureIds.AsyncEditor)]
 [Admin]
 [Route(Routes.ContentItemAsyncEditor)]
-public class ContentItemAsyncEditorController : Controller
+public sealed class ContentItemAsyncEditorController : Controller
 {
     [HttpGet("{providerName}/{contentType}/{contentItemId?}")]
     public ActionResult Index(string providerName, string contentType, string contentItemId)

Lombiq.ContentEditors/Lombiq.ContentEditors.csproj

@@ -25,13 +25,13 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="OrchardCore.Module.Targets" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.ContentFields" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.ContentManagement" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.ContentTypes.Abstractions" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.DisplayManagement" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.Media" Version="1.8.0" />
-    <PackageReference Include="OrchardCore.ResourceManagement" Version="1.8.0" />
+    <PackageReference Include="OrchardCore.Module.Targets" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.ContentFields" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.ContentManagement" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.ContentTypes.Abstractions" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.DisplayManagement" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.Media" Version="2.0.0" />
+    <PackageReference Include="OrchardCore.ResourceManagement" Version="2.0.0" />
   </ItemGroup>
 
   <ItemGroup>
@@ -47,7 +47,7 @@
   </ItemGroup>
 
   <ItemGroup Condition="'$(NuGetBuild)' == 'true'">
-    <PackageReference Include="Lombiq.HelpfulLibraries.OrchardCore" Version="10.0.0" />
+    <PackageReference Include="Lombiq.HelpfulLibraries.OrchardCore" Version="10.0.1-alpha.8.osoe-818" />
     <PackageReference Include="Lombiq.NodeJs.Extensions" Version="2.1.0" />
   </ItemGroup>
 

Lombiq.ContentEditors/Migrations/AsyncEditorMigrations.cs

@@ -6,7 +6,7 @@
 
 namespace Lombiq.ContentEditors.Migrations;
 
-public class AsyncEditorMigrations : DataMigration
+public sealed class AsyncEditorMigrations : DataMigration
 {
     public async Task<int> CreateAsync()
     {