#2 - Fix multiple open report call when report screen is mounted #41427

bernhardoj · 2024-05-01T15:17:37Z

Details

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

Fixed Issues

$ #41307
$ #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 and the report chat is shown

Android/iOS/mWeb

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

Next test for all platforms

Open a thread chat
Press the "From ..." text link
Verify the report screen won't show a blank screen briefly
Open an invalid reportID (such as 123) that you never load before in the device
Verify the skeleton shows and not found view will show after loading completes
Open a valid reportID that you don't have access to
Verify the not found view will show after loading completes

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-05-01.at.23.16.39.mov

Screen.Recording.2024-05-02.at.16.03.40.mov

Screen.Recording.2024-05-03.at.14.59.54.mov

Android: mWeb Chrome

Screen.Recording.2024-05-01.at.22.38.29.mov

Screen.Recording.2024-05-02.at.16.05.32.mov

Screen.Recording.2024-05-03.at.15.06.16.mov

iOS: Native

Screen.Recording.2024-05-01.at.22.44.22.mov

Screen.Recording.2024-05-02.at.16.08.40.mov

Screen.Recording.2024-05-03.at.15.02.43.mov

iOS: mWeb Safari

Screen.Recording.2024-05-01.at.22.25.39.mov

Screen.Recording.2024-05-02.at.16.07.22.mov

Screen.Recording.2024-05-03.at.15.01.17.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-01.at.19.19.58.mov

Screen.Recording.2024-05-02.at.15.58.35.mov

Screen.Recording.2024-05-03.at.14.58.16.mov

MacOS: Desktop

Screen.Recording.2024-05-01.at.22.17.51.mov

Screen.Recording.2024-05-02.at.16.02.30.mov

Screen.Recording.2024-05-03.at.14.59.12.mov

melvin-bot · 2024-05-01T15:17:43Z

@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-05-01T15:20:16Z

The reason #41307 happens is because if the report is loading, we return an empty report actions. Idk why we decide to do that.

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

Line 112 in 8661f6a

    
           const isLoading = (!!reportActionID && isLoadingInitialReportActions) || !isReadyForCommentLinking;

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

Lines 165 to 171 in 8661f6a

    
           const reportActions = useMemo(() => { 
        
               if (!reportActionID) { 
        
                   return combinedReportActions; 
        
               } 
        
               if (isLoading || indexOfLinkedAction === -1) { 
        
                   return []; 
        
               }

That's why we don't call OpenReport inside ReportActionsView if we are linking to a message.

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

Lines 240 to 247 in 8661f6a

    
           useEffect(() => { 
        
               if (reportActionID) { 
        
                   return; 
        
               } 
        
               const interactionTask = InteractionManager.runAfterInteractions(() => { 
        
                   openReportIfNecessary(); 
        
               });

So, I decided to do the same.

src/pages/home/ReportScreen.tsx

neil-marcellini

👋 Hi, I'm jumping in to review since this seems valuable. The logic for this area is pretty involved and I don't claim to fully understand it, so I'm asking some questions.

Let's pleas also add a lot more tests, such as opening a link to a message, opening an invalid reportID, opening a valid report link, opening a non-existent report link.

src/pages/home/ReportScreen.tsx

src/pages/home/report/ReportActionsView.tsx

bernhardoj · 2024-05-02T08:08:55Z

Added test for the invalid/non-existing report

neil-marcellini

Thanks for your replies. There's still a lot I'm unsure of, so I suggest some more tests to verify the behavior for both yourself and especially us reviewers.

Also please add steps distinguishing between opening an invalid reportID (such as 0), opening a valid report link, and opening a non-existent report link (some random valid id that doesn't exist). "Open an invalid chat" is a bit vague.

bernhardoj · 2024-05-03T07:07:56Z

opening an invalid reportID (such as 0)

Updated the step to be more clear

opening a valid report link,

A valid report link step is already in the test.

For the web, after signing in, a valid report will open. In the native test, there is already a step to open any report. I have updated it to "Open any report from LHN" and also to verify the valid report chat is shown to make it more clear.

opening a non-existent report link (some random valid id that doesn't exist)

Added the test step for this.

neil-marcellini

Ok, I think it should be good now. I still don't see a test for reportID 0. Leaving it to C+ and the managing engineer for final approvals and merge.

abdulrahuman5196 · 2024-05-06T16:06:50Z

Checking now

abdulrahuman5196 · 2024-05-07T12:10:33Z

@bernhardoj The skeleton view is flickering when moving to a report after sign-in. Could you kindly check on this?

Screen.Recording.2024-05-07.at.5.36.35.PM.mov

bernhardoj · 2024-05-07T14:41:40Z

Thanks for catching that. I found that it happens after we move the fetchReportIfNeeded inside the interaction task. Given that the timing difference is very small, I think we should put it back outside the interaction task. What do you think?

cc: @neil-marcellini

abdulrahuman5196 · 2024-05-10T14:35:25Z

@neil-marcellini Could you kindly check on the above?

neil-marcellini · 2024-05-10T16:06:30Z

@abdulrahuman5196 I gave a thumbs up, let's put it back outside the interaction task

bernhardoj · 2024-05-11T03:23:08Z

@abdulrahuman5196 updated

abdulrahuman5196 · 2024-05-13T10:45:54Z

Checking now

abdulrahuman5196 · 2024-05-13T11:09:47Z

@bernhardoj I am seeing multiple openReport calls after signin.

Screen.Recording.2024-05-13.at.4.35.45.PM.mp4

bernhardoj · 2024-05-13T13:10:56Z

That's really weird, i can't reproduce that at all.

Screen.Recording.2024-05-13.at.20.53.26.mov

neil-marcellini · 2024-05-14T17:14:23Z

@abdulrahuman5196 would you please re-test and provide specific test steps if you still experience the bug?

abdulrahuman5196 · 2024-05-14T17:48:27Z

Checking now again

abdulrahuman5196 · 2024-05-14T18:39:40Z

After latest merge I don't see this issue - #41427 (comment)

Finishing checklist.

abdulrahuman5196 · 2024-05-14T18:41:31Z

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-05-15.at.12.04.24.AM.mp4

Android: mWeb Chrome

Screen.Recording.2024-05-15.at.12.05.59.AM.mp4

iOS: Native

Screen.Recording.2024-05-14.at.11.57.43.PM.mp4

iOS: mWeb Safari

Screen.Recording.2024-05-15.at.12.02.06.AM.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-05-14.at.11.40.07.PM.mp4

MacOS: Desktop

Screen.Recording.2024-05-14.at.11.44.05.PM.mp4

abdulrahuman5196

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

All yours. @neil-marcellini / @flodnv

🎀 👀 🎀
C+ Reviewed

OSBotify · 2024-05-15T10:13:29Z

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

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

OSBotify · 2024-05-22T23:58:30Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

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

prevent multiple openreport call

3b0dcf5

bernhardoj requested a review from a team as a code owner May 1, 2024 15:17

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team May 1, 2024 15:17

bernhardoj commented May 1, 2024

View reviewed changes

src/pages/home/ReportScreen.tsx Show resolved Hide resolved

remove unnecessary deps

7e65896

neil-marcellini requested changes May 1, 2024

View reviewed changes

src/pages/home/ReportScreen.tsx Show resolved Hide resolved

src/pages/home/ReportScreen.tsx Show resolved Hide resolved

src/pages/home/report/ReportActionsView.tsx Show resolved Hide resolved

neil-marcellini reviewed May 2, 2024

View reviewed changes

fetch report after interaction

c3f0df3

neil-marcellini previously approved these changes May 3, 2024

View reviewed changes

Merge branch 'main' into fix/39673-prevent-multiple-open-report

38bf867

bernhardoj added 2 commits May 11, 2024 11:19

Merge branch 'main' into fix/39673-prevent-multiple-open-report

e1f52cf

put fetch report back outside interaction task

5c0d651

bernhardoj dismissed neil-marcellini’s stale review via 5c0d651 May 11, 2024 03:21

Merge branch 'main' into fix/39673-prevent-multiple-open-report

3f124c7

abdulrahuman5196 approved these changes May 14, 2024

View reviewed changes

melvin-bot bot requested a review from flodnv May 14, 2024 18:43

neil-marcellini approved these changes May 14, 2024

View reviewed changes

flodnv approved these changes May 14, 2024

View reviewed changes

flodnv merged commit 56ca21c into Expensify:main May 14, 2024
17 checks passed

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

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#2 - Fix multiple open report call when report screen is mounted #41427

#2 - Fix multiple open report call when report screen is mounted #41427

bernhardoj commented May 1, 2024 •

edited

Loading

melvin-bot bot commented May 1, 2024

bernhardoj commented May 1, 2024

neil-marcellini left a comment

bernhardoj commented May 2, 2024

neil-marcellini left a comment

bernhardoj commented May 3, 2024

neil-marcellini left a comment

abdulrahuman5196 commented May 6, 2024

abdulrahuman5196 commented May 7, 2024

bernhardoj commented May 7, 2024

abdulrahuman5196 commented May 10, 2024

neil-marcellini commented May 10, 2024

bernhardoj commented May 11, 2024

abdulrahuman5196 commented May 13, 2024

abdulrahuman5196 commented May 13, 2024

bernhardoj commented May 13, 2024

neil-marcellini commented May 14, 2024

abdulrahuman5196 commented May 14, 2024

abdulrahuman5196 commented May 14, 2024

abdulrahuman5196 commented May 14, 2024 •

edited

Loading

abdulrahuman5196 left a comment

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

#2 - Fix multiple open report call when report screen is mounted #41427

#2 - Fix multiple open report call when report screen is mounted #41427

Conversation

bernhardoj commented May 1, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 1, 2024

bernhardoj commented May 1, 2024

neil-marcellini left a comment

Choose a reason for hiding this comment

bernhardoj commented May 2, 2024

neil-marcellini left a comment

Choose a reason for hiding this comment

bernhardoj commented May 3, 2024

neil-marcellini left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented May 6, 2024

abdulrahuman5196 commented May 7, 2024

bernhardoj commented May 7, 2024

abdulrahuman5196 commented May 10, 2024

neil-marcellini commented May 10, 2024

bernhardoj commented May 11, 2024

abdulrahuman5196 commented May 13, 2024

abdulrahuman5196 commented May 13, 2024

bernhardoj commented May 13, 2024

neil-marcellini commented May 14, 2024

abdulrahuman5196 commented May 14, 2024

abdulrahuman5196 commented May 14, 2024

abdulrahuman5196 commented May 14, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

bernhardoj commented May 1, 2024 •

edited

Loading

abdulrahuman5196 commented May 14, 2024 •

edited

Loading