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

Block activation of primary buttons on background screens #8802

Merged
merged 8 commits into from
May 2, 2022

Conversation

parasharrajat
Copy link
Member

@parasharrajat parasharrajat commented Apr 27, 2022

Details

Fixed Issues

$ #7623

Tests

  1. Open two RHN modals and test that pressing enter does not trigger callback for background RHN screen.
  2. Test the StoryBook that all pages are opening properly.
  • Verify that no errors appear in the JS console

Contributor (PR Author) Checklist

  • I verified the PR has a small number of commits behind main
  • 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 clearly indicated the environment tests should be run in (Staging vs Production)
  • I wrote testing steps that cover success & fail scenarios (if applicable)
  • I included screenshots or videos for tests on all platforms
  • I ran the tests & veryfy they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • MacOS / Desktop
  • I verified there are no console errors related to changes in this PR
  • I followed proper code patterns (see Reviewing the code)
    • I added comments when the code was not self explanatory
    • I put all copy / text shown in the product in all src/languages/* files (if applicable)
    • I followed proper naming convention for platform-specific files (if applicable)
    • I followed style guidelines (in Styling.md) for all style edits I made
    • I followed the JSDocs style guidelines (in STYLE.md)
  • 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 corroborated the UI performance was not affected (the performance is the same than main branch)
  • If I created a new component I verified that a similar component doesn't exist in the codebase

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 was added in all src/languages/* files
    • I verified any copy / text that was added to the app is correct english and approved by marketing by tagging the marketing team 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 are not impacted by changes in this PR (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
  • I verified any variables that can be defined as constants (ie. in CONST.js) 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 */
    • Any functional components have the displayName property
    • 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
    • Any internal methods are bound to “this” properly so there are no scoping issues
    • Any internal methods bound to “this” are necessary to be bound
    • 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 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)

QA Steps

  1. Open any Workspace then its general settings.
  2. Go to the Get assistance page via clicking ? on header.
  3. Click on Request a setup Call.
  4. Select any field and press Enter/Return.
  5. Observer that it does not trigger save on Workspace general settings page And request a call is triggered.
  6. Close Request a call page.
  7. Press enter and observe that Workspace save operation is triggered.

  1. Open Storybook at https://staging.new.expensify.com/docs/index.html. Check that Button Story is working fine.

  1. Logout from the app on the web.
  2. Login back and observe that you are able to login.
  • Verify that no errors appear in the JS console

Screenshots

Mobile Web

image

Desktop | Web

screen-2022-03-22_23.38.43.mp4

iOS

image

Android

image

Storybook

image

@parasharrajat parasharrajat requested a review from a team as a code owner April 27, 2022 17:26
@melvin-bot melvin-bot bot requested review from thienlnam and removed request for a team April 27, 2022 17:26
Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Changes look good, just have a comment withNavigationFocus. Can we add tests to make sure we don't fail the error boundary as well?

export default Button;
export default compose(
withNavigationFallback,
withNavigationFocus,
Copy link
Contributor

Choose a reason for hiding this comment

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

What does the withNavigationFocus do here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, I forgot to push the final commit. Good catch.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm still not seeing how it is used, could you explain please?

Copy link
Member Author

Choose a reason for hiding this comment

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

this HOC gives is a new prop called isFocused and we are using that to determine if the button is visible on the currently focused/active screen. This way all the buttons on the backgrounded screens will not trigge with enter press.

@parasharrajat
Copy link
Member Author

Can we add tests to make sure we don't fail the error boundary as well?

these are covered with StoryBook tests. Other than this, I don't QA will be able to test Error UI unless there is a app crash.

@thienlnam
Copy link
Contributor

Tests well on web, running into issue building storybook but seems unrelated to this change

@thienlnam
Copy link
Contributor

Open Storybook at taging.new.expensify.com/docs/index.html. Check that Button Story is working fine.

Link needs to be updated

Also can you add a SC for the storybook build? Running into an issue with @react-native-community/netinfo/jest/netinfo-mock when trying to run storybook

Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

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

Approved pending storybook screenshots

@parasharrajat
Copy link
Member Author

@thienlnam I reported the issue about storybook https://expensify.slack.com/archives/C01GTK53T8Q/p1651081332743029.

We will have to apply this fix https://expensify.slack.com/archives/C01GTK53T8Q/p1651082528577659?thread_ts=1651081332.743029&cid=C01GTK53T8Q to fix the stories. This is out of scope for this PR.

@parasharrajat
Copy link
Member Author

Updated.

@thienlnam
Copy link
Contributor

Cool cool thanks!

@thienlnam thienlnam merged commit f1e891f into Expensify:main May 2, 2022
@OSBotify
Copy link
Contributor

OSBotify commented May 2, 2022

✋ 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

OSBotify commented May 9, 2022

🚀 Cherry-picked to staging by @sketchydroide in version: 1.1.57-8 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @chiragsalian in version: 1.1.57-17 🚀

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.

4 participants