Feature: clojure-SDK babashka support

Doc: some examples ported to bb

Refactor: Cleaned up the bb tasks helpers

Feature: bb tests in the github workflow

Author: JeremS

.github/workflows/release-sdk.yml

@@ -52,9 +52,12 @@ jobs:
           key: cljdeps-${{ hashFiles('**/deps.edn') }}
           restore-keys: cljdeps-
 
-      - name: Run test suite
+      - name: Run Clojure test suite
         run: bb test:all
 
+      - name: Run Babashka test suite
+        run: bb test:bb
+
       - name: Build jar artifacts
         run: bb jar:all
 

bb.edn

@@ -1,87 +1,126 @@
-{:paths ["src/main" "src/bb"]
+{:paths ["src/bb"
+         "sdk/src/main"
+         "sdk-adapter-http-kit/src/main/"
+         "sdk-malli-schemas/src/main"
+         "./src/test/core-sdk"
+         "./src/test/malli-schemas"]
+
+ :deps {io.github.noahtheduke/lazytest {:mvn/version "1.8.0"}
+        metosin/malli                  {:mvn/version "0.17.0"}}
+
  :tasks
  {:requires ([tasks :as t])
 
-  -prep (t/prep-libs)
-
-  dev {:task (t/dev :http-kit :ring-jetty :malli-schemas)}
-
-  dev:rj9a {:task (t/dev :http-kit :ring-rj9a :malli-schemas)}
-
-  dev:empty (t/dev :malli-schemas)
-
-  test:all (t/lazytest [:http-kit
-                        :ring-jetty
-                        :malli-schemas
-                        :sdk-brotli]
-                       [:test.paths/core-sdk
-                        :test.paths/malli-schemas
-                        :test.paths/brotli
-                        :test.paths/adapter-ring
-                        :test.paths/adapter-http-kit
-                        :test.paths/adapter-ring-jetty])
-
-  test:all-w (t/lazytest [:http-kit
-                          :ring-jetty
-                          :malli-schemas
-                          :sdk-brotli]
-                         [:test.paths/core-sdk
-                          :test.paths/malli-schemas
-                          :test.paths/brotli
-                          :test.paths/adapter-ring
-                          :test.paths/adapter-ring-jetty
-                          :test.paths/adapter-http-kit]
-                         "--watch"
-                         "--delay 1000")
-
-  test:rj9a (t/lazytest [:http-kit
-                         :ring-rj9a]
-                        [:test.paths/core-sdk
-                         :test.paths/adapter-ring
-                         :test.paths/adapter-rj9a])
-
-  jar:sdk {:doc  "Build jar for the common sdk"
-           :task (t/lib-jar! t/sdk-dir)}
-
-  jar:sdk-adapter-ring {:doc  "Build jar for the adapter-ring"
-                        :task (t/lib-jar! t/sdk-adapter-ring-dir)}
-
-  jar:sdk-adapter-http-kit {:doc  "Build jar for the adapter-http-kit"
-                            :task (t/lib-jar! t/sdk-adapter-http-kit-dir)}
-
-  jar:sdk-brotli {:doc  "Build jar for the Brotli library"
-                  :task (t/lib-jar! t/sdk-brotli-dir)}
-
-  jar:sdk-malli-schemas {:doc  "Build jar for the malli-schemas"
-                         :task (t/lib-jar! t/sdk-malli-schemas-dir)}
-
-  jar:all {:doc     "Build the jar for all the libs"
-           :depends [clean
-                     jar:sdk
-                     jar:sdk-adapter-ring
-                     jar:sdk-adapter-http-kit
-                     jar:sdk-brotli
-                     jar:sdk-malli-schemas]}
-
-  install:all {:doc "Install all libraries"
-               :depends [clean]
-               :task (doseq [dir t/sdk-lib-dirs]
-                       (t/lib-install! dir))}
-
-  clean {:doc  "Clean build artifacts"
-         :task (doseq [dir t/sdk-lib-dirs]
-                 (clojure {:dir dir} "-T:build clean"))}
-
-  set-version {:doc  "Set the version in all libs"
-               :task (doseq [dir t/sdk-lib-dirs]
-                       (t/lib-set-version! dir (first *command-line-args*)))}
-
-  bump-version {:doc  "Bump the version component in all libs. First argument must be one of: major, minor, patch"
-                :task (doseq [dir sdk-lib-dirs]
-                        (let [component (first *command-line-args*)]
-                          (t/lib-bump! dir component)))}
-
-  publish:all {:doc     "Publish the clojure sdk libs to clojars"
-               :depends [jar:all]
-               :task    (doseq [dir sdk-lib-dirs]
-                          (t/lib-publish! dir))}}}
+  dev
+  {:doc "Starts a dev repl. Additional deps aliases can be passed as arguments."
+   :task (t/dev :http-kit :ring-jetty :malli-schemas)}
+
+  dev:rj9a
+  {:doc "Same as `dev` with ring-jetty replaced with rj9a."
+   :task (t/dev :http-kit :ring-rj9a :malli-schemas)}
+
+  dev:empty
+  {:doc "Dev repl with no adapters."
+   :task (t/dev :malli-schemas)}
+  
+  dev:bb
+  {:doc "Start a babashka nrepl server. An addr like `localhost:1234` can be passed as argument."
+   :task (t/dev-bb)}
+
+  test:all
+  {:doc "Run all tests once."
+   :task (t/lazytest [:http-kit
+                      :ring-jetty
+                      :malli-schemas
+                      :sdk-brotli]
+                     [:test.paths/core-sdk
+                      :test.paths/malli-schemas
+                      :test.paths/brotli
+                      :test.paths/adapter-ring
+                      :test.paths/adapter-http-kit
+                      :test.paths/adapter-ring-jetty])}
+
+  test:all-w
+  {:doc "Watch all tests."
+   :task (t/lazytest [:http-kit
+                      :ring-jetty
+                      :malli-schemas
+                      :sdk-brotli]
+                     [:test.paths/core-sdk
+                      :test.paths/malli-schemas
+                      :test.paths/brotli
+                      :test.paths/adapter-ring
+                      :test.paths/adapter-ring-jetty
+                      :test.paths/adapter-http-kit]
+                     "--watch"
+                     "--delay 1000")}
+
+  test:rj9a
+  {:doc "Same as `test:all` with ring-jetty replaced by rj9a."
+   :task (t/lazytest [:http-kit
+                      :ring-rj9a]
+                     [:test.paths/core-sdk
+                      :test.paths/adapter-ring
+                      :test.paths/adapter-rj9a])}
+
+  test:bb
+  {:doc "Run core unit tests with babashka."
+   :task (t/bb-lazytest [:test.paths/core-sdk
+                         :test.paths/malli-schemas])}
+
+  jar:sdk
+  {:doc  "Build jar for the common sdk"
+   :task (t/lib-jar! t/sdk-dir)}
+
+  jar:sdk-adapter-ring
+  {:doc  "Build jar for the adapter-ring"
+   :task (t/lib-jar! t/sdk-adapter-ring-dir)}
+
+  jar:sdk-adapter-http-kit
+  {:doc  "Build jar for the adapter-http-kit"
+   :task (t/lib-jar! t/sdk-adapter-http-kit-dir)}
+
+  jar:sdk-brotli
+  {:doc  "Build jar for the Brotli library"
+   :task (t/lib-jar! t/sdk-brotli-dir)}
+
+  jar:sdk-malli-schemas
+  {:doc  "Build jar for the malli-schemas"
+   :task (t/lib-jar! t/sdk-malli-schemas-dir)}
+
+  jar:all
+  {:doc     "Build the jar for all the libs"
+   :depends [clean
+             jar:sdk
+             jar:sdk-adapter-ring
+             jar:sdk-adapter-http-kit
+             jar:sdk-brotli
+             jar:sdk-malli-schemas]}
+
+  install:all
+  {:doc "Install all libraries"
+   :depends [clean]
+   :task (doseq [dir t/sdk-lib-dirs]
+           (t/lib-install! dir))}
+
+  clean
+  {:doc  "Clean build artifacts"
+   :task (doseq [dir t/sdk-lib-dirs]
+           (clojure {:dir dir} "-T:build clean"))}
+
+  set-version
+  {:doc  "Set the version in all libs"
+   :task (doseq [dir t/sdk-lib-dirs]
+           (t/lib-set-version! dir (first *command-line-args*)))}
+
+  bump-version
+  {:doc  "Bump the version component in all libs. First argument must be one of: major, minor, patch"
+   :task (doseq [dir sdk-lib-dirs]
+           (let [component (first *command-line-args*)]
+             (t/lib-bump! dir component)))}
+
+  publish:all
+  {:doc     "Publish the clojure sdk libs to clojars"
+   :depends [jar:all]
+   :task    (doseq [dir sdk-lib-dirs]
+              (t/lib-publish! dir))}}}

sdk-adapter-http-kit/src/main/starfederation/datastar/clojure/adapter/http_kit/impl.clj renamed to sdk-adapter-http-kit/src/main/starfederation/datastar/clojure/adapter/http_kit/impl.cljc

@@ -5,8 +5,9 @@
     [starfederation.datastar.clojure.utils :as u]
     [org.httpkit.server :as hk-server])
   (:import
-    [java.util.concurrent.locks ReentrantLock]
-    [java.io ByteArrayOutputStream Closeable]))
+    java.lang.Exception
+    [java.io ByteArrayOutputStream Closeable]
+    [java.util.concurrent.locks ReentrantLock]))
 
 
 (def basic-profile
@@ -93,9 +94,10 @@
 
   (sse-gen? [_] true)
 
-  Closeable
-  (close [this]
-    (p/close-sse! this)))
+  #?@(:bb  []
+      :clj [Closeable
+            (close [this]
+              (p/close-sse! this))]))
 
 
 (defn ->sse-gen

sdk/src/main/starfederation/datastar/clojure/adapter/test.clj renamed to sdk/src/main/starfederation/datastar/clojure/adapter/test.cljc

@@ -5,8 +5,9 @@
     [starfederation.datastar.clojure.protocols :as p]
     [starfederation.datastar.clojure.utils :as u])
  (:import
-    [java.util.concurrent.locks ReentrantLock]
-    [java.io Closeable]))
+    #?(:clj [java.io Closeable])
+    java.lang.StringBuilder
+    [java.util.concurrent.locks ReentrantLock]))
 
 
 
@@ -46,9 +47,10 @@
 
   (sse-gen? [_] true)
 
-  Closeable
-  (close [this]
-    (p/close-sse! this)))
+  #?@(:bb  []
+      :clj [Closeable
+            (close [this]
+              (p/close-sse! this))]))
 
 
 (defn ->sse-response

src/bb-example/bb.edn

@@ -0,0 +1,7 @@
+{:paths ["src/main"
+         "../../sdk/src/main"
+         "../../sdk-adapter-http-kit/src/main/"
+         "../../sdk-malli-schemas/src/main"]
+ :deps {metosin/malli               {:mvn/version "0.17.0"}
+        org.clojars.askonomm/ruuter {:mvn/version "1.3.5"}
+        ring/ring-core              {:mvn/version "1.14.2"}}}

src/bb-example/src/main/bb_example/animation.clj

@@ -0,0 +1,66 @@
+(ns bb-example.animation
+  (:require
+    [bb-example.animation.broadcast                   :as broadcast]
+    [bb-example.animation.handlers                    :as handlers]
+    [bb-example.animation.rendering                   :as rendering]
+    [bb-example.animation.state                       :as state]
+    [bb-example.common                                :as c]
+    [bb-example.core                                  :as core]
+    [ruuter.core                                      :as ruuter]
+    [ring.middleware.params                           :as r-params]
+    [starfederation.datastar.clojure.adapter.http-kit :as hk-gen]
+
+    [starfederation.datastar.clojure.adapter.http-kit-schemas]
+    [starfederation.datastar.clojure.api-schemas]))
+
+;; This example let's use play with fat updates and compression
+;; to get an idea of the gains compression can help use achieve
+;; in terms of network usage.
+(broadcast/install-watch!)
+
+(def routes
+  [(c/GET "/"          handlers/home-handler)
+   (c/GET "/ping/:id"  (r-params/wrap-params handlers/ping-handler))
+   (c/GET "/random-10" handlers/random-pings-handler)
+   (c/GET "/reset"     handlers/reset-handler)
+   (c/GET "/step1"     handlers/step-handler)
+   (c/GET "/play"      handlers/play-handler)
+   (c/GET "/pause"     handlers/pause-handler)
+   (c/GET "/refresh"   handlers/refresh-handler)
+   (c/POST "/resize"   (r-params/wrap-params handlers/resize-handler))
+   (c/GET "/updates"   (handlers/->updates-handler
+                         {hk-gen/write-profile hk-gen/gzip-profile}))])
+
+(defn handler [req]
+  (ruuter/route routes req))
+
+
+(defn clear-terminal! []
+  (binding [*out* (java.io.PrintWriter. System/out)]
+    (print "\033c")
+    (flush)))
+
+
+
+(comment
+  (clear-terminal!)
+  (core/start! #'handler)
+  *e
+  state/!state
+  state/!conns
+  (reset! state/!conns #{})
+
+  (-> state/!state
+      deref
+      rendering/page)
+  (state/resize! 10 10)
+  (state/resize! 20 20)
+  (state/resize! 25 25)
+  (state/resize! 30 30)
+  (state/resize! 50 50)
+  (state/reset-state!)
+  (state/add-random-pings!)
+  (state/step-state!)
+  (state/start-animating!))
+
+

src/bb-example/src/main/bb_example/animation/broadcast.clj

@@ -0,0 +1,27 @@
+(ns bb-example.animation.broadcast
+  (:require
+    [bb-example.animation.rendering      :as rendering]
+    [bb-example.animation.state          :as state]
+    [starfederation.datastar.clojure.api :as d*]))
+
+
+(defn send-frame! [sse frame]
+  (try
+    (d*/patch-elements! sse frame)
+    (catch Exception e
+      (println e))))
+
+
+(defn broadcast-new-frame! [frame]
+  (let [sses @state/!conns]
+    (doseq [sse sses]
+      (send-frame! sse frame))))
+
+
+(defn install-watch! []
+  (add-watch state/!state ::watch
+             (fn [_k _ref old new]
+               (when-not (identical? old new)
+                 (let [frame (rendering/render-content new)]
+                  (broadcast-new-frame! frame))))))
+