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/ copmpser hide on change screen size #18702

Merged
merged 10 commits into from
May 12, 2023

Conversation

ahmdshrif
Copy link
Contributor

@ahmdshrif ahmdshrif commented May 10, 2023

Details

F ix composer hides/show on change screen size by:

  1. Hide composer depending on screen size directly not shouldShowCompeInput on large screens.
  2. Keep shouldShowComposeInput to track if the composer will be hidden in case resize to a small screen we update the state on both large and small screens.
  3. prevent the composer from focus if shouldShowCompeInput is false . to prevent autofocus when showing the composer in resize from small to large screens.

Fixed Issues

$ #18229
PROPOSAL: #18229 (comment)

Tests

  1. Login to Expensify and start a conversation on a small screen size.
  2. Send a message and click the "Edit" button to edit the message.
  3. Change the screen size from mobile width to web or tablet width.
  4. Click "Cancel" to exit the edit mode.
  5. Verify that After canceling the edit, the composer is displayed.
  • Verify that no errors appear in the JS console

Offline tests

  1. Login to Expensify and start a conversation on a small screen size.
  2. Send a message and click the "Edit" button to edit the message.
  3. disconnect your wifi or internet connection.
  4. Change the screen size from mobile width to web or tablet width.
  5. Click "Cancel" to exit the edit mode.
  6. Verify that After canceling the edit, the composer is displayed.
  • Verify that no errors appear in the JS console

QA Steps

test case1 :

  1. Login to Expensify and start a conversation on a small screen size.
  2. Send a message and click the "Edit" button to edit the message.
  3. Change the screen size from mobile width to web or tablet width.
  4. Verify that After canceling the edit, the composer is displayed.

test case2 :

  1. Login to Expensify and start a conversation on a large screen size.
  2. Send a message and click the "Edit" button to edit the message.
  3. Change the screen size from large width to small width.
  4. Verify that the composer is hidden.
  • 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
    • 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 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-05-10.at.8.39.51.AM.mov
Mobile Web - Chrome
Screen.Recording.2023-05-10.at.11.00.53.AM.mov
Mobile Web - Safari
Screen.Recording.2023-05-11.at.8.35.32.PM.mov
Desktop
Screen.Recording.2023-05-10.at.8.44.57.AM.mov
iOS
Screen.Recording.2023-05-11.at.9.14.45.PM.mov
Android
Screen.Recording.2023-05-10.at.10.55.11.AM.mov

@ahmdshrif ahmdshrif force-pushed the fix/Composer-not-displayed branch from 659e484 to 5d8cf14 Compare May 10, 2023 06:24
@ahmdshrif
Copy link
Contributor Author

ahmdshrif commented May 10, 2023

I re-test the issue and do some changes to my proposal because in some cases I find it when working on this issue

1- I expect if I am in edit mode and the screen changed from small size to large size:-

  • the composer should appear without pressing cancel.
  • the main composer should appear but not focused and the edit composer should be focused and
  • edit composer shouldn't have focus color.

2- I expect if I am in edit mode and the screen changed from large to small screen:-

  • the composer should disappear directly without pressing cancel.
  • the edit composer still focuses.
  • when canceling the edit mode composer showed again.

To implement this, we will need to save the state of the composer on all screen sizes. This means that if a user is editing on a large screen and then switches to a small screen, the state should be saved so that the composer is not shown on the small screen. We will then make the composer appear on the large screen regardless of whether this state is true or false, but we will depend on the saved state to unfocus the composer in the large screen size.

also, I am not including the screenshot on native because we can only resize on desktop and web

@ahmdshrif ahmdshrif marked this pull request as ready for review May 10, 2023 07:11
@ahmdshrif ahmdshrif requested a review from a team as a code owner May 10, 2023 07:11
@melvin-bot melvin-bot bot requested review from parasharrajat and roryabraham and removed request for a team May 10, 2023 07:11
@melvin-bot
Copy link

melvin-bot bot commented May 10, 2023

@roryabraham @parasharrajat 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]

@@ -769,7 +772,7 @@ class ReportActionCompose extends React.Component {
const isComposeDisabled = this.props.isDrawerOpen && this.props.isSmallScreenWidth;
const isBlockedFromConcierge = ReportUtils.chatIncludesConcierge(this.props.report) && User.isBlockedFromConcierge(this.props.blockedFromConcierge);
const inputPlaceholder = this.getInputPlaceholder();
const shouldUseFocusedColor = !isBlockedFromConcierge && !this.props.disabled && (this.state.isFocused || this.state.isDraggingOver);
const shouldUseFocusedColor = !isBlockedFromConcierge && !this.props.disabled && (this.state.isFocused || this.state.isDraggingOver) && this.props.shouldShowComposeInput;
Copy link
Member

Choose a reason for hiding this comment

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

Same for this. Why do we need this? This component will be mounted only when shouldShowComposeInput is true. We show the focused border only when the composer is being focused or an attachment is being dragged over.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes exactly if you remove this condition .... the composer will not be focused but have the focused border color in when you resize from a small to a large screen in edit mode.

but I think you mean we should move this condition to isFocuse init state like that :

            isFocused: this.willBlurTextInputOnTapOutside && !this.props.modal.isVisible && !this.props.modal.willAlertModalBecomeVisible && this.props.shouldShowComposeInput,

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat I move it to init state check last update

@@ -1,3 +1,3 @@
import * as Composer from '../actions/Composer';
import * as Composer from './actions/Composer';

export default (shouldShowComposeInput) => Composer.setShouldShowComposeInput(shouldShowComposeInput);
Copy link
Member

Choose a reason for hiding this comment

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

We don't need this lib at all. Let's call Composer.setShouldShowComposeInput directly,

Copy link
Contributor Author

@ahmdshrif ahmdshrif May 11, 2023

Choose a reason for hiding this comment

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

@parasharrajat I agree. Please check the last update.

@ahmdshrif ahmdshrif requested a review from parasharrajat May 11, 2023 10:41
@parasharrajat
Copy link
Member

parasharrajat commented May 11, 2023

Screenshots

🔲 iOS / native

Screen.Recording.2023-05-11.at.10.58.38.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-05-11.at.11.33.08.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-05-12.at.12.59.08.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-05-11.at.11.31.29.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-05-12.at.12.57.37.AM.mov

🔲 Android / native

Screen.Recording.2023-05-12.at.2.15.17.AM.mov

@ahmdshrif
Copy link
Contributor Author

@parasharrajat I mention in comment the that we can only resize on the web and desktop.
how do you expect screenshots on native Android and ios ???

@parasharrajat
Copy link
Member

how do you expect screenshots on native Android and ios ???

It should show the behavior of the composer as it works on staging.

@parasharrajat
Copy link
Member

Can you please merge main as well?

@ahmdshrif
Copy link
Contributor Author

Sure I merge it many times but looks like we have many changes today :D

@ahmdshrif
Copy link
Contributor Author

@parasharrajat I include screenShots for native and merge main

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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

cc: @roryabraham

🎀 👀 🎀 C+ reviewed

@parasharrajat
Copy link
Member

Bump @roryabraham

@roryabraham roryabraham merged commit 853f2c7 into Expensify:main May 12, 2023
@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/roryabraham in version: 1.3.14-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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.

4 participants