Extract WorkspaceSettingsModalStackNavigator #39084

hayata-suenaga · 2024-03-27T17:48:23Z

Details

There's a new requirement to implement protected routes. These are routes or screens that only a specific group of users should access. To do this, we need to conditionally add or remove screens from a navigator.

In our existing code, all stack navigators are created using the createModalStackNavigator function. But this function doesn't support conditional screens.

This proposed change redefines the WorkspaceSettingsModalStackNavigator without using the createModalStackNavigator function. This allows certain workspace settings-related screens to be made conditionally available.

Please note that this proposal doesn't implement the logic for conditionally registering certain screens. But it makes it easy to implement this kind of logic.

You can find further information on this change in this Slack thread.

Fixed Issues

$ #39087
PROPOSAL: N/A

Tests / QA Test

Sign in to staging.expenisfy.com. Use a non-public domain if possible. If you need to use a public domain (e.g., google.com], append ?exitTo=inbox to the URL.
Navigate to Settings -> Workspaces -> Group -> New Workspace -> Collect. This creates a new Collect workspace for you. You do NOT need to enter any payment information.
On the screen for your newly created workspace, open the developer console. Paste and execute the following code snippet:

p = Policy.getCurrent();
p.policy.isPolicyExpenseChatEnabled = true;
p.save();

Sign in to New Expensify using the same account you used in step Some initial fixes and code style updates #1.
Click on your avatar on the far right of the bottom tab -> Workspaces. The workspace you created should be listed. Click on it and then navigate to More Features.
Confirm that the screen you see matches the one shown below.
We want to check that all screens are accessible. Toggle all options listed on this page. Each time you toggle on an option, you should be navigated to the page for that option. After toggling on all options, the left-hand size of the screen should look something like this.

Offline tests

N/A

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 skipped the chrome on Android phone

Screenshots/Videos

Android: Native

screen-20240327-123731.mp4

This is from Ad Hoc build

Android: mWeb Chrome

N/A

iOS: Native

Simulator.Screen.Recording.-.iPhone.15.-.2024-03-27.at.14.24.00.mp4

iOS: mWeb Safari

Simulator.Screen.Recording.-.iPhone.15.-.2024-03-27.at.13.57.02.mp4

MacOS: Chrome / Safari

Screen.Recording.2024-03-27.at.1.50.25.PM.mov

MacOS: Desktop

Screen.Recording.2024-03-27.at.2.04.47.PM.mov

melvin-bot · 2024-03-27T17:48:51Z

@chiragsalian Please 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]

hayata-suenaga · 2024-03-27T18:15:36Z

Regression 1

This regression only happens with the ad hoc build. When testing locally, I cannot observe this regression

The ad hoc desktop and Android work as expected

Open the ad hoc build on a web browser
Confirm that the Hmm... it's not here page is presented
Click the Go back to home page link
Confirm that the home page is presented
Reload the site
Confirm that the Hmm... it's not here page is presented again

Update: I'm rebuilding the ad hoc just in case to figure out the regression with the web ad hoc

github-actions · 2024-03-27T19:06:17Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/39084/index.html	❌ FAILED ❌
	The QR code can't be generated, because the iOS build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/39084/NewExpensify.dmg	https://39084.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

situchan

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan · 2024-03-27T19:14:39Z

Please complete author checklist

melvin-bot · 2024-03-27T19:14:47Z

@MonilBhavsar Please 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]

hayata-suenaga · 2024-03-27T19:44:29Z

@roryabraham I'll work on the screen recordings after lunch. Meantime, could you review the code please? 🙇

UPDATE: I added the screen recordings to the author checklist

hayata-suenaga · 2024-03-28T03:35:35Z

There remains an issue with the ad hoc build on the web, but the local build and builds on other platforms are not affected. Apart from this, the PR is ready for internal engineer review.

situchan · 2024-03-28T03:36:53Z

There remains an issue with the ad hoc build on the web, but the local build and builds on other platforms are not affected. Apart from this, the PR is ready for internal engineer review.

yes, it's known issue happening on all adhoc builds

roryabraham

Also NAB but I suggest creating a hook to extract the common logic between WorkspaceSettingsModalStackNavigator and createModalStackNavigator

src/libs/Navigation/AppNavigator/WorkspaceSettingsModalStackNavigator.tsx

…reen options

hayata-suenaga · 2024-03-28T05:00:26Z

Addressed Rory's PR reviews and retested with web

Screen.Recording.2024-03-27.at.10.00.02.PM.mov

src/libs/Navigation/AppNavigator/ModalStackNavigators/useModalScreenOptions.ts

…to create stack navigators

roryabraham

sorry I didn't notice it before, but it's a bit weird that we have a module structure like this:

Navigation/AppNavigator
----> ModalStackNavigtors.tsx
----| ModalStackNavigators
----------> WorkspaceSettingsModalStackNavigator.tsx

because it's not immediately obvious what you mean if you do import ModalStackNavigators from @navigation/AppNavigator/ModalStackNavigator

I think a directory structure that more closely matches the established patterns in this repo would be like this:

Navigation/AppNavigator
----| ModalStackNavigators
----------> index.tsx
----------> WorkspaceSettingsModalStackNavigator.tsx

… index file

hayata-suenaga · 2024-03-28T05:26:05Z

changed 😄 and tested again on web

Screen.Recording.2024-03-27.at.10.24.59.PM.mov

OSBotify · 2024-03-28T05:48:08Z

✋ 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 · 2024-03-29T02:28:59Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.58-0 🚀

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

OSBotify · 2024-04-02T11:05:15Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.58-8 🚀

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

Hayata Suenaga added 3 commits March 27, 2024 10:39

refactor: extract stack navigator for workspace-settings-related screens

8581a48

chore: rename component & remove permission condition

872a256

chore: use the new navigator

f793643

hayata-suenaga requested a review from a team as a code owner March 27, 2024 17:48

hayata-suenaga self-assigned this Mar 27, 2024

hayata-suenaga added the Ready To Build label Mar 27, 2024

melvin-bot bot removed the request for review from a team March 27, 2024 17:48

melvin-bot bot requested a review from chiragsalian March 27, 2024 17:48

hayata-suenaga requested review from roryabraham and removed request for chiragsalian March 27, 2024 17:49

This comment has been minimized.

Sign in to view

hayata-suenaga requested a review from situchan March 27, 2024 18:31

situchan approved these changes Mar 27, 2024

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar March 27, 2024 19:14

roryabraham requested changes Mar 28, 2024

View reviewed changes

src/libs/Navigation/AppNavigator/WorkspaceSettingsModalStackNavigator.tsx Outdated Show resolved Hide resolved

Hayata Suenaga added 3 commits March 27, 2024 21:55

chore: add a hook to get the screen options for navigator screens

1afc66f

chore: move the location of the file & use the new hook to get the sc…

981f082

…reen options

fix: file location in the import statement

bd1faf3

hayata-suenaga requested a review from roryabraham March 28, 2024 05:00

roryabraham requested changes Mar 28, 2024

View reviewed changes

src/libs/Navigation/AppNavigator/ModalStackNavigators/useModalScreenOptions.ts Show resolved Hide resolved

refactor: use the new hook to get screen options inside the function …

d5765d4

…to create stack navigators

roryabraham requested changes Mar 28, 2024

View reviewed changes

refactor: move the modal stack navigators file into the new dir as an…

2f94730

… index file

roryabraham approved these changes Mar 28, 2024

View reviewed changes

roryabraham merged commit e14ac08 into main Mar 28, 2024
15 checks passed

roryabraham deleted the hayata-conditional-screens branch March 28, 2024 05:41

hayata-suenaga removed the Ready To Build label Mar 28, 2024

hayata-suenaga mentioned this pull request Mar 28, 2024

Feat: implement accounting page #38283

Closed

48 tasks

github-actions bot mentioned this pull request Mar 29, 2024

Deploy Checklist: New Expensify 2024-03-29 #39222

Closed

melvin-bot bot mentioned this pull request Apr 2, 2024

[HOLD for payment 2024-04-09] [Wave Collect][QBO] Make it easy to conditionally add or remove routes/screens in WorkspaceSettingsModalStackNavigator #39087

Closed

trjExpensify mentioned this pull request Apr 2, 2024

QBO import main page #38400

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extract WorkspaceSettingsModalStackNavigator #39084

Extract WorkspaceSettingsModalStackNavigator #39084

hayata-suenaga commented Mar 27, 2024 •

edited

Loading

melvin-bot bot commented Mar 27, 2024

This comment has been minimized.

hayata-suenaga commented Mar 27, 2024 •

edited

Loading

github-actions bot commented Mar 27, 2024

situchan left a comment

situchan commented Mar 27, 2024

melvin-bot bot commented Mar 27, 2024

hayata-suenaga commented Mar 27, 2024 •

edited

Loading

hayata-suenaga commented Mar 28, 2024 •

edited

Loading

situchan commented Mar 28, 2024

roryabraham left a comment

hayata-suenaga commented Mar 28, 2024

roryabraham left a comment

hayata-suenaga commented Mar 28, 2024

OSBotify commented Mar 28, 2024

OSBotify commented Mar 29, 2024

OSBotify commented Apr 2, 2024

Extract WorkspaceSettingsModalStackNavigator #39084

Extract WorkspaceSettingsModalStackNavigator #39084

Conversation

hayata-suenaga commented Mar 27, 2024 • edited Loading

Details

Fixed Issues

Tests / QA Test

Offline tests

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 27, 2024

This comment has been minimized.

hayata-suenaga commented Mar 27, 2024 • edited Loading

Regression 1

github-actions bot commented Mar 27, 2024

situchan left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Screenshots/Videos

situchan commented Mar 27, 2024

melvin-bot bot commented Mar 27, 2024

hayata-suenaga commented Mar 27, 2024 • edited Loading

hayata-suenaga commented Mar 28, 2024 • edited Loading

situchan commented Mar 28, 2024

roryabraham left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Mar 28, 2024

roryabraham left a comment

Choose a reason for hiding this comment

hayata-suenaga commented Mar 28, 2024

OSBotify commented Mar 28, 2024

OSBotify commented Mar 29, 2024

OSBotify commented Apr 2, 2024

hayata-suenaga commented Mar 27, 2024 •

edited

Loading

hayata-suenaga commented Mar 27, 2024 •

edited

Loading

hayata-suenaga commented Mar 27, 2024 •

edited

Loading

hayata-suenaga commented Mar 28, 2024 •

edited

Loading