Optimistic custom unit IDs #23600

amyevans · 2023-07-25T22:57:03Z

~~This is on Hold until https://github.com/Expensify/Web-Expensify/pull/38312 deploys but is otherwise ready to go~~

Details

Generate customUnitID and customUnitRateID on the client and pass the IDs to the backend, so that a user can update a workspace's reimbursement rate and/or unit offline at time of initial workspace creation.

Fixed Issues

$ #17198

Tests

Create a new workspace (Settings > Workspaces > New workspace)
Modify the workspace's reimbursement rate and/or unit (Settings > Workspaces > [Your workspace] > Reimbursements > Track distance)
Close the RHN and navigate again to the Track distance section
Verify the rate/unit that you set persists (and hasn't been overwritten by values from the server)

Verify that no errors appear in the JS console

Offline tests

The primary purpose of this PR is to get the offline flow working, so this test is important

Go offline
Create a new workspace (Settings > Workspaces > New workspace)
Modify the workspace's reimbursement rate and/or unit (Settings > Workspaces > [Your workspace] > Reimbursements > Track distance)
Close the RHN
Come back online
Navigate again to the Track distance section
Verify the rate/unit that you set persists (and hasn't been overwritten by values from the server)

QA Steps

Go offline
Create a new workspace (Settings > Workspaces > New workspace)
Modify the workspace's reimbursement rate and/or unit (Settings > Workspaces > [Your workspace] > Reimbursements > Track distance)
Close the RHN
Come back online
Navigate again to the Track distance section
Verify the rate/unit that you set persists

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

Chrome on the emulator is stuck for me recently, skipping

Mobile Web - Safari

safari-mweb.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

fedirjh

Looks good, I left minor comments.

src/pages/workspace/reimburse/WorkspaceReimburseView.js

src/pages/workspace/reimburse/WorkspaceRateAndUnitPage.js

src/libs/actions/Policy.js

melvin-bot · 2023-08-03T15:18:21Z

@fedirjh 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 · 2023-08-03T15:19:25Z

Conflicts fixed, the backend PR is now on production, and I retested for good measure, so this should be ready for a full review now @fedirjh

fedirjh · 2023-08-03T21:03:58Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

CleanShot.2023-08-03.at.19.28.42.mp4

Mobile Web - Chrome

CleanShot.2023-08-03.at.21.10.34.mp4

Mobile Web - Safari

CleanShot.2023-08-03.at.19.40.10.mp4

Desktop

CleanShot.2023-08-03.at.19.32.50.mp4

iOS

CleanShot.2023-08-03.at.19.38.04.mp4

Android

CleanShot.2023-08-03.at.20.59.27.mp4

fedirjh

Looks good and tests well 🚀

🎀 👀 🎀 C+ reviewed

melvin-bot · 2023-08-03T22:03:07Z

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

roryabraham · 2023-08-07T19:20:32Z

src/libs/NumberUtils.js

+ * @param {Number} num
+ * @returns {String}
+ */
+function generateHexadecimalValue(num) {


NAB I'd include random in the name here. generateRandomHexValue(len)

OSBotify · 2023-08-07T19:25: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.

OSBotify · 2023-08-09T09:11:56Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-09T09:50:39Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-10T20:09:05Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

allroundexperts · 2024-06-23T22:47:36Z

src/libs/actions/Policy.js

+            rates: {
+                [customUnitRateID]: {
+                    customUnitRateID,
+                    name: CONST.CUSTOM_UNITS.DEFAULT_RATE,
+                    rate: CONST.CUSTOM_UNITS.MILEAGE_IRS_RATE * CONST.POLICY.CUSTOM_UNIT_RATE_BASE_OFFSET,
+                },


Not adding a default enabled: false later on caused #42788

amyevans added 2 commits July 25, 2023 15:50

Hardcode bare minimum optimistic custom unit generation

900e25c

Return object with IDs separated out

8c4fde9

amyevans self-assigned this Jul 25, 2023

amyevans mentioned this pull request Jul 25, 2023

[HOLD for payment 2023-08-17] [$1000] The 'unit' in the track distance in offline mode doesn't change to kilometers #17198

Closed

6 tasks

amyevans added 10 commits July 27, 2023 13:52

Generate random IDs

cc60ef3

Remove unneeded fields

f828203

Swap instances of "Distance" for its constant

e26be56

Add constants for mi and km

e8db7b5

Fix undefined error

9dd3b2c

Create constant for the IRS default rate

7e8c75e

Create a separate function to match current PHP behavior

8e88a2f

Add JSDoc

658152a

Run prettier

f61c27b

Merge branch 'main' into amy-custom-units-optimistic

ed30467

fedirjh reviewed Jul 29, 2023

View reviewed changes

src/pages/workspace/reimburse/WorkspaceReimburseView.js Outdated Show resolved Hide resolved

src/pages/workspace/reimburse/WorkspaceRateAndUnitPage.js Show resolved Hide resolved

src/libs/actions/Policy.js Outdated Show resolved Hide resolved

amyevans added 4 commits July 31, 2023 11:08

Extract Default Rate to constant

efddedd

Move hexadecimal generation to utility function

3f232a3

Run prettier

87e54c8

Merge main and fix Policy.js conflict

ee35936

amyevans marked this pull request as ready for review August 3, 2023 15:18

amyevans requested a review from a team as a code owner August 3, 2023 15:18

melvin-bot bot requested review from fedirjh and removed request for a team August 3, 2023 15:18

fedirjh approved these changes Aug 3, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham August 3, 2023 22:03

roryabraham approved these changes Aug 7, 2023

View reviewed changes

roryabraham merged commit e716286 into main Aug 7, 2023

roryabraham deleted the amy-custom-units-optimistic branch August 7, 2023 19:21

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

allroundexperts reviewed Jun 23, 2024

View reviewed changes

allroundexperts mentioned this pull request Jun 23, 2024

[HOLD for payment 2024-06-20] [$250] Distance rates - Default distance rate is Disabled instead of Enabled after creating new WS #42788

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Optimistic custom unit IDs #23600

Optimistic custom unit IDs #23600

amyevans commented Jul 25, 2023 •

edited

Loading

fedirjh left a comment

melvin-bot bot commented Aug 3, 2023

amyevans commented Aug 3, 2023

fedirjh commented Aug 3, 2023

fedirjh left a comment

melvin-bot bot commented Aug 3, 2023

roryabraham Aug 7, 2023

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

allroundexperts Jun 23, 2024

Optimistic custom unit IDs #23600

Optimistic custom unit IDs #23600

Conversation

amyevans commented Jul 25, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 3, 2023

amyevans commented Aug 3, 2023

fedirjh commented Aug 3, 2023

Reviewer Checklist

Screenshots/Videos

fedirjh left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Aug 3, 2023

roryabraham Aug 7, 2023

Choose a reason for hiding this comment

OSBotify commented Aug 7, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 9, 2023

OSBotify commented Aug 10, 2023

allroundexperts Jun 23, 2024

Choose a reason for hiding this comment

amyevans commented Jul 25, 2023 •

edited

Loading