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

abzokhattab · 2025-02-17T11:17:56Z

Explanation of Change

Reverting the changes in this PR #38613

Fixed Issues

$ #56173
PROPOSAL: #56173 (comment)

Tests

Test 1:

Open a collect workspace settings page
Try to switch between Distance rates, Workflows, Categories, Tags, Taxes and More Features
Verify that everytime we switch to a feature, the corresponding Open API is called

Test 2:

Open the app and log in
Create a Workspace
Enable Distance Rates
CMD + D to open the troubleshooting modal and switch the"Simulate poor internet connection toggle" button on.
Add a new rate
Disable the rate added in step 5
Ensure that toggle stay disabled and doesnt trigger a brief on-off action

Offline tests

Same as tests

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-02-17.at.23.21.51.mov

Android: mWeb Chrome

Screen.Recording.2025-02-17.at.23.18.51.mov

iOS: Native

Screen.Recording.2025-02-17.at.23.07.15.mov

iOS: mWeb Safari

Screen.Recording.2025-02-17.at.23.08.38.mov

MacOS: Chrome / Safari

Screen.Recording.2025-02-17.at.22.36.10.mov

MacOS: Desktop

Screen.Recording.2025-02-17.at.23.28.32.mov

melvin-bot · 2025-02-17T22:36:25Z

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

s77rt · 2025-02-18T12:29:48Z

src/pages/workspace/WorkspaceMoreFeaturesPage.tsx

+    useEffect(() => {
+        fetchFeatures();
+    }, [fetchFeatures]);


Should not this have an empty dependency array? (same goes with other effects)

I kept it so that if the policyID changes, the request would be sent .. i don't have a concrete reproducing steps for this but theoretically i think it's good to have it ... what do you think?

Let's not write code for non existing flows, and remove the dependencies. We can always revisit this when needed

I removed them in this commit 3ed87c6

s77rt · 2025-02-19T13:25:40Z

src/pages/workspace/WorkspacePageWithSections.tsx

+    useEffect(() => {
+        fetchData(policyID, shouldSkipVBBACall);
+    }, [policyID, shouldSkipVBBACall]);


Do we need the dependencies here?

they were used in the reverted PR that's why i kept them https://github.com/Expensify/App/pull/38613/files#diff-be3f058d1023c441da95f052edfa6519d1581dd1c5c4cadd9ea1e7469209142f

Let's remove them for consistency. Also because policyID does not change and the passed shouldSkipVBBACall is a constant and does not change either

s77rt · 2025-02-19T14:27:10Z

@abzokhattab Can you update the test steps to include the ones in #56173

abzokhattab · 2025-02-19T14:43:31Z

Updated the tests

s77rt · 2025-02-19T14:45:41Z

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

Build issues. Not a blocker

Android: mWeb Chrome

mweb-chrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

mweb-safari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

s77rt · 2025-02-19T14:50:06Z

Verify the above with other pairs of features

Can you remove this step

CMD + D / CMD + M to open the troubleshooting modal and switch the"Simulate poor internet connection toggle" button on.

Why we have two shortcuts, it ssems that only the CMD + D that works

abzokhattab · 2025-02-19T14:59:23Z

I wasnt sure what is the shortcut for windows so i copied it from another PR .. but just found CTRL+J gives you the shortcuts list.. in this case its only CMD + D yes

s77rt · 2025-02-19T15:05:30Z

Can you please remove the last step from test 1

OSBotify · 2025-02-21T05:54:23Z

✋ 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-21T23:11:08Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.1.4-0 🚀

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

mountiny · 2025-02-24T12:45:38Z

@abzokhattab QA said this PR is failing with #56173

mvtglobally · 2025-02-24T14:59:46Z

PR fails on Desktop with the original issue

Steps:
Open the app and log in
Create a Workspace
Enable Distance Rates
CMD + D to open the troubleshooting modal and switch the"Simulate poor internet connection toggle" button on.
Add a new rate
Disable the rate added in step 5 by clicking on the toggle
Navigate away from "DIstance rates" by clicking on "Workflows"
Navigate to "Distance rates" again

Screen.Recording.2025-02-21.At.22.42.53.mp4

github-actions · 2025-02-24T19:42:47Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 9.1.4-4 🚀

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

s77rt · 2025-02-25T10:29:50Z

@abzokhattab Can you please check the above concern ^

abzokhattab · 2025-02-26T14:58:31Z

This happens because switching features too quickly and toggling the distance rates can trigger a distance rate update before the previous fetch is complete. I'm not sure if this would actually occur in real-world scenarios.

I'm not sure how to solve this if we want to...

s77rt · 2025-02-26T15:30:22Z

@abzokhattab Can you elaborate the requests that are fired in order and why the bug occurs? There is potentially an incorrect onyx data that we set optimistically

abzokhattab · 2025-02-26T15:57:55Z

I think its same root cause as here the write request is fired before the read request is finished .. when the read request data are returned it contains a stalled data before the write, thats why it blinks

Screen.Recording.2025-02-26.at.16.55.11.mov

s77rt · 2025-02-26T19:38:09Z

I see, we still need to figure this one out. This bug should be reproducible everywhere, do you know other cases? Let's discuss back on the issue

Reverting Expensify#38613

47fb90b

abzokhattab changed the title ~~Reverting https://github.com/Expensify/App/pull/38613~~ Fix: Distance Rates - Disabling rate toggle triggers a brief on-off action after relogging Feb 17, 2025

abzokhattab changed the title ~~Fix: Distance Rates - Disabling rate toggle triggers a brief on-off action after relogging~~ Reverting https://github.com/Expensify/App/pull/38613 Feb 17, 2025

abzokhattab marked this pull request as ready for review February 17, 2025 22:36

abzokhattab requested a review from a team as a code owner February 17, 2025 22:36

melvin-bot bot requested review from s77rt and removed request for a team February 17, 2025 22:36

abzokhattab mentioned this pull request Feb 17, 2025

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

Open

8 tasks

abzokhattab added 3 commits February 17, 2025 23:37

Importing react

6be15eb

Merge remote-tracking branch 'origin/main' into git-revert-38613

d3a693f

Fixing eslint

3cc64f9

s77rt suggested changes Feb 18, 2025

View reviewed changes

abzokhattab added 2 commits February 19, 2025 14:15

removing the fetch request function from the useEffect dependencies

3ed87c6

Merge remote-tracking branch 'origin/main' into git-revert-38613

66ea262

abzokhattab requested a review from s77rt February 19, 2025 13:19

s77rt reviewed Feb 19, 2025

View reviewed changes

abzokhattab changed the title ~~Reverting https://github.com/Expensify/App/pull/38613~~ Revert: "Fix: Read API is not triggered consistently when switching between features of a Collect workspace" Feb 19, 2025

abzokhattab added 2 commits February 19, 2025 14:40

Removing policyID, shouldSkipVBBACall from the useEffect

cb402cc

minor edit

eca1e38

s77rt approved these changes Feb 19, 2025

View reviewed changes

melvin-bot bot requested a review from roryabraham February 19, 2025 15:32

roryabraham approved these changes Feb 21, 2025

View reviewed changes

roryabraham merged commit b79a430 into Expensify:main Feb 21, 2025
20 checks passed

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

Deploy Checklist: New Expensify 2025-02-21 #57263

Closed

29 tasks

IuliiaHerets mentioned this pull request Feb 22, 2025

[$250] Web - Login - "isReportTopmostSplitNavigator" console error when navigating to the login #57285

Open

8 tasks

mkzie2 mentioned this pull request Mar 4, 2025

Bank - Payment account and payer fields do not appear after adding bank account #57742

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

abzokhattab commented Feb 17, 2025 •

edited

Loading

melvin-bot bot commented Feb 17, 2025

s77rt Feb 18, 2025

abzokhattab Feb 18, 2025

s77rt Feb 18, 2025

abzokhattab Feb 19, 2025 •

edited

Loading

s77rt Feb 19, 2025

abzokhattab Feb 19, 2025

s77rt Feb 19, 2025

abzokhattab Feb 19, 2025

s77rt commented Feb 19, 2025

abzokhattab commented Feb 19, 2025

s77rt commented Feb 19, 2025 •

edited

Loading

s77rt commented Feb 19, 2025 •

edited

Loading

abzokhattab commented Feb 19, 2025

s77rt commented Feb 19, 2025

OSBotify commented Feb 21, 2025

github-actions bot commented Feb 21, 2025

mountiny commented Feb 24, 2025

mvtglobally commented Feb 24, 2025

github-actions bot commented Feb 24, 2025

s77rt commented Feb 25, 2025

abzokhattab commented Feb 26, 2025 •

edited

Loading

s77rt commented Feb 26, 2025

abzokhattab commented Feb 26, 2025

s77rt commented Feb 26, 2025

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

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

Conversation

abzokhattab commented Feb 17, 2025 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 17, 2025

s77rt Feb 18, 2025

Choose a reason for hiding this comment

abzokhattab Feb 18, 2025

Choose a reason for hiding this comment

s77rt Feb 18, 2025

Choose a reason for hiding this comment

abzokhattab Feb 19, 2025 • edited Loading

Choose a reason for hiding this comment

s77rt Feb 19, 2025

Choose a reason for hiding this comment

abzokhattab Feb 19, 2025

Choose a reason for hiding this comment

s77rt Feb 19, 2025

Choose a reason for hiding this comment

abzokhattab Feb 19, 2025

Choose a reason for hiding this comment

s77rt commented Feb 19, 2025

abzokhattab commented Feb 19, 2025

s77rt commented Feb 19, 2025 • edited Loading

Reviewer Checklist

Screenshots/Videos

s77rt commented Feb 19, 2025 • edited Loading

abzokhattab commented Feb 19, 2025

s77rt commented Feb 19, 2025

OSBotify commented Feb 21, 2025

github-actions bot commented Feb 21, 2025

mountiny commented Feb 24, 2025

mvtglobally commented Feb 24, 2025

github-actions bot commented Feb 24, 2025

s77rt commented Feb 25, 2025

abzokhattab commented Feb 26, 2025 • edited Loading

s77rt commented Feb 26, 2025

abzokhattab commented Feb 26, 2025

s77rt commented Feb 26, 2025

abzokhattab commented Feb 17, 2025 •

edited

Loading

abzokhattab Feb 19, 2025 •

edited

Loading

s77rt commented Feb 19, 2025 •

edited

Loading

s77rt commented Feb 19, 2025 •

edited

Loading

abzokhattab commented Feb 26, 2025 •

edited

Loading