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

onKeyDown added to Textlink component #12034

Merged
merged 14 commits into from
Nov 3, 2022

Conversation

dhairyasenjaliya
Copy link
Contributor

@dhairyasenjaliya dhairyasenjaliya commented Oct 20, 2022

Details

Fixed Issues

$ #11354
PROPOSAL: #11354 (comment)

Tests

  1. Go to staging.new.expensify.com
  2. Login with the account
  3. Send PDF protected file
  4. Click on the PDF file
  5. Use the Tab key to navigate to Enter the Password name
  6. Click Enter
  7. Notice On pressing Enter Password modal should open
  • Verify that no errors appear in the JS console

QA Steps

  1. Go to staging.new.expensify.com
  2. Login with the account
  3. Send PDF protected file
  4. Click on the PDF file
  5. Use the Tab key to navigate to Enter the Password name
  6. Click Enter
  7. Notice On pressing Enter Password modal should open
  • Verify that no errors appear in the JS console

PR Review Checklist

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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed 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 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 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 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
  • 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 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.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

  • 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots

Web

Chrome
https://user-images.githubusercontent.com/47522946/196866996-1498e6fd-e578-48e0-a690-8b283c839d5a.mov

Safari
https://user-images.githubusercontent.com/47522946/196867024-5c4461fb-4eec-4314-a537-588b49ad0ab8.mov

Mobile Web - Chrome

M-Chrome

Mobile Web - Safari

Desktop

Desktop.mov

iOS

Android

@dhairyasenjaliya dhairyasenjaliya marked this pull request as ready for review October 20, 2022 05:56
@dhairyasenjaliya dhairyasenjaliya requested a review from a team as a code owner October 20, 2022 05:56
@melvin-bot melvin-bot bot requested review from eVoloshchak and tgolen and removed request for a team October 20, 2022 05:56
src/components/TextLink.js Outdated Show resolved Hide resolved
src/components/TextLink.js Outdated Show resolved Hide resolved
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

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

I like how this was combined into a single method now 👍

src/components/TextLink.js Outdated Show resolved Hide resolved
@dhairyasenjaliya
Copy link
Contributor Author

dhairyasenjaliya commented Oct 25, 2022

I found one issue in this condition for native it's not pressable I'm fixing that
@tgolen for web and m-web we are getting events like click and enter key events but for native we are not getting them, so should we create platform-specific index files for <TextLink> or maybe just add condition only on onMouseDown

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Oct 26, 2022

@dhairyasenjaliya
We should create platform-specific files as per README.md

The same structure all of the components are using, for example, PopoverMenu

Screenshot 2022-10-26 at 17 54 24

@dhairyasenjaliya
Copy link
Contributor Author

dhairyasenjaliya commented Oct 27, 2022

hello, For now, we have 2 options

  1. To create a platform-specific index

  2. To add conditions into onKeyDown like below

onKeyDown={(e) => {
    if (e.key !== 'Enter') {
        return;
    }
    handlePress(e);
}}      
  • I'm happy to proceed with any options from above just wanted to confirm with you guys @eVoloshchak @tgolen

@tgolen
Copy link
Contributor

tgolen commented Oct 27, 2022

I'd be fine with using option 2. As long as we don't have anything like Platform.OS === whatever

@dhairyasenjaliya
Copy link
Contributor Author

option 2 added @tgolen @eVoloshchak

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Oct 31, 2022

Screenshots

Web

Screen.Recording.2022-10-31.at.14.49.29.mov

Mobile Web - Chrome

Screen.Recording.2022-10-31.at.15.52.23.mov

Mobile Web - Safari

Screen.Recording.2022-10-31.at.15.54.47.mov

Desktop

Screen.Recording.2022-10-31.at.14.50.38.mov

iOS

Simulator Screen Shot - iPhone 12 - 2022-11-02 at 16 42 56

It's not possible to select a link with Tab on native platforms

Android

Screenshot_20221102_164303

It's not possible to select a link with Tab on native platforms

@eVoloshchak
Copy link
Contributor

@dhairyasenjaliya, could you please re-test native platforms? It looks like this for me, which is not how it looks on web/desktop. Make sure to merge the latest changes from main.

Screenshot_20221031_161113

Simulator Screen Shot - iPhone 12 - 2022-10-31 at 16 08 18

src/components/TextLink.js Outdated Show resolved Hide resolved
src/components/TextLink.js Outdated Show resolved Hide resolved
@dhairyasenjaliya
Copy link
Contributor Author

@dhairyasenjaliya, could you please re-test native platforms? It looks like this for me, which is not how it looks on web/desktop. Make sure to merge the latest changes from main.

Screenshot_20221031_161113

Simulator Screen Shot - iPhone 12 - 2022-10-31 at 16 08 18

hm weird let me check in the latest main might be any other PR causing regression!

@dhairyasenjaliya
Copy link
Contributor Author

@eVoloshchak native platform has an issue in the main branch same as you posted a screenshot, you can check even without this PR I think we can post this issue in slack since this was working fine recently these changes so I do think this might be a regression from other PR

src/components/TextLink.js Outdated Show resolved Hide resolved
@eVoloshchak
Copy link
Contributor

@eVoloshchak native platform has an issue in the main branch same as you posted a screenshot, you can check even without this PR I think we can post this issue in slack since this was working fine recently these changes so I do think this might be a regression from other PR

You are right, retested all platforms, updated the screenshots.
It's not possible to select a link using Tab navigation on native platforms, is it the same for you?

Co-authored-by: e_voloshchak <copyreading@gmail.com>
@dhairyasenjaliya
Copy link
Contributor Author

@eVoloshchak native platform has an issue in the main branch same as you posted a screenshot, you can check even without this PR I think we can post this issue in slack since this was working fine recently these changes so I do think this might be a regression from other PR

You are right, retested all platforms, updated the screenshots. It's not possible to select a link using Tab navigation on native platforms, is it the same for you?

yeah this is available only for web

@eVoloshchak
Copy link
Contributor

eVoloshchak commented Nov 2, 2022

LGTM!
cc: @tgolen

Screenshots

Web

Screen.Recording.2022-10-31.at.14.49.29.mov

Mobile Web - Chrome

Screen.Recording.2022-10-31.at.15.52.23.mov

Mobile Web - Safari

Screen.Recording.2022-10-31.at.15.54.47.mov

Desktop

Screen.Recording.2022-10-31.at.14.50.38.mov

iOS

Simulator Screen Shot - iPhone 12 - 2022-11-02 at 16 42 56

It's not possible to select a link with Tab on native platforms

Android

Screenshot_20221102_164303

It's not possible to select a link with Tab on native platforms

PR 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:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 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 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.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

eVoloshchak
eVoloshchak previously approved these changes Nov 2, 2022
src/components/TextLink.js Outdated Show resolved Hide resolved
src/components/TextLink.js Outdated Show resolved Hide resolved
Co-authored-by: Tim Golen <tgolen@gmail.com>
@dhairyasenjaliya
Copy link
Contributor Author

dhairyasenjaliya commented Nov 3, 2022

@tgolen any changes remaining from my side?

@eVoloshchak
Copy link
Contributor

@dhairyasenjaliya, I think this comment is not addressed yet
I agree, we should avoid using anonymous functions inside the JSX

@dhairyasenjaliya
Copy link
Contributor Author

@dhairyasenjaliya, I think this comment is not addressed yet I agree, we should avoid using anonymous functions inside the JSX

ah I missed that let me take a look at it

@dhairyasenjaliya
Copy link
Contributor Author

@tgolen @eVoloshchak have moved the callback to openLinkIfEnterKeyPressed is that correct or am I missing something?

src/components/TextLink.js Outdated Show resolved Hide resolved
src/components/TextLink.js Outdated Show resolved Hide resolved
Copy link
Contributor

@eVoloshchak eVoloshchak left a comment

Choose a reason for hiding this comment

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

cc: @tgolen

Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

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

Looks great, thank you!

@tgolen tgolen merged commit 1dd7174 into Expensify:main Nov 3, 2022
@melvin-bot melvin-bot bot added the Emergency label Nov 3, 2022
@melvin-bot
Copy link

melvin-bot bot commented Nov 3, 2022

@tgolen looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify
Copy link
Contributor

OSBotify commented Nov 3, 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.

@tgolen tgolen removed the Emergency label Nov 3, 2022
@tgolen
Copy link
Contributor

tgolen commented Nov 3, 2022

I manually verified the reviewer checklist is complete.

@OSBotify
Copy link
Contributor

OSBotify commented Nov 4, 2022

🚀 Deployed to staging by @tgolen in version: 1.2.24-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 8, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Nov 8, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 8, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀

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