Add compatibility with nREPL 0.4 (#540)

Support with tools.nrepl is kept for now with the assumption
that tools.nrepl namespaces would be loaded automatically by
`lein repl` or `boot repl`.

Support for tools.nrepl will likely be removed after a couple of
releases (once mainstream Lein and Boot switch to nREPL 0.4).

Author: bbatsov

README.md

@@ -182,7 +182,7 @@ You can easily boot an nREPL server with the CIDER middleware loaded
 with the following "magic" incantation:
 
 ```
-clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.18.0-SNAPSHOT"} }}' -e '(require (quote cider-nrepl.main)) (cider-nrepl.main/init ["cider.nrepl/cider-middleware"])'
+clj -Sdeps '{:deps {cider/cider-nrepl {:mvn/version "0.19.0-SNAPSHOT"} }}' -e '(require (quote cider-nrepl.main)) (cider-nrepl.main/init ["cider.nrepl/cider-middleware"])'
 ```
 
 Note that `clj` was introduced in Clojure 1.9.
@@ -194,7 +194,7 @@ server with CIDER's own nREPL handler.
 
 ```clojure
 (ns my-app
-  (:require [clojure.tools.nrepl.server :as nrepl-server]))
+  (:require [nrepl.server :as nrepl-server]))
 
 (defn nrepl-handler []
   (require 'cider.nrepl)

project.clj

@@ -6,7 +6,7 @@
   :license {:name "Eclipse Public License"
             :url "http://www.eclipse.org/legal/epl-v10.html"}
 
-  :dependencies [[org.clojure/tools.nrepl "0.2.13"]
+  :dependencies [[nrepl "0.4.4"]
                  ^:source-dep [cider/orchard "0.3.0"]
                  ^:source-dep [thunknyc/profile "0.5.2"]
                  ^:source-dep [mvxcvi/puget "1.0.2"]

src/cider/nrepl.clj

@@ -1,13 +1,24 @@
 (ns cider.nrepl
-  (:require [clojure.tools.nrepl.middleware :refer [set-descriptor!]]
-            [clojure.tools.nrepl.middleware.session :refer [session]]
-            [clojure.tools.nrepl.middleware.pr-values :refer [pr-values]]
-            [clojure.tools.nrepl.server :as nrepl-server]
-            [cider.nrepl.version :as version]
+  (:require [cider.nrepl.version :as version]
             [cider.nrepl.middleware.util.cljs :as cljs]
             [cider.nrepl.middleware.pprint :as pprint]
             [cider.nrepl.print-method]))
 
+;; Compatibility with the legacy tools.nrepl and the new nREPL 0.4.x.
+;; The assumption is that if someone is using old lein repl or boot repl
+;; they'll end up using the tools.nrepl, otherwise the modern one.
+(if (find-ns 'clojure.tools.nrepl)
+  (require
+   '[clojure.tools.nrepl.middleware :refer [set-descriptor!]]
+   '[clojure.tools.nrepl.middleware.session :refer [session]]
+   '[clojure.tools.nrepl.middleware.pr-values :refer [pr-values]]
+   '[clojure.tools.nrepl.server :as nrepl-server])
+  (require
+   '[nrepl.middleware :refer [set-descriptor!]]
+   '[nrepl.middleware.session :refer [session]]
+   '[nrepl.middleware.pr-values :refer [pr-values]]
+   '[nrepl.server :as nrepl-server]))
+
 (def delayed-handlers
   "Map of `delay`s holding deferred middleware handlers."
   (atom {}))

src/cider/nrepl/middleware/content_type.clj

@@ -43,13 +43,19 @@
   [4] https://tools.ietf.org/html/rfc2017"
   {:authors ["Reid 'arrdem' McKenzie <[email protected]>"]}
   (:require [cider.nrepl.middleware.slurp :refer [slurp-reply]])
-  (:import clojure.tools.nrepl.transport.Transport
-           java.awt.Image
+  (:import java.awt.Image
            [java.io ByteArrayOutputStream File OutputStream]
            [java.net URI URL]
            java.nio.file.Path
            javax.imageio.ImageIO))
 
+;; Compatibility with the legacy tools.nrepl and the new nREPL 0.4.x.
+;; The assumption is that if someone is using old lein repl or boot repl
+;; they'll end up using the tools.nrepl, otherwise the modern one.
+(if (find-ns 'clojure.tools.nrepl)
+  (import 'clojure.tools.nrepl.transport.Transport)
+  (import 'nrepl.transport.Transport))
+
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 
 (defprotocol URLCoercable
@@ -80,7 +86,7 @@
   [{:keys [session value] :as response}]
   (cond
     ;; FIXME (arrdem 2018-04-03):
-    ;; 
+    ;;
     ;;   This could be more generic in terms of tolerating more
     ;;   protocols / schemes
 
@@ -96,7 +102,7 @@
            :body "")
 
     ;; FIXME (arrdem 2018-04-03):
-    ;; 
+    ;;
     ;;   This is super snowflakey in terms of only supporting base64
     ;;   coding this one kind of object.  This could definitely be
     ;;   more generic / open to extension but hey at least it's

src/cider/nrepl/middleware/debug.clj

@@ -10,13 +10,24 @@
             [cider.nrepl.middleware.util.instrument :as ins]
             [orchard.misc :as misc]
             [orchard.meta :as m]
-            [clojure.java.io :as io]
-            [clojure.tools.nrepl.middleware.interruptible-eval :refer [*msg*]]
-            [clojure.tools.nrepl.misc :refer [response-for]]
-            [clojure.tools.nrepl.middleware.session :as session]
-            [clojure.tools.nrepl.transport :as transport])
+            [clojure.java.io :as io])
   (:import [clojure.lang Compiler$LocalBinding]))
 
+;; Compatibility with the legacy tools.nrepl and the new nREPL 0.4.x.
+;; The assumption is that if someone is using old lein repl or boot repl
+;; they'll end up using the tools.nrepl, otherwise the modern one.
+(if (find-ns 'clojure.tools.nrepl)
+  (require
+   '[clojure.tools.nrepl.middleware.interruptible-eval :refer [*msg*]]
+   '[clojure.tools.nrepl.middleware.session :as session]
+   '[clojure.tools.nrepl.misc :refer (response-for)]
+   '[clojure.tools.nrepl.transport :as transport])
+  (require
+   '[nrepl.middleware.interruptible-eval :refer [*msg*]]
+   '[nrepl.middleware.session :as session]
+   '[nrepl.misc :refer (response-for)]
+   '[nrepl.transport :as transport]))
+
 ;;;; # The Debugger
 ;;;
 ;;; The debugger is divided into two parts, instrument.clj and

src/cider/nrepl/middleware/inspect.clj

@@ -3,9 +3,24 @@
             [cider.nrepl.middleware.util.error-handling :refer [base-error-response]]
             [orchard.inspect :as inspect]
             [orchard.misc :as u]
-            [clojure.tools.nrepl.misc :refer [response-for]]
-            [clojure.tools.nrepl.transport :as transport])
-  (:import clojure.tools.nrepl.transport.Transport))
+            [nrepl.misc :refer [response-for]]
+            [nrepl.transport :as transport])
+  (:import nrepl.transport.Transport))
+
+;; Compatibility with the legacy tools.nrepl and the new nREPL 0.4.x.
+;; The assumption is that if someone is using old lein repl or boot repl
+;; they'll end up using the tools.nrepl, otherwise the modern one.
+(if (find-ns 'clojure.tools.nrepl)
+  (do
+    (require
+     '[clojure.tools.nrepl.misc :refer [response-for]]
+     '[clojure.tools.nrepl.transport :as transport])
+    (import 'clojure.tools.nrepl.transport.Transport))
+  (do
+    (require
+     '[nrepl.misc :refer [response-for]]
+     '[nrepl.transport :as transport])
+    (import 'nrepl.transport.Transport)))
 
 (def ^:dynamic *inspector* (inspect/fresh))
 

src/cider/nrepl/middleware/out.clj

@@ -9,10 +9,15 @@
   We use an eval message, instead of the clone op, because there's no
   guarantee that the channel that sent the clone message will properly
   handle output replies."
-  (:require [cider.nrepl.middleware.util.error-handling :refer [with-safe-transport]]
-            [clojure.tools.nrepl.middleware.interruptible-eval :as ie])
+  (:require [cider.nrepl.middleware.util.error-handling :refer [with-safe-transport]])
   (:import [java.io PrintWriter Writer PrintStream OutputStream]))
 
+(if (find-ns 'clojure.tools.nrepl)
+  (require
+   '[clojure.tools.nrepl.middleware.interruptible-eval :as ieval])
+  (require
+   '[nrepl.middleware.interruptible-eval :as ieval]))
+
 (declare unsubscribe-session)
 
 (def original-output
@@ -29,7 +34,7 @@
                                              (case ~type
                                                :out #'*out*
                                                :err #'*err*))]
-       (try (binding [ie/*msg* ~'msg]
+       (try (binding [ieval/*msg* ~'msg]
               ~@body)
             ;; If a channel is faulty, dissoc it.
             (catch Exception ~'e

src/cider/nrepl/middleware/pprint.clj

@@ -1,13 +1,25 @@
 (ns cider.nrepl.middleware.pprint
   (:require [cider.nrepl.middleware.util.cljs :as cljs]
             [orchard.misc :as u]
-            [clojure.pprint :refer [pprint *print-right-margin*]]
-            [clojure.tools.nrepl.middleware.interruptible-eval :refer [*msg*]]
-            [clojure.tools.nrepl.middleware.pr-values :refer [pr-values]]
-            [clojure.tools.nrepl.middleware.session :as session]
-            [clojure.tools.nrepl.misc :refer [response-for]]
-            [clojure.tools.nrepl.transport :as transport])
-  (:import clojure.tools.nrepl.transport.Transport))
+            [clojure.pprint :refer [pprint *print-right-margin*]]))
+
+(if (find-ns 'clojure.tools.nrepl)
+  (do
+    (require
+     '[clojure.tools.nrepl.middleware.interruptible-eval :refer [*msg*]]
+     '[clojure.tools.nrepl.middleware.pr-values :refer [pr-values]]
+     '[clojure.tools.nrepl.middleware.session :as session]
+     '[clojure.tools.nrepl.misc :refer [response-for]]
+     '[clojure.tools.nrepl.transport :as transport])
+    (import 'clojure.tools.nrepl.transport.Transport))
+  (do
+    (require
+     '[nrepl.middleware.interruptible-eval :refer [*msg*]]
+     '[nrepl.middleware.pr-values :refer [pr-values]]
+     '[nrepl.middleware.session :as session]
+     '[nrepl.misc :refer [response-for]]
+     '[nrepl.transport :as transport])
+    (import 'nrepl.transport.Transport)))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 

src/cider/nrepl/middleware/profile.clj

@@ -14,10 +14,15 @@
   Based on older middleware (nrepl-profile) that's not actively
   maintained anymore."
   {:author "Edwin Watkeys"}
-  (:require [clojure.string :as s]
-            [profile.core :as p]
-            [clojure.tools.nrepl.transport :as t]
-            [clojure.tools.nrepl.misc :refer [response-for]]))
+  (:require [profile.core :as p]))
+
+(if (find-ns 'clojure.tools.nrepl)
+  (require
+   '[clojure.tools.nrepl.misc :refer [response-for]]
+   '[clojure.tools.nrepl.transport :as t])
+  (require
+   '[nrepl.misc :refer [response-for]]
+   '[nrepl.transport :as t]))
 
 (defn send-exception
   [e msg transport]

src/cider/nrepl/middleware/refresh.clj

@@ -11,10 +11,17 @@
             [clojure.tools.namespace.dir :as dir]
             [clojure.tools.namespace.find :as find]
             [clojure.tools.namespace.reload :as reload]
-            [clojure.tools.namespace.track :as track]
-            [clojure.tools.nrepl.middleware.interruptible-eval :refer [*msg*]]
-            [clojure.tools.nrepl.misc :refer [response-for]]
-            [clojure.tools.nrepl.transport :as transport]))
+            [clojure.tools.namespace.track :as track]))
+
+(if (find-ns 'clojure.tools.nrepl)
+  (require
+   '[clojure.tools.nrepl.middleware.interruptible-eval :refer [*msg*]]
+   '[clojure.tools.nrepl.misc :refer (response-for)]
+   '[clojure.tools.nrepl.transport :as transport])
+  (require
+   '[nrepl.middleware.interruptible-eval :refer [*msg*]]
+   '[nrepl.misc :refer (response-for)]
+   '[nrepl.transport :as transport]))
 
 (defonce ^:private refresh-tracker (agent (track/tracker)))