Separate prod & dev config

Author: jebberjeb

project.clj

@@ -4,15 +4,11 @@
   :license {:name "Eclipse Public License"
             :url "http://www.eclipse.org/legal/epl-v10.html"}
   :dependencies [[org.clojure/clojure "1.9.0-alpha12"]
-                 [org.clojure/core.async "0.1.346.0-17112a-alpha"]
-                 ;; TODO: upgrade to this
-                 ;; [org.clojure/core.async "0.2.391"]
+                 [org.clojure/core.async "0.2.391"]
                  [org.clojure/tools.logging "0.3.1"]
                  [clj-logging-config "1.9.12"]
                  [clojure-msgpack "1.0.0"]]
   :repl-options {:init-ns neovim-client.nvim}
-  ;; TODO: remove this
-  ;;:jvm-opts ["-Dclojure.server.repl={:port 5555 :accept clojure.core.server/repl}"]
   :main ^:skip-aot neovim-client.socket-repl-plugin
   :target-path "target/%s"
   :profiles {:uberjar {:aot :all}})

socket-repl-plugin/.classpath

@@ -0,0 +1 @@
+/home/jeb/source/neovim-client/socket-repl-plugin/test:/home/jeb/source/neovim-client/socket-repl-plugin/src:/home/jeb/source/neovim-client/socket-repl-plugin/dev-resources:/home/jeb/source/neovim-client/socket-repl-plugin/resources:/home/jeb/source/neovim-client/socket-repl-plugin/target/base+system+user+dev/classes:/home/jeb/source/neovim-client/socket-repl-plugin/checkouts/neovim-client/src:/home/jeb/source/neovim-client/socket-repl-plugin/checkouts/neovim-client/test:/home/jeb/source/neovim-client/socket-repl-plugin/checkouts/neovim-client/dev-resources:/home/jeb/source/neovim-client/socket-repl-plugin/checkouts/neovim-client/resources:/home/jeb/source/neovim-client/socket-repl-plugin/checkouts/neovim-client/target/base+system+user+dev/classes:/home/jeb/.m2/repository/clojure-complete/clojure-complete/0.2.3/clojure-complete-0.2.3.jar:/home/jeb/.m2/repository/org/clojure-grimoire/lib-grimoire/0.6.4/lib-grimoire-0.6.4.jar:/home/jeb/.m2/repository/org/tcrawley/dynapath/0.2.3/dynapath-0.2.3.jar:/home/jeb/.m2/repository/org/clojure/clojure/1.9.0-alpha12/clojure-1.9.0-alpha12.jar:/home/jeb/.m2/repository/ring/ring-codec/1.0.0/ring-codec-1.0.0.jar:/home/jeb/.m2/repository/org/clojure/tools.analyzer.jvm/0.6.10/tools.analyzer.jvm-0.6.10.jar:/home/jeb/.m2/repository/grimvim/grimvim/0.1.0/grimvim-0.1.0.jar:/home/jeb/.m2/repository/org/clojure/tools.analyzer/0.6.9/tools.analyzer-0.6.9.jar:/home/jeb/.m2/repository/log4j/log4j/1.2.16/log4j-1.2.16.jar:/home/jeb/.m2/repository/org/clojure/core.async/0.2.391/core.async-0.2.391.jar:/home/jeb/.m2/repository/com/taoensso/encore/1.8.1/encore-1.8.1.jar:/home/jeb/.m2/repository/clojure-msgpack/clojure-msgpack/1.0.0/clojure-msgpack-1.0.0.jar:/home/jeb/.m2/repository/io/aviso/pretty/0.1.12/pretty-0.1.12.jar:/home/jeb/.m2/repository/org/clojure/core.memoize/0.5.9/core.memoize-0.5.9.jar:/home/jeb/.m2/repository/clj-logging-config/clj-logging-config/1.9.12/clj-logging-config-1.9.12.jar:/home/jeb/.m2/repository/org/clojure/tools.namespace/0.2.7/tools.namespace-0.2.7.jar:/home/jeb/.m2/repository/org/clojure/tools.logging/0.3.1/tools.logging-0.3.1.jar:/home/jeb/.m2/repository/com/taoensso/timbre/3.3.1/timbre-3.3.1.jar:/home/jeb/.m2/repository/commons-codec/commons-codec/1.6/commons-codec-1.6.jar:/home/jeb/.m2/repository/org/ow2/asm/asm-all/4.2/asm-all-4.2.jar:/home/jeb/.m2/repository/version-clj/version-clj/0.1.0/version-clj-0.1.0.jar:/home/jeb/.m2/repository/org/clojure/data.priority-map/0.0.7/data.priority-map-0.0.7.jar:/home/jeb/.m2/repository/ring-mock/ring-mock/0.1.5/ring-mock-0.1.5.jar:/home/jeb/.m2/repository/neovim-client/neovim-client/0.1.0-SNAPSHOT/neovim-client-0.1.0-SNAPSHOT.jar:/home/jeb/.m2/repository/org/clojure/tools.nrepl/0.2.10/tools.nrepl-0.2.10.jar:/home/jeb/.m2/repository/org/clojure/core.cache/0.6.5/core.cache-0.6.5.jar:/home/jeb/.m2/repository/org/clojure/tools.reader/0.8.8/tools.reader-0.8.8.jar:/home/jeb/.m2/repository/cider/cider-nrepl/0.10.0-SNAPSHOT/cider-nrepl-0.10.0-SNAPSHOT.jar

socket-repl-plugin/TODO

@@ -10,14 +10,12 @@ TODO alpha
 			show the contents of the temp file in the current buffer
 			make it autoread
 	[X] Name vim functions correctly
-	[_] create prod & debug plugin.vim
-		both should start the plugin the same way, w/ 
-		a bash script that specifies JVM options
-		eliminate lein
-		don't use a jar yet, just java -cp clojure.jar <clj-file> if possible
-	[_] add debug switch (var) to socket-repl-plugin.clj
+	[X] create prod & debug plugin.vim
+	[X] add debug switch (var) to socket-repl-plugin.clj
 	[_] implement doc (word under cursor)
 	[_] Pass host, port in connect
+	[_] Update README
+		Move NVIM_LISTEN... stuff to a debug section
 
 TODO final
 	[_] Rather than explicit repl output logging, can we intercept
@@ -47,21 +45,28 @@ Goals
 		Accessible from vim buffer `:call ShowClojurePluginRepl()`
 	-Not a way of life
 		Does not include paredit, syntax highlight, etc
+	-Architecture Diagram
+		nvim <--msgpack/stdio--> plugin (jar) <--localhost:5555--> socket repl
 
 Questions
 	Figwheel cljs-repl support
 
 Usage/Installation
-	if we ship jar, should be no install steps
+	no other install outside of normal plugin (pathogen, vundle, etc)
+		** except the rtp thing **
 	add command line args to your project, so it starts socket repl
-	on :Connect specify port (and host) to connect to
+		-Dclojure.server.repl="{:port 5555 :accept clojure.core.server/repl}"
+	on `:Connect` specify port (and host) to connect to
+	split a pane, `:ReplLog`
 
 Debugging notes
 	vim
-		rpcrequest(1, ...) <-- use channel 1, w/ tcp
-		don't do rpcstart
+		start vim w/ NVIM_LISTEN_ADDRESS
+		`:so` plugin/socket-repl.vim.debug script
 	clj
-		connect! add localhost 7777
-		vim blocks if you make a synchronous call to clj which makes a sync
-		call back to vim -- use async!
+		start plugin w/ `run.sh`
+			this also starts a socket repl on 5555
+		note: use async!
+		: vim blocks if you make a synchronous call to clj which makes a sync
+		: call back to vim -- use async!
 

socket-repl-plugin/deploy-local.sh

@@ -0,0 +1,5 @@
+lein uberjar
+cp target/uberjar/socket-repl-plugin-0.1.0-SNAPSHOT-standalone.jar .
+rm -rf ~/.vim/bundle/neovim-client
+cd ../..
+cp -rf neovim-client ~/.vim/bundle

socket-repl-plugin/plugin/socketrepl.vim

@@ -8,38 +8,38 @@ function! StartIfNotRunning()
         "TODO - This is a dirty hack. We should launch things without changing
         "the working directory.
         exec ':cd ' . s:p_dir
-        let g:channel = rpcstart('lein', ['run'])
+        exec ':cd ..'
+        let g:channel = rpcstart('java', ['-jar', 'socket-repl-plugin-0.1.0-SNAPSHOT-standalone.jar'])
         let g:is_running = 1
     endif
 endfunction
 
 function! Connect()
-    "call StartIfNotRunning()
-    let res = rpcrequest(1, 'connect', [])
+    call StartIfNotRunning()
+    let res = rpcrequest(g:channel, 'connect', [])
     return res
 endfunction
 command! Connect call Connect()
 
 function! EvalBuffer()
-    "call StartIfNotRunning()
-    let res = rpcrequest(1, 'eval-buffer', [])
+    call StartIfNotRunning()
+    let res = rpcrequest(g:channel, 'eval-buffer', [])
     return res
 endfunction
 command! EvalBuffer call EvalBuffer()
 
 function! EvalCode()
-    "call StartIfNotRunning()
-    "let res = rpcrequest(g:channel, 'eval-code', [])
-    let res = rpcrequest(1, 'eval-code', [])
+    call StartIfNotRunning()
+    let res = rpcrequest(g:channel, 'eval-code', [])
     return res
 endfunction
 command! EvalCode call EvalCode()
 
 function! ReplLog()
-    "call StartIfNotRunning()
-    let res = rpcrequest(1, 'show-log', [])
+    call StartIfNotRunning()
+    let res = rpcrequest(g:channel, 'show-log', [])
     return res
 endfunction
 command! ReplLog call ReplLog()
 
-echo 'socket repl plugin loaded!'
+echo 'prod socket repl plugin loaded!'

socket-repl-plugin/plugin/socketrepl.vim.debug

@@ -0,0 +1,28 @@
+let g:is_running = 0
+let g:channel = -1
+
+function! Connect()
+    let res = rpcrequest(1, 'connect', [])
+    return res
+endfunction
+command! Connect call Connect()
+
+function! EvalBuffer()
+    let res = rpcrequest(1, 'eval-buffer', [])
+    return res
+endfunction
+command! EvalBuffer call EvalBuffer()
+
+function! EvalCode()
+    let res = rpcrequest(1, 'eval-code', [])
+    return res
+endfunction
+command! EvalCode call EvalCode()
+
+function! ReplLog()
+    let res = rpcrequest(1, 'show-log', [])
+    return res
+endfunction
+command! ReplLog call ReplLog()
+
+echo 'debug socket repl plugin loaded!'

socket-repl-plugin/run.sh

@@ -0,0 +1,20 @@
+# Development run script.
+
+if [[ ! -e project.clj ]]; then
+    echo "This script must be run from the top-level"
+    exit 1
+fi
+
+# Generate .classpath from Leiningen if project.clj has changed.
+if [[ project.clj -nt .classpath ]]; then
+    lein classpath > .classpath
+fi
+
+# Use server-daemon false, so socket repl server thread will block exit.
+exec java \
+     -cp "$(cat .classpath)" \
+     -Djava.awt.headless=true \
+     -Dclojure.server.repl="{:port 5555 :accept clojure.core.server/repl :server-daemon false}" \
+     -XX:-OmitStackTraceInFastThrow \
+     clojure.main \
+     ./src/socket_repl/socket_repl_plugin.clj --debug true

socket-repl-plugin/socket-repl-plugin-0.1.0-SNAPSHOT-standalone.jar

@@ -8,7 +8,8 @@
     [neovim-client.nvim :as nvim])
   (:import
     (java.net Socket)
-    (java.io PrintStream File)))
+    (java.io PrintStream File))
+  (:gen-class))
 
 (def current-connection (atom nil))
 
@@ -70,6 +71,11 @@
   [string]
   (write-output @current-connection string))
 
+(defn update-last!
+  "Update the last accessed time."
+  []
+  (swap! current-connection assoc :last (System/currentTimeMillis)))
+
 (defn connect!
   "Connect to a socket repl. Adds the connection to the `current-connection`
   atom. Creates `go-loop`s to delegate input from the socket to `handler` one
@@ -85,7 +91,8 @@
                    :handler handler
                    :chan chan
                    :file file
-                   :file-stream (PrintStream. file)))
+                   :file-stream (PrintStream. file)
+                   :last (System/currentTimeMillis)))
 
     ;; input producer
     (go-loop []
@@ -100,14 +107,16 @@
                (recur))))
   "success")
 
-(defn -main
-  [& args]
-  ;; TODO: remove params for STDIO
-  (nvim/connect! "localhost" 7777)
+(defn start
+  [debug]
+  (if debug
+    (nvim/connect! "localhost" 7777)
+    (nvim/connect!))
 
   (nvim/register-method!
     "connect"
     (fn [msg]
+      (update-last!)
       ;; TODO: Get host/port from message
       (connect! "localhost" "5555"
                 (fn [x]
@@ -118,6 +127,7 @@
    (nvim/register-method!
      "eval-code"
      (fn [msg]
+       (update-last!)
        (nvim/get-cursor-location-async
          (fn [coords]
            (nvim/get-current-buffer-text-async
@@ -137,6 +147,7 @@
    (nvim/register-method!
      "eval-buffer"
      (fn [msg]
+       (update-last!)
        (nvim/get-current-buffer-text-async
          (fn [x]
            (write-output! (str x "\n"))
@@ -145,7 +156,7 @@
    (nvim/register-method!
      "show-log"
      (fn [msg]
-
+       (update-last!)
        (nvim/run-command-async!
          (format ":term tail -f %s" (-> @current-connection
                                         :file
@@ -162,14 +173,19 @@
              ":set updatetime=500 | au CursorHold <buffer> :e!"
              (fn [_] nil))))))
 
-  ;; TODO: Rather than an arbitrary timeout, the plugin should shut down
-  ;; when it has received no input for some time.
-  (comment
-    (dotimes [n 60]
-      (if (= 0 (mod n 10))
-        (nvim/run-command! (str ":echo 'plugin alive for " n " seconds.'")))
-      (Thread/sleep 1000))
+  ;; Don't need to do this in debug, socket repl will keep this alive.
+  (when-not debug
+    (loop []
+      (Thread/sleep 30000)
+      (let [elapsed-msec (- (System/currentTimeMillis)
+                            (:last @current-connection))]
+        (when (< elapsed-msec 60000)
+          (recur))))
 
     ;; Let nvim know we're shutting down.
     (nvim/run-command! ":let g:is_running=0")
     (nvim/run-command! ":echo 'plugin stopping.'")))
+
+(defn -main
+  [& args]
+  (start false))

socket-repl-plugin/src/socket_repl/socket_repl_plugin.clj

@@ -0,0 +1,8 @@
+(ns user
+  (:require
+    [socket-repl.socket-repl-plugin :as plugin]))
+
+(defn go
+  "Start the plugin."
+  []
+  (plugin/start true))