Remove policyMemberList as part of personalDetails migration #21694

puneetlath · 2023-06-27T15:48:18Z

Details

This PR updates the PersonalDetailsByAccountID migration to remove the old policyMemberList data from Onyx if it is found. We have updated the back-end to stop sending data to this Onyx key, so now we want to remove it from any clients that have it locally.

Fixed Issues

$ #21454

Tests

I added automated tests to ensure check that the data gets removed. To test manually, you can:

In the JS console do Onyx.set('policyMemberList_123', {blah: 1});
Check policyMemberList_123 in application storage and make sure you see what you set
Refresh the page
Make sure that policyMemberList_123 is now empty in application storage

Verify that no errors appear in the JS console

Offline tests

Same tests work online or offline.

QA Steps

There is nothing in particular to QA for this PR as there are no user-facing changes. Regular regression testing that the app is working as normal should be enough.

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
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

puneetlath · 2023-06-27T15:50:42Z

@s77rt maybe you can help me out here. I feel like I'm missing something obvious.

When I do what is in this PR and I log the output, it shows that oldPolicyMembers is empty, even though I have multiple policyMemberList_ collections in Onyx.

If I change the constant on line 13 to be policyMembers_ then it does find that collection, but for some reason when I make it policyMemberList_ it doesn't find it. Any ideas what I'm doing wrong?

s77rt · 2023-06-27T18:48:35Z

@puneetlath I think this has to do with Onyx initialisation. Onyx only works with keys that are given at setup, we supply ONYXKEYS but this list does not contain policyMemberList_. Just adding that should fix the issue.

POLICY_MEMBER_LIST: 'policyMemberList_',

puneetlath · 2023-06-27T20:26:36Z

Ahh interesting! Why does personalDetails work then? It's not in ONYXKEYS either.

puneetlath · 2023-06-27T21:12:33Z

Ok @s77rt I haven't had a chance to do the checklist and I need to head out for the day. But this is ready for review whenever you have a chance!

melvin-bot · 2023-06-27T21:12:44Z

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

s77rt · 2023-06-28T01:03:05Z

Why does personalDetails work then? It's not in ONYXKEYS either

I think this applies to collections only, personalDetails is not a collection, that key can be be found directly but when we search for policyMemberList_ we mean to check for a collection and not for the literal key policyMemberList_. Onyx differentiate between a literal key and a collection key by use of isCollectionKey function which looks into ONYXKEYS.COLLECTION if the key is there then it's a collection otherwise a literal key.

We used policyMemberList_ which is a collection key but since it was not on ONYXKEYS.COLLECTION Onyx was searching for the literal policyMemberList_ key instead which does not exist.
personalDetails is a literal key. Onyx will search for that literal key anyway.

So in short, unless you tell Onyx that a key is a collection key it will treat it as a literal key.

s77rt · 2023-06-28T01:03:17Z

I will review asap

puneetlath · 2023-06-28T15:55:09Z

Thanks for the explanation @s77rt, that makes sense!

The update to stop sending policyMemberList data from the back-end is live. So it would be great to merge this part of the migration today if we can.

s77rt

Working well, just a minor request to clear the code

s77rt · 2023-06-28T18:43:46Z

src/libs/migrations/PersonalDetailsByAccountID.js

+            if (!oldReportActions) {
+                Log.info('[Migrate Onyx] Skipped PersonalDetailsByAccountID reportActions migration because there were no reportActions');
+            } else {


NAB but can we flatten this? No need for the else condition. Or just remove the log that we are skipping the migration (we don't have a similar log for oldPolicyMemberList being empty)

(this is just to clear the diff, it's hard to read but I assume nothing changed in the below code)

Hmm, yeah that log doesn't really do much for us. I'm going to remove it.

Ok I updated it. Will be easier to review if you choose the "remove whitespace" option.

s77rt · 2023-06-28T20:07: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 / 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

s77rt

LGTM! 🚀

melvin-bot · 2023-06-28T20:09:00Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #21454... Please reach out for help on Slack if no one gets assigned!

puneetlath · 2023-06-28T20:09:37Z

Nice! @arosiclair or @Beamanator if one of y'all has a chance to approve/merge today, that would be much appreciated!

Beamanator

LGTM!

OSBotify · 2023-06-29T10:43:42Z

✋ 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-06-29T20:38:00Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.35-0 🚀

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

OSBotify · 2023-07-03T14:35:51Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

OSBotify · 2023-07-03T15:18:26Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.35-5 🚀

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

Connect to policy member list deprecated key

5a6807f

puneetlath self-assigned this Jun 27, 2023

puneetlath requested a review from s77rt June 27, 2023 15:50

puneetlath added 2 commits June 27, 2023 16:59

Fix onyx key for deprecated policy member list

a748183

Add tests for policyMemberList removal

f955e4e

puneetlath requested a review from Beamanator June 27, 2023 21:12

puneetlath marked this pull request as ready for review June 27, 2023 21:12

puneetlath requested a review from a team as a code owner June 27, 2023 21:12

melvin-bot bot requested review from arosiclair and removed request for a team June 27, 2023 21:12

puneetlath mentioned this pull request Jun 27, 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

s77rt reviewed Jun 28, 2023

View reviewed changes

Remove no report actions condition

4213c5b

s77rt approved these changes Jun 28, 2023

View reviewed changes

Beamanator approved these changes Jun 29, 2023

View reviewed changes

Beamanator merged commit 562a838 into main Jun 29, 2023

Beamanator deleted the policyMembers-migration branch June 29, 2023 10:40

OSBotify mentioned this pull request Jun 29, 2023

Deploy Checklist: New Expensify 2023-06-29 #21911

Closed

51 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove policyMemberList as part of personalDetails migration #21694

Remove policyMemberList as part of personalDetails migration #21694

puneetlath commented Jun 27, 2023 •

edited

Loading

puneetlath commented Jun 27, 2023

s77rt commented Jun 27, 2023 •

edited

Loading

puneetlath commented Jun 27, 2023

puneetlath commented Jun 27, 2023

melvin-bot bot commented Jun 27, 2023

s77rt commented Jun 28, 2023

s77rt commented Jun 28, 2023

puneetlath commented Jun 28, 2023

s77rt left a comment

s77rt Jun 28, 2023

puneetlath Jun 28, 2023

puneetlath Jun 28, 2023

s77rt Jun 28, 2023

s77rt commented Jun 28, 2023

s77rt left a comment

melvin-bot bot commented Jun 28, 2023

puneetlath commented Jun 28, 2023

Beamanator left a comment

OSBotify commented Jun 29, 2023

OSBotify commented Jun 29, 2023

OSBotify commented Jul 3, 2023

OSBotify commented Jul 3, 2023

Remove policyMemberList as part of personalDetails migration #21694

Remove policyMemberList as part of personalDetails migration #21694

Conversation

puneetlath commented Jun 27, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

puneetlath commented Jun 27, 2023

s77rt commented Jun 27, 2023 • edited Loading

puneetlath commented Jun 27, 2023

puneetlath commented Jun 27, 2023

melvin-bot bot commented Jun 27, 2023

s77rt commented Jun 28, 2023

s77rt commented Jun 28, 2023

puneetlath commented Jun 28, 2023

s77rt left a comment

Choose a reason for hiding this comment

s77rt Jun 28, 2023

Choose a reason for hiding this comment

puneetlath Jun 28, 2023

Choose a reason for hiding this comment

puneetlath Jun 28, 2023

Choose a reason for hiding this comment

s77rt Jun 28, 2023

Choose a reason for hiding this comment

s77rt commented Jun 28, 2023

Reviewer Checklist

Screenshots/Videos

s77rt left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 28, 2023

puneetlath commented Jun 28, 2023

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 29, 2023

OSBotify commented Jun 29, 2023

OSBotify commented Jul 3, 2023

OSBotify commented Jul 3, 2023

puneetlath commented Jun 27, 2023 •

edited

Loading

s77rt commented Jun 27, 2023 •

edited

Loading