;; 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 performance-tests.render-wasm.browser-test (:require ["fs" :as fs] ["http" :as http] ["net" :as net] ["os" :as os] ["path" :as path] ["playwright" :as playwright] [app.common.transit :as transit] [benches.render-wasm.errors :as errors] [benches.render-wasm.identity :as identity] [benches.render-wasm.node.process :as process] [benches.render-wasm.node.runner.browser :as browser] [benches.render-wasm.node.runner.server :as server] [cljs.test :as t :include-macros true] [frontend-tests.helpers.mock :as mock])) (def ^:private temporary-root (atom nil)) (def ^:private build-id "owned-browser-fixture") (def ^:private viewport {:width 320 :height 240 :dpr 1}) (t/use-fixtures :each {:before #(reset! temporary-root (fs/mkdtempSync (path/join (os/tmpdir) "penpot-browser-test-"))) :after #(fs/rmSync @temporary-root #js {:recursive true :force true})}) (t/deftest gpu-container-selects-the-vulkan-launch-backend (let [env (.-env js/process) previous (.-PENPOT_GPU env)] (try (doseq [value [nil "0" "true" "1"]] (if (nil? value) (js-delete env "PENPOT_GPU") (set! (.-PENPOT_GPU env) value)) (let [args (set (:args (browser/launch-settings)))] (t/is (= (= value "1") (contains? args "--use-angle=vulkan"))) (t/is (= (= value "1") (contains? args "--use-gl=angle"))) (t/is (contains? args "--enable-unsafe-swiftshader")))) (finally (if (undefined? previous) (js-delete env "PENPOT_GPU") (set! (.-PENPOT_GPU env) previous)))))) (defn- ^:async open-host [actual-id ready?] (let [identity-text (.stringify js/JSON (transit/encode-str {:build-id actual-id}))] (fs/writeFileSync (path/join @temporary-root "index.html") (str "browser ownership"))) (await (server/open {:id build-id :dir @temporary-root} {:startup-timeout-ms 3000}))) (defn- request-status [base-url request-path] (js/Promise. (fn [resolve reject] (let [address (js/URL. base-url) req (http/get #js {:hostname (.-hostname address) :port (.-port address) :path request-path :agent false} (fn [^js response] (.once response "error" reject) (.once response "end" #(resolve (.-statusCode response))) (.resume response)))] (.once ^js req "error" reject) (.setTimeout ^js req 3000 #(.destroy ^js req (js/Error. "HTTP test timed out"))))))) (defn- socket-status [url] (js/Promise. (fn [resolve _] (let [address (js/URL. url) ^js socket (net/createConnection #js {:host (.-hostname address) :port (js/Number (.-port address))})] (.once socket "connect" #(do (.destroy socket) (resolve :open))) (.once socket "error" #(do (.destroy socket) (resolve (.-code ^js %)))) (.setTimeout socket 3000 #(do (.destroy socket) (resolve :timeout))))))) (defn- ^:async rejected [promise] (try (await promise) (t/is false "expected browser work to reject") nil (catch :default cause cause))) (t/deftest ^:async page-and-context-close-failures-both-survive (let [page-error (js/Error. "page disposal failed") context-error (js/Error. "context disposal failed") owner {:page #js {:isClosed (constantly false) :close #(js/Promise.reject page-error)} :context #js {:close #(js/Promise.reject context-error)}} cause (await (rejected (browser/close-page owner)))] (t/is (= [page-error context-error] (mapv :error (errors/get-errors cause)))))) (t/deftest ^:async browser-disposal-collects-failures-and-repeated-close-shares-the-result (doseq [stop-fails? [false true]] (let [page-error (js/Error. "page disposal failed") context-error (js/Error. "context disposal failed") process-error (js/Error. "process disposal failed") disconnect-error (js/Error. "CDP disconnect failed") controller (js/AbortController.) running (js/Promise. (fn [_ reject] (.addEventListener (.-signal controller) "abort" #(reject (if stop-fails? process-error (ex-info "cancelled" {:type :process-cancelled})))))) owner {:controller controller :process running :shutdown (atom nil) :user-data-dir @temporary-root :page #js {:isClosed (constantly false) :close #(js/Promise.reject page-error)} :context #js {:close #(js/Promise.reject context-error)} :connection (atom (js/Promise.resolve #js {:isConnected (constantly true) :close #(if stop-fails? (js/Promise.reject disconnect-error) (js/Promise.resolve nil))}))} closing (browser/close owner)] (t/is (identical? closing (browser/close owner))) (if stop-fails? (let [cause (await (rejected closing))] (t/is (= [page-error context-error process-error disconnect-error] (mapv :error (errors/get-errors cause))))) (t/is (nil? (await closing))))))) (t/deftest ^:async unresolved-cancellation-retains-the-browser-profile (let [profile (path/join @temporary-root "profile.info") controller (js/AbortController.) failure (errors/combine [{:error (ex-info "Command cancelled" {:type :process-cancelled})} {:error (errors/fatal-error "Command group may still be running" {:type :process-unresolved :unresolved-process true :pid 4242 :pgid 4242 :signals ["SIGTERM" "SIGKILL"]} nil)}]) running (js/Promise. (fn [_ reject] (.addEventListener (.-signal controller) "abort" #(reject failure)))) owner {:controller controller :process running :shutdown (atom nil) :connection (atom nil) :user-data-dir @temporary-root}] (fs/writeFileSync profile "retained") (let [cause (try (await (browser/close owner)) nil (catch :default cause cause))] (t/is (errors/fatal? cause)) (t/is (process/unresolved? cause)) (t/is (= @temporary-root (:profile-path (errors/evidence :cleanup cause)))) (t/is (= "retained" (when (fs/existsSync profile) (fs/readFileSync profile "utf8"))))))) (t/deftest ^:async process-stop-retains-other-errors-after-cancellation (let [controller (js/AbortController.) probe (ex-info "Probe failed" {:type :process-probe}) failure (errors/combine [{:error (ex-info "Command cancelled" {:type :process-cancelled})} {:error probe}]) running (js/Promise. (fn [_ reject] (.addEventListener (.-signal controller) "abort" #(reject failure)))) owner {:controller controller :process running :shutdown (atom nil) :connection (atom nil) :user-data-dir @temporary-root} cause (try (await (browser/close owner)) nil (catch :default cause cause))] (t/is (= [probe] (mapv :error (errors/get-errors cause)))))) (t/deftest ^:async browser-startup-retains-a-failure-of-its-disposal (let [run-process process/run close browser/close cleanup-error (js/Error. "startup disposal failed")] (await (mock/with-mocks* {process/run (fn [options] (run-process (assoc options :command "/bin/sh" :args ["-c" "exit 17"]))) browser/close (fn [owner] (.then (close owner) (fn [_] (throw cleanup-error)) (fn [_] (throw cleanup-error))))} (let [cause (await (rejected (browser/launch {:startup-timeout-ms 10000}))) entries (errors/get-errors cause)] (t/is (= ::browser/startup-cleanup (:type (ex-data cause)))) (t/is (= ["Command exited unsuccessfully" "startup disposal failed"] (mapv #(errors/message-of (:error %)) entries)))))))) (defn- ^:async check-stopped [{:keys [endpoint user-data-dir]}] (t/is (not (fs/existsSync user-data-dir)) "owned Chromium profile was removed") (t/is (= "ECONNREFUSED" (await (socket-status endpoint))) "the owned CDP listener is gone")) (defn- ^:async close-fixture [owner page host] (try (when page (try (await (browser/close-page page)) (catch :default _ nil))) (when owner (try (await (browser/close owner)) (catch :default _ nil))) (finally (await (server/close host))))) (t/deftest ^:async startup-process-details-survive-browser-failure-wrappers (let [run-process process/run] (doseq [exit-code [0 17]] (await (mock/with-mocks* {process/run (fn [options] (run-process (assoc options :command "/bin/sh" :args ["-c" (str "exit " exit-code)])))} (let [cause (await (rejected (browser/launch {:startup-timeout-ms 10000}))) saved (-> (errors/evidence :browser-startup cause) transit/encode-str transit/decode-str) command (if (zero? exit-code) (.executablePath (.-chromium playwright)) "/bin/sh")] (t/is (= {:command command :exit-code exit-code} (select-keys saved [:command :exit-code]))) (t/is (= ::browser/endpoint-exit (:type (ex-data cause)))) (t/is (= "Chromium exited before its CDP endpoint became ready" (errors/message-of cause))) (t/is (= 1 (count (errors/get-errors cause)))))))))) (t/deftest ^:async successful-close-removes-the-profile-and-cdp-listener (let [host (await (open-host build-id true)) owner-ref (atom nil) page-ref (atom nil)] (try (let [owner (await (browser/launch {:startup-timeout-ms 30000})) _ (reset! owner-ref owner) page (await (browser/new-page owner host {:viewport viewport :startup-timeout-ms 30000}))] (reset! page-ref page) (t/is (= 200 (await (request-status (:endpoint owner) "/json/version")))) (t/is (= viewport (js->clj (await (.evaluate ^js (:page page) "({width:innerWidth,height:innerHeight,dpr:devicePixelRatio})")) :keywordize-keys true))) (await (browser/close-page page)) (reset! page-ref nil) (await (browser/close owner)) (await (check-stopped owner)) (t/is (not (.isConnected ^js (:browser owner)))) (t/is (= 200 (await (request-status (:base-url host) "/"))) "browser shutdown leaves its host live") (await (server/close host)) (t/is (= "ECONNREFUSED" (await (socket-status (:base-url host)))))) (finally (await (close-fixture @owner-ref @page-ref host)))))) (t/deftest ^:async identity-mismatch-rejects-and-the-caller-closes-the-owned-browser (let [host (await (open-host "wrong-compiled-build" true)) owner-ref (atom nil)] (try (let [owner (await (browser/launch {:startup-timeout-ms 30000})) _ (reset! owner-ref owner) cause (await (rejected (browser/new-page owner host {:viewport viewport :startup-timeout-ms 30000}))) facts (ex-data cause)] (t/is (= ::identity/mismatch (:type facts))) (t/is (= "wrong-compiled-build" (:actual-id facts))) (await (browser/close owner)) (reset! owner-ref nil) (await (check-stopped owner))) (finally (await (close-fixture @owner-ref nil host)))))) (t/deftest ^:async abort-stops-a-synchronously-blocked-page (let [host (await (open-host build-id true)) controller (js/AbortController.) owner-ref (atom nil) page-ref (atom nil) started-ref (atom nil) started (js/Promise. (fn [resolve _] (reset! started-ref resolve)))] (try (let [owner (await (browser/launch {:startup-timeout-ms 30000 :signal (.-signal controller)})) _ (reset! owner-ref owner) page-owner (await (browser/new-page owner host {:viewport viewport :startup-timeout-ms 30000 :signal (.-signal controller)})) ^js page (:page page-owner)] (reset! page-ref page-owner) (await (.exposeFunction page "__blockingStarted" (fn [] (@started-ref)))) (let [blocking (.evaluate page "window.__blockingStarted(); while (true) {}")] (.catch blocking (fn [_] nil)) (await (browser/within (fn [] started) {:deadline (process/deadline 5000) :phase :test-blocking-start})) (let [cause (await (rejected (browser/within #(.evaluate page "1") {:deadline (process/deadline 1000) :phase :test-blocked-page})))] (t/is (= ::browser/timeout (:type (ex-data cause))))) (.abort controller) (reset! page-ref nil) (await (browser/close owner)) (reset! owner-ref nil) (await (check-stopped owner)) (t/is (not (.isConnected ^js (:browser owner)))) (t/is (instance? js/Error (await (rejected blocking)))))) (finally (.abort controller) (await (close-fixture @owner-ref @page-ref host)))))) (t/deftest ^:async abort-during-readiness-cleans-the-starting-browser (let [host (await (open-host build-id false)) controller (js/AbortController.) owner-ref (atom nil) requested (js/Promise. (fn [resolve _] (.once ^js (:server host) "request" (fn [_] (resolve nil)))))] (try (let [owner (await (browser/launch {:startup-timeout-ms 30000 :signal (.-signal controller)})) _ (reset! owner-ref owner) page (browser/new-page owner host {:viewport viewport :startup-timeout-ms 30000 :signal (.-signal controller)})] (.catch page (fn [_] nil)) (await (browser/within (fn [] requested) {:deadline (process/deadline 30000) :phase :test-host-request})) (.abort controller (ex-info "caller cancelled browser readiness" {:type ::caller-abort})) (let [cause (await (rejected page))] (t/is (= ::caller-abort (:type (ex-data cause))))) (await (browser/close owner)) (reset! owner-ref nil) (await (check-stopped owner))) (finally (.abort controller) (await (close-fixture @owner-ref nil host))))))