OSOE-638: Feature to edit shell settings from the admin in Lombiq.Hosting.Tenants

Lombiq.Hosting.Tenants.Management.Tests.UI/Extensions/TestCaseUITestContextExtensions.cs

@@ -11,11 +11,34 @@ public static class TestCaseUITestContextExtensions
 {
     public static async Task TestShellSettingsEditorFeatureAsync(this UITestContext context)
     {
-        await context.SignInDirectlyAndGoToDashboardAsync();
+        await context.SignInDirectlyAsync();
         await context.GoToAdminRelativeUrlAsync("/Tenants/Edit/Default");
-        context.FillInMonacoEditor("Json_editor", "{\"TestKey:TestSubKey:TestSubOptions:Test\":\"TestValue\"}");
+
+        // Expected JSON string
+#pragma warning disable JSON002 // Probable JSON string detected
+        await context.FillInEditorThenCheckValueAsync(
+            "{\"TestKey\":{\"TestSubKey\":{\"TestSubOptions\":{\"Test\": \"TestValue\"}}}}",
+            "TestValue");
+#pragma warning restore JSON002 // Probable JSON string detected
+        await context.FillInEditorThenCheckValueAsync(
+            string.Empty,
+            expectedValue: null);
+    }
+
+    private static async Task FillInEditorThenCheckValueAsync(this UITestContext context, string text, string expectedValue)
+    {
+        context.FillInMonacoEditor("Json_editor", text);
         await context.ClickReliablyOnAsync(By.XPath("//button[contains(.,'Save settings')]"));
-        var editorValue = JObject.Parse(context.GetMonacoEditorText("Json_editor"));
-        editorValue.Value<string>("TestKey:TestSubKey:TestSubOptions:Test").ShouldBeAsString("TestValue");
+        var editorText = context.GetMonacoEditorText("Json_editor");
+
+        if (string.IsNullOrEmpty(text))
+        {
+            editorText.ShouldBeAsString(text);
+        }
+        else
+        {
+            var editorValue = JObject.Parse(context.GetMonacoEditorText("Json_editor"));
+            editorValue.SelectToken("TestKey.TestSubKey.TestSubOptions.Test")?.ToString().ShouldBeAsString(expectedValue);
+        }
     }
 }

Lombiq.Hosting.Tenants.Management/Controllers/ShellSettingsEditorController.cs

@@ -1,8 +1,9 @@
 using Lombiq.Hosting.Tenants.Management.Constants;
 using Lombiq.Hosting.Tenants.Management.Models;
+using Lombiq.Hosting.Tenants.Management.Service;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
-using Newtonsoft.Json;
+using Microsoft.Extensions.Configuration;
 using OrchardCore.Environment.Shell;
 using OrchardCore.Environment.Shell.Configuration;
 using OrchardCore.Locking.Distributed;
@@ -12,6 +13,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Text.Json;
 using System.Threading.Tasks;
 using static OrchardCore.Tenants.Permissions;
 
@@ -47,29 +49,56 @@ public async Task<IActionResult> Edit(ShellSettingsEditorViewModel model)
             return NotFound();
         }
 
-        var settingsDictionary = JsonConvert.DeserializeObject<Dictionary<string, string>>(model.Json);
-        var newSettings = new Dictionary<string, string>();
-
-        foreach (var key in settingsDictionary.Keys.Where(key => string.IsNullOrEmpty(settingsDictionary[key])))
+        model.Json ??= "{}";
+        if (!IsValidJson(model.Json))
         {
-            settingsDictionary[key] = null;
+            return RedirectToAction(
+                nameof(AdminController.Edit),
+                typeof(AdminController).ControllerName(),
+                new
+                {
+                    area = "OrchardCore.Tenants",
+                    id = model.TenantId,
+                });
         }
 
-        foreach (var key in settingsDictionary.Keys)
+        var settingsDictionary = new JsonConfigurationParser().ParseConfiguration(model.Json);
+        var newSettings = new Dictionary<string, string>();
+
+        var tenantSettingsPrefix = $"{model.TenantId}Prefix:";
+        var currentSettings = shellSettings.ShellConfiguration.AsEnumerable()
+            .Where(item => item.Value != null &&
+                item.Key.Contains(tenantSettingsPrefix))
+            .ToDictionary(key => key.Key.Replace(tenantSettingsPrefix, string.Empty), value => value.Value);
+
+        if (settingsDictionary?.Keys != null)
         {
-            if (shellSettings[key] != settingsDictionary[key])
+            foreach (var key in settingsDictionary.Keys)
             {
-                var tenantSettingsPrefix = $"{model.TenantId}Prefix:{key}";
-                newSettings[tenantSettingsPrefix] = settingsDictionary[key];
-                newSettings[key] = settingsDictionary[key];
+                var tenantSettingsPrefixWithKey = $"{tenantSettingsPrefix}{key}";
+                if (shellSettings[key] != settingsDictionary[key])
+                {
+                    newSettings[tenantSettingsPrefixWithKey] = settingsDictionary[key];
+                    newSettings[key] = settingsDictionary[key];
+                }
             }
         }
 
-        // Try to acquire a lock before using the scope, so that a next process gets the last committed data.
-        var (locker, locked) = await _distributedLock.TryAcquireLockAsync("SHELL_SETTINGS_EDITOR_LOCK", TimeSpan.MaxValue);
+        var deletableKeys = currentSettings
+            .Where(item => settingsDictionary == null || !settingsDictionary.ContainsKey(item.Key))
+            .Select(item => item.Key);
+
+        foreach (var key in deletableKeys)
+        {
+            var tenantSettingsPrefixWithKey = $"{tenantSettingsPrefix}{key}";
+            newSettings[key] = null;
+            newSettings[tenantSettingsPrefixWithKey] = null;
+        }
+
+        var (locker, locked) = await _distributedLock.TryAcquireLockAsync("SHELL_SETTINGS_EDITOR_LOCK", TimeSpan.FromSeconds(10));
         if (!locked)
         {
-            throw new TimeoutException($"Failed to acquire a lock before saving settings to the tenant: {model.TenantId}");
+            throw new TimeoutException($"Failed to acquire a lock before saving settings to the tenant: {model.TenantId}.");
         }
 
         await using var acquiredLock = locker;
@@ -86,4 +115,17 @@ public async Task<IActionResult> Edit(ShellSettingsEditorViewModel model)
                 id = model.TenantId,
             });
     }
+
+    private static bool IsValidJson(string json)
+    {
+        try
+        {
+            JsonDocument.Parse(json);
+            return true;
+        }
+        catch (JsonException)
+        {
+            return false;
+        }
+    }
 }

Lombiq.Hosting.Tenants.Management/Filters/ShellSettingsEditorFilter.cs

@@ -1,14 +1,12 @@
 using Lombiq.Hosting.Tenants.Management.Models;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
-using Microsoft.Extensions.Configuration;
-using Newtonsoft.Json;
 using OrchardCore.DisplayManagement;
 using OrchardCore.DisplayManagement.Layout;
 using OrchardCore.Environment.Shell;
+using OrchardCore.Environment.Shell.Configuration;
 using OrchardCore.Mvc.Core.Utilities;
 using OrchardCore.Tenants.Controllers;
-using System.Linq;
 using System.Threading.Tasks;
 
 namespace Lombiq.Hosting.Tenants.Management.Filters;
@@ -49,18 +47,15 @@ actionRouteValue is nameof(AdminController.Edit) &&
 
             var layout = await _layoutAccessor.GetLayoutAsync();
             var contentZone = layout.Zones["Content"];
-            var tenantSettingsPrefix = $"{tenantName}Prefix:";
-            var editableItems = shellSettings.ShellConfiguration.AsEnumerable()
-                .Where(item => item.Value != null &&
-                    item.Key.Contains(tenantSettingsPrefix))
-                .ToDictionary(key => key.Key.Replace(tenantSettingsPrefix, string.Empty), value => value.Value);
+            var tenantSettingsPrefix = $"{tenantName}Prefix";
+            var editableItems = shellSettings.ShellConfiguration.AsJsonNode();
 
             await contentZone.AddAsync(
                 await _shapeFactory.CreateAsync<ShellSettingsEditorViewModel>(
                     "ShellSettingsEditor",
                     viewModel =>
                     {
-                        viewModel.Json = JsonConvert.SerializeObject(editableItems);
+                        viewModel.Json = editableItems[tenantSettingsPrefix]?.ToJsonString();
                         viewModel.TenantId = tenantName;
                     }),
                 "10");

Lombiq.Hosting.Tenants.Management/Readme.md

@@ -4,7 +4,7 @@
 
 ## About
 
-With the help of this module, you can set restrictions on tenant creation.
+With the help of this module, you can set restrictions on tenant creation and set tenant level shell settings in the tenant editor.
 
 ## Documentation
 

Lombiq.Hosting.Tenants.Management/Service/JsonConfigurationParser.cs

@@ -0,0 +1,109 @@
+using Microsoft.Extensions.Configuration;
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using System.Text.Json;
+
+namespace Lombiq.Hosting.Tenants.Management.Service;
+
+public class JsonConfigurationParser
+{
+    private readonly Dictionary<string, string> Data = new(StringComparer.OrdinalIgnoreCase);
+    private readonly Stack<string> Paths = new();
+
+    public IDictionary<string, string> ParseConfiguration(string inputJson)
+    {
+        var jsonDocumentOptions = new JsonDocumentOptions
+        {
+            CommentHandling = JsonCommentHandling.Skip,
+            AllowTrailingCommas = true,
+        };
+
+        using var doc = JsonDocument.Parse(inputJson, jsonDocumentOptions);
+        if (doc.RootElement.ValueKind != JsonValueKind.Object)
+        {
+            throw new FormatException("Format Exception:" + doc.RootElement.ValueKind);
+        }
+
+        VisitObjectElement(doc.RootElement);
+
+        return Data;
+    }
+
+    private void VisitObjectElement(JsonElement element)
+    {
+        var isEmpty = true;
+
+        foreach (var property in element.EnumerateObject())
+        {
+            isEmpty = false;
+            EnterContext(property.Name);
+            VisitValue(property.Value);
+            ExitContext();
+        }
+
+        SetNullIfElementIsEmpty(isEmpty);
+    }
+
+    private void VisitArrayElement(JsonElement element)
+    {
+        int index = 0;
+
+        foreach (var arrayElement in element.EnumerateArray())
+        {
+            EnterContext(index.ToString(CultureInfo.InvariantCulture));
+            VisitValue(arrayElement);
+            ExitContext();
+            index++;
+        }
+
+        SetNullIfElementIsEmpty(isEmpty: index == 0);
+    }
+
+    private void SetNullIfElementIsEmpty(bool isEmpty)
+    {
+        if (isEmpty && Paths.Count > 0)
+        {
+            Data[Paths.Peek()] = null;
+        }
+    }
+
+    private void VisitValue(JsonElement value)
+    {
+        switch (value.ValueKind)
+        {
+            case JsonValueKind.Object:
+                VisitObjectElement(value);
+                break;
+
+            case JsonValueKind.Array:
+                VisitArrayElement(value);
+                break;
+
+            case JsonValueKind.Number:
+            case JsonValueKind.String:
+            case JsonValueKind.True:
+            case JsonValueKind.False:
+            case JsonValueKind.Null:
+                string key = Paths.Peek();
+                if (Data.ContainsKey(key))
+                {
+                    throw new FormatException("Key Is Duplicated:" + key);
+                }
+
+                Data[key] = value.ToString();
+                break;
+
+            case JsonValueKind.Undefined:
+            default:
+                throw new FormatException("Unsupported JSON Token:" + value.ValueKind);
+        }
+    }
+
+    private void EnterContext(string context) =>
+        Paths.Push(Paths.Count > 0 ?
+            Paths.Peek() + ConfigurationPath.KeyDelimiter + context :
+            context);
+
+    private void ExitContext() => Paths.Pop();
+}

Lombiq.Hosting.Tenants.Management/Views/ShellSettingsEditor.cshtml

@@ -14,7 +14,9 @@
     <div class="@Orchard.GetWrapperCssClasses("field-wrapper")" id="FieldWrapper">
         <label asp-for="Json" class="@Orchard.GetLabelCssClasses()">@T["Shell Settings editor"]</label>
         <div class="@Orchard.GetEndCssClasses()">
-            <span class="hint">@T["Key-value pairs should be set here. Save empty string value to delete setting."]</span>
+            <span class="hint">
+                @T["JSON key-value pairs should be set here, in the same way you'd configure the tenant-specific section in an appsettings.json file."]
+            </span>
             <div id="@Html.IdFor(model => model.Json)_editor" asp-for="Settings" style="min-height: 400px;" class="form-control"></div>
             <textarea asp-for="Json" hidden>@Html.Raw(Model.Json)</textarea>
         </div>