Merge branch 'dev' into fix/VCST-2300

basilkot · web-flow · commit 279282334102 · 2024-12-18T19:37:51.000+01:00
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -9,7 +9,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <VersionPrefix>3.871.0</VersionPrefix>
+    <VersionPrefix>3.873.0</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <VersionSuffix Condition=" '$(VersionSuffix)' != '' AND '$(BuildNumber)' != '' ">$(VersionSuffix)-$(BuildNumber)</VersionSuffix>
     <NoWarn>$(NoWarn);S3875;S4457</NoWarn>
diff --git a/src/VirtoCommerce.Platform.Web/Controllers/Api/ModulesController.cs b/src/VirtoCommerce.Platform.Web/Controllers/Api/ModulesController.cs
@@ -208,66 +208,97 @@ public async Task<ActionResult<ModuleDescriptor>> UploadModuleArchive()
                 return BadRequest($"Expected a multipart request, but got {Request.ContentType}");
             }
 
-            var uploadPath = Path.GetFullPath(_platformOptions.LocalUploadFolderPath);
-            if (!Directory.Exists(uploadPath))
+            var targetFilePath = await UploadFile(Request, Path.GetFullPath(_platformOptions.LocalUploadFolderPath));
+            if (targetFilePath is null)
             {
-                Directory.CreateDirectory(uploadPath);
+                return BadRequest("Cannot read file");
             }
 
-            ModuleDescriptor result = null;
-            string targetFilePath = null;
-            var boundary = MultipartRequestHelper.GetBoundary(MediaTypeHeaderValue.Parse(Request.ContentType), _defaultFormOptions.MultipartBoundaryLengthLimit);
-            var reader = new MultipartReader(boundary, HttpContext.Request.Body);
+            var manifest = await LoadModuleManifestFromZipArchive(targetFilePath);
+            if (manifest is null)
+            {
+                return BadRequest("Cannot read module manifest");
+            }
+
+            var module = AbstractTypeFactory<ManifestModuleInfo>.TryCreateInstance();
+            module.LoadFromManifest(manifest);
+            var existingModule = _externalModuleCatalog.Modules.OfType<ManifestModuleInfo>().FirstOrDefault(x => x.Equals(module));
+
+            if (existingModule != null)
+            {
+                module = existingModule;
+            }
+            else
+            {
+                //Force dependency validation for new module
+                _externalModuleCatalog.CompleteListWithDependencies([module]).ToList().Clear();
+                _externalModuleCatalog.AddModule(module);
+            }
+
+            module.Ref = targetFilePath;
+            var result = new ModuleDescriptor(module);
+
+            return Ok(result);
+        }
+
+        private static async Task<string> UploadFile(HttpRequest request, string uploadFolderPath)
+        {
+            var boundary = MultipartRequestHelper.GetBoundary(MediaTypeHeaderValue.Parse(request.ContentType), _defaultFormOptions.MultipartBoundaryLengthLimit);
+            var reader = new MultipartReader(boundary, request.Body);
             var section = await reader.ReadNextSectionAsync();
 
-            if (section != null)
+            if (section == null)
             {
-                var hasContentDispositionHeader = ContentDispositionHeaderValue.TryParse(section.ContentDisposition, out var contentDisposition);
+                return null;
+            }
 
-                if (hasContentDispositionHeader)
-                {
-                    if (MultipartRequestHelper.HasFileContentDisposition(contentDisposition))
-                    {
-                        var fileName = contentDisposition.FileName.Value;
-                        targetFilePath = Path.Combine(uploadPath, fileName);
+            if (!ContentDispositionHeaderValue.TryParse(section.ContentDisposition, out var contentDisposition) ||
+                !MultipartRequestHelper.HasFileContentDisposition(contentDisposition))
+            {
+                return null;
+            }
 
-                        using (var targetStream = System.IO.File.Create(targetFilePath))
-                        {
-                            await section.Body.CopyToAsync(targetStream);
-                        }
+            var fileName = Path.GetFileName(contentDisposition.FileName.Value);
+            if (string.IsNullOrEmpty(fileName))
+            {
+                return null;
+            }
 
-                    }
-                }
-                using (var packageStream = System.IO.File.Open(targetFilePath, FileMode.Open))
-                using (var package = new ZipArchive(packageStream, ZipArchiveMode.Read))
+            if (!Directory.Exists(uploadFolderPath))
+            {
+                Directory.CreateDirectory(uploadFolderPath);
+            }
+
+            var targetFilePath = Path.Combine(uploadFolderPath, fileName);
+
+            await using var targetStream = System.IO.File.Create(targetFilePath);
+            await section.Body.CopyToAsync(targetStream);
+
+            return targetFilePath;
+        }
+
+        private static async Task<ModuleManifest> LoadModuleManifestFromZipArchive(string path)
+        {
+            ModuleManifest manifest = null;
+
+            try
+            {
+                await using var packageStream = System.IO.File.Open(path, FileMode.Open);
+                using var package = new ZipArchive(packageStream, ZipArchiveMode.Read);
+
+                var entry = package.GetEntry("module.manifest");
+                if (entry != null)
                 {
-                    var entry = package.GetEntry("module.manifest");
-                    if (entry != null)
-                    {
-                        using (var manifestStream = entry.Open())
-                        {
-                            var manifest = ManifestReader.Read(manifestStream);
-                            var module = AbstractTypeFactory<ManifestModuleInfo>.TryCreateInstance();
-                            module.LoadFromManifest(manifest);
-                            var alreadyExistModule = _externalModuleCatalog.Modules.OfType<ManifestModuleInfo>().FirstOrDefault(x => x.Equals(module));
-                            if (alreadyExistModule != null)
-                            {
-                                module = alreadyExistModule;
-                            }
-                            else
-                            {
-                                //Force dependency validation for new module
-                                _externalModuleCatalog.CompleteListWithDependencies(new[] { module }).ToList().Clear();
-                                _externalModuleCatalog.AddModule(module);
-                            }
-                            module.Ref = targetFilePath;
-                            result = new ModuleDescriptor(module);
-                        }
-                    }
+                    await using var manifestStream = entry.Open();
+                    manifest = ManifestReader.Read(manifestStream);
                 }
             }
+            catch
+            {
+                // Suppress any exceptions
+            }
 
-            return Ok(result);
+            return manifest;
         }
 
         /// <summary>
diff --git a/src/VirtoCommerce.Platform.Web/Extensions/ServiceCollectionExtensions.cs b/src/VirtoCommerce.Platform.Web/Extensions/ServiceCollectionExtensions.cs
@@ -40,7 +40,11 @@ public static IServiceCollection AddModules(this IServiceCollection services, IM
             // Ensure all modules are loaded
             ConsoleLog.BeginOperation("Registering API controllers");
 
-            var modules = moduleCatalog.Modules.OfType<ManifestModuleInfo>().Where(x => x.State == ModuleState.NotStarted).ToArray();
+            var notStartedModules = moduleCatalog.Modules.Where(x => x.State == ModuleState.NotStarted);
+            var modules = moduleCatalog.CompleteListWithDependencies(notStartedModules)
+                .OfType<ManifestModuleInfo>()
+                .ToArray();
+
             for (var i = 0; i < modules.Length; i++)
             {
                 var module = modules[i];
diff --git a/src/VirtoCommerce.Platform.Web/Swagger/CustomSwaggerGenerator.cs b/src/VirtoCommerce.Platform.Web/Swagger/CustomSwaggerGenerator.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Diagnostics;
 using System.Reflection;
+using System.Threading.Tasks;
 using Microsoft.AspNetCore.Mvc.ApiExplorer;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.Swagger;
@@ -12,7 +13,7 @@ namespace VirtoCommerce.Platform.Web.Swagger
     /// <summary>
     /// Generate swagger schema ids for schema refs depending on document name
     /// </summary>
-    public class CustomSwaggerGenerator : ISwaggerProvider
+    public class CustomSwaggerGenerator : IAsyncSwaggerProvider
     {
         private readonly SwaggerGenerator _swaggerGenerator;
         private readonly SchemaGeneratorOptions _schemaGeneratorOptions;
@@ -30,10 +31,10 @@ public CustomSwaggerGenerator(SwaggerGeneratorOptions options, IApiDescriptionGr
             _swaggerGenerator = new SwaggerGenerator(options, apiDescriptionsProvider, schemaGenerator);
         }
 
-        public OpenApiDocument GetSwagger(string documentName, string host = null, string basePath = null)
+        public Task<OpenApiDocument> GetSwaggerAsync(string documentName, string host = null, string basePath = null)
         {
             SetSchemaIdSelector(documentName);
-            return _swaggerGenerator.GetSwagger(documentName, host, basePath);
+            return _swaggerGenerator.GetSwaggerAsync(documentName, host, basePath);
         }
 
         private void SetSchemaIdSelector(string documentName)
@@ -46,13 +47,13 @@ private void SetSchemaIdSelector(string documentName)
                     {
                         result = attribute.Id;
                     }
-                    else if (documentName == SwaggerServiceCollectionExtensions.platformUIDocName)
+                    else if (documentName == SwaggerServiceCollectionExtensions.PlatformUIDocName)
                     {
                         result = type.FullName;
                     }
                     else
                     {
-                        result = (string)_defaultSchemaIdSelectorMethodInfo.Invoke(_schemaGeneratorOptions, new object[] { type });
+                        result = (string)_defaultSchemaIdSelectorMethodInfo.Invoke(_schemaGeneratorOptions, [type]);
                     }
                     Trace.WriteLine($"SchemaIdSelector: {type.FullName} => {result}");
                     return result;
diff --git a/src/VirtoCommerce.Platform.Web/Swagger/SwaggerServiceCollectionExtensions.cs b/src/VirtoCommerce.Platform.Web/Swagger/SwaggerServiceCollectionExtensions.cs
@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using System.Reflection;
@@ -22,9 +21,8 @@ namespace VirtoCommerce.Platform.Web.Swagger
 {
     public static class SwaggerServiceCollectionExtensions
     {
-        public static string platformDocName { get; } = "VirtoCommerce.Platform";
-        public static string platformUIDocName { get; } = "PlatformUI";
-        private static string oauth2SchemeName = "oauth2";
+        public static string PlatformDocName => "VirtoCommerce.Platform";
+        public static string PlatformUIDocName => "PlatformUI";
 
         /// <summary>
         /// Register swagger documents generator
@@ -68,15 +66,15 @@ public static void AddSwagger(this IServiceCollection services, IConfiguration c
                     }
                 };
 
-                c.SwaggerDoc(platformDocName, platformInfo);
-                c.SwaggerDoc(platformUIDocName, platformInfo);
+                c.SwaggerDoc(PlatformDocName, platformInfo);
+                c.SwaggerDoc(PlatformUIDocName, platformInfo);
 
                 foreach (var module in modules)
                 {
                     c.SwaggerDoc(module.ModuleName, new OpenApiInfo { Title = $"{module.Id}", Version = "v1" });
                 }
 
-                c.TagActionsBy(api => api.GroupByModuleName(services));
+                c.TagActionsBy(api => [api.GetModuleName(provider)]);
                 c.IgnoreObsoleteActions();
                 c.DocumentFilter<ExcludeRedundantDepsFilter>();
                 // This temporary filter removes broken "application/*+json" content-type.
@@ -91,29 +89,24 @@ public static void AddSwagger(this IServiceCollection services, IConfiguration c
                 c.SchemaFilter<EnumSchemaFilter>();
                 c.SchemaFilter<SwaggerIgnoreFilter>();
                 c.MapType<object>(() => new OpenApiSchema { Type = "object" });
-                c.AddModulesXmlComments(services);
+                c.AddModulesXmlComments(provider);
                 c.CustomOperationIds(apiDesc =>
                     apiDesc.TryGetMethodInfo(out var methodInfo) ? $"{((ControllerActionDescriptor)apiDesc.ActionDescriptor).ControllerName}_{methodInfo.Name}" : null);
-                c.AddSecurityDefinition(oauth2SchemeName, new OpenApiSecurityScheme
+                c.AddSecurityDefinition("oauth2", new OpenApiSecurityScheme
                 {
                     Type = SecuritySchemeType.OAuth2,
                     Description = "OAuth2 Resource Owner Password Grant flow",
-                    Flows = new OpenApiOAuthFlows()
+                    Flows = new OpenApiOAuthFlows
                     {
-                        Password = new OpenApiOAuthFlow()
+                        Password = new OpenApiOAuthFlow
                         {
-                            TokenUrl = new Uri($"/connect/token", UriKind.Relative)
+                            TokenUrl = new Uri("/connect/token", UriKind.Relative)
                         }
                     },
                 });
 
-                c.DocInclusionPredicate((docName, apiDesc) =>
-                {
-                    return DocInclusionPredicateCustomStrategy(modules, docName, apiDesc);
-                });
-
+                c.DocInclusionPredicate((docName, apiDesc) => DocInclusionPredicateCustomStrategy(modules, docName, apiDesc));
                 c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
-
                 c.EnableAnnotations(enableAnnotationsForInheritance: true, enableAnnotationsForPolymorphism: true);
 
                 if (useAllOfToExtendReferenceSchemas)
@@ -124,26 +117,25 @@ public static void AddSwagger(this IServiceCollection services, IConfiguration c
 
             // Unfortunately, we can't use .CustomSchemaIds, because it changes schema ids for all documents (impossible to change ids depending on document name).
             // But we need this, because PlatformUI document should contain ref schema ids as type.FullName to avoid conflict with same type names in different modules.
-            // As a solution we use custom swagger generator that catches document name and generates schemaids depending on it
-            services.AddTransient<ISwaggerProvider, CustomSwaggerGenerator>();
+            // As a solution we use custom swagger generator that catches document name and generates schema ids depending on it.
+            services.AddTransient<IAsyncSwaggerProvider, CustomSwaggerGenerator>();
 
             //This is important line switches the SwaggerGenerator to use the Newtonsoft contract resolver that uses the globally registered PolymorphJsonContractResolver
             //to propagate up to the resulting OpenAPI schema the derived types instead of base domain types
             services.AddSwaggerGenNewtonsoftSupport();
-
         }
 
         private static bool DocInclusionPredicateCustomStrategy(ManifestModuleInfo[] modules, string docName, ApiDescription apiDesc)
         {
-            // It's an UI endpoint, return all to correctly build swagger UI page
-            if (docName.EqualsInvariant(platformUIDocName))
+            // It's a UI endpoint, return all to correctly build swagger UI page
+            if (docName.EqualsInvariant(PlatformUIDocName))
             {
                 return true;
             }
 
             // It's a platform endpoint.
             var currentAssembly = ((ControllerActionDescriptor)apiDesc.ActionDescriptor).ControllerTypeInfo.Assembly;
-            if (docName.EqualsInvariant(platformDocName) && currentAssembly.FullName.StartsWith(docName))
+            if (docName.EqualsInvariant(PlatformDocName) && currentAssembly.FullName?.StartsWith(docName) == true)
             {
                 return true;
             }
@@ -168,7 +160,7 @@ public static void UseSwagger(this IApplicationBuilder applicationBuilder)
             applicationBuilder.UseSwagger(c =>
             {
                 c.RouteTemplate = "docs/{documentName}/swagger.{json|yaml}";
-                c.PreSerializeFilters.Add((swagger, httpReq) =>
+                c.PreSerializeFilters.Add((_, _) =>
                 {
                 });
 
@@ -180,8 +172,8 @@ public static void UseSwagger(this IApplicationBuilder applicationBuilder)
             applicationBuilder.UseSwaggerUI(c =>
             {
                 // Json Format Support 
-                c.SwaggerEndpoint($"./{platformUIDocName}/swagger.json", platformUIDocName);
-                c.SwaggerEndpoint($"./{platformDocName}/swagger.json", platformDocName);
+                c.SwaggerEndpoint($"./{PlatformUIDocName}/swagger.json", PlatformUIDocName);
+                c.SwaggerEndpoint($"./{PlatformDocName}/swagger.json", PlatformDocName);
 
                 foreach (var moduleId in modules.OrderBy(m => m.Id).Select(m => m.Id))
                 {
@@ -205,17 +197,9 @@ public static void UseSwagger(this IApplicationBuilder applicationBuilder)
         }
 
 
-        /// <summary>
-        /// grouping by Module Names in the ApiDescription
-        /// with comparing Assemlies
-        /// </summary>
-        /// <param name="api"></param>
-        /// <param name="services"></param>
-        /// <returns></returns>
-        private static IList<string> GroupByModuleName(this ApiDescription api, IServiceCollection services)
+        private static string GetModuleName(this ApiDescription api, ServiceProvider serviceProvider)
         {
-            var providerSnapshot = services.BuildServiceProvider();
-            var moduleCatalog = providerSnapshot.GetRequiredService<ILocalModuleCatalog>();
+            var moduleCatalog = serviceProvider.GetRequiredService<ILocalModuleCatalog>();
 
             // ------
             // Lifted from ApiDescriptionExtensions
@@ -229,20 +213,17 @@ private static IList<string> GroupByModuleName(this ApiDescription api, IService
             // ------
 
             var moduleAssembly = actionDescriptor?.ControllerTypeInfo.Assembly ?? Assembly.GetExecutingAssembly();
-            var groupName = moduleCatalog.Modules.FirstOrDefault(m => m.ModuleInstance != null && m.Assembly == moduleAssembly);
+            var module = moduleCatalog.Modules.FirstOrDefault(m => m.ModuleInstance != null && m.Assembly == moduleAssembly);
 
-            return new List<string> { groupName != null ? groupName.ModuleName : "Platform" };
+            return module?.ModuleName ?? "Platform";
         }
 
         /// <summary>
         /// Add Comments/Descriptions from XML-files in the ApiDescription
         /// </summary>
-        /// <param name="options"></param>
-        /// <param name="services"></param>
-        private static void AddModulesXmlComments(this SwaggerGenOptions options, IServiceCollection services)
+        private static void AddModulesXmlComments(this SwaggerGenOptions options, ServiceProvider serviceProvider)
         {
-            var provider = services.BuildServiceProvider();
-            var localStorageModuleCatalogOptions = provider.GetService<IOptions<LocalStorageModuleCatalogOptions>>().Value;
+            var localStorageModuleCatalogOptions = serviceProvider.GetService<IOptions<LocalStorageModuleCatalogOptions>>().Value;
 
             var xmlCommentsDirectoryPaths = new[]
             {
diff --git a/src/VirtoCommerce.Platform.Web/VirtoCommerce.Platform.Web.csproj b/src/VirtoCommerce.Platform.Web/VirtoCommerce.Platform.Web.csproj

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Diagnostics;`
`3`	`3`	`using System.Reflection;`
	`4`	`+using System.Threading.Tasks;`
`4`	`5`	`using Microsoft.AspNetCore.Mvc.ApiExplorer;`
`5`	`6`	`using Microsoft.OpenApi.Models;`
`6`	`7`	`using Swashbuckle.AspNetCore.Swagger;`
`@@ -12,7 +13,7 @@ namespace VirtoCommerce.Platform.Web.Swagger`
`12`	`13`	`/// <summary>`
`13`	`14`	`/// Generate swagger schema ids for schema refs depending on document name`
`14`	`15`	`/// </summary>`
`15`		`- public class CustomSwaggerGenerator : ISwaggerProvider`
	`16`	`+ public class CustomSwaggerGenerator : IAsyncSwaggerProvider`
`16`	`17`	`{`
`17`	`18`	`private readonly SwaggerGenerator _swaggerGenerator;`
`18`	`19`	`private readonly SchemaGeneratorOptions _schemaGeneratorOptions;`
`@@ -30,10 +31,10 @@ public CustomSwaggerGenerator(SwaggerGeneratorOptions options, IApiDescriptionGr`
`30`	`31`	`_swaggerGenerator = new SwaggerGenerator(options, apiDescriptionsProvider, schemaGenerator);`
`31`	`32`	`}`
`32`	`33`
`33`		`- public OpenApiDocument GetSwagger(string documentName, string host = null, string basePath = null)`
	`34`	`+ public Task<OpenApiDocument> GetSwaggerAsync(string documentName, string host = null, string basePath = null)`
`34`	`35`	`{`
`35`	`36`	`SetSchemaIdSelector(documentName);`
`36`		`- return _swaggerGenerator.GetSwagger(documentName, host, basePath);`
	`37`	`+ return _swaggerGenerator.GetSwaggerAsync(documentName, host, basePath);`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`private void SetSchemaIdSelector(string documentName)`
`@@ -46,13 +47,13 @@ private void SetSchemaIdSelector(string documentName)`
`46`	`47`	`{`
`47`	`48`	`result = attribute.Id;`
`48`	`49`	`}`
`49`		`- else if (documentName == SwaggerServiceCollectionExtensions.platformUIDocName)`
	`50`	`+ else if (documentName == SwaggerServiceCollectionExtensions.PlatformUIDocName)`
`50`	`51`	`{`
`51`	`52`	`result = type.FullName;`
`52`	`53`	`}`
`53`	`54`	`else`
`54`	`55`	`{`
`55`		`- result = (string)_defaultSchemaIdSelectorMethodInfo.Invoke(_schemaGeneratorOptions, new object[] { type });`
	`56`	`+ result = (string)_defaultSchemaIdSelectorMethodInfo.Invoke(_schemaGeneratorOptions, [type]);`
`56`	`57`	`}`
`57`	`58`	`Trace.WriteLine($"SchemaIdSelector: {type.FullName} => {result}");`
`58`	`59`	`return result;`