Skip to content

Lock Symbol.dispose on web to fix Skia dispose errors in Safari - #102521

Merged
mountiny merged 2 commits into
Expensify:mainfrom
software-mansion-labs:fix-skia-symbol-dispose-web
Sep 30, 2026
Merged

mountiny merged 2 commits into
Expensify:mainfrom
software-mansion-labs:fix-skia-symbol-dispose-web

Conversation

@WojtekBoman

Copy link
Copy Markdown
Contributor

Explanation of Change

Skia's web host objects key their [Symbol.dispose] method once at load, but dispose() rereads Symbol.dispose on every call. Safari has no native symbol, so if a script defines it later, every chart frame throws. New web polyfill SymbolDispose.web.ts, imported first in index.js, locks both dispose symbols like the native property. Unit tests added.

Fixed Issues

$ #102043
PROPOSAL:

Tests

Test 1 - Safari: Skia charts keep working after a late Symbol.dispose

  1. In Safari on macOS, sign in with an account that has spend data and open Home (/home) so the insights chart renders
  2. Open Web Inspector and run typeof Symbol.dispose and Object.getOwnPropertyDescriptor(Symbol, 'dispose')
  3. Verify that the type is symbol and the descriptor shows writable: false and configurable: false
  4. Run Symbol.dispose = Symbol('late'), then run Symbol.dispose === Symbol.for('Symbol.dispose')
  5. Verify that the result is true (the assignment was ignored)
  6. Hover and move the cursor across the chart bars, then filter the console by dispose
  7. Verify that no this[Symbol.dispose] is not a function errors appear and the chart tooltip follows the cursor

Test 2 - Chrome: native symbol is left untouched

  1. In Chrome, open Home (/home) so the insights chart renders
  2. In DevTools, run Symbol.dispose === Symbol.for('Symbol.dispose')
  3. Verify that the result is false (the native symbol is kept, the polyfill did nothing)
  4. Hover across the chart bars
  5. Verify that the chart and tooltip render normally with no console errors

Test 3 - Native: charts are unaffected

  1. On iOS and Android, open Home so the insights chart renders
  2. Tap across the chart bars
  3. Verify that the chart and tooltip render normally with no errors
  • Verify that no errors appear in the JS console

Offline tests

N/A - web polyfill only, no API calls or Onyx writes.

QA Steps

Same as tests

  • 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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

@WojtekBoman

WojtekBoman commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor Author

@codex review

@WojtekBoman

Copy link
Copy Markdown
Contributor Author

@MelvinBot review this

@MelvinBot

Copy link
Copy Markdown
Contributor

Review

The PR looks good to merge. The fix matches the root cause, runs early enough, and I found nothing the lock would break. The only change I'd ask for is a wrong comment about tslib.

Please fix:

  • SymbolDispose.web.ts:25 and SymbolDisposePolyfillTest.ts:32 say tslib falls back to Symbol.for('Symbol.dispose'). It doesn't: tslib 2.8.1 throws Symbol.dispose is not defined when the symbol is missing. Babel, SWC, and core-js do use Symbol.for. Suggest: "Babel, SWC and core-js use the registered one".

Optional:

  • The issue doesn't name the script that sets Symbol.dispose late. A likely one is Google Identity Services (accounts.google.com/gsi/client), loaded on the sign-in page by GoogleSignIn/index.tsx:67-68. Its polyfill sets Symbol.dispose = Symbol("o") when the symbol is missing. That fits a chart loading, then a sign-out and sign-in without a page reload. Naming it in the PR description or the code comment would help future readers.
What I checked
  • Load order: index.js is the only web entry (config/rsbuild/rsbuild.common.ts, entry: {main: './index.js'}). The imports before the polyfill (NitroFetch.web.ts, PromiseWithResolvers, requestIdleCallback) don't load Skia. Skia's Host.js loads only in the lazy chart chunks. So Skia always keys its methods after the lock. Scripts in web/index.html (Ketch, Convert, GTM) don't define Symbol.dispose.
  • Root cause: Skia 2.11.2 lib/module/skia/web/Host.js:24-27 has dispose() { this[Symbol.dispose](); } plus a computed [Symbol.dispose]() method, as the PR describes.
  • Regression risk: ES modules run in strict mode, so a plain assignment to the locked property would throw a TypeError. I found no plain assignment in the bundle. readable-stream, canvaskit-wasm, the Babel and SWC helpers, and tslib only read the symbol. GSI's polyfill only writes when the value is missing, so it does nothing after the lock. The gtag containers only write X.prototype[Symbol.dispose], which reads the symbol. Browser extensions that inject into the page are the one thing I couldn't check.
  • Chrome/Firefox: there the native property is non-configurable, so the polyfill skips it. Node has it too, so the test file's import of the real Symbol does nothing, and the tests use fake constructors correctly.
  • Types: TupleToUnion is in the pinned type-fest (4.35.0) and is already used in src/ROUTES.ts.
  • Minor: the Storybook config doesn't import the polyfill, so Storybook in Safari keeps the old behavior. That doesn't affect production.

I didn't run the app. The bug needs Safari, and the test browser is Chromium, which has a native Symbol.dispose.

Linked issue: [Sentry: APP-M75 / APP-M74 / APP-M8W] Web Safari crash, Skia Host.dispose calls an undefined this[Symbol.dispose]


view run

@WojtekBoman
WojtekBoman marked this pull request as ready for review September 29, 2026 11:18
@WojtekBoman
WojtekBoman requested review from a team as code owners September 29, 2026 11:18
@melvin-bot
melvin-bot Bot requested review from cretadn22 and trjExpensify and removed request for a team September 29, 2026 11:18
@melvin-bot

melvin-bot Bot commented Sep 29, 2026

Copy link
Copy Markdown

@cretadn22 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]

@melvin-bot
melvin-bot Bot removed the request for review from a team September 29, 2026 11:18

@trjExpensify trjExpensify left a comment

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.

👍

@cretadn22

cretadn22 commented Sep 30, 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: HybridApp
Screen.Recording.2026-09-30.at.23.44.05.mov
Android: mWeb Chrome
Screen.Recording.2026-09-30.at.23.41.09.mov
iOS: HybridApp
Screen.Recording.2026-09-30.at.23.42.00.mov
iOS: mWeb Safari
Screen.Recording.2026-09-30.at.23.41.35.mov
MacOS: Chrome / Safari
Screen.Recording.2026-09-30.at.23.36.26.mov

@@ -0,0 +1,37 @@
import type {TupleToUnion} from 'type-fest';

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.

I initially considered putting this into a folder with index.ts and .native.ts, but that would break the uniform naming convention of the polyfills directory. More importantly, as the dealbreaker it would make the implementation impossible to import cleanly in unit tests. So I am fine with this implementation

@melvin-bot
melvin-bot Bot requested a review from mountiny September 30, 2026 16:46

@mountiny mountiny left a comment

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.

Nice thanks for the testing @cretadn22

@mountiny
mountiny merged commit 2ed3ee5 into Expensify:main Sep 30, 2026
39 of 44 checks passed
@OSBotify

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@github-actions

Copy link
Copy Markdown
Contributor

🚧 mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

OSBotify commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.5.0-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@MelvinBot

Copy link
Copy Markdown
Contributor

No help site update is needed. This PR adds an internal web polyfill so Skia charts stop throwing errors in Safari, which makes no user-facing workflow change and makes no help article sentence incorrect.


view run

@OSBotify

OSBotify commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.5.0-5 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 failure ❌

Bundle Size Analysis (Sentry):

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.

7 participants