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

Migrate Composer. web #23359

Merged
merged 24 commits into from
Aug 15, 2023
Merged

Migrate Composer. web #23359

merged 24 commits into from
Aug 15, 2023

Conversation

perunt
Copy link
Contributor

@perunt perunt commented Jul 21, 2023

Details

Fixed Issues

$ #16129
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

This PR updated the composer related to text input only on WEB

Test Case 1: Input Functionality

  1. Input random characters in the text box and verify that the entered characters are correctly displayed.
  2. Try to input various types of text, such as emojis, special characters, numbers, and a mixture of these.
  3. Check for proper functionality in both normal and capitalized modes.

Test Case 2: Multiline Input Functionality

  1. Try to input a multiline text in the text box.
  2. Verify that the text formatting (like new lines, spaces, etc.) is correctly retained and displayed.
  3. Check the scrolling functionality for multiline inputs.

Test Case 3: Focus Functionality

  1. Switch between the text box and the emoji picker multiple times, and verify that the focus is correctly switched each time.
  2. Verify that the text box regains focus when coming back from the emoji picker.

Test Case 4: Style Functionality

  1. Try to input a text that should trigger style changes (like shrinking or expanding).
  2. Verify that the style changes are correctly displayed.
  3. Check if these changes are retained when switching between different interfaces (like going to the emoji picker and coming back).

Test Case 5: Message Sending Functionality

  1. After inputting a message, hit the send button and verify that the message is sent.
  2. Verify that the text box is cleared after the message is sent.
  3. Check if the sent message is correctly displayed in the chat history.
  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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-07-27.at.14.18.50.mov
Mobile Web - Chrome
telegram-cloud-document-2-5336800175870455938.mp4
Mobile Web - Safari
Screen.Recording.2023-07-27.at.14.46.54.mov
Desktop
Screen.Recording.2023-07-27.at.15.07.41.mov
iOS
Android

@perunt perunt marked this pull request as ready for review July 27, 2023 13:17
@perunt perunt requested a review from a team as a code owner July 27, 2023 13:17
@melvin-bot melvin-bot bot requested review from ArekChr and removed request for a team July 27, 2023 13:17
@melvin-bot
Copy link

melvin-bot bot commented Jul 27, 2023

@ArekChr Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@ArekChr
Copy link
Contributor

ArekChr commented Jul 28, 2023

@perunt, please fix the lint issues. You can use the lint command from package.json scripts

@perunt
Copy link
Contributor Author

perunt commented Jul 28, 2023

it's quite weird that optional chaining is prohibited, as I saw it in the code
fixed, thanks @ArekChr !

src/components/Composer/index.js Outdated Show resolved Hide resolved
src/components/Composer/index.js Outdated Show resolved Hide resolved
caretContent: this.getNextChars(this.props.value, event.nativeEvent.selection.start),
},
const addCursorPositionToSelectionChange = (event) => {
flushSync(() => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you explain the usage of flushSync here?

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 need to return up-to-date data for positioning an inline autosuggestion within the callback. If we remove flushSync, we will receive an outdated value, which will lag(be delayed) by one value

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, thanks for the explanation!

ref={setTextInputRef}
selection={selection}
style={[
StyleSheet.flatten([style, {outline: 'none'}]),
Copy link
Contributor

Choose a reason for hiding this comment

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

In some places, implementation is slightly different. Could you explain why these changes? There is no outline: 'none', old code.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We use the outline in the old code here
do you mean using useMemo for this?

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks, it's ok, I couldn't find this style because git diff changes are going crazy, harder to compare

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, sometimes it just gets too messy 😄

src/components/Composer/index.js Outdated Show resolved Hide resolved
src/components/Composer/index.js Outdated Show resolved Hide resolved
Copy link
Contributor

@ArekChr ArekChr left a comment

Choose a reason for hiding this comment

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

Overall LGTM, please fix lint errors.

@perunt
Copy link
Contributor Author

perunt commented Aug 4, 2023

@ArekChr should be good to go

@ArekChr
Copy link
Contributor

ArekChr commented Aug 4, 2023

Hey @perunt, it looks like the test steps are missing. Could you update the location where I can check the logs, especially if no errors occur? Thank you!

Copy link
Contributor

@ArekChr ArekChr left a comment

Choose a reason for hiding this comment

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

I compared both files separately because the git diff was difficult to follow. It appears that the implementations have slightly changed, e.g. updateNumberOfLines has been removed. Please retain the original logic and only rewrite the class lifecycle methods with hooks, so the outcome will more accurately reflect the original implementation.

src/components/Composer/index.js Outdated Show resolved Hide resolved
src/components/Composer/index.js Show resolved Hide resolved
src/components/Composer/index.js Outdated Show resolved Hide resolved
@AndrewGable AndrewGable requested a review from a team August 4, 2023 15:06
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team August 4, 2023 15:06
@perunt
Copy link
Contributor Author

perunt commented Aug 14, 2023

@ArekChr, any issue here so far?

@allroundexperts
Copy link
Contributor

allroundexperts commented Aug 15, 2023

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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-08-15.at.4.24.42.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-08-15.at.4.41.19.PM.mov
Mobile Web - Safari
Screen.Recording.2023-08-15.at.4.39.48.PM.mov
Desktop
Screen.Recording.2023-08-15.at.5.02.07.PM.mov
iOS
Screen.Recording.2023-08-15.at.4.58.01.PM.mov
Android
Screen.Recording.2023-08-15.at.4.51.17.PM.mov

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Tests well!

Screen recordings are missing for iOS and android but I'm approving it since this is urgent.

@Expensify Expensify deleted a comment from ArekChr Aug 15, 2023
@perunt
Copy link
Contributor Author

perunt commented Aug 15, 2023

It's a WEB-only change, next time will add it.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks for the quick testing @allroundexperts

@perunt Keep an eye on #expensify-bugs in case there is anything new from this refactoring as its quite complex

checkComposerVisibility: () => false,
};
// Get characters from the cursor to the next space or new line
const getNextChars = (str, cursorPos) => {
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that would be handy but we can make it in a follow up PR

@mountiny mountiny merged commit 61ab4bc into Expensify:main Aug 15, 2023
13 of 15 checks passed
@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/mountiny in version: 1.3.55-0 🚀

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

@bondydaa
Copy link
Contributor

looks like this caused this regression #25409 where if you copy some text, open any RHP then paste it will paste your clipboard contents twice.

@ShogunFire
Copy link
Contributor

And maybe this one: #25413

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.56-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

@situchan
Copy link
Contributor

Coming from #25413:
This could have been caught and fixed earlier if edit message was thoroughly tested on all platforms, especially initial cursor position.

@aimane-chnaif
Copy link
Contributor

This caused Web - App adds extra line in edit message box
More details about the root cause: #27622 (comment)

Comment on lines +182 to +187
setSelection((prevSelection) => {
if (!!prevSelection && selectionProp.start === prevSelection.start && selectionProp.end === prevSelection.end) {
return;
}
return selectionProp;
});
Copy link
Contributor

Choose a reason for hiding this comment

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

Coming from #44259, instead of using a set state function updater, we can use setState function directly

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.