Skip to content

[reland] Unify canvas creation and Surface code in Skwasm and CanvasKit#179473

Merged
auto-submit[bot] merged 1 commit intoflutter:masterfrom
harryterkelsen:unify-surface-skwasm-canvaskit
Dec 19, 2025
Merged

[reland] Unify canvas creation and Surface code in Skwasm and CanvasKit#179473
auto-submit[bot] merged 1 commit intoflutter:masterfrom
harryterkelsen:unify-surface-skwasm-canvaskit

Conversation

@harryterkelsen
Copy link
Contributor

This PR introduces a significant refactoring of the web engine's rendering layer by unifying the Surface and Rasterizer implementations. These components have been moved from being renderer-specific to a generic compositing directory, making the architecture more modular and easier to maintain. The rasterizers are now renderer-agnostic and are provided with renderer-specific surface factories via dependency injection. A new CanvasProvider abstraction has also been introduced to manage the lifecycle of the underlying canvas elements.

A key outcome of this work is that the Skwasm backend now correctly handles WebGL context loss events. This was achieved by refactoring SkwasmSurface to allow the Dart side to manage the OffscreenCanvas lifecycle. A communication channel between the main thread and the web worker is now used to gracefully handle context loss and recovery. This effort also included fixing several related bugs around surface sizing, resource cleanup, and callback handling in multi-surface scenarios.

To validate these changes, new testing APIs have been added to allow for the creation of renderer-agnostic surface tests. A new test file, surface_context_lost_test.dart, has been added to verify the context loss and recovery behavior across all supported renderers, ensuring the new architecture is robust and reliable.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

@github-actions github-actions bot added engine flutter/engine related. See also e: labels. platform-web Web applications specifically labels Dec 4, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This is a significant and well-executed refactoring of the web engine's rendering layer. Unifying the Surface and Rasterizer implementations and introducing the CanvasProvider abstraction greatly improves the architecture's modularity and maintainability. It's great to see that this work also brings proper WebGL context loss handling to the Skwasm backend. The addition of new tests for context loss is also a very valuable contribution. I have a couple of comments on potential issues I've found.

Comment on lines +24 to +28
final DomEventListener eventListener = createDomEventListener((DomEvent event) {
onContextLost();
// The canvas is no longer usable.
releaseCanvas(canvas);
});
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The webglcontextlost event listener is missing a call to event.preventDefault(). According to the WebGL specification, if preventDefault() is not called on this event, the browser will not attempt to restore the context, and the webglcontextrestored event will not be fired. This will break WebGL context restoration for the CanvasKit renderer.

Suggested change
final DomEventListener eventListener = createDomEventListener((DomEvent event) {
onContextLost();
// The canvas is no longer usable.
releaseCanvas(canvas);
});
final DomEventListener eventListener = createDomEventListener((DomEvent event) {
event.preventDefault();
onContextLost();
// The canvas is no longer usable.
releaseCanvas(canvas);
});

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to call preventDefault() because we don't want the browser to attempt to restore the context. In the case the context is lost, we recreate it ourselves with a new Canvas

@mdebbar mdebbar removed their assignment Dec 11, 2025
@mdebbar mdebbar self-requested a review December 11, 2025 15:08
Copy link
Contributor

@mdebbar mdebbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this PR still relevant after your PR?

Comment on lines +65 to +67
/// NOTE: `dom.DomOffscreenCanvas` is not fully defined in the provided `dom.dart`
/// snippet. This implementation assumes it exists and has a similar API to the
/// standard `OffscreenCanvas`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what this comment means. If there are missing things in dom.dart we should fill the gaps.

}

@override
bool get isDisposed => debugDisposed;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If debugDisposed is now meant to be used in production code, maybe let's rename it to _isDisposed and use the new isDisposed in tests?

@harryterkelsen
Copy link
Contributor Author

Is this PR still relevant after your PR?

Yes, it should be merged with this PR after it lands.

@harryterkelsen harryterkelsen force-pushed the unify-surface-skwasm-canvaskit branch from 0bb0a90 to c04c46c Compare December 19, 2025 19:22
@harryterkelsen harryterkelsen requested review from a team and jtmcdole as code owners December 19, 2025 19:22
@github-actions github-actions bot added a: tests "flutter test", flutter_test, or one of our tests a: text input Entering text in a text field or keyboard related problems platform-android Android applications specifically platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) platform-fuchsia Fuchsia code specifically f: scrolling Viewports, list views, slivers, etc. f: cupertino flutter/packages/flutter/cupertino repository platform-windows Building on or for Windows specifically d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos f: routes Navigator, Router, and related APIs. f: gestures flutter/packages/flutter/gestures repository. platform-linux Building on or for Linux specifically a: desktop Running on desktop labels Dec 19, 2025
@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. a: accessibility Accessibility, e.g. VoiceOver or TalkBack. (aka a11y) platform-fuchsia Fuchsia code specifically f: scrolling Viewports, list views, slivers, etc. f: cupertino flutter/packages/flutter/cupertino repository d: api docs Issues with https://api.flutter.dev/ d: examples Sample code and demos f: gestures flutter/packages/flutter/gestures repository. platform-linux Building on or for Linux specifically a: desktop Running on desktop labels Dec 19, 2025
@fluttergithubbot
Copy link
Contributor

An existing Git SHA, 0bb0a901f77bddd203bb00b14429d2819f92d29d, was detected, and no actions were taken.

To re-trigger presubmits after closing or re-opeing a PR, or pushing a HEAD commit (i.e. with --force) that already was pushed before, push a blank commit (git commit --allow-empty -m "Trigger Build") or rebase to continue.

@auto-submit
Copy link
Contributor

auto-submit bot commented Dec 20, 2025

A reason for requesting a revert of flutter/flutter/179473 could
not be found or the reason was not properly formatted. Begin a comment with 'Reason for revert:' to tell the bot why
this issue is being reverted.

@harryterkelsen
Copy link
Contributor Author

Reason for revert: Potentially causing flaky skwasm framework tests: https://ci.chromium.org/ui/p/flutter/builders/prod/Linux%20web_skwasm_tests_1/9062/overview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engine flutter/engine related. See also e: labels. platform-web Web applications specifically

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants