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 combobox minimize #9706

Merged
merged 5 commits into from
Jul 25, 2022
Merged

Fix combobox minimize #9706

merged 5 commits into from
Jul 25, 2022

Conversation

mollfpr
Copy link
Contributor

@mollfpr mollfpr commented Jul 5, 2022

Details

Adding history router with type drawer to only when on mobile. On web or desktop size we don't need the drawer to toggle.

Fixed Issues

$ #8841

Tests

  1. Click on one chat first
  2. Minimize the window as much as possible
  3. Maximize the window
  4. Click another chat
  5. Minimize window
  6. Verify that the report screen is showing when minimizing the window
  • 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

  1. Click on one chat first
  2. Minimize the window as much as possible
  3. Maximize the window
  4. Click another chat
  5. Minimize window
  6. Verify that the report screen is showing when minimizing the window
  • Verify that no errors appear in the JS console

Screenshots

Web

screen-recording-2022-07-05-at-232433_9Fiwh2QP.mp4

Mobile Web

screen-recording-2022-07-05-at-232932_kwktq1nb.mp4
screen-recording-2022-07-05-at-232527_N2pCHoto.mp4

Desktop

screen-recording-2022-07-05-at-233053_P9Cvk1K0.mp4

iOS

Screen.Recording.2022-07-06.at.22.48.41.mov

Android

@mollfpr mollfpr marked this pull request as ready for review July 6, 2022 16:39
@mollfpr mollfpr requested a review from a team as a code owner July 6, 2022 16:39
@melvin-bot melvin-bot bot requested review from aldo-expensify and Santhosh-Sellavel and removed request for a team July 6, 2022 16:39
@mollfpr
Copy link
Contributor Author

mollfpr commented Jul 6, 2022

@Santhosh-Sellavel Can you help me to test on Android native? I can't run the android on my local. Thanks!

* @returns {String}
*/
function getDefaultDrawerState(isSmallScreenWidth) {
function getDefaultDrawerState(isSmallScreen) {
isSmallScreenWidth = isSmallScreen;
Copy link
Contributor

Choose a reason for hiding this comment

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

This getter having a side effect of setting isSmallScreenWidth feels too dirty. navigate calling navigationRef.current.dispatch(CustomActions.pushDrawerRoute(route, isSmallScreenWidth)); depends on getDefaultDrawerState having been called before.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are we okay using your approach to get the dimension?

const initialDimensions = Dimensions.get('window');
const isSmallScreenWidth = initialDimensions.width <= variables.mobileResponsiveWidthBreakpoint;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I couldn't find another way to get the screen size except using Dimensions.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is what I came with when I was testing, I didn't see any other way that didn't involve changing too many things (I must say I didn't tried much :P)

Thoughts @Santhosh-Sellavel ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Isn't there any API in Dimensions to listen to the changes? @mollfpr Explore the options.

Copy link
Contributor

Choose a reason for hiding this comment

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

I may be missing something, but if that code is inside pushDrawerRoute, wouldn't it be up to date when that function is called? pushDrawerRoute doesn't get called when minimizing or expanding the window, does it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yep, that should do.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yep, that should do.

@aldo-expensify I already confirmed it would work.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, that should do.

@aldo-expensify I already confirmed it would work.

The version with the listener?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Are we okay using your approach to get the dimension?

const initialDimensions = Dimensions.get('window');
const isSmallScreenWidth = initialDimensions.width <= variables.mobileResponsiveWidthBreakpoint;

Sorry for the confusion, I thought we are determining once. This way itself will work if it is determined every time.
@aldo-expensify

Dimensions.addEventListener('change', ({window}) => {
isSmallScreenWidth = window.width <= variables.mobileResponsiveWidthBreakpoint;
});

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Santhosh-Sellavel @aldo-expensify I adding a listener to get the screen size. It's should reflect the screen size.

Copy link
Contributor

Choose a reason for hiding this comment

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

hum, I still don't understand how Dimensions.get('window'); would be outdated. From the documentation it looks like it should return the current width, up to date when is used by pushDrawerRoute.

I don't think this is necessary at all.

@Santhosh-Sellavel can you explain more why you think it would "not reflect correctly"?

Copy link
Collaborator

Choose a reason for hiding this comment

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

So let's go with the first way right @aldo-expensify or let's keep this? I'll leave it to you to decide.

Copy link
Contributor

@aldo-expensify aldo-expensify Jul 15, 2022

Choose a reason for hiding this comment

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

Thanks @Santhosh-Sellavel , I got a bit confused in the other conversation :P

Considering that the "first way" worked fine, I prefer the first way because it is more simple than keeping this variable up to date with a listener. Can you revert this last commit introducing the listener?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Cool! @mollfpr kindly update the PR

@mollfpr
Copy link
Contributor Author

mollfpr commented Jul 15, 2022

@aldo-expensify @Santhosh-Sellavel updated!

@Santhosh-Sellavel
Copy link
Collaborator

@Santhosh-Sellavel Can you help me to test on Android native? I can't run the android on my local. Thanks!

What issue you are facing in the local?

@Santhosh-Sellavel
Copy link
Collaborator

@mollfpr
We have a breakage here

Steps:

  1. Open the app in the expanded window.
  2. Click any chat
  3. Minimize the window
  4. Click back from the chat header
  5. Try to switch to a different chat but it's not working.
Bug1.mov

cc: @aldo-expensify

@aldo-expensify
Copy link
Contributor

@Santhosh-Sellavel I tried to reproduce the problem you see, but didn't happen to me. Does it always happen to you? or sometimes? can you check if you don't have the same problem in main?

@Santhosh-Sellavel
Copy link
Collaborator

I pulled from main and made the changes.

@mollfpr
Copy link
Contributor Author

mollfpr commented Jul 17, 2022

@Santhosh-Sellavel I'm unable to produce the above issue.

@Santhosh-Sellavel
Copy link
Collaborator

Reviewing again now.

@Santhosh-Sellavel
Copy link
Collaborator

@Santhosh-Sellavel Can you help me to test on Android native? I can't run the android on my local. Thanks!

What issue you are facing in the local?

@mollfpr

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jul 18, 2022

@Santhosh-Sellavel I tried to reproduce the problem you see, but didn't happen to me. Does it always happen to you? or sometimes? can you check if you don't have the same problem in main?

Pulled changes again today. Not reproducible now. But I'm afraid this might be a regression where I'm missing exact steps to reproduce now.

Copy link
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

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

Tested again and it seems to work fine.

I'll get another pair of eyes just to be sure.

@mollfpr
Copy link
Contributor Author

mollfpr commented Jul 21, 2022

What issue you are facing in the local?

I think it’s because I update my Java to 17, I did’nt have enough time to fix the JDK. Btw I’m using apple chip.

Copy link
Contributor

@Justicea83 Justicea83 left a comment

Choose a reason for hiding this comment

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

LGTM!

@Santhosh-Sellavel
Copy link
Collaborator

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.

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@aldo-expensify
Copy link
Contributor

thanks for reviewing again @Santhosh-Sellavel !

@aldo-expensify aldo-expensify merged commit c5fb877 into Expensify:main Jul 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.

@marcaaron
Copy link
Contributor

I do wish that a broader conversation would have been started about this PR and solution. Almost every issue dealing with react-navigation was put on hold a while back while so we could look at longer term more holistic solutions. This one still made it through somehow...

@Santhosh-Sellavel please recall these posts (maybe you have not seen them)

https://expensify.slack.com/archives/C02NK2DQWUX/p1652908236507109
https://expensify.slack.com/archives/C02NK2DQWUX/p1653333895007009

@aldo-expensify I'm not sure what I could have done differently here and not casting any blame for accepting this solution. Maybe I could have been more proactive here or there is some way to lock the file so it won't be edited anymore.

marcaaron added a commit that referenced this pull request Jul 26, 2022
marcaaron added a commit that referenced this pull request Jul 26, 2022
…ions2

[No QA] Revert #9706. Rename file to `DeprecatedCustomActions.js` to prevent further editing
@OSBotify
Copy link
Contributor

OSBotify commented Aug 1, 2022

🚀 Deployed to staging by @aldo-expensify in version: 1.1.87-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 4, 2022

🚀 Deployed to production by @yuwenmemon in version: 1.1.87-9 🚀

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.

6 participants