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 the blue frame caused by selection prop #19293

Merged
merged 7 commits into from
May 24, 2023

Conversation

ntdiary
Copy link
Contributor

@ntdiary ntdiary commented May 19, 2023

Details

Fixed Issues

$ #15105
PROPOSAL: #15105 (comment)

Tests

  1. Open a chat that has sent multiple messages.
  2. Long press a sent message, then select Edit option.
  3. Long press another sent message.
  4. Check that the highlight blue frame doesn't appear on the Delete option or backdrop.
  • Verify that no errors appear in the JS console

Offline tests

  1. Open a chat that has sent multiple messages.
  2. Long press a sent message, then select Edit option.
  3. Long press another sent message.
  4. Check that the highlight blue frame doesn't appear on the Delete option or backdrop.

QA Steps

  1. Open a chat that has sent multiple messages.
  2. Long press a sent message, then select Edit option.
  3. Long press another sent message.
  4. Check that the highlight blue frame doesn't appear on the Delete option or backdrop.
  • 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
web.mp4
Mobile Web - Chrome
mobile-chrome.mp4
Mobile Web - Safari
mobile-safari.mp4
Desktop
desktop.mp4
iOS
ios.mp4
Android
android.mp4

@ntdiary ntdiary marked this pull request as ready for review May 21, 2023 06:46
@ntdiary ntdiary requested a review from a team as a code owner May 21, 2023 06:46
@melvin-bot melvin-bot bot requested review from hayata-suenaga and parasharrajat and removed request for a team May 21, 2023 06:46
@melvin-bot
Copy link

melvin-bot bot commented May 21, 2023

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

@ntdiary
Copy link
Contributor Author

ntdiary commented May 22, 2023

Hi @parasharrajat @hayata-suenaga please feel free to let me know if there are any areas for improvement in this PR. : )

@parasharrajat
Copy link
Member

Yeah, I will check this in 2 hours.

hayata-suenaga
hayata-suenaga previously approved these changes May 22, 2023
Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

LGTM!

@arielgreen
Copy link
Contributor

Yeah, I will check this in 2 hours.

@parasharrajat it's been 8 hours -- have you had a chance to review? Please provide an update asap.

@parasharrajat
Copy link
Member

@ntdiary Can you please merge main into this?

@parasharrajat
Copy link
Member

Thanks. Testing it.

Comment on lines -1062 to +1070
autoFocus={!this.props.modal.isVisible && (this.shouldFocusInputOnScreenFocus || this.isEmptyChat()) && this.props.shouldShowComposeInput}
autoFocus={this.shouldAutoFocus}
Copy link
Member

Choose a reason for hiding this comment

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

It won't change after the component is mounted. For example when this.props.modal.isVisible or this.props.shouldShowComposeInput changes.

Copy link
Member

Choose a reason for hiding this comment

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

Silly me. This is autoFocus prop it only works on mount. 🐤

Comment on lines +211 to +212
start: isMobileSafari && !this.shouldAutoFocus ? 0 : props.comment.length,
end: isMobileSafari && !this.shouldAutoFocus ? 0 : props.comment.length,
Copy link
Member

Choose a reason for hiding this comment

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

How does safari handles the selection when props.comment is present. Basically, a report has a draft.

Copy link
Contributor Author

@ntdiary ntdiary May 23, 2023

Choose a reason for hiding this comment

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

After this change, even if there is a draft, the selection is 0 when the component mounts. When the user clicks the main composer input, the browser internally fires a selectionchange event, the selection will be updated based on the location clicked by the user.

Copy link
Member

Choose a reason for hiding this comment

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

Although currently the app does not have autofocus set on Safari I am asking this when we have set autofocus.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In general, only updating the selection of unfocused element will cause this issue.
autoFocus will focus the input before updating the selection, so there is no problem.

The only thing to note in the future is that when this.props.modal.willAlertModalBecomeVisible is true, autoFocus should be false.
Because at this time, although autoFocus will focus the input first, focus trap will immediately defocus the input (this is synchronous, so it is executed before updating the selection), which means that when the selection is updated later, the input is still unfocused.

},
isFocused: false,
hasExceededMaxCommentLength: false,
};
}

componentDidMount() {
this.setState((prevState) => ({
Copy link
Member

Choose a reason for hiding this comment

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

Please add a comment explaining the reason behind doing this even though it is added on composer/

@parasharrajat
Copy link
Member

parasharrajat commented May 23, 2023

Screenshots

🔲 iOS / native

Screen.Recording.2023-05-24.at.11.02.34.PM.mov

🔲 iOS / Safari

Screen.Recording.2023-05-24.at.11.08.26.PM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-05-24.at.11.50.37.PM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-05-24.at.11.28.15.PM.mov

🔲 Android / Chrome

Screen.Recording.2023-05-24.at.11.10.24.PM.mov

🔲 Android / native

tt.Screen.Recording.2023-05-24.at.11.06.00.PM.mov

@parasharrajat
Copy link
Member

Testing for one thing.

@parasharrajat
Copy link
Member

BUG: Android: Report Composer is not focused on load when report is empty.

Steps:

  1. Create a Dm with someone.
  2. Open any other report.
  3. GO back to LHN.
  4. Reopen the newly created Chat.

Expected: Composer should be focused.

@ntdiary
Copy link
Contributor Author

ntdiary commented May 24, 2023

BUG: Android: Report Composer is not focused on load when report is empty.

@parasharrajat , I failed to reproduce the problem. Is there something wrong with my steps? 🤔

test-2.mp4

@parasharrajat
Copy link
Member

Ok, Thanks. Let me recheck. I will try cache cleanup this time. I wasn't also able to reproduce this consistently.

@parasharrajat
Copy link
Member

Ok, it seems to be working now. Completing the checklist.

@parasharrajat
Copy link
Member

parasharrajat commented May 24, 2023

I am facing strange issues on iOS with focusing. (Not related to this issue).

  1. when I try to edit a message when one is already in edit mode, newly edited message does not get focused.
  2. when I try to edit a message when one is already in edit mode and focused, newly edited message does not get focused instead previous message get focused.

This is same on 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: @hayata-suenaga

🎀 👀 🎀 C+ reviewed

Copy link
Contributor

@hayata-suenaga hayata-suenaga left a comment

Choose a reason for hiding this comment

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

LGTM

@hayata-suenaga hayata-suenaga merged commit b69b1c5 into Expensify:main May 24, 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/hayata-suenaga in version: 1.3.18-0 🚀

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

@OSBotify
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

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

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

@mvtglobally
Copy link

@ntdiary @parasharrajat @arielgreen We are not seeing blue border on Safari, but I think there was a really old KI about it.
Can you pls double check if we should log an issue here ?

Screen.Recording.2023-05-25.at.16.09.11.mov

@parasharrajat
Copy link
Member

Which blue border?

@yuwenmemon
Copy link
Contributor

Yes, I believe the whole point is that the blue border shouldn't appear? So it seems everything is working as expected

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.18-2 🚀

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.

7 participants