Merge pull request #135 from yisraelU/main

handle docs path
disneystreaming · Mar 11, 2022 · 0407bcb · 0407bcb
2 parents ce45b6a + 1de97d1
commit 0407bcb
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 1 deletion.
diff --git a/modules/http4s-swagger/src-jvm/smithy4s/http4s/swagger/Docs.scala b/modules/http4s-swagger/src-jvm/smithy4s/http4s/swagger/Docs.scala
@@ -37,11 +37,22 @@ private[smithy4s] abstract class Docs[F[_]](
 
   val actualPath: Path = Uri.Path.unsafeFromString("/" + path)
 
+  object DocPath {
+    def unapply(p: Path): Boolean = {
+      p match {
+        case `actualPath`                                               => true
+        case `actualPath` / ""                                          => true
+        case `actualPath` / file if file.equalsIgnoreCase("index.html") => true
+        case _                                                          => false
+      }
+    }
+  }
   def routes: HttpRoutes[F] = HttpRoutes.of[F] {
-    case GET -> `actualPath` =>
+    case GET -> DocPath() =>
       PermanentRedirect(
         Location(Uri.unsafeFromString(s"/$path/index.html?url=/$jsonSpec"))
       )
+
     case request @ GET -> `actualPath` / filePath =>
       val resource = s"$swaggerUiPath/$filePath"
       staticResource(resource, Some(request)).getOrElseF(NotFound())

diff --git a/modules/http4s-swagger/test/src/smithy4s/http4s/swagger/DocsSpec.scala b/modules/http4s-swagger/test/src/smithy4s/http4s/swagger/DocsSpec.scala
@@ -28,6 +28,25 @@ object DocsSpec extends SimpleIOSuite with TestCompat {
     val app = docs(path).routes.orNotFound
 
     test(s"GET /$path redirects to expected location") {
+      val request =
+        Request[IO](
+          method = Method.GET,
+          uri = Uri.unsafeFromString(s"/$path/index.html")
+        )
+      app.run(request).map { response =>
+        val redirectUri = response.headers
+          .get(CIString("Location"))
+          .map(_.head)
+          .map(_.value)
+
+        expect(response.status == Status.PermanentRedirect) and
+          expect.eql(
+            redirectUri,
+            Some(s"/$path/index.html?url=/foobar.test-spec.json")
+          )
+      }
+    }
+    test(s"GET /$path/ redirects to expected location") {
       val request =
         Request[IO](method = Method.GET, uri = Uri.unsafeFromString(s"/$path"))
       app.run(request).map { response =>
@@ -43,7 +62,22 @@ object DocsSpec extends SimpleIOSuite with TestCompat {
           )
       }
     }
+    test(s"GET /$path/index.html redirects to expected location") {
+      val request =
+        Request[IO](method = Method.GET, uri = Uri.unsafeFromString(s"/$path"))
+      app.run(request).map { response =>
+        val redirectUri = response.headers
+          .get(CIString("Location"))
+          .map(_.head)
+          .map(_.value)
 
+        expect(response.status == Status.PermanentRedirect) and
+          expect.eql(
+            redirectUri,
+            Some(s"/$path/index.html?url=/foobar.test-spec.json")
+          )
+      }
+    }
     test(s"GET $path/test-file.json fetches requested file") {
       val filePath = s"/$path/test-file.json"
       val request =