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

fix: ignore other actions if navigation in progress in menu Items #28338

Merged

Conversation

ishpaul777
Copy link
Contributor

@ishpaul777 ishpaul777 commented Sep 27, 2023

Details

Fixed Issues

$ #27384
PROPOSAL: #27384 (comment)

Tests

  • Verify that no errors appear in the JS console
  1. Navigate to Workspace settings Page and quickly press different MenuItems, verify only one Item Opens at a time.
  2. Navigate to About Page and and quickly press different MenuItems (other than external links), verify only one Item Opens at a time.
  3. Navigate to Security Page and and quickly press different MenuItems (other than external links), verify only one Item Opens at a time.

Offline tests

QA Steps

  • Verify that no errors appear in the JS console
  1. Navigate to Workspace settings Page and quickly press different MenuItems, verify only one Item Opens at a time.
  2. Navigate to About Page and and quickly press different MenuItems (other than external links), verify only one Item Opens at a time.
  3. Navigate to Security Page and and quickly press different MenuItems (other than external links), verify only one Item Opens at a time.

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 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 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
    • 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
    • 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 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 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-10-16.at.7.02.42.PM-1.mov
Mobile Web - Chrome
VIDEO-2023-10-16-19-40-58.mov
Mobile Web - Safari
RPReplay_Final1697459265.mov
Desktop
Screen.Recording.2023-10-16.at.9.18.27.PM-1.mov
iOS
Simulator.Screen.Recording.-.iPhone.15.Pro.-.2023-10-16.at.17.20.49.mov
Android
Screen.Recording.2023-10-16.at.5.22.36.PM-1.mov

@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Oct 9, 2023

Hi @robertKozik, i have added some comments, can you take a look at code change i have added video for ios will add for rest once code changes looks good to you,

@ishpaul777 ishpaul777 marked this pull request as ready for review October 9, 2023 11:50
@ishpaul777 ishpaul777 requested a review from a team as a code owner October 9, 2023 11:50
@melvin-bot melvin-bot bot requested review from robertKozik and removed request for a team October 9, 2023 11:50
Copy link
Contributor

@robertKozik robertKozik left a comment

Choose a reason for hiding this comment

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

The diff is really messy due to import shuffle from your commits - please do something with it. Apart from that few suggestions, mainly use useMemo for option mappings

src/pages/settings/InitialSettingsPage.js Outdated Show resolved Hide resolved
src/components/MenuItemList.js Outdated Show resolved Hide resolved
src/pages/settings/AboutPage/AboutPage.js Outdated Show resolved Hide resolved
src/pages/settings/AboutPage/AboutPage.js Outdated Show resolved Hide resolved
src/pages/settings/InitialSettingsPage.js Show resolved Hide resolved
src/pages/settings/Security/SecuritySettingsPage.js Outdated Show resolved Hide resolved
@ishpaul777
Copy link
Contributor Author

ishpaul777 commented Oct 10, 2023

Thanks for reviewing and providing feedback. I'll make changes.

@ishpaul777
Copy link
Contributor Author

Hii @robertKozik, made some change mind giving a quick look?

@robertKozik
Copy link
Contributor

I'm OOO for today - will review early tomorrow

@ishpaul777
Copy link
Contributor Author

gentle bump @robertKozik

Copy link
Contributor

@robertKozik robertKozik left a comment

Choose a reason for hiding this comment

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

The last one I think. You've removed passing onyx state about the modal, but there is still used inside the memo. I'll start filling reviewer checklist

src/pages/settings/AboutPage/AboutPage.js Outdated Show resolved Hide resolved
src/pages/settings/AboutPage/AboutPage.js Outdated Show resolved Hide resolved
src/pages/settings/AboutPage/AboutPage.js Outdated Show resolved Hide resolved
@robertKozik
Copy link
Contributor

Also could you fill in your (authors) checklist, provide test steps and resolve conflicts @ishpaul777 ?

@ishpaul777
Copy link
Contributor Author

i'll resolve the conflicts and clean up the code in a while. Thanks for the reviewing again.

@MonilBhavsar
Copy link
Contributor

Update: one outstanding thread that needs to be resolved #28338 (comment). Looks good overall.
Looks like we'll need to test it again after resolving and updating the comment.

@ishpaul777
Copy link
Contributor Author

@MonilBhavsar The fix was simpler than i thought, we no longer wrap the modal opening action in singleExecution and this solves the blinking issue, Can you review again please. @robertKozik

@MonilBhavsar
Copy link
Contributor

Great, thank you! 😄 Did you test on all platforms? Let's be careful as it affects most of the navigation items in the App.

@ishpaul777
Copy link
Contributor Author

sorry for delay, Done with the testing everthing works as expected on my side on all platforms. @robertKozik @MonilBhavsar

@ishpaul777
Copy link
Contributor Author

gentle bump @MonilBhavsar

@MonilBhavsar
Copy link
Contributor

There are conflicts to resolve.
Since there were major updates, it needs to be re reviewed and re tested by C+. @robertKozik could you please help to review and test.

@robertKozik
Copy link
Contributor

Sureee, I'm on it 👀

Copy link
Contributor

@robertKozik robertKozik left a comment

Choose a reason for hiding this comment

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

retested - works well.
CC. @MonilBhavsar

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good and works well 🚀

@MonilBhavsar MonilBhavsar merged commit 0d6fa8b into Expensify:main Oct 25, 2023
14 checks passed
@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/MonilBhavsar in version: 1.3.91-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

}) {
const [isDownloadButtonActive, temporarilyDisableDownloadButton] = useThrottledButtonState();
const {translate} = useLocalize();
const {isKeyboardShown} = useKeyboardState();
const waitForNavigate = useWaitForNavigation();
Copy link
Contributor

Choose a reason for hiding this comment

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

👋 coming from #30636

The hooks here cause an error in the storybook for component HeaderWithBackButton.

iconRight: Expensicons.NewWindow,
action: () => {
Link.openExternalLink(CONST.GITHUB_URL);
},
Copy link
Contributor

@abdulrahuman5196 abdulrahuman5196 Jan 11, 2024

Choose a reason for hiding this comment

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

link for github url is missed here during refractor

Causing this issue - #32965

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No excuses.. i messed up here😅

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