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

Display correct message when editing distance requests #27979

Merged
merged 10 commits into from
Oct 2, 2023

Conversation

Gonals
Copy link
Contributor

@Gonals Gonals commented Sep 22, 2023

Details

Fixed Issues

$ #27630
PROPOSAL:

Tests

  • Create a distance request in Newdot following the steps here
  • Once it shows up in newdot, open it and click on Distance.
  • Edit the waypoints and wait for a few seconds until it is done loading.
  • Confirm the following message displays:
Screenshot 2023-09-21 at 5 22 07 PM
  • Verify that no errors appear in the JS console

Offline tests

None

QA Steps

  • Create a distance request in Newdot by opening a chat with a Workspace and clicking + > Request Money > Distance and setting waypoints.
  • Open it and click on Distance.
  • Edit the waypoints and wait for a few seconds until it is done loading.
  • Confirm the following message displays:
Screenshot 2023-09-21 at 5 22 07 PM
  • 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 / Chrome
    • iOS / native
    • iOS / 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
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web Screenshot 2023-09-22 at 11 55 02 AM
Mobile Web - Chrome Screenshot 2023-09-22 at 12 50 27 PM
Mobile Web - Safari Screenshot 2023-09-22 at 12 47 27 PM
Desktop Screenshot 2023-09-22 at 11 57 20 AM
iOS
Android Screenshot 2023-09-22 at 12 26 46 PM

@Gonals Gonals requested a review from a team as a code owner September 22, 2023 04:06
@Gonals Gonals self-assigned this Sep 22, 2023
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team September 22, 2023 04:06
@melvin-bot
Copy link

melvin-bot bot commented Sep 22, 2023

@cubuspl42 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 neil-marcellini changed the title [HOLD] Display correct message when editing distance requests [HOLD 22715] Display correct message when editing distance requests Sep 22, 2023
},
});

// Step 4: Comput the IOU total and update the report preview message (and report header) so LHN amount owed is correct.
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo?

route: {},
};

// This component is responsible for grabbing the transactionID from the IOU key
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it some magic I'm not familiar with? This component seems to do nothing beyond forwarding the route property

Copy link
Contributor

Choose a reason for hiding this comment

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

Or was this comment copy-pasted?

@cubuspl42
Copy link
Contributor

Well, it's a big one. To be honest, I'm not completely sure I'm experienced enough to review the high-level decisions here. I left minor comments and can help with the testing.

@Gonals
Copy link
Contributor Author

Gonals commented Sep 25, 2023

Well, it's a big one. To be honest, I'm not completely sure I'm experienced enough to review the high-level decisions here. I left minor comments and can help with the testing.

Ah! Don't worry too much about it. It looks big because it comes from #26141 's branch. Once that one merges, it will become simple :)

@Gonals Gonals changed the title [HOLD 22715] Display correct message when editing distance requests Display correct message when editing distance requests Sep 29, 2023
@Gonals
Copy link
Contributor Author

Gonals commented Sep 29, 2023

@cubuspl42 Ready for review! Should be waaaay simpler now 😁

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looks great, assuming the C+ testing goes well! There's one JSDoc that needs to be updated.

Comment on lines 1568 to 1576
/**
* Get the proper message schema for modified expense message.
*
* @param {String} newValue
* @param {String} oldValue
* @param {String} valueName
* @param {Boolean} valueInQuotes
* @returns {String}
*/
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this was pasted from above but you forgot to update it

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated!

@cubuspl42
Copy link
Contributor

Create a distance request in Newdot following the steps [here](https://github.com/Expensify/Web-Expensify
Confirm the following message displays:

Looks great, assuming the C+ testing goes well! There's one JSDoc that needs to be updated.

I don't have access to the steps nor the screenshot... Maybe they can be copied here?

@Gonals
Copy link
Contributor Author

Gonals commented Oct 2, 2023

Create a distance request in Newdot following the steps [here](https://github.com/Expensify/Web-Expensify
Confirm the following message displays:

Looks great, assuming the C+ testing goes well! There's one JSDoc that needs to be updated.

I don't have access to the steps nor the screenshot... Maybe they can be copied here?

Huh. Weird.

Here are the test steps:

  • Create a distance request in Newdot following the steps here. You can also try simply clicking (in a workspace chate) : + > Request Money > Distance and see if the map loads for you
  • Once it shows up in newdot, open it and click on Distance.
  • Edit the waypoints and wait for a few seconds until it is done loading.
  • Confirm the following message displays:
Screenshot 2023-09-21 at 5 22 07 PM

@cubuspl42
Copy link
Contributor

@Gonals I just don't have access to https://github.com/Expensify/Web-Expensify, but that's typical for C+ team, I think. The screenshot still doesn't work, but maybe I'll figure things out without it

@Gonals
Copy link
Contributor Author

Gonals commented Oct 2, 2023

I just don't have access to https://github.com/Expensify/Web-Expensify

Ah, gotcha! Yeah, try creating it from newDot doing + > Request Money > Distance and see if the map loads for you (it takes a few seconds). Otherwise, this is all yours, @neil-marcellini.

The message should say: changed the distance to XXXX (previously YYYY), which updated the amount to ZZZZ (previously MMMM)

@cubuspl42
Copy link
Contributor

@Gonals Would you please merge main and tell me if you are able to execute the testing steps?

I'm having trouble going past pressing "+" (I always test with latest main merged-in)

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

Looks good and tests well on web at least. In the interest of urgency I'm going to ask for another C+ in Slack to complete the checklist.

Screen.Recording.2023-10-02.at.10.47.39.AM.mov

@rushatgabhane
Copy link
Member

I'm having trouble going past pressing "+"

that is unrelated to this PR. it's a bug on main

@rushatgabhane
Copy link
Member

rushatgabhane commented Oct 2, 2023

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 image
Mobile Web - Chrome

WhatsApp Image 2023-10-03 at 00 57 18

Mobile Web - Safari image
Desktop image
iOS image
Android image

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@melvin-bot melvin-bot bot requested a review from techievivek October 2, 2023 19:29
@melvin-bot
Copy link

melvin-bot bot commented Oct 2, 2023

@techievivek 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 neil-marcellini merged commit 4d6a490 into main Oct 2, 2023
13 of 14 checks passed
@neil-marcellini neil-marcellini deleted the alberto-distMess branch October 2, 2023 22:07
@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

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

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 5, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

@JmillsExpensify
Copy link

Can I have an Expensify employee provide a payment summary so that I can get @rushatgabhane paid?

@neil-marcellini
Copy link
Contributor

Payment summary: $500 to @rushatgabhane for the PR review.

@JmillsExpensify
Copy link

$500 payment approved for @rushatgabhane based on summary above.

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.

6 participants