CLJS-2913: improvements to exception messages and printing

Author: mfikes

src/main/clojure/cljs/analyzer.cljc

@@ -692,6 +692,12 @@
                        screen location navigator history location
                        global process require module exports)))}))
 
+(defn- source-info->error-data
+  [{:keys [file line column]}]
+  {:clojure.error/source file
+   :clojure.error/line   line
+   :clojure.error/column column})
+
 (defn source-info
   ([env]
    (when (:line env)
@@ -716,6 +722,20 @@
   (doseq [handler *cljs-warning-handlers*]
     (handler warning-type env extra)))
 
+(defn- error-data
+  ([env phase]
+   (error-data env phase nil))
+  ([env phase symbol]
+   (merge (-> (source-info env) source-info->error-data)
+     {:clojure.error/phase phase}
+     (when symbol
+       {:clojure.error/symbol symbol}))))
+
+(defn- compile-syntax-error
+  [env msg symbol]
+  (ex-info nil (error-data env :compile-syntax-check symbol)
+    #?(:clj (RuntimeException. ^String msg) :cljs (js/Error. msg))))
+
 (defn error
   ([env msg]
    (error env msg nil))
@@ -729,14 +749,20 @@
   [ex]
   (= :cljs/analysis-error (:tag (ex-data ex))))
 
+(defn has-error-data?
+  #?(:cljs {:tag boolean})
+  [ex]
+  (contains? (ex-data ex) :clojure.error/phase))
+
 #?(:clj
    (defmacro wrapping-errors [env & body]
      `(try
         ~@body
         (catch Throwable err#
-          (if (analysis-error? err#)
-            (throw err#)
-            (throw (error ~env (.getMessage err#) err#)))))))
+          (cond
+            (has-error-data? err#) (throw err#)
+            (analysis-error? err#) (throw (ex-info nil (error-data ~env :compilation) err#))
+            :else (throw (ex-info nil (error-data ~env :compilation) (error ~env (.getMessage err#) err#))))))))
 
 ;; namespaces implicit to the inclusion of cljs.core
 (def implicit-nses '#{goog goog.object goog.string goog.array Math String})
@@ -1584,9 +1610,9 @@
 (defmethod parse 'if
   [op env [_ test then else :as form] name _]
   (when (< (count form) 3)
-    (throw (error env "Too few arguments to if")))
+    (throw (compile-syntax-error env "Too few arguments to if" 'if)))
   (when (> (count form) 4)
-   (throw (error env "Too many arguments to if")))
+    (throw (compile-syntax-error env "Too many arguments to if" 'if)))
   (let [test-expr (disallowing-recur (analyze (assoc env :context :expr) test))
         then-expr (allowing-redef (analyze (add-predicate-induced-tags env test) then))
         else-expr (allowing-redef (analyze env else))]
@@ -3698,32 +3724,41 @@
        (when (some? (find-ns-obj 'cljs.spec.alpha))
          @cached-var))))
 
+(defn- var->sym [var]
+  #?(:clj  (symbol (str (.-ns ^clojure.lang.Var var)) (str (.-sym ^clojure.lang.Var var)))
+     :cljs (.-sym var)))
+
 (defn- do-macroexpand-check
-  [form mac-var]
+  [env form mac-var]
   (when (not (-> @env/*compiler* :options :spec-skip-macros))
     (let [mchk #?(:clj (some-> (find-ns 'clojure.spec.alpha)
                        (ns-resolve 'macroexpand-check))
                 :cljs (get-macroexpand-check-var))]
     (when (some? mchk)
-      (mchk mac-var (next form))))))
+      (try
+        (mchk mac-var (next form))
+        (catch #?(:clj Throwable :cljs :default) e
+          (throw (ex-info nil (error-data env :macro-syntax-check (var->sym mac-var)) e))))))))
 
 (defn macroexpand-1*
   [env form]
   (let [op (first form)]
     (if (contains? specials op)
       (do
         (when (= 'ns op)
-          (do-macroexpand-check form (get-expander 'cljs.core/ns-special-form env)))
+          (do-macroexpand-check env form (get-expander 'cljs.core/ns-special-form env)))
         form)
       ;else
         (if-some [mac-var (when (symbol? op) (get-expander op env))]
           (#?@(:clj [binding [*ns* (create-ns *cljs-ns*)]]
                :cljs [do])
-            (do-macroexpand-check form mac-var)
+            (do-macroexpand-check env form mac-var)
             (let [form' (try
                           (apply @mac-var form env (rest form))
                           #?(:clj (catch ArityException e
-                                    (throw (ArityException. (- (.actual e) 2) (.name e))))))]
+                                    (throw (ArityException. (- (.actual e) 2) (.name e)))))
+                          (catch #?(:clj Throwable :cljs :default) e
+                            (throw (ex-info nil (error-data env :macroexpansion (var->sym mac-var)) e))))]
               (if #?(:clj (seq? form') :cljs (cljs-seq? form'))
                 (let [sym' (first form')
                       sym  (first form)]

src/main/clojure/cljs/analyzer/macros.clj

@@ -39,9 +39,10 @@
   `(try
      ~@body
      (catch :default err#
-       (if (cljs.analyzer/analysis-error? err#)
-         (throw err#)
-         (throw (cljs.analyzer/error ~env (.-message err#) err#))))))
+       (cond
+         (cljs.analyzer/has-error-data? err#) (throw err#)
+         (cljs.analyzer/analysis-error? err#) (throw (ex-info nil (cljs.analyzer/error-data ~env :compilation) err#))
+         :else (throw (ex-info nil (cljs.analyzer/error-data ~env :compilation) (cljs.analyzer/error ~env (.getMessage err#) err#)))))))
 
 (defmacro disallowing-recur [& body]
   `(cljs.core/binding [cljs.analyzer/*recur-frames*

src/main/clojure/cljs/closure.clj

@@ -86,15 +86,17 @@
         _      (when (nil? ns)
                  (throw
                    (ex-info (str kw " symbol " sym " is not fully qualified")
-                     (merge ex-data {kw sym}))))
+                     (merge ex-data {kw sym
+                                     :clojure.error/phase :compilation}))))
         var-ns (symbol ns)]
     (when (not (find-ns var-ns))
       (try
         (locking ana/load-mutex
           (require var-ns))
         (catch Throwable t
           (throw (ex-info (str "Cannot require namespace referred by " kw " value " sym)
-                   (merge ex-data {kw sym})
+                   (merge ex-data {kw sym
+                                   :clojure.error/phase :compilation})
                    t)))))
 
     (find-var sym)))
@@ -227,7 +229,7 @@
       (ex-info
         (str "Invalid :closure-output-charset " charset " given, only "
              (string/join ", " (keys string->charset)) " supported ")
-        {}))))
+        {:clojure.error/phase :compilation}))))
 
 (defn ^CompilerOptions$LanguageMode lang-key->lang-mode [key]
   (case (keyword (string/replace (name key) #"^es" "ecmascript"))
@@ -261,7 +263,7 @@
           :off AnonymousFunctionNamingPolicy/OFF
           :unmapped AnonymousFunctionNamingPolicy/UNMAPPED
           :mapped AnonymousFunctionNamingPolicy/MAPPED
-          (throw (IllegalArgumentException. (str "Invalid :anon-fn-naming-policy value " policy " - only :off, :unmapped, :mapped permitted")))))))
+          (throw (util/compilation-error (IllegalArgumentException. (str "Invalid :anon-fn-naming-policy value " policy " - only :off, :unmapped, :mapped permitted"))))))))
 
   (when-let [lang-key (:language-in opts :ecmascript5)]
     (.setLanguageIn compiler-options (lang-key->lang-mode lang-key)))
@@ -369,8 +371,8 @@
   [{:keys [externs use-only-custom-externs target ups-externs infer-externs] :as opts}]
   (let [validate (fn validate [p us]
                    (if (empty? us)
-                     (throw (IllegalArgumentException.
-                              (str "Extern " p " does not exist")))
+                     (throw (util/compilation-error (IllegalArgumentException.
+                                                      (str "Extern " p " does not exist"))))
                      us))
         filter-cp-js (fn [paths]
                        (for [p paths
@@ -413,7 +415,7 @@
       (doseq [next (seq warnings)]
         (println "WARNING:" (.toString ^JSError next)))
       (when (seq errors)
-        (throw (Exception. "Closure compilation failed"))))))
+        (throw (util/compilation-error (Exception. "Closure compilation failed")))))))
 
 ;; Protocols for IJavaScript and Compilable
 ;; ========================================
@@ -876,10 +878,11 @@
                                    (io/resource relpath)))]
                  {:relative-path relpath :uri js-res :ext :js}
                  (throw
-                   (IllegalArgumentException.
-                     (str "Namespace " ns " does not exist."
-                          (when (string/includes? ns "-")
-                            " Please check that namespaces with dashes use underscores in the ClojureScript file name.")))))))))))))
+                   (util/compilation-error
+                     (IllegalArgumentException.
+                       (str "Namespace " ns " does not exist."
+                         (when (string/includes? ns "-")
+                           " Please check that namespaces with dashes use underscores in the ClojureScript file name."))))))))))))))
 
 (defn cljs-dependencies
   "Given a list of all required namespaces, return a list of
@@ -1284,8 +1287,8 @@
                           (swap! used into entries)
                           (into ret unused))
                         (throw
-                          (IllegalArgumentException.
-                            (str "Could not find matching namespace for " entry-sym)))))
+                          (util/compilation-error (IllegalArgumentException.
+                                                    (str "Could not find matching namespace for " entry-sym))))))
                     [] entries)
                   foreign-deps (atom [])]
               ;; add inputs to module
@@ -1304,8 +1307,8 @@
                     (when (:verbose opts)
                       (util/debug-prn "  module" name "depends on" dep))
                     (.addDependency js-module ^JSModule parent-module))
-                  (throw (IllegalArgumentException.
-                           (str "Parent module " dep " does not exist")))))
+                  (throw (util/compilation-error (IllegalArgumentException.
+                                                   (str "Parent module " dep " does not exist"))))))
               (conj ret
                 [name (assoc module-desc
                         :closure-module js-module
@@ -2052,7 +2055,7 @@
           (deps/-closure-lib? js)
           (deps/-foreign? js)))
     (catch Throwable t
-      (throw (Exception. (str "Could not write JavaScript " (pr-str js)))))))
+      (throw (util/compilation-error (Exception. (str "Could not write JavaScript " (pr-str js))))))))
 
 (defn source-on-disk
   "Ensure that the given IJavaScript exists on disk in the output directory.
@@ -2160,8 +2163,8 @@
                                   (:url-min ijs))
                              (:url ijs))]
               (slurp url)
-              (throw (IllegalArgumentException.
-                       (str "Foreign lib " ijs " does not exist")))))]
+              (throw (util/compilation-error (IllegalArgumentException.
+                                               (str "Foreign lib " ijs " does not exist"))))))]
     (str (string/join "\n" (map to-js-str sources)) "\n")))
 
 (defn add-wrapper [{:keys [output-wrapper] :as opts} js]
@@ -2689,7 +2692,8 @@
         (catch Throwable t
           (throw (ex-info (str "Error running preprocessing function " preprocess)
                    {:file       (:file js-module)
-                    :preprocess preprocess}
+                    :preprocess preprocess
+                    :clojure.error/phase :compilation}
                    t)))))
 
     :else
@@ -2772,19 +2776,22 @@
       (let [new-mappings (reader/read {:eof nil :read-cond :allow} rdr)]
         (when (not (map? new-mappings))
           (throw (ex-info (str "Not a valid data-reader map")
-                   {:url url})))
+                   {:url url
+                    :clojure.error/phase :compilation})))
         (reduce
           (fn [m [k v]]
             (when (not (symbol? k))
               (throw (ex-info (str "Invalid form in data-reader file")
                        {:url url
-                        :form k})))
+                        :form k
+                        :clojure.error/phase :compilation})))
             (when (and (contains? mappings k)
                     (not= (mappings k) v))
               (throw (ex-info "Conflicting data-reader mapping"
                        {:url url
                         :conflict k
-                        :mappings m})))
+                        :mappings m
+                        :clojure.error/phase :compilation})))
             (assoc m k v))
           mappings
           new-mappings)))))
@@ -3241,8 +3248,8 @@
             "js" (cond-> (:provides (parse-js-ns src))
                    (not all-provides) first)
             (throw
-              (IllegalArgumentException.
-                (str "Can't create goog.require expression for " src))))]
+              (util/compilation-error (IllegalArgumentException.
+                                        (str "Can't create goog.require expression for " src)))))]
       (if (and (not all-provides) wrap)
         (if (:reload options)
           (str "goog.require(\"" goog-ns "\", true);")

src/main/clojure/cljs/compiler.cljc

@@ -304,7 +304,8 @@
     (ex-info (str "failed compiling constant: " x "; "
                (pr-str (type x)) " is not a valid ClojureScript constant.")
       {:constant x
-       :type (type x)})))
+       :type (type x)
+       :clojure.error/phase :compilation})))
 
 (defmethod emit-constant* nil [x] (emits "null"))
 
@@ -1398,8 +1399,8 @@
          (clojure.string/replace file-str #"\.cljc$" ".js"))
 
        :else
-       (throw (IllegalArgumentException.
-                (str "Invalid source file extension " file-str))))))
+       (throw (util/compilation-error (IllegalArgumentException.
+                                        (str "Invalid source file extension " file-str)))))))
 
 #?(:clj
    (defn with-core-cljs
@@ -1702,8 +1703,8 @@
                       (with-core-cljs opts (fn [] (ana/analyze-file src-file opts))))
                     (assoc ns-info :out-file (.toString dest-file)))))
               (catch Exception e
-                (throw (ex-info (str "failed compiling file:" src) {:file src} e))))
-            (throw (java.io.FileNotFoundException. (str "The file " src " does not exist.")))))))))
+                (throw (ex-info (str "failed compiling file:" src) {:file src :clojure.error/phase :compilation} e))))
+            (throw (util/compilation-error (java.io.FileNotFoundException. (str "The file " src " does not exist."))))))))))
 
 #?(:clj
    (defn cljs-files-in
@@ -1788,7 +1789,8 @@
         :else (throw
                 (ex-info
                   (str "Cannot emit constant for type " (type sym))
-                  {:error :invalid-constant-type})))
+                  {:error :invalid-constant-type
+                   :clojure.error/phase :compilation})))
       (emits ";\n"))))
 
 #?(:clj

src/main/clojure/cljs/js_deps.cljc

@@ -179,8 +179,8 @@ case."
           (if-let [file (get-file dep index')]
             (update-in index' [file] lib-spec-merge dep)
             (throw
-              (Exception.
-                (str "No :file provided for :foreign-libs spec " (pr-str dep)))))
+              (util/compilation-error (Exception.
+                                        (str "No :file provided for :foreign-libs spec " (pr-str dep))))))
           (assoc index' (:file dep) dep))))
     {} deps))