[TS Migration] Define a concise way to access or default to an inexistent record by kubabutkiewicz · Pull Request #42634 · Expensify/App

kubabutkiewicz · 2024-05-27T12:45:37Z

Details

Fixed Issues

$ #39125

Tests

We need to do full regression testing since this PR is changing lot of files

Verify that no errors appear in the JS console

Offline tests

QA Steps

We need to do full regression testing since this PR is changing lot of files

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
- 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.mp4

Android: mWeb Chrome

iOS: Native

ios.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desktop.mp4

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

contributingGuides/STYLE.md

src/pages/workspace/reimburse/WorkspaceRateAndUnitPage/InitialPage.tsx

src/pages/workspace/workflows/WorkspaceWorkflowsPage.tsx

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

melvin-bot · 2024-05-31T08:22:32Z

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

jjcoffee · 2024-05-31T08:27:41Z

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

android-native-2024-06-04_14.55.53.mp4

Android: mWeb Chrome

android-chrome-2024-06-04_15.16.24.mp4

iOS: Native

ios-native-2024-06-04_11.45.41.mp4

iOS: mWeb Safari

ios-safari-2024-06-04_13.02.27.mp4

MacOS: Chrome / Safari

desktop-chrome-2024-06-04_11.10.19.mp4

MacOS: Desktop

desktop-app-2024-06-04_11.17.21.mp4

mountiny · 2024-05-31T08:58:01Z

@jjcoffee lets do proper testing and PR on this and once you cannot find any regressions, we will create a build and ask Applause to do a full regression testing

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

kubabutkiewicz · 2024-06-03T09:01:38Z

@jjcoffee comment resolved :D

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

kubabutkiewicz · 2024-06-04T11:53:53Z

@jjcoffee done!

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

kubabutkiewicz · 2024-06-12T15:09:58Z

@blimpich ts issue resolved and merge conflicts too

blimpich · 2024-06-12T17:22:51Z

Ad-hoc build has been triggered. Hopefully ready soon.

github-actions · 2024-06-12T17:53:58Z

🧪🧪 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/42634/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/42634/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/42634/NewExpensify.dmg	https://42634.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

blimpich · 2024-06-12T17:57:26Z

@jjcoffee new build ready for you to test. Thank you!

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

jjcoffee · 2024-06-13T10:42:02Z

@blimpich I think we're good to go! I've confirmed all issues are resolved, with the following caveats:

Attachment - Mp4 video can not be reproduced - This works fine when I run a local build so I can only assume that this is an issue with the adhoc build.
Conversation - Expensify Link addresses are opening in new tab - this works fine if using staging.new.expensify.com links (QA were copying the adhoc URL).

Resolved

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

OSBotify · 2024-06-13T16:47:36Z

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

kavimuru · 2024-06-14T17:01:03Z

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

Workspace - The default data in the Tax ID number field is "-1"

Version Number: v1.4.78-4 adhoc
Reproducible in staging?: N
Reproducible in production?: unable to check with test credentials
Logs: https://stackoverflow.com/c/expensify/questions/4856
Issue reported by: Applause-Internal team

Action Performed:

Navigate to https://42634.pr-testing.expensify.com/
Log in with a new expensifail account
Create a workspace
Enable "Workflows"
Start adding a Plaid Regions Bank account
Continue the flow until the "Enter your company’s Tax ID number." prompt

Expected Result:

The field should be empty.

Actual Result:

The default data in the Tax ID number field is "-1".

Workaround:

Unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

iOS: Native
MacOS: Chrome / Safari

Screenshots/Videos

View all open jobs on GitHub

OSBotify · 2024-06-14T23:16:24Z

🚀 Deployed to staging by https://github.com/blimpich in version: 1.4.84-0 🚀

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

OSBotify · 2024-06-17T23:48:37Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.84-3 🚀

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

suneox · 2024-07-20T08:01:41Z

src/pages/ReimbursementAccount/BusinessInfo/substeps/TaxIdBusiness.tsx

-    const defaultCompanyTaxId = reimbursementAccount?.achData?.companyTaxID ?? '';
-    const bankAccountID = reimbursementAccount?.achData?.bankAccountID ?? 0;
+    const defaultCompanyTaxId = reimbursementAccount?.achData?.companyTaxID ?? '-1';
+    const bankAccountID = reimbursementAccount?.achData?.bankAccountID ?? -1;


This change raise regression #45073 has fixed, due to companyTaxID is a string, so the fallback value must be an empty string

paultsimura · 2024-07-22T13:48:15Z

src/libs/ReportUtils.ts

    // We don't allow IOU actions if an Expensify account is a participant of the report, unless the policy that the report is on is owned by an Expensify account
    const doParticipantsIncludeExpensifyAccounts = lodashIntersection(reportParticipants, CONST.EXPENSIFY_ACCOUNT_IDS).length > 0;
-    const isPolicyOwnedByExpensifyAccounts = report?.policyID ? CONST.EXPENSIFY_ACCOUNT_IDS.includes(getPolicy(report?.policyID ?? '')?.ownerAccountID ?? 0) : false;
+    const isPolicyOwnedByExpensifyAccounts = report?.policyID ? CONST.EXPENSIFY_ACCOUNT_IDS.includes(getPolicy(report?.policyID ?? '-1')?.ownerAccountID ?? -1) : false;


This caused #44985 as a side effect. A simple change like this couldn't have prevented the bug though – it required a little deeper fix.

kubabutkiewicz added 9 commits May 27, 2024 13:43

feat: default onyx ids to -1

93a45ce

fix: continue

d4185d2

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

36895ea

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

7454a50

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

fix: tests

88db466

fix: wrong redirect

70b278e

doc: added entry about defaulting values for ids

2a17472

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

2b038ad

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

fix

05fcbff

fabioh8010 reviewed May 29, 2024

View reviewed changes

kubabutkiewicz added 2 commits May 31, 2024 10:07

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

78cb36c

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

fix: resolve comments

d13967e

kubabutkiewicz marked this pull request as ready for review May 31, 2024 08:22

kubabutkiewicz requested a review from a team as a code owner May 31, 2024 08:22

melvin-bot bot removed the request for review from a team May 31, 2024 08:22

melvin-bot bot requested a review from jjcoffee May 31, 2024 08:22

This comment was marked as resolved.

Sign in to view

mountiny assigned kubabutkiewicz May 31, 2024

mountiny added the Ready To Build label May 31, 2024

kubabutkiewicz added 2 commits June 3, 2024 09:44

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

f66184a

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

fix: resolve comments

7b0d6c2

This comment was marked as resolved.

Sign in to view

fabioh8010 approved these changes Jun 3, 2024

View reviewed changes

kubabutkiewicz added 2 commits June 4, 2024 13:07

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

b6ff4d2

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

fix: add more defaults to -1

ff2520e

kubabutkiewicz added 2 commits June 12, 2024 16:25

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

9ce2dc8

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

fix: typecheck

b75d020

kubabutkiewicz added 2 commits June 13, 2024 09:07

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

0966396

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

fix: lint

27e0cc7

blazejkustra approved these changes Jun 13, 2024

View reviewed changes

Merge branch 'main' of github.com:kubabutkiewicz/expensify-app into t…

8c5e2e3

…s-migration/Define-concise-way-to-access-or-default-to-an-inexistent-record

blimpich approved these changes Jun 13, 2024

View reviewed changes

blimpich merged commit d2af463 into Expensify:main Jun 13, 2024

github-actions bot mentioned this pull request Jun 14, 2024

Deploy Checklist: New Expensify 2024-06-14 #43793

Closed

53 tasks

bernhardoj mentioned this pull request Jun 16, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] Workspace - Workspace list reloads when returning online #43799

Closed

6 tasks

This was referenced Jun 16, 2024

[CP Staging] Check for -1 default value for delegateAccountID #43817

Merged

[CP Staging] Remove withPolicyAndFullscreenLoading from WorkspacesListPage #43818

Merged

melvin-bot bot mentioned this pull request Jun 17, 2024

[HOLD for payment 2024-06-28] [HOLD for payment 2024-06-24] [$250] [TS Migration] Define a concise way to access or default to an inexistent record #39125

Closed

bernhardoj mentioned this pull request Jun 19, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [$250] Send invoice - "To" field displays Hidden instead of invoice receiver #43917

Closed

6 tasks

dominictb mentioned this pull request Jul 3, 2024

[HOLD for Payment 2024-08-22][$250] Chat - Message marker disappears when the 2nd user deletes the first message #41935

Closed

6 tasks

bernhardoj mentioned this pull request Jul 9, 2024

[HOLD for payment 2024-07-24] [$250] Concierge - There is submit, split and pay options in Concierge chat #44985

Closed

6 tasks

Krishna2323 mentioned this pull request Jul 9, 2024

[HOLD for payment 2024-07-24] [$250] Connect bank - "-1" is pre-filled for the tax ID number when connecting a new bank account #45073

Closed

6 tasks

suneox reviewed Jul 20, 2024

View reviewed changes

paultsimura reviewed Jul 22, 2024

View reviewed changes

truph01 mentioned this pull request Aug 16, 2024

Fix: RHN lag when close #45691

Merged

50 tasks

hungvu193 mentioned this pull request Nov 15, 2024

Feat: Add a step to to Request Physical Card form that collects a magic code #51135

Merged

50 tasks

Conversation

kubabutkiewicz commented May 27, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

melvin-bot bot commented May 31, 2024

Uh oh!

jjcoffee commented May 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

This comment was marked as resolved.

mountiny commented May 31, 2024

Uh oh!

kubabutkiewicz commented Jun 3, 2024

Uh oh!

This comment was marked as resolved.

kubabutkiewicz commented Jun 4, 2024

Uh oh!

kubabutkiewicz commented Jun 12, 2024

Uh oh!

blimpich commented Jun 12, 2024

Uh oh!

github-actions bot commented Jun 12, 2024

Uh oh!

blimpich commented Jun 12, 2024

Uh oh!

jjcoffee commented Jun 13, 2024

Uh oh!

OSBotify commented Jun 13, 2024

Uh oh!

kavimuru commented Jun 14, 2024

Workspace - The default data in the Tax ID number field is "-1"

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Uh oh!

OSBotify commented Jun 14, 2024

Uh oh!

OSBotify commented Jun 17, 2024

Uh oh!

suneox Jul 20, 2024

Choose a reason for hiding this comment

Uh oh!

paultsimura Jul 22, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

12 participants

kubabutkiewicz commented May 27, 2024 •

edited

Loading

jjcoffee commented May 31, 2024 •

edited

Loading