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

feat: updated react-native-key-command version #19124

Merged
merged 5 commits into from
May 24, 2023

Conversation

allroundexperts
Copy link
Contributor

Details

This PR updates the react-native-key-command library to the latest version such that it incorporates a fix that handled the key shortcuts in correct order.

Fixed Issues

$ #18480
PROPOSAL: #18480 (comment)

Tests

  1. Open ND and click the + icon in the LHN.
  2. Click the create group option.
  3. Press CMD+Enter and verify that nothing happens.
  4. Press Enter and verify that a user gets selected.
  5. Press CMD+Enter and verify that the new group screen gets created.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

  1. Open ND and click the + icon in the LHN.
  2. Click the create group option.
  3. Press CMD+Enter and verify that nothing happens.
  4. Press Enter and verify that a user gets selected.
  5. Press CMD+Enter and verify that the new group screen gets created.
  • 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 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 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
Screen.Recording.2023-05-17.at.7.47.50.PM.mov
Mobile Web - Chrome Screenshot 2023-05-17 at 2 10 59 AM
Mobile Web - Safari Screenshot 2023-05-17 at 2 13 04 AM
Desktop
Screen.Recording.2023-05-17.at.7.50.44.PM.mov
iOS Screenshot 2023-05-17 at 2 12 01 AM
Android Screenshot 2023-05-17 at 2 16 14 AM

@allroundexperts allroundexperts requested a review from a team as a code owner May 17, 2023 15:00
@melvin-bot melvin-bot bot requested review from mananjadhav and mountiny and removed request for a team May 17, 2023 15:00
@melvin-bot
Copy link

melvin-bot bot commented May 17, 2023

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

mananjadhav
mananjadhav previously approved these changes May 18, 2023
@mananjadhav
Copy link
Collaborator

@allroundexperts Verify Podfile check is failing. I think we'll have to push the Podfile change as well?

@mananjadhav
Copy link
Collaborator

mananjadhav commented May 19, 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 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 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 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 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
web-shortcut-modifiers-precedence.mov
Mobile Web - Chrome

NA

Mobile Web - Safari

NA

Desktop
desktop-shortcut-modifiers-precedence.mov
iOS
Android

NA


Just left with fixing the GHA, and because it is related to Podfile, I would then run once again on iOS to confirm it doesn't break anything.

@allroundexperts
Copy link
Contributor Author

@allroundexperts Verify Podfile check is failing. I think we'll have to push the Podfile change as well?

Let's first try with main merging.

@allroundexperts
Copy link
Contributor Author

Didn't work. 😢

@mountiny
Copy link
Contributor

is it failing on other PRs too?

@allroundexperts
Copy link
Contributor Author

is it failing on other PRs too?

No, it happens on this PR only. Its complaining that podfile has previous version of react-native-key-command.

@allroundexperts
Copy link
Contributor Author

allroundexperts commented May 19, 2023

💥 react-native-key-command (1.0.1) not found in Podfile.lock. Did you forget to run npx pod-install?

@mananjadhav
Copy link
Collaborator

I can still see the error for react-native-key command.

react-native-key-command (1.0.1) not found in Podfile.lock. Did you forget to run npx pod-install?

@allroundexperts once you do the pod install, doesn't the Podfile/Podfile.lock get updated?

image

@allroundexperts
Copy link
Contributor Author

I can still see the error for react-native-key command.

react-native-key-command (1.0.1) not found in Podfile.lock. Did you forget to run npx pod-install?

@allroundexperts once you do the pod install, doesn't the Podfile/Podfile.lock get updated?

image

It's getting updated but only react-native-reanimated library gets updated.

@allroundexperts
Copy link
Contributor Author

allroundexperts commented May 19, 2023

@mountiny I think you forgot to update the version here and here?

@mountiny
Copy link
Contributor

hmmm thats odd, it was not needed here either Expensify/react-native-key-command#19 but there was no "packages" field in there

@allroundexperts
Copy link
Contributor Author

hmmm thats odd, it was not needed here either Expensify/react-native-key-command#19 but there was no "packages" field in there

Have a look here

@mananjadhav
Copy link
Collaborator

@mountiny I can see in https://github.com/Expensify/react-native-key-command/pull/22/files#diff-b2790cc3d555682b207af1ca2fb897ebd2114c01149bf460fd85fc2b1503a687 we did update the versions in package-lock.json and Podfile.lock.

My concern is if it should be automatically done, when we did update the version. But could you please update it and we can try?

Also @allroundexperts I wonder why it shows up on my change list when I run pod install. Are you sure your Podfile doesn't show the dif?

@allroundexperts
Copy link
Contributor Author

@mountiny I can see in https://github.com/Expensify/react-native-key-command/pull/22/files#diff-b2790cc3d555682b207af1ca2fb897ebd2114c01149bf460fd85fc2b1503a687 we did update the versions in package-lock.json and Podfile.lock.

My concern is if it should be automatically done, when we did update the version. But could you please update it and we can try?

Also @allroundexperts I wonder why it shows up on my change list when I run pod install. Are you sure your Podfile doesn't show the dif?

I'm not sure why but I can confirm that when I run the update on podfile, only react-native-reanimated gets updated.

@mountiny
Copy link
Contributor

https://github.com/Expensify/react-native-key-command/pull/22/files#diff-b2790cc3d555682b207af1ca2fb897ebd2114c01149bf460fd85fc2b1503a687R565 how did they get this change, if I wun pod install in the ios directory it fails:

➜  ios git:(vit-fixTheVersioning) ✗ pod install

[!] Invalid `Podfile` file: cannot load such file -- /Users/vit/Expensidev/react-native-key-command/example/node_modules/react-native/scripts/react_native_pods.

 #  from /Users/vit/Expensidev/react-native-key-command/example/ios/Podfile:1
 #  -------------------------------------------
 >  require_relative '../node_modules/react-native/scripts/react_native_pods'
 #  require_relative '../node_modules/@react-native-community/cli-platform-ios/native_modules'
 #  -------------------------------------------
➜  ios git:(vit-fixTheVersioning) ✗

@mananjadhav
Copy link
Collaborator

@azimgd do you have any comments on how to update the version in the dependency?

@allroundexperts
Copy link
Contributor Author

@mananjadhav @mountiny Is there a solution that I can try here? I think this is blocking this PR from merging.

@mountiny
Copy link
Contributor

yeah sorry I tried earlier today and seeing some weird behaviour when trying to update the package. Getting big diff when running npm i which should not happen

@azimgd azimgd mentioned this pull request May 23, 2023
57 tasks
@allroundexperts
Copy link
Contributor Author

@mountiny @mananjadhav After merging with main and then running install inside the iOS directory, the version of the package did got updated in the podfile. However, there is a version change for Cocoapod which I'm not sure is required here.

@azimgd
Copy link
Contributor

azimgd commented May 24, 2023

Cocoapods version should not be changed.

@mountiny
Copy link
Contributor

Thanks Azim!

@allroundexperts can you revert the cocoapods change please?

@mananjadhav once that is done, can you please test this.

@mountiny
Copy link
Contributor

Bumping the cocoapods change before EOD for me @allroundexperts

@allroundexperts
Copy link
Contributor Author

Bumping the cocoapods change before EOD for me @allroundexperts

Coming up in 30 mins

@allroundexperts
Copy link
Contributor Author

@mountiny Updated.

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.

Thanks everyone, checking of the checklist as I believe this was tested thoroughly.

@mountiny mountiny merged commit 25c779c into Expensify:main May 24, 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.3.18-0 🚀

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

@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.18-2 🚀

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.

5 participants