Report actions Onyx migration for accountIDs #21509

puneetlath · 2023-06-24T22:20:59Z

Details

This is the first stage in the email-to-accountID migrations that we are going to need to do. For now this migration:

Checks reportActions to see if any of them DO have email-based data and DONT have the accountID-based equivalent
If so, we try to add the accountID equivalent by finding the relevant accountID in personalDetails
If we aren't able to find the relevant accountID, we simply clear the reportAction from Onyx. We do this so that nothing will break due to the missing info and since the reportAction will get returned by the API again when needed.

This is built off the work that @roryabraham originally did in this PR.

Fixed Issues

#21454 (comment)

Tests

I wrote automated Jest tests for each scenario that can happen as part of the migration
I tested some of the scenarios manually. For example, you can do:

Type Onyx.set('reportActions_123', {1234: {originalMessage: {oldLogin: 'fdjsklfjdsk'}}});
You'll now see the reportActions data you added in reportActions_123

Refresh the page
The migration will run and you should see that reportActions_123 no longer has any data

Verify that no errors appear in the JS console

Offline tests

There is no difference between being online or offline, since the migration is run over the locally stored data in Onyx.

QA Steps

There is nothing for QA to test, since this doesn't change the app experience in any way. It just updates the underlying Onyx data.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-06-26T13:17:56Z

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

Beamanator

a few general comments before continuing - i think it looks good, i just need these comments answered to wrap my brain around these migrations first :D

src/libs/migrations/PersonalDetailsByAccountID.js

Beamanator

One more question @puneetlath : Should we also be removing old email data from the front-end? Or will we do that in a different step?

puneetlath · 2023-06-26T14:50:24Z

One more question @puneetlath : Should we also be removing old email data from the front-end? Or will we do that in a different step?

We'll do that in a different step once the back-end has stopped sending it. For now, we're just making sure the client doesn't break because it is missing needed data.

Once the back-end stops sending any given email-based data, we'll also update this migration to include removing any of that type of data.

Beamanator

Nice, ok this makes sense to me now and looks like it's working well!

Co-authored-by: Alex Beaman <alexbeaman@expensify.com>

Beamanator

Lookin great! Sorry don't have time to completely test this today, can get to it tomorrow if nobody else does by then 🙏

s77rt · 2023-06-26T15:55:19Z

Taking this as C+

s77rt

Looking good and tests well, just left very minor comments

s77rt · 2023-06-26T17:30:06Z

src/libs/migrations/PersonalDetailsByAccountID.js

+                    return;
+                }
+
+                const newReportAction = reportAction;


Why we are adding a new variable here? Both newReportAction and reportAction refer to the same object.

ESLint doesn't like it if I assign to a function parameter.

Hmm but under the hood we are doing exactly that right? if you console.log reportAction it will be exactly the same as newReportAction

I agree. Do you see it as a problem though? Is there a reason for me to copy the object instead?

No, the objects here are used only once. All good 👍

src/libs/migrations/PersonalDetailsByAccountID.js

s77rt · 2023-06-26T18:16: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 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2023-06-26T22:37:44Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.33-1 🚀

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

luacmartins · 2023-06-26T23:06:52Z

Maybe we should have waited to merge this migration because of SHN.

puneetlath · 2023-06-26T23:11:14Z

Hmm maybe yeah. I should've started a convo about it at least. My thinking was that we should've done this earlier already because people could have broken report actions in Onyx already.

OSBotify · 2023-06-28T14:06:19Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.33-4 🚀

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

Create migration for reportActions with accountID

fc04ddc

puneetlath self-assigned this Jun 24, 2023

Add whisperedTo and childEmails

bccd465

puneetlath force-pushed the reportActions-migration branch from 1565a7f to bccd465 Compare June 24, 2023 22:22

puneetlath added 6 commits June 24, 2023 19:52

Use lodashHas for checking if properties exist in object

2189204

Add logs when removing or skipping

04b794e

Only migrate reportActions if they have changed

c5a7b92

Start adding tests

f8dca5a

Add case for originalMessage.participants

e1bed86

Add tests for each case

6959985

puneetlath requested a review from Beamanator June 25, 2023 21:55

Add accountEmail -> accountID case

c82a43c

puneetlath marked this pull request as ready for review June 26, 2023 13:17

puneetlath requested a review from a team as a code owner June 26, 2023 13:17

melvin-bot bot requested review from AndrewGable and removed request for a team June 26, 2023 13:17

Add test for success scenario

312ec88

Beamanator reviewed Jun 26, 2023

View reviewed changes

src/libs/migrations/PersonalDetailsByAccountID.js Show resolved Hide resolved

src/libs/migrations/PersonalDetailsByAccountID.js Show resolved Hide resolved

src/libs/migrations/PersonalDetailsByAccountID.js Outdated Show resolved Hide resolved

Beamanator reviewed Jun 26, 2023

View reviewed changes

Improve reportActions explanation

0eb83f4

Beamanator previously approved these changes Jun 26, 2023

View reviewed changes

Update src/libs/migrations/PersonalDetailsByAccountID.js

d5ed78f

Co-authored-by: Alex Beaman <alexbeaman@expensify.com>

puneetlath dismissed Beamanator’s stale review via d5ed78f June 26, 2023 15:15

Explain why were using old personalDetails object

566301f

puneetlath requested a review from Beamanator June 26, 2023 15:22

Beamanator approved these changes Jun 26, 2023

View reviewed changes

puneetlath requested a review from s77rt June 26, 2023 17:01

s77rt reviewed Jun 26, 2023

View reviewed changes

s77rt approved these changes Jun 26, 2023

View reviewed changes

puneetlath merged commit 2abcd9f into main Jun 26, 2023

puneetlath deleted the reportActions-migration branch June 26, 2023 21:55

puneetlath mentioned this pull request Jun 26, 2023

[HOLD for payment 2023-12-07] [HOLD for payment 2023-10-13] [HOLD for payment 2023-07-14] Onyx migration for personalDetails changes #21454

Closed

9 tasks

OSBotify mentioned this pull request Jun 26, 2023

Deploy Checklist: New Expensify 2023-06-26 #21650

Closed

23 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Report actions Onyx migration for accountIDs #21509

Report actions Onyx migration for accountIDs #21509

puneetlath commented Jun 24, 2023 •

edited

Loading

melvin-bot bot commented Jun 26, 2023

Beamanator left a comment

Beamanator left a comment

puneetlath commented Jun 26, 2023

Beamanator left a comment

Beamanator left a comment

s77rt commented Jun 26, 2023

s77rt left a comment

s77rt Jun 26, 2023

puneetlath Jun 26, 2023

s77rt Jun 26, 2023

puneetlath Jun 26, 2023

s77rt Jun 26, 2023

puneetlath Jun 26, 2023

s77rt commented Jun 26, 2023

OSBotify commented Jun 26, 2023

luacmartins commented Jun 26, 2023

puneetlath commented Jun 26, 2023

OSBotify commented Jun 28, 2023

Report actions Onyx migration for accountIDs #21509

Report actions Onyx migration for accountIDs #21509

Conversation

puneetlath commented Jun 24, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 26, 2023

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

puneetlath commented Jun 26, 2023

Beamanator left a comment

Choose a reason for hiding this comment

Beamanator left a comment

Choose a reason for hiding this comment

s77rt commented Jun 26, 2023

s77rt left a comment

Choose a reason for hiding this comment

s77rt Jun 26, 2023

Choose a reason for hiding this comment

puneetlath Jun 26, 2023

Choose a reason for hiding this comment

s77rt Jun 26, 2023

Choose a reason for hiding this comment

puneetlath Jun 26, 2023

Choose a reason for hiding this comment

s77rt Jun 26, 2023

Choose a reason for hiding this comment

puneetlath Jun 26, 2023

Choose a reason for hiding this comment

s77rt commented Jun 26, 2023

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jun 26, 2023

luacmartins commented Jun 26, 2023

puneetlath commented Jun 26, 2023

OSBotify commented Jun 28, 2023

puneetlath commented Jun 24, 2023 •

edited

Loading