Implement new UpdateMoneyRequestDate API endpoint #30737

tgolen · 2023-11-01T22:06:42Z

Held on https://github.com/Expensify/Web-Expensify/pull/39445 where the API Endpoint is added

Details

This PR uses the new API for updating the date of a money request. There is one glitch that is important to note:

When changing the date of a scanning request, the merchant and amount fields briefly show an error. I feel this is out of scope of this PR to fix. It's actually better than the existing functionality where the merchant and amount fields show an error that never goes away.

Fixed Issues

$ #29993

Tests

Have three types of money requests: manual, scan, and distance
Edit each type of request to change the date
Verify you can change the date

Verify that no errors appear in the JS console

Offline tests

Update the date field while offline
Verify the field shows as pending (greyed out)
Go online and verify the field is updated

QA Steps

Same as the tests above

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 Note: I could not test here because of broken emulator URLs that have not been fixed
- 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 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 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 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
- 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
  - 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 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 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 author 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

melvin-bot · 2023-11-09T18:40:13Z

@cubuspl42 @ One of you needs to 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]

dylanexpensify · 2023-11-14T20:47:02Z

bump @cubuspl42

cubuspl42 · 2023-11-15T10:39:44Z

@dylanexpensify Aren't we on hold on some backend change?

[HOLD Web-Expensify/pull/39445]

cubuspl42 · 2023-11-22T10:52:33Z

@dylanexpensify Aren't we on hold on some backend change?

[HOLD Web-Expensify/pull/39445]

Let me know what's the state of that PR, I don't have the necessary permissions to view it.

tgolen · 2023-12-01T18:28:26Z

The PR for the web API was merged yesterday. I think that will allow this to come off of HOLD on Monday (assuming deploys go well). I've updated this branch and retested it, so you should at least be able to do a code review.

tgolen · 2023-12-06T17:12:28Z

The API has been deployed to production so this is off HOLD and can be reviewed/merged.

cubuspl42 · 2023-12-07T10:39:06Z

src/libs/actions/IOU.js

+ * @param {String} [transactionChanges.created] // Present when updated the date field
+ * @param {Boolean} onlyIncludeChangedFields
+ *                      // When 'true', then the returned params will only include the transaction details for the fields that were changed.
+ *                      // When `false`, then the returned params will include all the transaction details, regardless of which fields were changed.
+ *                      // This setting is necessary while the UpdateDistanceRequest API is refactored to be fully 1:1:1 in https://github.com/Expensify/App/issues/28358


A comment within a comment!

cubuspl42 · 2023-12-07T10:41:55Z

src/pages/EditRequestPage.js

+    const saveCreated = useCallback(
+        ({created: newCreated}) => {
+            // If the value hasn't changed, don't request to save changes on the server and just close the modal
+            if (newCreated === TransactionUtils.getCreated(transaction)) {


Just confirming: we're fine with identity comparison here, right?

Yeah, it should be fine. Thanks for confirming!

cubuspl42 · 2023-12-07T12:19:53Z

Would you merge main? We're ~1000 commits behind

cubuspl42 · 2023-12-07T12:31:25Z

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

updaterequestdate-web.mp4

Mobile Web - Chrome

updaterequestdate-android-web-compressed.mp4

Mobile Web - Safari

updaterequestdate-ios-web.mp4

Desktop

iOS

updaterequestdate-ios.mp4

Android

updaterequestdate-android-compressed.mp4

cubuspl42 · 2023-12-07T12:32:18Z

Left a minor comment about a comment within a comment, but otherwise looks good 👍

tgolen · 2023-12-07T16:39:35Z

OK, this is updated with main and I fixed the comment of comments :D

cubuspl42 · 2023-12-08T09:33:43Z

src/libs/actions/IOU.js

- * @param {Object} [transactionChanges.comment]
- * @param {Object} [transactionChanges.waypoints]
- *
+ * @param {String} [transactionChanges.created] // Present when updated the date field


/* // This one too */

tgolen · 2023-12-12T16:06:06Z

Updated. We should be fine to merge now?

cubuspl42

Sure 👍

melvin-bot · 2023-12-13T10:17:47Z

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

Beamanator

LGTM!

OSBotify · 2023-12-13T12:53:42Z

✋ 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-12-14T16:05:25Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.13-0 🚀

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

OSBotify · 2023-12-14T16:45:13Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.4.13-0 🚀

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

OSBotify · 2023-12-19T02:01:31Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.13-8 🚀

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

Add a DRY method for returning the params and onyx data

f40baf8

tgolen mentioned this pull request Nov 1, 2023

[HOLD for payment 2023-12-26] [DISTANCE] LOW: UpdateDistanceRequest 1:1:1 - UpdateMoneyRequestDate - Split out into its own command #29993

Closed

tgolen changed the title ~~Add a DRY method for returning the params and onyx data~~ Tgolen updaterequestdate Nov 3, 2023

tgolen added 3 commits November 3, 2023 12:55

Merge branch 'main' into tgolen-updaterequestdate

6cfddc7

Remove unused props and simplify callback

44619ea

Call new method for updating request date

e8ba740

tgolen self-assigned this Nov 3, 2023

tgolen added 3 commits November 9, 2023 09:39

Merge branch 'main' into tgolen-updaterequestdate

9f23d9d

Pass the reportID to the API endpoint

ec8857a

Only include changed fields in optimistic data

92934ef

tgolen changed the title ~~Tgolen updaterequestdate~~ [HOLD Web-Expensify/pull/39445] Implement new UpdateMoneyRequestDate API endpoint Nov 9, 2023

tgolen requested a review from Beamanator November 9, 2023 18:39

tgolen marked this pull request as ready for review November 9, 2023 18:40

tgolen requested a review from a team as a code owner November 9, 2023 18:40

melvin-bot bot requested review from cubuspl42 and removed request for a team November 9, 2023 18:40

Merge branch 'main' into tgolen-updaterequestdate

a9a881b

tgolen changed the title ~~[HOLD Web-Expensify/pull/39445] Implement new UpdateMoneyRequestDate API endpoint~~ Implement new UpdateMoneyRequestDate API endpoint Nov 29, 2023

tgolen changed the title ~~Implement new UpdateMoneyRequestDate API endpoint~~ [HOLD Web-Expensify/pull/39445] Implement new UpdateMoneyRequestDate API endpoint Nov 29, 2023

tgolen added 2 commits December 1, 2023 10:24

Merge branch 'main' into tgolen-updaterequestdate

be8de36

Simplify how the created field is accessed

16161b7

tgolen changed the title ~~[HOLD Web-Expensify/pull/39445] Implement new UpdateMoneyRequestDate API endpoint~~ Implement new UpdateMoneyRequestDate API endpoint Dec 6, 2023

cubuspl42 reviewed Dec 7, 2023

View reviewed changes

tgolen added 2 commits December 7, 2023 09:38

Merge branch 'main' into tgolen-updaterequestdate

a37c757

Remove nested comments

35b91ca

tgolen requested a review from cubuspl42 December 7, 2023 16:39

cubuspl42 reviewed Dec 8, 2023

View reviewed changes

Update IOU.js

90ada1c

cubuspl42 approved these changes Dec 13, 2023

View reviewed changes

melvin-bot bot requested a review from johnmlee101 December 13, 2023 10:17

Beamanator approved these changes Dec 13, 2023

View reviewed changes

Beamanator merged commit f77318c into main Dec 13, 2023

Beamanator deleted the tgolen-updaterequestdate branch December 13, 2023 12:48

github-actions bot mentioned this pull request Dec 14, 2023

Deploy Checklist: New Expensify 2023-12-14 #33072

Closed

77 tasks

lanitochka17 mentioned this pull request Dec 14, 2023

[HOLD for payment 2023-12-28] [HOLD for payment 2023-12-26] Expense - App crashes when saving expense date twice in offline mode #33098

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement new UpdateMoneyRequestDate API endpoint #30737

Implement new UpdateMoneyRequestDate API endpoint #30737

tgolen commented Nov 1, 2023 •

edited

Loading

melvin-bot bot commented Nov 9, 2023

dylanexpensify commented Nov 14, 2023

cubuspl42 commented Nov 15, 2023 •

edited

Loading

cubuspl42 commented Nov 22, 2023

tgolen commented Dec 1, 2023

tgolen commented Dec 6, 2023

cubuspl42 Dec 7, 2023

cubuspl42 Dec 7, 2023

tgolen Dec 7, 2023

cubuspl42 commented Dec 7, 2023

cubuspl42 commented Dec 7, 2023

cubuspl42 commented Dec 7, 2023

tgolen commented Dec 7, 2023

cubuspl42 Dec 8, 2023

tgolen commented Dec 12, 2023

cubuspl42 left a comment

melvin-bot bot commented Dec 13, 2023

Beamanator left a comment

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 19, 2023

Implement new UpdateMoneyRequestDate API endpoint #30737

Implement new UpdateMoneyRequestDate API endpoint #30737

Conversation

tgolen commented Nov 1, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 9, 2023

dylanexpensify commented Nov 14, 2023

cubuspl42 commented Nov 15, 2023 • edited Loading

cubuspl42 commented Nov 22, 2023

tgolen commented Dec 1, 2023

tgolen commented Dec 6, 2023

cubuspl42 Dec 7, 2023

Choose a reason for hiding this comment

cubuspl42 Dec 7, 2023

Choose a reason for hiding this comment

tgolen Dec 7, 2023

Choose a reason for hiding this comment

cubuspl42 commented Dec 7, 2023

cubuspl42 commented Dec 7, 2023

Reviewer Checklist

Screenshots/Videos

cubuspl42 commented Dec 7, 2023

tgolen commented Dec 7, 2023

cubuspl42 Dec 8, 2023

Choose a reason for hiding this comment

tgolen commented Dec 12, 2023

cubuspl42 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 13, 2023

Beamanator left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 13, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 14, 2023

OSBotify commented Dec 19, 2023

tgolen commented Nov 1, 2023 •

edited

Loading

cubuspl42 commented Nov 15, 2023 •

edited

Loading