mirror of
https://github.com/penpot/penpot.git
synced 2026-07-28 17:06:21 +00:00
ae6ca9e115
When a Penpot file is exported without bundled libraries and then imported into a different environment, external library links are broken because library UUIDs differ across environments. This feature adds a heuristic to auto-relink libraries by matching slugified library names against shared files in the target team: - Export: embed external library metadata (id, name, slug, used-by) in the manifest when libraries are not included in the export. - Import: resolve external libraries by slugifying shared file names in the destination team and matching against manifest slugs. - Single match: auto-link silently (creates file-library-rel row). - Multiple matches: emit SSE event so the frontend shows a selection dialog for the user to pick the correct library. - No match: import continues without linking (current behavior). Backend changes: - Extended manifest schema with optional :external-libraries field - Added slugify-name, get-files-names, get-shared-files-for-team, find-shared-files-by-slug helpers in app.binfile.common - Threaded team-id into import cfg from RPC layer - Added resolve-external-libraries and auto-link-libraries in v3 - Emit :library-candidates SSE event for multi-match cases Frontend changes: - Worker captures library-candidates SSE events and forwards them - Import dialog shows auto-link notification and multi-match selection UI with select dropdowns - Added link-files-to-library! RPC helper for user selections - Added en/es translations for new UI strings Closes #9263 Signed-off-by: Andrey Antukh <niwi@niwi.nz>
483 lines
20 KiB
Clojure
483 lines
20 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 backend-tests.binfile-test
|
|
"Internal binfile test, no RPC involved"
|
|
(:require
|
|
[app.binfile.common :as bfc]
|
|
[app.binfile.v3 :as v3]
|
|
[app.common.data :as d]
|
|
[app.common.features :as cfeat]
|
|
[app.common.pprint :as pp]
|
|
[app.common.thumbnails :as thc]
|
|
[app.common.time :as ct]
|
|
[app.common.types.shape :as cts]
|
|
[app.common.uuid :as uuid]
|
|
[app.db :as db]
|
|
[app.db.sql :as sql]
|
|
[app.http :as http]
|
|
[app.rpc :as-alias rpc]
|
|
[app.storage :as sto]
|
|
[app.storage.tmp :as tmp]
|
|
[backend-tests.helpers :as th]
|
|
[clojure.test :as t]
|
|
[cuerdas.core :as str]
|
|
[datoteka.fs :as fs]
|
|
[datoteka.io :as io]))
|
|
|
|
(t/use-fixtures :once th/state-init)
|
|
(t/use-fixtures :each th/database-reset)
|
|
|
|
(defn- update-file!
|
|
[& {:keys [profile-id file-id changes revn] :or {revn 0}}]
|
|
(let [params {::th/type :update-file
|
|
::rpc/profile-id profile-id
|
|
:id file-id
|
|
:session-id (uuid/random)
|
|
:revn revn
|
|
:vern 0
|
|
:features cfeat/supported-features
|
|
:changes changes}
|
|
out (th/command! params)]
|
|
;; (th/print-result! out)
|
|
(t/is (nil? (:error out)))
|
|
(:result out)))
|
|
|
|
(defn- prepare-simple-file
|
|
[profile]
|
|
(let [page-id-1 (uuid/custom 1 1)
|
|
page-id-2 (uuid/custom 1 2)
|
|
shape-id (uuid/custom 2 1)
|
|
file (th/create-file* 1 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared false})]
|
|
(update-file!
|
|
:file-id (:id file)
|
|
:profile-id (:id profile)
|
|
:revn 0
|
|
:vern 0
|
|
:changes
|
|
[{:type :add-page
|
|
:name "test 1"
|
|
:id page-id-1}
|
|
{:type :add-page
|
|
:name "test 2"
|
|
:id page-id-2}])
|
|
|
|
(update-file!
|
|
:file-id (:id file)
|
|
:profile-id (:id profile)
|
|
:revn 0
|
|
:vern 0
|
|
:changes
|
|
[{:type :add-obj
|
|
:page-id page-id-1
|
|
:id shape-id
|
|
:parent-id uuid/zero
|
|
:frame-id uuid/zero
|
|
:components-v2 true
|
|
:obj (cts/setup-shape
|
|
{:id shape-id
|
|
:name "image"
|
|
:frame-id uuid/zero
|
|
:parent-id uuid/zero
|
|
:type :rect})}])
|
|
|
|
(dissoc file :data)))
|
|
|
|
(t/deftest export-binfile-v3
|
|
(let [profile (th/create-profile* 1)
|
|
file (prepare-simple-file profile)
|
|
output (tmp/tempfile :suffix ".zip")]
|
|
|
|
(v3/export-files!
|
|
(-> th/*system*
|
|
(assoc ::bfc/ids #{(:id file)})
|
|
(assoc ::bfc/embed-assets false)
|
|
(assoc ::bfc/include-libraries false))
|
|
(io/output-stream output))
|
|
|
|
(let [result (-> th/*system*
|
|
(assoc ::bfc/project-id (:default-project-id profile))
|
|
(assoc ::bfc/profile-id (:id profile))
|
|
(assoc ::bfc/input output)
|
|
(v3/import-files!))]
|
|
(t/is (map? result))
|
|
(t/is (= 1 (count (:file-ids result))))
|
|
(t/is (every? uuid? (:file-ids result)))
|
|
;; No external libraries in simple case - resolution should be empty
|
|
(t/is (= {} (:resolution result))))))
|
|
|
|
(t/deftest slugify-name-test
|
|
(t/is (= "my-design-system" (bfc/slugify-name "My Design System!")))
|
|
(t/is (= "icons" (bfc/slugify-name "Icons")))
|
|
(t/is (= "brand-colors-2024" (bfc/slugify-name "Brand Colors 2024")))
|
|
(t/is (= "" (bfc/slugify-name "---"))))
|
|
|
|
(t/deftest export-includes-external-libraries
|
|
(let [profile (th/create-profile* 1)
|
|
;; Create a shared library file
|
|
library (th/create-file* 1 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
;; Create a file that uses the library
|
|
file (th/create-file* 2 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared false})]
|
|
|
|
;; Link file to library
|
|
(db/insert! th/*system* :file-library-rel
|
|
{:file-id (:id file)
|
|
:library-file-id (:id library)})
|
|
|
|
;; Export without including libraries
|
|
(let [output (tmp/tempfile :suffix ".zip")]
|
|
(v3/export-files!
|
|
(-> th/*system*
|
|
(assoc ::bfc/ids #{(:id file)})
|
|
(assoc ::bfc/embed-assets false)
|
|
(assoc ::bfc/include-libraries false))
|
|
(io/output-stream output))
|
|
|
|
;; Read the manifest and check external-libraries
|
|
(let [manifest (v3/get-manifest output)]
|
|
(t/is (some? (:external-libraries manifest)))
|
|
(t/is (= 1 (count (:external-libraries manifest))))
|
|
(let [ext-lib (first (:external-libraries manifest))]
|
|
(t/is (= (:id library) (:id ext-lib)))
|
|
(t/is (= "Icons Library" (:name ext-lib)))
|
|
(t/is (= "icons-library" (:slug ext-lib)))
|
|
(t/is (= [(:id file)] (:used-by ext-lib))))))))
|
|
|
|
(t/deftest import-auto-links-single-candidate
|
|
(let [profile (th/create-profile* 1)
|
|
;; Create a shared library file
|
|
library (th/create-file* 1 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
;; Create a file that uses the library
|
|
file (th/create-file* 2 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared false})]
|
|
|
|
;; Link file to library
|
|
(db/insert! th/*system* :file-library-rel
|
|
{:file-id (:id file)
|
|
:library-file-id (:id library)})
|
|
|
|
;; Export without including libraries
|
|
(let [output (tmp/tempfile :suffix ".zip")]
|
|
(v3/export-files!
|
|
(-> th/*system*
|
|
(assoc ::bfc/ids #{(:id file)})
|
|
(assoc ::bfc/embed-assets false)
|
|
(assoc ::bfc/include-libraries false))
|
|
(io/output-stream output))
|
|
|
|
;; Remove the source library to simulate a cross-environment import
|
|
;; where the original library does not exist in the target team.
|
|
(db/update! th/*system* :file
|
|
{:deleted-at (ct/now)}
|
|
{:id (:id library)})
|
|
|
|
;; Now create a new shared library with the same name in the same team
|
|
;; (simulating the library existing in the target environment)
|
|
(let [library2 (th/create-file* 3 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
|
|
result (-> th/*system*
|
|
(assoc ::bfc/project-id (:default-project-id profile))
|
|
(assoc ::bfc/profile-id (:id profile))
|
|
(assoc ::bfc/team-id (:default-team-id profile))
|
|
(assoc ::bfc/input output)
|
|
(v3/import-files!))]
|
|
|
|
;; Check that the library was auto-linked in the resolution
|
|
(let [resolution (:resolution result)
|
|
file-id (first (:file-ids result))
|
|
file-res (get resolution file-id)]
|
|
;; File should have name
|
|
(t/is (some? (:name file-res)))
|
|
;; File should have one auto-linked library in :done
|
|
(t/is (= 1 (count (:done file-res))))
|
|
(let [done-entry (first (:done file-res))]
|
|
(t/is (= (:id library) (:id done-entry)))
|
|
(t/is (= (:id library2) (:linked-to done-entry))))
|
|
;; No pending candidates
|
|
(t/is (= [] (:pending file-res))))
|
|
|
|
;; Verify the file-library-rel was created
|
|
(let [rels (db/query th/*system* :file-library-rel
|
|
{:library-file-id (:id library2)})]
|
|
(t/is (= 1 (count rels))))))))
|
|
|
|
(t/deftest import-no-auto-link-no-match
|
|
(let [profile (th/create-profile* 1)
|
|
;; Create a shared library file
|
|
library (th/create-file* 1 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
;; Create a file that uses the library
|
|
file (th/create-file* 2 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared false})]
|
|
|
|
;; Link file to library
|
|
(db/insert! th/*system* :file-library-rel
|
|
{:file-id (:id file)
|
|
:library-file-id (:id library)})
|
|
|
|
;; Export without including libraries
|
|
(let [output (tmp/tempfile :suffix ".zip")]
|
|
(v3/export-files!
|
|
(-> th/*system*
|
|
(assoc ::bfc/ids #{(:id file)})
|
|
(assoc ::bfc/embed-assets false)
|
|
(assoc ::bfc/include-libraries false))
|
|
(io/output-stream output))
|
|
|
|
;; Remove the source library to simulate a cross-environment import
|
|
;; where no matching library exists in the target team.
|
|
(db/update! th/*system* :file
|
|
{:deleted-at (ct/now)}
|
|
{:id (:id library)})
|
|
|
|
;; Import without any matching library in the team
|
|
(let [result (-> th/*system*
|
|
(assoc ::bfc/project-id (:default-project-id profile))
|
|
(assoc ::bfc/profile-id (:id profile))
|
|
(assoc ::bfc/team-id (:default-team-id profile))
|
|
(assoc ::bfc/input output)
|
|
(v3/import-files!))]
|
|
|
|
;; No auto-linking should happen - resolution should be empty
|
|
(t/is (= {} (:resolution result)))))))
|
|
|
|
(t/deftest import-returns-multi-match-candidates
|
|
(let [profile (th/create-profile* 1)
|
|
;; Create a shared library file
|
|
library (th/create-file* 1 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
;; Create a file that uses the library
|
|
file (th/create-file* 2 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared false})]
|
|
|
|
;; Link file to library
|
|
(db/insert! th/*system* :file-library-rel
|
|
{:file-id (:id file)
|
|
:library-file-id (:id library)})
|
|
|
|
;; Export without including libraries
|
|
(let [output (tmp/tempfile :suffix ".zip")]
|
|
(v3/export-files!
|
|
(-> th/*system*
|
|
(assoc ::bfc/ids #{(:id file)})
|
|
(assoc ::bfc/embed-assets false)
|
|
(assoc ::bfc/include-libraries false))
|
|
(io/output-stream output))
|
|
|
|
;; Remove the source library to simulate a cross-environment import
|
|
;; where the original library does not exist in the target team.
|
|
(db/update! th/*system* :file
|
|
{:deleted-at (ct/now)}
|
|
{:id (:id library)})
|
|
|
|
;; Create TWO shared libraries with the same name
|
|
(let [library2 (th/create-file* 3 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
library3 (th/create-file* 4 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
|
|
result (-> th/*system*
|
|
(assoc ::bfc/project-id (:default-project-id profile))
|
|
(assoc ::bfc/profile-id (:id profile))
|
|
(assoc ::bfc/team-id (:default-team-id profile))
|
|
(assoc ::bfc/input output)
|
|
(v3/import-files!))]
|
|
|
|
;; No auto-linking (multi-match) - check resolution structure
|
|
(let [resolution (:resolution result)
|
|
file-id (first (:file-ids result))
|
|
file-res (get resolution file-id)]
|
|
;; File should have name
|
|
(t/is (some? (:name file-res)))
|
|
;; No auto-linked libraries
|
|
(t/is (= [] (:done file-res)))
|
|
;; Should have pending candidates
|
|
(t/is (= 1 (count (:pending file-res))))
|
|
(let [pending-entry (first (:pending file-res))]
|
|
(t/is (= (:id library) (:id pending-entry)))
|
|
(t/is (= 2 (count (:candidates pending-entry))))
|
|
;; Each candidate should have project info
|
|
(doseq [candidate (:candidates pending-entry)]
|
|
(t/is (some? (:project-id candidate)))
|
|
(t/is (some? (:project-name candidate))))))
|
|
|
|
;; No file-library-rel should be created automatically
|
|
(let [rels (db/query th/*system* :file-library-rel
|
|
{:library-file-id (:id library2)})]
|
|
(t/is (= 0 (count rels))))
|
|
(let [rels (db/query th/*system* :file-library-rel
|
|
{:library-file-id (:id library3)})]
|
|
(t/is (= 0 (count rels))))))))
|
|
|
|
(t/deftest import-auto-link-respects-library-permissions
|
|
(let [owner (th/create-profile* 1)
|
|
team (th/create-team* 1 {:profile-id (:id owner)})
|
|
viewer (th/create-profile* 2)
|
|
_ (th/create-team-role* {:team-id (:id team)
|
|
:profile-id (:id viewer)
|
|
:role :viewer})
|
|
|
|
library (th/create-file* 1 {:profile-id (:id owner)
|
|
:project-id (:default-project-id owner)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
file (th/create-file* 2 {:profile-id (:id owner)
|
|
:project-id (:default-project-id owner)
|
|
:is-shared false})]
|
|
|
|
;; Link file to library
|
|
(db/insert! th/*system* :file-library-rel
|
|
{:file-id (:id file)
|
|
:library-file-id (:id library)})
|
|
|
|
;; Export without including libraries
|
|
(let [output (tmp/tempfile :suffix ".zip")]
|
|
(v3/export-files!
|
|
(-> th/*system*
|
|
(assoc ::bfc/ids #{(:id file)})
|
|
(assoc ::bfc/embed-assets false)
|
|
(assoc ::bfc/include-libraries false))
|
|
(io/output-stream output))
|
|
|
|
;; Remove the source library and recreate a matching one owned by owner
|
|
(db/update! th/*system* :file
|
|
{:deleted-at (ct/now)}
|
|
{:id (:id library)})
|
|
|
|
;; Create a project in the team for the matched library and import.
|
|
(let [project (th/create-project* 1 {:profile-id (:id owner)
|
|
:team-id (:id team)})
|
|
|
|
library2 (th/create-file* 3 {:profile-id (:id owner)
|
|
:project-id (:id project)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
|
|
result (-> th/*system*
|
|
(assoc ::bfc/project-id (:id project))
|
|
(assoc ::bfc/profile-id (:id viewer))
|
|
(assoc ::bfc/team-id (:id team))
|
|
(assoc ::bfc/input output)
|
|
(v3/import-files!))]
|
|
|
|
;; Auto-link must be skipped because viewer cannot edit the library
|
|
(let [resolution (:resolution result)
|
|
file-id (first (:file-ids result))
|
|
file-res (get resolution file-id)]
|
|
;; No auto-linked libraries - file may not be in resolution map at all
|
|
(t/is (or (nil? file-res)
|
|
(= [] (:done file-res)))))
|
|
|
|
;; No file-library-rel should have been created
|
|
(let [rels (db/query th/*system* :file-library-rel
|
|
{:library-file-id (:id library2)})]
|
|
(t/is (= 0 (count rels))))
|
|
|
|
;; Control: the same import performed by the owner (who has edit
|
|
;; permission on the library) should auto-link.
|
|
(let [result (-> th/*system*
|
|
(assoc ::bfc/project-id (:id project))
|
|
(assoc ::bfc/profile-id (:id owner))
|
|
(assoc ::bfc/team-id (:id team))
|
|
(assoc ::bfc/input output)
|
|
(v3/import-files!))]
|
|
|
|
(let [resolution (:resolution result)
|
|
file-id (first (:file-ids result))
|
|
file-res (get resolution file-id)]
|
|
;; Should have name
|
|
(t/is (some? (:name file-res)))
|
|
;; Should have one auto-linked library
|
|
(t/is (= 1 (count (:done file-res))))
|
|
(t/is (= (:id library2) (:linked-to (first (:done file-res))))))
|
|
|
|
(let [rels (db/query th/*system* :file-library-rel
|
|
{:library-file-id (:id library2)})]
|
|
(t/is (= 1 (count rels)))))))))
|
|
|
|
(t/deftest import-auto-link-only-files-that-used-library
|
|
(let [profile (th/create-profile* 1)
|
|
library (th/create-file* 1 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
file1 (th/create-file* 2 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared false})
|
|
file2 (th/create-file* 3 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared false})]
|
|
|
|
;; Only file1 uses the library
|
|
(db/insert! th/*system* :file-library-rel
|
|
{:file-id (:id file1)
|
|
:library-file-id (:id library)})
|
|
|
|
;; Export both files without including libraries
|
|
(let [output (tmp/tempfile :suffix ".zip")]
|
|
(v3/export-files!
|
|
(-> th/*system*
|
|
(assoc ::bfc/ids #{(:id file1) (:id file2)})
|
|
(assoc ::bfc/embed-assets false)
|
|
(assoc ::bfc/include-libraries false))
|
|
(io/output-stream output))
|
|
|
|
;; Remove the source library and recreate a matching one
|
|
(db/update! th/*system* :file
|
|
{:deleted-at (ct/now)}
|
|
{:id (:id library)})
|
|
|
|
(let [library2 (th/create-file* 4 {:profile-id (:id profile)
|
|
:project-id (:default-project-id profile)
|
|
:is-shared true
|
|
:name "Icons Library"})
|
|
|
|
result (-> th/*system*
|
|
(assoc ::bfc/project-id (:default-project-id profile))
|
|
(assoc ::bfc/profile-id (:id profile))
|
|
(assoc ::bfc/team-id (:default-team-id profile))
|
|
(assoc ::bfc/input output)
|
|
(v3/import-files!))]
|
|
|
|
;; The library should be auto-linked for the file that used it
|
|
(let [resolution (:resolution result)
|
|
;; Find the file that has auto-linked libraries
|
|
file-with-done (d/seek #(seq (:done %)) (vals resolution))]
|
|
(t/is (some? file-with-done))
|
|
;; Should have name
|
|
(t/is (some? (:name file-with-done)))
|
|
(t/is (= 1 (count (:done file-with-done))))
|
|
(t/is (= (:id library2) (:linked-to (first (:done file-with-done))))))
|
|
|
|
;; But only one file-library-rel should exist (for file1)
|
|
(let [rels (db/query th/*system* :file-library-rel
|
|
{:library-file-id (:id library2)})]
|
|
(t/is (= 1 (count rels))))))))
|