diff --git a/frontend/src/app/main/data/workspace.cljs b/frontend/src/app/main/data/workspace.cljs index 7581866dc6..cc9c9c7954 100644 --- a/frontend/src/app/main/data/workspace.cljs +++ b/frontend/src/app/main/data/workspace.cljs @@ -314,7 +314,8 @@ ::ev/name "open-workspace-file" ::ev/origin "workspace" :file-id file-id - :team-id team-id))))))) + :team-id team-id + :renderer (features/get-active-renderer state)))))))) (defn- restore-pending-changes "Applies the edits still waiting to be saved to a freshly loaded `file`. diff --git a/frontend/src/app/main/errors.cljs b/frontend/src/app/main/errors.cljs index 5f48fd0c9e..fceac0d344 100644 --- a/frontend/src/app/main/errors.cljs +++ b/frontend/src/app/main/errors.cljs @@ -16,6 +16,7 @@ [app.main.data.nitrate :as dnt] [app.main.data.notifications :as ntf] [app.main.data.workspace :as-alias dw] + [app.main.features :as features] [app.main.repo :as rp] [app.main.router :as rt] [app.main.store :as st] @@ -410,7 +411,8 @@ :hint hint :href (rt/get-current-href) :report report - :occurrences occurrences}))) + :occurrences occurrences + :renderer (features/get-active-renderer @st/state)}))) (defn submit-report "Report the error report to the audit log subsystem, subject to the diff --git a/frontend/src/app/main/features.cljs b/frontend/src/app/main/features.cljs index b5fcfdc528..7ced696941 100644 --- a/frontend/src/app/main/features.cljs +++ b/frontend/src/app/main/features.cljs @@ -85,6 +85,13 @@ "feature not supported") (contains? (:features state) feature)) +(defn get-active-renderer + "Name of the renderer active in `state`, for telemetry: `wasm` (WebGL) or + `svg`, or nil before the features are initialized." + [state] + (when (contains? state :features) + (if (active-feature? state "render-wasm/v1") "wasm" "svg"))) + (defn active-features? "Given a state and a set of features, check if the features are all enabled." ([state a] diff --git a/frontend/src/app/main/ui/settings/options.cljs b/frontend/src/app/main/ui/settings/options.cljs index b841f3567d..00898df09c 100644 --- a/frontend/src/app/main/ui/settings/options.cljs +++ b/frontend/src/app/main/ui/settings/options.cljs @@ -20,6 +20,7 @@ [app.main.ui.ds.foundations.typography :as t] [app.main.ui.ds.foundations.typography.heading :refer [heading*]] [app.main.ui.ds.foundations.typography.text :refer [text*]] + [app.render-wasm.api.webgl :as webgl] [app.util.dom :as dom] [app.util.i18n :as i18n :refer [tr]] [app.util.theme :as theme] @@ -101,10 +102,11 @@ handle-render-change (mf/use-fn (fn [enabled?] - (st/emit! (ev/event {::ev/name (if enabled? - "enable-webgl-rendering" - "disable-webgl-rendering") - ::ev/origin "settings"}) + (st/emit! (ev/event (assoc (webgl/get-environment) + ::ev/name (if enabled? + "enable-webgl-rendering" + "disable-webgl-rendering") + ::ev/origin "settings")) (du/update-profile-props {:renderer (if enabled? :wasm :svg)}) (ntf/success (if enabled? (tr "webgl.toast.webgl-render-enabled") diff --git a/frontend/src/app/main/ui/workspace/main_menu.cljs b/frontend/src/app/main/ui/workspace/main_menu.cljs index 79d2b80a20..b05f7eaab3 100644 --- a/frontend/src/app/main/ui/workspace/main_menu.cljs +++ b/frontend/src/app/main/ui/workspace/main_menu.cljs @@ -42,6 +42,7 @@ [app.main.ui.ds.foundations.assets.icon :as i :refer [icon*]] [app.main.ui.hooks.resize :as r] [app.plugins.register :as preg] + [app.render-wasm.api.webgl :as webgl] [app.util.dom :as dom] [app.util.i18n :as i18n :refer [tr]] [app.util.keyboard :as kbd] @@ -965,8 +966,9 @@ (dom/reload-current-window true)) (fn [_] (st/emit! (ntf/error (tr "errors.generic")))))) - (st/emit! (ev/event {::ev/name ev-name - ::ev/origin "workspace:menu"}) + (st/emit! (ev/event (assoc (webgl/get-environment) + ::ev/name ev-name + ::ev/origin "workspace:menu")) (ptk/data-event ::ev/force-persist {}))))) open-plugins-manager diff --git a/frontend/src/app/main/ui/workspace/viewport_wasm.cljs b/frontend/src/app/main/ui/workspace/viewport_wasm.cljs index cfa1a3d38d..1cb2ad6c88 100644 --- a/frontend/src/app/main/ui/workspace/viewport_wasm.cljs +++ b/frontend/src/app/main/ui/workspace/viewport_wasm.cljs @@ -16,6 +16,7 @@ [app.common.types.component :as ctk] [app.common.types.shape :as cts] [app.common.types.shape.layout :as ctl] + [app.main.data.event :as ev] [app.main.data.modal :as modal] [app.main.data.workspace :as dw] [app.main.data.workspace.transforms :as dwt] @@ -58,6 +59,7 @@ [app.main.ui.workspace.viewport.viewport-ref :as vp-ref :refer [create-viewport-ref]] [app.main.ui.workspace.viewport.widgets :as widgets] [app.render-wasm.api :as wasm.api] + [app.render-wasm.api.webgl :as webgl] [app.render-wasm.rulers-state :as rs] [app.util.debug :as dbg] [app.util.text-editor :as ted] @@ -70,6 +72,10 @@ ;; --- Viewport +;; Retries after the first failed WebGL context init before showing the +;; "WebGL unavailable" modal. +(def ^:private ^:const max-init-retries 3) + (defn- apply-modifiers-to-objects [objects modifiers] (->> modifiers @@ -460,21 +466,28 @@ (let [timeout-id-ref (volatile! nil) unmounted? (volatile! false) modal-shown? (volatile! false) + init-error (volatile! nil) show-unavailable (fn [] (when-not (or @unmounted? @modal-shown?) (vreset! modal-shown? true) (reset! canvas-init? false) - (st/emit! (modal/show {:type :webgl-unavailable})))) + (st/emit! (modal/show {:type :webgl-unavailable}) + (ev/event (assoc (webgl/get-environment) + ::ev/name "webgl-unavailable" + ::ev/origin "workspace" + :hint (or @init-error "no webgl2 context")))))) try-init (fn try-init [retries] (when-not @unmounted? + (vreset! init-error nil) (let [init? (try (wasm.api/init-canvas-context canvas) (catch :default e (js/console.error "Error initializing canvas context:" e) + (vreset! init-error (ex-message e)) false))] (cond init? @@ -490,7 +503,7 @@ (->> @wasm.api/module (p/fmap (fn [ready?] (when ready? - (try-init 3))))) + (try-init max-init-retries))))) (fn [] (vreset! unmounted? true) (when-let [timeout-id @timeout-id-ref] diff --git a/frontend/src/app/render_wasm/api.cljs b/frontend/src/app/render_wasm/api.cljs index aab9321c6c..d9ad59efc5 100644 --- a/frontend/src/app/render_wasm/api.cljs +++ b/frontend/src/app/render_wasm/api.cljs @@ -33,6 +33,7 @@ [app.common.types.text :as txt] [app.common.uuid :as uuid] [app.config :as cf] + [app.main.data.event :as-alias ev] [app.main.data.helpers :as dsh] [app.main.data.notifications :as ntf] [app.main.data.render-wasm :as drw] @@ -2389,6 +2390,17 @@ (set-render-options! new-dpr) (resize-viewbox css-w css-h))))) +(defn- emit-webgl-event + "Send a WebGL audit event with the environment details. Built as a plain + data event so this namespace does not load `app.main.data.event`, which + the worker build cannot run." + [event-name props] + (st/emit! (ptk/data-event ::ev/event + (merge (webgl/get-environment) + props + {::ev/name event-name + ::ev/origin "workspace"})))) + (defn- on-webgl-context-lost [event] (dom/prevent-default event) @@ -2405,7 +2417,8 @@ :type :toast :level :warning :timeout 5000})) - (st/emit! (drw/context-lost))) + (st/emit! (drw/context-lost)) + (emit-webgl-event "webgl-context-lost" {})) (defn- on-webgl-context-restored [event] @@ -2422,6 +2435,7 @@ ;; only after the full reload so layout/viewport sync runs ;; against a live renderer with `wasm/ready?` true. (st/emit! (drw/context-restored)) + (emit-webgl-event "webgl-context-restored" {}) (listen-tiles-render-complete-once! end-context-loss-overlay!) (st/async-emit! (ntf/show {:content (tr "webgl.webgl-context-recovered.toast") @@ -2472,6 +2486,7 @@ (let [{:keys [context handle]} result] (set! wasm/gl-context-handle handle) (set! wasm/gl-context context) + (webgl/remember-gpu-info context) ;; `init-context` already ran `_init` through `_set_browser` in ;; order. Publish the handles, then mark live before sizing so the @@ -2609,6 +2624,9 @@ (p/catch (fn [cause] (ug/dispatch! (ug/event "penpot:wasm:reload-failed")) + (emit-webgl-event "webgl-reload-failed" + {:hint (ex-message cause) + :code (some-> (ex-data cause) :code name)}) (reset! wasm/reloading? false) (reset! wasm/context-lost? true) (clear-canvas) diff --git a/frontend/src/app/render_wasm/api/webgl.cljs b/frontend/src/app/render_wasm/api/webgl.cljs index 3fe8a7b0ba..cde2622727 100644 --- a/frontend/src/app/render_wasm/api/webgl.cljs +++ b/frontend/src/app/render_wasm/api/webgl.cljs @@ -11,6 +11,7 @@ [app.common.math :as mth] [app.common.render-wasm.helpers :as h] [app.common.render-wasm.wasm :as wasm] + [cuerdas.core :as str] [promesa.core :as p])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -314,3 +315,73 @@ void main() { (resolve false))) (set! (.-src img) uri)))) (p/resolved false))) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; Environment +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(defn- get-gpu-family + "Normalize a GPU renderer string to a GPU family. Telemetry sends the + family, not the full string, which can help fingerprint a device." + [renderer] + (let [renderer (str/lower renderer) + has? (fn [& parts] (some #(str/includes? renderer %) parts))] + (cond + (has? "swiftshader") "swiftshader" + (has? "llvmpipe" "softpipe") "llvmpipe" + (has? "microsoft basic render") "microsoft-basic-render" + (has? "apple") "apple" + (has? "nvidia" "geforce" "quadro") "nvidia" + (has? "amd" "radeon") "amd" + (has? "intel") "intel" + (has? "adreno") "adreno" + (has? "mali") "mali" + (has? "powervr") "powervr" + :else "other"))) + +(defn- get-gpu-backend + "Graphics API behind the WebGL implementation (ANGLE names it in the + renderer string), or nil when the string does not say." + [renderer] + (let [renderer (str/lower renderer) + has? (fn [& parts] (some #(str/includes? renderer %) parts))] + (cond + (has? "direct3d11" "d3d11") "d3d11" + (has? "direct3d9" "d3d9") "d3d9" + (has? "metal") "metal" + (has? "vulkan") "vulkan" + (has? "opengl") "opengl"))) + +(defn- read-gpu-info + "GPU details of a live WebGL context, or nil when it is lost." + [^js gl] + (when-not (.isContextLost gl) + (let [^js ext (.getExtension gl "WEBGL_debug_renderer_info") + renderer (or (when ext + (.getParameter gl (.-UNMASKED_RENDERER_WEBGL ext))) + (.getParameter gl (.-RENDERER gl)))] + (when (string? renderer) + {:gpu-family (get-gpu-family renderer) + :gpu-backend (get-gpu-backend renderer) + :max-texture-size (.getParameter gl (.-MAX_TEXTURE_SIZE gl))})))) + +(defonce ^:private gpu-info + (volatile! nil)) + +(defn remember-gpu-info + "Keep the GPU details of `gl`, a context the renderer just created, so + later events can send them after that context is lost." + [gl] + (when-let [info (try (read-gpu-info gl) (catch :default _ nil))] + (vreset! gpu-info info))) + +(defn get-environment + "Environment details for WebGL telemetry: GPU family, GPU backend and max + texture size when already remembered, device memory, CPU cores and + whether the app runs inside Electron. Never creates a WebGL context." + [] + (let [^js navigator js/navigator] + (assoc @gpu-info + :device-memory (.-deviceMemory navigator) + :cpu-cores (.-hardwareConcurrency navigator) + :electron (str/includes? (.-userAgent navigator) "Electron/")))) diff --git a/frontend/test/frontend_tests/errors_governor_test.cljs b/frontend/test/frontend_tests/errors_governor_test.cljs index a51f775a43..035188c5ff 100644 --- a/frontend/test/frontend_tests/errors_governor_test.cljs +++ b/frontend/test/frontend_tests/errors_governor_test.cljs @@ -174,6 +174,18 @@ (t/is (= 1 (count events))) (t/is (= 1 (:occurrences (deref (first events))))))) +(t/deftest submit-report-carries-the-active-renderer + (let [submit (fn [state hint] + (with-redefs [st/state (atom state)] + (capture-reports! + #(errors/submit-report :event-name "handled-exception" + :report "report" + :hint hint + :cause (error-cause :hint hint)))))] + (t/is (= "wasm" (:renderer (deref (first (submit {:features #{"render-wasm/v1"}} "a")))))) + (t/is (= "svg" (:renderer (deref (first (submit {:features #{}} "b")))))) + (t/is (nil? (:renderer (deref (first (submit {} "c")))))))) + (t/deftest invalid-report-does-not-consume-a-reservation (let [cause (error-cause :type :network :hint "boom") events (capture-reports!