Synchronize electric-fiddle with electric-starter-app

Author: ggeoffrey

.clj-kondo/config.edn

@@ -6,4 +6,4 @@
            hyperfiddle.electric.impl.array-fields/deffields clojure.core/declare}
  :linters {:redundant-expression {:level :off}
            :var-same-name-except-case {:level :off}
-           :clojure-lsp/unused-public-var {:level :off}}}
+           :clojure-lsp/unused-public-var {:level :off}}}

.dockerignore

@@ -1,4 +1,25 @@
-resources/public/electric_starter_app/js
-target/
-.cpcache
-.shadow-cljs
+**/.clj-kondo
+**/.cpcache
+**/.DS_Store
+**/.env
+**/.idea
+**/.lsp
+**/.nrepl-port
+**/*.~undo-tree~
+**/*.iml
+**/report.html
+**/yarn-error.log
+fly.toml
+yarn.lock
+
+# ignore target artifacts – docker owns the prod build
+**/.shadow-cljs
+**/node_modules
+**/output.calva-repl
+**/resources/public/*.min.css
+**/resources/public/js
+**/target
+**/tsconfig.tsbuildinfo
+# **/src/**/*.js -- we commit precompiled js files (Failure.js, Pending.js), as well as .class
+**/datagrid/state
+**/datomic_browser/state

.github/workflows/deploy.yml

@@ -0,0 +1,61 @@
+name: hyperfiddle/electric-fiddle
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+jobs:
+  deploy:
+    name: "Fly deploy, domain: hello-fiddle"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          submodules: recursive # includes HFQL
+          ssh-key: ${{ secrets.HYPERFIDDLE_ORG_DEPLOY_KEY }}
+      - uses: superfly/flyctl-actions/setup-flyctl@master
+      - run: NO_COLOR=1 flyctl deploy --remote-only --config src/hello-fiddle/fly.toml --build-arg hfql_ssh_prv_key="$HFQL_SSH_PRV_KEY"
+        env:
+          FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
+          #DATOMIC_DEV_LOCAL_USER: ${{ secrets.DATOMIC_DEV_LOCAL_USER }}
+
+  # docker_build:
+  #   needs: [jvm, browser]
+  #   if: success()
+  #   runs-on: ubuntu-latest
+  #   name: Build and push Docker image
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #       with:
+  #         fetch-depth: 0
+  #     - name: Set Environment Variables
+  #       run: echo "HYPERFIDDLE_ELECTRIC_SERVER_VERSION=$(git describe --tags --long --always --dirty)" >> $GITHUB_ENV
+
+  #     - name: Set up Docker Buildx
+  #       uses: docker/setup-buildx-action@v2
+
+  #     - uses: superfly/flyctl-actions/setup-flyctl@master
+  #     - run: flyctl auth docker
+  #       env:
+  #         FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
+
+  #     - name: Build and push
+  #       uses: docker/build-push-action@v4
+  #       with:
+  #         push: true
+  #         tags: registry.fly.io/electric-demo:latest
+  #         build-args: |
+  #           HYPERFIDDLE_ELECTRIC_SERVER_VERSION=${{ env.HYPERFIDDLE_ELECTRIC_SERVER_VERSION }}
+
+  # deploy:
+  #   needs: [docker_build]
+  #   if: success() && github.ref == 'refs/heads/master'
+  #   name: Deploy Docker image to Fly.io
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v3
+  #     - uses: superfly/flyctl-actions/setup-flyctl@master
+  #     - run: flyctl deploy --image registry.fly.io/electric-demo:latest
+  #       env:
+  #         FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

.gitignore

@@ -9,8 +9,21 @@
 .nrepl-port
 .shadow-cljs
 node_modules
-/resources/public/electric_starter_app/js
+#/report.html
+/resources/public/electric_fiddle/js
 /resources/electric-manifest.edn
 /target
+/yarn-error.log
 .DS_Store
+#src/**/*.js -- for tsc modules only, see https://github.com/hyperfiddle/photon/commit/0aa9b26c35d961151891c1e42ec13fcf52e38fa2
+# for xtdb-starter demo:
+data
+# ---
+/src/datomic_browser/state/
+/src/datagrid/state/
+/src-dev/electric-fiddle.edn
 /.dir-locals.el
+/resources/public/user/ui_demo.css
+
+# libpython-clj
+/classes

.gitmodules

@@ -0,0 +1,27 @@
+[submodule "vendor/hfql"]
+	path = vendor/hfql
+	url = git@gitlab.com:hyperfiddle/hfql.git
+[submodule "vendor/electric"]
+	path = vendor/electric
+	url = git@gitlab.com:hyperfiddle/electric.git
+[submodule "vendor/rcf"]
+	path = vendor/rcf
+	url = git@gitlab.com:hyperfiddle/rcf.git
+[submodule "heroicons-electric"]
+	path = vendor/heroicons-electric
+	url = git@gitlab.com:hyperfiddle/heroicons-electric.git
+[submodule "vendor/hyperfiddle"]
+	path = vendor/hyperfiddle
+	url = git@gitlab.com:hyperfiddle/hyperfiddle.git
+[submodule "src-private"]
+	path = src-private
+	url = git@gitlab.com:hyperfiddle/scratch.git
+[submodule "vendor/electric3-starter-app"]
+	path = vendor/electric3-starter-app
+	url = git@gitlab.com:hyperfiddle/electric3-starter-app.git
+[submodule "vendor/electric-datomic-browser"]
+	path = vendor/electric-datomic-browser
+	url = git@gitlab.com:hyperfiddle/electric-datomic-browser.git
+[submodule "vendor/hyperfiddle-contrib"]
+	path = vendor/hyperfiddle-contrib
+	url = git@gitlab.com:hyperfiddle/hyperfiddle-contrib.git

Dockerfile

@@ -1,21 +1,40 @@
+FROM node:18-bookworm-slim AS node-deps
+WORKDIR /app
+COPY package.json package.json
+RUN npm install
+
 FROM clojure:temurin-17-tools-deps-1.12.0.1501 AS build
 WORKDIR /app
+COPY --from=node-deps /app/node_modules /app/node_modules
+# install python for libpython-clj navigator demo
+RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends python3 python3-dev && rm -rf /var/lib/apt/lists/*
 COPY deps.edn deps.edn
+
+ARG HYPERFIDDLE_FIDDLE_DEPS_ALIAS
+ARG HYPERFIDDLE_FIDDLE_NS
 ARG VERSION
+
 ENV VERSION=$VERSION
-RUN clojure -A:prod -M -e ::ok       # preload – rebuilds if deps or commit version changes
-RUN clojure -A:build:prod -M -e ::ok # preload
+
+RUN clojure -A:prod:$HYPERFIDDLE_FIDDLE_DEPS_ALIAS -M -e ::ok         # preload
+RUN clojure -A:build:prod:$HYPERFIDDLE_FIDDLE_DEPS_ALIAS -M -e ::ok   # preload
 
 COPY shadow-cljs.edn shadow-cljs.edn
 COPY src src
-COPY src-prod src-prod
 COPY src-build src-build
+COPY src-prod src-prod
 COPY resources resources
 
-RUN clojure -X:prod:build uberjar :version "\"$VERSION\"" :build/jar-name "app.jar"
+RUN clojure -X:build:prod:$HYPERFIDDLE_FIDDLE_DEPS_ALIAS uberjar \
+    :build/fiddle-ns $HYPERFIDDLE_FIDDLE_NS \
+    :build/fiddle-deps-alias $HYPERFIDDLE_FIDDLE_DEPS_ALIAS \
+    :build/jar-name app.jar \
+    :version "\"$VERSION\""
 
 FROM amazoncorretto:17 AS app
 WORKDIR /app
+# install python for libpython-clj navigator demo
+RUN yum update -y && yum install -y python3 && yum clean all && rm -rf /var/cache/yum
 COPY --from=build /app/target/app.jar app.jar
 
 EXPOSE 8080

LICENSE

@@ -1,7 +1,21 @@
-MIT No Attribution
+MIT License
 
 Copyright (c) 2024 Hyperfiddle
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,36 +1,49 @@
-# Electric v3 Starter App
+# Hyperfiddle demos repo — Electric Fiddle
+
+This is an **internal playground repo** where we host a lot of our demos, live examples, and little snippets and deploy them to prod. In its current form it's **not intended for public use**. We only leave it published so we can link to the source code of certain demos when we need to.
+
+For a minimalist Electric starter repo, see https://gitlab.com/hyperfiddle/electric3-starter-app.
 
 ## Links
 
 * Electric github with source code: https://github.com/hyperfiddle/electric
 * Tutorial: https://electric.hyperfiddle.net/
 
-## Getting started - dev setup
+## Getting started — dev setup
 
-* Shell: `clj -A:dev -X dev/-main`. 
+* Shell: `clj -A:dev:private:electric-tutorial:dustingetz -X dev/-main`
 * Login instructions will be printed
-* REPL: `:dev` deps alias, `(dev/-main)` at the REPL to start dev build
+* REPL: `:dev:private:electric-tutorial:dustingetz` deps aliases, `(dev/-main)` at the REPL to start dev build
 * App will start on http://localhost:8080
-* Electric root function: [src/electric_starter_app/main.cljc](src/electric_starter_app/main.cljc)
 * Hot code reloading works: edit -> save -> see app reload in browser
 
 > [!WARNING]
-> Electric dev environments must run **one single JVM** that is shared by both the Clojure REPL and shadow-cljs ClojureScript compilation process! Electric uses a custom hot code reloading strategy to ensure that the Electric frontend and backend processes (DAGs) stay in sync as you change one or the other. This starter repo achieves this by booting shadow from the dev entrypoint[src-dev/dev.cljc](src-dev/dev.cljc). I believe this is compatible with both Calva and Cursive's "happy path" shadow-cljs support. For other editors, watch out as your boot sequence may run shadow-cljs in a second process! You will experience undefined behavior.
+> Electric dev environments must run **one single JVM** that is shared by both the Clojure REPL and shadow-cljs ClojureScript compilation process! Electric uses a custom hot code reloading strategy to ensure that the Electric frontend and backend processes (DAGs) stay in sync as you change one or the other. This starter repo achieves this by booting shadow from the dev entrypoint [src-dev/dev.cljc](src-dev/dev.cljc). I believe this is compatible with both Calva and Cursive's "happy path" shadow-cljs support. For other editors, watch out as your boot sequence may run shadow-cljs in a second process! You will experience undefined behavior.
+
+## "Fiddle" classpath infrastructure (optional)
+
+This repo is structured to allow multiple "fiddles" (little apps) to share common dev infrastructure (e.g. routing, databases). During dev, these classpaths are merged, but prod classpaths are isolated so that each fiddle can deployed individually.
+
+* **local dev**: the [dev entrypoint](src-dev/dev.cljc) uses a [clever reader trick](src-dev/load_dev_fiddles!.cljc) to drive Clojure/Script namespace `:require` directives dynamically from a config file, [`electric-fiddle.edn`](src-dev/electric-fiddle.example.edn). Clone the example file to override it locally, and remember to restart your REPL.
+
+* **prod**: the [prod entrypoint](src-prod/prod.cljc) runs only one fiddle at a time, with an isolated classpath. Prod has a mandatory [build](src-build/build.clj), which bakes the Electric application client program. At compile time, both the Electric program hash (derived from git) and the fiddle entrypoint namespace are known statically, and built into both the client assets and also the server asset `resources/electric-manifest.edn` which is used to ensure that the client & server agree about the baked Electric program hash. At runtime, the prod entrypoint uses the reader trick to lookup the name of the entrypoint to run.
+
+This is all done in a rather tiny amount of LOC, so we feel it is reasonable to expect you to understand it.
 
 ## Deployment
 
 ```shell
-# Prod build
-clj -X:build:prod build-client
-clj -M:prod -m prod
 
-# Uberjar (optional)
-clj -X:build:prod uberjar :build/jar-name "app.jar"
+clj -X:build:prod:electric-tutorial build-client :build/fiddle-ns docs-site.sitemap
+clj -M:prod:electric-tutorial -m prod
+
+# Uberjar
+clj -X:build:prod:electric-tutorial uberjar :build/fiddle-ns docs-site.sitemap :build/fiddle-deps-alias :electric-tutorial :build/jar-name '"app.jar"'
 java -cp target/app.jar clojure.main -m prod
 
 # Docker
-docker build --build-arg VERSION=$(git rev-parse HEAD) -t electric3-starter-app:latest .
-docker run --rm -it -p 8080:8080 electric3-starter-app:latest
+docker build --build-arg HYPERFIDDLE_FIDDLE_NS=docs-site.sitemap --build-arg HYPERFIDDLE_FIDDLE_DEPS_ALIAS=electric-tutorial --build-arg VERSION=$(git rev-parse HEAD) -t electric-fiddle:latest .
+docker run --rm -it -p 8080:8080 electric-fiddle:latest
 
 # Fly
 fly deploy --remote-only --build-arg VERSION=$(git rev-parse HEAD)