warnings: add initial warnings

Author: handerpeder

deps.edn

@@ -36,7 +36,8 @@
                  :extra-deps {djblue/portal #_{:clj-kondo/ignore [:deps.edn]} {:mvn/version "RELEASE"}}
                  :jvm-opts ["--enable-native-access=ALL-UNNAMED"]}
            :test {:extra-paths ["test"]
-                  :extra-deps {lambdaisland/kaocha {:mvn/version "1.91.1392"}}
+                  :extra-deps {lambdaisland/kaocha {:mvn/version "1.91.1392"}
+                               metosin/malli {:mvn/version "0.19.1"}}
                   :main-opts ["-m" "kaocha.runner"]
                   :jvm-opts ["--enable-native-access=ALL-UNNAMED"]}
            :nrepl {:extra-deps {nrepl/nrepl {:mvn/version "1.3.1"}}

dev/user.clj

@@ -1,6 +1,4 @@
-(ns user
-  (:require [eden.core]
-            [clojure.datafy]))
+(ns user (:require [clojure.datafy]))
 
 (defmacro capture-env
   "Capture local bindings.
@@ -48,3 +46,5 @@
     (defonce _add-tap-only-once (add-tap submit))
     (defn selected [] (selected p))
     (defn popen [] (open p))))
+
+(require '[eden.core])

src/eden/report.clj

@@ -3,7 +3,29 @@
 (defmulti print-warning :type)
 
 (defmethod print-warning :missing-key [{:keys [directive key template]}]
-  (println (format "  Missing key: %s for directive %s in template %s" key directive template)))
+  (println (format "  Missing key: %s for directive %s in template %s"
+                   key directive template)))
+
+(defmethod print-warning :missing-render-template [{:keys [lang template parent]}]
+  (println (format "  Missing template: %s (lang: %s) while rendering %s"
+                   template lang parent)))
+
+(defmethod print-warning :missing-page-content [{:keys [lang spec parent] :as w}]
+  (println (format "  Missing content: %s (lang: %s) while rendering %s"
+                   (:data spec) lang parent))
+  (prn w))
+
+(defmethod print-warning :not-a-string [{:keys [form lang]}]
+  (println (format "  Missing string value for template: '%s' (lang: %s)"
+                   (pr-str form)
+                   lang)))
+
+(defmethod print-warning :missing-include-template [{:keys [directive template]}]
+  (println (format "  Missing include template: %s for %s"
+                   template directive)))
+
+(defmethod print-warning :missing-template [{:keys [lang template]}]
+  (println (format "  Missing template: %s (lang: %s). Create template or specify :template in content " template lang)))
 
 (defmethod print-warning :default [{:keys [type] :as warning}]
   (println "Unknown warning:" type)
@@ -12,8 +34,10 @@
 (defn print-build-report [ctx]
   (when-let [warnings (seq (into #{} (:warnings ctx)))]
     (println "\n⚠️ Warnings")
-    (doseq [warning warnings]
-      (print-warning warning)))
+    (doseq [[content-key content-warnings] (sort-by first (group-by #(or (:parent %) (:content-key %)) warnings))]
+      (println "\n" content-key)
+      (doseq [warning content-warnings]
+        (print-warning warning))))
 
   (when-let [error (:error ctx)]
     (println (format "\n❌ Build failed: %s" error))))

src/eden/site_generator.clj

@@ -73,6 +73,7 @@
         (do (warn! context
                    {:type :missing-key
                     :template (some-> context :data :template)
+                    :content-key (:content-key context)
                     :key processed-key
                     :directive :eden/get})
             [:span.missing-content (str "[:eden/get " processed-key "]")]))
@@ -257,6 +258,7 @@
                      {:data processed-render-spec}
                      processed-render-spec)
 
+        parent-content-key (:content-key context)
         content-key (:data final-spec)
 
         lang (or (:lang context)
@@ -268,6 +270,8 @@
                       (warn! context
                              {:type :missing-page-content
                               :directive :eden/render
+                              :parent parent-content-key
+                              :content-key content-key
                               :lang lang
                               :spec final-spec}))
 
@@ -280,6 +284,8 @@
                           (warn! context
                                  {:type :missing-render-template
                                   :directive :eden/render
+                                  :parent parent-content-key
+                                  :content-key content-key
                                   :lang lang
                                   :template template-key
                                   :spec final-spec})))]
@@ -317,6 +323,7 @@
                      (warn! context
                             {:type :missing-include-template
                              :directive :eden/include
+                             :content-key (:content-key context)
                              :template processed-template-name}))]
     (process template (update context :data merge override-context))))
 
@@ -360,6 +367,8 @@
                                            (str/replace s variable value)
                                            (do (warn! context {:type :not-a-string
                                                                :directive :eden/t
+                                                               :lang (:lang context)
+                                                               :content-key (:content-key context)
                                                                :value value
                                                                :template-variable variable
                                                                :template-string string-template

test/eden/site_generator_test.clj

@@ -223,39 +223,6 @@
                         :lang :en
                         :templates {:sidebar [:h2 [:eden/get :hello]]}}))))
 
-
-  (testing "simple component, content not found"
-    (let [warnings (atom [])]
-      (is (= [:span.missing-content "[:eden/render :this-page-is-not-found]"]
-             (sg/process [:eden/render :this-page-is-not-found]
-                         {:content {:en {:sidebar {:hello "world"}}}
-                          :warn! #(swap! warnings conj %)
-                          :lang :en
-                          :templates {:sidebar [:h2 [:eden/get :hello]]}})))
-      (is (= 1 (count @warnings)))
-      (is (= [{:type :missing-page-content,
-               :directive :eden/render
-               :lang :en,
-               :spec {:data :this-page-is-not-found}}]
-             @warnings))))
-
-  (testing "simple component, template not found"
-    (let [warnings (atom [])]
-      (is (= [:span.missing-content "[:eden/render :sidebar]"]
-             (sg/process [:eden/render :sidebar]
-                         {:content {:en {:sidebar {:hello "world"
-                                                   :template :my-nonexistent-template}}}
-                          :warn! #(swap! warnings conj %)
-                          :lang :en
-                          :templates {:sidebar [:h2 [:eden/get :hello]]}})))
-      (is (= 1 (count @warnings)))
-      (is (= [{:type :missing-render-template
-               :directive :eden/render
-               :lang :en
-               :template :my-nonexistent-template
-               :spec {:data :sidebar}}]
-             @warnings))))
-
   (testing "simple component, page has template"
     (is (= [:p "I am foo"]
            (sg/process [:eden/render :sidebar]
@@ -357,21 +324,7 @@
                            [:p "Language: " [:eden/get :language]]]]]]
                        {:data {:user {:name "user name"
                                       :preferences {:theme "dark"
-                                                    :language "braile"}}}}))))
-
-  (testing "missing key"
-    (let [warnings (atom [])]
-      (is (= [[:p [:span.missing-content "[:eden/get :value]"]]]
-             (sg/process [:eden/with :foo
-                          [:p [:eden/get :value]]]
-                         {:warn! #(swap! warnings conj %)})))
-
-      (let [relevant-warnings (filter #(= (:type %) :with-directive-data-not-found) @warnings)]
-        (is (= 1 (count relevant-warnings)))
-        (is (= {:type :with-directive-data-not-found,
-                :data-key :foo
-                :data nil}
-               (first relevant-warnings)))))))
+                                                    :language "braile"}}}})))))
 
 (deftest eden-include
   (testing "simple include"

test/eden/site_generator_test/warning_examples.clj

@@ -0,0 +1,124 @@
+(ns eden.site-generator-test.warning-examples
+  "Example warnings for each type, used for:
+   1. Visual inspection of report output
+   2. Testing report formatting
+   3. Documentation of warning structures
+   
+   All examples must validate against their schemas in warnings-test namespace.
+   Run (print-all-examples) to see formatted output of all warning types."
+  (:require [eden.site-generator-test.warnings-test :as wt]
+            [eden.report :as report]
+            [malli.core :as m]
+            [malli.error :as me]))
+
+(def warnings
+  [{:type :missing-key
+    :template :home
+    :content-key :index
+    :key :page-title
+    :directive :eden/get}
+
+   {:type :missing-path
+    :directive :eden/get-in
+    :path [:user :profile :avatar]}
+
+   {:type :missing-config-key
+    :path [:social :twitter :api-key]}
+
+   {:type :missing-collection-key
+    :key :products}
+
+   {:type :unsupported-eden-each-collection-spec
+    :original-key "invalid-string"
+    :context {} ; Would have full context in real scenario
+    :body [:div "..."]
+    :key "invalid-string"}
+
+   {:type :missing-page-content
+    :directive :eden/render
+    :lang :en
+    :spec {:data :about-page}
+    :parent :home
+    :content-key :about-page}
+
+   {:type :missing-render-template
+    :directive :eden/render
+    :lang :en
+    :template :product-detail
+    :spec {:data :product}
+    :parent :shop
+    :content-key :product}
+
+   {:type :with-directive-data-not-found
+    :data-key :user-preferences
+    :data {:user-id 123 :user-name "John"}}
+
+   {:type :missing-include-template
+    :directive :eden/include
+    :template :header-navigation
+    :content-key :home}
+
+   {:type :missing-body-in-context
+    :directive :eden/body
+    :content-key :blog-post}
+
+   {:type :invalid-key-or-path
+    :path "should-be-keyword-or-vector"
+    :directive :eden/t}
+
+   {:type :not-a-string
+    :directive :eden/t
+    :content-key :dashboard
+    :lang :en
+    :value 42
+    :template-variable "{{count}}"
+    :template-string "You have {{count}} messages"
+    :form [:eden/t :message-count {:count 42}]}
+
+   {:type :unknown-directive
+    :directive :eden/custom-thing}
+
+   {:type :missing-content
+    :content-key :privacy-policy
+    :message "Page :privacy-policy not found in any language"}])
+
+(defn print-examples []
+  (let [{:keys [valid errors]}
+        (reduce (fn [agg w]
+                  (if (m/validate wt/Warning w)
+                    (update agg :valid conj w)
+                    (update agg :errors conj (let [explained (m/explain wt/Warning w)]
+                                               {:value w
+                                                :explain explained
+                                                :humanized (me/humanize explained)}))))
+                {:valid [] :errors []}
+                warnings)
+        warnings-by-type (group-by :type valid)]
+
+    (doseq [[type warnings] warnings-by-type]
+      (println type "examples")
+      (doseq [w warnings]
+        (report/print-warning w)))
+
+    (when (seq errors)
+      (println "\nErrors:")
+      (let [{missing true other false}
+            (group-by #(= (-> % :explain :errors first :type) ::m/invalid-dispatch-value) errors)]
+        (when (seq missing)
+          (println "  Missing schemas")
+          (doseq [missing-schema (into #{} (map (comp :type :value)) missing)]
+            (println "    " missing-schema))
+          (println))
+
+        (when (seq other)
+          (println "  Invalid warnings")
+          (doseq [{:keys [value humanized]} other]
+            (print "    ")
+            (pr humanized)
+            (print " - ")
+            (prn value)
+            (println))
+          (println))))))
+
+(comment
+  (print-examples))