fix: throw WebGLUnsupportedError when WebGL is unavailable#141
Merged
Conversation
… safe without a renderer
|
🎉 This PR is included in version 2.14.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Canvas.load()now throws a typedWebGLUnsupportedError(exported from the package root) when WebGL is unavailable, instead of resolving successfully. The in-canvas error overlay still renders before the throw, so integrations that don't catch keep the current visual behaviour.Canvas.resize()is now a no-op when the renderer doesn't exist (beforeload()completes or afterdispose()), instead of throwingTypeError: Cannot read properties of undefined (reading 'resize').Why
When WebGL is unavailable (hardware acceleration disabled, some VMs/remote desktops),
load()silently returned with no renderer. Hosts had no way to detect the failure, treated the editor as loaded, and any subsequentresize()call crashed. Hosts can now catchWebGLUnsupportedErrorand show their own error state.Behaviour change
load()rejects where it previously resolved on WebGL-less browsers. Integrations that relied on the silent overlay are unaffected visually, but code awaitingload()should handle the rejection.How to verify
npx jest tests/webgl-support.test.ts— jsdom has no WebGL, so the tests exercise the real failure path:load()rejects withWebGLUnsupportedError, the overlay still mounts, andresize()no-ops without a renderer.