fix: incorrect page is displayed when refreshing the page #54680

truph01 · 2024-12-31T09:40:03Z

Explanation of Change

Fixed Issues

$ #54021
PROPOSAL: #54021 (comment)

Tests

Go to ND
Go to settings - security - copilot
Select a user - full access
Tap add copilot
Refresh the page
Verify: On refreshing copilot magic code page, user must not be directed to previous page.

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]."

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

Screen.Recording.2024-12-31.at.16.32.23.mov

Android: mWeb Chrome

Screen.Recording.2024-12-31.at.16.31.06.mov

iOS: Native

Screen.Recording.2024-12-31.at.16.35.21.mov

iOS: mWeb Safari

Screen.Recording.2024-12-31.at.16.34.13.mov

MacOS: Chrome / Safari

Screen.Recording.2024-12-31.at.16.29.38.mov

MacOS: Desktop

Screen.Recording.2024-12-31.at.16.38.51.mov

melvin-bot · 2024-12-31T09:40:09Z

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

allgandalf · 2025-01-02T03:23:34Z

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 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: Native

Screen.Recording.2025-02-24.at.5.50.18.PM.mov

Android: mWeb Chrome

Screen.Recording.2025-02-24.at.5.48.49.PM.mov

iOS: Native

Screen.Recording.2025-01-31.at.12.39.26.PM.mov

iOS: mWeb Safari

Screen.Recording.2025-01-31.at.12.40.22.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-01-31.at.12.36.23.PM.mov

MacOS: Desktop

Screen.Recording.2025-01-31.at.12.37.02.PM.mov

allgandalf · 2025-01-07T10:20:53Z

@truph01 , we are still getting navigated to previous page and then we come on the code page, which prompts to multiple magic codes, can you please check?

truph01 · 2025-01-07T10:39:10Z

we are still getting navigated to previous page and then we come on the code page, which prompts to multiple magic codes, can you please check?

Sorry, can you give me the detailed reproduction steps for this issue?

allgandalf · 2025-01-09T05:38:25Z

just follow the steps you wrote , you can see that we still see the previous page for a split second. please check the expected result from the issue:

On refreshing copilot magic code page, user must not be directed to previous page.

Note that the user gets redirected to the code page, here the expected result is that we should not get redirected

Screen.Recording.2025-01-09.at.11.07.42.AM.mov

truph01 · 2025-01-10T02:58:05Z

@allgandalf I updated PR to address issue

allgandalf · 2025-01-10T06:02:00Z

src/pages/settings/Security/AddDelegate/ConfirmDelegatePage.tsx

@@ -1,4 +1,4 @@
-import React, {useState} from 'react';


@truph01 for my understanding, can you explain why that regression occured and how did we fix it?

asking cause I'm not a fan of introducing new props unless there is no other option

can you explain why that regression occured and how did we fix it?

The modal defined in:

App/src/pages/settings/Security/AddDelegate/ConfirmDelegatePage.tsx

Line 82 in fe6cfc2

<DelegateMagicCodeModal

utilizes animation for sliding in and out. Consequently, even if we consistently set the isValidateCodeActionModalVisible value to true in:

App/src/pages/settings/Security/AddDelegate/ConfirmDelegatePage.tsx

Line 93 in fe6cfc2

isValidateCodeActionModalVisible={isValidateCodeActionModalVisible}

the modal doesn’t appear instantly. Instead, its container remains visible momentarily due to the animation transition.

makes sense to me, thanks a lot

allgandalf · 2025-01-13T07:46:15Z

src/pages/settings/Security/AddDelegate/ConfirmDelegatePage.tsx

@@ -80,6 +87,8 @@ function ConfirmDelegatePage({route}: ConfirmDelegatePageProps) {
                    shouldShowRightIcon
                />
                <DelegateMagicCodeModal
+                    // eslint-disable-next-line react-compiler/react-compiler


why do we need to disable this one ?

If not, we will encounter the lint error: Ref values (the current property) may not be accessed during render

yeah i mean 😅 , we shouldn't disable the error unless it's absolutely necessary, can you work through it?

I couldn't find a way to fix the ESLint issue without disabling the lint rule. However, we are using similar logic in many places throughout the app, such as:

App/src/pages/home/report/ContextMenu/PopoverReportActionContextMenu.tsx

Line 1 in 51ffc9c

/* eslint-disable react-compiler/react-compiler */

can you ask on open source channel, i'm not really sure about this update

I asked here https://expensify.slack.com/archives/C01GTK53T8Q/p1736941321586909

@allgandalf I just updated PR. Now I use state instead of ref.

truph01 · 2025-01-23T10:07:14Z

@allgandalf Could you review PR once you have a chance? Thanks.

allgandalf · 2025-01-29T07:05:08Z

src/components/ValidateCodeActionModal/index.tsx

@@ -70,6 +71,7 @@ function ValidateCodeActionModal({
            hideModalContentWhileAnimating
            useNativeDriver
            shouldUseModalPaddingStyle={false}
+            animationInTiming={disableAnimation ? 1 : undefined}


@truph01 can you please put a comment here explaining why this is needed ? the git blame will not explain to others why we needed this

I just added comment

allgandalf · 2025-01-29T09:46:03Z

src/components/ValidateCodeActionModal/index.tsx

+            // If `disableAnimation` is true, set `animationInTiming` to 1 to disable the animation effect
+            animationInTiming={disableAnimation ? 1 : undefined}


let me rephrase 😅 , I meant that we need explanation for this change and not what this expression does

I believe the comment 'set animationInTiming to 1 to disable the animation effect' already clarifies the change. Do you have any suggestions for it?

Just so you know, the line animationInTiming={disableAnimation ? 1 : undefined} is already in use in our app without any comment.

I believe the comment 'set animationInTiming to 1 to disable the animation effect' already clarifies the change. Do you have any suggestions for it?

It's not about the change but more of the functionality, In the checklist we have:

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.

Just so you know, the line animationInTiming={disableAnimation ? 1 : undefined} is already in use in our app without any comment.

There should had been a comment explaning it, i will raise this one internally but in the meantime please explain why we needed to make the change

Are you suggesting that we add a comment explaining why this change fixes the issue? If so, I think it would be better to add the comment to this line:

The comment could be:
'We should disable the animation initially and only enable it when the user manually opens the modal to ensure it appears immediately when refreshing the page.'

About the animationInTiming={disableAnimation ? 1 : undefined}, we can discuss internally adding the comment since this line has also been used in other places in the past.

works for me!

I updated it

allgandalf · 2025-01-31T07:00:30Z

src/pages/settings/Security/AddDelegate/ConfirmDelegatePage.tsx

+                    // We should disable the animation initially and only enable it when the user manually opens the modal
+                    // to ensure it appears immediately when refreshing the page.
+                    disableAnimation={shouldDisableModalAnimation}


makes a lot of sense to anyone reading this in the future, thanks for this ❤️

allgandalf · 2025-01-31T07:13:22Z

@truph01 the PR still shows the previous page for a second for small screen refresh:

Screen.Recording.2025-01-31.at.12.43.05.PM.mov

truph01 · 2025-01-31T18:44:22Z

The previous page briefly appears as mentioned in here because our modal isn't displayed immediately when visible is set to true. I plan to show a loading indicator instead of the previous screen until the modal fully appears. You can see the result of that plan in the video below:

Screen.Recording.2025-02-01.at.01.36.34.mov

cc @Expensify/design Would love to hear your thoughts—thanks!

truph01 · 2025-02-12T11:08:48Z

@Expensify/design Could you please help take a look once you have a chance, thanks.

allgandalf · 2025-02-18T10:29:28Z

bump @Expensify/design

shawnborton · 2025-02-18T14:20:04Z

Sorry, totally missed this one!

I plan to show a loading indicator instead of the previous screen until the modal fully appears. You can see the result of that plan in the video below:

That makes sense to me and sounds like a good solution - let's go with it and see how it feels.

truph01 · 2025-02-19T11:54:21Z

I plan to show a loading indicator instead of the previous screen until the modal fully appears. You can see the result of that plan in the video below:

I updated PR to align with this solution and here is result:

Screen.Recording.2025-02-19.at.18.49.18.mov

shawnborton · 2025-02-19T13:14:26Z

Looks like you can slightly see the previous page though?

That being said, this is not a common case so I don't think we need to bang our heads over a perfect solution here.

truph01 · 2025-02-19T14:30:17Z

Looks like you can slightly see the previous page though?

Yes, it is because the loading indicator has a transparent background

shawnborton · 2025-02-19T14:45:29Z

Cool - if we really want to be perfect about this, I would pass through an extraClass to make it so that the BG doesn't have transparency, but I don't feel strongly.

truph01 · 2025-02-19T14:49:15Z

@shawnborton As you said above, "That being said, this is not a common case so I don't think we need to bang our heads over a perfect solution here.", I believe the loading indicator with a transparent background is sufficient, as it’s not a frequent scenario, and even when it occurs, the loading screen is only displayed briefly.

shawnborton · 2025-02-19T14:53:39Z

Fair!

OSBotify · 2025-02-24T12:59:39Z

✋ 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-02-24T20:14:29Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.1.5-0 🚀

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

github-actions · 2025-02-26T00:03:36Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.1.5-5 🚀

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

fix: incorrect page is displayed when refreshing the page

025c78b

truph01 requested a review from a team as a code owner December 31, 2024 09:40

melvin-bot bot requested review from allgandalf and removed request for a team December 31, 2024 09:40

truph01 mentioned this pull request Dec 31, 2024

[Due for payment 2025-03-05] [$250] mWeb - Copilot - On refreshing copilot magic code page, user directed to previous page #54021

Closed

8 tasks

fix: lint

c98a3a5

truph01 added 2 commits January 10, 2025 09:40

merge main

7a83b03

fix: disable modal animation after refreshing page

13d0c65

allgandalf reviewed Jan 10, 2025

View reviewed changes

allgandalf reviewed Jan 13, 2025

View reviewed changes

truph01 added 5 commits January 14, 2025 17:25

merge main

d70595e

merge maiin

4ed9e5a

fix: use useState instead of useRef

ca4b1e7

fix: lint

728ac39

fix: lint

e49143e

allgandalf reviewed Jan 29, 2025

View reviewed changes

truph01 added 2 commits January 29, 2025 16:37

merge main

f429543

fix: add comment

15c3b56

allgandalf reviewed Jan 29, 2025

View reviewed changes

truph01 added 2 commits January 30, 2025 16:29

merge main

669eb15

fix: add comment

c986d69

allgandalf reviewed Jan 31, 2025

View reviewed changes

merge main

f44a299

This comment was marked as duplicate.

Sign in to view

truph01 added 2 commits February 19, 2025 17:40

merge main

c0ad5d2

fix: Show loading indicator when the magic modal is showing

45c2e9e

allgandalf approved these changes Feb 24, 2025

View reviewed changes

melvin-bot bot requested a review from carlosmiceli February 24, 2025 12:21

carlosmiceli approved these changes Feb 24, 2025

View reviewed changes

carlosmiceli merged commit e0204bb into Expensify:main Feb 24, 2025
17 checks passed

github-actions bot mentioned this pull request Feb 24, 2025

Deploy Checklist: New Expensify 2025-02-24 #57336

Closed

52 tasks

ikevin127 mentioned this pull request Feb 25, 2025

[$250] Web - Copilot- Page redirects after refreshing Copilot Magic Code page after changing access #57342

Open

8 tasks

		// If `disableAnimation` is true, set `animationInTiming` to 1 to disable the animation effect
		animationInTiming={disableAnimation ? 1 : undefined}

fix: incorrect page is displayed when refreshing the page #54680

fix: incorrect page is displayed when refreshing the page #54680

Conversation

truph01 commented Dec 31, 2024

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 31, 2024

allgandalf commented Jan 2, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf commented Jan 7, 2025

truph01 commented Jan 7, 2025

allgandalf commented Jan 9, 2025

truph01 commented Jan 10, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

truph01 commented Jan 23, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

truph01 Jan 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

allgandalf commented Jan 31, 2025

truph01 commented Jan 31, 2025

truph01 commented Feb 12, 2025

allgandalf commented Feb 18, 2025

This comment was marked as duplicate.

shawnborton commented Feb 18, 2025

truph01 commented Feb 19, 2025

shawnborton commented Feb 19, 2025

truph01 commented Feb 19, 2025

shawnborton commented Feb 19, 2025

truph01 commented Feb 19, 2025 • edited Loading

shawnborton commented Feb 19, 2025

OSBotify commented Feb 24, 2025

github-actions bot commented Feb 24, 2025

github-actions bot commented Feb 26, 2025

allgandalf commented Jan 2, 2025 •

edited

Loading

truph01 Jan 29, 2025 •

edited

Loading

truph01 commented Feb 19, 2025 •

edited

Loading