orchard.java: add *analyze-sources* dynamic var (#212)

vemv · web-flow · commit 19ababb55574 · 2023-11-11T21:14:37.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## master (unreleased)
 
+## New features
+
+* `orchard.java`: add `*analyze-sources*` dynamic var.
+  * You can bind this to `false` in order to increase performance / decrease the amount of information returned.
+
 ## 0.19.0 (2023-11-04)
 
 ## New features
diff --git a/project.clj b/project.clj
@@ -84,7 +84,7 @@
                                          `add-cognitest)]}
 
              ;; Development tools
-             :dev {:plugins [[cider/cider-nrepl "0.41.0"]
+             :dev {:plugins [[cider/cider-nrepl "0.43.1"]
                              [refactor-nrepl "3.9.0"]]
                    :dependencies [[nrepl/nrepl "1.0.0"]
                                   [org.clojure/tools.namespace "1.4.4"]]
diff --git a/src/orchard/java.clj b/src/orchard/java.clj
@@ -312,6 +312,12 @@
                    ;; for dynamically loaded classes:
                    :reflector (JavaReflector. (.getClassLoader c))))
 
+(def ^:dynamic *analyze-sources*
+  "Whether to analyze .java sources in addition to reflection-gathered info.
+
+  Bind this to `false` in order to increase performance / decrease the amount of information returned."
+  true)
+
 (defn class-info*
   "For the class symbol, return Java class and member info. Members are indexed
   first by name, and then by argument types to list all overloads."
@@ -321,7 +327,8 @@
                            (catch LinkageError _))]
     (let [package (some-> c package symbol)
           {:keys [members] :as result} (misc/deep-merge (reflect-info (reflection-for c))
-                                                        (source-info class)
+                                                        (when *analyze-sources*
+                                                          (source-info class))
                                                         {:name       (-> c .getSimpleName symbol)
                                                          :class      (-> c .getName symbol)
                                                          :package    package
@@ -378,7 +385,11 @@
         info (if (and cached stale)
                (class-info* class)
                info)]
-    (when (or (not cached) stale)
+    (when (and
+           ;; Only cache full values that possibly were slowly computed.
+           ;; It would be a mistake to cache the fast values, letting them shadow a full computation:
+           *analyze-sources*
+           (or (not cached) stale))
       (.put cache class {:info info, :last-modified last-modified}))
     info))
 
diff --git a/test/orchard/java_test.clj b/test/orchard/java_test.clj
@@ -528,3 +528,13 @@
             (is (not (string/includes? s "^function.Function java.util.function.Function")))
             (is (not (string/includes? s "^java.util.function.Function java.util.function.Function")))
             (assert (is (not (string/includes? s "java.lang"))))))))))
+
+(when (and util/has-enriched-classpath?
+           @@sut/parser-next-available?)
+  (deftest *analyze-sources*-test
+    (with-redefs [cache (LruMap. 100)]
+      (binding [sut/*analyze-sources* false]
+        (is (nil? (:doc (sut/resolve-symbol 'user `Thread/activeCount)))
+            "Binding this var to `false` results in source info being omitted"))
+      (is (seq (:doc (sut/resolve-symbol 'user `Thread/activeCount)))
+          "Subsequent calls aren't affected, since there's no caching interference"))))
