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

truph01 · 2024-06-03T09:44:25Z

Details

This PR will make sure: the default should be that we do not call the API OpenWorkspaceView and specify the param only if we need it in WorkspacePageWithSections

Fixed Issues

$ #42900
PROPOSAL: #42900 (comment)

Tests

Sign in to any Expensify account.
Create a new collect workspace if itsn't
Go to Setting -> Workspaces, open that workspace.
Open the network inspector tool (can use Chrome dev tool)
Go to Workspace profile
Verify that the OpenWorkspaceView API is called
Go to pages: Distance rates/Workflows.
Verify that there is no OpenWorkspaceView API called

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-06-08.at.20.59.06.mov

Android: mWeb Chrome

Screen.Recording.2024-06-08.at.20.56.04.mov

iOS: Native

output.mp4

iOS: mWeb Safari

Screen.Recording.2024-06-08.at.20.46.37.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-08.at.12.59.41.mov

MacOS: Desktop

Screen.Recording.2024-06-08.at.20.34.07.mov

mountiny · 2024-06-05T00:06:10Z

@truph01 please get this PR ready for a review as soon as you can. Do not post new proposals on issues until this is merged. Thanks for understanding

truph01 · 2024-06-05T00:18:12Z

@mountiny

I need to confirm that, should we call OpenWorkspaceView if the reimbursementAccount is available?
Also, in WorkspaceProfilePage, we need to use hasVBBA prop:

App/src/pages/workspace/WorkspaceProfilePage.tsx

Line 129 in 9b179ce

{(hasVBA?: boolean) => (

so I don't think "This is being called on pages where the bank account details are not needed" like mentioned in the "Actual result" section in the bug description. But as I mentioned above, we do not need to call OpenWorkspaceView if we already have reimbursementAccount data.

truph01 · 2024-06-05T00:29:07Z

I just updated comment

melvin-bot · 2024-06-05T02:46:15Z

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

truph01 · 2024-06-05T03:04:08Z

@hoangzinh Based on my comment, this PR is to make sure "the default should be that we do not call the API command and specify the param only if we need it"

mountiny · 2024-06-05T10:10:45Z

@truph01 can you make sure we do not call the API request when the reimbursementAccount is present?

truph01 · 2024-06-05T10:41:38Z

@mountiny I think we can do it by updating:

App/src/pages/workspace/WorkspacePageWithSections.tsx

Line 140 in a67be2f

fetchData(policyID, shouldSkipVBBACall);

to:

            if (reimbursementAccount) {
                return;
            }
            fetchData(policyID, shouldSkipVBBACall);

What do you think?

hoangzinh · 2024-06-05T10:52:12Z

We can do it, but do we ensure this data reimbursementAccount is up-to-date?

hoangzinh · 2024-06-05T11:03:36Z

I tried to follow this step to setup VBBA to check if FE can receive a Pusher event regarding reimbursementAccount update but I still need to wait to verify info

Before your bank account XXXXXXXXXXXX1111 can be activated, we need to have a deeper look at your account.
You will get a notification once the validation is complete. This normally takes 2 business days.

truph01 · 2024-06-05T11:19:21Z

@hoangzinh Ah, that makes sense. So I think I need to consider my plan "do not call the API request when the reimbursementAccount is present", it can lead to the reimbursementAccount is outdated

truph01 · 2024-06-05T15:33:39Z

@mountiny Can you confirm "if FE can receive a Pusher event regarding reimbursementAccount update" like @hoangzinh mentioned in this ? Then we can consider whether we should "do not call the API request when the reimbursementAccount is present" or not. Thanks

hoangzinh · 2024-06-05T16:26:53Z

@mountiny Can you confirm "if FE can receive a Pusher event regarding reimbursementAccount update" like @hoangzinh mentioned in this ? Then we can consider whether we should "do not call the API request when the reimbursementAccount is present" or not. Thanks

From testing, it seems we don't have that Pusher event. Moreover, the reimbursementAccountdata is not included in either OpenApp or ReconnectApp API (that means if a device is offline, then go online, the reimbursementAccountdata is not updated. I think it's reason why we have to manually fetch data here

App/src/pages/workspace/WorkspacePageWithSections.tsx

Line 120 in 8dbec8d

useNetwork({onReconnect: () => fetchData(policyID, shouldSkipVBBACall)});

truph01 · 2024-06-05T20:46:29Z

@hoangzinh Based on it, you can review this PR now

truph01 · 2024-06-06T09:19:12Z

@hoangzinh Can you help review it because it is HIGH priority task, thanks

hoangzinh · 2024-06-06T10:49:31Z

I need to confirm that, should we call OpenWorkspaceView if the reimbursementAccount is available?

Also, in WorkspaceProfilePage, we need to use hasVBBA prop:

App/src/pages/workspace/WorkspaceProfilePage.tsx

Line 129 in 9b179ce

{(hasVBA?: boolean) => (

Sorry for late. @truph01 Based on what you found here, I think it's valid to call OpenWorkspaceView API in WorkspaceProfilePage, otherwise the hasVBBA prop would contain out-dated data. What do you think?

truph01 · 2024-06-06T10:51:53Z

@hoangzinh Yes. So that is why I said that:

this PR is just to make sure "the default should be that we do not call the API command and specify the param only if we need it"

hoangzinh · 2024-06-06T10:55:00Z

right, let's wait if @mountiny agrees on it.

mountiny · 2024-06-06T14:52:46Z

Ok, lets continue with this, but we will need to reconsider a backend solution for this

mountiny · 2024-06-06T14:53:06Z

@hoangzinh the current changes in the PR are enough

hoangzinh · 2024-06-06T15:59:43Z

@truph01 can you add test steps in the PR description?

hoangzinh · 2024-06-06T16:00:02Z

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

Screen.Recording.2024-06-08.at.11.12.17.android.mov

Android: mWeb Chrome

Screen.Recording.2024-06-08.at.11.23.47.android.chrome.mov

iOS: Native

Screen.Recording.2024-06-08.at.11.24.45.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-06-08.at.11.26.14.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-08.at.10.55.08.web.mov

MacOS: Desktop

Screen.Recording.2024-06-08.at.11.00.38.desktop.mov

truph01 · 2024-06-06T16:18:10Z

@hoangzinh Since this PR is solely a migration and doesn't address any bugs, I'm currently quite confused about the appropriate test steps for this scenario. I added the test steps in the PR's author, if you have any feedback, let me know. Thanks

hoangzinh · 2024-06-07T12:13:08Z

@truph01 I think none neither of them. If it's possible, is there any way that (I know it's quite of hard)

If a user is on the profile page, then a user clicks on the menu item to update workspace profile, we should not call OpenWorkspaceView API (because the user is still on profile page) => It would save us a lot of OpenWorkspaceView API call when user update workspace profile.
Otherwise, keep it as it is.

truph01 · 2024-06-07T13:37:00Z

@hoangzinh There are many similar pages, such as settings/workspaces/:policyID/bills, settings/workspaces/:policyID/card, settings/workspaces/:policyID/invoices, settings/workspaces/:policyID/travel, etc. In each page, we can have the same behavior as workspace profile page (navigate to other page then go back). So we should ensure consistent handling across all these pages, not just the workspace profile page.

hoangzinh · 2024-06-07T14:36:53Z

Yes, if it's possible @truph01. Do you have any viable solution for it?

truph01 · 2024-06-07T14:43:53Z

@hoangzinh It is Option 1 in above, right?

hoangzinh · 2024-06-07T14:45:43Z

This option @truph01 #42979 (comment)

truph01 · 2024-06-07T14:52:57Z

I mean your suggestion here #42979 (comment) is the same as my option 1 #42979 (comment), do you think that is correct?

hoangzinh · 2024-06-07T15:25:16Z

It's almost the same @truph01, there are a few other ways to visit Workspace profile page, for example direct link, deep-link, from list WS -> profile.

truph01 · 2024-06-07T15:37:07Z

@hoangzinh Ok, got it.
I think now we need confirmation from @mountiny about my question before implementing the detail so there's no wasted effort.

mountiny · 2024-06-07T21:04:50Z

@truph01 @hoangzinh this is tricky, I think we should not call it again when the RHP modal is closed, but I can see we do that on other pages too and I think it would be out of scope for this PR, so lets do nothing now

truph01 · 2024-06-08T01:05:11Z

@hoangzinh Based on it, I remove the change which fixed your concern #42979 (comment). You can review PR now

hoangzinh · 2024-06-08T03:48:11Z

sure @truph01. I will try to complete review checklist today. Meanwhile, can you add recordings on all platforms as requirements in PR checklist? Thanks

truph01 · 2024-06-08T04:05:42Z

@hoangzinh Sure, will do it today

hoangzinh · 2024-06-08T04:21:15Z

@truph01 because all of those routes are only accessible in free Workspace.
WorkspaceBillsPage (settings/workspaces/:policyID/bills),
WorkspaceCardPage (settings/workspaces/:policyID/card),
WorkspaceInvoicesPage (settings/workspaces/:policyID/invoices),
WorkspaceTravelsPage (settings/workspaces/:policyID/travel)

It looks like we can't create a new Free workspace atm. Therefore it's hard to test with current steps. I think the viable steps should be

Sign in to any Expensify account.
Create a new collect workspace if itsn't
Go to Setting -> Workspaces, open that workspace.
Open the network inspector tool (can use Chrome dev tool)
Go to Workspace profile
Verify that the OpenWorkspaceView API is called
Go to pages: Distance rates/Workflows.
Verify that there is no OpenWorkspaceView API called

What do you think?

truph01 · 2024-06-08T05:01:00Z

@hoangzinh I agree. I just updated the test steps

truph01 · 2024-06-08T06:03:52Z

@hoangzinh I added recording in chrome

hoangzinh · 2024-06-08T13:29:25Z

I included screenshots or videos for tests on all platforms

cool thanks @truph01, as a PR checklist, let me know when you complete all platforms.

truph01 · 2024-06-08T14:03:31Z

@hoangzinh I completed checklist

truph01 · 2024-06-09T16:57:42Z

@hoangzinh Did you finish reviewing step?

hoangzinh

LGTM, congrats for the 1st PR @truph01

mountiny

Thanks for help here!

truph01 · 2024-06-10T09:05:53Z

@mountiny I merged main

OSBotify · 2024-06-10T09:31:21Z

✋ 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-06-11T22:28:32Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.82-0 🚀

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

OSBotify · 2024-06-13T15:31:08Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.82-4 🚀

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

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

cd48cd5

fix merge main

d1c1499

truph01 mentioned this pull request Jun 5, 2024

[HOLD for payment 2024-07-24] [$250] [HIGH] [API] OpenWorkspaceView API call is made on pages that do not need it #42900

Closed

6 tasks

truph01 marked this pull request as ready for review June 5, 2024 02:46

truph01 requested a review from a team as a code owner June 5, 2024 02:46

melvin-bot bot requested review from hoangzinh and removed request for a team June 5, 2024 02:46

mountiny assigned truph01 Jun 5, 2024

Fix: Remove isCalledVBBARef

6b8c4b2

hoangzinh approved these changes Jun 9, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny June 9, 2024 23:00

mountiny approved these changes Jun 10, 2024

View reviewed changes

Fix: Merge main to fix lint

3c81519

mountiny approved these changes Jun 10, 2024

View reviewed changes

mountiny merged commit 5c86b72 into Expensify:main Jun 10, 2024
15 checks passed

github-actions bot mentioned this pull request Jun 11, 2024

Deploy Checklist: New Expensify 2024-06-11 #43515

Closed

59 tasks

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

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

Conversation

truph01 commented Jun 3, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

mountiny commented Jun 5, 2024

truph01 commented Jun 5, 2024 • edited Loading

truph01 commented Jun 5, 2024

melvin-bot bot commented Jun 5, 2024

truph01 commented Jun 5, 2024 • edited Loading

mountiny commented Jun 5, 2024

truph01 commented Jun 5, 2024

hoangzinh commented Jun 5, 2024

hoangzinh commented Jun 5, 2024

truph01 commented Jun 5, 2024

truph01 commented Jun 5, 2024

hoangzinh commented Jun 5, 2024

truph01 commented Jun 5, 2024

truph01 commented Jun 6, 2024

hoangzinh commented Jun 6, 2024

truph01 commented Jun 6, 2024

hoangzinh commented Jun 6, 2024

mountiny commented Jun 6, 2024

mountiny commented Jun 6, 2024

hoangzinh commented Jun 6, 2024

hoangzinh commented Jun 6, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

truph01 commented Jun 6, 2024

hoangzinh commented Jun 7, 2024

truph01 commented Jun 7, 2024

hoangzinh commented Jun 7, 2024

truph01 commented Jun 7, 2024

hoangzinh commented Jun 7, 2024

truph01 commented Jun 7, 2024

hoangzinh commented Jun 7, 2024

truph01 commented Jun 7, 2024

mountiny commented Jun 7, 2024

truph01 commented Jun 8, 2024

hoangzinh commented Jun 8, 2024

truph01 commented Jun 8, 2024

hoangzinh commented Jun 8, 2024 • edited Loading

truph01 commented Jun 8, 2024

truph01 commented Jun 8, 2024

hoangzinh commented Jun 8, 2024 • edited Loading

truph01 commented Jun 8, 2024

truph01 commented Jun 9, 2024

hoangzinh left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

truph01 commented Jun 10, 2024

OSBotify commented Jun 10, 2024

OSBotify commented Jun 11, 2024

OSBotify commented Jun 13, 2024

truph01 commented Jun 3, 2024 •

edited

Loading

truph01 commented Jun 5, 2024 •

edited

Loading

truph01 commented Jun 5, 2024 •

edited

Loading

hoangzinh commented Jun 6, 2024 •

edited

Loading

hoangzinh commented Jun 8, 2024 •

edited

Loading

hoangzinh commented Jun 8, 2024 •

edited

Loading