Skip to content

[No QA] feat(telemetry): Add js module init time tracking - #83583

Merged
roryabraham merged 13 commits into
Expensify:mainfrom
callstack-internal:eliran/sentry-add-js-module-time
Mar 3, 2026
Merged

roryabraham merged 13 commits into
Expensify:mainfrom
callstack-internal:eliran/sentry-add-js-module-time

Conversation

@elirangoshen

@elirangoshen elirangoshen commented Feb 26, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Adds per-module initialization time tracking to help identify which src/ modules are slowest to execute during cold start.

src/setup/moduleInitPolyfill.js— a Metro polyfill that wraps Metro's __d() global (the module definition function) to time each module's factory execution using Hermes' nativePerformanceNow clock. Results are
stored in global.__moduleInitTimes (moduleId → ms) and global.__moduleNames (moduleId → file path).

metro.config.js — registers moduleInitPolyfill.js as a globalPrefix script so it runs before any __d() calls, ensuring every module is instrumented from the very start of bundle execution.

src/setup/telemetry/index.ts — on runJsBundleEnd (fired via a buffered PerformanceObserver), reads the collected times, filters to src/ modules only, sorts by slowest, takes the top 50, logs them via
console.debug, and attaches them as a Sentry breadcrumb (module.init category) for cold-start analysis.

src/types/global.d.ts — adds ambient type declarations for __moduleInitTimes and __moduleNames so TypeScript is aware of the globals injected by the polyfill.

Fixed Issues

#82974

Tests

  • Build and run the HybridApp
  • Cold-launch the app (force-stop it first)
  • Verify it passed splash screen

Offline tests

N/A — telemetry only, no functional change. The polyfill and observer are fire-and-forget; if runJsBundleEnd never fires the data is simply not collected.

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

    • Build and run the HybridApp
    • Cold-launch the app (force-stop it first)
    • Verify it passed splash screen

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 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 shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • 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)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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 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.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • 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 Screenshot 2026-02-26 at 14 58 27
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

elirangoshen and others added 2 commits February 26, 2026 11:00
Wraps Metro's __d() to time each module factory execution, storing
results in global.__moduleInitTimes / __moduleNames. On runJsBundleEnd,
logs the top 20 slowest module init times and attaches them as a Sentry
breadcrumb for cold-start analysis.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov

codecov Bot commented Feb 26, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/CONST/index.ts 94.30% <ø> (+1.74%) ⬆️
src/setup/telemetry/index.native.ts 0.00% <0.00%> (ø)
src/setup/telemetry/index.web.ts 0.00% <0.00%> (ø)
src/setup/telemetry/reportModuleInitTimes.ts 0.00% <0.00%> (ø)
src/setup/moduleInitPolyfill.ts 0.00% <0.00%> (ø)
... and 222 files with indirect coverage changes

@elirangoshen
elirangoshen marked this pull request as ready for review February 26, 2026 15:19
@elirangoshen
elirangoshen requested review from a team as code owners February 26, 2026 15:19
@melvin-bot
melvin-bot Bot requested review from JmillsExpensify and mjasikowski and removed request for a team February 26, 2026 15:19
@melvin-bot

melvin-bot Bot commented Feb 26, 2026

Copy link
Copy Markdown

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

Comment thread src/setup/telemetry/index.ts Resolved
Comment thread src/setup/telemetry/index.ts Resolved
Comment thread src/setup/telemetry/index.ts Resolved

@JmillsExpensify JmillsExpensify 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.

No product review required.

@roryabraham roryabraham 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.

This looks good, but it seems like it only works in Metro, which means it will only work in dev and on iOS/Android. What about measuring on web, and in production?

@roryabraham
roryabraham removed the request for review from mjasikowski February 27, 2026 16:39
@elirangoshen

elirangoshen commented Mar 2, 2026 •

Copy link
Copy Markdown
Contributor Author

This looks good, but it seems like it only works in Metro, which means it will only work in dev and on iOS/Android. What about measuring on web, and in production?

About the metro, it should work in release builds as well , because getPolyfills hook is a build-time config and should work regardless if its dev or release.

The only actual dev/release differences in the config are:

  • Release only: createSentryMetroSerializer() — adds Sentry debug IDs/source maps to the bundle
  • Release only: withSentryConfig(mergedConfig) wraps the whole config

About web I pushed update to get same level of logging, yet that can have negative effects on the bundle size and maintenance in future webpack upgrades , (as I added webpack plugin) this is the current list in web :

[Telemetry] Module init times (slowest first) — count: 50
index.web.ts:26 [Module] 1474ms — ./index.js
index.web.ts:26 [Module] 1375ms — ./src/App.tsx
index.web.ts:26 [Module] 944ms — ./src/components/ColorSchemeWrapper/index.tsx
index.web.ts:26 [Module] 943ms — ./src/hooks/useThemeStyles.ts
index.web.ts:26 [Module] 942ms — ./src/components/ThemeStylesContextProvider/index.tsx
index.web.ts:26 [Module] 933ms — ./src/styles/index.ts
index.web.ts:26 [Module] 786ms — ./src/components/WideRHPContextProvider/index.tsx
index.web.ts:26 [Module] 767ms — ./src/components/Search/SearchContext.tsx
index.web.ts:26 [Module] 767ms — ./src/hooks/useOnyx.ts
index.web.ts:26 [Module] 765ms — ./src/libs/ReportUtils.ts
index.web.ts:26 [Module] 432ms — ./src/libs/actions/IOU/index.ts
index.web.ts:26 [Module] 411ms — ./src/libs/SearchUIUtils.ts
index.web.ts:26 [Module] 373ms — ./src/components/SelectionListWithSections/ChatListItem.tsx
index.web.ts:26 [Module] 371ms — ./src/pages/inbox/report/ReportActionItem.tsx
index.web.ts:26 [Module] 362ms — ./src/pages/inbox/report/PureReportActionItem.tsx
index.web.ts:26 [Module] 264ms — ./src/libs/actions/BankAccounts.ts
index.web.ts:26 [Module] 259ms — ./src/libs/API/index.ts
index.web.ts:26 [Module] 258ms — ./src/libs/Middleware/index.ts
index.web.ts:26 [Module] 254ms — ./src/libs/actions/Session/index.ts
index.web.ts:26 [Module] 254ms — ./src/libs/Middleware/HandleDeletedAccount.ts
index.web.ts:26 [Module] 242ms — ./src/libs/actions/Link.ts
index.web.ts:26 [Module] 219ms — ./src/libs/actions/Report/index.ts
index.web.ts:26 [Module] 155ms — ./src/components/KYCWall/BaseKYCWall.tsx
index.web.ts:26 [Module] 155ms — ./src/components/KYCWall/index.tsx
index.web.ts:26 [Module] 151ms — ./src/components/AddPaymentMethodMenu.tsx
index.web.ts:26 [Module] 150ms — ./src/components/PopoverMenu.tsx
index.web.ts:26 [Module] 123ms — ./node_modules/react-native-gesture-handler/lib/module/index.js
index.web.ts:26 [Module] 123ms — ./src/components/ActionSheetAwareScrollView/ActionSheetAwareScrollViewContext.tsx
index.web.ts:26 [Module] 123ms — ./src/components/ActionSheetAwareScrollView/index.tsx
index.web.ts:26 [Module] 122ms — ./src/libs/Log.ts
index.web.ts:26 [Module] 122ms — ./src/hooks/useWorkletStateMachine/index.ts
index.web.ts:26 [Module] 105ms — ./src/components/ReportActionItem/MoneyRequestAction.tsx
index.web.ts:26 [Module] 104ms — ./src/components/ReportActionItem/TransactionPreview/index.tsx
index.web.ts:26 [Module] 101ms — ./src/components/ReportActionItem/TransactionPreview/TransactionPreviewContent.tsx
index.web.ts:26 [Module] 100ms — ./src/components/MenuItem.tsx
index.web.ts:26 [Module] 100ms — ./src/components/FocusableMenuItem.tsx
index.web.ts:26 [Module] 98ms — ./src/components/ReportActionItem/ReportActionItemImages.tsx
index.web.ts:26 [Module] 97ms — ./node_modules/react-native-gesture-handler/lib/module/handlers/gestures/GestureDetector/index.js
index.web.ts:26 [Module] 95ms — ./node_modules/react-native-gesture-handler/lib/module/handlers/gestures/GestureDetector/useAnimatedGesture.js
index.web.ts:26 [Module] 93ms — ./node_modules/react-native-reanimated/lib/module/index.js
index.web.ts:26 [Module] 93ms — ./node_modules/react-native-gesture-handler/lib/module/handlers/gestures/reanimatedWrapper.js
index.web.ts:26 [Module] 92ms — ./node_modules/@sentry/react-native/dist/js/index.js
index.web.ts:26 [Module] 85ms — ./src/components/ReportActionItem/ReportActionItemImage.tsx
index.web.ts:26 [Module] 84ms — ./src/libs/ModifiedExpenseMessage.ts
index.web.ts:26 [Module] 78ms — ./node_modules/react-native-render-html/lib/commonjs/index.js
index.web.ts:26 [Module] 78ms — ./src/components/RenderHTML.tsx
index.web.ts:26 [Module] 78ms — ./src/components/FormHelpMessage.tsx
index.web.ts:26 [Module] 75ms — ./node_modules/react-native-render-html/lib/commonjs/RenderHTML.js
index.web.ts:26 [Module] 71ms — ./src/components/ReceiptImage/index.tsx
index.web.ts:26 [Module] 60ms — ./src/libs/PolicyUtils.ts

@elirangoshen
elirangoshen requested a review from roryabraham March 2, 2026 14:36
Comment thread src/setup/telemetry/index.native.ts Resolved
import webpack from 'webpack';
// @libs alias is not available in Node.js/Storybook context — use relative path instead
// @ts-expect-error -- Can't use .ts extensions without allowImportingTsExtensions in tsconfig
// eslint-disable-next-line import/extensions, @dword-design/import-alias/prefer-alias

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.

I added those es lint rules because using @libs caused build error in story book as it might have issue using the alias

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.

Hmmm ok well we should be able to fix this in the webpack config layer but we don't have to do it in this PR

@elirangoshen
elirangoshen requested a review from roryabraham March 3, 2026 13:19
@roryabraham roryabraham changed the title Eliran/sentry add js module time [No QA] feat(telemetry): Add js module init time Mar 3, 2026
@melvin-bot

melvin-bot Bot commented Mar 3, 2026

Copy link
Copy Markdown

Hey, I noticed you changed some webpack configuration files. This can break production builds. Did you remember to run a production build locally to verify they still work?

@roryabraham roryabraham changed the title [No QA] feat(telemetry): Add js module init time [No QA] feat(telemetry): Add js module init time tracking Mar 3, 2026
@roryabraham

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
    • MacOS: Desktop
  • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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 shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • 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)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • 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.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • 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
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari image

@roryabraham
roryabraham merged commit e7bb108 into Expensify:main Mar 3, 2026
31 of 38 checks passed
@github-actions

github-actions Bot commented Mar 3, 2026

Copy link
Copy Markdown
Contributor

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

@OSBotify

OSBotify commented Mar 3, 2026

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.

});

requestAnimationFrame(() => {
reportModuleInitTimes(__moduleInitTimes as Record<string, number> | undefined, __moduleNames as Record<string, string> | undefined, 100);

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 keep getting error on app start

Image

@elirangoshen elirangoshen Mar 4, 2026 •

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.

Did you try to clear the browser cache ?

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.

Web issue fixed after fresh npm install.
Still on mobile native. Does this require native rebuild?

@roryabraham

Copy link
Copy Markdown
Contributor

Weird, I didn't see that 😕

@elirangoshen

Copy link
Copy Markdown
Contributor Author

I will check it again tomorrow

@elirangoshen

Copy link
Copy Markdown
Contributor Author

I think it might be due to stale cache but I added typeguard safety.
should I open new pr with this ?

@roryabraham

Copy link
Copy Markdown
Contributor

I added typeguard safety ... should I open new pr with this

Go ahead!

@OSBotify

OSBotify commented Mar 4, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.3.31-0 🚀

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

@OSBotify

OSBotify commented Mar 6, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/blimpich in version: 9.3.31-12 🚀

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

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.

5 participants