From deb14ed0090dca082c41a9484c3fa651ca656b5d Mon Sep 17 00:00:00 2001
From: Tienson Qin <tiensonqin@gmail.com>
Date: Mon, 30 Dec 2024 14:04:26 +0800
Subject: [PATCH] feat: dev validate db

---
 .../frontend/handler/common/developer.cljs    | 22 ++++++-----
 src/main/frontend/handler/worker.cljs         |  8 +++-
 .../frontend/modules/shortcut/config.cljs     | 38 +++++++++++--------
 src/main/frontend/worker/db/validate.cljs     | 33 ++++++++++++++++
 src/main/frontend/worker/db_worker.cljs       |  6 +++
 src/resources/dicts/en.edn                    |  5 +--
 6 files changed, 81 insertions(+), 31 deletions(-)
 create mode 100644 src/main/frontend/worker/db/validate.cljs

diff --git a/src/main/frontend/handler/common/developer.cljs b/src/main/frontend/handler/common/developer.cljs
index 63fa267ea18..498373f78ef 100644
--- a/src/main/frontend/handler/common/developer.cljs
+++ b/src/main/frontend/handler/common/developer.cljs
@@ -1,17 +1,17 @@
 (ns frontend.handler.common.developer
   "Common fns for developer related functionality"
-  (:require [frontend.db :as db]
-            [cljs.pprint :as pprint]
-            [frontend.state :as state]
+  (:require [cljs.pprint :as pprint]
+            [datascript.impl.entity :as de]
+            [frontend.config :as config]
+            [frontend.db :as db]
+            [frontend.format.mldoc :as mldoc]
             [frontend.handler.notification :as notification]
+            [frontend.persist-db :as persist-db]
+            [frontend.state :as state]
             [frontend.ui :as ui]
             [frontend.util.page :as page-util]
-            [frontend.format.mldoc :as mldoc]
-            [frontend.config :as config]
-            [frontend.persist-db :as persist-db]
-            [promesa.core :as p]
-            [datascript.impl.entity :as de]
-            [logseq.db.frontend.property :as db-property]))
+            [logseq.db.frontend.property :as db-property]
+            [promesa.core :as p]))
 
 ;; Fns used between menus and commands
 (defn show-entity-data
@@ -88,6 +88,10 @@
         (show-content-ast (get-in page-data [:block/file :file/content]) (:block/format page-data))
         (notification/show! "No page found" :warning)))))
 
+(defn ^:export validate-db []
+  (when-let [^Object worker @state/*db-worker]
+    (.validate-db worker (state/get-current-repo))))
+
 (defn import-chosen-graph
   [repo]
   (p/let [_ (persist-db/<unsafe-delete repo)]
diff --git a/src/main/frontend/handler/worker.cljs b/src/main/frontend/handler/worker.cljs
index 059b818f4b8..9c8f68e0c94 100644
--- a/src/main/frontend/handler/worker.cljs
+++ b/src/main/frontend/handler/worker.cljs
@@ -4,8 +4,9 @@
             [frontend.handler.file :as file-handler]
             [frontend.handler.notification :as notification]
             [frontend.state :as state]
-            [promesa.core :as p]
-            [logseq.db :as ldb]))
+            [lambdaisland.glogi :as log]
+            [logseq.db :as ldb]
+            [promesa.core :as p]))
 
 (defmulti handle identity)
 
@@ -25,6 +26,9 @@
 (defmethod handle :notification [_ _worker data]
   (apply notification/show! data))
 
+(defmethod handle :log [_ _worker [name level data]]
+  (log/log name level data))
+
 (defmethod handle :add-repo [_ _worker data]
   (state/add-repo! {:url (:repo data)})
   (state/pub-event! [:graph/switch (:repo data) {:rtc-download? true}]))
diff --git a/src/main/frontend/modules/shortcut/config.cljs b/src/main/frontend/modules/shortcut/config.cljs
index 3f14a73786e..1a41293ea91 100644
--- a/src/main/frontend/modules/shortcut/config.cljs
+++ b/src/main/frontend/modules/shortcut/config.cljs
@@ -1,34 +1,34 @@
 (ns frontend.modules.shortcut.config
-  (:require [clojure.string :as str]
+  (:require [clojure.data :as data]
+            [clojure.string :as str]
+            [electron.ipc :as ipc]
+            [frontend.commands :as commands]
             [frontend.components.commit :as commit]
-            [frontend.extensions.srs.handler :as srs]
+            [frontend.config :as config]
+            [frontend.dicts :as dicts]
             [frontend.extensions.pdf.utils :as pdf-utils]
+            [frontend.extensions.srs.handler :as srs]
             [frontend.handler.config :as config-handler]
             [frontend.handler.editor :as editor-handler]
-            [frontend.handler.paste :as paste-handler]
+            [frontend.handler.export :as export-handler]
             [frontend.handler.history :as history]
+            [frontend.handler.journal :as journal-handler]
+            [frontend.handler.jump :as jump-handler]
             [frontend.handler.notification :as notification]
             [frontend.handler.page :as page-handler]
+            [frontend.handler.paste :as paste-handler]
+            [frontend.handler.plugin :as plugin-handler]
+            [frontend.handler.plugin-config :as plugin-config-handler]
             [frontend.handler.route :as route-handler]
-            [frontend.handler.journal :as journal-handler]
             [frontend.handler.search :as search-handler]
             [frontend.handler.ui :as ui-handler]
-            [frontend.handler.plugin :as plugin-handler]
-            [frontend.handler.export :as export-handler]
             [frontend.handler.whiteboard :as whiteboard-handler]
-            [frontend.handler.plugin-config :as plugin-config-handler]
             [frontend.handler.window :as window-handler]
-            [frontend.handler.jump :as jump-handler]
-            [frontend.dicts :as dicts]
             [frontend.modules.shortcut.before :as m]
             [frontend.state :as state]
             [frontend.util :refer [mac?] :as util]
-            [frontend.commands :as commands]
-            [frontend.config :as config]
-            [electron.ipc :as ipc]
-            [promesa.core :as p]
-            [clojure.data :as data]
-            [medley.core :as medley]))
+            [medley.core :as medley]
+            [promesa.core :as p]))
 
 (defn- search
   [mode]
@@ -603,7 +603,11 @@
 
    :dev/show-page-ast {:binding []
                        :inactive (not (state/developer-mode?))
-                       :fn :frontend.handler.common.developer/show-page-ast}})
+                       :fn :frontend.handler.common.developer/show-page-ast}
+
+   :dev/validate-db   {:binding []
+                       :inactive (not (state/developer-mode?))
+                       :fn :frontend.handler.common.developer/validate-db}})
 
 (let [keyboard-commands
       {::commands (set (keys all-built-in-keyboard-shortcuts))
@@ -809,6 +813,7 @@
           :dev/show-page-data
           :dev/show-page-ast
           :dev/replace-graph-with-db-file
+          :dev/validate-db
           :ui/customize-appearance])
         (with-meta {:before m/enable-when-not-editing-mode!}))
 
@@ -996,6 +1001,7 @@
      :dev/show-page-data
      :dev/show-page-ast
      :dev/replace-graph-with-db-file
+     :dev/validate-db
      :ui/clear-all-notifications]
 
     :shortcut.category/plugins
diff --git a/src/main/frontend/worker/db/validate.cljs b/src/main/frontend/worker/db/validate.cljs
new file mode 100644
index 00000000000..3b7e57eca53
--- /dev/null
+++ b/src/main/frontend/worker/db/validate.cljs
@@ -0,0 +1,33 @@
+(ns frontend.worker.db.validate
+  "Validate db"
+  (:require [cljs.pprint :as pprint]
+            [frontend.worker.util :as worker-util]
+            [logseq.db :as ldb]
+            [logseq.db.frontend.validate :as db-validate]))
+
+(defn- counts-from-entities
+  [entities]
+  {:entities (count entities)
+   :pages (count (filter :block/name entities))
+   :blocks (count (filter :block/title entities))
+   :classes (count (filter ldb/class? entities))
+   :objects (count (filter #(seq (:block/tags %)) entities))
+   :properties (count (filter ldb/property? entities))
+   :property-values (count (mapcat :block/properties entities))})
+
+(defn validate-db
+  [db]
+  (let [{:keys [errors datom-count entities]} (db-validate/validate-db! db)]
+    (if errors
+      (do
+        (worker-util/post-message :log [:db-invalid :error
+                                        {:msg (str "Validation detected " (count errors) " invalid block(s):")
+                                         :counts (assoc (counts-from-entities entities) :datoms datom-count)}])
+        (pprint/pprint errors)
+        (worker-util/post-message :notification
+                                  [(str "Validation detected " (count errors) " invalid block(s). These blocks may be buggy when you interact with them. See the javascript console for more.")
+                                   :warning false]))
+
+      (worker-util/post-message :notification
+                                [(str "Your graph is valid! " (assoc (counts-from-entities entities) :datoms datom-count))
+                                 :success false]))))
diff --git a/src/main/frontend/worker/db_worker.cljs b/src/main/frontend/worker/db_worker.cljs
index f5720833735..0feb4de6021 100644
--- a/src/main/frontend/worker/db_worker.cljs
+++ b/src/main/frontend/worker/db_worker.cljs
@@ -13,6 +13,7 @@
             [frontend.worker.db-listener :as db-listener]
             [frontend.worker.db-metadata :as worker-db-metadata]
             [frontend.worker.db.migrate :as db-migrate]
+            [frontend.worker.db.validate :as worker-db-validate]
             [frontend.worker.device :as worker-device]
             [frontend.worker.export :as worker-export]
             [frontend.worker.file :as file]
@@ -908,6 +909,11 @@
    (undo-redo/record-editor-info! repo (ldb/read-transit-str editor-info-str))
    nil)
 
+  (validate-db
+   [_this repo]
+   (when-let [conn (worker-state/get-datascript-conn repo)]
+     (worker-db-validate/validate-db @conn)))
+
   (dangerousRemoveAllDbs
    [this repo]
    (p/let [dbs (.listDB this)]
diff --git a/src/resources/dicts/en.edn b/src/resources/dicts/en.edn
index f092d42b9a1..1544ee66146 100644
--- a/src/resources/dicts/en.edn
+++ b/src/resources/dicts/en.edn
@@ -206,10 +206,6 @@
  :editor/collapse-block-children "Collapse all"
  :editor/delete-selection "Delete selected blocks"
  :editor/cycle-todo "Rotate the TODO state"
- :dev/show-page-data "(Dev) Show page data"
- :dev/show-block-data "(Dev) Show block data"
- :dev/show-block-ast "(Dev) Show block AST"
- :dev/show-page-ast "(Dev) Show page AST"
  :content/copy-export-as "Copy / Export as.."
  :content/copy-block-url "Copy block URL"
  :content/copy-block-ref "Copy block ref"
@@ -796,4 +792,5 @@
   :dev/show-page-data "(Dev) Show page data"
   :dev/show-page-ast "(Dev) Show page AST"
   :dev/replace-graph-with-db-file "(Dev) Replace graph with its db.sqlite file"
+  :dev/validate-db "(Dev) Validate current graph"
   :window/close "Close window"}}