3pp-mirror/penpot
1
0
Fork 0
mirror of https://github.com/penpot/penpot.git synced 2025-06-08 23:11:37 +02:00
Code Issues Projects Releases Packages Wiki Activity

🔧 Add filtering to logs in component sync algorithm

Browse source
This commit is contained in:
Andrés Moya 2025-02-19 11:22:12 +01:00 • committed by Andrés Moya
parent 4799f6fe0a
commit 1c98c53805
1 changed files with 126 additions and 76 deletions
Download patch file Download diff file Expand all files Collapse all files

104
common/src/app/common/logic/libraries.cljc
View file

@ -5,6 +5,7 @@
;; Copyright (c) KALEIDOS INC ;; Copyright (c) KALEIDOS INC
(ns app.common.logic.libraries (ns app.common.logic.libraries
#?(:cljs (:require-macros [app.common.logic.libraries :refer [shape-log container-log]]))
(:require (:require
[app.common.data :as d] [app.common.data :as d]
[app.common.data.macros :as dm] [app.common.data.macros :as dm]
@ -35,6 +36,33 @@
;; Change this to :info :debug or :trace to debug this module, or :warn to reset to default ;; Change this to :info :debug or :trace to debug this module, or :warn to reset to default
(log/set-level! :warn) (log/set-level! :warn)
(def log-shape-ids #{})
(def log-container-ids #{})
(defn enabled-shape?
[id container]
(or (empty? log-shape-ids)
(nil? id)
(let [ids (if container
(into #{} (cfh/get-parent-ids-seq-with-self (:objects container) id))
#{id})]
(seq (set/intersection log-shape-ids ids)))))
(defmacro shape-log
[level id container & params]
`(when (enabled-shape? ~id ~container)
(log/log ~level ~@params)))
(defn enabled-container?
[id]
(or (empty? log-container-ids)
(log-container-ids id)))
(defmacro container-log
[level id & params]
`(when (enabled-container? ~id)
(log/log ~level ~@params)))
(declare generate-sync-container) (declare generate-sync-container)
(declare generate-sync-shape) (declare generate-sync-shape)
(declare generate-sync-text-shape) (declare generate-sync-text-shape)
@ -258,7 +286,8 @@
with a component." with a component."
[changes container libraries shape-id] [changes container libraries shape-id]
(let [shape (ctn/get-shape container shape-id)] (let [shape (ctn/get-shape container shape-id)]
(log/debug :msg "Detach instance" :shape-id shape-id :container (:id container)) (shape-log :debug shape-id container
:msg "Detach instance" :shape-id shape-id :container (:id container))
(generate-detach-recursive changes container libraries shape-id true (true? (:component-root shape))))) (generate-detach-recursive changes container libraries shape-id true (true? (:component-root shape)))))
(defn- generate-detach-recursive (defn- generate-detach-recursive
@ -375,7 +404,8 @@
(s/assert ::us/uuid file-id) (s/assert ::us/uuid file-id)
(s/assert ::us/uuid library-id) (s/assert ::us/uuid library-id)
(log/info :msg "Sync file with library" (container-log :info asset-id
:msg "Sync file with library"
:asset-type asset-type :asset-type asset-type
:asset-id asset-id :asset-id asset-id
:file (pretty-file file-id libraries current-file-id) :file (pretty-file file-id libraries current-file-id)
@ -413,7 +443,8 @@
(s/assert ::us/uuid file-id) (s/assert ::us/uuid file-id)
(s/assert ::us/uuid library-id) (s/assert ::us/uuid library-id)
(log/info :msg "Sync local components with library" (container-log :info asset-id
:msg "Sync local components with library"
:asset-type asset-type :asset-type asset-type
:asset-id asset-id :asset-id asset-id
:file (pretty-file file-id libraries current-file-id) :file (pretty-file file-id libraries current-file-id)
@ -443,8 +474,8 @@
[changes asset-type asset-id library-id container components-v2 libraries current-file-id] [changes asset-type asset-id library-id container components-v2 libraries current-file-id]
(if (cfh/page? container) (if (cfh/page? container)
(log/debug :msg "Sync page in local file" :page-id (:id container)) (container-log :debug (:id container) :msg "Sync page in local file" :page-id (:id container))
(log/debug :msg "Sync component in local library" :component-id (:id container))) (container-log :debug (:id container) :msg "Sync component in local library" :component-id (:id container)))
(let [linked-shapes (->> (vals (:objects container)) (let [linked-shapes (->> (vals (:objects container))
(filter #(uses-assets? asset-type asset-id % library-id)))] (filter #(uses-assets? asset-type asset-id % library-id)))]
@ -499,7 +530,7 @@
(defmethod generate-sync-shape :colors (defmethod generate-sync-shape :colors
[_ changes library-id _ shape _ libraries _] [_ changes library-id _ shape _ libraries _]
(log/debug :msg "Sync colors of shape" :shape (:name shape)) (shape-log :debug (:id shape) nil :msg "Sync colors of shape" :shape (:name shape))
;; Synchronize a shape that uses some colors of the library. The value of the ;; Synchronize a shape that uses some colors of the library. The value of the
;; color in the library is copied to the shape. ;; color in the library is copied to the shape.
@ -510,7 +541,7 @@
(defmethod generate-sync-shape :typographies (defmethod generate-sync-shape :typographies
[_ changes library-id container shape _ libraries _] [_ changes library-id container shape _ libraries _]
(log/debug :msg "Sync typographies of shape" :shape (:name shape)) (shape-log :debug (:id shape) nil :msg "Sync typographies of shape" :shape (:name shape))
;; Synchronize a shape that uses some typographies of the library. The attributes ;; Synchronize a shape that uses some typographies of the library. The attributes
;; of the typography are copied to the shape." ;; of the typography are copied to the shape."
@ -672,7 +703,8 @@
"Generate changes to synchronize one shape that is the root of a component "Generate changes to synchronize one shape that is the root of a component
instance, and all its children, from the given component." instance, and all its children, from the given component."
[changes file libraries container shape-id reset? components-v2] [changes file libraries container shape-id reset? components-v2]
(log/debug :msg "Sync shape direct" :shape-inst (str shape-id) :reset? reset?) (shape-log :debug shape-id container
:msg "Sync shape direct" :shape-inst (str shape-id) :reset? reset?)
(let [shape-inst (ctn/get-shape container shape-id) (let [shape-inst (ctn/get-shape container shape-id)
library (dm/get-in libraries [(:component-file shape-inst) :data]) library (dm/get-in libraries [(:component-file shape-inst) :data])
component (ctkl/get-component library (:component-id shape-inst) true)] component (ctkl/get-component library (:component-id shape-inst) true)]
@ -736,7 +768,8 @@
(defn- generate-sync-shape-direct-recursive (defn- generate-sync-shape-direct-recursive
[changes container shape-inst component library file libraries shape-main root-inst root-main reset? initial-root? redirect-shaperef components-v2] [changes container shape-inst component library file libraries shape-main root-inst root-main reset? initial-root? redirect-shaperef components-v2]
(log/debug :msg "Sync shape direct recursive" (shape-log :debug (:id shape-inst) container
:msg "Sync shape direct recursive"
:shape-inst (str (:name shape-inst) " " (pretty-uuid (:id shape-inst))) :shape-inst (str (:name shape-inst) " " (pretty-uuid (:id shape-inst)))
:component (:name component)) :component (:name component))
@ -794,7 +827,8 @@
(map #(redirect-shaperef %) children-inst) children-inst) (map #(redirect-shaperef %) children-inst) children-inst)
only-inst (fn [changes child-inst] only-inst (fn [changes child-inst]
(log/trace :msg "Only inst" (shape-log :trace (:id child-inst) container
:msg "Only inst"
:child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst)))) :child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst))))
(if-not (and omit-touched? (if-not (and omit-touched?
(contains? (:touched shape-inst) (contains? (:touched shape-inst)
@ -806,7 +840,8 @@
changes)) changes))
only-main (fn [changes child-main] only-main (fn [changes child-main]
(log/trace :msg "Only main" (shape-log :trace (:id child-main) component-container
:msg "Only main"
:child-main (str (:name child-main) " " (pretty-uuid (:id child-main)))) :child-main (str (:name child-main) " " (pretty-uuid (:id child-main))))
(if-not (and omit-touched? (if-not (and omit-touched?
(contains? (:touched shape-inst) (contains? (:touched shape-inst)
@ -825,7 +860,8 @@
changes)) changes))
both (fn [changes child-inst child-main] both (fn [changes child-inst child-main]
(log/trace :msg "Both" (shape-log :trace (:id child-inst) container
:msg "Both"
:child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst))) :child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst)))
:child-main (str (:name child-main) " " (pretty-uuid (:id child-main)))) :child-main (str (:name child-main) " " (pretty-uuid (:id child-main))))
(generate-sync-shape-direct-recursive changes (generate-sync-shape-direct-recursive changes
@ -844,14 +880,16 @@
components-v2)) components-v2))
swapped (fn [changes child-inst child-main] swapped (fn [changes child-inst child-main]
(log/trace :msg "Match slot" (shape-log :trace (:id child-inst) container
:msg "Match slot"
:child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst))) :child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst)))
:child-main (str (:name child-main) " " (pretty-uuid (:id child-main)))) :child-main (str (:name child-main) " " (pretty-uuid (:id child-main))))
;; For now we don't make any sync here. ;; For now we don't make any sync here.
changes) changes)
moved (fn [changes child-inst child-main] moved (fn [changes child-inst child-main]
(log/trace :msg "Move" (shape-log :trace (:id child-inst) container
:msg "Move"
:child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst))) :child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst)))
:child-main (str (:name child-main) " " (pretty-uuid (:id child-main)))) :child-main (str (:name child-main) " " (pretty-uuid (:id child-main))))
(move-shape (move-shape
@ -863,6 +901,7 @@
omit-touched?))] omit-touched?))]
(compare-children changes (compare-children changes
shape-inst
children-inst children-inst
children-main children-main
container container
@ -901,7 +940,7 @@
"Generate changes to update the component a shape is linked to, from "Generate changes to update the component a shape is linked to, from
the values in the shape and all its children." the values in the shape and all its children."
[changes file libraries container shape-id components-v2] [changes file libraries container shape-id components-v2]
(log/debug :msg "Sync shape inverse" :shape (str shape-id)) (shape-log :debug shape-id container :msg "Sync shape inverse" :shape (str shape-id))
(let [redirect-shaperef (partial redirect-shaperef container libraries) (let [redirect-shaperef (partial redirect-shaperef container libraries)
shape-inst (ctn/get-shape container shape-id) shape-inst (ctn/get-shape container shape-id)
library (dm/get-in libraries [(:component-file shape-inst) :data]) library (dm/get-in libraries [(:component-file shape-inst) :data])
@ -943,7 +982,8 @@
(defn- generate-sync-shape-inverse-recursive (defn- generate-sync-shape-inverse-recursive
[changes container shape-inst component library file libraries shape-main root-inst root-main initial-root? redirect-shaperef components-v2] [changes container shape-inst component library file libraries shape-main root-inst root-main initial-root? redirect-shaperef components-v2]
(log/trace :msg "Sync shape inverse recursive" (shape-log :trace (:id shape-inst) container
:msg "Sync shape inverse recursive"
:shape (str (:name shape-inst)) :shape (str (:name shape-inst))
:component (:name component)) :component (:name component))
@ -1036,7 +1076,8 @@
components-v2)) components-v2))
swapped (fn [changes child-inst child-main] swapped (fn [changes child-inst child-main]
(log/trace :msg "Match slot" (shape-log :trace (:id child-inst) container
:msg "Match slot"
:child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst))) :child-inst (str (:name child-inst) " " (pretty-uuid (:id child-inst)))
:child-main (str (:name child-main) " " (pretty-uuid (:id child-main)))) :child-main (str (:name child-main) " " (pretty-uuid (:id child-main))))
;; For now we don't make any sync here. ;; For now we don't make any sync here.
@ -1053,6 +1094,7 @@
changes changes
(compare-children changes (compare-children changes
shape-inst
children-inst children-inst
children-main children-main
container container
@ -1084,14 +1126,15 @@
;; ---- Operation generation helpers ---- ;; ---- Operation generation helpers ----
(defn- compare-children (defn- compare-children
[changes children-inst children-main container-inst container-main file libraries only-inst-cb only-main-cb both-cb swapped-cb moved-cb inverse? reset? components-v2] [changes shape-inst children-inst children-main container-inst container-main file libraries only-inst-cb only-main-cb both-cb swapped-cb moved-cb inverse? reset? components-v2]
(log/trace :msg "Compare children") (shape-log :trace (:id shape-inst) container-inst :msg "Compare children")
(loop [children-inst (seq (or children-inst [])) (loop [children-inst (seq (or children-inst []))
children-main (seq (or children-main [])) children-main (seq (or children-main []))
changes changes] changes changes]
(let [child-inst (first children-inst) (let [child-inst (first children-inst)
child-main (first children-main)] child-main (first children-main)]
(log/trace :main (str (:name child-main) " " (pretty-uuid (:id child-main))) (shape-log :trace (:id shape-inst) container-inst
:main (str (:name child-main) " " (pretty-uuid (:id child-main)))
:inst (str (:name child-inst) " " (pretty-uuid (:id child-inst)))) :inst (str (:name child-inst) " " (pretty-uuid (:id child-inst))))
(cond (cond
(and (nil? child-inst) (nil? child-main)) (and (nil? child-inst) (nil? child-main))
@ -1154,7 +1197,8 @@
(defn- add-shape-to-instance (defn- add-shape-to-instance
[changes component-shape index component-page container root-instance root-main omit-touched? set-remote-synced? components-v2] [changes component-shape index component-page container root-instance root-main omit-touched? set-remote-synced? components-v2]
(log/info :msg (str "ADD [P " (pretty-uuid (:id container)) "] " (shape-log :info (:id component-shape) component-page
:msg (str "ADD [P " (pretty-uuid (:id container)) "] "
(:name component-shape) (:name component-shape)
" " " "
(pretty-uuid (:id component-shape)))) (pretty-uuid (:id component-shape))))
@ -1229,7 +1273,8 @@
(defn- add-shape-to-main (defn- add-shape-to-main
[changes shape index component component-container page root-instance root-main components-v2] [changes shape index component component-container page root-instance root-main components-v2]
(log/info :msg (str "ADD [C " (pretty-uuid (:id component-container)) "] " (shape-log :info (:id shape) page
:msg (str "ADD [C " (pretty-uuid (:id component-container)) "] "
(:name shape) (:name shape)
" " " "
(pretty-uuid (:id shape)))) (pretty-uuid (:id shape))))
@ -1332,7 +1377,8 @@
(defn- remove-shape (defn- remove-shape
[changes shape container omit-touched?] [changes shape container omit-touched?]
(log/info :msg (str "REMOVE-SHAPE " (shape-log :info (:id shape) container
:msg (str "REMOVE-SHAPE "
(if (cfh/page? container) "[P " "[C ") (if (cfh/page? container) "[P " "[C ")
(pretty-uuid (:id container)) "] " (pretty-uuid (:id container)) "] "
(:name shape) (:name shape)
@ -1384,7 +1430,8 @@
(defn- move-shape (defn- move-shape
[changes shape index-before index-after container omit-touched?] [changes shape index-before index-after container omit-touched?]
(log/info :msg (str "MOVE " (shape-log :info (:id shape) container
:msg (str "MOVE "
(if (cfh/page? container) "[P " "[C ") (if (cfh/page? container) "[P " "[C ")
(pretty-uuid (:id container)) "] " (pretty-uuid (:id container)) "] "
(:name shape) (:name shape)
@ -1424,7 +1471,8 @@
(if (nil? (:shape-ref dest-shape)) (if (nil? (:shape-ref dest-shape))
changes changes
(do (do
(log/info :msg (str "CHANGE-TOUCHED " (shape-log :info (:id dest-shape) container
:msg (str "CHANGE-TOUCHED "
(if (cfh/page? container) "[P " "[C ") (if (cfh/page? container) "[P " "[C ")
(pretty-uuid (:id container)) "] " (pretty-uuid (:id container)) "] "
(:name dest-shape) (:name dest-shape)
@ -1466,7 +1514,8 @@
(if (nil? (:shape-ref shape)) (if (nil? (:shape-ref shape))
changes changes
(do (do
(log/info :msg (str "CHANGE-REMOTE-SYNCED? " (shape-log :info (:id shape) container
:msg (str "CHANGE-REMOTE-SYNCED? "
(if (cfh/page? container) "[P " "[C ") (if (cfh/page? container) "[P " "[C ")
(pretty-uuid (:id container)) "] " (pretty-uuid (:id container)) "] "
(:name shape) (:name shape)
@ -1535,7 +1584,8 @@
in the destination shape will not be copied." in the destination shape will not be copied."
[changes dest-shape origin-shape dest-root origin-root container omit-touched?] [changes dest-shape origin-shape dest-root origin-root container omit-touched?]
(log/info :msg (str "SYNC " (shape-log :info (:id dest-shape) container
:msg (str "SYNC "
(:name origin-shape) (:name origin-shape)
" " " "
(pretty-uuid (:id origin-shape)) (pretty-uuid (:id origin-shape))