Fix a problem with missing html file (#1933)

* Fix 404

* Added relevant middleware, added tests

* Small fixes

* Typo...

* More small fixes

IsraelHiking.API/Services/CrawlersMiddleware.cs → IsraelHiking.API/Services/Middleware/CrawlersMiddleware.cs

@@ -8,10 +8,10 @@
 using Microsoft.AspNetCore.Http;
 using Wangkanai.Detection.Services;
 
-namespace IsraelHiking.API.Services
+namespace IsraelHiking.API.Services.Middleware
 {
     /// <summary>
-    /// This middleware is responsible in returning the index.html file or a simple page with info for the crawlers
+    /// This middleware is responsible in returning a simple page with info for the crawlers
     /// </summary>
     public class CrawlersMiddleware
     {

IsraelHiking.API/Services/Middleware/SpaDefaultHtmlMiddleware.cs

@@ -0,0 +1,42 @@
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
+
+namespace IsraelHiking.API.Services.Middleware;
+
+/// <summary>
+/// This middleware is responsible in returning the index.html file
+/// </summary>
+public class SpaDefaultHtmlMiddleware
+{
+    private readonly RequestDelegate _next;
+    private readonly IWebHostEnvironment _environment;
+
+    /// <summary>
+    /// Constructor
+    /// </summary>
+    /// <param name="next"></param>
+    /// <param name="environment"></param>
+    public SpaDefaultHtmlMiddleware(RequestDelegate next, 
+        IWebHostEnvironment environment)
+    {
+        _next = next;
+        _environment = environment;
+    }
+    /// <summary>
+    /// Main middleware method required for asp.net
+    /// </summary>
+    /// <param name="context"></param>
+    public async Task InvokeAsync(HttpContext context)
+    {
+        if (context.Request.Path.StartsWithSegments("/api"))
+        {
+            await _next.Invoke(context);
+            return;
+        }
+        var indexFileInfo = _environment.WebRootFileProvider.GetFileInfo("/index.html");
+        context.Response.ContentType = "text/html";
+        context.Response.ContentLength = indexFileInfo.Length;
+        await context.Response.SendFileAsync(indexFileInfo);
+    }
+}

IsraelHiking.Web/Program.cs

@@ -7,6 +7,7 @@
 using System.Threading.Tasks;
 using IsraelHiking.API;
 using IsraelHiking.API.Services;
+using IsraelHiking.API.Services.Middleware;
 using IsraelHiking.API.Swagger;
 using IsraelHiking.Common.Configuration;
 using IsraelHiking.Common.Extensions;
@@ -54,17 +55,17 @@ void SetupApplication(WebApplication app)
     {
         ContentTypeProvider = new FileExtensionContentTypeProvider
         {
-            Mappings = { {".pbf", "application/x-protobuf"} } // for the fonts files
+            Mappings = { { ".pbf", "application/x-protobuf" } } // for the fonts files
         }
     });
     app.UseSwagger();
     app.UseSwaggerUI(c =>
     {
         c.SwaggerEndpoint("/swagger/v1/swagger.json", "Israel Hiking Map API V1");
     });
-    // This should be the last middleware
     app.UseMiddleware<CrawlersMiddleware>();
-    app.MapFallbackToFile("index.html");
+    // This should be the last middleware
+    app.UseMiddleware<SpaDefaultHtmlMiddleware>();
     InitializeServices(app.Services);
 }
 

Tests/IsraelHiking.API.Tests/Services/CrawlersMiddlewareTests.cs → Tests/IsraelHiking.API.Tests/Services/Middleware/CrawlersMiddlewareTests.cs

@@ -1,4 +1,8 @@
-using IsraelHiking.API.Services;
+using System;
+using System.IO;
+using System.Text;
+using IsraelHiking.API.Services;
+using IsraelHiking.API.Services.Middleware;
 using IsraelHiking.API.Services.Poi;
 using IsraelHiking.Common;
 using IsraelHiking.Common.Configuration;
@@ -9,12 +13,9 @@
 using NetTopologySuite.Features;
 using NetTopologySuite.Geometries;
 using NSubstitute;
-using System;
-using System.IO;
-using System.Text;
 using Wangkanai.Detection.Services;
 
-namespace IsraelHiking.API.Tests.Services
+namespace IsraelHiking.API.Tests.Services.Middleware
 {
     [TestClass]
     public class CrawlersMiddlewareTests

Tests/IsraelHiking.API.Tests/Services/Middleware/SpaDefaultHtmlMiddlewareTests.cs

@@ -0,0 +1,68 @@
+using System.IO;
+using IsraelHiking.API.Services.Middleware;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.FileProviders;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using NSubstitute;
+
+namespace IsraelHiking.API.Tests.Services.Middleware;
+
+[TestClass]
+public class SpaDefaultHtmlMiddlewareTests
+{
+    private SpaDefaultHtmlMiddleware _middleware;
+    private IWebHostEnvironment _environment;
+    private RequestDelegate _next;
+
+    [TestInitialize]
+    public void TestInitialize()
+    {
+        _next = Substitute.For<RequestDelegate>();
+        _environment = Substitute.For<IWebHostEnvironment>();
+        _middleware = new SpaDefaultHtmlMiddleware(_next, _environment);
+    }
+
+    [TestMethod]
+    public void TestAPI_ShouldPassThrough()
+    {
+        var context = new DefaultHttpContext
+        {
+            Request =
+            {
+                Path = new PathString("/api/something"),
+                Host = new HostString("israelhiking.osm.org.il"),
+                QueryString = QueryString.Empty,
+                PathBase = PathString.Empty,
+                Scheme = "http"
+            }
+        };
+
+        _middleware.InvokeAsync(context).Wait();
+
+        _next.Received().Invoke(context);
+    }
+
+    [TestMethod]
+    public void TestOther_ShouldReturnHtmlFile()
+    {
+        var context = new DefaultHttpContext
+        {
+            Request =
+            {
+                Path = new PathString("/pther"),
+                Host = new HostString("israelhiking.osm.org.il"),
+                QueryString = QueryString.Empty,
+                PathBase = PathString.Empty,
+                Scheme = "http"
+            }
+        };
+        var fileInfo = Substitute.For<IFileInfo>();
+        fileInfo.CreateReadStream().Returns(new MemoryStream(new byte[] {1}));
+        _environment.WebRootFileProvider.GetFileInfo(Arg.Any<string>()).Returns(fileInfo);
+
+        _middleware.InvokeAsync(context).Wait();
+
+        _next.DidNotReceive().Invoke(context);
+    }
+}