feat: Add new question to skip or retry classpath scan during startup if failed

Author: ericdallo

CHANGELOG.md

@@ -28,6 +28,7 @@
   - Add refactoring `Restructure keys`, the inverse of `Destructure keys`. #1170
   - Add refactorings to convert between `(:x m)` and `(get m :x)` or `(:y (:x m))` and `(get-in m [:x :y])`. #1172
   - Add support to imported java class on completion. #1193
+  - Add new question to skip or retry classpath scan during startup if failed. 
 
 ## 2022.07.24-18.25.43
 

cli/src/clojure_lsp/server.clj

@@ -126,7 +126,8 @@
                           :actions actions}
                          (conform-or-log ::coercer/show-message-request)
                          (lsp.server/send-request server "window/showMessageRequest"))
-            response (lsp.server/deref-or-cancel request 10e3 ::timeout)]
+            ;; High timeout as we probably want to wait some time for user input
+            response (lsp.server/deref-or-cancel request 10e5 ::timeout)]
         (when-not (= response ::timeout)
           (:title response)))))
 

lib/src/clojure_lsp/classpath.clj

@@ -72,17 +72,34 @@
         {:command command
          :error (.getMessage e)}))))
 
+(defn ^:private lookup-classpath-handling-error! [project-spec root-path producer]
+  (let [{:keys [command error paths]} (lookup-classpath! root-path project-spec)
+        retry-action "Retry"
+        ignore-action "Ignore"]
+    (if error
+      (do
+        (logger/error (format "Error while looking up classpath info in %s. Error: %s" (str root-path) error))
+        (if-let [chosen-action (producer/show-message-request
+                                 producer
+                                 (format (str "LSP classpath lookup failed when running `%s`. Some features may not work properly if ignored.\n\n"
+                                              "Error: %s\n\nChoose an option:") command error)
+                                 :warning
+                                 [{:title retry-action}
+                                  {:title ignore-action}])]
+          (if (= retry-action chosen-action)
+            (recur project-spec root-path producer)
+            (do
+              (logger/warn (format "Classpath lookup retry skipped by user"))
+              paths))
+          (logger/warn (format "Invalid classpath lookup option, skipping lookup"))))
+      paths)))
+
 (defn scan-classpath! [{:keys [db* producer]}]
   (let [db @db*
         root-path (shared/uri->path (:project-root-uri db))]
     (->> (settings/get db [:project-specs])
          (filter (partial valid-project-spec? root-path))
-         (map #(lookup-classpath! root-path %))
-         (map (fn [{:keys [command error paths]}]
-                (when error
-                  (logger/error (format "Error while looking up classpath info in %s. Error: %s" (str root-path) error))
-                  (producer/show-message producer (format "Classpath lookup failed when running `%s`. Some features may not work properly. Error: %s" command error) :error error))
-                paths))
+         (mapv #(lookup-classpath-handling-error! % root-path producer))
          (reduce set/union))))
 
 (defn ^:private classpath-cmd->windows-safe-classpath-cmd

lib/src/clojure_lsp/crawler.clj

@@ -223,7 +223,6 @@
               (analyze-external-classpath! root-path (-> @db* :settings :source-paths) classpath progress-token components))
             (logger/info "Caching db for next startup...")
             (upsert-db-cache! @db*))))
-
       (publish-task-progress producer (:resolving-config task-list) progress-token)
       (when-let [classpath-settings (and (config/classpath-config-paths? settings)
                                          (:classpath @db*)