Merge pull request #117 from http4s/integration/0.2-main-20220319

Merge 0.2 -> main

Author: armanbilge

.github/workflows/ci.yml

@@ -17,6 +17,7 @@ on:
 env:
   PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
   SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
+  SONATYPE_CREDENTIAL_HOST: ${{ secrets.SONATYPE_CREDENTIAL_HOST }}
   SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
   PGP_SECRET: ${{ secrets.PGP_SECRET }}
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -41,12 +42,21 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Download Java (temurin@8)
+        id: download-java-temurin-8
+        if: matrix.java == 'temurin@8'
+        uses: typelevel/download-java@v1
+        with:
+          distribution: temurin
+          java-version: 8
+
       - name: Setup Java (temurin@8)
         if: matrix.java == 'temurin@8'
         uses: actions/setup-java@v2
         with:
-          distribution: temurin
+          distribution: jdkfile
           java-version: 8
+          jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }}
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -113,12 +123,21 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Download Java (temurin@8)
+        id: download-java-temurin-8
+        if: matrix.java == 'temurin@8'
+        uses: typelevel/download-java@v1
+        with:
+          distribution: temurin
+          java-version: 8
+
       - name: Setup Java (temurin@8)
         if: matrix.java == 'temurin@8'
         uses: actions/setup-java@v2
         with:
-          distribution: temurin
+          distribution: jdkfile
           java-version: 8
+          jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }}
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -154,12 +173,12 @@ jobs:
 
       - name: Import signing key
         if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE == ''
-        run: echo $PGP_SECRET | base64 -d | gpg --import
+        run: echo $PGP_SECRET | base64 -di | gpg --import
 
       - name: Import signing key and strip passphrase
         if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE != ''
         run: |
-          echo "$PGP_SECRET" | base64 -d > /tmp/signing-key.gpg
+          echo "$PGP_SECRET" | base64 -di > /tmp/signing-key.gpg
           echo "$PGP_PASSPHRASE" | gpg --pinentry-mode loopback --passphrase-fd 0 --import /tmp/signing-key.gpg
           (echo "$PGP_PASSPHRASE"; echo; echo) | gpg --command-fd 0 --pinentry-mode loopback --change-passphrase $(gpg --list-secret-keys --with-colons 2> /dev/null | grep '^sec:' | cut --delimiter ':' --fields 5 | tail -n 1)
 
@@ -180,12 +199,21 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Download Java (temurin@8)
+        id: download-java-temurin-8
+        if: matrix.java == 'temurin@8'
+        uses: typelevel/download-java@v1
+        with:
+          distribution: temurin
+          java-version: 8
+
       - name: Setup Java (temurin@8)
         if: matrix.java == 'temurin@8'
         uses: actions/setup-java@v2
         with:
-          distribution: temurin
+          distribution: jdkfile
           java-version: 8
+          jdkFile: ${{ steps.download-java-temurin-8.outputs.jdkFile }}
 
       - name: Cache sbt
         uses: actions/cache@v2
@@ -208,4 +236,4 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: site/target/docs/site
-          publish_branch: gh-pages
+          keep_files: true

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.4.0
+version = 3.4.3
 
 runner.dialect = Scala213Source3
 

README.md

@@ -1,12 +1,12 @@
 # http4s-dom
 
-Use http4s in your browser with Scala.js! Check out the [live example](https://http4s.github.io/http4s-dom/) in the docs.
-
+Use http4s in your browser with Scala.js! Check out the [interactive examples](https://http4s.github.io/http4s-dom/) in the docs.
 
 Features:
 
-* A [`Client` implementation](https://www.javadoc.io/doc/org.http4s/http4s-dom_sjs1_2.13/latest/org/http4s/dom/FetchClientBuilder.html) backed by [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
-* A [`Service Worker` integration](https://www.javadoc.io/doc/org.http4s/http4s-dom_sjs1_2.13/latest/org/http4s/dom/ServiceWorker$.html) to install your `HttpRoutes` as a [`FetchEvent` handler](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/onfetch)
+* A [`Client` implementation](fetch.md) backed by [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+* A [`WSClient` implementation](websocket.md) backed by [`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket$.html)
+* A [`Service Worker` integration](serviceworker.md) to install your `HttpRoutes` as a [`FetchEvent` handler](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/onfetch)
 * Encoders for [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File), [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) and [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
 
 Notably, http4s-dom can also be used to create _serverless_ apps with [Cloudflare Workers](https://workers.cloudflare.com) which have adopted the same APIs used in the browser!
@@ -16,9 +16,6 @@ Notably, http4s-dom can also be used to create _serverless_ apps with [Cloudflar
 [![http4s-dom Scala version support](https://index.scala-lang.org/http4s/http4s-dom/http4s-dom/latest.svg)](https://index.scala-lang.org/http4s/http4s-dom/http4s-dom)
 
 ```scala
-// Supports http4s 0.23.x and scala-js-dom 2.x
-libraryDependencies += "org.http4s" %%% "http4s-dom" % "0.2.0"
-
-// Or, for compatibility with scala-js-dom 1.x
-libraryDependencies += "org.http4s" %%% "http4s-dom" % "0.1.0"
+// Supports http4s 0.23.x
+libraryDependencies += "org.http4s" %%% "http4s-dom" % "0.2.1"
 ```

build.sbt

@@ -53,29 +53,35 @@ Global / fileServicePort := {
   import cats.data.Kleisli
   import cats.effect.IO
   import cats.effect.unsafe.implicits.global
-  import com.comcast.ip4s.Port
-  import org.http4s.ember.server.EmberServerBuilder
+  import org.http4s._
+  import org.http4s.dsl.io._
+  import org.http4s.blaze.server.BlazeServerBuilder
   import org.http4s.server.staticcontent._
+  import java.net.InetSocketAddress
 
   (for {
     deferredPort <- IO.deferred[Int]
-    _ <- EmberServerBuilder
-      .default[IO]
-      .withPort(Port.fromInt(0).get)
-      .withHttpApp {
-        Kleisli { req =>
-          fileService[IO](FileService.Config(".")).orNotFound.run(req).map { res =>
-            // TODO find out why mime type is not auto-inferred
-            if (req.uri.renderString.endsWith(".js"))
-              res.withHeaders(
-                "Service-Worker-Allowed" -> "/",
-                "Content-Type" -> "text/javascript"
-              )
-            else res
+    _ <- BlazeServerBuilder[IO]
+      .bindSocketAddress(new InetSocketAddress("localhost", 0))
+      .withHttpWebSocketApp { wsb =>
+        HttpRoutes
+          .of[IO] {
+            case Method.GET -> Root / "ws" =>
+              wsb.build(identity)
+            case req =>
+              fileService[IO](FileService.Config(".")).orNotFound.run(req).map { res =>
+                // TODO find out why mime type is not auto-inferred
+                if (req.uri.renderString.endsWith(".js"))
+                  res.withHeaders(
+                    "Service-Worker-Allowed" -> "/",
+                    "Content-Type" -> "text/javascript"
+                  )
+                else res
+              }
           }
-        }
+          .orNotFound
       }
-      .build
+      .resource
       .map(_.address.getPort)
       .evalTap(deferredPort.complete(_))
       .useForever
@@ -103,9 +109,9 @@ ThisBuild / Test / jsEnv := {
   }
 }
 
-val catsEffectVersion = "3.3.5"
-val fs2Version = "3.2.4"
-val http4sVersion = "1.0.0-M31"
+val catsEffectVersion = "3.3.8"
+val fs2Version = "3.2.5"
+val http4sVersion = "1.0.0-M32"
 val scalaJSDomVersion = "2.1.0"
 val circeVersion = "0.15.0-M1"
 val munitVersion = "0.7.29"
@@ -133,7 +139,7 @@ lazy val tests = project
   .settings(
     scalaJSUseMainModuleInitializer := true,
     (Test / test) := (Test / test).dependsOn(Compile / fastOptJS).value,
-    buildInfoKeys := Seq[BuildInfoKey](scalaVersion),
+    buildInfoKeys := Seq[BuildInfoKey](scalaVersion, fileServicePort),
     buildInfoPackage := "org.http4s.dom",
     libraryDependencies ++= Seq(
       "org.scalameta" %%% "munit" % munitVersion % Test,
@@ -155,48 +161,16 @@ lazy val jsdocs =
     )
     .enablePlugins(ScalaJSPlugin)
 
-import laika.ast.Path.Root
-import laika.ast._
-import laika.ast.LengthUnit._
-import laika.helium.Helium
-import laika.helium.config.{
-  Favicon,
-  HeliumIcon,
-  IconLink,
-  ImageLink,
-  ReleaseInfo,
-  Teaser,
-  TextLink
-}
-import laika.theme.config.Color
-
-Global / excludeLintKeys += laikaDescribe
-
 lazy val docs = project
   .in(file("site"))
   .settings(
-    libraryDependencies += "org.scala-js" %% "scalajs-linker" % scalaJSVersion,
-    libraryDependencies += {
-      scalaBinaryVersion.value match {
-        // keep these pinned to mdoc.js Scala versions
-        // scala-steward:off
-        case "2.12" =>
-          ("org.scala-js" %% "scalajs-compiler" % scalaJSVersion).cross(
-            CrossVersion.constant("2.12.15"))
-        case "2.13" | "3" =>
-          ("org.scala-js" %% "scalajs-compiler" % scalaJSVersion).cross(
-            CrossVersion.constant("2.13.6"))
-        // scala-steward:on
-      }
-    },
     tlFatalWarningsInCi := false,
     mdocJS := Some(jsdocs),
     mdocVariables ++= Map(
       "js-opt" -> "fast",
       "HTTP4S_VERSION" -> http4sVersion,
       "CIRCE_VERSION" -> circeVersion
     ),
-    laikaDescribe := "<disabled>",
     laikaConfig ~= { _.withRawContent },
     tlSiteHeliumConfig ~= {
       // Actually, this *disables* auto-linking, to avoid duplicates with mdoc

docs/README.md

@@ -0,0 +1,6 @@
+laika.navigationOrder = [
+  index.md
+  fetch.md
+  websocket.md
+  serviceworker.md
+]

docs/directory.conf

@@ -0,0 +1,38 @@
+# Fetch Client
+
+The [`FetchClientBuilder`](https://www.javadoc.io/doc/org.http4s/http4s-dom_sjs1_2.13/latest/org/http4s/dom/FetchClientBuilder.html) creates a standard http4s [`Client`](https://http4s.org/v0.23/api/org/http4s/client/client) that is described in the [http4s documentation](https://http4s.org/v0.23/client/).
+
+## Example
+
+```scala mdoc:js
+<div style="text-align:center">
+  <h3 style="padding:10px">
+    I'm bored.
+  </h3>
+  <button id="button">Fetch Activity</button>
+  <p style="padding:10px" id="activity"></p>
+</div>
+---
+import cats.effect._
+import cats.effect.unsafe.implicits._
+import io.circe.generic.auto._
+import org.http4s.circe.CirceEntityCodec._
+import org.http4s.dom._
+import org.scalajs.dom._
+
+val client = FetchClientBuilder[IO].create
+
+val activityElement = document.getElementById("activity")
+
+case class Activity(activity: String)
+
+val fetchActivity: IO[Unit] = for {
+  _ <- IO(activityElement.innerHTML = "<i>fetching...</i>")
+  activity <- client.expect[Activity]("https://www.boredapi.com/api/activity")
+  _ <- IO(activityElement.innerHTML = activity.activity)
+} yield ()
+
+val button = document.getElementById("button").asInstanceOf[html.Button]
+
+button.onclick = _ => fetchActivity.unsafeRunAndForget()
+```

docs/fetch.md

@@ -0,0 +1,27 @@
+# http4s-dom
+
+Use http4s in your browser with Scala.js!
+Features:
+
+* A [`Client` implementation](fetch.md) backed by [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+* A [`WSClient` implementation](websocket.md) backed by [`WebSocket`](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket$.html)
+* A [`Service Worker` integration](serviceworker.md) to install your `HttpRoutes` as a [`FetchEvent` handler](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/onfetch)
+* Encoders for [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File), [`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob) and [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
+
+Notably, http4s-dom can also be used to create _serverless_ apps with [Cloudflare Workers](https://workers.cloudflare.com) which have adopted the same APIs used in the browser!
+
+## Installation
+
+[![http4s-dom Scala version support](https://index.scala-lang.org/http4s/http4s-dom/http4s-dom/latest.svg)](https://index.scala-lang.org/http4s/http4s-dom/http4s-dom)
+
+```scala
+// Supports http4s 0.23.x and scala-js-dom 2.x
+libraryDependencies += "org.http4s" %%% "http4s-dom" % "@VERSION@"
+
+// recommended, brings in the latest client module
+libraryDependencies += "org.http4s" %%% "http4s-client" % "@HTTP4S_VERSION@"
+
+// optional, for JSON support
+libraryDependencies += "org.http4s" %%% "http4s-circe" % "@HTTP4S_VERSION@"
+libraryDependencies += "io.circe" %%% "circe-generic" % "@CIRCE_VERSION@"
+```