Fix: Change offline pattern for unassigning cards #52109

koko57 · 2024-11-06T12:04:43Z

Explanation of Change

I also added removing the card from the cardList as before this change the card was still visible in the members details card section (if you assigned the card to yourself).

#51895 - for this one I also disabled the button when loading (bc user was able to click it million times when loading)

Fixed Issues

$ #51876
$ #51895
PROPOSAL:

Tests

#51876

Go to a workspace with company cards feeds enabled
Assign a card to somebody if no cards assigned
Go offline
Go to card details
Unassign card
Verify that the card is no longer on the card list
Go to workspace members
Go to member details (of the member you assigned card to)
Verify that the card is no longer in cards section

#51895

Go offline
Go to card details
Update Card button should be disabled
Go back online
Go to card details
Update Card button should be enabled
Click the button
Verify that when loading the button is also disabled

Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

no QA

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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(themeColors.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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/a056a33f-67af-4349-9adf-deb84caddc8d

MacOS: Desktop

melvin-bot · 2024-11-06T12:17:41Z

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

DylanDylann · 2024-11-06T13:19:12Z

@mountiny Could I take over this one?

koko57 · 2024-11-06T13:44:01Z

@mountiny I've accidentally pushed the changes for #51895 on this branch 🤦🏻‍♀️ 😅 Can it be done in one PR?

DylanDylann · 2024-11-06T13:50:51Z

src/libs/actions/CompanyCards.ts

+            {
+                onyxMethod: Onyx.METHOD.MERGE,
+                key: ONYXKEYS.CARD_LIST,
+                value: {
+                    [cardID]: null,
+                },
+            },


this is redundant, right?

ok, I see now 😅

DylanDylann · 2024-11-06T13:50:56Z

src/libs/actions/CompanyCards.ts

+        successData: [
+            {
+                onyxMethod: Onyx.METHOD.MERGE,
+                key: `${ONYXKEYS.COLLECTION.WORKSPACE_CARDS_LIST}${workspaceAccountID}_${bankName}`,
+                value: {
+                    [cardID]: null,
+                },
+            },


this is redundant, right?

whyyyy? 🤔

@koko57 We already removed the card on optimistic data

parasharrajat · 2024-11-06T13:57:31Z

Is there a reason for removing me from review?

koko57 · 2024-11-06T14:03:43Z

@DylanDylann test steps updated, removed the unnecessary code

DylanDylann · 2024-11-06T14:10:02Z

@parasharrajat This PR belongs to the Workspace Feed Project and I am taking over this project. Sorry for the confusion

koko57 · 2024-11-06T16:32:46Z

@DylanDylann done

DylanDylann · 2024-11-06T17:08:58Z

@koko57 In offline pattern B, we need to grey out the deleted card when users remove it offline and only hide it when receiving response from BE

DylanDylann · 2024-11-06T17:09:25Z

We need to add pendingAction or pendingField in optimisticData

koko57 · 2024-11-07T01:51:33Z

We need to add pendingAction or pendingField in optimisticData

@mountiny should we also do this for the Expensify Card? For now we have the same pattern there

koko57 · 2024-11-07T04:06:34Z

#51841 - this PR removes the card optimistically with no card greyed out state - the cards should be removed instantly. Same in the docs:

DylanDylann · 2024-11-07T04:20:14Z

@koko57 In this issue, the expected is "Use Pattern B as per document sheet". You mean that we need to use another offline pattern

DylanDylann · 2024-11-07T04:22:26Z

While implementing this PR, there are no requirements for us to use offline pattern B. So I only fixed the original bug and didn't notice which offline pattern we should use

koko57 · 2024-11-07T04:23:43Z

@DylanDylann so I think it should be discussed then. Nevertheless these changes fix the problem I mentioned in the description:

I also added removing the card from the cardList as before this change the card was still visible in the members details card section (if you assigned the card to yourself).

and there was no error handling and restoring the card if the API call failed.

DylanDylann · 2024-11-07T04:25:46Z

If we use offline pattern B, we also handle failed cases on API

DylanDylann · 2024-11-07T04:27:05Z

We need to confirm that should we apply offline pattern B to both deactivating Expensify Card action and unassigning Company Card action?

cc @joekaufmanexpensify @mountiny

koko57 · 2024-11-07T05:18:09Z

and other card dectivating actions - like the one reporting fraud in the wallet.

mountiny · 2024-11-07T09:43:47Z

We should apply pattern B to all of those, if there will be issues with error handling we can do pattern C and wait for the action to succeed same as creating a card

koko57 · 2024-11-07T09:54:34Z

Could we possibly merge this one to have at least #51895 fixed? And I could do the change for all the cards actions in a separate PR? WDYT @mountiny @DylanDylann?

DylanDylann · 2024-11-07T09:56:32Z

I am fine. But give me 30 mins to make the checklist

mountiny · 2024-11-07T11:25:45Z

Thanks

DylanDylann · 2024-11-07T12:51:15Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-11-07.at.19.55.04.mov

MacOS: Chrome / Safari

Screen.Recording.2024-11-07.at.19.53.53.mov

MacOS: Desktop

Screen.Recording.2024-11-07.at.19.54.33.mov

DylanDylann · 2024-11-07T13:33:34Z

~~I haven't uploaded video for IOS because of some problem on my local. I hope it doesn't block this PR~~

All done

mountiny

Thanks!

OSBotify · 2024-11-07T14:19:59Z

✋ 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 · 2024-11-11T18:40:26Z

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

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

joekaufmanexpensify · 2024-11-11T22:52:44Z

#51876
Go to a workspace with company cards feeds enabled
Assign a card to somebody if no cards assigned
Go offline
Go to card details
Unassign card
Verify that the card is no longer on the card list
Go to workspace members
Go to member details (of the member you assigned card to)
Verify that the card is no longer in cards section

Verified this is working as expected. We still seem to be using pattern A for this, as the card is being optimistically removed while offline with no feedback. However I think that is expected and we are addressing in a follow up PR, so checking this off. LMK if not correct. cc @mountiny @koko57

joekaufmanexpensify · 2024-11-11T22:53:38Z

#51895
Go offline
Go to card details
Update Card button should be disabled
Go back online
Go to card details
Update Card button should be enabled
Click the button
Verify that when loading the button is also disabled

Confirmed both cases are working as expected!

koko57 · 2024-11-12T03:18:24Z

@joekaufmanexpensify yes, I will be working on the follow-up today!

mountiny · 2024-11-12T12:24:53Z

Thanks for testing

joekaufmanexpensify · 2024-11-12T13:10:41Z

Course, and sounds good!

github-actions · 2024-11-13T00:43:55Z

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

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

koko57 added 2 commits November 6, 2024 18:56

fix: change offline pattern for unassigning cards

3056dc0

fix: update cardID param for consistency

c1999bf

koko57 marked this pull request as ready for review November 6, 2024 12:17

koko57 requested a review from a team as a code owner November 6, 2024 12:17

melvin-bot bot requested a review from parasharrajat November 6, 2024 12:17

melvin-bot bot removed the request for review from a team November 6, 2024 12:17

koko57 mentioned this pull request Nov 6, 2024

[HOLD for payment 2024-11-26] [HOLD for payment 2024-11-21] [HOLD for payment 2024-11-20] [Workspace feeds] Unassigning a card offline seems to use pattern A, when the doc says it should be pattern B. #51876

Closed

8 tasks

mountiny requested review from DylanDylann and removed request for parasharrajat November 6, 2024 13:20

mountiny assigned koko57 Nov 6, 2024

mountiny self-requested a review November 6, 2024 13:21

fix: disable Update card when offline

9e2771a

DylanDylann reviewed Nov 6, 2024

View reviewed changes

fix: minor fix

2e487d1

koko57 requested a review from DylanDylann November 6, 2024 14:03

fix: remove unnecessary code

39b17d1

DylanDylann approved these changes Nov 7, 2024

View reviewed changes

mountiny added the InternalQA This pull request required internal QA label Nov 7, 2024

mountiny changed the title ~~[No QA] Fix: Change offline pattern for unassigning cards~~ Fix: Change offline pattern for unassigning cards Nov 7, 2024

mountiny approved these changes Nov 7, 2024

View reviewed changes

Expensify deleted a comment from DylanDylann Nov 7, 2024

mountiny merged commit 7788cc1 into Expensify:main Nov 7, 2024
17 of 18 checks passed

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

[HOLD for payment 2024-11-21] Deploy Checklist: New Expensify 2024-11-11 #52320

Closed

95 tasks

melvin-bot bot mentioned this pull request Nov 13, 2024

[HOLD for payment 2024-11-20] [Workspace Feeds] Loading Circle Displays Indefinitely When Queuing Offline Card Update #51895

Closed

8 tasks

Fix: Change offline pattern for unassigning cards #52109

Fix: Change offline pattern for unassigning cards #52109

Conversation

koko57 commented Nov 6, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 6, 2024

DylanDylann commented Nov 6, 2024

koko57 commented Nov 6, 2024

DylanDylann Nov 6, 2024

Choose a reason for hiding this comment

koko57 Nov 6, 2024

Choose a reason for hiding this comment

DylanDylann Nov 6, 2024

Choose a reason for hiding this comment

koko57 Nov 6, 2024

Choose a reason for hiding this comment

DylanDylann Nov 6, 2024

Choose a reason for hiding this comment

parasharrajat commented Nov 6, 2024

koko57 commented Nov 6, 2024

DylanDylann commented Nov 6, 2024

koko57 commented Nov 6, 2024

DylanDylann commented Nov 6, 2024

DylanDylann commented Nov 6, 2024

koko57 commented Nov 7, 2024

koko57 commented Nov 7, 2024

DylanDylann commented Nov 7, 2024

DylanDylann commented Nov 7, 2024

koko57 commented Nov 7, 2024

DylanDylann commented Nov 7, 2024

DylanDylann commented Nov 7, 2024 • edited Loading

koko57 commented Nov 7, 2024 • edited Loading

mountiny commented Nov 7, 2024

koko57 commented Nov 7, 2024

DylanDylann commented Nov 7, 2024

mountiny commented Nov 7, 2024

DylanDylann commented Nov 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

DylanDylann commented Nov 7, 2024 • edited Loading

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Nov 7, 2024

github-actions bot commented Nov 11, 2024

joekaufmanexpensify commented Nov 11, 2024

joekaufmanexpensify commented Nov 11, 2024

koko57 commented Nov 12, 2024

mountiny commented Nov 12, 2024

joekaufmanexpensify commented Nov 12, 2024

github-actions bot commented Nov 13, 2024

koko57 commented Nov 6, 2024 •

edited

Loading

DylanDylann commented Nov 7, 2024 •

edited

Loading

koko57 commented Nov 7, 2024 •

edited

Loading

DylanDylann commented Nov 7, 2024 •

edited

Loading

DylanDylann commented Nov 7, 2024 •

edited

Loading