Fix: Read API is not triggered consistently when switching between features of a Collect workspace by tienifr · Pull Request #38613 · Expensify/App

tienifr · 2024-03-19T17:20:42Z

Details

Read API is not triggered consistently when switching features of Collect workspace. This PR fixes that.

Fixed Issues

$ #38378
PROPOSAL: #38378 (comment)

Tests

Open a collect workspace settings page
Try to switch between Taxes and More features features
Verify that everytime we switch to a feature, the corresponding Open API is called (OpenPolicyTaxesPage and OpenPolicyMoreFeaturesPage respectively in this case)
Verify the above with other pairs of features

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

NA

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-03-20.at.00.28.08-compressed.mov

Android: mWeb Chrome

Screen.Recording.2024-03-20.at.00.34.16-compressed.mov

iOS: Native

Screen.Recording.2024-03-20.at.00.26.12-compressed.mov

iOS: mWeb Safari

Screen.Recording.2024-03-20.at.00.25.19-compressed.mov

MacOS: Chrome / Safari

Screen.Recording.2024-03-20.at.00.22.15-compressed.mov

MacOS: Desktop

Screen.Recording.2024-03-20.at.00.22.15-compressed.mov

…res of collect workspace

melvin-bot · 2024-03-19T17:36:23Z

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

eVoloshchak · 2024-03-21T09:34:25Z

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

24-03-19-17-19-43.mp4

Android: mWeb Chrome

Screen.Recording.2024-04-02.at.15.05.15.mov

iOS: Native

Screen.Recording.2024-04-02.at.14.54.27.mov

iOS: mWeb Safari

Screen.Recording.2024-04-02.at.15.02.17.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-02.at.14.35.40.mov

MacOS: Desktop

Screen.Recording.2024-04-02.at.14.59.05.mov

eVoloshchak · 2024-03-21T09:40:55Z

@tienifr, I'm facing a bug with app not loading, the skeleton UI is displayed indefinitely
This isn't caused by this PR, I've tested this branch yesterday and it was working as expected. Must be a conflict with the latest changes from main, could you resolve the conflicts please?

tienifr · 2024-03-21T10:06:21Z

@eVoloshchak I've merged main and retested well.

tienifr · 2024-03-21T10:18:12Z

Perf-test is failing on main 😓

eVoloshchak

Log out
Log in back again
Open a collect workspace settings page
Click on Members menu item
Notice OpenWorkspaceMembersPage request is triggered twice

Screen.Recording.2024-03-21.at.16.26.06.mov

This is reproducible only after the first login and I couldn't reproduce this on staging, looks like a bug

tienifr · 2024-03-25T08:56:27Z

@eVoloshchak

RCA

App/src/pages/workspace/WorkspaceMembersPage.tsx

Lines 128 to 130 in bbbb8e6

    
           const getWorkspaceMembers = useCallback(() => { 
        
               Policy.openWorkspaceMembersPage(route.params.policyID, Object.keys(PolicyUtils.getMemberAccountIDsForWorkspace(policyMembers, personalDetails))); 
        
           }, [route.params.policyID, policyMembers, personalDetails]);

policyMembers is initially empty after we logged in, then gets updated after getWorkspaceMembers is called. As it is a dependency of getWorkspaceMembers, getWorkspaceMembers is re-triggered by the focus effect.

App/src/pages/workspace/WorkspaceMembersPage.tsx

Lines 147 to 151 in 288bd8c

    
           useFocusEffect( 
        
               useCallback(() => { 
        
                   getWorkspaceMembers(); 
        
               }, [getWorkspaceMembers]), 
        
           );

Solution

Neither could we remove policyMembers from getWorkspaceMembers's dependency list nor getWorkspaceMembers from the focus effect dependency list, because we would always get a stale, not up-to-date policyMembers value. useFocusEffect receives a memoized callback so if we used empty dependency list, we would always get a stale getWorkspaceMembers as well.

useFocusEffect here is not a good choice so I use useEffect with manual isFocused check instead.

tienifr · 2024-03-28T04:23:37Z

@eVoloshchak Above is my suggestions. Wdyt?

eVoloshchak · 2024-03-31T21:42:26Z

useFocusEffect here is not a good choice so I use useEffect with manual isFocused check instead.

I agree with this approach, web works well, cannot test this on native platforms due to a bug not related to this PR (the workspace settings are not active on native platforms), will come back to this tomorrow

Screen.Recording.2024-03-31.at.23.40.37.mov

tienifr · 2024-04-01T01:53:34Z

the workspace settings are not active on native platforms

@eVoloshchak This was fixed on main.

eVoloshchak

LGTM!

src/pages/workspace/WorkspaceMembersPage.tsx

mountiny

Thank you!

mountiny

Thank you!

OSBotify · 2024-04-03T17:33:07Z

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

OSBotify · 2024-04-08T10:54:41Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.60-13 🚀

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

s77rt · 2025-05-19T01:30:25Z

src/pages/workspace/WorkspaceMembersPage.tsx

+    // useFocusEffect would make getWorkspaceMembers get called twice on fresh login because policyMember is a dependency of getWorkspaceMembers.
    useEffect(() => {
+        if (!isFocused) {
+            return;
+        }
        getWorkspaceMembers();
        // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, []);
+    }, [isFocused]);


This also executed after closing RHP. Coming from #61061

fix: read api is not triggered consistently when switch between featu…

288bd8c

…res of collect workspace

tienifr changed the title ~~Fix: Read API is not triggered consistently when switching features of Collect workspace~~ Fix: Read API is not triggered consistently when switching between features of a Collect workspace Mar 19, 2024

tienifr mentioned this pull request Mar 19, 2024

[HOLD for payment 2024-04-15] [$250] [Wave Collect] As we switch between the features of Collect workspace the read api commands are not triggered everytime #38378

Closed

tienifr marked this pull request as ready for review March 19, 2024 17:36

tienifr requested a review from a team as a code owner March 19, 2024 17:36

melvin-bot bot removed the request for review from a team March 19, 2024 17:36

melvin-bot bot requested a review from eVoloshchak March 19, 2024 17:36

Merge branch 'main' into fix/38378

4ff5f6c

mountiny assigned tienifr Mar 20, 2024

Merge branch 'main' into fix/38378

1a2f946

Merge branch 'main' of https://github.com/tienifr/App into fix/38378

fe434fe

eVoloshchak reviewed Mar 21, 2024

View reviewed changes

tienifr added 2 commits March 25, 2024 12:05

Merge branch 'main' into fix/38378

650026d

fix: getWorkspaceMembers twice after logging in

bbbb8e6

Merge branch 'main' into fix/38378

7248021

Merge branch 'main' of https://github.com/tienifr/App into fix/38378

eedf0fb

eVoloshchak approved these changes Apr 2, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny April 2, 2024 13:07

mountiny requested changes Apr 2, 2024

View reviewed changes

src/pages/workspace/WorkspaceMembersPage.tsx Show resolved Hide resolved

Add comment for not using useFocusEffect

ac6bb01

mountiny approved these changes Apr 3, 2024

View reviewed changes

mountiny merged commit 255f841 into Expensify:main Apr 3, 2024

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

[INCORRECT] (used to be a checklist but was incorrectly triggered) #39573

Closed

44 tasks

mountiny mentioned this pull request Apr 4, 2024

Deploy Checklist: New Expensify 2024-04-04 #39588

Closed

48 tasks

hoangzinh mentioned this pull request Jun 7, 2024

Fix: OpenWorkspaceView API call is made on pages that do not need it #42979

Merged

50 tasks

s77rt mentioned this pull request Feb 13, 2025

[$250] Distance Rates - Disabling rate toggle triggers a brief on-off action after relogging #56173

Closed

8 tasks

abzokhattab added a commit to abzokhattab/App that referenced this pull request Feb 17, 2025

Reverting Expensify#38613

47fb90b

abzokhattab mentioned this pull request Feb 17, 2025

Revert: "Fix: Read API is not triggered consistently when switching between features of a Collect workspace" #56932

Merged

48 tasks

s77rt reviewed May 19, 2025

View reviewed changes

s77rt mentioned this pull request May 19, 2025

[Due for payment 2025-05-30] [Due for payment 2025-05-22] [$250] Remove unnecessary Read api call s on the workspace features pages #61061

Closed

Conversation

tienifr commented Mar 19, 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 Mar 19, 2024

Uh oh!

eVoloshchak commented Mar 21, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

eVoloshchak commented Mar 21, 2024

Uh oh!

tienifr commented Mar 21, 2024

Uh oh!

tienifr commented Mar 21, 2024

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

tienifr commented Mar 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

RCA

Solution

Uh oh!

tienifr commented Mar 28, 2024

Uh oh!

eVoloshchak commented Mar 31, 2024

Uh oh!

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

Uh oh!

Uh oh!

eVoloshchak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 3, 2024

Uh oh!

OSBotify commented Apr 8, 2024

Uh oh!

s77rt May 19, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tienifr commented Mar 19, 2024 •

edited

Loading

eVoloshchak commented Mar 21, 2024 •

edited

Loading

tienifr commented Mar 25, 2024 •

edited

Loading

tienifr commented Apr 1, 2024 •

edited

Loading