Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Track expense with custom distance rate #47864

Merged
merged 4 commits into from
Sep 5, 2024
Merged

Conversation

neil-marcellini
Copy link
Contributor

@neil-marcellini neil-marcellini commented Aug 22, 2024

Details

Fixed Issues

$ #47153
PROPOSAL: N/A

Tests

Precondition:

  • Workspace has a few distance rates.
  1. Log in
  2. Go to workspace chat.
  3. Click + > Track expense > Distance.
  4. Proceed to confirmation page.
  5. Click Rate and select a different rate.
  6. Submit the track distance expense.
  7. Go to transaction thread.
  8. Verify the custom rate is displayed
  • Verify that no errors appear in the JS console

Offline tests

  1. Run the same tests above going offline while submitting
  2. Verify optimistic data looks good (shows the custom rate)
  3. Go back online after
  4. Verify final data looks good (shows the custom rate)

QA Steps

Same as 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

I only tested web since the changes should be platform independent, and C+/QA will test all platforms.

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
trackCustom1080.mov
MacOS: Desktop

@neil-marcellini neil-marcellini self-assigned this Aug 22, 2024
Copy link

cloudflare-workers-and-pages bot commented Aug 22, 2024

Deploying new-help with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5201a6c
Status:🚫  Build failed.

View logs

@neil-marcellini neil-marcellini changed the title Track expense with custom distance rate [HOLD Web-E 43234] Track expense with custom distance rate Aug 22, 2024
@neil-marcellini neil-marcellini marked this pull request as ready for review August 23, 2024 18:42
@neil-marcellini neil-marcellini requested a review from a team as a code owner August 23, 2024 18:42
@melvin-bot melvin-bot bot requested review from jjcoffee and removed request for a team August 23, 2024 18:42
Copy link

melvin-bot bot commented Aug 23, 2024

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

@neil-marcellini
Copy link
Contributor Author

The backend fix is on staging so you can test now, but we still need to hold to merge until it's on production

@jjcoffee
Copy link
Contributor

jjcoffee commented Aug 26, 2024

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-app-2024-08-26_09.51.15.mp4
Android: mWeb Chrome
android-chrome-2024-08-26_10.02.52.mp4
iOS: Native
ios-app-2024-08-26_10.51.33.mp4
iOS: mWeb Safari
ios-safari-2024-08-26_10.58.20.mp4
MacOS: Chrome / Safari
desktop-chrome-2024-08-26_09.40.17.mp4
MacOS: Desktop
desktop-app-2024-08-26_09.45.13.mp4

@jjcoffee
Copy link
Contributor

@neil-marcellini Tests well, except that weirdly only on Android native I'm getting the error: Unexpected error submitting this expense. Please try again later..

Request logs

[hmmm] [Network] API request error: Connection interruption likely - {"message":"Network request failed","request":{"command":"TrackExpense","data":{"amount":4667,"currency":"USD","comment":"","created":"2024-08-26","merchant":"46.67 miles @ $1 / mile","iouReportID":"2206440119288172","chatReportID":"8453830520816782","transactionID":"701438414021283425","reportActionID":"5500740757517283508","createdChatReportActionID":"-1","createdIOUReportActionID":"-1","reportPreviewReportActionID":"6553915437872518885","receipt":{"source":249,"state":"OPEN"},"receiptState":"OPEN","category":"","tag":"Test","taxCode":"","taxAmount":0,"billable":false,"transactionThreadReportID":"6785219536653772","createdReportActionIDForThread":"3139612341763897727","waypoints":"{"waypoint0":{"keyForList":"111 Prairie Ridge Ct_1724658687274","lat":36.75784549999999,"lng":-95.9080789,"address":"111 Prairie Ridge Ct, Bartlesville, OK, USA","name":"111 Prairie Ridge Ct"},"waypoint1":{"keyForList":"1120 S Utica Ave_1724658691588","lat":36.1470944,"lng":-95.967617,"address":"1120 South Utica Avenue, Tulsa, OK, USA","name":"1120 S Utica Ave"}}","customUnitRateID":"FA34EB87885B8","apiRequestType":"write","pusherSocketID":"766764.4703658","shouldRetry":true,"canCancel":true},"successData":[{"onyxMethod":"merge","key":"report_2206440119288172","value":{"pendingFields":null,"errorFields":null}},{"onyxMethod":"merge","key":"reportActions_2206440119288172","value":{"5500740757517283508":{"pendingAction":null,"errors":null}}},{"onyxMethod":"merge","key":"reportActions_8453830520816782","value":{"6553915437872518885":{"pendingAction":null}}},{"onyxMethod":"merge","key":"report_6785219536653772","value":{"pendingFields":null,"errorFields":null}},{"onyxMethod":"merge","key":"transactions_701438414021283425","value":{"pendingAction":null,"pendingFields":{"waypoints":null},"routes":null}},{"onyxMethod":"merge","key":"reportActions_6785219536653772","value":{"3139612341763897727":{"pendingAction":null,"errors":null}}}],"failureData":[{"onyxMethod":"set","key":"nvp_quickActionGlobalCreate","value":{"action":"trackDistance","chatReportID":"8453830520816782","isFirstQuickAction":false}},{"onyxMethod":"merge","key":"report_2206440119288172","value":{"pendingFields":null,"errorFields":{}}},{"onyxMethod":"merge","key":"reportActions_2206440119288172","value":{"5500740757517283508":{"errors":{"1724658702546000":"Unexpected error submitting this expense. Please try again later."}}}},{"onyxMethod":"merge","key":"report_8453830520816782","value":{"lastReadTime":"2024-08-08 14:14:35.192","lastMessageText":"","lastMessageHtml":""}},{"onyxMethod":"merge","key":"report_6785219536653772","value":{"pendingFields":null,"errorFields":{"createChat":{"1724658702546000":"Unexpected error creating this chat. Please try again later."}}}},{"onyxMethod":"merge","key":"transactions_701438414021283425","value":{"errors":{"1724658702546000":"Unexpected error submitting this expense. Please try again later."},"pendingFields":{"waypoints":null}}},{"onyxMethod":"merge","key":"reportActions_6785219536653772","value":{"3139612341763897727":{"errors":{"1724658702546000":"Unexpected error submitting this expense. Please try again later."}}}},{"onyxMethod":"set","key":"transactionViolations_701438414021283425","value":[]},{"onyxMethod":"set","key":"reportViolations_2206440119288172","value":null}]}}

@neil-marcellini neil-marcellini changed the title [HOLD Web-E 43234] Track expense with custom distance rate Track expense with custom distance rate Aug 27, 2024
@neil-marcellini
Copy link
Contributor Author

That's odd. Would you please try again now that it's on prod? If there's a problem again please send my the test email you're using, or even better the requestID of the failed request.

@jjcoffee
Copy link
Contributor

@neil-marcellini Still happening, unfortunately! Request ID I think is 8ba302faeac3372d-FRA, the test email is [email protected]. I've also tried with a brand new account but I get the same error.

Copy link
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue on Android is also happening on main, so I think we're good to merge these changes.

@neil-marcellini Perhaps the fix from here can be re-applied to track expense?

@melvin-bot melvin-bot bot requested a review from arosiclair September 5, 2024 10:10
Copy link

melvin-bot bot commented Sep 5, 2024

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

@arosiclair
Copy link
Contributor

Not sure what the deal is with the Cloudflare Pages failure. I think it's probably unrelated so feel free to merge if it looks fine to you @neil-marcellini.

@neil-marcellini
Copy link
Contributor Author

The issue on Android is also happening on main, so I think we're good to merge these changes.

@neil-marcellini Perhaps the fix from here can be re-applied to track expense?

Ah yeah very interesting. We made a backend fix so that float distances like 2.0 stay as floats instead of getting converted to ints by PHP json encode, which would then cause problems later. I will re-test and see if it's working.

@neil-marcellini
Copy link
Contributor Author

I found these logs which show that the error is coming from a unique constraints violation on the reportActionID. Since you said the problem also occurs on main I agree we can go ahead. Would you please report the issue in Slack @jjcoffee?

'read/write transaction', query failed with error #19 (UNIQUE constraint failed: reportActions.reportActionID): INSERT INTO reportActions ( reportActionID, created, reportID, accountID, action, message ) VALUES ( 3460851511966431620, '2024-08-28 08:41:08.274', 2206440119288172, 15801235, 'IOU', '{"IOUReportID":2206440119288172,"IOUTransactionID":"8919939418154390761","amount":4667,"comment":"46.67 miles","currency":"USD","lastModified":"2024-08-28 08:41:08.274","participantAccountIDs":[15801235,0],"type":"track"}');

@neil-marcellini neil-marcellini merged commit 9d9acde into main Sep 5, 2024
14 checks passed
@neil-marcellini neil-marcellini deleted the neil-track-custom-rate branch September 5, 2024 17:07
@OSBotify
Copy link
Contributor

OSBotify commented Sep 5, 2024

✋ 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
Copy link
Contributor

OSBotify commented Sep 5, 2024

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

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

@jjcoffee
Copy link
Contributor

jjcoffee commented Sep 6, 2024

@neil-marcellini Sure, reported here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants