Create DistanceRates.ts Utils file #42786

dangrous · 2024-05-29T18:13:19Z

Details

Continued progress on #38477

Fixed Issues

#38477
PROPOSAL:

Tests

No explicit tests, since nothing should change on the front end - just organizational. But play around with distance rates to make sure nothing seems weird!

Verify that no errors appear in the JS console

Offline tests

QA Steps

No QA (will come up in existing QA tests)

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-05-29T18:39:12Z

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

amyevans · 2024-05-29T20:15:10Z

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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

luacmartins · 2024-05-29T22:12:21Z

@dangrous conflicts

luacmartins · 2024-05-31T17:24:08Z

Still waiting on conflicts resolution

luacmartins · 2024-06-03T16:20:03Z

@dangrous we still have conflicts

amyevans · 2024-06-03T16:20:56Z

He's OOO until tomorrow

dangrous · 2024-06-04T19:48:52Z

Conflicts resolved! Ready for a final look.

luacmartins · 2024-06-04T20:14:04Z

Gonna merge before we get more conflicts

OSBotify · 2024-06-04T20:22:29Z

✋ 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-06-11T23:32:58Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

allgandalf · 2024-11-12T09:43:50Z

src/libs/actions/Policy/DistanceRate.ts

+        } else {
+            optimisticRates[rateID] = currentRates[rateID];
+            successRates[rateID] = currentRates[rateID];
+        }
+    }


@dangrous was there any reason to set this explicitely, we have a bug currently #51426.

this block unintentionally overrides changes made by the CreatePolicyDistanceRate request.

The bug is that:

The new rate added offline becomes active when going online. But seen grayed out when user go offline again after the distance rate is completely active
The same rate seen grayed out every time user go offline

So this PR was just moving the code, I didn't actually change any functionality - so I'm not sure! My gut is that we can remove this code, but we'll have to look farther back in the blame to find the original author - it would be in src/libs/actions/Policy/Policy.ts

dangrous added 7 commits May 29, 2024 13:40

create scaffold file

d13296d

remove all non-distance rate functions

d710561

swap references

271019c

remove functions from Policy.ts

41614f1

move prepareCustomUnitRatesArray since not used in Policy.ts

20f84c8

move removePendingFieldsFromCustomUnit since not used in Policy.ts

aa51ef3

prettier

8caaa42

dangrous self-assigned this May 29, 2024

put removePendingFields... back whoops

62dd5b5

dangrous marked this pull request as ready for review May 29, 2024 18:34

dangrous requested a review from a team as a code owner May 29, 2024 18:34

melvin-bot bot requested review from MonilBhavsar and removed request for a team May 29, 2024 18:39

amyevans previously approved these changes May 29, 2024

View reviewed changes

luacmartins previously approved these changes May 29, 2024

View reviewed changes

luacmartins self-requested a review May 30, 2024 14:08

merge conflicts

e4675e8

dangrous dismissed stale reviews from luacmartins and amyevans via e4675e8 June 4, 2024 19:37

luacmartins approved these changes Jun 4, 2024

View reviewed changes

luacmartins merged commit a1fc168 into main Jun 4, 2024
17 checks passed

luacmartins deleted the dangrous-distancerateutils branch June 4, 2024 20:14

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

Deploy Checklist: New Expensify 2024-06-06 #43168

Closed

grgia mentioned this pull request Jun 6, 2024

[HOLD for payment 2024-06-20] [HOLD for payment 2024-06-18] Expense - App crashes when submitting expense on a newly created workspace #43171

Closed

6 tasks

allgandalf reviewed Nov 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create DistanceRates.ts Utils file #42786

Create DistanceRates.ts Utils file #42786

dangrous commented May 29, 2024 •

edited

Loading

melvin-bot bot commented May 29, 2024

amyevans commented May 29, 2024 •

edited

Loading

luacmartins commented May 29, 2024

luacmartins commented May 31, 2024 •

edited

Loading

luacmartins commented Jun 3, 2024

amyevans commented Jun 3, 2024

dangrous commented Jun 4, 2024

luacmartins commented Jun 4, 2024

OSBotify commented Jun 4, 2024

OSBotify commented Jun 11, 2024

allgandalf Nov 12, 2024

dangrous Nov 12, 2024

Create DistanceRates.ts Utils file #42786

Create DistanceRates.ts Utils file #42786

Conversation

dangrous commented May 29, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 29, 2024

amyevans commented May 29, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

luacmartins commented May 29, 2024

luacmartins commented May 31, 2024 • edited Loading

luacmartins commented Jun 3, 2024

amyevans commented Jun 3, 2024

dangrous commented Jun 4, 2024

luacmartins commented Jun 4, 2024

OSBotify commented Jun 4, 2024

OSBotify commented Jun 11, 2024

allgandalf Nov 12, 2024

Choose a reason for hiding this comment

dangrous Nov 12, 2024

Choose a reason for hiding this comment

dangrous commented May 29, 2024 •

edited

Loading

amyevans commented May 29, 2024 •

edited

Loading

luacmartins commented May 31, 2024 •

edited

Loading