App icon indicating copy to clipboard operation
App copied to clipboard

Fix: Initial focus in WorkspaceCompanyCardAccountSelectCardPage

Open waterim opened this issue 1 year ago • 11 comments

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/51891 $ https://github.com/Expensify/App/pull/52575#issuecomment-2501780310 PROPOSAL: N/A

Tests

  1. Choose the workspace from settings
  2. Click company cards > Card Details
  3. Verify that default export account is presented in Export row - with name "Default card"
  4. Click on the "Default card option"
  5. Click on 'export option' > Export company card expenses as > Export as
  6. Change on another value
  7. Get back to the export accounts page
  8. See that focus was correctly set on the "Default card"
  • [x] Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

None

  • [X] Verify that no errors appear in the JS console

PR Author Checklist

  • [X] I linked the correct issue in the ### Fixed Issues section above
  • [X] I wrote clear testing steps that cover the changes made in this PR
    • [X] I added steps for local testing in the Tests section
    • [X] I added steps for the expected offline behavior in the Offline steps section
    • [X] I added steps for Staging and/or Production testing in the QA steps section
    • [X] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [X] 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)
    • [X] 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).
  • [X] I included screenshots or videos for tests on all platforms
  • [X] I ran the tests on all platforms & verified they passed on:
    • [X] Android / native
    • [X] Android / Chrome
    • [X] iOS / native
    • [x] iOS / Safari
    • [X] MacOS / Chrome / Safari
    • [X] MacOS / Desktop
  • [X] 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)
  • [X] I followed proper code patterns (see Reviewing the code)
    • [X] 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)
    • [X] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [X] I verified that comments were added to code that is not self explanatory
    • [X] 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.
    • [X] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [X] 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:
    • [X] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [X] 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.
    • [X] 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.
    • [X] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [X] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [X] I followed the guidelines as stated in the Review Guidelines
  • [X] 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)
  • [X] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [X] 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
  • [X] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [X] If a new component is created I verified that:
    • [X] A similar component doesn't exist in the codebase
    • [X] All props are defined accurately and each prop has a /** comment above it */
    • [X] The file is named correctly
    • [X] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [X] The only data being stored in the state is data necessary for rendering and nothing else
    • [X] 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
    • [X] 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)
    • [X] 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)
    • [X] All JSX used for rendering exists in the render method
    • [X] 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
  • [X] If any new file was added I verified that:
    • [X] 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
  • [X] If a new CSS style is added I verified that:
    • [X] A similar style doesn't already exist
    • [X] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • [X] 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.
  • [X] 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)
  • [X] 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.
  • [X] 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.
  • [X] 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.
  • [X] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

https://github.com/user-attachments/assets/97fe2100-72d7-4f81-b0d0-8caa07463798

waterim avatar Dec 03 '24 01:12 waterim

@DylanDylann 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[bot] avatar Dec 03 '24 01:12 melvin-bot[bot]

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] 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
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

DylanDylann avatar Dec 03 '24 05:12 DylanDylann

I can't test this PR directly, because it requires an auth QBO account that has cards. So I used another way to test this problem

Disable this line: https://github.com/Expensify/App/blob/b80c68ea76cdf825d9331bbf298cc41b40716037/src/pages/workspace/companyCards/WorkspaceCompanyCardAccountSelectCardPage.tsx#L71

And make sure that the background highlight is updated when we select another option

https://github.com/user-attachments/assets/6e806c28-47f8-405e-9397-f602a8eb7db8

DylanDylann avatar Dec 03 '24 05:12 DylanDylann

@waterim with this setup, I see a problem

https://github.com/user-attachments/assets/1d9e8a67-8268-464e-a312-bd826d78a617

We also need to address this problem. It is also similar to the reported bug

DylanDylann avatar Dec 03 '24 09:12 DylanDylann

Checking it, yesterday Callstack had full-day meeting

waterim avatar Dec 04 '24 10:12 waterim

@DylanDylann My update: Still sitting and trying to understand why focus index in some point goes to -1 while Im passing prop to prevent it

waterim avatar Dec 04 '24 21:12 waterim

Hmm, I am not sure if this bug will happen from the client side (it was caused for me when I hard-code to reproduce the bug) @mountiny Could you help to run a build and @joekaufmanexpensify can test this from his side

DylanDylann avatar Dec 06 '24 09:12 DylanDylann

Yep, happy to help test with an ad-hoc bulld!

joekaufmanexpensify avatar Dec 06 '24 13:12 joekaufmanexpensify

Hmm, makes sense, let try like this, but Im still wondering why prop for preventing refocus just drops after switching debit to credit and from credit to debit in offline mode and getting back(but that happens only for the first time, hard to reproduce)

Also its possible that issue is not reproducible with real data for credit card, I cant test it fully as I was able to mock only debit cards

Let it test with adhoc build, thank you @joekaufmanexpensify @mountiny

waterim avatar Dec 06 '24 21:12 waterim

🚧 @mountiny has triggered a test build. You can view the workflow run here.

github-actions[bot] avatar Dec 08 '24 23:12 github-actions[bot]

:test_tube::test_tube: Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! :test_tube::test_tube:

Android :robot: iOS :apple:
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/53418/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53418/index.html
Android iOS
Desktop :computer: Web :spider_web:
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/53418/NewExpensify.dmg https://53418.pr-testing.expensify.com
Desktop Web

:eyes: View the workflow run that generated this build :eyes:

github-actions[bot] avatar Dec 09 '24 00:12 github-actions[bot]

@waterim Any new update? It seems we need implement a new logic to handle this case

DylanDylann avatar Dec 11 '24 08:12 DylanDylann

@DylanDylann trying to fix it, this one is a bit tricky and couldn't find good solution for now, continuing working!

waterim avatar Dec 11 '24 12:12 waterim

@DylanDylann Updated PR with new prop shouldResetFocusedIndex to reset index on changing export type to 0(default card), not to -1 as we had previously each time we changed export type

waterim avatar Dec 12 '24 01:12 waterim

@DylanDylann what is your ETA?

mountiny avatar Dec 12 '24 15:12 mountiny

@mountiny we are discussing on Slack

DylanDylann avatar Dec 12 '24 15:12 DylanDylann

@waterim Are we good to close this PR?

DylanDylann avatar Dec 18 '24 05:12 DylanDylann