Merge pull request #776 from PHOENIXCONTACT/feature/launcher-config

Using ConfigManager in Launcher

Author: dbeuchler

docs/articles/launcher/Launcher.md

@@ -1,42 +1,51 @@
 # Launcher
 
-## Sorting
+## Configuration
 
-To sort your modules in the launcher, you can use the `SortIndex` property within the `appsettings.json`. This property allows you to define the order of modules by assigning them an index value. Modules with lower index values will appear before those with higher values.
+The launcher generates a config file named `Moryx.Launcher.LauncherConfig.json` in your configuration directory. This file contains settings for the launcher, including module sort-indices and external modules.
+
+### Sorting
+
+To sort your modules in the launcher, you can use the `ModuleSortIndices` property. This property allows you to define the order of modules by assigning them an index value. Modules with lower index values will appear before those with higher values.
 
 ````json
 {
-  "Shell": {
-    "SortIndex": {
-      "moduleA-route": 10,
-      "moduleB-route": 20,
-      "moduleC-route": 15
+  "ModuleSortIndices": [
+    {
+      "Route": "Orders",
+      "SortIndex": 1
+    },
+    {
+      "Route": "WorkerSupport",
+      "SortIndex": 10
+    },
+    {
+      "Route": "example",
+      "SortIndex": 100
     }
-  }
+  ]
 }
+
 ````
 
-## External Modules
+### External Modules
 
-To define external modules in the launcher configuration, you can use the `ExternalModules` property within the `appsettings.json`. This allows you to specify
+To define external modules in the launcher configuration, you can use the `ExternalModules` property. This allows you to specify
 modules that should be loaded from external sources rather than being bundled with your application.
 
 External modules are integrated with the `<embed>` tag; the external web-page must support being embedded in an iframe.
 
 ````json
 {
-  "Shell": {
-    "SortIndex": {
-      "example": 10
-    },
-    "ExternalModules": [
-      {
-        "Route": "example",
-        "Title": "Example",
-        "Url": "http://www.example.com",
-        "Icon": "globe"
-      }
-    ]
-  }
+  "ExternalModules": [
+    {
+      "Title": "Example",
+      "Url": "http://www.example.com",
+      "Icon": "globe",
+      "Description": "Example description of the external module.",
+      "Route": "example"
+    }
+  ]
 }
+
 ````

docs/migrations/v8_to_v10.md

@@ -44,6 +44,10 @@ With MORYX 10, several changes have been made to the data model to improve perfo
 - If you were using `ProductFileEntity`, consider using alternative storage solutions such as file systems or dedicated file storage services to manage product-related files.
 - The `ProductFile` was removed completely.
 
+## Launcher
+
+- The `SortIndex` configuration was moved to the `Moryx.Launcher.LauncherConfig.json` configuration file. Refer to the [Launcher](/docs/articles/launcher/Launcher.md) documentation for more information.
+
 ## Removal of Modules-Analytics
 
 The analytics module was doing nothing and the web module was replaced by supporting external modules in `Launcher`. Its now supported to embed external web-pages into the shell. Refer to the [Launcher](/docs/articles/launcher/Launcher.md) documentation for more information.

src/Moryx.Launcher/Config/ExternalModuleConfig.cs

@@ -1,7 +1,7 @@
 // Copyright (c) 2025, Phoenix Contact GmbH & Co. KG
 // Licensed under the Apache License, Version 2.0
 
-namespace Moryx.Launcher.Config;
+namespace Moryx.Launcher;
 
 /// <summary>
 /// Configuration for an external module

src/Moryx.Launcher/Config/LauncherConfig.cs

@@ -0,0 +1,26 @@
+// Copyright (c) 2025, Phoenix Contact GmbH & Co. KG
+// Licensed under the Apache License, Version 2.0
+
+using System.Runtime.Serialization;
+using Moryx.Configuration;
+
+namespace Moryx.Launcher;
+
+/// <summary>
+/// Configuration for the launcher
+/// </summary>
+[DataContract]
+public class LauncherConfig : ConfigBase
+{
+    /// <summary>
+    /// Sort indices for modules
+    /// </summary>
+    [DataMember]
+    public ModuleSortIndexConfig[] ModuleSortIndices { get; set; }
+
+    /// <summary>
+    /// Definition of external modules
+    /// </summary>
+    [DataMember]
+    public ExternalModuleConfig[] ExternalModules { get; set; }
+}

src/Moryx.Launcher/Config/ModuleSortIndexConfig.cs

@@ -0,0 +1,25 @@
+// Copyright (c) 2025, Phoenix Contact GmbH & Co. KG
+// Licensed under the Apache License, Version 2.0
+
+using System.Runtime.Serialization;
+
+namespace Moryx.Launcher;
+
+/// <summary>
+/// Configuration for module sort indices
+/// </summary>
+[DataContract]
+public class ModuleSortIndexConfig
+{
+    /// <summary>
+    /// Base route of the module
+    /// </summary>
+    [DataMember]
+    public string Route { get; set; }
+
+    /// <summary>
+    /// Target index of the module in the shell navigation
+    /// </summary>
+    [DataMember]
+    public int SortIndex { get; set; }
+}

src/Moryx.Launcher/Moryx.Launcher.csproj.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=config/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

src/Moryx.Launcher/Pages/External.cshtml

@@ -1,9 +1,9 @@
 @page "{*_}"
 @using Microsoft.AspNetCore.Authorization
 @using Microsoft.Extensions.Configuration
+@using Moryx.Configuration
 @using Moryx.Launcher
-@using Moryx.Launcher.Config
-@inject IConfiguration _configuration
+@inject IConfigManager _configManager
 @{
     ViewData["Title"] = "External";
     ViewData["BaseRef"] = "external";
@@ -18,8 +18,7 @@
     if (routeValues.Count > 1)
         externalRouteName = routeValues["_"]?.ToString();
 
-    var externalModuleConfigs = _configuration.GetSection("Shell:ExternalModules").Get<ExternalModuleConfig[]>();
-
+    var externalModuleConfigs = _configManager.GetConfiguration<LauncherConfig>().ExternalModules;
     var config = externalModuleConfigs.FirstOrDefault(c => c.Route.Equals(externalRouteName));
 
     if (config != null)

src/Moryx.Launcher/ShellNavigator.cs

@@ -7,38 +7,36 @@
 using Microsoft.AspNetCore.Mvc.RazorPages.Infrastructure;
 using Microsoft.AspNetCore.Routing;
 using Microsoft.Extensions.Caching.Memory;
-using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Moryx.Asp.Integration;
+using Moryx.Configuration;
 using Moryx.Identity;
-using Moryx.Launcher.Config;
 using Moryx.Tools;
 
 namespace Moryx.Launcher
 {
     /// <inheritdoc />
     public class ShellNavigator : IShellNavigator
     {
-        private readonly IConfiguration _configuration;
         private readonly ILogger _logger;
         private readonly MoryxAccessManagementClient _client;
         private readonly IReadOnlyList<ExternalModuleItem> _externalModules;
+        private readonly LauncherConfig _launcherConfig;
 
-        public EndpointDataSource EndpointsDataSource { get; }
-        public PageLoader PageLoader { get; }
+        private readonly EndpointDataSource _endpointsDataSource;
+        private readonly PageLoader _pageLoader;
 
         public ShellNavigator(
             EndpointDataSource endpointsDataSource,
             PageLoader pageLoader,
-            IConfiguration configuration,
+            IConfigManager configManager,
             IOptionsMonitor<MoryxIdentityOptions> options,
             IMemoryCache memoryCache,
             ILoggerFactory logger)
         {
-            EndpointsDataSource = endpointsDataSource;
-            PageLoader = pageLoader;
-            _configuration = configuration;
+            _endpointsDataSource = endpointsDataSource;
+            _pageLoader = pageLoader;
             _logger = logger.CreateLogger(nameof(ShellNavigator));
             if (options?.CurrentValue?.BaseAddress is not null)
             {
@@ -49,18 +47,19 @@ public ShellNavigator(
                 );
             }
 
+            _launcherConfig = GetConfiguration(configManager);
             _externalModules = LoadExternalModules();
         }
 
         /// <inheritdoc />
         public async Task<IReadOnlyList<ModuleItem>> GetModuleItems(HttpContext context)
         {
             // Filter pages
-            var pageActionDescriptors = EndpointsDataSource.Endpoints.SelectMany(endpoint => endpoint.Metadata)
+            var pageActionDescriptors = _endpointsDataSource.Endpoints.SelectMany(endpoint => endpoint.Metadata)
                 .OfType<PageActionDescriptor>()
                 .Where(pad => !pad.ViewEnginePath.Contains("Index"));
             // Retrieve all Metadata
-            var compiledPageActionDescriptors = await Task.WhenAll(pageActionDescriptors.Select(async pad => await PageLoader.LoadAsync(pad, EndpointMetadataCollection.Empty)));
+            var compiledPageActionDescriptors = await Task.WhenAll(pageActionDescriptors.Select(async pad => await _pageLoader.LoadAsync(pad, EndpointMetadataCollection.Empty)));
 
             // Filter permission
             if (context is not null && _client is not null)
@@ -87,16 +86,22 @@ public async Task<IReadOnlyList<ModuleItem>> GetModuleItems(HttpContext context)
             foreach (var module in modules.OrderBy(m => m.Title))
             {
                 var route = module is ExternalModuleItem ? module.Route.Replace("external/", "") : module.Route;
-                var sortIndex = _configuration[$"Shell:SortIndex:{route}"];
-                module.SortIndex = int.TryParse(sortIndex, out var customIndex) ? customIndex : index++;
+                var indexConfig = _launcherConfig.ModuleSortIndices.FirstOrDefault(m => m.Route == route);
+                if (indexConfig != null)
+                {
+                    module.SortIndex = indexConfig.SortIndex;
+                    continue;
+                }
+
+                module.SortIndex = index++;
             }
 
             return modules;
         }
 
         private ExternalModuleItem[] LoadExternalModules()
         {
-            var externalModuleConfigs = _configuration.GetSection("Shell:ExternalModules").Get<ExternalModuleConfig[]>();
+            var externalModuleConfigs = _launcherConfig.ExternalModules;
             return externalModuleConfigs?.Select(CreateExternalModuleItem).ToArray() ?? [];
         }
 
@@ -127,8 +132,22 @@ private static WebModuleItem CreateWebModuleItem(CompiledPageActionDescriptor pa
                 Icon = webModuleAttribute.Icon,
                 Description = pageActionDescriptor.PageTypeInfo.GetDescription() ?? "",
                 Category = webModuleAttribute.Category,
-                EventStream = streamAttribute?.EventStreamUrl ?? null
+                EventStream = streamAttribute?.EventStreamUrl
             };
         }
+
+        private LauncherConfig GetConfiguration(IConfigManager configManager)
+        {
+            var launcherConfig = configManager.GetConfiguration<LauncherConfig>();
+
+            // If configuration is generated, save it back to persist defaults
+            if (launcherConfig.ConfigState == ConfigState.Generated)
+            {
+                launcherConfig.ConfigState = ConfigState.Valid;
+                configManager.SaveConfiguration(_launcherConfig);
+            }
+
+            return launcherConfig;
+        }
     }
 }

src/StartProject.Asp/Config/Moryx.Launcher.LauncherConfig.json

@@ -0,0 +1,26 @@
+{
+  "ModuleSortIndices": [
+    {
+      "Route": "Orders",
+      "SortIndex": 1
+    },
+    {
+      "Route": "WorkerSupport",
+      "SortIndex": 10
+    },
+    {
+      "Route": "example",
+      "SortIndex": 100
+    }
+  ],
+  "ExternalModules": [
+    {
+      "Title": "Example",
+      "Url": "http://www.example.com",
+      "Icon": "globe",
+      "Description": "Example description of the external module.",
+      "Route": "example"
+    }
+  ],
+  "ConfigState": "Valid"
+}

src/StartProject.Asp/Properties/launchSettings.json

@@ -10,4 +10,4 @@
       }
     }
   }
-}
+}