Fix multiple open report call when report screen is mounted by bernhardoj · Pull Request #40624 · Expensify/App

bernhardoj · 2024-04-20T06:12:04Z

Details

We call OpenReport in both ReportScreen and ReportActionsView. This PR fix it.

Fixed Issues

$ #39673
PROPOSAL: #39673 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Web/Desktop

Open developer tools
Switch to the Network tab
Sign out and sign in
Wait until the app load completes
In the network tab, verify there is only 1 OpenReport call

Android/iOS/mWeb

Open developer tools (not available in Android/iOS)
Switch to the Network tab
Open any report
In the network tab, verify there is only 1 OpenReport call

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-20.at.14.02.00.mov

Android: mWeb Chrome

Screen.Recording.2024-04-20.at.14.06.15.mov

iOS: Native

Screen.Recording.2024-04-20.at.13.58.34.mov

iOS: mWeb Safari

Screen.Recording.2024-04-20.at.13.59.27.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-20.at.13.52.31.mov

MacOS: Desktop

Screen.Recording.2024-04-20.at.13.54.01.mov

melvin-bot · 2024-04-20T06:12:09Z

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

bernhardoj · 2024-04-20T06:13:44Z

On a small screen, logging in won't call OpenReport since there is no report screen mounted which is different with a large screen. So, I only test opening some reports and verify the OpenReport call is still only called once.

I still saw some reports not making OpenReport API call with the mentioned changes

@abdulrahuman5196 can you tell me how to reproduce this? so I can take a look. Thanks!

abdulrahuman5196 · 2024-04-23T12:15:08Z

Checking now

abdulrahuman5196 · 2024-04-24T12:02:37Z

On a small screen, logging in won't call OpenReport since there is no report screen mounted which is different with a large screen. So, I only test opening some reports and verify the OpenReport call is still only called once.

I still saw some reports not making OpenReport API call with the mentioned changes

@abdulrahuman5196 can you tell me how to reproduce this? so I can take a look. Thanks!

I didn't see this issue yesterday. Will check again and approve if no other issues.

abdulrahuman5196 · 2024-04-26T16:38:52Z

Screen.Recording.2024-04-26.at.9.57.18.PM.mov

For some reports I am still seeing OpenReport being called twice after fresh signin. I suspect reports with partial skeleton loading is still calling OpenReport twice. Could you check on this @bernhardoj ?

bernhardoj · 2024-04-27T13:59:52Z

Looks like it's coming from this temporary code

App/src/pages/home/report/ReportActionsView.tsx

Lines 394 to 410 in 10fc359

    
           useEffect(() => { 
        
               // Temporary solution for handling REPORT_PREVIEW. More details: https://expensify.slack.com/archives/C035J5C9FAP/p1705417778466539?thread_ts=1705035404.136629&cid=C035J5C9FAP 
        
               // This code should be removed once REPORT_PREVIEW is no longer repositioned. 
        
               // We need to call openReport for gaps created by moving REPORT_PREVIEW, which causes mismatches in previousReportActionID and reportActionID of adjacent reportActions. The server returns the correct sequence, allowing us to overwrite incorrect data with the correct one. 
        
               const shouldOpenReport = 
        
                   newestReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW && 
        
                   !hasCreatedAction && 
        
                   isReadyForCommentLinking && 
        
                   reportActions.length < 24 && 
        
                   reportActions.length >= 1 && 
        
                   !isLoadingInitialReportActions && 
        
                   !isLoadingOlderReportActions && 
        
                   !isLoadingNewerReportActions; 
        
               if (shouldOpenReport) { 
        
                   Report.openReport(reportID, reportActionID); 
        
               }

From your video, I can see at least 2 satisfied conditions,
newestReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW
and
!hasCreatedAction

I think we can ignore it for now since it's a temporary code and the author already commented that it will be removed in the future.

Btw, idk how to reproduce it

abdulrahuman5196 · 2024-04-29T11:41:02Z

Looks like it's coming from this temporary code

App/src/pages/home/report/ReportActionsView.tsx

Lines 394 to 410 in 10fc359

useEffect(() => {

// Temporary solution for handling REPORT_PREVIEW. More details: https://expensify.slack.com/archives/C035J5C9FAP/p1705417778466539?thread_ts=1705035404.136629&cid=C035J5C9FAP

// This code should be removed once REPORT_PREVIEW is no longer repositioned.

// We need to call openReport for gaps created by moving REPORT_PREVIEW, which causes mismatches in previousReportActionID and reportActionID of adjacent reportActions. The server returns the correct sequence, allowing us to overwrite incorrect data with the correct one.

const shouldOpenReport =

newestReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW &&

!hasCreatedAction &&

isReadyForCommentLinking &&

reportActions.length < 24 &&

reportActions.length >= 1 &&

!isLoadingInitialReportActions &&

!isLoadingOlderReportActions &&

!isLoadingNewerReportActions;

if (shouldOpenReport) {

Report.openReport(reportID, reportActionID);

}

From your video, I can see at least 2 satisfied conditions, newestReportAction?.actionName === CONST.REPORT.ACTIONS.TYPE.REPORT_PREVIEW and !hasCreatedAction

I think we can ignore it for now since it's a temporary code and the author already commented that it will be removed in the future.

Btw, idk how to reproduce it

Got it. Verified and seems its the cause.

abdulrahuman5196 · 2024-04-29T12:12:40Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Screen.Recording.2024-04-29.at.5.33.34.PM.mp4

Android: mWeb Chrome

Screen.Recording.2024-04-29.at.5.37.29.PM.mp4

iOS: Native

Screen.Recording.2024-04-29.at.5.27.56.PM.mp4

iOS: mWeb Safari

Screen.Recording.2024-04-29.at.5.30.06.PM.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-04-29.at.5.15.14.PM.mp4

MacOS: Desktop

Screen.Recording.2024-04-29.at.5.17.58.PM.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @flodnv

🎀 👀 🎀
C+ Reviewed

OSBotify · 2024-04-29T23:34:15Z

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

platform	result
🤖 android 🤖	failure ❌
🖥 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-04-30T01:14:12Z

🚀 Deployed to staging by https://github.com/flodnv in version: 1.4.68-0 🚀

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

OSBotify · 2024-04-30T02:35:00Z

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

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

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

…ultiple-open-report" This reverts commit c343552, reversing changes made to c4d9d4e.

[CP Staging] Revert PR #40624, fix flickering when switching from task to parent

[CP Staging] Revert PR #40624, fix flickering when switching from task to parent (cherry picked from commit 221f850)

OSBotify · 2024-05-01T02:38:22Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.68-3 🚀

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

OSBotify · 2024-05-01T03:01:49Z

🚀 Deployed to staging by https://github.com/flodnv in version: 1.4.69-0 🚀

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

kbecciv · 2024-05-01T12:11:45Z

This PR is failing because of issue #39673

The issue is tested in: Web, mWeb and Desktop

1714550211587.Screen_Recording_2024-05-01_at_10.52.39_in_the_morning.mp4

1714550449687.Screen_Recording_2024-05-01_at_10.59.20_in_the_morning.mp4

1714550449687.Screen_Recording_2024-05-01_at_10.59.20_in_the_morning.1.mp4

OSBotify · 2024-05-02T13:05:24Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

fix multiple open report when mounted

eb29d41

bernhardoj requested a review from a team as a code owner April 20, 2024 06:12

melvin-bot bot removed the request for review from a team April 20, 2024 06:12

melvin-bot bot requested a review from abdulrahuman5196 April 20, 2024 06:12

remove unnecessary deps

257c1de

abdulrahuman5196 approved these changes Apr 29, 2024

View reviewed changes

melvin-bot bot requested a review from flodnv April 29, 2024 12:22

flodnv approved these changes Apr 29, 2024

View reviewed changes

flodnv merged commit c343552 into Expensify:main Apr 29, 2024

github-actions bot mentioned this pull request Apr 29, 2024

Deploy Checklist: New Expensify 2024-04-29 #41266

Closed

74 tasks

francoisl mentioned this pull request Apr 30, 2024

[HOLD for payment 2024-05-09] [HOLD for payment 2024-05-08] Thread - Chat flickers after clicking on link in thread header #41307

Closed

6 tasks

francoisl added a commit that referenced this pull request Apr 30, 2024

Revert "Merge pull request #40624 from bernhardoj/fix/39673-prevent-m…

159cadb

…ultiple-open-report" This reverts commit c343552, reversing changes made to c4d9d4e.

francoisl mentioned this pull request Apr 30, 2024

[CP Staging] Revert PR #40624, fix flickering when switching from task to parent #41352

Merged

49 tasks

melvin-bot bot added Reviewing Has a PR in review Weekly KSv2 labels Apr 30, 2024

yuwenmemon added a commit that referenced this pull request Apr 30, 2024

Merge pull request #41352 from Expensify/francois-revert-40624

221f850

[CP Staging] Revert PR #40624, fix flickering when switching from task to parent

OSBotify pushed a commit that referenced this pull request Apr 30, 2024

Merge pull request #41352 from Expensify/francois-revert-40624

c7810f1

[CP Staging] Revert PR #40624, fix flickering when switching from task to parent (cherry picked from commit 221f850)

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

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

melvin-bot bot mentioned this pull request May 1, 2024

[HOLD for payment 2024-05-09] [HOLD for payment 2024-05-08] HIGH: [API Reliability] [$250] Multiple calls to OpenReport on signin #39673

Closed

6 tasks

Conversation

bernhardoj commented Apr 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 20, 2024

Uh oh!

bernhardoj commented Apr 20, 2024

Uh oh!

abdulrahuman5196 commented Apr 23, 2024

Uh oh!

abdulrahuman5196 commented Apr 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abdulrahuman5196 commented Apr 26, 2024

Uh oh!

bernhardoj commented Apr 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abdulrahuman5196 commented Apr 29, 2024

Uh oh!

abdulrahuman5196 commented Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 29, 2024

Uh oh!

OSBotify commented Apr 30, 2024

Uh oh!

OSBotify commented Apr 30, 2024

Uh oh!

OSBotify commented May 1, 2024

Uh oh!

OSBotify commented May 1, 2024

Uh oh!

kbecciv commented May 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented May 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

bernhardoj commented Apr 20, 2024 •

edited

Loading

abdulrahuman5196 commented Apr 24, 2024 •

edited

Loading

bernhardoj commented Apr 27, 2024 •

edited

Loading

abdulrahuman5196 commented Apr 29, 2024 •

edited

Loading

kbecciv commented May 1, 2024 •

edited

Loading