fix workspace avatar issue on deletion #32986

FitseTLT · 2023-12-13T16:19:17Z

Details

Fixed Issues

$ #32195
PROPOSAL: #32195 (comment)

Tests

Open the app
Disable internet connection
Create a workspace
Upload an avatar for workspace
Tap the header > workspace header
Delete the workspace
Verify that the avatar for the workspace deleted in (6) is the default one (not the avatar you set in (4))

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

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 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.
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.

Screenshots/Videos

Android: Native

wsp.android.native.mp4

Android: mWeb Chrome

wsp.android.mweb.mp4

iOS: Native

wsp.ios.native.mp4

iOS: mWeb Safari

wsp.ios.mweb.mp4

MacOS: Chrome / Safari

wsp.web.mp4

MacOS: Desktop

wsp.desktop.mp4

melvin-bot · 2023-12-13T16:19:23Z

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

FitseTLT · 2023-12-18T12:13:54Z

@getusha bump for a review

getusha · 2023-12-18T13:43:48Z

@FitseTLT the PR is a bit different from your proposal, could you please explain?

FitseTLT · 2023-12-18T13:52:43Z

If U meant about the removing of the failureData. If we use falilureData to revert the avatar change then when we delete the same workspace loging in from two devices and both offline: after we make the second device online the first device has already deleted the workspace on the server so the deletion will fail and the avatar will revert back to the previous one (unintended) until the avatar data syncs from BE ( in my case I only saw it happen after reloading on web).
So b/c of that I omitted the failure data as in the case of workspace avatar deletion here and also other places in the App

App/src/libs/actions/Policy.js

Lines 683 to 695 in 70813db

    
           const failureData = [ 
        
               { 
        
                   onyxMethod: Onyx.METHOD.MERGE, 
        
                   key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`, 
        
                   value: { 
        
                       pendingFields: { 
        
                           avatar: null, 
        
                       }, 
        
                       errorFields: { 
        
                           avatar: ErrorUtils.getMicroSecondOnyxError('avatarWithImagePicker.deleteWorkspaceError'), 
        
                       }, 
        
                   }, 
        
               },

getusha · 2023-12-20T16:21:47Z

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-01-23.at.4.25.18.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-01-23.at.3.45.35.PM.mov

iOS: Native

Screen.Recording.2024-01-23.at.4.15.09.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-01-23.at.4.09.47.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-23.at.3.54.33.PM.mov

MacOS: Desktop

Screen.Recording.2024-01-23.at.4.27.14.PM.mov

getusha · 2023-12-21T09:25:57Z

@FitseTLT when we enable the connection the avatar is being reverted back to the uploaded avatar.

FitseTLT · 2023-12-21T10:15:21Z

@getusha but from the snapshot it is clear that the workspace is not deleted, maybe the deletion must have failed. so it is the correct behaviour.

getusha · 2023-12-25T12:21:59Z

@FitseTLT still the avatar is present after the workspace is deleted, check this.

Screen.Recording.2023-12-25.at.3.20.02.PM.mov

FitseTLT · 2023-12-25T21:08:57Z

@getusha I did the same thing in the video but couldn't reproduce. Anyway, it is a backend issue and cannot be related to the change we are making on this pr as the avatar is changing when online (related to the data returned from server).

2023-12-26.00-02-51.mp4

getusha · 2023-12-26T14:05:29Z

Anyway, it is a backend issue and cannot be related to the change we are making on this pr as the avatar is changing when online (related to the data returned from server).

Isn't the issue we're trying to address? I don't see the value in removing the avatar only when the user is offline, just to have it reverted back once they're online. I feel like we can handle it here, otherwise @madmax330 could check if this is a backend issue.

You just have to wait a bit longer to reproduce.

Screen.Recording.2023-12-26.at.4.57.14.PM.mov

FitseTLT · 2023-12-26T14:48:28Z

Isn't the issue we're trying to address? I don't see the value in removing the avatar only when the user is offline, just to have it reverted back once they're online.

Nope. Almost in all cases we try to align what will happen on the server to the optimistic data for creating better offline UX. But although the server resets the workspace avatar on workspace deletion that effect was not included in our optimistic data, so in this issue we are trying to align that BE operation in FE offline. However, on the new issue you discovered, while the workspace is created and deleted offline, the server is reverting it back (because it is what is happening when we go online). So it is not sth we can handle here, so I agree with u on asking thoughts of @madmax330 here 👍

madmax330 · 2024-01-23T10:19:17Z

@getushasicne this fixes the original issue, let's just merge this and we can make a separate issue for the other problem.
Please complete the review

getusha · 2024-01-23T13:50:18Z

Looks like there is conflict @FitseTLT

FitseTLT · 2024-01-23T14:34:08Z

@madmax330 Good to go! The performance tests are failing on other prs too; can't be related with this pr.

getusha · 2024-01-23T17:14:15Z

looks like unrelated. @FitseTLT can we merge main again to re-trigger the github action?

FitseTLT · 2024-01-24T13:33:28Z

@madmax330 merged main and performance tests pass. U 're Good to go!

madmax330 · 2024-01-24T15:53:34Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

getusha · 2024-01-24T16:11:00Z

@madmax330 already completed the checklist, #32986

just updated it looks like it was outdated.

OSBotify · 2024-01-24T16:49:47Z

✋ 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-01-25T09:06:31Z

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.4.32-0 🚀

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

rlinoz · 2024-01-25T21:36:51Z

Issue from this PR: #35177

OSBotify · 2024-01-29T19:06:13Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.32-5 🚀

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

reset workspace avatar in optimistic data

3ecd7f9

FitseTLT requested a review from a team as a code owner December 13, 2023 16:19

melvin-bot bot requested review from getusha and removed request for a team December 13, 2023 16:19

getusha mentioned this pull request Jan 6, 2024

[HOLD for payment 2024-02-05] [$500] Workspace avatar not reverted to default when deleting workspace offline #32195

Closed

6 tasks

getusha approved these changes Jan 23, 2024

View reviewed changes

melvin-bot bot requested a review from madmax330 January 23, 2024 13:48

Merge branch 'main' into fix-workspace-avatar-issue-on-deletion

58abf36

Merge branch 'main' into fix-workspace-avatar-issue-on-deletion

5705b4c

madmax330 approved these changes Jan 24, 2024

View reviewed changes

getusha approved these changes Jan 24, 2024

View reviewed changes

melvin-bot bot requested a review from madmax330 January 24, 2024 16:11

madmax330 merged commit 6182855 into Expensify:main Jan 24, 2024
15 of 16 checks passed

github-actions bot mentioned this pull request Jan 25, 2024

Deploy Checklist: New Expensify 2024-01-25 #35138

Closed

48 tasks

kbecciv mentioned this pull request Jan 25, 2024

Workspace - Custom avatar uploaded offline is inconsistent after deleting workspace #35177

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix workspace avatar issue on deletion #32986

fix workspace avatar issue on deletion #32986

FitseTLT commented Dec 13, 2023 •

edited

Loading

melvin-bot bot commented Dec 13, 2023

FitseTLT commented Dec 18, 2023 •

edited

Loading

getusha commented Dec 18, 2023

FitseTLT commented Dec 18, 2023

getusha commented Dec 20, 2023 •

edited

Loading

getusha commented Dec 21, 2023

FitseTLT commented Dec 21, 2023

getusha commented Dec 25, 2023

FitseTLT commented Dec 25, 2023

getusha commented Dec 26, 2023

FitseTLT commented Dec 26, 2023 •

edited

Loading

madmax330 commented Jan 23, 2024

getusha commented Jan 23, 2024

FitseTLT commented Jan 23, 2024

getusha commented Jan 23, 2024

FitseTLT commented Jan 24, 2024

madmax330 commented Jan 24, 2024 •

edited

Loading

getusha commented Jan 24, 2024

OSBotify commented Jan 24, 2024

OSBotify commented Jan 25, 2024

rlinoz commented Jan 25, 2024

OSBotify commented Jan 29, 2024

fix workspace avatar issue on deletion #32986

fix workspace avatar issue on deletion #32986

Conversation

FitseTLT commented Dec 13, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 13, 2023

FitseTLT commented Dec 18, 2023 • edited Loading

getusha commented Dec 18, 2023

FitseTLT commented Dec 18, 2023

getusha commented Dec 20, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

getusha commented Dec 21, 2023

FitseTLT commented Dec 21, 2023

getusha commented Dec 25, 2023

FitseTLT commented Dec 25, 2023

getusha commented Dec 26, 2023

FitseTLT commented Dec 26, 2023 • edited Loading

madmax330 commented Jan 23, 2024

getusha commented Jan 23, 2024

FitseTLT commented Jan 23, 2024

getusha commented Jan 23, 2024

FitseTLT commented Jan 24, 2024

madmax330 commented Jan 24, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

getusha commented Jan 24, 2024

OSBotify commented Jan 24, 2024

OSBotify commented Jan 25, 2024

rlinoz commented Jan 25, 2024

OSBotify commented Jan 29, 2024

FitseTLT commented Dec 13, 2023 •

edited

Loading

FitseTLT commented Dec 18, 2023 •

edited

Loading

getusha commented Dec 20, 2023 •

edited

Loading

FitseTLT commented Dec 26, 2023 •

edited

Loading

madmax330 commented Jan 24, 2024 •

edited

Loading