Compare commits

...

1 Commits

Author SHA1 Message Date
Alejandro Alonso
c5f4872340 🐛 Fix WebGL context lost problems 2025-12-26 12:10:47 +01:00
3 changed files with 170 additions and 9 deletions

View File

@@ -11,6 +11,7 @@
[app.common.data.macros :as dm]
[app.common.files.helpers :as cfh]
[app.common.geom.shapes :as gsh]
[app.common.logging :as log]
[app.common.types.color :as clr]
[app.common.types.component :as ctk]
[app.common.types.path :as path]
@@ -54,6 +55,7 @@
[app.main.ui.workspace.viewport.widgets :as widgets]
[app.render-wasm.api :as wasm.api]
[app.util.debug :as dbg]
[app.util.globals :as ug]
[app.util.text-editor :as ted]
[beicon.v2.core :as rx]
[promesa.core :as p]
@@ -133,6 +135,9 @@
canvas-init? (mf/use-state false)
initialized? (mf/use-state false)
;; Refs to store current values for context restoration
viewport-state-ref (mf/use-ref nil)
;; REFS
[viewport-ref
on-viewport-ref] (create-viewport-ref)
@@ -301,6 +306,8 @@
;; We think moving this out to a handler will make the render code
;; harder to follow through.
(mf/with-effect [page-id]
;; Reset initialized state when page changes
(reset! initialized? false)
(when-let [canvas (mf/ref-val canvas-ref)]
(->> wasm.api/module
(p/fmap (fn [ready?]
@@ -331,11 +338,33 @@
(when (and @canvas-init? preview-blend)
(wasm.api/request-render "with-effect")))
;; Update viewport state ref whenever values change
(mf/with-effect [base-objects zoom vbox background]
(mf/set-ref-val! viewport-state-ref {:base-objects base-objects
:zoom zoom
:vbox vbox
:background background}))
(mf/with-effect [@canvas-init? zoom vbox background]
(when (and @canvas-init? (not @initialized?))
(wasm.api/initialize-viewport base-objects zoom vbox background)
(reset! initialized? true)))
;; Listen for context restoration events - register only once
(mf/with-effect []
(let [listener (fn [_]
(log/info :hint "Context restored event received, resetting viewport initialization")
(let [state (mf/ref-val viewport-state-ref)]
(when state
(reset! initialized? false)
(wasm.api/initialize-viewport (:base-objects state)
(:zoom state)
(:vbox state)
(:background state))
(wasm.api/request-render "context-restored"))))]
(.addEventListener ug/document "penpot:wasm:context-restored" listener)
#(.removeEventListener ug/document "penpot:wasm:context-restored" listener)))
(mf/with-effect [focus]
(when (and @canvas-init? @initialized?)
(if (empty? focus)

View File

@@ -21,6 +21,7 @@
[app.common.types.text :as txt]
[app.common.uuid :as uuid]
[app.config :as cf]
[app.main.data.render-wasm :as drw]
[app.main.refs :as refs]
[app.main.render :as render]
[app.main.store :as st]
@@ -1233,6 +1234,97 @@
(re-find #"(?i)edge" user-agent) :edge
:else :unknown)))))
(defn- initialize-wasm-context
"Initializes the WebGL context and WASM render engine.
Registers the context with Emscripten, sets up extensions, and initializes the render module."
[canvas context flags]
(let [gl (unchecked-get wasm/internal-module "GL")
handle (.registerContext ^js gl context #js {"majorVersion" 2})]
(.makeContextCurrent ^js gl handle)
(set! wasm/gl-context-handle handle)
(set! wasm/gl-context context)
;; Force the WEBGL_debug_renderer_info extension as emscripten does not enable it
(.getExtension context "WEBGL_debug_renderer_info")
;; Initialize Wasm Render Engine
(h/call wasm/internal-module "_init" (/ (.-width ^js canvas) dpr) (/ (.-height ^js canvas) dpr))
(h/call wasm/internal-module "_set_render_options" flags dpr)))
(defn- handle-context-lost
"Handler for WebGL context loss events. Attempts to restore the context manually if possible."
[canvas event]
(.preventDefault event)
(log/warn :hint "WebGL context lost")
;; Only mark as lost if this is the same canvas (not a page change)
;; During page changes, clear-canvas handles the cleanup
(when (exists? js/window)
(let [saved-canvas (.-penpotCanvas js/window)]
(when (identical? canvas saved-canvas)
(set! wasm/context-initialized? false)
(st/emit! (drw/context-lost))
;; Only try to restore manually if we have the lose extension
(when-let [lose-ext (.-penpotLoseContextExt js/window)]
;; Use setTimeout to allow the browser to process the context loss event
(js/setTimeout
(fn []
(try
;; Check if context is actually lost before trying to restore
(let [current-context (.getContext ^js canvas "webgl2" default-context-options)]
(cond
(nil? current-context)
;; No context available, try to restore
(do
(log/info :hint "No context available, attempting to restore manually")
(.restoreContext ^js lose-ext))
(.-isContextLost ^js current-context)
;; Context exists but is lost, try to restore
(do
(log/info :hint "Context is lost, attempting to restore manually")
(.restoreContext ^js lose-ext))
:else
;; Context is already restored, skip
(log/info :hint "Context already restored, skipping manual restoration")))
;; After restoreContext(), the browser should fire webglcontextrestored
;; which will trigger our restoration handler
(catch :default err
(log/warn :hint "Could not restore context manually" :error err))))
0))))))
(defn- handle-context-restored
"Handler for WebGL context restoration events. Re-initializes the context and WASM module."
[canvas gl flags]
(log/info :hint "WebGL context restored by browser, re-initializing")
;; Re-initialize the context after browser restoration
;; Use setTimeout to ensure the browser has fully restored the context
(js/setTimeout
(fn []
(let [restored-context (.getContext ^js canvas "webgl2" default-context-options)]
(when-not (nil? restored-context)
(try
;; Clean up old handle if exists
(when-let [old-handle wasm/gl-context-handle]
(try
(.deleteContext ^js gl old-handle)
(catch :default _)))
;; Re-initialize the context and WASM module
(initialize-wasm-context canvas restored-context flags)
(set! wasm/context-initialized? true)
(log/info :hint "WebGL context restored successfully")
(st/emit! (drw/context-restored))
(ug/dispatch! (ug/event "penpot:wasm:context-restored"))
;; Force a render after context restoration
(request-render "context-restored")
(catch :default err
(log/error :hint "Failed to restore WebGL context"
:error err)))))
0)))
(defn init-canvas-context
[canvas]
(let [gl (unchecked-get wasm/internal-module "GL")
@@ -1243,17 +1335,45 @@
browser (get-browser)
browser (sr/translate-browser browser)]
(when-not (nil? context)
(let [handle (.registerContext ^js gl context #js {"majorVersion" 2})]
(.makeContextCurrent ^js gl handle)
(set! wasm/gl-context-handle handle)
(set! wasm/gl-context context)
;; Initialize WebGL context and WASM render engine
(initialize-wasm-context canvas context flags)
;; Force the WEBGL_debug_renderer_info extension as emscripten does not enable it
(.getExtension context "WEBGL_debug_renderer_info")
;; Store reference to lose extension for manual restoration
(let [lose-ext (.getExtension context "WEBGL_lose_context")]
(when (and lose-ext (exists? js/window))
(set! (.-penpotLoseContextExt js/window) lose-ext)
(set! (.-penpotCanvas js/window) canvas)))
;; Remove existing event listeners if any (cleanup from previous initialization)
(when wasm/context-lost-handler
(.removeEventListener canvas "webglcontextlost" wasm/context-lost-handler))
(when wasm/context-restored-handler
(.removeEventListener canvas "webglcontextrestored" wasm/context-restored-handler))
;; Create and store event handlers for context loss and restoration
(let [lost-handler (fn [event]
(handle-context-lost canvas event))
restored-handler (fn [event]
(handle-context-restored canvas gl flags))]
(set! wasm/context-lost-handler lost-handler)
(set! wasm/context-restored-handler restored-handler)
;; Add event listeners for context loss and restoration
(.addEventListener canvas "webglcontextlost" lost-handler)
(.addEventListener canvas "webglcontextrestored" restored-handler))
;; Add debug helpers for reproducing context loss issues
(when (exists? js/window)
(set! (.-penpotDebugPanning js/window)
(fn []
(let [lose-ext (.getExtension context "WEBGL_lose_context")]
(when lose-ext
(js/setTimeout
(fn []
(log/warn :hint "Forcing context loss for testing")
(.loseContext lose-ext))
1000))))))
;; Initialize Wasm Render Engine
(h/call wasm/internal-module "_init" (/ (.-width ^js canvas) dpr) (/ (.-height ^js canvas) dpr))
(h/call wasm/internal-module "_set_render_options" flags dpr))
(set! wasm/context-initialized? true))
(h/call wasm/internal-module "_set_browser" browser)
@@ -1269,6 +1389,16 @@
(set! wasm/context-initialized? false)
(h/call wasm/internal-module "_clean_up")
;; Remove event listeners before cleaning up context
(when (and wasm/gl-context (.-canvas wasm/gl-context))
(let [canvas (.-canvas wasm/gl-context)]
(when wasm/context-lost-handler
(.removeEventListener canvas "webglcontextlost" wasm/context-lost-handler)
(set! wasm/context-lost-handler nil))
(when wasm/context-restored-handler
(.removeEventListener canvas "webglcontextrestored" wasm/context-restored-handler)
(set! wasm/context-restored-handler nil))))
;; Ensure the WebGL context is properly disposed so browsers do not keep
;; accumulating active contexts between page switches.
(when-let [gl (unchecked-get wasm/internal-module "GL")]

View File

@@ -11,6 +11,8 @@
(defonce internal-module #js {})
(defonce gl-context-handle nil)
(defonce gl-context nil)
(defonce context-lost-handler nil)
(defonce context-restored-handler nil)
(defonce serializers
#js {:blur-type shared/RawBlurType
:blend-mode shared/RawBlendMode