penpot/common/test/common_tests/logic/comp_flex_interactions_test.cljc
Alonso Torres cb8f563bb2
🐛 Keep swapped and moved children in place when a component syncs (#12716)
* 🐛 Keep swapped and moved children in place when a component syncs

A sync resets an untouched shape of a copy to the main's geometry and the
layout then moves it back. Children the sync keeps, because they are
swapped or the user moved them, did not take the first move but did take
the second, so each sync pushed them away from their parent by the gap
between the copy and the main (e.g. a swapped icon in a copy that fills a
wider layout).

The sync now moves those children by the offset it applies to their
parent. Flex-child attributes still sync as before, so swapped children
keep their absolute position.

Closes #12657

* 🐛 Place swapped children where the swap puts them on sync and switch

A swapped child that the user never moved now goes to the top-left of the
shape it replaced, as a swap does: on a sync, the place of the main's slot
occupant; on a variant switch, the place of the new variant's occupant.
A swapped child the user moved keeps its offset inside its parent.

This stops the variant switch from leaving the swapped child at its old
position while the new variant is created at the main's size, and puts
back children that drifted before the sync fix the next time their copy
syncs.

* 🐛 Make kept children follow their parent's constraints on component sync

When a sync resets the size of a copy's shape, for example a copy root
that fills a wider layout, the layout then grows it back and moves its
children by their constraints. Children the sync keeps (moved by the
user, or swapped) only followed the parent's top-left, so with a right,
center or scale constraint they drifted on every sync, and a swapped
child with a scale constraint grew on every sync.

The sync now passes the parent's geometry before and after down the
tree, and kept children follow that change through their constraints.
Untouched swapped children also undo the change through their
constraints before they go to the swap place, so they keep their size.

The default constraint modifier returns empty modifiers instead of an
empty vector, which add-modifiers could not take.

* 🐛 Make swapped children follow their parent's constraints on switch

A variant switch only moved a swapped child by the parent's position
change. When the new variant's root had a different size, a user-moved
child with a right constraint drifted, and a scale-constrained one kept
its grown size.

The switch now applies the parent change from the old parent to the new
one through the child's constraints. An untouched swapped child then
takes the place of the shape it replaces, as a swap does.

* 🐛 Sync nested swapped copies before the copies that hold them

A swapped child is a copy of its own component, so one sync handles it
twice: once on its own, and once when the copy that holds it places it.
Each step read the shape from the data as it was before the sync, so
the step that ran last won, and the order came from the order of shape
ids. When the swapped child came last, it wrote its old size and
position back over the placement, leaving its x and selrect apart, and
a swapped child with a scale constraint grew on every sync.

The sync now visits the most deeply nested shapes first, and each step
reads the shapes as the earlier steps left them, so the placement
always comes last and builds on the child's own sync.

* 🐛 Keep moved children with a scale constraint at their size on switch

A variant switch carries the size of a child the user moved as an
override. In a copy that fills a wider layout, a child with a scale
constraint already has the size the layout gave it, so the switch
carried that size onto the new variant, created at the main's size, and
the layout then scaled it again: the child grew on every switch.

Before comparing, the switch now resizes the previous child the way its
constraints follow the change from its old parent to its new one. A
child that only grew with the layout then matches the main and is not
carried as an override.

* 🐛 Keep the content of swapped children at its size on sync and switch

When a sync or a variant switch undid the parent change on a swapped
child through its constraints, it applied the child's resize to every
shape inside it. The layout then grows the child back through its own
constraint, but its content follows its own constraints (left and top
by default), so it stayed shrunk: the shape inside a swapped icon with
a scale constraint lost most of its width on every switch.

The change of the swapped child now goes down its subtree the way a
layout update does, each shape through its own constraints.

* 🐛 Accept mixed and empty values in the layout size constraints menu

With several shapes or a group selected, the sidebar merges the layout
item attributes and tokens of the shapes: nil when a shape lacks one,
:multiple when they differ. The props schema of layout-size-constraints*
only accepted the values of a single shape, so selecting such shapes
with fill sizing raised "invalid props".

The schema now accepts nil and :multiple, as the numeric inputs those
values go to do.

* ♻️ Share the swapped child follow-parent step between sync and switch

The component sync and the variant switch both make a swapped child and
its children follow the parent change through their constraints and then
move them to the swap place. Both now use generate-follow-parent, so the
two paths stay the same. The helper that writes geometry without marking
it touched is renamed to update-geometry-untouched.

Adds a test for a swapped child without absolute position in a slot
without layout, and fixes the test comments on why constraints are set
again after a swap.
2026-10-29 17:30:16 +01:00

471 lines
22 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 SUBSIDIARY SL
(ns common-tests.logic.comp-flex-interactions-test
(:require
[app.common.files.changes-builder :as pcb]
[app.common.geom.point :as gpt]
[app.common.geom.shapes :as gsh]
[app.common.logic.libraries :as cll]
[app.common.math :as mth]
[app.common.test-helpers.components :as thc]
[app.common.test-helpers.compositions :as tho]
[app.common.test-helpers.files :as thf]
[app.common.test-helpers.ids-map :as thi]
[app.common.test-helpers.shapes :as ths]
[app.common.types.component :as ctk]
[app.common.types.container :as ctn]
[app.common.types.modifiers :as ctm]
[clojure.test :as t]))
(t/use-fixtures :each thi/test-fixture)
(defn- setup-file
"Flex component and copy whose children navigate to different boards."
[]
(-> (thf/sample-file :file1)
(tho/add-simple-component-with-copy :component1
:main-root
:main-child
:copy-root
:main-root-params {:layout :flex
:layout-flex-dir :row}
:copy-root-params {:children-labels [:copy-child]})
(ths/add-sample-shape :main-popup :type :frame)
(ths/add-sample-shape :copy-popup :type :frame)
(ths/add-interaction :main-child :main-popup)
(ths/add-interaction :copy-child :copy-popup)))
(defn- destinations
[shape]
(mapv :destination (:interactions shape)))
(t/deftest test-sync-flex-main-keeps-copy-interactions
(let [;; ==== Setup
file (setup-file)
margin {:m1 5 :m2 5 :m3 5 :m4 5}
;; ==== Action
updated-file (tho/change-shape file :main-child
#(assoc % :hidden true :layout-item-margin margin))
changes (cll/generate-sync-file-changes (pcb/empty-changes)
nil
:components
(:id updated-file)
(thi/id :component1)
(:id updated-file)
{(:id updated-file) updated-file}
(:id updated-file))
file' (thf/apply-changes updated-file changes)
;; ==== Get
copy-child' (ths/get-shape file' :copy-child)]
;; ==== Check
(t/is (true? (:hidden copy-child')))
(t/is (= margin (:layout-item-margin copy-child')))
(t/is (= [(thi/id :copy-popup)] (destinations copy-child')))))
(t/deftest test-sync-flex-copy-to-main-keeps-main-interactions
(let [;; ==== Setup
file (setup-file)
;; ==== Action
updated-file (tho/change-shape file :copy-child #(assoc % :hidden true))
page (thf/current-page updated-file)
container (ctn/make-container page :page)
changes (-> (pcb/empty-changes)
(pcb/with-container container)
(cll/generate-sync-shape-inverse (:data updated-file)
{(:id updated-file) updated-file}
container
(thi/id :copy-root)))
file' (thf/apply-changes updated-file changes)
;; ==== Get
main-child' (ths/get-shape file' :main-child)]
;; ==== Check
(t/is (true? (:hidden main-child')))
(t/is (= [(thi/id :main-popup)] (destinations main-child')))))
(defn- setup-library-and-file
"Library flex component with a nested copy, and a file instance whose
nested copy has an interaction."
[]
(let [library (-> (thf/sample-file :library)
(tho/add-nested-component :component1
:main1-root
:main1-child
:component2
:main2-root
:nested-head
:main2-root-params {:layout :flex
:layout-flex-dir :row}))
file (-> (thf/sample-file :file)
(ths/add-sample-shape :copy-popup :type :frame)
(thc/instantiate-component :component2
:copy2-root
:library library
:children-labels [:copy-nested-head])
(ths/add-interaction :copy-nested-head :copy-popup))]
[library file]))
(defn- sync-file-from-library
[file library]
(cll/generate-sync-file-changes (pcb/empty-changes)
nil
nil
(:id file)
nil
(:id library)
{(:id library) library
(:id file) file}
(:id file)))
(t/deftest test-sync-library-flex-keeps-nested-copy-interactions
(let [;; ==== Setup
[library file] (setup-library-and-file)
copy-x (:x (tho/bottom-shape file :copy2-root))
;; ==== Action
library' (-> library
(tho/change-shape :main1-child #(gsh/move % (gpt/point 1 0)))
(tho/propagate-component-changes :component1))
file' (thf/apply-changes file (sync-file-from-library file library'))
;; ==== Get
copy-nested-head' (ths/get-shape file' :copy-nested-head)]
;; ==== Check
(t/is (mth/close? (inc copy-x) (:x (tho/bottom-shape file' :copy2-root))))
(t/is (= [(thi/id :copy-popup)] (destinations copy-nested-head')))))
(defn- swap-to-library-component
"Swap a shape in `file` to a component that lives in `library`, keeping
flex-item attrs the way production `component-swap` does."
[file library shape-label new-component-label]
(let [shape (ths/get-shape file shape-label)
page (thf/current-page file)
keep-props-values (select-keys shape ctk/swap-keep-attrs)
libraries {(:id library) library
(:id file) file}
id-new (:id (thc/get-component library new-component-label))
[_ _ changes] (cll/generate-component-swap
(pcb/empty-changes nil (:id page))
(:objects page)
shape
(:data library)
page
libraries
id-new
0
nil
keep-props-values
false)]
(thf/apply-changes file changes)))
(defn- setup-library-with-absolute-nested-icon
"Library: icon A, icon B, and a flex board whose nested child is an
instance of icon A with absolute position."
[]
(-> (thf/sample-file :library)
(tho/add-simple-component :icon-a :icon-a-root :icon-a-child)
(tho/add-simple-component :icon-b :icon-b-root :icon-b-child)
(tho/add-frame :board-root {:name "Board"
:layout :flex
:layout-flex-dir :row})
(thc/instantiate-component :icon-a :nested-head {:parent-label :board-root})
(tho/change-shape :nested-head #(assoc % :layout-item-absolute true))
(thc/make-component :board :board-root)))
(t/deftest test-sync-library-keeps-swapped-nested-absolute
(let [;; ==== Setup
library (setup-library-with-absolute-nested-icon)
file (-> (thf/sample-file :file)
(thc/instantiate-component :board
:copy-board
:library library
:children-labels [:copy-nested-head]))
file (swap-to-library-component file library :copy-nested-head :icon-b)
swapped (ths/get-shape file :copy-nested-head)
;; ==== Action
library' (tho/change-shape library :board-root
#(assoc % :fills (ths/sample-fills-color :fill-color "#fabada")))
file' (thf/apply-changes file (sync-file-from-library file library'))
swapped' (ths/get-shape file' :copy-nested-head)]
;; ==== Check
(t/is (true? (:layout-item-absolute swapped)))
(t/is (some? (ctk/get-swap-slot swapped)))
(t/is (= (thi/id :icon-b) (:component-id swapped)))
(t/is (some? (ctk/get-swap-slot swapped')))
(t/is (= (thi/id :icon-b) (:component-id swapped')))
(t/is (true? (:layout-item-absolute swapped')))))
(t/deftest test-sync-library-propagates-slot-absolute-to-swapped-nested
(let [;; ==== Setup
library (setup-library-with-absolute-nested-icon)
file (-> (thf/sample-file :file)
(thc/instantiate-component :board
:copy-board
:library library
:children-labels [:copy-nested-head]))
file (swap-to-library-component file library :copy-nested-head :icon-b)
;; ==== Action
library' (tho/change-shape library :nested-head
#(assoc % :layout-item-absolute false))
file' (thf/apply-changes file (sync-file-from-library file library'))
swapped' (ths/get-shape file' :copy-nested-head)]
;; ==== Check
(t/is (some? (ctk/get-swap-slot swapped')))
(t/is (= (thi/id :icon-b) (:component-id swapped')))
(t/is (not (true? (:layout-item-absolute swapped'))))))
(t/deftest test-sync-library-flex-child-attrs-to-unswapped-sibling
(let [;; ==== Setup
margin {:m1 5 :m2 5 :m3 5 :m4 5}
library (-> (thf/sample-file :library)
(tho/add-simple-component :icon-a :icon-a-root :icon-a-child)
(tho/add-simple-component :icon-b :icon-b-root :icon-b-child)
(tho/add-frame :board-root {:name "Board"
:layout :flex
:layout-flex-dir :row})
(thc/instantiate-component :icon-a :nested-head {:parent-label :board-root})
(ths/add-sample-shape :sibling :type :rect :name "Sibling" :parent-label :board-root)
(tho/change-shape :nested-head #(assoc % :layout-item-absolute true))
(thc/make-component :board :board-root))
file (-> (thf/sample-file :file)
(thc/instantiate-component :board
:copy-board
:library library
:children-labels [:copy-nested-head :copy-sibling]))
file (swap-to-library-component file library :copy-nested-head :icon-b)
;; ==== Action
library' (tho/change-shape library :sibling
#(assoc % :layout-item-margin margin))
file' (thf/apply-changes file (sync-file-from-library file library'))
sibling' (ths/get-shape file' :copy-sibling)
swapped' (ths/get-shape file' :copy-nested-head)]
;; ==== Check
(t/is (= margin (:layout-item-margin sibling')))
(t/is (true? (:layout-item-absolute swapped')))
(t/is (some? (ctk/get-swap-slot swapped')))))
(defn- setup-library-with-icon-slot
"Library: icon A, icon B, and a flex board whose `:slot` frame holds an
instance of icon A. The slot has a flex layout and the icon is absolute;
with `:layout? false` the slot has no layout and the icon is a plain child."
[& {:keys [layout?] :or {layout? true}}]
(-> (thf/sample-file :library)
(tho/add-simple-component :icon-a :icon-a-root :icon-a-child)
(tho/add-simple-component :icon-b :icon-b-root :icon-b-child)
(tho/add-frame :board-root {:name "Board"
:layout :flex
:layout-flex-dir :row})
(tho/add-frame :slot (cond-> {:name "Slot" :parent-label :board-root}
layout? (assoc :layout :flex :layout-flex-dir :row)))
(thc/instantiate-component :icon-a :nested-head {:parent-label :slot})
(cond-> layout? (tho/change-shape :nested-head #(assoc % :layout-item-absolute true)))
(thc/make-component :board :board-root)))
(defn- instantiate-board
"File with a copy of the library board, labelling its slot and nested icon."
[library]
(let [file (-> (thf/sample-file :file)
(thc/instantiate-component :board
:copy-board
:library library
:children-labels [:copy-slot]))
slot (ths/get-shape file :copy-slot)]
(thi/set-id! :copy-nested-head (first (:shapes slot)))
file))
(defn- offset-in-slot
[file slot-label icon-label]
(let [slot (ths/get-shape file slot-label)
icon (ths/get-shape file icon-label)]
(gpt/point (- (:x icon) (:x slot))
(- (:y icon) (:y slot)))))
(defn- sync-after-unrelated-change
[file library root-label]
(let [library' (tho/change-shape library root-label
#(assoc % :fills (ths/sample-fills-color :fill-color "#fabada")))]
(thf/apply-changes file (sync-file-from-library file library'))))
(t/deftest test-sync-places-swapped-child-in-moved-slot
(let [;; ==== Setup
library (setup-library-with-icon-slot)
file (-> (instantiate-board library)
(swap-to-library-component library :copy-nested-head :icon-b)
;; The layout moves the slot, and a previous sync moved the icon away
(tho/move-shape-tree :copy-slot (gpt/point 800 0) :ignore-touched true)
(tho/move-shape-tree :copy-nested-head (gpt/point 800 0) :ignore-touched true))
;; ==== Action
file' (sync-after-unrelated-change file library :board-root)]
;; ==== Check
(t/is (gpt/close? (offset-in-slot library :slot :nested-head)
(offset-in-slot file' :copy-slot :copy-nested-head)))
(t/is (true? (:layout-item-absolute (ths/get-shape file' :copy-nested-head))))))
(t/deftest test-sync-places-swapped-child-in-moved-slot-without-layout
(let [;; ==== Setup
library (setup-library-with-icon-slot :layout? false)
file (-> (instantiate-board library)
(swap-to-library-component library :copy-nested-head :icon-b)
;; The layout moves the slot, and a previous sync moved the icon away
(tho/move-shape-tree :copy-slot (gpt/point 800 0) :ignore-touched true)
(tho/move-shape-tree :copy-nested-head (gpt/point 800 0) :ignore-touched true))
;; ==== Action
file' (sync-after-unrelated-change file library :board-root)]
;; ==== Check
(t/is (gpt/close? (offset-in-slot library :slot :nested-head)
(offset-in-slot file' :copy-slot :copy-nested-head)))))
(t/deftest test-sync-keeps-moved-child-in-moved-slot
(let [;; ==== Setup
library (setup-library-with-icon-slot)
file (-> (instantiate-board library)
(tho/move-shape-tree :copy-nested-head (gpt/point 5 0))
(tho/move-shape-tree :copy-slot (gpt/point 800 0) :ignore-touched true))
before (offset-in-slot file :copy-slot :copy-nested-head)
;; ==== Action
file' (sync-after-unrelated-change file library :board-root)]
;; ==== Check
(t/is (gpt/close? before (offset-in-slot file' :copy-slot :copy-nested-head)))))
(t/deftest test-sync-keeps-user-moved-swapped-child-in-moved-slot
(let [;; ==== Setup
library (setup-library-with-icon-slot)
file (-> (instantiate-board library)
(swap-to-library-component library :copy-nested-head :icon-b)
(tho/move-shape-tree :copy-nested-head (gpt/point 5 0))
(tho/move-shape-tree :copy-slot (gpt/point 800 0) :ignore-touched true))
before (offset-in-slot file :copy-slot :copy-nested-head)
;; ==== Action
file' (sync-after-unrelated-change file library :board-root)]
;; ==== Check
(t/is (gpt/close? before (offset-in-slot file' :copy-slot :copy-nested-head)))))
(defn- with-shapes-first
"Puts the shapes with the given labels first in the page objects, in that
order. The sync visits the shapes of a page in this order."
[file labels]
(let [page-id (:id (thf/current-page file))
ids (mapv thi/id labels)]
(update-in file [:data :pages-index page-id :objects]
(fn [objects]
(apply array-map (concat (mapcat #(vector % (get objects %)) ids)
(mapcat identity (apply dissoc objects ids))))))))
(t/deftest test-sync-places-swapped-child-where-main-slot-occupant-is
(let [;; ==== Setup
library (setup-library-with-icon-slot)
file (-> (instantiate-board library)
(swap-to-library-component library :copy-nested-head :icon-b)
;; The copy comes before its swapped icon, which the sync also syncs on its own
(with-shapes-first [:copy-board :copy-nested-head]))
;; ==== Action
library' (-> library
(tho/move-shape-tree :nested-head (gpt/point 4 4))
(tho/change-shape :icon-b-root #(gsh/transform-shape % (ctm/change-size % 32 nil))))
file' (thf/apply-changes file (sync-file-from-library file library'))
;; ==== Get
icon' (ths/get-shape file' :copy-nested-head)]
;; ==== Check
(t/is (gpt/close? (offset-in-slot library' :slot :nested-head)
(offset-in-slot file' :copy-slot :copy-nested-head)))
(t/is (mth/close? (:width (ths/get-shape library' :icon-b-root)) (:width icon')))
(t/is (mth/close? (:x icon') (-> icon' :selrect :x)))))
(defn- setup-library-with-root-icon
"Library: icon A, and a 300px wide flex card whose `:close` child, placed
directly in the root, is an absolute instance of icon A with the given
horizontal constraint."
[constraints-h]
(-> (thf/sample-file :library)
(tho/add-simple-component :icon-a :icon-a-root :icon-a-child
:root-params {:width 24 :height 24}
:child-params {:width 24 :height 24})
(tho/add-simple-component :icon-b :icon-b-root :icon-b-child
:root-params {:width 24 :height 24}
:child-params {:width 24 :height 24})
(tho/add-frame :card-root {:name "Card"
:layout :flex
:layout-flex-dir :row
:width 300
:height 48})
(thc/instantiate-component :icon-a :close {:parent-label :card-root})
(tho/change-shape :close #(assoc % :layout-item-absolute true :constraints-h constraints-h))
(thc/make-component :card :card-root)))
(defn- instantiate-filled-card
"File with a copy of the card, widened by 800px and with its close icon
moved by `icon-shift`, the way the layout does when the copy fills a wider
parent."
[library icon-shift]
(-> (thf/sample-file :file)
(thc/instantiate-component :card
:copy-card
:library library
:children-labels [:copy-close])
(tho/change-shape :copy-card
#(gsh/transform-shape % (ctm/change-size % (+ (:width %) 800) nil))
:ignore-touched true)
(tho/move-shape-tree :copy-close (gpt/point icon-shift 0) :ignore-touched true)))
(t/deftest test-sync-moved-root-child-follows-root-through-right-constraint
(let [;; ==== Setup
library (setup-library-with-root-icon :right)
file (-> (instantiate-filled-card library 800)
(tho/move-shape-tree :copy-close (gpt/point 5 0)))
;; ==== Action
file' (sync-after-unrelated-change file library :card-root)]
;; ==== Check
(t/is (gpt/close? (gpt/add (offset-in-slot library :card-root :close) (gpt/point 5 0))
(offset-in-slot file' :copy-card :copy-close)))))
(t/deftest test-sync-scales-swapped-root-child-back-with-root
(let [;; ==== Setup
library (setup-library-with-root-icon :scale)
file (-> (instantiate-filled-card library 0)
(swap-to-library-component library :copy-close :icon-b)
;; The swap drops the constraints; set them again so this path runs
(tho/change-shape :copy-close #(assoc % :constraints-h :scale)))
;; ==== Action
file' (sync-after-unrelated-change file library :card-root)
;; ==== Get
scale (/ (:width (ths/get-shape file' :copy-card))
(:width (ths/get-shape file :copy-card)))
inner #(ths/get-shape-by-id % (first (:shapes (ths/get-shape % :copy-close))))]
;; ==== Check
(t/is (mth/close? (* scale (:width (ths/get-shape file :copy-close)))
(:width (ths/get-shape file' :copy-close))))
;; The icon content follows the icon through its own (left) constraint
(t/is (mth/close? (:width (inner file)) (:width (inner file'))))))