Prototype unit tests

Author: jebberjeb

TODO

@@ -1,5 +1,51 @@
-global-state
-	[X] finish refactoring nvim, rpc
-	[X] from debug session, stop, then start (restart) should work
-	[X] make sure sample plugins still work
-	[_] clojure socket repl plugin refactor
+Versioning
+	re: https://github.com/neovim/neovim/pull/5535
+	re: https://github.com/neovim/neovim/pull/5386
+
+	[_] an we start writing tests for these things?
+		[X] We'd have to start an nvim --embed, and maybe specify the NVIM_... ? 
+		[X] Then, we connect
+		[X] Test version validation
+		[_] Integration test
+			-insert some text in current buffer
+			-command split the a new buffer put some stuff in it
+			-command switch back to the original buffer
+			-get the text of current buffer
+
+		Tough to figure out exactly how to test against multiple version of
+		Neovim's API. For now, let's just do this basic test, and document
+		the version of Neovim used.
+
+	Following the philosophy described above, we need
+		[_] Make the user specify required API level on `connect`
+
+		[_] Change the api to one function `exec`, pass the op as the first
+		arg, and then use varargs, or a collection of args.
+			Implementing `exec` and `exec-async` should include
+			version-supported? check, maybe assume nvim_command will always
+			be supported.
+
+		[_] On `connect`, intern dynamically created functions similar to the
+		macros we use now.
+
+		[_] Change the existing samples to use this, maybe only support one
+		sample.
+
+		[_] Make a `doc` function that basically does `ns-publics`
+
+		[_] Update the docs, including video?
+			In terms of the docs, we'll take a similar approach that other
+			AWS client libs have taken, we'll steer them heavily toward
+			the *actual* docs, and using `nvim-get-api-info`.
+
+		[_] Tag the existing version, bump the version (project & github),
+		and release.
+
+	Why aren't we doing anything statically?
+		Although I'd prefer actual functions in source code, I don't like
+			That I'd have to change code when they version the API
+			But, more importantly, since the api_level supports a range of
+			levels, I'd either
+				have to support side-by-side versions
+					but that would be easy with codegen & ns2, ns3, etc.
+				make patches to all versions, if version by api-level

src/neovim_client/nvim.clj

@@ -7,6 +7,9 @@
   (:import (java.net Socket)
            (com.etsy.net UnixDomainSocketClient JUDS)))
 
+(declare exec)
+(declare exec-async)
+
 (defmacro defvim
   [fn-name vim-command & args]
   `(do
@@ -117,27 +120,38 @@
 (def register-method! rpc/register-method!)
 (def stop rpc/stop)
 
+(defn version-supported?
+  [component]
+  (let [desired-version (:version component)
+        [channel api-info] @(:api-info component)
+        {:strs [version]} api-info
+        {:strs [api_prerelease api_level api_compatible]} version
+        min-version api_compatible
+        max-version (if api_prerelease (dec api_level) api_level)]
+    (<= min-version desired-version max-version)))
+
 (defn new*
-  [input output update-nvim-channel?]
+  [version input output update-nvim-channel?]
   (let [component (rpc/new input output)]
     ;; Each time you connect to the same nvim instance using a socket, nvim
     ;; allocates a new channel.
-    (when update-nvim-channel?
-      (async/thread
-        (let [api-info (vim-get-api-info component)]
+    (async/thread
+      (let [api-info (vim-get-api-info component)]
+        (deliver (:api-info component) api-info)
+        (when update-nvim-channel?
           (vim-command component (format "let g:nvim_tcp_plugin_channel = %s"
                                          (first api-info))))))
-    component))
+    (assoc component :version version)))
 
 (defn new
   "Connect to msgpack-rpc channel via standard io, TCP socket, Unix domain
   sockets."
-  ([] (new* System/in System/out true))
-  ([uds-filepath]
+  ([version] (new* version System/in System/out true))
+  ([version uds-filepath]
    (let [socket (UnixDomainSocketClient. uds-filepath JUDS/SOCK_STREAM)]
-     (new* (.getInputStream socket) (.getOutputStream socket) true)))
-  ([host port]
+     (new* version (.getInputStream socket) (.getOutputStream socket) true)))
+  ([version host port]
    (log/info "plugin host connecting to nvim at " host ":" port)
    (let [socket (java.net.Socket. host port)]
      (.setTcpNoDelay socket true)
-     (new* (.getInputStream socket) (.getOutputStream socket) true))))
+     (new* version (.getInputStream socket) (.getOutputStream socket) true))))

src/neovim_client/rpc.clj

@@ -82,7 +82,9 @@
         input-stream (DataInputStream. input-stream)
         message-table (atom {})
         method-table (atom {})
-        component {:input-stream input-stream
+        component {:version nil
+                   :api-info (promise)
+                   :input-stream input-stream
                    :output-stream output-stream
                    :out-chan (create-output-channel output-stream) 
                    :in-chan in-chan