[CP Staging] Keep original isClientTheLeader value on page refresh #42095

Skakruk · 2024-05-13T18:17:20Z

Details

Login - 'Another login page is open' briefly displayed when refresh the page

A bug was caused by this PR #40997. On page refresh, the app was cleaning its own clientID from the list of active clients. And while the page is still visible Onyx reports change and triggers re-render. Since clientID is already removed from the list, isClientTheLeader returns false.

Fixed Issues

$ #42062
PROPOSAL: #42062 (comment)

Tests

Open sign-in page
Hit Refresh page
Title "Get started below." should not change to "Another login page is open."

Offline tests

QA Steps

Open sign-in page
Hit Refresh page
Title "Get started below." should not change to "Another login page is open."

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
- MacOS: Desktop
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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 verified the translation was requested/reviewed 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.js 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 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.
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: mWeb Chrome

az_recorder_20240514_220249_edited.mp4

iOS: mWeb Safari

RPReplay_Final1715707087.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-05-13.at.21.10.30.mp4

melvin-bot · 2024-05-13T18:17:25Z

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

tgolen · 2024-05-13T18:51:44Z

src/libs/ActiveClientManager/index.ts

+ * The last GUID is the most recent GUID, so that should be the leader
+ */
+const isClientTheLeader: IsClientTheLeader = () => {
+    if (wasTheLeader) {


Can you please add a comment here explaining why this logic is necessary? Maybe a better name for this variable would be isPromotingAnotherLeader or something.

Fun fact, var name isPromotingAnotherLeader was triggering eslint rule no-negated-condition. So I had to use isPromotingNewLeader

ishpaul777 · 2024-05-13T19:26:57Z

is this PR requires me as c+ @tgolen : )

tgolen · 2024-05-13T19:35:55Z

is this PR requires me as c+ @tgolen : )

Yes, would you please do the checklist for this PR and test it?

ishpaul777 · 2024-05-13T19:59:05Z

GH actions are down, was waiting for it to complete 🤦‍♂️

ishpaul777 · 2024-05-13T19:59:29Z

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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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.js 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.
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: Native

Android: mWeb Chrome

Screen.Recording.2024-05-14.at.4.17.09.AM.mov

iOS: Native

N/a

iOS: mWeb Safari

Screen.Recording.2024-05-14.at.3.58.11.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-14.at.2.29.33.AM.mov

MacOS: Desktop

N/A SINCE ITS NOT POSSIBLE TO OPEN APP ON DIFFERENT TABS ON DESKTOP

ishpaul777 · 2024-05-13T20:03:48Z

@Skakruk Please add QA steps (should be same as test steps just mention this under QA steps)

ishpaul777 · 2024-05-13T20:19:52Z

Whats the expected behaviour in case 2 tabs are open in same window, I see "Get started below." on both screens 🤔

Skakruk · 2024-05-13T20:24:27Z

@ishpaul777 that's correct behavior since once the tab is active, client becomes the leader

ishpaul777 · 2024-05-13T20:26:51Z

okay this make sense, then what are the specific conditions where we show the screen and why (just want to understand the issue better)

Skakruk · 2024-05-13T20:33:04Z

you may see the bug in related issue #42062
The issue is the when there is only one tab active (hence already leading client) and user refreshs the page, the cleanup process is removing current client ID and it mistakingly becomes not the leading one. This leads to showing the "Another login page is open." title on sign up page for a second before the page is refreshed.

ishpaul777 · 2024-05-13T20:49:53Z

okay i get the issue this PR is fixing, but i am asking when do we show "Another login page is open." is it only when the tab is open on different window, say Tab A and Tab B on same window, i open Tab B in different window, Tab A shows "Another login page is open." Am i understanding correctly? is there any case i am missing?

Screen.Recording.2024-05-14.at.2.17.37.AM.mov

ishpaul777 · 2024-05-13T21:09:17Z

also @Skakruk Can you please add demo videos for Andriod chrome and Ios safari

Skakruk · 2024-05-13T21:27:49Z

We don’t have such scenarios for native devices. Also, the code is mocked for that platforms. It only affects web browsers.

…

On Tue, May 14, 2024 at 00:09 Ishpaul Singh ***@***.***> wrote: also @Skakruk <https://github.com/Skakruk> Can you please add demo videos for Andriod chrome and Ios safari — Reply to this email directly, view it on GitHub <#42095 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AANP3V3NOKLP2DCIK6VAKGLZCETZJAVCNFSM6AAAAABHUWNPV6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBYHAYDIMJRGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

ishpaul777 · 2024-05-13T22:33:02Z

It only affects web browsers

Yeah thats why i asked only for android mweb-chrome and mweb safari video : )

tgolen · 2024-05-14T14:47:47Z

src/libs/ActiveClientManager/index.ts

+    // keep reporting currently leading client on page refresh
+    // when clientID is already removed from activeClients list


Suggested change

// keep reporting currently leading client on page refresh

// when clientID is already removed from activeClients list

// When a new leader is being promoted, there is a small period of time when the current leader's clientID has been removed from the activeClients list due to asynchronous operations, but the new leader hasn't officially taken over yet. This can lead to a moment when the page is refreshed where multiple leaders are being reported. This early return here will prevent that from happening by keeping the current leader as the "active leader" until the other leader is fully promoted.

Please be sure that comments are all proper English and do a thorough job of explaining the purpose of the logic. Also, even though I've added this suggestion, you'll need to split it up into multiple lines (I suggest using our line max length setting for this).

Thank you, I've updated the comment.

ishpaul777 · 2024-05-14T17:57:47Z

@Skakruk Please add videos for mweb chrome and mweb safari its not skipable item in checklist for this case

Skakruk · 2024-05-14T19:09:54Z

@ishpaul777 I've uploaded screen records for iOS Safari and Android Chrome devices

ishpaul777

tgolen · 2024-05-14T20:09:50Z

You completed 56 out of 57 checklist items with 1 unfinished items

@ishpaul777 did you want to check off that last item?

ishpaul777 · 2024-05-14T20:12:42Z

ah sorry, checked it off :D

OSBotify · 2024-05-14T21:07:01Z

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

[CP Staging] Keep original isClientTheLeader value on page refresh (cherry picked from commit 8a5bc9c)

OSBotify · 2024-05-14T23:31:19Z

🚀 Cherry-picked to staging by https://github.com/mountiny in version: 1.4.73-7 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-05-15T09:52:22Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.73-7 🚀

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

Keep original isClientTheLeader value on page refresh

8f080a8

Skakruk requested a review from a team as a code owner May 13, 2024 18:17

melvin-bot bot requested review from ishpaul777 and removed request for a team May 13, 2024 18:17

Skakruk mentioned this pull request May 13, 2024

[HOLD for payment 2024-05-22] Login - 'Another login page is open' briefly displayed when refresh the page #42062

Closed

6 tasks

Skakruk added 2 commits May 13, 2024 21:32

Linting

d060f0b

Linting

9a6c5d5

tgolen requested changes May 13, 2024

View reviewed changes

Change var name and add comment

850cb06

danieldoglas mentioned this pull request May 14, 2024

[$250] Chat - Unending skeleton is displayed on first time sign-up #42063

Closed

6 tasks

tgolen requested changes May 14, 2024

View reviewed changes

Update comment

c185bdd

ishpaul777 approved these changes May 14, 2024

View reviewed changes

melvin-bot bot requested a review from tgolen May 14, 2024 19:18

tgolen approved these changes May 14, 2024

View reviewed changes

jasperhuangg changed the title ~~Keep original isClientTheLeader value on page refresh~~ [CP Staging] Keep original isClientTheLeader value on page refresh May 14, 2024

jasperhuangg approved these changes May 14, 2024

View reviewed changes

tgolen merged commit 8a5bc9c into Expensify:main May 14, 2024
20 of 21 checks passed

OSBotify pushed a commit that referenced this pull request May 14, 2024

Merge pull request #42095 from Skakruk/42062-login-title-on-refresh

b5f3804

[CP Staging] Keep original isClientTheLeader value on page refresh (cherry picked from commit 8a5bc9c)

github-actions bot mentioned this pull request May 14, 2024

Deploy Checklist: New Expensify 2024-05-13 #42040

Closed

74 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Keep original isClientTheLeader value on page refresh #42095

[CP Staging] Keep original isClientTheLeader value on page refresh #42095

Skakruk commented May 13, 2024 •

edited

Loading

melvin-bot bot commented May 13, 2024

tgolen May 13, 2024

Skakruk May 13, 2024

ishpaul777 commented May 13, 2024 •

edited

Loading

tgolen commented May 13, 2024

ishpaul777 commented May 13, 2024

ishpaul777 commented May 13, 2024 •

edited

Loading

ishpaul777 commented May 13, 2024

ishpaul777 commented May 13, 2024

Skakruk commented May 13, 2024

ishpaul777 commented May 13, 2024

Skakruk commented May 13, 2024 •

edited

Loading

ishpaul777 commented May 13, 2024

ishpaul777 commented May 13, 2024

Skakruk commented May 13, 2024 via email

ishpaul777 commented May 13, 2024 •

edited

Loading

tgolen May 14, 2024

Skakruk May 14, 2024

ishpaul777 commented May 14, 2024

Skakruk commented May 14, 2024

ishpaul777 left a comment

tgolen commented May 14, 2024

ishpaul777 commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

		// keep reporting currently leading client on page refresh
		// when clientID is already removed from activeClients list

	// keep reporting currently leading client on page refresh
	// when clientID is already removed from activeClients list
	// When a new leader is being promoted, there is a small period of time when the current leader's clientID has been removed from the activeClients list due to asynchronous operations, but the new leader hasn't officially taken over yet. This can lead to a moment when the page is refreshed where multiple leaders are being reported. This early return here will prevent that from happening by keeping the current leader as the "active leader" until the other leader is fully promoted.

[CP Staging] Keep original isClientTheLeader value on page refresh #42095

[CP Staging] Keep original isClientTheLeader value on page refresh #42095

Conversation

Skakruk commented May 13, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 13, 2024

tgolen May 13, 2024

Choose a reason for hiding this comment

Skakruk May 13, 2024

Choose a reason for hiding this comment

ishpaul777 commented May 13, 2024 • edited Loading

tgolen commented May 13, 2024

ishpaul777 commented May 13, 2024

ishpaul777 commented May 13, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 commented May 13, 2024

ishpaul777 commented May 13, 2024

Skakruk commented May 13, 2024

ishpaul777 commented May 13, 2024

Skakruk commented May 13, 2024 • edited Loading

ishpaul777 commented May 13, 2024

ishpaul777 commented May 13, 2024

Skakruk commented May 13, 2024 via email

ishpaul777 commented May 13, 2024 • edited Loading

tgolen May 14, 2024

Choose a reason for hiding this comment

Skakruk May 14, 2024

Choose a reason for hiding this comment

ishpaul777 commented May 14, 2024

Skakruk commented May 14, 2024

ishpaul777 left a comment

Choose a reason for hiding this comment

tgolen commented May 14, 2024

ishpaul777 commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

Skakruk commented May 13, 2024 •

edited

Loading

ishpaul777 commented May 13, 2024 •

edited

Loading

ishpaul777 commented May 13, 2024 •

edited

Loading

Skakruk commented May 13, 2024 •

edited

Loading

ishpaul777 commented May 13, 2024 •

edited

Loading