mirror of
https://github.com/penpot/penpot.git
synced 2026-11-10 03:50:33 +00:00
29373fff9f
* ✨ Rework the import dialog The import wizard paints a Check/Upload/Import stepper derived from the dialog status, plus a phase title, a description and a progress bar per phase, and its rows follow the new design: folder icon, file name and a size subtitle. While checking, the dialog shows no rows and no spinner, because the phase header already carries the message. The wizard writes the job milestone once, in the header (`jp/current-milestone-text`), since every file of a container reports the same one. A row keeps its name and its size, says "Ready" once its container finished uploading, and shows the error text when it fails; the button that drops a file only appears while the wizard still offers its import step. The `jobs.queued` label now reads "Waiting job slot". The bar measures the whole import: determinate while the containers are uploaded, weighted by their size (`imp/upload-pct`), and animated otherwise, because the stages of a job are not comparable. The phase title counts the files, and `imp/imported-count` counts them done with the job's own counter, so the number moves while a container rebuilds its files one by one. The analysis reads the entries of a version 3 package in one pass: a file shows what it occupies inside its container, its own entries plus the storage objects its media and thumbnails reference, while what the container weighs stays in `:container-size`, the size the upload bar is weighed on. The ready step waits for the end of the analysis (`imp/ready-to-import?`), not for every known file, so Continue never leaves out the files that arrive later. Tests cover the file sizes, the upload percentage, the done counter, the wizard step and the milestone in course. The change also adds `-XX:NativeMemoryTracking=summary` to the backend devenv so `jcmd` shows native memory, and documents the wizard, the promise call styles (`mem:clojure/promesa`) and two CSS pitfalls: a logical `inline-size` wins over an inline physical `width`, and Rumext leaves a plain `:style` map raw, so inline styles leave CLJS as `#js` objects. AI-assisted-by: glm-5.3-flash AI-assisted-by: deepseek-v4.1-flash * ✨ Rework the export dialog Every exported file is its own job, so each row reports its own state: folder icon, name and a size-plus-`.penpot` subtitle; waiting for a worker; running with the milestone of the job and an animated bar; or exported with a tick. A failed row paints red, takes the close icon and shows the hint of the job, or a generic label, through `files-export-modal.export-error`. Success, failure and cancellation replace each other, so a row never reports two outcomes at once. The ids of the messages are canonicalized to string before they match a row, because they cross serialization boundaries. The export result now carries `:size`, so the subtitle says the format until the job produces the artifact and the size once it exists; a transport failure builds a synthetic error, so a nil `ex-data` no longer leaves the row hanging. The header counts the files and says whether the export runs or ended; since every file has its own job, it paints no global bar. Closing changes too: the Close button is gone. While files are in flight the footer offers Cancel export and the X cancels as well, which marks the loading rows cancelled and leaves them in place, so their outcome can be read; once every row reached a terminal state the footer offers Done, which dismisses the dialog. The retry button of the finished design is left out, because the client has no retry mechanism yet. Styles come along: the rows scroll while the header and the footer stay put, and the new phase header, row and bar follow the tokens of the import wizard. The title key becomes `files-export-modal.title`, and the new keys cover the header, the row states and the buttons. AI-assisted-by: muse-spark-1.3 * ♻️ Inline the binfile job adapters into their task handlers The wrappers in app.binfile.jobs only forwarded to the core, so each task handler now composes its own run: frozen cfg, active check, progress bridge and format dispatch. export-cfg freezes the whole export (file-ids, export-type, output) and v3/export-files! takes it as its single argument; ::bfc/ids becomes ::bfc/file-ids. The bridge keeps one job: bfj/run forwards the cfg to its callback, and check-active answers with it to thread the run. AI-assisted-by: muse-spark-1.3 * 🐛 Migrate binfile tests to the single-arg export-files! The refactor made v3/export-files! take a single cfg carrying ::bfc/file-ids and ::bfc/output, but six calls in binfile_test (added by the tokens handling change) still used the old two-arg form with ::bfc/ids. Move them to the new form, as the rest of the file already does. AI-assisted-by: muse-spark-1.3 * 🐛 Fix export artifact expectations to include file size The export flow now reports the artifact size, but the stale expectations dropped it and failed the frontend suite. Include the size in both assertions so they match the emitted message. AI-assisted-by: muse-spark-1.3-contributor * 🐛 Migrate remaining export-files! test callers to the single-arg form rpc_binfile_test and offload_file_data_test still passed the output apart and used ::bfc/ids; move both into the cfg as ::bfc/file-ids/::bfc/output. * 🐛 Hide the downloads hint when no file was exported After Cancel or when every job failed, the export header said "0 files exported · Check your downloads folder."; drop the hint then. * ♻️ Read the object of a container entry once The index of a container asked twice for the object of the same zip entry: once to test it and once as the key of the update. Resolve it once, in the branch that owns it, so the entries of a file never pay for a question that does not apply to them. Addresses a review note on #12192. AI-assisted-by: deepseek-v4.1-flash * ♻️ Never size an import row with its container's weight A row of a version 3 package took the size of the container whenever the container held no entry for its file, while the comment beside it promised the opposite. An unknown size now stays nil, which the row already understands: it paints no subtitle instead of a number that belongs to the whole package. The test carries a file the manifest lists and the container does not hold, and the memory records what the row does then. Addresses a review note on #12192. AI-assisted-by: deepseek-v4.1-flash * 🐛 Retry pool stats read until snapshot is consistent Hikari exposes each pool counter through a separate MXBean call, so a borrow or return between the reads can leave one snapshot off by one. The test read once and failed in CI with total 2 vs active + idle 3. Read up to 20 times with a 10ms pause until total equals active + idle, then assert on the stable snapshot. The invariant stays strict; only the transient race is tolerated. AI-assisted-by: muse-spark-1.3-contributor --------- Co-authored-by: Elena Torro <elenatorro@gmail.com>
271 lines
11 KiB
Clojure
271 lines
11 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 backend-tests.tasks.binfile-jobs-integration-test
|
|
"The whole chain of a binfile job, without a full end-to-end: the
|
|
command creates the job, the dispatcher sends it to its own queue, the
|
|
runner of that queue executes it and the artifact it produced (or
|
|
consumed) ends up where the ledger says."
|
|
(:require
|
|
[app.binfile.common :as bfc]
|
|
[app.binfile.jobs :as bfj]
|
|
[app.binfile.v3 :as v3]
|
|
[app.common.time :as ct]
|
|
[app.common.uuid :as uuid]
|
|
[app.config :as cf]
|
|
[app.db :as db]
|
|
[app.jobs :as jobs]
|
|
[app.metrics :as-alias mtx]
|
|
[app.msgbus :as-alias mbus]
|
|
[app.redis :as rds]
|
|
[app.rpc :as-alias rpc]
|
|
[app.storage :as sto]
|
|
[app.storage.tmp :as tmp]
|
|
[app.worker :as wrk]
|
|
[app.worker.dispatcher :as wdisp]
|
|
[app.worker.runner :as wrkr]
|
|
[backend-tests.helpers :as th]
|
|
[clojure.java.io :as jio]
|
|
[clojure.test :as t]
|
|
[datoteka.io :as io]))
|
|
|
|
(t/use-fixtures :once th/state-init)
|
|
(t/use-fixtures :each (th/serial th/database-reset th/clean-storage))
|
|
|
|
(def ^:private fixture
|
|
"A real penpot export, the same fixture the binfile tests read."
|
|
"backend_tests/test_files/svg-attrs-camel-case.penpot")
|
|
|
|
(def ^:private fast-timeout
|
|
"A runner of an empty queue must not make the test wait for the default
|
|
timeout of the production loop."
|
|
(ct/duration {:millis 200}))
|
|
|
|
(defn- get-storage
|
|
[]
|
|
(assoc (:app.storage/storage th/*system*) ::sto/backend :fs))
|
|
|
|
(defn- import-fixture!
|
|
"A file in the default project of the profile, imported from the
|
|
fixture through the core."
|
|
[profile]
|
|
(-> 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 (-> fixture io/resource jio/file))
|
|
(v3/import-files!)))
|
|
|
|
(defn- upload-chunked!
|
|
"Upload the fixture as a single chunk and return the session id."
|
|
[profile]
|
|
(let [source (-> fixture io/resource jio/file)
|
|
session-id (-> (th/command! {::th/type :create-upload-session
|
|
::rpc/profile-id (:id profile)
|
|
:total-chunks 1})
|
|
:result :session-id)
|
|
out (th/multipart-command! {::th/type :upload-chunk
|
|
::rpc/profile-id (:id profile)
|
|
:session-id session-id
|
|
:index 0
|
|
:content {:filename "package.penpot"
|
|
:path (th/tempfile fixture)
|
|
:mtype "application/zip"
|
|
:size (.length source)}})]
|
|
(t/is (nil? (:error out)))
|
|
session-id))
|
|
|
|
(defn- dispatcher-cfg
|
|
[]
|
|
{::db/pool th/*pool*
|
|
::rds/client (get th/*system* :app.redis/client)
|
|
::mtx/metrics (get th/*system* :app.metrics/metrics)
|
|
::wrk/tenant (cf/get :tenant)
|
|
::wdisp/lease (cf/get-jobs-lease)
|
|
::wdisp/timeout (ct/duration "10s")})
|
|
|
|
(defn- runner-cfg
|
|
"The cfg the runner loop needs, with the real job-defs of the system:
|
|
the handler closes over the component of its own job-def."
|
|
[queue]
|
|
{::db/pool th/*pool*
|
|
::rds/conn (rds/connect {::rds/client (get th/*system* :app.redis/client)
|
|
::mtx/metrics (get th/*system* :app.metrics/metrics)})
|
|
::jobs/defs (::jobs/defs th/*system*)
|
|
::mtx/metrics (get th/*system* :app.metrics/metrics)
|
|
::mbus/msgbus (get th/*system* :app.msgbus/msgbus)
|
|
::wrkr/id "test-runner"
|
|
::wrkr/queue queue
|
|
::wrk/tenant (cf/get :tenant)
|
|
::wrkr/timeout fast-timeout})
|
|
|
|
(defn- run-one
|
|
[cfg]
|
|
(@#'wrkr/run-worker-loop cfg))
|
|
|
|
(defn- job-row
|
|
[job-id]
|
|
(-> (th/db-get :job {:id job-id})
|
|
(update :result #(cond-> % (db/pgobject? %) db/decode-json-pgobject))
|
|
(update :error jobs/decode-job-error)))
|
|
|
|
(defn- project-files
|
|
[project-id]
|
|
(th/db-exec! ["SELECT id FROM file WHERE project_id = ? AND deleted_at IS NULL"
|
|
project-id]))
|
|
|
|
(defn- download
|
|
"The artifact as a local file, as a client would fetch it."
|
|
[resource-id]
|
|
(let [object (sto/get-object (get-storage) resource-id)
|
|
path (tmp/tempfile* :suffix ".penpot")]
|
|
(with-open [out (io/output-stream path)]
|
|
(io/copy (sto/get-object-data (get-storage) object) out))
|
|
path))
|
|
|
|
(defn- create-export-binfile-job
|
|
[profile file-ids]
|
|
(th/command! {::th/type :create-export-binfile-job
|
|
::rpc/profile-id (:id profile)
|
|
:params {:file-ids file-ids
|
|
:export-type :detach-libraries}}))
|
|
|
|
(defn- create-import-binfile-job
|
|
[profile project-id]
|
|
(th/command! {::th/type :create-import-binfile-job
|
|
::rpc/profile-id (:id profile)
|
|
:params {:project-id project-id
|
|
:name "imported"}
|
|
:upload-id (upload-chunked! profile)}))
|
|
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
;; TESTS
|
|
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
|
|
|
(t/deftest the-export-job-runs-to-completion-in-its-own-queue
|
|
(let [profile (th/create-profile* 1)
|
|
file-id (first (:file-ids (import-fixture! profile)))
|
|
out (create-export-binfile-job profile #{file-id})
|
|
job-id (:id (:result out))]
|
|
|
|
(t/is (th/success? out))
|
|
|
|
(wdisp/run-batch (dispatcher-cfg))
|
|
(t/testing "the dispatcher schedules it, and it waits for its queue"
|
|
(t/is (= "scheduled" (:status (jobs/get-job th/*system* job-id)))))
|
|
|
|
(t/testing "a runner of another queue does not take it"
|
|
(run-one (runner-cfg "default"))
|
|
(t/is (= "scheduled" (:status (jobs/get-job th/*system* job-id)))))
|
|
|
|
(t/testing "the runner of its queue does"
|
|
(run-one (runner-cfg "binfile"))
|
|
(t/is (= "completed" (:status (jobs/get-job th/*system* job-id)))))
|
|
|
|
(let [row (job-row job-id)
|
|
job (:result row)]
|
|
(t/testing "the runner associated the artifact of the completion envelope"
|
|
(t/is (some? (:resource-id row))))
|
|
|
|
(t/testing "the result of the job is the descriptor the handler built"
|
|
(t/is (= "export.penpot" (:filename job)))
|
|
(t/is (= "application/zip" (:mtype job)))
|
|
(t/is (pos? (:size job)))
|
|
(t/is (some? (:resource-uri job))))
|
|
|
|
(t/testing "and the artifact is the package of those files"
|
|
(t/is (= [file-id]
|
|
(mapv :id (:files (v3/get-manifest th/*system*
|
|
(download (:resource-id row))))))))
|
|
|
|
(t/testing "the artifact belongs to the profile of the job"
|
|
(let [object (sto/get-object (get-storage) (:resource-id row))]
|
|
(t/is (= sto/job-resource-bucket (:bucket (meta object))))
|
|
(t/is (= (:id profile) (:profile-id (meta object))))))
|
|
|
|
(t/testing "the runner reached the terminal state through the row"
|
|
(t/is (= "completed" (:status row)))
|
|
(t/is (some? (:completed-at row)))))))
|
|
|
|
(t/deftest the-import-job-runs-to-completion-in-its-own-queue
|
|
(let [profile (th/create-profile* 1)
|
|
project-id (:default-project-id profile)
|
|
out (create-import-binfile-job profile project-id)
|
|
job-id (:id (:result out))
|
|
;; read before the run: the handler drops the reference as soon as
|
|
;; it releases the package
|
|
input-id (:resource-id (th/db-get :job {:id job-id}))]
|
|
|
|
(t/is (th/success? out))
|
|
|
|
(wdisp/run-batch (dispatcher-cfg))
|
|
(run-one (runner-cfg "binfile"))
|
|
|
|
(let [row (job-row job-id)
|
|
job (:result row)]
|
|
(t/testing "the job ends completed"
|
|
(t/is (= "completed" (:status row))))
|
|
|
|
(t/testing "the files of the package are in the destination"
|
|
;; the result is JSON: its ids come back as text, the rows as uuids
|
|
(t/is (= (set (map str (:file-ids job)))
|
|
(set (map (comp str :id) (project-files project-id))))))
|
|
|
|
(t/testing "the result carries the files and their resolution"
|
|
(t/is (pos? (count (:file-ids job))))
|
|
(t/is (= "imported" (:name job))))
|
|
|
|
(t/testing "the package it consumed is released"
|
|
(t/is (some? (:deleted-at (th/db-get :storage-object
|
|
{:id input-id}
|
|
{::db/remove-deleted false})))))
|
|
|
|
(t/testing "and the job no longer points at it"
|
|
(t/is (nil? (:resource-id row)))))))
|
|
|
|
(t/deftest the-adapter-reports-progress-through-heartbeat
|
|
(let [profile (th/create-profile* 1)
|
|
file-id (first (:file-ids (import-fixture! profile)))
|
|
job-id (uuid/next)
|
|
calls (atom [])]
|
|
|
|
(th/db-insert! :job {:id job-id
|
|
:name "export-binfile"
|
|
:tenant (cf/get :tenant)
|
|
:queue "binfile"
|
|
:params (db/json {})
|
|
:priority 100
|
|
:max-retries 0
|
|
:retry-num 0
|
|
:status "running"
|
|
:profile-id (:id profile)
|
|
:scheduled-at (ct/now)
|
|
:created-at (ct/now)
|
|
:modified-at (ct/now)})
|
|
|
|
(with-redefs [jobs/heartbeat (fn [_cfg & {:as options}]
|
|
(swap! calls conj options)
|
|
1)]
|
|
(let [cfg (bfc/export-cfg th/*system*
|
|
{:file-ids #{file-id}
|
|
:export-type :detach-libraries
|
|
:output (tmp/tempfile* :suffix ".penpot")})
|
|
context (jobs/make-context (jobs/get-job th/*system* job-id))]
|
|
(bfj/check-active cfg context)
|
|
(bfj/run cfg context v3/export-files!)))
|
|
|
|
(let [reports (map :progress @calls)]
|
|
|
|
(t/testing "the adapter reports progress through heartbeat"
|
|
(t/is (pos? (count reports))))
|
|
|
|
(t/testing "with the payload of the job contract, and nothing else"
|
|
(t/is (every? keyword? (map :stage reports)))
|
|
(t/is (every? #(<= (count (keys %)) 2) reports)))
|
|
|
|
(t/testing "about the job of the context, not one the caller named"
|
|
(t/is (every? #(= job-id (:job-id %)) @calls))))))
|