♻️ Refactor temporal files management on exporter

This commit is contained in:
Andrey Antukh 2022-06-29 14:39:40 +02:00
parent d021ac0226
commit ebe8fdcba8
8 changed files with 57 additions and 40 deletions

View File

@ -8,10 +8,10 @@
(:require (:require
["process" :as proc] ["process" :as proc]
[app.browser :as bwr] [app.browser :as bwr]
[app.redis :as redis]
[app.common.logging :as l] [app.common.logging :as l]
[app.config] [app.config]
[app.http :as http] [app.http :as http]
[app.redis :as redis]
[promesa.core :as p])) [promesa.core :as p]))
(enable-console-print!) (enable-console-print!)

View File

@ -128,8 +128,8 @@
(defn- join-pdf (defn- join-pdf
[file-id paths] [file-id paths]
(p/let [tmpdir (sh/mktmpdir! "join-pdf") (p/let [prefix (str/concat "penpot.tmp.pdfunite." file-id ".")
path (path/join tmpdir (str/concat file-id ".pdf"))] path (sh/tempfile :prefix prefix :suffix ".pdf")]
(sh/run-cmd! (str "pdfunite " (str/join " " paths) " " path)) (sh/run-cmd! (str "pdfunite " (str/join " " paths) " " path))
path)) path))
@ -137,5 +137,4 @@
[{:keys [path] :as resource} output-path] [{:keys [path] :as resource} output-path]
(p/do (p/do
(sh/move! output-path path) (sh/move! output-path path)
(sh/rmdir! (path/dirname output-path))
resource)) resource))

View File

@ -102,8 +102,6 @@
total (count exports) total (count exports)
topic (str profile-id) topic (str profile-id)
to-delete (atom #{})
on-progress (fn [{:keys [done]}] on-progress (fn [{:keys [done]}]
(when-not wait (when-not wait
(let [data {:type :export-update (let [data {:type :export-update
@ -137,7 +135,6 @@
:on-progress on-progress) :on-progress on-progress)
append (fn [{:keys [filename path] :as object}] append (fn [{:keys [filename path] :as object}]
(swap! to-delete conj path)
(rsc/add-to-zip! zip path filename)) (rsc/add-to-zip! zip path filename))
proc (-> (p/do proc (-> (p/do
@ -146,7 +143,6 @@
(p/let [proc (rd/render export append)] (p/let [proc (rd/render export append)]
(p/recur (rest exports))))) (p/recur (rest exports)))))
(.finalize zip)) (.finalize zip))
(p/then (fn [_] (p/run! #(sh/rmdir! (path/dirname %)) @to-delete)))
(p/then (constantly resource)) (p/then (constantly resource))
(p/catch on-error)) (p/catch on-error))
] ]

View File

@ -14,15 +14,15 @@
[app.common.data :as d] [app.common.data :as d]
[app.common.exceptions :as ex] [app.common.exceptions :as ex]
[app.common.uuid :as uuid] [app.common.uuid :as uuid]
[app.util.shell :as sh]
[app.util.mime :as mime] [app.util.mime :as mime]
[app.util.shell :as sh]
[cljs.core :as c] [cljs.core :as c]
[cuerdas.core :as str] [cuerdas.core :as str]
[promesa.core :as p])) [promesa.core :as p]))
(defn- get-path (defn- get-path
[type id] [type id]
(path/join (os/tmpdir) (str/concat "exporter-resource." (c/name type) "." id))) (path/join sh/tmpdir (str/concat "penpot.resource." (c/name type) "." id)))
(defn create (defn create
"Generates ephimeral resource object." "Generates ephimeral resource object."

View File

@ -36,9 +36,8 @@
:userAgent bw/default-user-agent}) :userAgent bw/default-user-agent})
(render-object [page {:keys [id] :as object}] (render-object [page {:keys [id] :as object}]
(p/let [tmpdir (sh/mktmpdir! "bitmap-render") (p/let [path (sh/tempfile :prefix "penpot.tmp.render.bitmap." :suffix (mime/get-extension type))
path (path/join tmpdir (str/concat id (mime/get-extension type))) node (bw/select page (str/concat "#screenshot-" id))]
node (bw/select page (str/concat "#screenshot-" id))]
(bw/wait-for node) (bw/wait-for node)
(case type (case type
:png (bw/screenshot node {:omit-background? true :type type :path path}) :png (bw/screenshot node {:omit-background? true :type type :path path})

View File

@ -44,8 +44,7 @@
(render-object [page base-uri {:keys [id] :as object}] (render-object [page base-uri {:keys [id] :as object}]
(p/let [uri (prepare-uri base-uri id) (p/let [uri (prepare-uri base-uri id)
tmp (sh/mktmpdir! "pdf-render") path (sh/tempfile :prefix "penpot.tmp.render.pdf." :suffix (mime/get-extension type))]
path (path/join tmp (str/concat id (mime/get-extension type)))]
(l/info :uri uri) (l/info :uri uri)
(bw/nav! page uri) (bw/nav! page uri)
(p/let [dom (bw/select page (dm/str "#screenshot-" id))] (p/let [dom (bw/select page (dm/str "#screenshot-" id))]

View File

@ -116,24 +116,20 @@
(defn render (defn render
[{:keys [page-id file-id objects token scale type]} on-object] [{:keys [page-id file-id objects token scale type]} on-object]
(letfn [(convert-to-ppm [pngpath] (letfn [(convert-to-ppm [pngpath]
(l/trace :fn :convert-to-ppm) (let [ppmpath (str/concat pngpath "origin.ppm")]
(let [basepath (path/dirname pngpath) (l/trace :fn :convert-to-ppm :path ppmpath)
ppmpath (path/join basepath "origin.ppm")]
(-> (sh/run-cmd! (str "convert " pngpath " " ppmpath)) (-> (sh/run-cmd! (str "convert " pngpath " " ppmpath))
(p/then (constantly ppmpath))))) (p/then (constantly ppmpath)))))
(trace-color-mask [pbmpath] (trace-color-mask [pbmpath]
(l/trace :fn :trace-color-mask :pbmpath pbmpath) (l/trace :fn :trace-color-mask :pbmpath pbmpath)
(let [basepath (path/dirname pbmpath) (let [svgpath (str/concat pbmpath ".svg")]
basename (path/basename pbmpath ".pbm")
svgpath (path/join basepath (str basename ".svg"))]
(-> (sh/run-cmd! (str "potrace --flat -b svg " pbmpath " -o " svgpath)) (-> (sh/run-cmd! (str "potrace --flat -b svg " pbmpath " -o " svgpath))
(p/then (constantly svgpath))))) (p/then (constantly svgpath)))))
(generate-color-layer [ppmpath color] (generate-color-layer [ppmpath color]
(l/trace :fn :generate-color-layer :ppmpath ppmpath :color color) (l/trace :fn :generate-color-layer :ppmpath ppmpath :color color)
(let [basepath (path/dirname ppmpath) (let [pbmpath (str/concat ppmpath ".mask-" (subs color 1) ".pbm")]
pbmpath (path/join basepath (str "mask-" (subs color 1) ".pbm"))]
(-> (sh/run-cmd! (str/format "ppmcolormask \"%s\" %s" color ppmpath)) (-> (sh/run-cmd! (str/format "ppmcolormask \"%s\" %s" color ppmpath))
(p/then (fn [stdout] (p/then (fn [stdout]
(-> (sh/write-file! pbmpath stdout) (-> (sh/write-file! pbmpath stdout)
@ -247,15 +243,14 @@
(trace-node [{:keys [data] :as node}] (trace-node [{:keys [data] :as node}]
(l/trace :fn :trace-node) (l/trace :fn :trace-node)
(p/let [tdpath (sh/mktmpdir! "svgexport") (p/let [pngpath (sh/tempfile :prefix "penpot.tmp.render.svg.parse."
pngpath (path/join tdpath "origin.png") :suffix ".origin.png")
_ (sh/write-file! pngpath data) _ (sh/write-file! pngpath data)
ppmpath (convert-to-ppm pngpath) ppmpath (convert-to-ppm pngpath)
svgdata (convert-to-svg ppmpath node)] svgdata (convert-to-svg ppmpath node)]
(-> node (-> node
(dissoc :data) (dissoc :data)
(assoc :tempdir tdpath (assoc :svgdata svgdata))))
:svgdata svgdata))))
(extract-element-attrs [^js element] (extract-element-attrs [^js element]
(let [^js attrs (.. element -attributes) (let [^js attrs (.. element -attributes)
@ -289,17 +284,11 @@
shot (bw/screenshot text-node {:omit-background? true :type "png"})] shot (bw/screenshot text-node {:omit-background? true :type "png"})]
[shot node])) [shot node]))
(clean-temp-data [{:keys [tempdir] :as node}]
(p/do!
(sh/rmdir! tempdir)
(dissoc node :tempdir)))
(extract-txt-node [page item] (extract-txt-node [page item]
(-> (p/resolved item) (-> (p/resolved item)
(p/then (partial resolve-text-node page)) (p/then (partial resolve-text-node page))
(p/then extract-single-node) (p/then extract-single-node)
(p/then trace-node) (p/then trace-node)))
(p/then clean-temp-data)))
(extract-txt-nodes [page {:keys [id] :as objects}] (extract-txt-nodes [page {:keys [id] :as objects}]
(l/trace :fn :process-text-nodes) (l/trace :fn :process-text-nodes)
@ -323,9 +312,8 @@
:userAgent bw/default-user-agent}) :userAgent bw/default-user-agent})
(render-object [page {:keys [id] :as object}] (render-object [page {:keys [id] :as object}]
(p/let [tmpdir (sh/mktmpdir! "svg-render") (p/let [path (sh/tempfile :prefix "penpot.tmp.render.svg." :suffix (mime/get-extension type))
path (path/join tmpdir (str/concat id (mime/get-extension type))) node (bw/select page (str/concat "#screenshot-" id))]
node (bw/select page (str/concat "#screenshot-" id))]
(bw/wait-for node) (bw/wait-for node)
(p/let [xmldata (extract-svg page object) (p/let [xmldata (extract-svg page object)
txtdata (extract-txt-nodes page object) txtdata (extract-txt-nodes page object)

View File

@ -12,13 +12,49 @@
["os" :as os] ["os" :as os]
["path" :as path] ["path" :as path]
[app.common.logging :as l] [app.common.logging :as l]
[app.common.uuid :as uuid]
[app.common.exceptions :as ex]
[cuerdas.core :as str]
[promesa.core :as p])) [promesa.core :as p]))
(l/set-level! :trace) (l/set-level! :trace)
(defn mktmpdir! (def tempfile-minage (* 1000 60 60 1)) ;; 1h
[prefix]
(.mkdtemp fs/promises (path/join (os/tmpdir) prefix))) (def tmpdir
(let [path (path/join (os/tmpdir) "penpot")]
(when-not (fs/existsSync path)
(fs/mkdirSync path #js {:recursive true}))
path))
(defn- schedule-deletion!
[path]
(letfn [(remote-tempfile []
(when (fs/existsSync path)
(l/trace :hint "permanently remove tempfile" :path path)
(fs/rmSync path #js {:recursive true})))]
(let [ts (js/Date.now)]
(l/trace :hint "schedule tempfile deletion"
:path path
:scheduled-at (.. (js/Date. (+ (js/Date.now) tempfile-minage)) toString))
(js/setTimeout remote-tempfile tempfile-minage))))
(defn tempfile
[& {:keys [prefix suffix]
:or {prefix "penpot."
suffix ".tmp"}}]
(loop [i 0]
(if (< i 1000)
(let [path (path/join tmpdir (str/concat prefix (uuid/next) "-" i suffix))]
(if (fs/existsSync path)
(recur (inc i))
(do
(schedule-deletion! path)
path)))
(ex/raise :type :internal
:code :unable-to-locate-temporal-file
:hint "unable to find a tempfile candidate"))))
(defn move! (defn move!
[origin-path dest-path] [origin-path dest-path]