Should now work with static sites too

Author: Quafadas

build.mill

@@ -1,5 +1,5 @@
 //| mill-jvm-version: 21
-//| mill-version: 1.0.4
+//| mill-version: 1.0.5
 //| mvnDeps:
 //| - com.lihaoyi::mill-contrib-buildinfo:$MILL_VERSION
 //| - com.goyeau::mill-scalafix::0.6.0

routes/src/appRoute.scala

@@ -17,10 +17,7 @@ def appRoute[F[_]: Files](stringPath: String)(using f: Async[F]): HttpRoutes[F]
   case req @ GET -> Root / fName ~ "js" =>
     StaticFile
       .fromPath(fs2.io.file.Path(stringPath) / req.uri.path.renderString, Some(req))
-      .getOrElseF(
-        fileService[F](FileService.Config(stringPath)).run(req)
-        .getOrElseF(f.pure(Response[F](Status.NotFound)))
-      )
+      .getOrElseF(f.pure(Response[F](Status.NotFound)))
 
   case req @ GET -> Root / fName ~ "wasm" =>
     StaticFile

site/docs/routes.md

@@ -0,0 +1,18 @@
+# Routes
+
+Files are served under three seperate routing strategies. Conflicts are resolved in the order listed here.
+
+## `--out-dir` Route
+
+These files are assumed to be created by a build tool emitting `.js`, `.js.map`, `.wasm`, and `.wasm.map` files. They are watched in the directory specified by the `--out-dir` argument, and served at the root of the server. For example, scala-js will usually emit a file called `main.js`.
+
+You'll find it at http://localhost:8080/main.js
+
+
+## SPA Routes
+
+For things like client side routing to work, the backend must return the `index.html` file for any route that doesn't match a static asset. This is done by specifying a `--client-routes-prefix` argument. For example, if you specify `--client-routes-prefix app`, then any request to http://localhost:8080/app/anything/here will return the `index.html` file in response to a request made by the browser. The browser will then handle the routing / rendering.
+
+## Static Routes
+
+Static assets are served from the directory specified by the `--path-to-index-html` argument to the root of the site. For example, if you have a file `styles/index.less` in that directory, it will be served at http://localhost:8080/styles/index.less

sjsls/src/BuildTool.scala

@@ -0,0 +1,13 @@
+package io.github.quafadas.sjsls
+
+sealed trait BuildTool(val invokedVia: String)
+class ScalaCli
+    extends BuildTool(
+      if isWindows then "scala-cli.bat" else "scala-cli"
+    )
+class Mill
+    extends BuildTool(
+      if isWindows then "mill.bat" else "mill"
+    )
+
+class NoBuildTool extends BuildTool("")

sjsls/src/buildRunner.scala

@@ -14,18 +14,6 @@ import cats.effect.ResourceIO
 import cats.effect.kernel.Resource
 import cats.syntax.all.*
 
-sealed trait BuildTool(val invokedVia: String)
-class ScalaCli
-    extends BuildTool(
-      if isWindows then "scala-cli.bat" else "scala-cli"
-    )
-class Mill
-    extends BuildTool(
-      if isWindows then "mill.bat" else "mill"
-    )
-
-class NoBuildTool extends BuildTool("")
-
 private lazy val isWindows: Boolean =
   System.getProperty("os.name").toLowerCase(Locale.ENGLISH).contains("windows")
 

sjsls/src/liveServer.scala

@@ -93,7 +93,14 @@ object LiveServer extends IOApp:
       linkingTopic <- Topic[IO, Unit].toResource
       client <- EmberClientBuilder.default[IO].build
       baseDirPath <- lsc.baseDir.fold(Files[IO].currentWorkingDirectory.toResource)(toDirectoryPath)
-      outDirPath <- lsc.outDir.fold(Files[IO].tempDirectory)(toDirectoryPath)
+      outDirPath <- lsc
+        .outDir
+        .fold {
+          // If we arent' responsible for linking and the user has specified a location for index html, we're essentially serving a static site.
+          (lsc.buildTool, lsc.indexHtmlTemplate) match
+            case (_: NoBuildTool, Some(indexHtml)) => toDirectoryPath(indexHtml)
+            case _                                 => Files[IO].tempDirectory
+        }(toDirectoryPath)
       outDirString = outDirPath.show
       indexHtmlTemplatePath <- lsc.indexHtmlTemplate.traverse(toDirectoryPath)
       stylesDirPath <- lsc.stylesDir.traverse(toDirectoryPath)

sjsls/src/middleware/ETagMiddleware.scala

@@ -39,7 +39,7 @@ object ETagMiddleware:
                   )
                 )
             case None =>
-              logger.debug("No hash found in map at path :" + req.uri.toString) >>
+              logger.debug(s"No hash found in map at path: ${req.uri.toString}. Adding revalidate headers") >>
                 IO(
                   resp.putHeaders(
                     Header.Raw(ci"Cache-control", "Must-Revalidate"),

sjsls/src/middleware/staticpathMiddleware.scala

@@ -87,7 +87,7 @@ object StaticMiddleware:
     (req: Request[IO]) =>
       val epochInstant: Instant = Instant.EPOCH
       val fullPath = staticDir / req.uri.path.toString.drop(1)
-
-      cachedFileResponse(epochInstant, fullPath, req, service)(logger: Scribe[IO])
+      OptionT.liftF(logger.debug(s"Attempting to serve static file at: $fullPath")) >>
+        cachedFileResponse(epochInstant, fullPath, req, service)(logger: Scribe[IO])
   }
 end StaticMiddleware

sjsls/src/routes.scala

@@ -50,7 +50,8 @@ def routes[F[_]: Files: MonadThrow](
       .combineK(proxyRoutes)
       .combineK(routes)
   )
-
-  IO(refreshableApp).toResource
+  logger.info("Routes created  at : ").toResource >>
+    logger.info("Path: " + stringPath).toResource >>
+    IO(refreshableApp).toResource
 
 end routes

sjsls/src/staticRoutes.scala

@@ -52,22 +52,23 @@ def staticAssetRoutes(
         )
       )(logger).combineK(generatedIndexHtml(injectStyles = true, modules, zdt, injectPreloads)(logger))
 
-def serveIndexHtml(from: fs2.io.file.Path, modules: Ref[IO, Map[String, String]], injectPreloads: Boolean) = StaticFile
-  .fromPath[IO](from / "index.html")
-  .getOrElseF(NotFound())
-  .flatMap {
-    f =>
-      f.body
-        .through(text.utf8.decode)
-        .compile
-        .string
-        .flatMap {
-          body =>
-            for str <- if injectPreloads then (injectModulePreloads(modules, body)) else IO.pure(body)
-            yield
-              val bytes = str.getBytes()
-              f.withEntity(bytes)
-              Response[IO]().withEntity(bytes).putHeaders("Content-Type" -> "text/html")
+def serveIndexHtml(from: fs2.io.file.Path, modules: Ref[IO, Map[String, String]], injectPreloads: Boolean) =
+  StaticFile
+    .fromPath[IO](from / "index.html")
+    .getOrElseF(NotFound())
+    .flatMap {
+      f =>
+        f.body
+          .through(text.utf8.decode)
+          .compile
+          .string
+          .flatMap {
+            body =>
+              for str <- if injectPreloads then (injectModulePreloads(modules, body)) else IO.pure(body)
+              yield
+                val bytes = str.getBytes()
+                f.withEntity(bytes)
+                Response[IO]().withEntity(bytes).putHeaders("Content-Type" -> "text/html")
 
-        }
-  }
+          }
+    }