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

[GR Phase 2] Step 5 Director information screen (without API calls) - implementation #51648

Open
wants to merge 29 commits into
base: main
Choose a base branch
from

Conversation

burczu
Copy link
Contributor

@burczu burczu commented Oct 29, 2024

Details

This PR contains implementation of step 5 (Director information screen) - GR phase 2.

Design doc section: https://docs.google.com/document/d/1Y4P7G9h0Easjcea7wyk52gKrNB9o1yTjpmJFYkrHDW4/edit?tab=t.0#bookmark=id.damtu6jbu35v

Fixed Issues

$ #50901
PROPOSAL: n/a

Tests

  1. Log in to the app
  2. Open Workspace with Workflows feature enabled
  3. Tap on "Connect bank account" inside the "Make or track payments" section
  4. Go to the 5th step of the flow
  5. Test the flow
  • Verify that no errors appear in the JS console

Offline tests

Same as above.

QA Steps

Same as 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
    • 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-11-13.at.12.36.26.mov
Android: mWeb Chrome
Screen.Recording.2024-11-13.at.12.40.06.mov
iOS: Native
Screen.Recording.2024-11-13.at.12.20.07.mov
iOS: mWeb Safari
Screen.Recording.2024-11-13.at.12.23.15.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-13.at.12.13.01.mov
MacOS: Desktop
Screen.Recording.2024-11-13.at.12.18.37.mov

@burczu burczu force-pushed the feat/50901-GR-step-5-director-information-screen branch 4 times, most recently from 040bcf1 to f1c90fa Compare November 5, 2024 07:41
@burczu burczu force-pushed the feat/50901-GR-step-5-director-information-screen branch from f1c90fa to d7fd35e Compare November 6, 2024 06:10
@burczu burczu marked this pull request as ready for review November 6, 2024 12:02
@burczu burczu requested review from a team as code owners November 6, 2024 12:02
@melvin-bot melvin-bot bot requested a review from hungvu193 November 6, 2024 12:02
Copy link

melvin-bot bot commented Nov 6, 2024

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

@melvin-bot melvin-bot bot removed the request for review from a team November 6, 2024 12:02
@dannymcclain
Copy link
Contributor

I wasn't super involved with this, so we should probably wait for the other members of @Expensify/design to weigh in here, but generally this looks pretty good. A few questions/comments:

  • What size are the radio check circles? They look a little small to me? In Figma they're 28x28px
  • Seems like there's some weirdness going on with the attachment selector on iOS—any idea what's going on there?
  • The attachment preview looks pretty borked when the file name is really long (icon gets pushed out of the container, the file name doesn't truncate, etc)
    • Is that something we need to handle here or is that being dealt with elsewhere?
  • I think all the single input screens (legal name, job title) need to autofocus the input when you get to them (for the first time or any subsequent time)—that's how we typically handle inputs like that

@shawnborton
Copy link
Contributor

shawnborton commented Nov 6, 2024

Feeling good! I have the same feedback as Danny above regarding the checkbox size.

Then for this screen, the blue link looks like it's not left-aligned the same way the others are:
CleanShot 2024-11-06 at 15 49 38@2x

Then for this screen, it feels like the input could be a bit closer to the headline?
CleanShot 2024-11-06 at 15 50 38@2x

@dubielzyk-expensify
Copy link
Contributor

dubielzyk-expensify commented Nov 7, 2024

Then for this screen, it feels like the input could be a bit closer to the headline?

This goes for the legal name screen too

@hungvu193
Copy link
Contributor

@burczu would you mind addressing these advices from design team above? ty

@burczu
Copy link
Contributor Author

burczu commented Nov 8, 2024

@hungvu193 yes, on it!

@hungvu193
Copy link
Contributor

hungvu193 commented Nov 11, 2024

Error message is too close to the Upload file component.

Screenshot 2024-11-11 at 10 40 08

@burczu
Copy link
Contributor Author

burczu commented Nov 13, 2024

Infinite loop when pressing back between LegalName and Email page.

fixed

@burczu
Copy link
Contributor Author

burczu commented Nov 13, 2024

On Native platform, the attachment icon is out of the border.

fixed

@hungvu193
Copy link
Contributor

Nice. I'll verify it shortly

@hungvu193
Copy link
Contributor

@burczu Can you also update the screenshots/videos so Design team can review the UI?

@burczu
Copy link
Contributor Author

burczu commented Nov 13, 2024

@burczu Can you also update the screenshots/videos so Design team can review the UI?

I will, but still I have few things here to address, so I'll do it once its all done. I think you can wait till then with verification - I'll post a separate comment that's it ready to re-review.

@hungvu193
Copy link
Contributor

@burczu Can you also update the screenshots/videos so Design team can review the UI?

I will, but still I have few things here to address, so I'll do it once its all done. I think you can wait till then with verification - I'll post a separate comment that's it ready to re-review.

Cool. Let me know when it's ready for another review. Ty

@burczu
Copy link
Contributor Author

burczu commented Nov 13, 2024

@dannymcclain Answering your comments:

I wasn't super involved with this, so we should probably wait for the other members of @Expensify/design to weigh in here, but generally this looks pretty good. A few questions/comments:

  • What size are the radio check circles? They look a little small to me? In Figma they're 28x28px

Good point - fixed.

  • Seems like there's some weirdness going on with the attachment selector on iOS—any idea what's going on there?

I think this is because of the simulator, I believe this will work correctly on real device.

  • The attachment preview looks pretty borked when the file name is really long (icon gets pushed out of the container, the file name doesn't truncate, etc)

    • Is that something we need to handle here or is that being dealt with elsewhere?

This is related to what @hungvu193 pointed out here too - fixed.

  • I think all the single input screens (legal name, job title) need to autofocus the input when you get to them (for the first time or any subsequent time)—that's how we typically handle inputs like that

Added autofocus to sile input screens.

@burczu
Copy link
Contributor Author

burczu commented Nov 13, 2024

@shawnborton Answering your comments:

Feeling good! I have the same feedback as Danny above regarding the checkbox size.

Then for this screen, the blue link looks like it's not left-aligned the same way the others are:

Good point. Fixed.

Then for this screen, it feels like the input could be a bit closer to the headline?

Yes. Fixed

@burczu
Copy link
Contributor Author

burczu commented Nov 13, 2024

@hungvu193 I think I've addressed all the comments - you can now re-review the PR. Videos also are updated now.

@hungvu193
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
Screen.Recording.2024-11-11.at.13.32.38.mov
Android: mWeb Chrome
Screen.Recording.2024-11-11.at.11.18.32.mov
iOS: Native
Screen.Recording.2024-11-11.at.11.10.09.mov
iOS: mWeb Safari
Screen.Recording.2024-11-11.at.10.56.48.mov
MacOS: Chrome / Safari
Screen.Recording.2024-11-11.at.10.47.27.mov
MacOS: Desktop
Screen.Recording.2024-11-11.at.10.46.15.mov

@hungvu193
Copy link
Contributor

@burczu LGTM. I think we only have translations left

@hungvu193 hungvu193 mentioned this pull request Nov 14, 2024
49 tasks
@burczu
Copy link
Contributor Author

burczu commented Nov 14, 2024

@hungvu193 asked for confirmation on translations here: https://callstack-hq.slack.com/archives/C01GTK53T8Q/p1731572554005439

@burczu
Copy link
Contributor Author

burczu commented Nov 14, 2024

@hungvu193 spanish translations reviewed and updated

Copy link
Contributor

@hungvu193 hungvu193 left a comment

Choose a reason for hiding this comment

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

LGTM

@melvin-bot melvin-bot bot requested a review from madmax330 November 14, 2024 10:30
containerStyles?: StyleProp<ViewStyle>;
};

function WhyLink({containerStyles}: WhyLinkProps) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This component was already added in @pasyukevich's PR here: https://github.com/Expensify/App/pull/52054/files

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh It was merged recently, I didn't notice it during this PR review process

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, it disappeared from this PR after I've synced it with the latest main

@burczu burczu force-pushed the feat/50901-GR-step-5-director-information-screen branch from fcd83e9 to 418fbd7 Compare November 14, 2024 12:30
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