Fix report action draft still present after deleting the workspace #30049

bernhardoj · 2023-10-20T04:26:29Z

Details

When we delete a workspace, all workspace-related chat is archived, and not allowed to edit any message, but every message on edit is still present allowing to user to edit it but eventually, an error is thrown from the BE.

Fixed Issues

$ #26887
PROPOSAL: #26887 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Prerequisites: have a workspace

Open workspace chat (either #admins or #announce)
Send any message
Press the pencil icon to start editing the message
Verify the message enter the edit mode
Delete the workspace
Verify the message back to a normal view (non-edit mode)

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
- 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(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.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Screen.Recording.2023-10-20.at.11.49.04.mov

Android: mWeb Chrome

Screen.Recording.2023-10-20.at.11.27.12.mov

iOS: Native

Screen.Recording.2023-10-20.at.11.33.22.mov

iOS: mWeb Safari

Screen.Recording.2023-10-20.at.11.28.20.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-20.at.11.10.25.mov

MacOS: Desktop

Screen.Recording.2023-10-20.at.11.13.00.mov

This reverts commit 2bb124b.

melvin-bot · 2023-10-20T04:26:34Z

@aimane-chnaif 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]

bernhardoj · 2023-10-20T04:27:48Z

Additional video showing the draft is deleted when the workspace is deleted from another client/device

Screen.Recording.2023-10-20.at.11.35.22.mov

aimane-chnaif · 2023-10-22T17:41:35Z

src/libs/migrations/KeyReportActionsDraftByReportActionID.js

+                    if (!_.isString(reportActionDraft)) {
+                        return;
+                    }


NAB: Is there any non-string case?

One case is when the action draft is already migrated to an object, so we skip it.

I don't know if it is possible that a user have both old and new structure of action draft, but just to be safe.

aimane-chnaif · 2023-10-22T18:04:14Z

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 / Chrome
- iOS / native
- iOS / 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(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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web-ios.mov

Migration test

Before:

before.migration.mov

After:

after.migration.mov

Mobile Web - Chrome

desktop-mchrome.mov

Mobile Web - Safari

android-msafari.mov

Desktop

desktop-mchrome.mov

iOS

web-ios.mov

Android

android-msafari.mov

aimane-chnaif

LGTM 🎉

cead22 · 2023-10-24T00:17:27Z

src/libs/migrations/KeyReportActionsDraftByReportActionID.js

+                    const reportActionID = onyxKey.split('_').pop();
+                    const newOnyxKey = onyxKey.replace(`_${reportActionID}`, '');
+                    newReportActionsDrafts[newOnyxKey] = {
+                        ...(newReportActionsDrafts[newOnyxKey] || allReportActionsDrafts[newOnyxKey]),


What does || allReportActionsDrafts[newOnyxKey] do in here? do we ever set allReportActionsDrafts[newOnyxKey]?

It's to cover a case where there is already an existing migrated draft of newOnyxKey.

the example is on the 2nd unit test

Can you add a comment to make that obvious please? I see the test, and with one of the values for reportID 2 set to {} and one to null, but is that something that can happen, like having a migration run half-way?

Added the comment.

but is that something that can happen, like having a migration run half-way?

I'm not sure actually, but I see the other existing tests and they include that kind of case.

cead22 · 2023-10-24T18:33:49Z

src/libs/migrations/KeyReportActionsDraftByReportActionID.js

+                    newReportActionsDrafts[newOnyxKey] = {
+                        ...(newReportActionsDrafts[newOnyxKey] ||
+                            // Includes the existing migrated draft
+                            allReportActionsDrafts[newOnyxKey]),
+                        [reportActionID]: reportActionDraft,
+                    };


This is now very hard to read, can we make it less fancy and more readable, maybe like this?

Suggested change

newReportActionsDrafts[newOnyxKey] = {

...(newReportActionsDrafts[newOnyxKey] ||

// Includes the existing migrated draft

allReportActionsDrafts[newOnyxKey]),

[reportActionID]: reportActionDraft,

};

// If newReportActionsDrafts[newOnyxKey] isn't set, fall back on the migrated draft if there is one

const currentActionDrafts = newReportActionsDrafts[newOnyxKey] || allReportActionsDrafts[newOnyxKey];

newReportActionsDrafts[newOnyxKey] = {

...currentActionDrafts,

[reportActionID]: reportActionDraft,

};

Thanks for the suggestion! I have updated the code.

OSBotify · 2023-10-25T17:02:58Z

✋ 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 · 2023-10-25T17:50:22Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.91-1 🚀

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

OSBotify · 2023-10-26T22:40:57Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

OSBotify · 2023-10-30T08:05:35Z

🚀 Deployed to staging by https://github.com/cead22 in version: 1.3.93-0 🚀

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

OSBotify · 2023-10-31T21:38:44Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.93-1 🚀

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

bernhardoj added 5 commits October 20, 2023 11:51

restructure report actions drafts onyx + migration

d6504ca

don't migrate empty draft

2bb124b

clear draft when workspace is deleted

229605f

Revert "don't migrate empty draft"

613e254

This reverts commit 2bb124b.

don't migrate empty draft

e9855c7

bernhardoj requested a review from a team as a code owner October 20, 2023 04:26

melvin-bot bot requested review from aimane-chnaif and removed request for a team October 20, 2023 04:26

aimane-chnaif reviewed Oct 22, 2023

View reviewed changes

aimane-chnaif approved these changes Oct 22, 2023

View reviewed changes

melvin-bot bot requested a review from cead22 October 22, 2023 18:07

cead22 reviewed Oct 24, 2023

View reviewed changes

bernhardoj added 2 commits October 25, 2023 02:10

add comment

2179169

prettier

c8286e8

cead22 requested changes Oct 24, 2023

View reviewed changes

make the code more readable

9edcd3b

cead22 approved these changes Oct 25, 2023

View reviewed changes

cead22 merged commit 9a85f80 into Expensify:main Oct 25, 2023
12 checks passed

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

melvin-bot bot mentioned this pull request Oct 26, 2023

[HOLD for payment 2023-11-02] [$500] Workspace - Archived Chat shows the edit composer for the message #26887

Closed

6 tasks

OSBotify mentioned this pull request Oct 30, 2023

Deploy Checklist: New Expensify 2023-10-30 #30560

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix report action draft still present after deleting the workspace #30049

Fix report action draft still present after deleting the workspace #30049

bernhardoj commented Oct 20, 2023

melvin-bot bot commented Oct 20, 2023

bernhardoj commented Oct 20, 2023

aimane-chnaif Oct 22, 2023

bernhardoj Oct 23, 2023 •

edited

Loading

aimane-chnaif commented Oct 22, 2023 •

edited

Loading

Migration test

aimane-chnaif left a comment

cead22 Oct 24, 2023

bernhardoj Oct 24, 2023

cead22 Oct 24, 2023

bernhardoj Oct 24, 2023

cead22 Oct 24, 2023

bernhardoj Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

OSBotify commented Oct 30, 2023

OSBotify commented Oct 31, 2023

Fix report action draft still present after deleting the workspace #30049

Fix report action draft still present after deleting the workspace #30049

Conversation

bernhardoj commented Oct 20, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 20, 2023

bernhardoj commented Oct 20, 2023

aimane-chnaif Oct 22, 2023

Choose a reason for hiding this comment

bernhardoj Oct 23, 2023 • edited Loading

Choose a reason for hiding this comment

aimane-chnaif commented Oct 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Migration test

aimane-chnaif left a comment

Choose a reason for hiding this comment

cead22 Oct 24, 2023

Choose a reason for hiding this comment

bernhardoj Oct 24, 2023

Choose a reason for hiding this comment

cead22 Oct 24, 2023

Choose a reason for hiding this comment

bernhardoj Oct 24, 2023

Choose a reason for hiding this comment

cead22 Oct 24, 2023

Choose a reason for hiding this comment

bernhardoj Oct 25, 2023

Choose a reason for hiding this comment

OSBotify commented Oct 25, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

OSBotify commented Oct 30, 2023

OSBotify commented Oct 31, 2023

bernhardoj Oct 23, 2023 •

edited

Loading

aimane-chnaif commented Oct 22, 2023 •

edited

Loading