PT-12422: Add spa routes to return correct http status (#650)

* Add spa routes to return correct http status * add two letters language support * fix code smell * feat: add support for JS RegExp patterns * Add content pages support for 200/404 * undo common controller * add workcontext * Fix naming * use workContextAccessor instead workContext --------- Co-authored-by: Artem Makarov <[email protected]> Co-authored-by: artem-dudarev <[email protected]>
VirtoCommerce · Jul 10, 2023 · 1748185 · 1748185
1 parent 4fc743a
commit 1748185
Show file tree

Hide file tree

Showing 8 changed files with 217 additions and 42 deletions.
diff --git a/VirtoCommerce.Storefront.Model/ISeoInfoService.cs b/VirtoCommerce.Storefront.Model/ISeoInfoService.cs
@@ -1,4 +1,5 @@
 using System.Threading.Tasks;
+using VirtoCommerce.Storefront.Model.StaticContent;
 using VirtoCommerce.Storefront.Model.Stores;
 
 namespace VirtoCommerce.Storefront.Model
@@ -8,5 +9,7 @@ public interface ISeoInfoService
         Task<SeoInfo[]> GetSeoInfosBySlug(string slug);
 
         Task<SeoInfo[]> GetBestMatchingSeoInfos(string slug, Store store, string currentCulture);
+
+        ContentItem GetContentItem(string slug, WorkContext context);
     }
 }
diff --git a/VirtoCommerce.Storefront.Model/ISpaRouteService.cs b/VirtoCommerce.Storefront.Model/ISpaRouteService.cs
@@ -0,0 +1,9 @@
+using System.Threading.Tasks;
+
+namespace VirtoCommerce.Storefront.Model
+{
+    public interface ISpaRouteService
+    {
+        Task<bool> IsSpaRoute(string route);
+    }
+}
diff --git a/VirtoCommerce.Storefront/Controllers/Api/ApiCommonController.cs b/VirtoCommerce.Storefront/Controllers/Api/ApiCommonController.cs
@@ -89,8 +89,8 @@ public async Task<SlugInfoResult> GetInfoBySlugAsync(string slug, [FromQuery] st
                     );
 
                     var page = pages.FirstOrDefault(x => x.Language.CultureName.EqualsInvariant(culture))
-                                            ?? pages.FirstOrDefault(x => x.Language.IsInvariant)
-                                            ?? pages.FirstOrDefault(x => x.AliasesUrls.Contains(pageUrl, StringComparer.OrdinalIgnoreCase));
+                               ?? pages.FirstOrDefault(x => x.Language.IsInvariant)
+                               ?? pages.FirstOrDefault(x => x.AliasesUrls.Contains(pageUrl, StringComparer.OrdinalIgnoreCase));
                     result.ContentItem = page;
 
                 }

diff --git a/VirtoCommerce.Storefront/Controllers/ErrorController.cs b/VirtoCommerce.Storefront/Controllers/ErrorController.cs
@@ -1,28 +1,70 @@
+using System.Linq;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
 using Microsoft.AspNetCore.Diagnostics;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using VirtoCommerce.Storefront.Infrastructure;
 using VirtoCommerce.Storefront.Model;
+using VirtoCommerce.Storefront.Model.Common;
 using VirtoCommerce.Storefront.Model.Common.Exceptions;
 
 namespace VirtoCommerce.Storefront.Controllers
 {
     [StorefrontRoute("error")]
-    public class ErrorController : Controller
+    public class ErrorController : StorefrontControllerBase
     {
-        private readonly IWorkContextAccessor _workContextAccessor;
-        public ErrorController(IWorkContextAccessor workContextAccessor)
+        private readonly ISeoInfoService _seoInfoService;
+        private readonly ISpaRouteService _spaRouteService;
+
+        public ErrorController(
+            IWorkContextAccessor workContextAccessor,
+            IStorefrontUrlBuilder urlBuilder,
+            ISeoInfoService seoInfoService,
+            ISpaRouteService spaRouteService)
+            : base(workContextAccessor, urlBuilder)
         {
-            _workContextAccessor = workContextAccessor;
+            _seoInfoService = seoInfoService;
+            _spaRouteService = spaRouteService;
         }
 
         [Route("{errCode}")]
-        public IActionResult Error(int? errCode)
+        public async Task<IActionResult> Error(int? errCode)
         {
             //Returns index page on 404 error when the store.IsSpa flag is activated 
-            if (errCode == StatusCodes.Status404NotFound && _workContextAccessor.WorkContext.CurrentStore.IsSpa)
+            if (errCode == StatusCodes.Status404NotFound && WorkContext.CurrentStore.IsSpa)
             {
-                Response.StatusCode = StatusCodes.Status200OK;
+                var path = TrimTwoLetterLangSegment(Request.HttpContext.Features.Get<IStatusCodeReExecuteFeature>()?.OriginalPath);
+                Response.StatusCode = StatusCodes.Status404NotFound;
+
+                if (path == "/")
+                {
+                    Response.StatusCode = StatusCodes.Status200OK;
+                    return View("index");
+                }
+
+                if (string.IsNullOrEmpty(path))
+                {
+                    return View("index");
+                }
+
+                var slug = path.Split('/').Last();
+                if (!string.IsNullOrEmpty(slug))
+                {
+                    var seoInfos = await _seoInfoService.GetBestMatchingSeoInfos(slug, WorkContext.CurrentStore, WorkContext.CurrentLanguage.CultureName);
+                    Response.StatusCode = seoInfos.Any() ? StatusCodes.Status200OK : StatusCodes.Status404NotFound;
+                }
+
+                if (Response.StatusCode == StatusCodes.Status404NotFound)
+                {
+                    Response.StatusCode = _seoInfoService.GetContentItem($"/{slug}", WorkContext) != null ? StatusCodes.Status200OK : StatusCodes.Status404NotFound;
+                }
+
+                if (Response.StatusCode == StatusCodes.Status404NotFound)
+                {
+                    Response.StatusCode = await _spaRouteService.IsSpaRoute(path) ? StatusCodes.Status200OK : StatusCodes.Status404NotFound;
+                }
+
                 return View("index");
             }
             var exceptionFeature = base.HttpContext.Features.Get<IExceptionHandlerFeature>();
@@ -43,5 +85,17 @@ public IActionResult AccessDenied()
             Response.StatusCode = StatusCodes.Status403Forbidden;
             return View("AccessDenied");
         }
+
+        private string TrimTwoLetterLangSegment(string path)
+        {
+            var language = WorkContext.CurrentStore.Languages.FirstOrDefault(x => Regex.IsMatch(path, @"^/\b" + x.TwoLetterLanguageName + @"\b/", RegexOptions.IgnoreCase));
+
+            if (language != null)
+            {
+                path = Regex.Replace(path, @"/\b" + language.TwoLetterLanguageName + @"\b/", "/", RegexOptions.IgnoreCase);
+            }
+
+            return path;
+        }
     }
 }
diff --git a/VirtoCommerce.Storefront/Domain/SeoInfoService.cs b/VirtoCommerce.Storefront/Domain/SeoInfoService.cs
@@ -0,0 +1,61 @@
+using System;
+using System.Linq;
+using System.Threading.Tasks;
+using VirtoCommerce.Storefront.AutoRestClients.CoreModuleApi;
+using VirtoCommerce.Storefront.Common;
+using VirtoCommerce.Storefront.Model;
+using VirtoCommerce.Storefront.Model.Common;
+using VirtoCommerce.Storefront.Model.StaticContent;
+using VirtoCommerce.Storefront.Model.Stores;
+
+namespace VirtoCommerce.Storefront.Domain
+{
+    public class SeoInfoService : ISeoInfoService
+    {
+        private readonly ICommerce _coreModuleApi;
+
+        public SeoInfoService(ICommerce coreModuleApi)
+        {
+            _coreModuleApi = coreModuleApi;
+        }
+
+        public async Task<SeoInfo[]> GetSeoInfosBySlug(string slug)
+        {
+            var result = (await _coreModuleApi.GetSeoInfoBySlugAsync(slug)).Select(x => x.ToSeoInfo()).ToArray();
+
+            return result;
+        }
+
+        public async Task<SeoInfo[]> GetBestMatchingSeoInfos(string slug, Store store, string currentCulture)
+        {
+            var result = (await _coreModuleApi.GetSeoInfoBySlugAsync(slug)).GetBestMatchingSeoInfos(store, currentCulture, slug).Select(x => x.ToSeoInfo()).ToArray();
+
+            return result;
+        }
+
+        public ContentItem GetContentItem(string slug, WorkContext context)
+        {
+            ContentItem result = null;
+            var pageUrl = slug == "__index__home__page__" ? "/" : $"/{slug}";
+            try
+            {
+                var pages = context.Pages.Where(p =>
+                    string.Equals(p.Url, pageUrl, StringComparison.OrdinalIgnoreCase)
+                    || string.Equals(p.Url, slug, StringComparison.OrdinalIgnoreCase)
+                );
+
+                var page = pages.FirstOrDefault(x => x.Language.CultureName.EqualsInvariant(context.CurrentLanguage.CultureName))
+                           ?? pages.FirstOrDefault(x => x.Language.IsInvariant)
+                           ?? pages.FirstOrDefault(x => x.AliasesUrls.Contains(pageUrl, StringComparer.OrdinalIgnoreCase));
+                result = page;
+
+            }
+            catch
+            {
+                //do nothing
+            }
+
+            return result;
+        }
+    }
+}
diff --git a/VirtoCommerce.Storefront/Domain/SeoInfoServise.cs b/VirtoCommerce.Storefront/Domain/SeoInfoServise.cs
diff --git a/VirtoCommerce.Storefront/Domain/SpaRouteService.cs b/VirtoCommerce.Storefront/Domain/SpaRouteService.cs
@@ -0,0 +1,79 @@
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text.RegularExpressions;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using VirtoCommerce.Storefront.Model;
+using VirtoCommerce.Storefront.Model.Caching;
+using VirtoCommerce.Storefront.Model.Common;
+using VirtoCommerce.Storefront.Model.Common.Caching;
+using VirtoCommerce.Storefront.Model.StaticContent;
+
+namespace VirtoCommerce.Storefront.Domain
+{
+    public class SpaRouteService : ISpaRouteService
+    {
+        private readonly IContentBlobProvider _contentBlobProvider;
+        private readonly IStorefrontMemoryCache _memoryCache;
+        private readonly IWorkContextAccessor _workContextAccessor;
+
+        public SpaRouteService(
+            IContentBlobProvider contentBlobProvider,
+            IStorefrontMemoryCache memoryCache,
+            IWorkContextAccessor workContextAccessor)
+        {
+            _contentBlobProvider = contentBlobProvider;
+            _memoryCache = memoryCache;
+            _workContextAccessor = workContextAccessor;
+        }
+
+        public virtual async Task<bool> IsSpaRoute(string route)
+        {
+            var workContext = _workContextAccessor.WorkContext;
+            var cacheKey = CacheKey.With(GetType(), nameof(IsSpaRoute), workContext.CurrentStore.Id, route);
+            var result = await _memoryCache.GetOrCreateExclusiveAsync(cacheKey, async (_) =>
+            {
+                var routes = await GetSpaRoutes();
+
+                var isSpaRoute = routes.Any(jsPattern =>
+                {
+                    // Input sample: jsPattern = "/^\\/account\\/profile\\/?$/i"
+                    // Only the char "i" can be an ending. The others chars are not used
+                    // when generating RegExp patterns in the `routes.json` file.
+                    var options = jsPattern.EndsWith("i") ? RegexOptions.IgnoreCase : RegexOptions.None;
+                    var pattern = Regex.Replace(jsPattern, @"^\/|\/i?$", string.Empty);
+
+                    return Regex.IsMatch(route, pattern, options);
+                });
+
+                return isSpaRoute;
+            });
+
+            return result;
+        }
+
+        protected virtual async Task<List<string>> GetSpaRoutes()
+        {
+            var workContext = _workContextAccessor.WorkContext;
+            var cacheKey = CacheKey.With(GetType(), nameof(GetSpaRoutes), workContext.CurrentStore.Id);
+            var routes = await _memoryCache.GetOrCreateExclusiveAsync(cacheKey, async (_) =>
+            {
+                var result = new List<string>();
+                var currentThemeName = !string.IsNullOrEmpty(workContext.CurrentStore.ThemeName) ? workContext.CurrentStore.ThemeName : "default";
+                var currentThemePath = Path.Combine("Themes", workContext.CurrentStore.Id, currentThemeName);
+                var currentThemeSettingPath = Path.Combine(currentThemePath, "config", "routes.json");
+
+                if (_contentBlobProvider.PathExists(currentThemeSettingPath))
+                {
+                    await using var stream = _contentBlobProvider.OpenRead(currentThemeSettingPath);
+                    result = JsonConvert.DeserializeObject<List<string>>(await stream.ReadToStringAsync());
+                }
+
+                return result;
+            });
+
+            return routes;
+        }
+    }
+}
diff --git a/VirtoCommerce.Storefront/Startup.cs b/VirtoCommerce.Storefront/Startup.cs
@@ -93,7 +93,8 @@ public void ConfigureServices(IServiceCollection services)
             services.AddSingleton<ICurrencyService, CurrencyService>();
             services.AddSingleton<ISlugRouteService, SlugRouteService>();
             services.AddSingleton<IMemberService, MemberService>();
-            services.AddSingleton<ISeoInfoService, SeoInfoServise>();
+            services.AddSingleton<ISeoInfoService, SeoInfoService>();
+            services.AddSingleton<ISpaRouteService, SpaRouteService>();
 
             services.AddSingleton<IStaticContentService, StaticContentService>();
             services.AddSingleton<IMenuLinkListService, MenuLinkListServiceImpl>();