mirror of
https://github.com/penpot/penpot.git
synced 2026-08-11 07:18:56 +00:00
f2adc944f3
The default query is now multi-line with // comments that explain the filter_* column convention in place (Kuzu accepts comments and blank lines mid-statement; verified against an in-memory database through the console query path). The query fieldset is retitled 'LadybugDB Cypher' with the Cypher word linking to https://docs.ladybugdb.com/cypher/. Signed-off-by: Álvaro Tejero Cantero <alvorithm@teje.ro>
273 lines
10 KiB
Clojure
273 lines
10 KiB
Clojure
;; This Source Code Form is subject to the terms of the Mozilla Public
|
|
;; License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
;; file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
;;
|
|
;; Copyright (c) KALEIDOS INC Sucursal en España SL
|
|
|
|
(ns app.graph.debug
|
|
"In-memory Ladybug sessions for the debug graph console."
|
|
(:require
|
|
[app.common.exceptions :as ex]
|
|
[app.common.logging :as l]
|
|
[app.common.time :as ct]
|
|
[app.graph.ingest :as graph.ingest]
|
|
[app.graph.ladybug :as ladybug]
|
|
[app.graph.schema.nodes :as nodes]
|
|
[app.graph.sync :as graph.sync]
|
|
[app.msgbus :as mbus]
|
|
[clojure.string :as str]
|
|
[promesa.exec.csp :as sp])
|
|
(:import
|
|
com.ladybugdb.Connection
|
|
com.ladybugdb.Database))
|
|
|
|
(set! *warn-on-reflection* true)
|
|
|
|
(def default-query
|
|
"Default console query, written to be self-explanatory in the textarea.
|
|
The `filter_*` columns carry node ids for the graph-view result filter;
|
|
the results table hides them (see `hide-filter-columns` and the
|
|
template's `renderQueryOutput`)."
|
|
(str "MATCH (s)-[r]->(t)\n"
|
|
"// WHERE some condition\n"
|
|
"RETURN label(s) AS src, s.name,\n"
|
|
" label(r) AS rel,\n"
|
|
" t.name, label(t) AS tgt,\n"
|
|
"\n"
|
|
"// filter_* columns omitted from table; these needed for graph view\n"
|
|
"s.id AS filter_src_id, t.id AS filter_tgt_id;"))
|
|
|
|
(defonce ^:private sessions
|
|
(atom {}))
|
|
|
|
(defn- session-key
|
|
[profile-id]
|
|
(str profile-id))
|
|
|
|
(defn- destroy-session!
|
|
[{:keys [conn db sync-ch msgbus]}]
|
|
(when sync-ch
|
|
(sp/close! sync-ch)
|
|
(when msgbus
|
|
(mbus/purge! msgbus [sync-ch])))
|
|
(when conn
|
|
(ex/ignoring (.close ^Connection conn)))
|
|
(when db
|
|
(ex/ignoring (.close ^Database db))))
|
|
|
|
(defn- format-cell
|
|
[value]
|
|
(cond
|
|
(nil? value) "NULL"
|
|
(string? value) value
|
|
:else (str value)))
|
|
|
|
(defn- format-query-result
|
|
[{:keys [columns rows truncated?]}]
|
|
{:columns (mapv str columns)
|
|
:rows (mapv (fn [row]
|
|
(mapv format-cell row))
|
|
rows)
|
|
:truncated? truncated?
|
|
:row-count (count rows)})
|
|
|
|
(defn- apply-file-change!
|
|
[conn profile-id {:keys [changes revn file-id]}]
|
|
(try
|
|
(some-> (get @sessions (session-key profile-id))
|
|
(as-> current
|
|
(when (= file-id (:file-id current))
|
|
(let [result (locking (:lock current)
|
|
(graph.sync/apply-changes!
|
|
conn (:index current) changes revn))
|
|
sync-at (ct/now)]
|
|
(swap! sessions assoc-in [(session-key profile-id) :index]
|
|
(:index result))
|
|
(swap! sessions update-in [(session-key profile-id) :meta]
|
|
(fn [meta]
|
|
(cond-> (-> meta
|
|
(update :sync dissoc :error)
|
|
(assoc-in [:sync :last-at] sync-at)
|
|
(assoc-in [:sync :last-applied] (:applied result))
|
|
(assoc-in [:sync :last-skipped] (:skipped result)))
|
|
(seq (:applied result))
|
|
(assoc :revn (:revn result)))))
|
|
(when (seq (:skipped result))
|
|
(l/dbg :hint "graph sync skipped changes"
|
|
:file-id (str file-id)
|
|
:revn revn
|
|
:skipped (:skipped result)))))))
|
|
(catch Throwable cause
|
|
(l/wrn :hint "graph sync failed"
|
|
:file-id (str file-id)
|
|
:cause cause)
|
|
(swap! sessions assoc-in [(session-key profile-id) :meta :sync :error]
|
|
(ex-message cause)))))
|
|
|
|
(defn- start-sync-loop!
|
|
[{:keys [conn profile-id file-id] :as session}]
|
|
(if-let [msgbus (:msgbus session)]
|
|
(let [sync-ch (sp/chan :buf (sp/dropping-buffer 64))]
|
|
(mbus/sub! msgbus :topic file-id :chan sync-ch)
|
|
(sp/go-loop []
|
|
(when-let [message (sp/take! sync-ch)]
|
|
(when (= :file-change (:type message))
|
|
(apply-file-change! conn profile-id message)))
|
|
(recur))
|
|
(assoc session :sync-ch sync-ch))
|
|
session))
|
|
|
|
(defn session-info
|
|
"Return a public view of the current session for `profile-id`, if any."
|
|
[profile-id]
|
|
(when-let [{:keys [file-id meta loaded-at index]} (get @sessions (session-key profile-id))]
|
|
{:file-id file-id
|
|
:name (:name meta)
|
|
:revn (:revn meta)
|
|
:graph-revn (:revn index)
|
|
:schema-version (:schema-version meta)
|
|
:projection (:projection meta)
|
|
:sync (:sync meta)
|
|
:loaded-at (ct/format-inst loaded-at :iso)}))
|
|
|
|
(defn sync-status
|
|
"Return incremental sync status for the active session."
|
|
[profile-id]
|
|
(when-let [session (get @sessions (session-key profile-id))]
|
|
(let [{:keys [file-id meta index loaded-at]} session]
|
|
{:file-id file-id
|
|
:revn (:revn meta)
|
|
:graph-revn (:revn index)
|
|
:sync (:sync meta)
|
|
:loaded-at (ct/format-inst loaded-at :iso)})))
|
|
|
|
(defn unload-session!
|
|
"Close and discard the in-memory graph for `profile-id`."
|
|
[profile-id]
|
|
(when-let [session (get @sessions (session-key profile-id))]
|
|
(destroy-session! session))
|
|
(swap! sessions dissoc (session-key profile-id)))
|
|
|
|
(defn load-session!
|
|
"Ingest `file-id` into a new in-memory Ladybug database for `profile-id`."
|
|
[cfg profile-id file-id]
|
|
(unload-session! profile-id)
|
|
(let [^Database db (Database.)
|
|
^Connection conn (Connection. db)
|
|
msgbus (::mbus/msgbus cfg)]
|
|
(.setQueryTimeout conn 0)
|
|
(ladybug/ensure-extensions! conn)
|
|
(try
|
|
(let [meta (graph.ingest/ingest-on-connection! cfg conn file-id
|
|
:db-path ":memory:"
|
|
:skip-stats? true
|
|
:skip-validation? true)
|
|
index (graph.sync/build-index file-id (:revn meta) (:projection meta))
|
|
session
|
|
;; :lock serializes access to the shared Connection between the
|
|
;; msgbus sync loop (writes) and HTTP handlers (reads); the Java
|
|
;; binding gives no thread-safety guarantee for one Connection.
|
|
(-> {:db db
|
|
:conn conn
|
|
:lock (Object.)
|
|
:file-id file-id
|
|
:meta meta
|
|
:index index
|
|
:msgbus msgbus
|
|
:profile-id profile-id
|
|
:loaded-at (ct/now)}
|
|
start-sync-loop!)]
|
|
(swap! sessions assoc (session-key profile-id) session)
|
|
meta)
|
|
(catch Throwable cause
|
|
(destroy-session! {:conn conn :db db :msgbus msgbus})
|
|
(throw cause)))))
|
|
|
|
(defn query-session!
|
|
"Run `statement` against the in-memory graph for `profile-id`."
|
|
[profile-id statement]
|
|
(when (str/blank? statement)
|
|
(ex/raise :type :validation
|
|
:code :missing-query
|
|
:hint "cypher query is required"))
|
|
(if-let [{:keys [conn lock]} (get @sessions (session-key profile-id))]
|
|
(locking (or lock ::no-lock)
|
|
(-> (ladybug/query-on-connection! conn statement)
|
|
format-query-result))
|
|
(ex/raise :type :not-found
|
|
:code :graph-session-not-loaded
|
|
:hint "load a file graph before running queries")))
|
|
|
|
(def ^:private export-max-rows
|
|
"Row cap for graph-view export queries; far above expected per-file node
|
|
and edge counts. `:truncated` in the export signals when it was hit."
|
|
100000)
|
|
|
|
(defn- export-nodes
|
|
[conn]
|
|
(reduce
|
|
(fn [acc {:keys [table]}]
|
|
(let [stmt (str "MATCH (n:" (nodes/match-label table)
|
|
") RETURN n.id AS id, n.name AS name;")
|
|
{:keys [rows truncated?]}
|
|
(ladybug/query-on-connection! conn stmt :max-rows export-max-rows)]
|
|
(-> acc
|
|
(update :nodes into
|
|
(map (fn [[id label]]
|
|
{:id (str id) :label (str label) :table table}))
|
|
rows)
|
|
(update :truncated? #(or % truncated?)))))
|
|
{:nodes [] :truncated? false}
|
|
nodes/node-types))
|
|
|
|
(defn- export-edges
|
|
[conn]
|
|
(let [stmt (str "MATCH (a)-[r:IsChildOf]->(b) "
|
|
"RETURN a.id AS source, b.id AS target, r.position AS position;")
|
|
{:keys [rows truncated?]}
|
|
(ladybug/query-on-connection! conn stmt :max-rows export-max-rows)]
|
|
{:edges (mapv (fn [[source target position]]
|
|
{:source (str source) :target (str target) :position position})
|
|
rows)
|
|
:truncated? truncated?}))
|
|
|
|
(defn export-graph-data!
|
|
"Export the node/edge inventory of the in-memory graph for `profile-id`
|
|
as plain data for the debug graph view. Returns nil when no session is
|
|
loaded. Queries the Ladybug database (not the sync index) so the view
|
|
reflects actual DB state, including drift."
|
|
[profile-id]
|
|
(when-let [{:keys [conn lock file-id index]} (get @sessions (session-key profile-id))]
|
|
(locking (or lock ::no-lock)
|
|
(let [{:keys [nodes] nodes-truncated? :truncated?} (export-nodes conn)
|
|
{:keys [edges] edges-truncated? :truncated?} (export-edges conn)]
|
|
{:file-id (str file-id)
|
|
:revn (:revn index)
|
|
:truncated (boolean (or nodes-truncated? edges-truncated?))
|
|
:nodes nodes
|
|
:edges edges}))))
|
|
|
|
(defn- hide-filter-columns
|
|
"Drop `filter_*` columns from a query result before HTML table render;
|
|
they exist to feed node ids to the graph-view filter, not for reading.
|
|
The JSON response path keeps the full result."
|
|
[{:keys [columns rows] :as result}]
|
|
(let [idxs (vec (keep-indexed
|
|
(fn [i c] (when-not (str/starts-with? (str c) "filter_") i))
|
|
columns))]
|
|
(if (or (empty? idxs) (= (count idxs) (count columns)))
|
|
result
|
|
(assoc result
|
|
:columns (mapv (vec columns) idxs)
|
|
:rows (mapv (fn [row] (mapv (vec row) idxs)) rows)))))
|
|
|
|
(defn console-context
|
|
"Build template data for the graph debug console page."
|
|
[profile-id & {:keys [query query-result error message]}]
|
|
{:session (session-info profile-id)
|
|
:query (or query default-query)
|
|
:query-result (some-> query-result hide-filter-columns)
|
|
:error error
|
|
:message message
|
|
:default-query default-query})
|