Deprecate card.isVirtual references #39829

SzymczakJ · 2024-04-08T15:20:14Z

Details

Change name of property isVirtual to nameValuePairs.isVirtual. To keep the deprecation safe I'm also creating onyx migration for that old isVirtual key.

Fixed Issues

$ #39692
PROPOSAL:

Tests

Use an account with previously linked cards and check if every "card" feature on WalletPage works

Offline tests

QA Steps

Same as tests

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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.

Screenshots/Videos

Android: Native

android.mov

Android: mWeb Chrome

androidweb.mov

iOS: Native

ios.mov

iOS: mWeb Safari

iosweb.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

Skalakid

Some type checks are failing. Should we migrate card.isVirtual references in ActivatePhysicalCardPage.tsx, PaymentMethodList.tsx and ReportVirtualCardFraudPage.tsx to use not deprecated nameValuePairs.isVirtual?

melvin-bot · 2024-04-09T13:17:45Z

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

grgia

Off the bat, changes and migration looks pretty good! Going to use a test build to test with card data

github-actions · 2024-04-12T09:11:51Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/39829/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/39829/NewExpensify.dmg	https://39829.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

allroundexperts · 2024-04-15T06:09:19Z

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design 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-04-15.at.1.19.46.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-04-15.at.1.17.24.PM.mov

iOS: Native

Error running RN debugger on iOS

iOS: mWeb Safari

Screen.Recording.2024-04-15.at.11.59.22.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-15.at.12.03.20.PM.mov

MacOS: Desktop

Screen.Recording.2024-04-15.at.12.09.14.PM.mov

allroundexperts · 2024-04-15T06:27:16Z

src/libs/migrations/RenameCardIsVirtual.ts

+                            nameValuePairs: {
+                                isVirtual: card.isVirtual,
+                            },
+                            isVirtual: null,


Setting this to null wouldn't cause this migration to run on each start? This is because at line 22, you are making use of the following condition:

const cardsWithIsVirtualProp = Object.values(cardList).filter((card) => card.isVirtual !== undefined);

good point, fixed code accordingly!

allroundexperts

Looks good!

OSBotify · 2024-04-16T15:05:25Z

✋ 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-04-18T04:56:53Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.63-0 🚀

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

OSBotify · 2024-04-22T14:57:52Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

SzymczakJ added 3 commits April 8, 2024 15:32

change card.isVirtual references to card.nameValuePairs?.isVirtual

5887f83

add onyx migration of card.isVirtual to card.nameValuePairs.isVirtual

f209268

correct comments in new RenameCardIsVirtual

a6c8b09

SzymczakJ force-pushed the @szymczak/deprecate-card.isVirtual-references branch from 3e18e3a to a6c8b09 Compare April 8, 2024 15:25

Skalakid reviewed Apr 8, 2024

View reviewed changes

fix type errors

0106a06

Skalakid approved these changes Apr 8, 2024

View reviewed changes

SzymczakJ marked this pull request as ready for review April 9, 2024 13:17

SzymczakJ requested a review from a team as a code owner April 9, 2024 13:17

melvin-bot bot requested review from allroundexperts and removed request for a team April 9, 2024 13:17

fix types

8de7fc6

grgia self-requested a review April 12, 2024 08:28

grgia previously approved these changes Apr 12, 2024

View reviewed changes

grgia added the Ready To Build label Apr 12, 2024

allroundexperts reviewed Apr 15, 2024

View reviewed changes

fix migration logic

fc9f595

SzymczakJ dismissed grgia’s stale review via fc9f595 April 16, 2024 10:21

allroundexperts approved these changes Apr 16, 2024

View reviewed changes

melvin-bot bot requested a review from grgia April 16, 2024 11:40

grgia approved these changes Apr 16, 2024

View reviewed changes

grgia merged commit 83d1166 into Expensify:main Apr 16, 2024
16 of 18 checks passed

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

SzymczakJ deleted the @szymczak/deprecate-card.isVirtual-references branch April 8, 2025 09:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Deprecate card.isVirtual references #39829

Deprecate card.isVirtual references #39829

Uh oh!

SzymczakJ commented Apr 8, 2024 •

edited

Loading

Uh oh!

Skalakid left a comment

Uh oh!

melvin-bot bot commented Apr 9, 2024

Uh oh!

grgia left a comment

Uh oh!

github-actions bot commented Apr 12, 2024

Uh oh!

allroundexperts commented Apr 15, 2024 •

edited

Loading

Uh oh!

allroundexperts Apr 15, 2024

Uh oh!

SzymczakJ Apr 16, 2024

Uh oh!

allroundexperts left a comment

Uh oh!

Uh oh!

OSBotify commented Apr 16, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

Uh oh!

Deprecate card.isVirtual references #39829

Deprecate card.isVirtual references #39829

Uh oh!

Conversation

SzymczakJ commented Apr 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

Skalakid left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Apr 9, 2024

Uh oh!

grgia left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 12, 2024

Uh oh!

allroundexperts commented Apr 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allroundexperts Apr 15, 2024

Choose a reason for hiding this comment

Uh oh!

SzymczakJ Apr 16, 2024

Choose a reason for hiding this comment

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

OSBotify commented Apr 16, 2024

Uh oh!

OSBotify commented Apr 18, 2024

Uh oh!

OSBotify commented Apr 22, 2024

Uh oh!

Uh oh!

SzymczakJ commented Apr 8, 2024 •

edited

Loading

allroundexperts commented Apr 15, 2024 •

edited

Loading