Make injectin gpreloads optional and not the default

Author: Quafadas

sjsls/src/buildSpaRoute.scala

@@ -20,7 +20,12 @@ import cats.effect.kernel.Ref
   * @param logger
   * @return
   */
-def buildSpaRoute(indexOpts: Option[IndexHtmlConfig], modules: Ref[IO, Map[String, String]], zdt: ZonedDateTime)(
+def buildSpaRoute(
+    indexOpts: Option[IndexHtmlConfig],
+    modules: Ref[IO, Map[String, String]],
+    zdt: ZonedDateTime,
+    injectPreloads: Boolean
+)(
     logger: Scribe[IO]
 )(using
     Async[IO]
@@ -53,7 +58,7 @@ def buildSpaRoute(indexOpts: Option[IndexHtmlConfig], modules: Ref[IO, Map[Strin
     case Some(IndexHtmlConfig.IndexHtmlPath(dir)) =>
       StaticFileMiddleware(
         HttpRoutes.of[IO] {
-          case req @ GET -> _ => serveIndexHtml(dir, modules)
+          case req @ GET -> _ => serveIndexHtml(dir, modules, injectPreloads)
         },
         dir / "index.html"
       )(logger)

sjsls/src/live.server.scala

@@ -127,6 +127,13 @@ object LiveServer extends IOApp:
         case "none"      => None()
     }
 
+  val injectPreloadsOpt = Opts
+    .flag(
+      "inject-preloads",
+      "Whether or not to attempt injecting module preloads into the index.html, potentially speeds up page load, but may not work with all servers and or cause instability in the refresh process."
+    )
+    .orFalse
+
   val extraBuildArgsOpt: Opts[List[String]] = Opts
     .options[String](
       "extra-build-args",
@@ -189,7 +196,8 @@ object LiveServer extends IOApp:
       millModuleName: Option[String] = None,
       stylesDir: Option[String] = None,
       indexHtmlTemplate: Option[String] = None,
-      buildToolInvocation: Option[String] = None
+      buildToolInvocation: Option[String] = None,
+      injectPreloads: Boolean = false
   )
 
   def parseOpts = (
@@ -207,7 +215,8 @@ object LiveServer extends IOApp:
     millModuleNameOpt,
     stylesDirOpt,
     indexHtmlTemplateOpt,
-    buildToolInvocation
+    buildToolInvocation,
+    injectPreloadsOpt
   ).mapN(LiveServerConfig.apply)
 
   def main(lsc: LiveServerConfig): Resource[IO, Server] =
@@ -275,7 +284,15 @@ object LiveServer extends IOApp:
         lsc.buildToolInvocation
       )(logger)
 
-      app <- routes(outDirString, refreshTopic, indexOpts, proxyRoutes, fileToHashRef, lsc.clientRoutingPrefix)(logger)
+      app <- routes(
+        outDirString,
+        refreshTopic,
+        indexOpts,
+        proxyRoutes,
+        fileToHashRef,
+        lsc.clientRoutingPrefix,
+        lsc.injectPreloads
+      )(logger)
 
       _ <- updateMapRef(outDirPath, fileToHashRef)(logger).toResource
       // _ <- stylesDir.fold(Resource.unit)(sd => seedMapOnStart(sd, mr))

sjsls/src/routes.scala

@@ -25,15 +25,16 @@ def routes[F[_]: Files: MonadThrow](
     indexOpts: Option[IndexHtmlConfig],
     proxyRoutes: HttpRoutes[IO],
     ref: Ref[IO, Map[String, String]],
-    clientRoutingPrefix: Option[String]
+    clientRoutingPrefix: Option[String],
+    injectPreloads: Boolean
 )(logger: Scribe[IO]): Resource[IO, HttpRoutes[IO]] =
 
   val traceLogger = traceLoggerMiddleware(logger)
   val zdt = ZonedDateTime.now()
 
   val linkedAppWithCaching: HttpRoutes[IO] = ETagMiddleware(appRoute[IO](stringPath), ref)(logger)
-  val spaRoutes = clientRoutingPrefix.map(s => (s, buildSpaRoute(indexOpts, ref, zdt)(logger)))
-  val staticRoutes = Some(staticAssetRoutes(indexOpts, ref, zdt)(logger))
+  val spaRoutes = clientRoutingPrefix.map(s => (s, buildSpaRoute(indexOpts, ref, zdt, injectPreloads)(logger)))
+  val staticRoutes = Some(staticAssetRoutes(indexOpts, ref, zdt, injectPreloads)(logger))
 
   val routes =
     frontendRoutes[IO](

sjsls/src/static.routes.scala

@@ -24,15 +24,16 @@ import cats.syntax.all.*
 def staticAssetRoutes(
     indexOpts: Option[IndexHtmlConfig],
     modules: Ref[IO, Map[String, String]],
-    zdt: ZonedDateTime
+    zdt: ZonedDateTime,
+    injectPreloads: Boolean
 )(logger: Scribe[IO]): HttpRoutes[IO] =
   indexOpts match
     case None => generatedIndexHtml(injectStyles = false, modules, zdt)(logger)
 
     case Some(IndexHtmlConfig.IndexHtmlPath(path)) =>
       HttpRoutes
         .of[IO] {
-          case req @ GET -> Root => serveIndexHtml(path, modules)
+          case req @ GET -> Root => serveIndexHtml(path, modules, injectPreloads)
 
         }
         .combineK(
@@ -51,7 +52,7 @@ def staticAssetRoutes(
         )
       )(logger).combineK(generatedIndexHtml(injectStyles = true, modules, zdt)(logger))
 
-def serveIndexHtml(from: fs2.io.file.Path, modules: Ref[IO, Map[String, String]]) = StaticFile
+def serveIndexHtml(from: fs2.io.file.Path, modules: Ref[IO, Map[String, String]], injectPreloads: Boolean) = StaticFile
   .fromPath[IO](from / "index.html")
   .getOrElseF(NotFound())
   .flatMap {
@@ -62,7 +63,7 @@ def serveIndexHtml(from: fs2.io.file.Path, modules: Ref[IO, Map[String, String]]
         .string
         .flatMap {
           body =>
-            for str <- injectModulePreloads(modules, body)
+            for str <- if injectPreloads then (injectModulePreloads(modules, body)) else IO.pure(body)
             yield
               val bytes = str.getBytes()
               f.withEntity(bytes)

sjsls/test/src/RoutesSpec.scala

@@ -181,7 +181,8 @@ class RoutesSuite extends CatsEffectSuite:
           None,
           HttpRoutes.empty[IO],
           fileToHashRef,
-          Some("app")
+          Some("app"),
+          false
         )(logger)
       yield errorActionFor(theseRoutes, aLogger).orNotFound
 
@@ -256,7 +257,8 @@ class RoutesSuite extends CatsEffectSuite:
             Some(IndexHtmlConfig.IndexHtmlPath(staticDir.toFs2)),
             HttpRoutes.empty[IO],
             fileToHashRef,
-            None
+            None,
+            false
           )(logger)
         yield theseRoutes.orNotFound
 
@@ -286,7 +288,8 @@ class RoutesSuite extends CatsEffectSuite:
           None,
           HttpRoutes.empty[IO],
           fileToHashRef,
-          None
+          None,
+          false
         )(logger)
       yield theseRoutes.orNotFound
 
@@ -317,7 +320,8 @@ class RoutesSuite extends CatsEffectSuite:
             Some(IndexHtmlConfig.StylesOnly(styleDir.toFs2)),
             HttpRoutes.empty[IO],
             fileToHashRef,
-            None
+            None,
+            false
           )(logger)
         yield theseRoutes.orNotFound
 
@@ -350,7 +354,8 @@ class RoutesSuite extends CatsEffectSuite:
             Some(IndexHtmlConfig.StylesOnly(styleDir.toFs2)),
             HttpRoutes.empty[IO],
             fileToHashRef,
-            Some("app")
+            Some("app"),
+            false
           )(logger)
         yield theseRoutes.orNotFound
 
@@ -383,7 +388,8 @@ class RoutesSuite extends CatsEffectSuite:
           Some(IndexHtmlConfig.IndexHtmlPath(staticDir.toFs2)),
           HttpRoutes.empty[IO],
           fileToHashRef,
-          None
+          None,
+          false
         )(logger)
       yield (theseRoutes.orNotFound, logger, modifedAt)
 
@@ -437,7 +443,8 @@ class RoutesSuite extends CatsEffectSuite:
           Some(IndexHtmlConfig.IndexHtmlPath(staticDir.toFs2)),
           HttpRoutes.empty[IO],
           fileToHashRef,
-          Some("app")
+          Some("app"),
+          false
         )(logger)
       yield (theseRoutes.orNotFound, logger)
 

sjsls/test/src/spaRoutesSuite.scala

@@ -36,7 +36,7 @@ class SpaRoutesSuite extends CatsEffectSuite:
 
   setupRef.test("spa routes have preloads injected for the easy case") {
     (logger, modules, _) =>
-      val spaRoute = buildSpaRoute(None, modules, ZonedDateTime.now())(logger)
+      val spaRoute = buildSpaRoute(None, modules, ZonedDateTime.now(), true)(logger)
       val resp = spaRoute(Request[IO](uri = uri"/anything")).getOrElse(fail("No response"))
       for
         body <- resp.map(_.bodyText.compile.string)
@@ -55,7 +55,8 @@ class SpaRoutesSuite extends CatsEffectSuite:
       val spaRoute = buildSpaRoute(
         Some(IndexHtmlConfig.StylesOnly(fs2.io.file.Path.apply("doestmatter"))),
         modules,
-        ZonedDateTime.now()
+        ZonedDateTime.now(),
+        true
       )(logger)
       val resp = spaRoute(Request[IO](uri = uri"/anything")).getOrElse(fail("No response"))
       for
@@ -75,7 +76,8 @@ class SpaRoutesSuite extends CatsEffectSuite:
       val spaRoute = buildSpaRoute(
         Some(IndexHtmlConfig.StylesOnly(fs2.io.file.Path.apply(tempDir.toString))),
         modules,
-        ZonedDateTime.now()
+        ZonedDateTime.now(),
+        injectPreloads = true
       )(logger)
       val resp = spaRoute(Request[IO](uri = uri"/anything")).getOrElse(fail("No response"))
       for