Onyx migration for transactions backups

[Tony-MK]

Details

This migration moves all the transaction backups stored in the transaction collection, ONYXKEYS.COLLECTION.TRANSACTION, to a reserved collection that only stores draft transactions, ONYXKEYS.COLLECTION.TRANSACTION_DRAFT. The purpose of the migration is that there is a possibility that transaction backups are not filtered by most functions when all transactions are fetched.
One problem that arose from storing transaction backups with the other transactions is that for every distance request that has their waypoints updated offline, we expect the ReportPreview component to display the default image of a pending map. However, due to the presence of the transaction backup, the previous map image will be displayed alongside the current pending map. The problem was further discussed in this PR. #30232 (comment)

Fixed Issues

$
PROPOSAL:

Tests

1. Create distance request if you don't have one which is unpaid
2. Remember the information on the details page of the distance request
3. Edit one of the waypoints, but don't save the changes
4. Wait for the new map to appear
5. Press the back button to return to the details page
6. Confirm the information has not changed
7. Return to the page where you edited the waypoints
8. Verify that the waypoints have not been modified

• Verify that no errors appear in the JS console

Offline tests

QA Steps

1. Create distance request if you don't have one which is unpaid
2. Remember the information on the details page of the distance request
3. Edit one of the waypoints, but don't save the changes
4. Wait for the new map to appear
5. Press the back button to return to the details page
6. Confirm the information has not changed
7. Return to the page where you edited the waypoints
8. Verify that the waypoints have not been modified

• 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] (

    App/src/components/withLocalize.js

    Lines 60 to 68 in 4bd9940

    	translate: this.translate.bind(this),
    	numberFormat: this.numberFormat.bind(this),
    	datetimeToRelative: this.datetimeToRelative.bind(this),
    	datetimeToCalendarTime: this.datetimeToCalendarTime.bind(this),
    	fromLocalPhone: this.fromLocalPhone.bind(this),
    	toLocalPhone: this.toLocalPhone.bind(this),
    	fromLocaleDigit: this.fromLocaleDigit.bind(this),
    	toLocaleDigit: this.toLocaleDigit.bind(this),
    	preferredLocale: this.props.preferredLocale,

    )
  • 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.

Screenshots/Videos

Android: Native

Android.-.Native.mov

Android: mWeb Chrome

Android.-.mWeb.Chrome.mov

iOS: Native

iOS.-.Native.mov

iOS: mWeb Safari

iOS.-.mWeb.Safari.mp4

MacOS: Chrome / Safari

macOS.-.Chrome.mov

MacOS: Desktop

macOS.-.Desktop.mov

[melvin-bot]

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

[Tony-MK]

Hey @tgolen, Do you remember requesting that I create a PR for the backup transaction migration in this comment?

Here is the PR for it, but I have currently noticed that it doesn't work because of the effects of the bug you stated on Slack.

[tgolen]

Thanks for changing that around!

[Tony-MK]

Hey, @tgolen, do I need to complete the PR Author Checklist? If so, do the tests need to be related to the other PR?

[tgolen]

do I need to complete the PR Author Checklist?

Yes, please. Many of the points will not apply but they still need to be checked.

If so, do the tests need to be related to the other PR?

Here is an example of a PR that I wrote for an Onyx migration: #27203 which might give you some ideas. I think a basic test that functionality still works with the new collection would be good to have.

[Tony-MK]

@toglen Could you review the PR Author Checklist, please? Some don't apply, so I did not cross them. Also, I couldn't build an Android app, so I left it empty. Is it acceptable?

[situchan]

@Tony-MK you need to fill all items even though they are not relevant.

• I linked the correct issue in the ### Fixed Issues section above
• 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

[situchan]

ERROR: Found new JavaScript files in the /src/libs, /src/hooks, /src/styles, or /src/languages directories; use TypeScript instead.

There was recent announcement regarding this - https://expensify.slack.com/archives/C01GTK53T8Q/p1700075112873269

[Tony-MK]

@situchan Thank you. What about the console errors?

[situchan]

@situchan Thank you. What about the console errors?

what console errors?

[Tony-MK]

From the PR Author Checklist:

Verify that no errors appear in the JS console

There are some errors that appear in the Chrome Dev Tools console, but the PR didn't create them. The same errors also appear with the main branch.

[situchan]

From the PR Author Checklist:

Verify that no errors appear in the JS console

There are some errors that appear in the Chrome Dev Tools console, but the PR didn't create them. The same errors also appear with the main branch.

No worries about them as long as they aren't caused by this PR

[tgolen]

@situchan Would you like to run through the reviewer checklist on this one?

[situchan]

@situchan Would you like to run through the reviewer checklist on this one?

Sure!

[situchan]

This happens on main but is this expected or bug?

• open edit distance page
• update address A to B
• refresh
• address B briefly shows and then reverts back to A

Screen.Recording.2023-11-20.at.10.07.45.PM.mov

[situchan]

Found weird bug happening on main:

Screen.Recording.2023-11-21.at.4.41.13.AM.mov

Repro step:

• Go to edit distance page
• Refresh app
• Click back button
• Edit distance page reappears (BUG1)
• Click back button
• Now distance request changes to manual request (BUG2)
• Refresh app
• Now manual request changes back to distance request

[situchan]

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(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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

[situchan]

[melvin-bot]

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #31593.

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[Tony-MK]

Hey @tgolen and @situchan , I have a brief inquiry. This is my first contribution without an assigned issue, and I'm uncertain about the compensation for this pull request. Could you provide clarification on this matter? Thanks, and I hope you have a great day.

[tgolen]

Hm, yeah... I guess we did kind of go around the process for this one. The best thing to do would be to go back and go through the process:

1. You create an issue
2. Give it the bug label (so that it assigns someone from our BugZero team who issue the payments)
3. I'll assign the issue to you and explain what's going on and that you already fixed the issue with a PR
4. Then you and @situchan can get paid properly

[situchan]

We can use #31593

[bfitzexpensify]

Yes, I can handle via #31593 - @Tony-MK, I've just sent you an offer via Upwork, and I'll cc you in that issue so that we can track payment.

@situchan will this PR require completion of a BZ checklist or is it not needed here?

[situchan]

@situchan will this PR require completion of a BZ checklist or is it not needed here?

We can skip BZ checklist. This is not bug but dev improvement.

[OSBotify]

🚀 Deployed to staging by https://github.com/tgolen in version: 1.4.2-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.2-3 🚀

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