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: 8329: Resolve fabmenu open multiple time #8692

Merged

Conversation

dharmik
Copy link
Contributor

@dharmik dharmik commented Apr 19, 2022

Details

Fixed Issues

$ 8329

Tests

tests to something like this -

1 Login to New expensify
2 In RHN, tap on the green +
Double tap on new chat
3 Verify that the new chat page opens

  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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
  • 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.

PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again 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 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 tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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.

QA Steps

tests to something like this -

1 Login to New expensify
2 In RHN, tap on the green +
Double tap on new chat
3 Verify that the new chat page opens

  • Verify that no errors appear in the JS console

Video

iOS

Screen.Recording.2022-04-15.at.10.47.49.AM.mov

android

162147410-a7ee7d7d-de03-4086-ac2c-ed19091aa655.mp4

Macos

Screen.Recording.2022-04-19.at.11.15.18.PM.mov

MWeb

Screen.Recording.2022-04-20.at.11.56.42.PM.mov

Web

Screen.Recording.2022-04-20.at.11.58.54.PM.mov

@dharmik dharmik requested a review from a team as a code owner April 19, 2022 17:50
@melvin-bot melvin-bot bot requested review from rushatgabhane and tgolen and removed request for a team April 19, 2022 17:50
@dharmik
Copy link
Contributor Author

dharmik commented Apr 19, 2022

@rushatgabhane PR updated.

@rushatgabhane
Copy link
Member

rushatgabhane commented Apr 19, 2022

@dharmik please add screenshots for all platforms

And update the tests to something like this -

  1. Login to New expensify
  2. In RHN, tap on the green +
  3. Double tap on new chat
  4. Verify that the new chat page opens

Thanks!

@@ -58,14 +59,23 @@ class SidebarScreen extends Component {
Timing.start(CONST.TIMING.SIDEBAR_LOADED, true);

const routes = lodashGet(this.props.navigation.getState(), 'routes', []);
WelcomeAction.show({routes, toggleCreateMenu: this.toggleCreateMenu});
WelcomeAction.show({routes, hideCreateMenu: this.hideCreateMenu});
}

/**
* Method called when a Create Menu item is selected.
*/
onCreateMenuItemSelected() {
Copy link
Contributor

Choose a reason for hiding this comment

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

If this method only does one thing, which is call another method, then this method should be removed and just call this.hideCreateMenu() instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tgolen You mean to say we need to make the change like this?

-        WelcomeAction.show({routes, hideCreateMenu: this.hideCreateMenu});
+        this.hideCreateMenu();

If yes? WelcomeActions.js we are managing this condition and call method in if statement.

if (!Policy.isAdminOfFreePolicy(allPolicies) && !isDisplayingWorkspaceRoute) {
            hideCreateMenu();
        }

Any thoughts on it?

Copy link
Member

Choose a reason for hiding this comment

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

@dharmik, onCreateMenuItemSelected() just calls hideCreateMenu().

So you need to

  1. Remove onCreateMenuItemSelected(), and
  2. Replace all calls to it with hideCreateMenu()

Let me know if you have any questions.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rushatgabhane Resolved

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rushatgabhane @tgolen Can you please share your opinion on it? #8692 (comment)

Copy link
Member

@rushatgabhane rushatgabhane Apr 21, 2022

Choose a reason for hiding this comment

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

Can you please share your opinion on it? #8692 (comment)

@dharmik I'm sorry, I don't understand. I thought this conversation was resolved.
Only action required by you is to address #8692 (comment)

Please let me know if you have any questions, thanks so much!

@@ -75,7 +75,7 @@ function show({routes, toggleCreateMenu}) {
// It's also possible that we already have a workspace policy. In either case we will not toggle the menu but do still want to set the NVP in this case
Copy link
Contributor

Choose a reason for hiding this comment

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

This comment needs to be updated now (since it specifically mentions toggling)

Copy link
Member

Choose a reason for hiding this comment

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

@dharmik ig you missed this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rushatgabhane PR updated.

@dharmik
Copy link
Contributor Author

dharmik commented Apr 20, 2022

@rushatgabhane I updated videos in PR description is that okay?

@dharmik
Copy link
Contributor Author

dharmik commented Apr 22, 2022

@rushatgabhane Can you please recheck this PR & let me know if I miss something?

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@tgolen Looks good!

#### PR Reviewer Checklist

  • 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 verified tests pass on all platforms & I tested again 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 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 tagging the marketing team 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 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 */
    • Any functional components have the displayName property
    • 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.

@rushatgabhane
Copy link
Member

rushatgabhane commented Apr 22, 2022

@dharmik sorry for the delay, you just need to address this comment. Thanks so much!

@dharmik
Copy link
Contributor Author

dharmik commented Apr 23, 2022

@rushatgabhane

#8692

I added all videos in PR description

@rushatgabhane
Copy link
Member

@dharmik the tests aren't clear, so please address that too. My comment here was a suggestion for that

@dharmik
Copy link
Contributor Author

dharmik commented Apr 23, 2022

if in those video testes are not clear so in screenshot how clear?

Appreciate your suggestion

@rushatgabhane

@rushatgabhane
Copy link
Member

Ohh I see. Forget the video completely. As per the suggestions here update these tests in the PR description 👇

Screenshot_20220423-230513

@dharmik
Copy link
Contributor Author

dharmik commented Apr 23, 2022

PR description updated @rushatgabhane

@rushatgabhane
Copy link
Member

Btw, PR is approved!

@tgolen tgolen merged commit 16b130b into Expensify:main Apr 25, 2022
@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 @tgolen in version: 1.1.57-0 🚀

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

@marcaaron
Copy link
Contributor

Sorry if I'm missing some context but doesn't this PR break the "automatic" opening on the create menu for a first time user sign in since we are only "hiding" it now?

I find it kind of weird that we are calling WelcomeAction.show() but it doesn't "show" anything and either navigates somewhere or calls a hide() method.

@marcaaron
Copy link
Contributor

/**
* Shows a welcome action on first login
*
* @param {Object} params
* @param {Object} params.routes
* @param {Function} params.hideCreateMenu
*/
function show({routes, hideCreateMenu}) {
// NOTE: This setTimeout is required due to a bug in react-navigation where modals do not display properly in a drawerContent
// This is a short-term workaround, see this issue for updates on a long-term solution: https://github.com/Expensify/App/issues/5296
setTimeout(() => {
if (!isFirstTimeNewExpensifyUser) {
return;
}
// Set the NVP back to false so we don't automatically run welcome actions again
NameValuePair.set(CONST.NVP.IS_FIRST_TIME_NEW_EXPENSIFY_USER, false, ONYXKEYS.NVP_IS_FIRST_TIME_NEW_EXPENSIFY_USER);
// We want to display the Workspace chat first since that means a user is already in a Workspace and doesn't need to create another one
const workspaceChatReport = _.find(allReports, report => ReportUtils.isPolicyExpenseChat(report));
if (workspaceChatReport) {
Navigation.navigate(ROUTES.getReportRoute(workspaceChatReport.reportID));
return;
}
// If we are rendering the SidebarScreen at the same time as a workspace route that means we've already created a workspace via workspace/new and should not open the global
// create menu right now.
const topRouteName = lodashGet(_.last(routes), 'name', '');
const loginWithShortLivedTokenRoute = _.find(routes, route => route.name === 'LogInWithShortLivedToken');
const exitingToWorkspaceRoute = lodashGet(loginWithShortLivedTokenRoute, 'params.exitTo', '') === 'workspace/new';
const isDisplayingWorkspaceRoute = topRouteName.toLowerCase().includes('workspace') || exitingToWorkspaceRoute;
// It's also possible that we already have a workspace policy. In either case we will not hide the menu but do still want to set the NVP in this case
// since the user does not need to create a workspace.
if (!Policy.isAdminOfFreePolicy(allPolicies) && !isDisplayingWorkspaceRoute) {
hideCreateMenu();
}
}, 1500);
}

Anyone can tell us where in this function we "show" something?

@marcaaron
Copy link
Contributor

Thinking maybe it should have been showCreateMenu() and we just got mixed up because it wasn't clear if "toggle" meant "hide" or "show". But it means "show" right?

@marcaaron
Copy link
Contributor

(context: While looking into the issue here realized the code no longer makes sense since we're not showing anything)

@tgolen
Copy link
Contributor

tgolen commented Apr 28, 2022

Those are pretty good questions. I actually think there is quite a bit about the welcome actions code that is an anti-pattern (like passing callback functions into the action file, the use of the setTimeout(), etc.). I would say there aren't really any good answers, and I would be in favor of just doing a bit of an over-haul and cleanup to this code.

@marcaaron
Copy link
Contributor

I agree, but this PR still broke existing behavior. We are calling a function that doesn't show anything and won't hide something because nothing is shown in the first place.

@tgolen
Copy link
Contributor

tgolen commented Apr 28, 2022

Yeah, so in that case, it's definitely a regression that needs fixed regardless. You are right.

@dharmik
Copy link
Contributor Author

dharmik commented Apr 29, 2022

@marcaaron : I realize it, thanks for point it out.

File: In src/libs/actions/WelcomeActions.js we only display it to Show menu item first time for isFirstTimeNewExpensifyUser = true

Changes:
File: src/pages/home/sidebar/SidebarScreen.js

-        WelcomeAction.show({routes, hideCreateMenu: this.hideCreateMenu});
+        WelcomeAction.show({routes, showCreateMenu: this.showCreateMenu});

File: src/libs/actions/WelcomeActions.js

- * @param {Function} params.hideCreateMenu
+ * @param {Function} params.showCreateMenu
  */
-function show({routes, hideCreateMenu}) {
+function show({routes, showCreateMenu}) {
         if (!Policy.isAdminOfFreePolicy(allPolicies) && !isDisplayingWorkspaceRoute) {
-            hideCreateMenu();
+            showCreateMenu();

@marcaaron Is it okay?

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @chiragsalian in version: 1.1.57-17 🚀

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