VCST-2990: Add developer tools (#2905)

Co-authored-by: Artem Dudarev <artem@virtoworks.com>
Co-authored-by: Maria Volkova <106367190+Maria-Volkova-Tula@users.noreply.github.com>

Author: 3 people

src/VirtoCommerce.Platform.Core/DeveloperTools/DeveloperToolDescriptor.cs

@@ -0,0 +1,10 @@
+namespace VirtoCommerce.Platform.Core.DeveloperTools;
+
+public class DeveloperToolDescriptor
+{
+    public string Name { get; set; }
+    public string Url { get; set; }
+    public bool IsExternal { get; set; }
+    public int SortOrder { get; set; }
+    public string Permission { get; set; }
+}

src/VirtoCommerce.Platform.Core/DeveloperTools/IDeveloperToolsRegistrar.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+using System.Security.Claims;
+
+namespace VirtoCommerce.Platform.Core.DeveloperTools;
+
+public interface IDeveloperToolRegistrar
+{
+    void RegisterDeveloperTool(DeveloperToolDescriptor tool);
+    IList<DeveloperToolDescriptor> GetRegisteredTools(ClaimsPrincipal claimsPrincipal);
+}

src/VirtoCommerce.Platform.Core/PlatformConstants.cs

@@ -63,6 +63,8 @@ public static class Permissions
                 public const string SettingAccess = "platform:setting:access";
                 public const string SettingUpdate = "platform:setting:update";
 
+                public const string DeveloperToolsAccess = "platform:developer-tools:access";
+
                 public const string DynamicPropertiesQuery = "platform:dynamic_properties:read";
                 public const string DynamicPropertiesCreate = "platform:dynamic_properties:create";
                 public const string DynamicPropertiesAccess = "platform:dynamic_properties:access";
@@ -96,6 +98,7 @@ public static class Permissions
                     AssetAccess, AssetDelete, AssetUpdate, AssetCreate, AssetRead,
                     ModuleQuery, ModuleAccess, ModuleManage,
                     SettingQuery, SettingAccess, SettingUpdate,
+                    DeveloperToolsAccess,
                     DynamicPropertiesQuery, DynamicPropertiesCreate, DynamicPropertiesAccess, DynamicPropertiesUpdate, DynamicPropertiesDelete,
                     SecurityQuery, SecurityCreate, SecurityAccess, SecurityUpdate, SecurityDelete,
                     SecurityLoginOnBehalf, SecurityVerifyEmail, SecurityConfirmEmail, SecurityGenerateToken, SecurityVerifyToken,

src/VirtoCommerce.Platform.Data/DeveloperTools/DeveloperToolRegistrar.cs

@@ -0,0 +1,33 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Security.Claims;
+using VirtoCommerce.Platform.Core;
+using VirtoCommerce.Platform.Core.DeveloperTools;
+using static VirtoCommerce.Platform.Core.PlatformConstants.Security.Claims;
+
+namespace VirtoCommerce.Platform.Data.DeveloperTools;
+
+public class DeveloperToolRegistrar : IDeveloperToolRegistrar
+{
+    private readonly List<DeveloperToolDescriptor> _tools = [];
+
+    public void RegisterDeveloperTool(DeveloperToolDescriptor tool)
+    {
+        ArgumentNullException.ThrowIfNull(tool);
+        _tools.Add(tool);
+    }
+
+    public IList<DeveloperToolDescriptor> GetRegisteredTools(ClaimsPrincipal claimsPrincipal)
+    {
+        var isAdmin = claimsPrincipal != null && claimsPrincipal.IsInRole(PlatformConstants.Security.SystemRoles.Administrator);
+
+        return _tools
+            .Where(x =>
+                isAdmin ||
+                string.IsNullOrEmpty(x.Permission) ||
+                claimsPrincipal != null && claimsPrincipal.HasClaim(PermissionClaimType, x.Permission))
+            .OrderBy(x => x.SortOrder)
+            .ToList();
+    }
+}

src/VirtoCommerce.Platform.Hangfire/Extensions/ApplicationBuilderExtensions.cs

@@ -8,8 +8,11 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Options;
+using VirtoCommerce.Platform.Core;
+using VirtoCommerce.Platform.Core.DeveloperTools;
 using VirtoCommerce.Platform.Core.Events;
 using VirtoCommerce.Platform.Core.Security;
+using VirtoCommerce.Platform.Core.Settings;
 using VirtoCommerce.Platform.Core.Settings.Events;
 using VirtoCommerce.Platform.Hangfire.Middleware;
 
@@ -67,6 +70,15 @@ public static IApplicationBuilder UseHangfire(this IApplicationBuilder appBuilde
             var userNameResolver = appBuilder.ApplicationServices.CreateScope().ServiceProvider.GetRequiredService<IUserNameResolver>();
             GlobalJobFilters.Filters.Add(new HangfireUserContextMiddleware(userNameResolver));
 
+            var toolRegistrar = appBuilder.ApplicationServices.GetService<IDeveloperToolRegistrar>();
+            toolRegistrar.RegisterDeveloperTool(new DeveloperToolDescriptor
+            {
+                Name = "Hangfire",
+                Url = "/hangfire",
+                SortOrder = 20,
+                Permission = PlatformConstants.Security.Permissions.BackgroundJobsManage,
+            });
+
             return appBuilder;
         }
     }

src/VirtoCommerce.Platform.Web/Controllers/Api/DeveloperToolsController.cs

@@ -0,0 +1,18 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using VirtoCommerce.Platform.Core.DeveloperTools;
+using Permissions = VirtoCommerce.Platform.Core.PlatformConstants.Security.Permissions;
+
+namespace VirtoCommerce.Platform.Web.Controllers.Api;
+
+[Authorize]
+[Route("/api/platform/developer-tools")]
+public class DeveloperToolsController(IDeveloperToolRegistrar developerToolRegistrar) : Controller
+{
+    [HttpGet]
+    [Authorize(Permissions.DeveloperToolsAccess)]
+    public ActionResult<DeveloperToolDescriptor[]> GetDeveloperTools()
+    {
+        return Ok(developerToolRegistrar.GetRegisteredTools(User));
+    }
+}

src/VirtoCommerce.Platform.Web/Startup.cs

@@ -36,6 +36,7 @@
 using Serilog;
 using VirtoCommerce.Platform.Core;
 using VirtoCommerce.Platform.Core.Common;
+using VirtoCommerce.Platform.Core.DeveloperTools;
 using VirtoCommerce.Platform.Core.DynamicProperties;
 using VirtoCommerce.Platform.Core.JsonConverters;
 using VirtoCommerce.Platform.Core.Localizations;
@@ -44,6 +45,7 @@
 using VirtoCommerce.Platform.Core.Security;
 using VirtoCommerce.Platform.Core.Security.ExternalSignIn;
 using VirtoCommerce.Platform.Core.Settings;
+using VirtoCommerce.Platform.Data.DeveloperTools;
 using VirtoCommerce.Platform.Data.Extensions;
 using VirtoCommerce.Platform.Data.MySql;
 using VirtoCommerce.Platform.Data.MySql.Extensions;
@@ -79,7 +81,6 @@
 using JsonSerializer = Newtonsoft.Json.JsonSerializer;
 using MsTokens = Microsoft.IdentityModel.Tokens;
 
-
 namespace VirtoCommerce.Platform.Web
 {
     public class Startup
@@ -485,6 +486,8 @@ public void ConfigureServices(IServiceCollection services)
             //Platform authorization handler for policies based on permissions
             services.AddSingleton<IAuthorizationHandler, DefaultPermissionAuthorizationHandler>();
 
+            services.AddSingleton<IDeveloperToolRegistrar, DeveloperToolRegistrar>();
+
             services.AddTransient<IExternalSignInService, ExternalSignInService>();
             services.AddTransient<IExternalSigninService, ExternalSignInService>();
 
@@ -699,6 +702,14 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILogger<
 
             app.UseEndpoints(SetupEndpoints);
 
+            var toolRegistrar = app.ApplicationServices.GetService<IDeveloperToolRegistrar>();
+            toolRegistrar.RegisterDeveloperTool(new DeveloperToolDescriptor
+            {
+                Name = "Health",
+                Url = "/health",
+                SortOrder = 10,
+            });
+
             // Enable middleware to serve generated Swagger as a JSON endpoint.
             app.UseSwagger();
 

src/VirtoCommerce.Platform.Web/Swagger/SwaggerServiceCollectionExtensions.cs

@@ -14,6 +14,7 @@
 using Swashbuckle.AspNetCore.SwaggerGen;
 using Swashbuckle.AspNetCore.SwaggerUI;
 using VirtoCommerce.Platform.Core.Common;
+using VirtoCommerce.Platform.Core.DeveloperTools;
 using VirtoCommerce.Platform.Core.Modularity;
 using VirtoCommerce.Platform.Core.Swagger;
 
@@ -194,6 +195,14 @@ public static void UseSwagger(this IApplicationBuilder applicationBuilder)
                 c.DocExpansion(DocExpansion.None);
                 c.DefaultModelsExpandDepth(-1);
             });
+
+            var toolRegistrar = applicationBuilder.ApplicationServices.GetService<IDeveloperToolRegistrar>();
+            toolRegistrar.RegisterDeveloperTool(new()
+            {
+                Name = "Swagger",
+                Url = "/docs/index.html",
+                SortOrder = 30,
+            });
         }
 
 

src/VirtoCommerce.Platform.Web/appsettings.json

@@ -218,7 +218,7 @@
     // X-Frame-Options header configuration. Allowed values: Deny - default, SameOrigin, or custom uri.
     "FrameOptions": "Deny",
     // FrameAncestors configuration in Content-Security-Header header. Allowed values: None - default, Self, or custom uri.
-    "FrameAncestors": "None"
+    "FrameAncestors": "Self"
   },
   "AzureAd": {
     "Enabled": false,

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/de.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "Benutzerprofil",
       "assets": "Ressourcen",
       "toggle-favorites": "Umschalt + Leertaste zum Umschalten der Favoriten",
+      "developer-tools": "Entwicklerwerkzeuge",
       "help": "Hilfe"
     },
     "navigation": {
       "back": "Zurück"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Entwicklerwerkzeuge"
+      },
       "system-info": {
         "title": "Plattforminformationen",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/en.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "User profile",
       "assets": "Assets",
       "toggle-favorites": "Shift + Space to toggle favorites",
+      "developer-tools": "Developer tools",
       "help": "Help"
     },
     "navigation": {
       "back": "Back"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Developer tools"
+      },
       "system-info": {
         "title": "Platform information",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/es.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "Perfil de usuario",
       "assets": "Recursos",
       "toggle-favorites": "Shift + Espacio para alternar favoritos",
+      "developer-tools": "Herramientas para desarrolladores",
       "help": "Ayuda"
     },
     "navigation": {
       "back": "Atrás"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Herramientas para desarrolladores"
+      },
       "system-info": {
         "title": "Información de la plataforma",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/fr.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "Profil utilisateur",
       "assets": "Ressources",
       "toggle-favorites": "Maj + Espace pour basculer les favoris",
+      "developer-tools": "Outils développeur",
       "help": "Aide"
     },
     "navigation": {
       "back": "Retour"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Outils développeur"
+      },
       "system-info": {
         "title": "Informations sur la plateforme",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/it.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "Profilo utente",
       "assets": "Risorse",
       "toggle-favorites": "Shift + Spazio per attivare/disattivare i preferiti",
+      "developer-tools": "Strumenti per sviluppatori",
       "help": "Aiuto"
     },
     "navigation": {
       "back": "Indietro"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Strumenti per sviluppatori"
+      },
       "system-info": {
         "title": "Informazioni sulla piattaforma",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/ja.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "ユーザープロフィール",
       "assets": "リソース",
       "toggle-favorites": "Shift + スペースでお気に入りを切り替え",
+      "developer-tools": "開発者ツール",
       "help": "ヘルプ"
     },
     "navigation": {
       "back": "戻る"
     },
     "blades": {
+      "developer-tools": {
+        "title": "開発者ツール"
+      },
       "system-info": {
         "title": "プラットフォーム情報",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/pl.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "Profil użytkownika",
       "assets": "Zasoby",
       "toggle-favorites": "Shift + Spacja, aby przełączyć ulubione",
+      "developer-tools": "Narzędzia deweloperskie",      
       "help": "Pomoc"
     },
     "navigation": {
       "back": "Wstecz"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Narzędzia deweloperskie"
+      },
       "system-info": {
         "title": "Informacje o platformie",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/pt.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "Perfil do usuário",
       "assets": "Recursos",
       "toggle-favorites": "Shift + Espaço para alternar favoritos",
+      "developer-tools": "Ferramentas de desenvolvedor",      
       "help": "Ajuda"
     },
     "navigation": {
       "back": "Voltar"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Ferramentas de desenvolvedor"
+      },      
       "system-info": {
         "title": "Informações da plataforma",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/ru.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "Профиль пользователя",
       "assets": "Ресурсы",
       "toggle-favorites": "Shift + Пробел для переключения избранного",
+      "developer-tools": "Инструменты разработчика",      
       "help": "Помощь"
     },
     "navigation": {
       "back": "Назад"
     },
     "blades": {
+      "developer-tools": {
+        "title": "Инструменты разработчика"
+      },      
       "system-info": {
         "title": "Информация о платформе",
         "labels": {

src/VirtoCommerce.Platform.Web/wwwroot/Localizations/zh.VirtoCommerce.Platform.json

@@ -14,12 +14,16 @@
       "user-profile": "用户资料",
       "assets": "资源",
       "toggle-favorites": "按 Shift + 空格键切换收藏夹",
+      "developer-tools": "开发者工具",      
       "help": "帮助"
     },
     "navigation": {
       "back": "返回"
     },
     "blades": {
+      "developer-tools": {
+        "title": "开发者工具"
+      },      
       "system-info": {
         "title": "平台信息",
         "labels": {