Feat/36985 create new rate field

[koko57]

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/36985 PROPOSAL: -

Tests

P2P / Splits

1. Go to global create (+) > Request money
2. Change the request type to Distance
3. Choose and submit the start/finish points
4. Choose one user or add to a split and go to the confirmation page
5. Verify that the distance is displayed correctly
6. Verify that clicking the distance field navigates to the distance editing page
7. Go back to the confirmation page
8. Verify that the rate is displayed correctly
9. Verify that the field is non-interactive

** Workspace Requests**

Prerequisites:

1. Log in to expensify.com
2. Go to Settings > Workspaces
3. Create a new Collect workspace if needed
4. Click on the workspace to open its settings page
5. Open the JS console (command + option + j)
6. Paste in the following and hit enter to enable the workspace to be used in NewDot

p = Policy.getCurrent(); 
p.policy.isPolicyExpenseChatEnabled = "true"; 
p.save();

7. Click on Expenses in the left hand menu of the workspace settings and scroll down to the Distance card
8. Click “Add a mileage rate”, then enter a unique name and value
9. Click Members in the left hand menu and invite a member (required so that an expense chat is created for NewDot)
10. Log in as the member on new expensify

---

1. Go to global create (+) > Request money
2. Change the request type to Distance
3. Choose and submit the start/finish points
4. Select the collect workspace and go to the confirmation page
5. Verify that the distance is displayed correctly
6. Verify that clicking the distance field navigates to the distance editing page
7. Go back to the confirmation page
8. Verify that the default rate is used and displayed correctly
9. Verify that the field has a right arrow icon, is interactive and navigates to the rate selection page
10. Verify that both workspace rates are displayed correctly on the selection page, and the default is currently selected
11. Select the other rate
12. Verify you are navigated back to the confirmation page and the amount and the rate field are properly updated

Money Request View

1. Open the expense report
2. Verify that a request preview is displayed with the proper distance and rate
3. Open the request
4. Verify that the Distance field is displayed with the correct value
5. Verify that the Rate is displayed with correct value
6. Rate field is not interactive for now, it'll be changed later

• [x] Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

P2P / Splits

1. Go to global create (+) > Request money
2. Change the request type to Distance
3. Choose and submit the start/finish points
4. Choose one user or add to a split and go to the confirmation page
5. Verify that the distance is displayed correctly
6. Verify that clicking the distance field navigates to the distance editing page
7. Go back to the confirmation page
8. Verify that the rate is displayed correctly
9. Verify that the field is non-interactive

** Workspace Requests**

Prerequisites:

1. Log in to expensify.com
2. Go to Settings > Workspaces
3. Create a new Collect workspace if needed
4. Click on the workspace to open its settings page
5. Open the JS console (command + option + j)
6. Paste in the following and hit enter to enable the workspace to be used in NewDot

p = Policy.getCurrent(); 
p.policy.isPolicyExpenseChatEnabled = "true"; 
p.save();

7. Click on Expenses in the left hand menu of the workspace settings and scroll down to the Distance card
8. Click “Add a mileage rate”, then enter a unique name and value
9. Click Members in the left hand menu and invite a member (required so that an expense chat is created for NewDot)
10. Log in as the member on new expensify

---

1. Go to global create (+) > Request money
2. Change the request type to Distance
3. Choose and submit the start/finish points
4. Select the collect workspace and go to the confirmation page
5. Verify that the distance is displayed correctly
6. Verify that clicking the distance field navigates to the distance editing page
7. Go back to the confirmation page
8. Verify that the default rate is used and displayed correctly
9. Verify that the field has a right arrow icon, is interactive and navigates to the rate selection page
10. Verify that both workspace rates are displayed correctly on the selection page, and the default is currently selected
11. Select the other rate
12. Verify you are navigated back to the confirmation page and the amount and the rate field are properly updated

Money Request View

1. Open the expense report
2. Verify that a request preview is displayed with the proper distance and rate
3. Open the request
4. Verify that the Distance field is displayed with the correct value
5. Verify that the Rate is displayed with correct value
6. Rate field is not interactive for now, it'll be changed later

• [ ] Verify that no errors appear in the JS console

PR Author Checklist

• [x] I linked the correct issue in the ### Fixed Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] I added steps for the expected offline behavior in the Offline steps section
  • [x] I added steps for Staging and/or Production testing in the QA steps section
  • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [x] 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)
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android / native
  • [x] Android / Chrome
  • [x] iOS / native
  • [x] iOS / Safari
  • [x] MacOS / Chrome / Safari
  • [x] MacOS / Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] 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:
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] If the PR modifies the form input styles:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/Expensify/App/assets/28020445/596d4dca-1837-428c-a3d6-82e4c5f9cdad

Android: mWeb Chrome

iOS: Native

https://github.com/Expensify/App/assets/28020445/e67c8dba-25db-48b6-b026-2263a3f31b71

iOS: mWeb Safari

https://github.com/Expensify/App/assets/28020445/92e46962-2291-4d99-8ec8-276eefdd1809

MacOS: Chrome / Safari

https://github.com/Expensify/App/assets/28020445/3ac987f8-0e5c-482a-bb0e-23eeab7c8f02

MacOS: Desktop

https://github.com/Expensify/App/assets/28020445/cbcd8644-a061-40eb-b8a4-17e081a82a80

[melvin-bot[bot]]

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

[getusha]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Workspace Requests

https://github.com/Expensify/App/assets/75031127/38fa041d-9792-424b-915a-0f28b050f4e9

P2P / Splits

https://github.com/Expensify/App/assets/75031127/441b8045-b827-4cb6-9321-6218079576d9

Android: mWeb Chrome

Workspace Requests

https://github.com/Expensify/App/assets/75031127/7144c0b1-66dd-464f-a189-8cd701395b18

P2P / Splits

https://github.com/Expensify/App/assets/75031127/45710295-51cc-4e56-8c94-0f8a093ea62d

iOS: Native

Workspace Requests

https://github.com/Expensify/App/assets/75031127/32e76f2a-2741-4545-9b45-2819f392579d

P2P / Splits

https://github.com/Expensify/App/assets/75031127/e33c4db9-82a3-4a7e-8e8c-3da9abceed85

iOS: mWeb Safari

P2P / Splits

https://github.com/Expensify/App/assets/75031127/046de54a-be92-4687-ac64-d071c7a47956

Workspace Requests

https://github.com/Expensify/App/assets/75031127/97dba8cf-bd85-4fd2-9a01-b3fa67ea92bd

MacOS: Chrome / Safari

P2P / Splits

Workspace Requests

https://github.com/Expensify/App/assets/75031127/f20e651a-2159-4ab9-992d-8232f850c3c2

MacOS: Desktop

Workspace Requests

https://github.com/Expensify/App/assets/75031127/8c9e0bf6-2864-4122-9327-9b936592e0ef

P2P / Splits

https://github.com/Expensify/App/assets/75031127/7780b56f-1bda-4e36-afe9-b36bee372efe

[koko57]

conflicts resolved

[getusha]

@neil-marcellini can you add my accounts to the beta [email protected], [email protected]

[neil-marcellini]

@getusha it's a frontend only beta so you can just change Permissions.ts to return true for you

[getusha]

@getusha it's a frontend only beta so you can just change Permissions.ts to return true for you

Enabled it from the front-end & couldn't get the Distance & Rate field to load. it's stuck on Route pending.. let me try it again.

[neil-marcellini]

Ok. @koko57 can you look into that please?

[neil-marcellini]

I'm planning to review today

[koko57]

@neil-marcellini ok, thanks, I'll also check what's wrong here

[koko57]

@neil-marcellini should be fixed now

[koko57]

@neil-marcellini @getusha ok I think it's ready for the next round of review. The reassure test is failing but it's with SignInPage

[paultsimura]

Hey, maybe it's a bit out of scope, but when adding the rates on ND, we can't set the names (so far).

Therefore, when selecting the rate for a request, all the rates will show just a "Default rate #" title. Is it expected, or should we hide these titles?

[koko57]

Hey, maybe it's a bit out of scope, but when adding the rates on ND, we can't set the names (so far).

Therefore, when selecting the rate for a request, all the rates will show just a "Default rate #" title. Is it expected, or should we hide these titles?

@paultsimura I think it will be added later, but showing these names is now mainly for compatibility with the OD where you can edit the rate name.

cc @neil-marcellini for confirmation

[getusha]

BUG? the rate preview is different from the selected rate on workspace request money confirmation page

https://github.com/Expensify/App/assets/75031127/272e16cc-4957-4379-83cc-241699de8344

[neil-marcellini]

Hey, maybe it's a bit out of scope, but when adding the rates on ND, we can't set the names (so far). Therefore, when selecting the rate for a request, all the rates will show just a "Default rate #" title. Is it expected, or should we hide these titles?

@paultsimura I think it will be added later, but showing these names is now mainly for compatibility with the OD where you can edit the rate name.

cc @neil-marcellini for confirmation

Good catch @paultsimura. The design doc isn't very clear on this point, or really we forgot to clarify this case. If the rate doesn't have a name, let's only display the bold text with the formatted rate $0.673 / mile

[koko57]

@getusha could you please re-review?

[paultsimura]

@neil-marcellini is there any good reason why the rates are stored inside transaction.comment instead of the transaction directly?

It will bring complications such as updating the rate – updating it will set transaction.comment as a pending field, and therefore the "description" field will be marked as pending.

There are workarounds for this, but I'm wandering why some fields are added directly to the transaction, while other are deeply nested within the comment 🤔

[neil-marcellini]

@neil-marcellini is there any good reason why the rates are stored inside transaction.comment instead of the transaction directly?

It's because that's the way it has always been done on the backend, and it would be a ton of unnecessary work to change it. In our DB the comment column in our transaction table is where we can store JSON data about the transaction.

The description is stored in transaction.comment.comment so it should be easy to use that path specifically for the pending field.

[koko57]

@neil-marcellini @paultsimura re-requesting the review as there were conflicts because of the the MoneyTemporaryForRefactorRequestConfirmationList migration to tsx

[neil-marcellini]

@koko57 lint is failing

[koko57]

@neil-marcellini fixed!

[getusha]

@koko57 is the default rate supposed to be the selected one always on the Confirmation page?

[koko57]

@getusha could you explain it? I don't get what you mean 😅

@koko57 is the default rate supposed to be the selected one always on the Confirmation page?

[getusha]

@getusha could you explain it? I don't get what you mean 😅

@koko57 Just wanted a clarification on which rate should be selected by default initially when we open the confirmation page.

[paultsimura]

@getusha could you explain it? I don't get what you mean 😅

@koko57 Just wanted a clarification on which rate should be selected by default initially when we open the confirmation page.

It should be the last rate the User used within this Workspace

[getusha]

@koko57 i am still able to reproduce this https://github.com/Expensify/App/pull/38543#issuecomment-2047639258

You have to log out and sign in again to reproduce.

https://github.com/Expensify/App/assets/75031127/04f0aabf-cdfe-4816-948a-4550b2c5d52d

[getusha]

@neil-marcellini i am getting this error after requesting money from a collect workspace. not sure if this a bug or an issue from my account.

[koko57]

@neil-marcellini @getusha the problem with the rate https://github.com/Expensify/App/pull/38543#issuecomment-2047639258 is that when we select the participant the policy doesn't have customUnits property, so we don't have the ID to set it properly. We get the data after we land on the confirmation page

logged out policy on select participant

onyx after going to confirmation

[koko57]

I can fallback to getDefaultMileageRate once again for just displaying the rate but we would send the request without customUnitRateID if the rate is not changed. As @getusha wrote it happens after you log out/in or when you choose a workspace never selected before. Then you have all the data, so that's why later on the bug doesn't occur. @neil-marcellini could we have the customUnit object for each policy right after we log in?

[getusha]

@neil-marcellini could you please check https://github.com/Expensify/App/pull/38543#issuecomment-2050483760, https://github.com/Expensify/App/pull/38543#issuecomment-2050505896 & https://github.com/Expensify/App/pull/38543#issuecomment-2050544611? i am not able to create any requests.