@swm/global nav menu v1 #28277

adamgrzybowski · 2023-09-26T18:31:17Z

Details

The v1 version of the global navigation. Only one option "Chats" is included.

Fixed Issues

$ #27000
PROPOSAL:

Tests

Confirm the new Global Nav component appears as expected

Offline tests

N/A

QA Steps

Access NewDot on all platforms
Check that there is a new navigation panel (Global Nav).
Check that there is one menu option ("Chats") on Global Nav
Check that on wider screens (laptop web, desktop), the Global Nav looks like the screenshot below.

Check that on smaller screens (mobile web, iOS, Android), the Global Nav looks like the screenshot below.

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 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

web.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

desktop.mov

iOS

Android

hayata-suenaga · 2023-09-28T02:45:32Z

@shawnborton for providing the icons

shawnborton · 2023-09-28T04:53:35Z

These are all of the icons we'll need, some already exist in the App repo though, so you might need to upload certain ones:

Icon svgs: Icons.zip

melvin-bot · 2023-09-28T17:11:50Z

@hoangzinh @hayata-suenaga 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]

allroundexperts · 2023-09-29T00:37:37Z

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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-10-05.at.6.15.48.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-10-05.at.6.19.44.PM.mov

Mobile Web - Safari

Screen.Recording.2023-10-05.at.6.18.15.PM.mov

Desktop

Screen.Recording.2023-10-05.at.6.22.04.PM.mov

iOS

Screen.Recording.2023-10-05.at.6.17.29.PM.mov

Android

Screen.Recording.2023-10-05.at.6.20.45.PM.mov

allroundexperts · 2023-09-29T01:07:29Z

Bug: The chat menu is not highlighted on mWeb.

src/libs/Navigation/linkTo.js

src/pages/home/sidebar/GlobalNavigation/GlobalNavigation.js

src/pages/home/sidebar/GlobalNavigation/GlobalNavigationMenuItem.js

src/pages/home/sidebar/GlobalNavigation/GlobalNavigationMenuItemList.js

adamgrzybowski · 2023-09-29T16:23:28Z

@allroundexperts I made some adjustments.

Bug: The chat menu is not highlighted on mWeb.

This also should be fixed

mountiny · 2023-10-05T19:28:55Z

Added your device to the provisioning profile, hopefully it will work next

shawnborton · 2023-10-05T20:56:34Z

Dang, still having that same integrity error.

mountiny · 2023-10-05T21:37:14Z

Ok it works for me, I will ask in Slack what else is required.

hayata-suenaga · 2023-10-06T00:10:58Z

@mountiny asked the question about provisioning profile here

mountiny · 2023-10-06T12:58:59Z

Started a build with new provisioning profile 🤞

OSBotify · 2023-10-06T13:32:12Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/28277/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/28277/index.html

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/28277/NewExpensify.dmg	https://28277.pr-testing.expensify.com

shawnborton · 2023-10-06T14:07:50Z

Dang, I still can't install iOS.

mountiny · 2023-10-06T14:25:29Z

Dang, I am not sure whats next, this should have the new profile with your deviceID in it

adamgrzybowski · 2023-10-06T15:39:42Z

Hey, I see there are still a few style related things to fix. I would like to propose to implement them after the rest of the global navigation logic. There are a few factors why I am considering it:

While all those changes are mostly small things I think they can add up.
Until this moment my work was mainly related to navigation. I don't have much experience with existing components and conventions in the context of Expensify. That may cause additional delays.
I think that we can relatively safely work on styles after finishing the logic without worrying that these changes will affect the behavior of the app. That means we can test the logic and work on styles in parallel.
Finally, we have a pretty close deadline so I think it may be worth focusing on functionality first.

Of course, I can understand the reasons for merging only style perfect PR with the main. On the other hand, it's not about ignoring all these valuable comments on how to improve the look of the app. It's about moving them later in the production cycle.

I would be happy to hear your opinion on this. I think this option is worth considering but I will be happy with any decision.

cc: @hayata-suenaga @shawnborton @s77rt @allroundexperts @mountiny

mountiny

@adamgrzybowski I agree with shipping this one so the community can catch any bigger bugs/ deeplinks and whatnot which we might be missing here and holding the merge on styling updates now would not be worth it. Great job on this PR!

@shawnborton I think we can collect the styling feedback on one issue and ask C+ to handle it as they have the best experience with the app codebase and they can address that fast, curious if you agree

@hayata-suenaga @stitesExpensify up to you and all yours 🚀

hayata-suenaga

great job and thank you for suggesting the idea of merging PR first and making style adjustments later 🙌

hayata-suenaga · 2023-10-07T00:56:29Z

I added the QA test steps in the OP. I also checked the item for adding screenshots for all platforms. Two C+ added screenshots, so I think it's enough.

OSBotify · 2023-10-07T01:08:05Z

✋ 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 · 2023-10-09T23:01:52Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.80-0 🚀

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

OSBotify · 2023-10-11T04:42:08Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.80-3 🚀

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

OSBotify · 2023-10-11T05:11:02Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.81-0 🚀

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

OSBotify · 2023-10-13T22:00:08Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:12:11Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T22:28:24Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-13T23:03:49Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.83-11 🚀

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

OSBotify · 2023-10-16T21:15:29Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

OSBotify · 2023-10-16T21:51:49Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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

WoLewicki and others added 5 commits September 26, 2023 14:59

feat: first look at adding global nav menu

aacb4a6

feat: remove unused onLayout and move globalNavigation higher

fe7851f

feat: prepare app for different menus

5bc0dec

add first global navigation option

b1af947

style changes

2344abc

hayata-suenaga added the Design label Sep 28, 2023

hayata-suenaga requested a review from shawnborton September 28, 2023 02:46

adamgrzybowski mentioned this pull request Sep 28, 2023

[$500] [HOLD for payment 2023-10-18] Add Global Nav component #27000

Closed

adamgrzybowski added 2 commits September 28, 2023 18:47

style changes v2

a966c89

Merge branch 'main' into @swm/global-nav-menu-v1

76ef562

adamgrzybowski marked this pull request as ready for review September 28, 2023 17:11

adamgrzybowski requested a review from a team as a code owner September 28, 2023 17:11

melvin-bot bot requested review from hayata-suenaga and hoangzinh and removed request for a team September 28, 2023 17:11

hayata-suenaga requested a review from allroundexperts September 29, 2023 00:45