Migrate `IOURequestStepDistanceRate` to `useOnyx` by mkzie2 · Pull Request #50537 · Expensify/App

mkzie2 · 2024-10-10T00:46:09Z

Details

Fixed Issues

$ #50334
PROPOSAL: #50334 (comment)

Tests

Enable Distance rates and Taxes for workspace
Add several rates
Enable Track tax, add Tax rate and Tax reimbursable for every rates
Submit a distance expense to the above workspace
Press Rates in confirmation page
Verify all workspace's distance rates show
Change to another rate
Verify the total amount, tax rate and tax amount are updated accordingly
Submit the expense
Verify the expense is created successfully

Verify that no errors appear in the JS console

Offline tests

See Tests

QA Steps

See Tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-10-10.at.16.39.17-compressed.mov

Android: mWeb Chrome

Screen.Recording.2024-10-10.at.16.41.43-compressed.mov

iOS: Native

Screen.Recording.2024-10-10.at.08.21.07-compressed.mov

iOS: mWeb Safari

Screen.Recording.2024-10-10.at.08.15.54-compressed.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-10.at.08.04.41-compressed.mov

MacOS: Desktop

Screen.Recording.2024-10-10.at.08.14.15-compressed.mov

melvin-bot · 2024-10-10T01:22:15Z

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

rushatgabhane · 2024-10-10T02:26:46Z

-    policyTags: OnyxEntry<OnyxTypes.PolicyTagLists>;
+type IOURequestStepDistanceRateProps = WithWritableReportOrNotFoundProps<typeof SCREENS.MONEY_REQUEST.STEP_DISTANCE_RATE> & {
+    /** Holds data related to Money Request view state, rather than the underlying Money Request data. */
+    transaction: OnyxEntry<OnyxTypes.Transaction>;


@mkzie2 do we have a hook for transaction? Can we create one?

Hmm why do we need it?

withFullTransactionOrNotFound is being used in many places and has a quite complicated logic

It is already using useOnyx

That's why I think this is out of scope and should be handled in a separate withFullTransactionOrNotFound migration issue.

agree, thanks for explaining

mkzie2 · 2024-10-14T03:59:09Z

@rushatgabhane How's your testing?

rushatgabhane · 2024-10-15T02:43:55Z

@mkzie2 do you know why tax amount is always 0 ? The tax rate is 5%

mkzie2 · 2024-10-15T02:54:10Z

@rushatgabhane Did you set the "Tax reclaimable on" value? Without it, the tax amount is always zero.

rushatgabhane · 2024-10-15T13:05:59Z

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-10-15.at.17.59.55.mov

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-10-15.at.18.31.48.mov

MacOS: Chrome / Safari

Screen.Recording.2024-10-15.at.17.58.55.mov

MacOS: Desktop

neil-marcellini

Looks great thanks! @mkzie2 we need to fix conflicts though. Please DM me when that's done and I can merge this.

mkzie2 · 2024-10-15T19:32:34Z

@neil-marcellini I resolved the conflict.

OSBotify · 2024-10-16T17:08:28Z

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

github-actions · 2024-10-17T01:59:29Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.0.50-0 🚀

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

github-actions · 2024-10-18T18:48:19Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.50-8 🚀

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

mkzie2 added 4 commits October 10, 2024 07:45

migrate IOURequestStepDistanceRate to useOnyx

2881a49

fix typescript and lint errors

62acf3b

update onyx key

6aed040

revert unnesscary changes

46e5519

mkzie2 marked this pull request as ready for review October 10, 2024 01:22

mkzie2 requested a review from a team as a code owner October 10, 2024 01:22

melvin-bot Bot requested review from rushatgabhane and removed request for a team October 10, 2024 01:22

rushatgabhane reviewed Oct 10, 2024

View reviewed changes

rushatgabhane approved these changes Oct 15, 2024

View reviewed changes

melvin-bot Bot requested a review from neil-marcellini October 15, 2024 13:06

neil-marcellini previously approved these changes Oct 15, 2024

View reviewed changes

resolve conflict

7170d67

mkzie2 dismissed neil-marcellini’s stale review via 7170d67 October 15, 2024 19:27

neil-marcellini approved these changes Oct 16, 2024

View reviewed changes

neil-marcellini merged commit cbd4f17 into Expensify:main Oct 16, 2024

github-actions Bot mentioned this pull request Oct 17, 2024

Deploy Checklist: New Expensify 2024-10-17 #50969

Closed

90 tasks

melvin-bot Bot mentioned this pull request Oct 18, 2024

[HOLD for payment 2024-10-25] [$250] Migrate IOURequestStepDistanceRate to useOnyx #50334

Closed

Conversation

mkzie2 commented Oct 10, 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!

melvin-bot Bot commented Oct 10, 2024

Uh oh!

rushatgabhane Oct 10, 2024

Choose a reason for hiding this comment

Uh oh!

mkzie2 Oct 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rushatgabhane Oct 11, 2024

Choose a reason for hiding this comment

Uh oh!

mkzie2 commented Oct 14, 2024

Uh oh!

rushatgabhane commented Oct 15, 2024

Uh oh!

mkzie2 commented Oct 15, 2024

Uh oh!

rushatgabhane commented Oct 15, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

mkzie2 commented Oct 15, 2024

Uh oh!

OSBotify commented Oct 16, 2024

Uh oh!

github-actions Bot commented Oct 17, 2024

Uh oh!

github-actions Bot commented Oct 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mkzie2 commented Oct 10, 2024 •

edited

Loading

mkzie2 Oct 10, 2024 •

edited

Loading