Fix not calling OpenApp command when transitioning to NewDot from OldDot by kubabutkiewicz · Pull Request #59835 · Expensify/App

kubabutkiewicz · 2025-04-08T14:50:56Z

Explanation of Change

This change addresses an issue that occasionally occurs during the transition from olddot to newdot, where data fails to load properly into Onyx. The root cause is that the OpenApp API is not being called. This occurs because during initialization, likely due to a race condition or Onyx not being fully initialized, the clientId from ActiveClientManager is not successfully added to the activeClients array, resulting in the absence of a leaderClientId. The implemented solution ensures that when no leader client ID is detected during a transition, the init method from ActiveClientManager is called again to properly establish the leader client ID.

Fixed Issues

$ #59800
PROPOSAL:

Tests

Open Old dot and login to account which can be migrated to NewDot
Open NewDot in second tab and be on SignIn page
Open DevTools -> Application tab
Remove all data from Onyx
Go to old dot and click Try New Expensify
When transitioning to New Dot copy the transition url
Go to New dot which is on Sign in page
In the url type the transition url and go to this url
You should now log in into NewDot and OpenApp api should be correctly called

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Go to OldDot
Migrate account to NewDot
Verify that you are correctly logged in and all data is correct

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

old-dot-bug.mp4

MacOS: Desktop

melvin-bot · 2025-04-08T14:51:02Z

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

github-actions · 2025-04-08T14:53:07Z

🚧 @mountiny has triggered a test app build. You can view the workflow run here.

github-actions · 2025-04-08T15:12:31Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
Android 🤖🔄	iOS 🍎🔄
❌ FAILED ❌	❌ FAILED ❌
The QR code can't be generated, because the Android build failed	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/59835/NewExpensify.dmg	https://59835.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

kubabutkiewicz · 2025-04-08T15:23:44Z

I will fix the lint errors, they are due to need of change the imports types to named.

…to fix-not-calling-openApp-command-when-transitioning

kubabutkiewicz · 2025-04-09T08:50:27Z

        initializePusher();
+        // Sometimes when we transition from old dot to new dot, the client is not the leader
+        // so we need to initialize the client again
+        if (!isClientTheLeader() && isTransitioning) {


Wondering if we should always call init when there is no clientLeader because I suspect that maybe it was the same case for Doza here https://callstack-hq.slack.com/archives/C05LX9D6E07/p1743436382386309 @mountiny and the ReconnectApp command wasnt called

from high level that makes sense to me

QichenZhu · 2025-04-09T13:55:51Z

@kubabutkiewicz I tested the solution on macOS Chrome and it works 🎉.

Could I get some clarification on the root cause?

This occurs because during initialization, likely due to a race condition or Onyx not being fully initialized, the clientId from ActiveClientManager is not successfully added to the activeClients array

Does the race condition originate from the Onyx library or E/App?

I logged the activeClients value changes during initialization and saw these outputs, so I’m not sure if this PR fixes the race condition or just masks it.

Before this PR: (Correct --> Wrong)

activeClients: ['5de9aded-bab2-89e4-e4d2-7b7474062c3f']
activeClients: []

After this PR: (Correct --> Wrong --> Correct)

activeClients: ['a74965ee-ed93-2a06-9f97-43444c687ef0']
activeClients: []
activeClients: ['a74965ee-ed93-2a06-9f97-43444c687ef0']

Screenshots

Before this PR

After this PR

kubabutkiewicz · 2025-04-11T07:31:30Z

Sorry @QichenZhu didn't see the notification for that. Yeah you are right it is more masking it right now. But I was struggling to find the exact root cause of that. So that was just a solution of that problem I could figure out right now.

QichenZhu · 2025-04-11T10:43:57Z

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)
  N/A. Test steps require an active network connection.
I checked that screenshots or videos are included for tests on all platforms
Test steps only apply to MacOS: Chrome / Safari.
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: Native
- Android: mWeb Chrome
- iOS: Native
- 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 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.
N/A. This is a workaround. The issue might not be from E/App.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android-native.mp4

Android: mWeb Chrome

android-web.mov

iOS: Native

ios-native.mp4

iOS: mWeb Safari

ios-web.mov

MacOS: Chrome / Safari

mac-web.mov

MacOS: Desktop

mac-desktop.mov

mountiny

Thanks! Callstack is looking for someone to dig deeper to also fix the RCA

OSBotify · 2025-04-11T14:07:42Z

✋ 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 · 2025-04-14T23:17:34Z

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

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

github-actions · 2025-04-16T22:13:37Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.1.28-15 🚀

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

add client initlialization if there is no current leader

cd615f1

kubabutkiewicz requested a review from a team as a code owner April 8, 2025 14:50

melvin-bot Bot requested review from QichenZhu and removed request for a team April 8, 2025 14:51

mountiny assigned kubabutkiewicz Apr 8, 2025

mountiny mentioned this pull request Apr 8, 2025

[Due for payment 2025-06-18] [$125] Update the adhoc build message to say a build was skipped and not failed #59843

Closed

mkzie2 mentioned this pull request Apr 8, 2025

[No QA] Update the adhoc build message to say a build was skipped and not failed #59847

Merged

50 tasks

kubabutkiewicz added 2 commits April 9, 2025 09:45

Merge branch 'main' of github.com:callstack-internal/Expensify-App in…

e5ae9bb

…to fix-not-calling-openApp-command-when-transitioning

fix lint

18d2f62

kubabutkiewicz commented Apr 9, 2025

View reviewed changes

Comment thread src/libs/Navigation/AppNavigator/AuthScreens.tsx Outdated

move initialization of ActiveClientManager higher

a5c3097

kubabutkiewicz commented Apr 9, 2025

View reviewed changes

QichenZhu approved these changes Apr 11, 2025

View reviewed changes

melvin-bot Bot requested a review from mountiny April 11, 2025 13:54

mountiny approved these changes Apr 11, 2025

View reviewed changes

mountiny merged commit 32492c3 into Expensify:main Apr 11, 2025

github-actions Bot mentioned this pull request Apr 15, 2025

Deploy Checklist: New Expensify 2025-04-15 #60222

Closed

melvin-bot Bot mentioned this pull request Apr 16, 2025

[$250] [Due for payment 2025-04-23] Users are seeing the all caught up page in LHN even if they have data locally #59800

Closed

18 tasks

Navigation Menu

Fix not calling OpenApp command when transitioning to NewDot from OldDot - #59835

Fix not calling OpenApp command when transitioning to NewDot from OldDot#59835
mountiny merged 4 commits into
Expensify:mainfrom
callstack-internal:fix-not-calling-openApp-command-when-transitioning

kubabutkiewicz commented Apr 8, 2025

Uh oh!

melvin-bot Bot commented Apr 8, 2025

Uh oh!

github-actions Bot commented Apr 8, 2025

Uh oh!

github-actions Bot commented Apr 8, 2025

Uh oh!

kubabutkiewicz commented Apr 8, 2025

Uh oh!

Uh oh!

kubabutkiewicz Apr 9, 2025

Uh oh!

mountiny Apr 9, 2025

Uh oh!

QichenZhu commented Apr 9, 2025

Uh oh!

kubabutkiewicz commented Apr 11, 2025

Uh oh!

QichenZhu commented Apr 11, 2025 •

edited

Loading

Uh oh!

mountiny left a comment

Uh oh!

OSBotify commented Apr 11, 2025

Uh oh!

github-actions Bot commented Apr 14, 2025

Uh oh!

github-actions Bot commented Apr 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

kubabutkiewicz commented Apr 8, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Apr 8, 2025

Uh oh!

github-actions Bot commented Apr 8, 2025

Uh oh!

github-actions Bot commented Apr 8, 2025

Uh oh!

kubabutkiewicz commented Apr 8, 2025

Uh oh!

Uh oh!

kubabutkiewicz Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

mountiny Apr 9, 2025

Choose a reason for hiding this comment

Uh oh!

QichenZhu commented Apr 9, 2025

Screenshots

Uh oh!

kubabutkiewicz commented Apr 11, 2025

Uh oh!

QichenZhu commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 11, 2025

Uh oh!

github-actions Bot commented Apr 14, 2025

Uh oh!

github-actions Bot commented Apr 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

QichenZhu commented Apr 11, 2025 •

edited

Loading