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.

Sign up for GitHub

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

Jump to bottom

Disabled distance rate is present in the rate list in confirmation p #42330

Merged
merged 15 commits into from
Jun 4, 2024
Merged

Disabled distance rate is present in the rate list in confirmation p #42330

merged 15 commits into from
Jun 4, 2024

Conversation

cretadn22
Copy link
Contributor

@cretadn22 cretadn22 commented May 17, 2024 •
edited
Loading

Details

Defaulting distance rate to the first enabled when the Rate field is not shown (users with betas disabled).
Not displaying the disabled distance rates in the Rate field list (users with betas enabled).

Fixed Issues

$ #42284
PROPOSAL: #42284 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Test 1

Precondition: User does NOT have betas enabled, hence no Rate field will be displayed in Distance confirmation page.

  1. Log in and go to Collect workspace settings.
  2. Enable and go to Distance rates.
  3. Click [+ Add rate].
  4. Add a new rate and make sure it's Enabled.
  5. Disable previously existing rate (default $0.670 / mile).
  6. Go to workspace chat.
  7. Start submitting a Distance request.
  8. On Distance confirmation page, verify that the enabled rate is set as default in the Distance field (see below).
Screenshot 2024-05-29 at 14 10 59

Test 2

Precondition: User does has betas enabled, hence the Rate field will be displayed in Distance confirmation page.

  1. Log in and go to Collect workspace settings.
  2. Enable and go to Distance rates.
  3. Click [+ Add rate].
  4. Add a new rate and make sure it's Enabled.
  5. Disable previously existing rate (default $0.670 / mile).
  6. Go to workspace chat.
  7. Start submitting a Distance request.
  8. On Distance confirmation page, verify that the enabled rate is set as default in the Rate field (see [1.]).
  9. On Distance confirmation page, click on the Rate field and verify that the disabled rate is not displayed (see [2.]).
09 21 50
  • 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
Screen.Recording.2024-05-29.at.23.28.03.mp4
Android: mWeb Chrome
Screen.Recording.2024-05-29.at.23.23.04.mp4
iOS: Native
Screen.Recording.2024-05-29.at.23.27.08.mp4
iOS: mWeb Safari
Screen.Recording.2024-05-29.at.23.48.08.mp4
MacOS: Chrome / Safari
CDLA-1.mp4
MacOS: Desktop
Screen.Recording.2024-05-29.at.23.22.29.mp4

@cretadn22 cretadn22 mentioned this pull request May 17, 2024
Closed
6 tasks
@cretadn22 cretadn22 marked this pull request as ready for review May 29, 2024 15:27
@cretadn22 cretadn22 requested a review from a team as a code owner May 29, 2024 15:27
@melvin-bot melvin-bot bot requested review from ikevin127 and removed request for a team May 29, 2024 15:27
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented May 29, 2024

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

@ikevin127
Copy link
Contributor

@cretadn22 Regarding the PR description tests, I'd be more specific so the QA team has a better understanding of the changes and what to test.

Note: Here's the pastebin so you can easily copy & paste the below steps in your PR's description.

Tip

Test 1

Precondition: User does NOT have betas enabled, hence no Rate field will be displayed in Distance confirmation page.

  1. Log in and go to Collect workspace settings.
  2. Enable and go to Distance rates.
  3. Click [+ Add rate].
  4. Add a new rate and make sure it's Enabled.
  5. Disable previously existing rate (default $0.670 / mile).
  6. Go to workspace chat.
  7. Start submitting a Distance request.
  8. On Distance confirmation page, verify that the enabled rate is set as default in the Distance field (see below).
Screenshot 2024-05-29 at 14 10 59

Test 2

Precondition: User does has betas enabled, hence the Rate field will be displayed in Distance confirmation page.

  1. Log in and go to Collect workspace settings.
  2. Enable and go to Distance rates.
  3. Click [+ Add rate].
  4. Add a new rate and make sure it's Enabled.
  5. Disable previously existing rate (default $0.670 / mile).
  6. Go to workspace chat.
  7. Start submitting a Distance request.
  8. On Distance confirmation page, verify that the enabled rate is set as default in the Rate field (see [1.]).
  9. On Distance confirmation page, click on the Rate field and verify that the disabled rate is not displayed (see [2.]).
1 2
1 2

@ikevin127
Copy link
Contributor

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
android-mweb.mov
iOS: Native
iOS: mWeb Safari
ios-mweb.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@ikevin127
Copy link
Contributor

@cretadn22 I will ✅ Approve once the 2 comments (#42330 (comment) and #42330 (comment)) are addressed.

Note: Please don't force-push anymore as this goes against the guidelines, see Submit your pull request for final review:

  1. Please never force push when a PR review has already started (because this messes with the PR review history)

@cretadn22
Copy link
Contributor Author

@ikevin127 Thanks for your comments, It will greatly assist me in future PRs.

ikevin127
ikevin127 approved these changes May 30, 2024
View reviewed changes
Copy link
Contributor

@ikevin127 ikevin127 left a comment

Choose a reason for hiding this comment

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

@cretadn22 Sure, thanks for promptly updating the PR!

Just a note regarding the PR description tests -> it's missing the picture from Test 1 under step (8.):

<img width="360" alt="Screenshot 2024-05-29 at 14 10 59" src="https://github.com/Expensify/App/assets/56457735/fad564df-1bf3-4998-ac65-b402f2d1da69">

@melvin-bot melvin-bot bot requested a review from neil-marcellini May 30, 2024 02:44
neil-marcellini
neil-marcellini requested changes May 30, 2024
View reviewed changes
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.

Overall looks really good, thanks! I'm requesting changes for a couple small clean up items.

@cretadn22
Copy link
Contributor Author

@neil-marcellini Your comments make sense, I made an update to address your suggestion

neil-marcellini
neil-marcellini requested changes May 31, 2024
View reviewed changes
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.

Thanks for the updates, looking really close. Two more small things @cretadn22

@cretadn22
Copy link
Contributor Author

@neil-marcellini I addressed your comment and removed the description of getMileageRates function

@cretadn22
Copy link
Contributor Author

@neil-marcellini Hi, Wdyt about my update?

@neil-marcellini
Copy link
Contributor

Hi, sorry I lost track of this. I plan to review today or tomorrow.

neil-marcellini
neil-marcellini approved these changes Jun 4, 2024
View reviewed changes
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.

Great work, thanks!

@neil-marcellini neil-marcellini merged commit 6197a82 into Expensify:main Jun 4, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jun 4, 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.

@github-actions github-actions bot mentioned this pull request Jun 6, 2024
Closed
@MonilBhavsar
Copy link
Contributor

@cretadn22 @ikevin127 @neil-marcellini this PR most probably is causing this crash. Can anyone please take a look. Thanks!

#43171

@MonilBhavsar MonilBhavsar mentioned this pull request Jun 6, 2024
Closed
6 tasks
@MonilBhavsar
Copy link
Contributor

A small feedback here - The PR title can be more descriptive so one can find the PR from the list of deployed PR's

@ikevin127
Copy link
Contributor

ikevin127 commented Jun 6, 2024 •
edited
Loading

@cretadn22 Can you please edit the PR title here on tgithub to match the issue's title, like:
Disabled distance rate is present in the rate list in confirmation page

Also it's possible that this PR caused these regressions: #43197 and #43171. Can you confirm if those two were caused by this PR's code changes ?

You can do this by changing the code back to what it was before (locally) and checking if the issues are still occuring.

@cretadn22 cretadn22 changed the title update rate list Disabled distance rate is present in the rate list in confirmation p Jun 6, 2024
@neil-marcellini neil-marcellini mentioned this pull request Jun 6, 2024
Closed
@OSBotify
Copy link
Contributor

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@neil-marcellini neil-marcellini neil-marcellini approved these changes

@ikevin127 ikevin127 ikevin127 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@cretadn22 @ikevin127 @neil-marcellini @OSBotify @MonilBhavsar