Skip to content

[NO QA][Sentry] Adding module names to web#84422

Merged
Julesssss merged 8 commits intoExpensify:mainfrom
callstack-internal:eliran/sentry-module-fix
Mar 23, 2026
Merged

[NO QA][Sentry] Adding module names to web#84422
Julesssss merged 8 commits intoExpensify:mainfrom
callstack-internal:eliran/sentry-module-fix

Conversation

@elirangoshen
Copy link
Copy Markdown
Contributor

@elirangoshen elirangoshen commented Mar 6, 2026

Explanation of Change

In production webpack builds, module IDs are numeric hashes (e.g. 535, 23042) instead of file paths. The Sentry breadcrumb for slow module init times was reporting these opaque numbers, making the data unusable
for identifying performance bottlenecks.

The changes:

  1. ModuleInitTimingPlugin.ts — at build time, the plugin now iterates all webpack compilation modules and emits a self.__moduleNames = { "535": "./src/styles/index.ts", ... } runtime object mapping each numeric
    ID to its relative source path. node_modules are excluded to keep the emitted JSON small.
  2. index.web.ts — now reads __moduleNames (same typeof guard pattern used for __moduleInitTimes) and passes it to reportModuleInitTimes, which already uses it as a fallback: names?.[id] ?? id.

The native side (Metro) already had this via moduleInitPolyfill.ts + __moduleNames. This brings web to parity.

Fixed Issues

$#82975

Tests

  1. Build the web app in production mode (npm run build)
  2. Open the app, trigger some navigation to load modules
  3. Open Sentry and inspect the module_init_times breadcrumb
  4. Verify module entries now show readable paths like ./src/styles/index.ts instead of numeric IDs like 535
  5. Verify the dev build still works (IDs are already paths in dev, __moduleNames is set but redundant — no regression)
  6. Check bundle size has not grown significantly (names JSON is source-files only, no node_modules)
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

N/A

  • 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
    • 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 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"
    • 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 and posted it for approval
    • 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 and follows capitalization guidelines
    • I verified proper file naming conventions were followed for any new or renamed files
    • I verified the JSDocs style guidelines 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 verified all code is DRY
  • I verified any variables that can be defined as constants 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 it is needed
  • 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
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed
    • The assets load correctly across all supported platforms
  • If the PR modifies code that runs when editing or sending messages, I tested markdown behaviors
  • If the PR modifies a generic component, I verified it doesn't break other usages
  • If the PR modifies a component related to Storybook stories, I verified all stories still work
  • If the PR modifies a component or page accessible by deeplink, I verified it works logged-in and logged-out
  • If the PR modifies the UI:
    • I verified inputs inside forms are aligned
    • I added the Design label or tagged @Expensify/design
  • If a new page is added, I verified it's using the ScrollView component
  • I added unit tests for any new feature or bug fix
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome

Screenshots/Videos

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

@elirangoshen elirangoshen requested review from a team as code owners March 6, 2026 16:20
@melvin-bot melvin-bot bot requested review from JmillsExpensify and inimaga and removed request for a team March 6, 2026 16:20
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Mar 6, 2026

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

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 6, 2026

Codecov Report

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

Files with missing lines Coverage Δ
src/setup/telemetry/index.web.ts 0.00% <0.00%> (ø)
... and 482 files with indirect coverage changes

Comment on lines +68 to +71
// Build a moduleId → file path map so numeric production IDs are readable in Sentry.
// Skip node_modules to keep the emitted JSON small.
const names: Record<string, string> = {};
for (const module of compilation.modules) {
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. This is a going to add a non-trivial amount of startup JS for every user in production, as we're effectively shipping a moduleId -> path manifest for every first-party webpack module in the app inside the runtime chunk.
Could we rework this to avoid shipping the full map at startup? cc: @roryabraham

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 wonder if we can solve this at build time instead of runtime (i.e: avoid mangling the module names in the first place)

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.

We will do the JSON parsing for every user on startup, it might impact our app startup metrics negatively.
Eli do you think we are able to do it on build time rather than runtime?

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 will check it and let you know

Copy link
Copy Markdown
Contributor Author

@elirangoshen elirangoshen Mar 11, 2026

Choose a reason for hiding this comment

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

ok I changed it and now it should execute in build time, there one trade off which it need to execute 1 async action (fetch) but I think its minor effect. what do you think ? @roryabraham @inimaga

The map is now built at webpack compile time and written to a static file module-names.json in dist/. It never touches the runtime chunk. The app fetches it lazily inside requestAnimationFrame

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 personally think a lazy fetch of a json file is probably a small price to pay for this visibility.

nit: why requestAnimationFrame instead of requestIdleCallback? The latter seems more idomatic for tasks unrelated to UI.

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.

Sure I changed it and pushed other minor change due to an exception I had sometimes of Multiple assets emit different content to the same filename module-names.json. now it seems working good.

Copy link
Copy Markdown
Contributor

@inimaga inimaga left a comment

Choose a reason for hiding this comment

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

One potential issue

@inimaga inimaga requested a review from roryabraham March 9, 2026 14:40
@inimaga

This comment was marked as resolved.

@chatgpt-codex-connector

This comment was marked as outdated.

@roryabraham
Copy link
Copy Markdown
Contributor

@codex review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. 🎉

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@roryabraham roryabraham requested a review from Julesssss March 9, 2026 22:25
Copy link
Copy Markdown
Contributor

@JmillsExpensify JmillsExpensify left a comment

Choose a reason for hiding this comment

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

No product review required on this one.

@Julesssss Julesssss changed the title [Sentry] Adding module names to web [NO QA][Sentry] Adding module names to web Mar 10, 2026
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Mar 10, 2026

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?

@elirangoshen
Copy link
Copy Markdown
Contributor Author

I might refactor anyway so ill check after well decide what to do

Copy link
Copy Markdown
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

@elirangoshen could you please share some before/after metrics for reference

@elirangoshen
Copy link
Copy Markdown
Contributor Author

Hmmm. This is a going to add a non-trivial amount of startup JS for every user in production, as we're effectively shipping a moduleId -> path manifest for every first-party webpack module in the app inside the runtime chunk. Could we rework this to avoid shipping the full map at startup? cc: @roryabraham

so for the web span ManualAppStartup was better after the change , naybe due ti other chnages in main branch :
median value in 10 runs: ManualAppStartup duration was before the change1073ms and after 1016ms

@Julesssss
Copy link
Copy Markdown
Contributor

@rinej @inimaga ready for our final reviews again.

Copy link
Copy Markdown
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

Looking good, one minor comment

Copy link
Copy Markdown
Contributor

@Julesssss Julesssss left a comment

Choose a reason for hiding this comment

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

LGTM

@Julesssss
Copy link
Copy Markdown
Contributor

Sorry for delay, was ooo

@Julesssss
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 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

@Julesssss Julesssss merged commit 441d85a into Expensify:main Mar 23, 2026
31 of 35 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

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

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.3.43-3 🚀

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.

8 participants