Document --jsonrpc

* add shared /thread volume

Author: slimslenderslacks

README.md

@@ -93,6 +93,25 @@ Prompts are fetched from a GitHub repository.  The mandatory parts of the ref ar
 but optional `path` and `ref` can be added to pull prompts from branches, and to specify a subdirectory
 where the prompt files are located in the repo.
 
+## Output json-rpc notifications
+
+Add the flag `--jsonrpc` to the list of arguments to switch the stdout stream to be a series of `jsonrpc` notifications.  
+This is useful if you are running the tool and streaming responses on to a canvas.
+
+Try running the with the `--jsonrpc` to see a full example but the stdout stream will look something like this.
+
+```
+{"jsonrpc":"2.0","method":"message","params":{"content":" consistently"}}Content-Length: 65
+
+{"jsonrpc":"2.0","method":"message","params":{"content":" high"}}Content-Length: 61
+
+{"jsonrpc":"2.0","method":"message","params":{"content":"."}}Content-Length: 52
+
+{"jsonrpc":"2.0","method":"functions","params":null}Content-Length: 57
+
+{"jsonrpc":"2.0","method":"functions-done","params":null}Content-Length: 1703
+```
+
 ### Prompt file layout
 
 Each prompt directory should contain a README.md describing the prompts and their purpose.  Each prompt file

functions/hub/curl/Dockerfile

@@ -0,0 +1,33 @@
+
+# syntax = docker/dockerfile:1.4
+FROM nixos/nix:2.21.1@sha256:3f6c77ee4d2c82e472e64e6cd7087241dc391421a0b42c22e6849c586d5398d9 AS builder
+
+WORKDIR /tmp/build
+RUN mkdir /tmp/nix-store-closure
+
+# ignore SC2046 because the output of nix-store -qR will never have spaces - this is safe here
+# hadolint ignore=SC2046
+RUN --mount=type=cache,target=/nix,from=nixos/nix:2.21.1,source=/nix \
+    --mount=type=cache,target=/root/.cache \
+    --mount=type=bind,target=/tmp/build \
+    <<EOF
+  nix \
+    --extra-experimental-features "nix-command flakes" \
+    --option filter-syscalls false \
+    --extra-trusted-substituters "https://cache.iog.io" \
+    --extra-trusted-public-keys "hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ=" \
+    --show-trace \
+    --log-format raw \
+    build . --out-link /tmp/output/result
+  cp -R $(nix-store -qR /tmp/output/result) /tmp/nix-store-closure
+EOF
+
+FROM scratch
+
+WORKDIR /app
+
+COPY --from=builder /tmp/nix-store-closure /nix/store
+COPY --from=builder /tmp/output/ /app/
+
+ENTRYPOINT ["/app/result/bin/entrypoint"]
+CMD ["--help"]

functions/hub/curl/flake.lock

@@ -0,0 +1,39 @@
+{
+  description = "fasttext";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.11";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils, ...}@inputs:
+
+    flake-utils.lib.eachDefaultSystem
+      (system:
+        let
+          pkgs = import nixpkgs {
+            inherit system;
+          };
+
+        in rec
+        {
+          packages = rec {
+
+            # this derivation just contains the init.clj script
+            scripts = pkgs.stdenv.mkDerivation {
+              name = "scripts";
+              src = ./.;
+              installPhase = ''
+                cp init.clj $out
+              '';
+            };
+
+            # the script must have gh in the PATH
+            default = pkgs.writeShellScriptBin "entrypoint" ''
+              export PATH=${pkgs.lib.makeBinPath [pkgs.curl]}
+              export SSL_CERT_FILE=${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt
+              ${pkgs.babashka}/bin/bb ${scripts} "$@"
+            '';
+          };
+        });
+}

functions/hub/curl/flake.nix

@@ -0,0 +1,19 @@
+(ns init
+  (:require
+   [babashka.process]
+   [cheshire.core]))
+
+(try
+  (let [[json-string & args] *command-line-args*
+        {llm-args :args} (cheshire.core/parse-string json-string true)]
+    (println
+     (-> (apply babashka.process/process
+                {:out :string}
+                "curl" args)
+         (deref)
+         (babashka.process/check)
+         :out)))
+  (catch Throwable t
+    (binding [*out* *err*]
+      (println (str "Error: " (.getMessage t)))
+      (System/exit 1))))

functions/hub/curl/init.clj

@@ -0,0 +1,35 @@
+# Background
+
+The `curl` function has one parameter.
+
+* `args`: the args to send to the image
+
+## Usage
+
+This function should be given a rw bind mount for the root of a project.
+
+```sh
+docker run --rm \
+       --mount type=bind,source=$PWD,target=/project \
+       --entrypoint /app/result/bin/entrypoint \
+       --workdir /project \
+       vonwig/curl:latest '{}'
+```
+
+## Build
+
+```sh
+docker build -t vonwig/fasttext:latest .
+```
+
+```sh
+# docker:command=build
+
+docker buildx build \
+    --builder hydrobuild \
+    --platform linux/amd64,linux/arm64 \
+    --tag vonwig/fasttext:latest \
+    --file Dockerfile \
+    --push .
+docker pull vonwig/fasttext:latest
+```

functions/hub/curl/runbook.md

@@ -42,3 +42,23 @@ docker run --rm \
 bb -m clean-local-images
 ```
 
+## https://github.com/docker/labs-eslint-violations.git
+
+```sh
+docker run --rm \
+          -it \
+           -v /var/run/docker.sock:/var/run/docker.sock \
+           --mount type=bind,source=$PWD,target=/app/local \
+           --workdir /app \
+           --mount type=volume,source=docker-prompts,target=/prompts \
+           --mount type=bind,source=$HOME/.openai-api-key,target=/root/.openai-api-key \
+           vonwig/prompts:local \
+                                 run \
+                                 /Users/slim/repo/labs-eslint-violations \
+                                 jimclark106 \
+                                 "$(uname -o)" \
+                                 local/prompts/eslint \
+                                 --pat "$(cat ~/.secrets/dockerhub-pat-ai-tools-for-devs.txt)" \
+                                 --jsonrpc
+
+```

runbook.md

@@ -67,7 +67,7 @@
 ;; entrypoint is an array of strings
 ;; env is a map
 ;; Env is an array of name=value strings
-(defn create-container [{:keys [image entrypoint command host-dir env]}]
+(defn create-container [{:keys [image entrypoint command host-dir env thread-volume]}]
   (let [payload (json/generate-string
                  (merge
                   {:Image image
@@ -76,8 +76,10 @@
                                        (map (fn [[k v]] (format "%s=%s" (name k) v)))
                                        (into []))})
                   (when host-dir {:HostConfig
-                                  {:Binds [(format "%s:/project:rw" host-dir)
-                                           "docker-lsp:/docker"]}
+                                  {:Binds
+                                   (concat [(format "%s:/project:rw" host-dir)
+                                            "docker-lsp:/docker-lsp"]
+                                           (when thread-volume (format "%s:/thread" thread-volume)))}
                                   :WorkingDir "/project"})
                   (when entrypoint {:Entrypoint entrypoint})
                   (when command {:Cmd command})))]
@@ -89,6 +91,18 @@
       :headers {"Content-Type" "application/json"
                 "Content-Length" (count payload)}})))
 
+(defn create-volume [{:keys [thread-volume-name]}]
+  (curl/post "http://localhost/volumes/create"
+             {:raw-args ["--unix-socket" "/var/run/docker.sock"]
+              :throw false
+              :body (json/generate-string {:Name thread-volume-name})
+              :headers {"Content-Type" "application/json"}}))
+
+(defn remove-volume [{:keys [thread-volume-name]}]
+  (curl/delete (format "http://localhost/volumes/%s" thread-volume-name)
+             {:raw-args ["--unix-socket" "/var/run/docker.sock"]
+              :throw false}))
+
 (defn inspect-container [{:keys [Id]}]
   (curl/get
    (format "http://localhost/containers/%s/json" Id)
@@ -133,6 +147,8 @@
       (throw (ex-info (format "%s -- (%d != %s)" s (:status response) code) response)))))
 
 (def create (comp ->json (status? 201 "create-container") create-container))
+(def thread-volume (comp (status? 201 "create-volume") create-volume))
+(def delete-thread-volume (comp (status? 204 "remove-volume") remove-volume))
 (def inspect (comp ->json (status? 200 "inspect container") inspect-container))
 (def start (comp (status? 204 "start-container") start-container))
 (def wait (comp (status? 200 "wait-container") wait-container))
@@ -157,19 +173,20 @@
 (spec/def ::container-definition (spec/keys :opt-un [::host-dir ::entrypoint ::command ::user ::pat]
                                             :req-un [::image]))
 
-;; TODO verify that m is a container-definition
 (defn run-function [m]
   (when (and (:user m) (and (not (:offline m)) (or (:pat m) (creds/credential-helper->jwt))))
     (pull (assoc m :creds {:username (:user m)
                            :password (or (:pat m) (creds/credential-helper->jwt))
                            :serveraddress "https://index.docker.io/v1/"})))
+  (when (:thread-volume m) (thread-volume m))
   (let [x (create m)]
     (start x)
     (wait x)
     ;; body is raw PTY output
     (let [s (:body (attach x))
           info (inspect x)]
       (delete x)
+      (when (and (:thread-volume m) (not (true? (:save-thread-volume m)))) (delete-thread-volume m))
       {:pty-output s
        :exit-code (-> info :State :ExitCode)
        :info info})))

src/docker.clj

@@ -159,7 +159,7 @@
        function-name - the name of the function that the LLM has selected
        json-arg-string - the JSON arg string that the LLM has generated
        resolve fail - callbacks"
-  [{:keys [functions user pat] :as opts} function-name json-arg-string {:keys [resolve fail]}]
+  [{:keys [functions user pat thread-volume save-thread-volume] :as opts} function-name json-arg-string {:keys [resolve fail]}]
   (if-let [definition (->
                        (->> (filter #(= function-name (-> % :function :name)) functions)
                             first)
@@ -175,7 +175,9 @@
                                         (if json-arg-string [json-arg-string] ["{}"])
                                         (when-let [c (-> definition :container :command)] c))}
                              (when user {:user user})
-                             (when pat {:pat pat}))
+                             (when pat {:pat pat})
+                             (when thread-volume {:thread-volume thread-volume})
+                             (when (true? save-thread-volume) {:save-thread-volume true}))
               {:keys [pty-output exit-code]} (docker/run-function function-call)]
           (if (= 0 exit-code)
             (resolve pty-output)
@@ -206,7 +208,7 @@
       args for extracting functions, host-dir, user, platform
     returns channel that will contain the final set of messages and a finish-reason"
   [prompts & args]
-  (let [[host-dir user platform prompts-dir & {:keys [url pat]}] args
+  (let [[host-dir user platform prompts-dir & {:keys [url pat save-thread-volume thread-id]}] args
         prompt-dir (get-dir prompts-dir)
         m (collect-metadata prompt-dir)
         functions (collect-functions prompt-dir)
@@ -217,7 +219,11 @@
                                        :host-dir host-dir
                                        :user user
                                        :platform platform}
-                                      (when pat {:pat pat}))))]
+                                      (when pat {:pat pat})
+                                      (when save-thread-volume {:save-thread-volume true})
+                                      (if thread-id 
+                                        {:thread-volume thread-id}
+                                        {:thread-volume (str (random-uuid))}))))]
     (try
       (openai/openai
        (merge
@@ -298,21 +304,23 @@
                [nil "--host-dir DIR" "Project directory"]
                [nil "--prompts DIR_OR_GITHUB_REF" "prompts"]
                [nil "--offline" "do not try to pull new images"]
-               [nil "--pretty-print-prompts" "pretty print prompts"]])
+               [nil "--pretty-print-prompts" "pretty print prompts"]
+               [nil "--save-thread-volume" "save the thread volume for debugging"]
+               [nil "--thread-id THREAD_ID" "use this thread-id for the next conversation"]])
 
 (defn- add-arg [options args k]
   (if-let [v (k options)] (concat args [k v]) args))
 
-(def output-handler (fn [x] (println (json/generate-string x))))
+(def output-handler (fn [x] (jsonrpc/notify {:message {:content (json/generate-string x)}})))
 (defn output-prompts [coll]
-  (println "## Prompts:\n")
+  (jsonrpc/notify {:message {:content "## Prompts:\n"}})
   (->> coll
        (mapcat (fn [{:keys [role content]}]
                  [(format "## %s\n" role)
                   content]))
        (interpose "\n")
        (apply str)
-       (println)))
+       ((fn [s] (jsonrpc/notify {:message {:content s}})))))
 
 (defn -main [& args]
   (try
@@ -328,7 +336,8 @@
        (apply -run-command (concat
                             arguments
                             (reduce (partial add-arg options) [] [:url :pat :host-dir :prompts])
-                            (when (:offline options) [:offline true])))))
+                            (when (:offline options) [:offline true])
+                            (when (:save-thread-volume options) [:save-thread-volume true])))))
     (catch Throwable t
       (warn "Error: {{ exception }}" {:exception t})
       (System/exit 1))))