Skip to content

fix(charts): keep the skia canvas usable when React re-runs Canvas effects on web - #100714

Open
dariusz-biela wants to merge 5 commits into
Expensify:mainfrom
software-mansion-labs:dariusz-biela/fix/skia-defer-webgl-context-loss
Open

dariusz-biela wants to merge 5 commits into
Expensify:mainfrom
software-mansion-labs:dariusz-biela/fix/skia-defer-webgl-context-loss

Conversation

@dariusz-biela

@dariusz-biela dariusz-biela commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Adds patch 004 to @shopify/react-native-skia so a <Canvas> on web survives React re-running its layout effects on the same DOM node. Today WebGLRenderer.dispose() loses the canvas's WebGL context on every effect cleanup, and a lost context is permanent for that element, so the re-run can never create a surface again and the chart stays blank. This is a prerequisite for hiding chart screens with React <Activity> (the ScreenActivityWrapper rollout, #98254) and it also fixes the same failure under StrictMode's dev double-invoke.

In the app

  • Nothing changes in production today: no screen opts into nonTopScreenBehavior: 'activity' yet, and StrictMode is a dev-only tool.
  • With USE_REACT_STRICT_MODE_IN_DEV on, Reports charts (bar, line, pie) render instead of falling back to "Unable to display chart".
  • Once a screen with charts opts into Activity, hiding and revealing it keeps the chart and its last presented frame instead of showing a white block.

In the code

  • New patches/@shopify/react-native-skia/@shopify+react-native-skia+2.4.18+004+defer-webgl-context-loss-to-unmount.patch: dispose() now loses the context only when the canvas has already left the document, which is the real-unmount case. In 2.4.18 it runs from a passive effect cleanup, which React flushes after detaching the host node, so a plain isConnected check is enough and a real unmount still releases its context deterministically (browsers cap a page at ~16 live contexts). An Activity hide or a StrictMode re-run keeps the element connected, so the new renderer reuses the live context like the resize path already does.
  • Same guard as the upstream fix(🌐): don't lose the canvas WebGL context on layout-effect cleanup Shopify/react-native-skia#4002 (merged 2026-09-02, not in any release yet), minus its microtask deferral, which that fix needs only because its dispose() runs from a layout effect cleanup, before the node is detached. Upstream also zeroes the canvas size on cleanup, which would blank a hidden Activity screen's backdrop, so a Skia bump does not fully replace this patch. details.md records that.

Known regression

  • A screen unmounted while it is hidden no longer releases its WebGL context eagerly. Its cleanup already ran at hide time, when the canvas was still connected, so React runs none at unmount and the context, with its full-size drawing buffer, is reclaimed only by the browser's own eviction of the oldest context once the per-page cap is hit (16 in Chrome). Before the patch every unmount released the context synchronously. Mounted screens are unchanged, each held a live context before Activity too.
  • Upstream fix(🌐): don't lose the canvas WebGL context on layout-effect cleanup Shopify/react-native-skia#4002 skips the same release in that case, but it is less exposed: its dispose() frees the surface, the GrContext, the CanvasKit context handle and the drawing buffer at every hide, so only the context slot survives there. Freeing the buffer is the canvas size reset that would blank a hidden screen's backdrop, which is why this patch does not copy it.

Fixed Issues

$ #98254
PROPOSAL: N/A

Tests

Web (Chrome) only, the patch touches SkiaPictureView.web.js.

  1. In src/CONFIG.ts set USE_REACT_STRICT_MODE_IN_DEV to true and start the web app (npm run web).
  2. Open Reports, group expenses (for example by category) and switch the view to the bar chart. Verify that the chart renders (without the patch it shows "Unable to display chart").
  3. Switch to the line and pie views. Verify that each chart renders and that no rangeMin or WebGL error appears in the JS console.
  • Verify that no errors appear in the JS console

Offline tests

N/A - the patch changes how a web <canvas> releases its WebGL context, no network or Onyx code is touched.

QA Steps

Web (Chrome and Safari) and mWeb, the patch only touches the web renderer.

  1. Open Reports, group expenses (for example by category) and switch the view to the bar chart. Verify that the chart renders.
  2. Switch to the line view and then the pie view. Verify that each chart renders with its labels and that no "Unable to display chart" message appears.
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Web QA Steps
1-qa-steps-charts.mp4
Before fix behavior with Activity
2-main-activity-hide-breaks-chart.mp4
After fix behavior with Activity
3-fixed-activity-hide-keeps-chart.mp4

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

WebGLRenderer.dispose() loses the canvas's WebGL context on every layout-effect
cleanup, but an <Activity> hide (and StrictMode's DEV double-invoke) re-runs the
effects on the same element, where a lost context is permanent - the reveal can
never create a surface again and the hidden backdrop shows a white block where
the chart was.

Patch skia to defer the release by one microtask and lose the context only once
the canvas has really left the document, mirroring upstream PR
Shopify/react-native-skia#4027 (issue Expensify#3976): a hidden screen keeps its context
and its last presented frame, the reveal reuses the live context like the resize
path always has, and a real unmount still releases the context slot
deterministically.
@dariusz-biela
dariusz-biela force-pushed the dariusz-biela/fix/skia-defer-webgl-context-loss branch from 4249cad to 09bf361 Compare September 9, 2026 13:07
…m fix

Shorten the in-patch comment to three lines, drop the dead null guard on the
canvas, and condense the details.md reason. Upstream Expensify#4027 was closed in favor
of Expensify#4002, which merged on 2026-09-02 and is not in any release yet; record
that, and that its canvas size reset would blank a hidden Activity backdrop,
so a Skia bump does not fully replace this patch.
…ssion

Before patch 004 every unmount released the WebGL context synchronously,
background screens included, so the leak of a screen unmounted while hidden
does not match the pre-Activity baseline. Say so instead of claiming parity.

dispose() now defers the release by one microtask and only loses the
context when the canvas has left the document. React runs cleanup before
detaching the host node, so isConnected is false one microtask later only

@jmgraa jmgraa Sep 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

If I'm reading the PR and React's commit order right, this one line looks off: "React runs cleanup before detaching the host node". That's true foruseLayoutEffect and it is what upstream #4002 does, but in 2.4.18 dispose() runs from the passive useEffect cleanup, which React flushes after it removes the node.

So on this version isConnected alone already separates a real unmount from an Activity hide and the queueMicrotask is carrying forward a guarantee we'll need again once we bump past #4002, where the caller is a layout effect.

I think it is worth rewording, so nobody later measures isConnected, sees it's already false and drops the deferral as dead code.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good catch, you're right: in 2.4.18 dispose() runs from a passive useEffect cleanup, so isConnected is already false at cleanup time on a real unmount. Dropped the microtask and made the check synchronous in e85fcca, details.md now explains why upstream needs the deferral and this version does not.

In 2.4.18 dispose() runs from a passive useEffect cleanup, which React
flushes after removing the host node, so the canvas is already detached on a
real unmount and still connected across an Activity hide. The microtask only
matters for a layout-effect caller like upstream's; drop it and say why in
details.md.

@mhawryluk mhawryluk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

…ecisely

Upstream Expensify#4002 skips the same eager context release, but its dispose()
already frees the surface, the GrContext, the CanvasKit handle and the
drawing buffer at every hide, so only the context slot survives there.
Saying it has "the same gap" understated this patch's leak.
@dariusz-biela
dariusz-biela force-pushed the dariusz-biela/fix/skia-defer-webgl-context-loss branch from cc5a486 to a1d710e Compare September 11, 2026 10:19
@dariusz-biela
dariusz-biela marked this pull request as ready for review September 11, 2026 10:22
@dariusz-biela
dariusz-biela requested a review from a team as a code owner September 11, 2026 10:22
@melvin-bot
melvin-bot Bot requested review from truph01 and removed request for a team September 11, 2026 10:22
@melvin-bot

melvin-bot Bot commented Sep 11, 2026

Copy link
Copy Markdown

@truph01 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@truph01

truph01 commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained """"why"""" the code was doing something instead of only explaining """"what"""" the code was doing.
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: mWeb Chrome
Screen.Recording.2026-09-14.at.17.35.33.mov
iOS: mWeb Safari
Screen.Recording.2026-09-14.at.17.35.51.mov
MacOS: Chrome / Safari
Screen.Recording.2026-09-14.at.17.22.37.mov

@melvin-bot
melvin-bot Bot requested a review from roryabraham September 14, 2026 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants