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

fix/15625: Workspace name is not present in header on connect bank account page #16102

Merged
merged 2 commits into from
Mar 23, 2023

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Mar 19, 2023

Details

This PR will add the workspace name in the subtitle of the Connect bank account pages

Fixed Issues

$ #15625
PROPOSAL: #15625 (comment)

Tests

  1. Open the app
  2. Open any workspace
  3. Open connect bank account
  4. Verify that the workspace name is displayed on manual step page, start over page, error page, enable page (see the below screenshot for more detail)
  • Verify that no errors appear in the JS console

Offline tests

Same above

QA Steps

  1. Open the app
  2. Open any workspace
  3. Open connect bank account
  4. Verify that the workspace name is displayed on manual step page, start over page, error page, enable page (see the below screenshot for more detail)
  • 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 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 correct English and 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
    • 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
  1. Manual Step Page
Screen Shot 2023-03-19 at 13 49 33
  1. Start Over Page
web15625-2
  1. Error Page
web15625-4
  1. Enable Page
web15625-1
Mobile Web - Chrome
  1. Manual Step Page
chrome15625-2
  1. Start Over Page
chrome15625-3
  1. Error Page
chrome15625-4
  1. Enable Page
chrome15625-1
Mobile Web - Safari
  1. Manual Step Page
Screen Shot 2023-03-19 at 13 41 49
  1. Start Over Page
Screen Shot 2023-03-19 at 13 40 38
  1. Error Page
Screen Shot 2023-03-19 at 13 47 33
  1. Enable Page
Screen Shot 2023-03-19 at 13 47 10
Desktop
  1. Manual Step Page
Screen Shot 2023-03-19 at 13 49 33
  1. Start Over Page
web15625-2
  1. Error Page
Screen Shot 2023-03-19 at 13 48 38
  1. Enable Page
web15625-3
iOS
  1. Manual Step Page
Screen Shot 2023-03-19 at 14 06 13
  1. Start Over Page
Screen Shot 2023-03-19 at 14 07 34
  1. Error Page
Screen Shot 2023-03-19 at 14 08 27
  1. Enable Page
Screen Shot 2023-03-19 at 14 08 14
Android
  1. Manual Step Page
Screen Shot 2023-03-19 at 14 22 43
  1. Start Over Page
chrome15625-3
  1. Error Page
Screen Shot 2023-03-19 at 14 21 54
  1. Enable Page
Screen Shot 2023-03-19 at 14 22 19

@tienifr tienifr marked this pull request as ready for review March 22, 2023 01:39
@tienifr tienifr requested a review from a team as a code owner March 22, 2023 01:39
@melvin-bot melvin-bot bot requested review from mollfpr and mountiny and removed request for a team March 22, 2023 01:39
@MelvinBot
Copy link

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

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

Nicely done on this PR @tienifr.

Just a couple of comments on the prop types.

@@ -44,6 +44,9 @@ const propTypes = {
/** Is the user account validated? */
validated: PropTypes.bool,
}),

/* The workspace name */
policyName: PropTypes.string.isRequired,
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we need policyName to be required. The page still accessible without providing policyID to the route params.

Copy link
Contributor Author

@tienifr tienifr Mar 22, 2023

Choose a reason for hiding this comment

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

@mollfpr I just removed required and add the default policyName in all places. Could you help to review again?

@@ -37,6 +36,9 @@ const propTypes = {
name: PropTypes.string,
}).isRequired,

/* The workspace name */
policyName: PropTypes.string.isRequired,
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as the above.

@@ -31,6 +32,9 @@ const propTypes = {
/* Onyx Props */
user: userPropTypes.isRequired,

/* The workspace name */
policyName: PropTypes.string.isRequired,
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as the above.

@mollfpr
Copy link
Contributor

mollfpr commented Mar 22, 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 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 correct English and 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 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
Bank Account New Bank Account Start Over Bank Account Enable Bank Account Error
16102 Web - New 16102 Web - Start over 16102 Web - Enable 16102 Web - Error
Mobile Web - Chrome
Bank Account New Bank Account Start Over Bank Account Enable Bank Account Error
16102 mWeb:Chrome - New 16102 mWeb:Chrome - Start over 16102 mWeb:Chrome - Enable 16102 mWeb:Chrome - Error
Mobile Web - Safari
Bank Account New Bank Account Start Over Bank Account Enable Bank Account Error
16102 mWeb:Safari - New 16102 mWeb:Safari - Start over 16102 mWeb:Safari - Enable 16102 mWeb:Safari - Error
Desktop
Bank Account New Bank Account Start Over Bank Account Enable Bank Account Error
16102 Desktop - New 16102 Desktop - Start over 16102 Desktop - Enable 16102 Desktop - Error
iOS
Bank Account New Bank Account Start Over Bank Account Enable Bank Account Error
16102 iOS - New 16102 iOS - Start over 16102 iOS - Enable 16102 iOS - Error
Android
Bank Account New Bank Account Start Over Bank Account Enable Bank Account Error
16102 Android - New 16102 Android - Start over 16102 Android - Enable 16102 Android - Error

mollfpr

This comment was marked as duplicate.

Copy link
Contributor

@mollfpr mollfpr left a comment

Choose a reason for hiding this comment

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

Well done @tienifr and thanks for raising the PR quickly 👍

@mountiny Tests well and all yours.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 23, 2023

@mountiny Can you take a look at this PR and provide feedback?

@mountiny
Copy link
Contributor

Yes, had to restart the PR reviewer checklist job.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thank you @tienifr and @mollfpr

@mountiny mountiny merged commit fb90cd8 into Expensify:main Mar 23, 2023
@OSBotify
Copy link
Contributor

✋ 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

🚀 Deployed to staging by https://github.com/mountiny in version: 1.2.89-0 🚀

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

@kavimuru
Copy link

@tienifr How to trigger that error page?

226159844-dea7f679-0a0e-4856-a667-2567f0876b2d

@mountiny
Copy link
Contributor

@tienifr can you help with that?

@kavimuru even if you cant access it, I believe its same to assume this works for the error page if it works for the other pages too

@kavimuru
Copy link

@mountiny Yes it works in other pages.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 27, 2023

@kavimuru Sorry for my lateness. I see that there are 2 ways to access the error page

  1. The field session.email has a value that ends with @expensify.sms

Screen Shot 2023-03-27 at 11 16 02

  1. Field throttedDate in the reimbursementAccount field in ONYX has value

Screen Shot 2023-03-27 at 11 14 14

cc @mountiny @mollfpr

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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

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