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 new line issue #436

Merged
merged 23 commits into from
Apr 20, 2022
Merged

fix new line issue #436

merged 23 commits into from
Apr 20, 2022

Conversation

ahmdshrif
Copy link
Contributor

@ahmdshrif ahmdshrif commented Mar 24, 2022

@roryabraham @rushatgabhane @iwiznia will you please review this?

fix mapping the block to newline (div,comment, h tags)
fix map table to a new line.

Details

the proposal for these 2 issues is here :
Expensify/App#7352 (comment)
Expensify/App#7644 (comment)

Fixed Issues

$ Expensify/App#7352
$ Expensify/App#7644

Tests

  1. What unit/integration tests cover your change? What autoQA tests cover your change?
    change this fix new line issue  #436 (comment)

  2. What tests did you perform that validates your changed worked?

QA

  1. What does QA need to do to validate your changes?
  2. What areas to they need to test for regressions?

use the cases I add on UT to be mapped as new lines.

Tests

  • 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. Open the app
  2. Copy a message with multiple line breaks
  3. Paste into another chat
  4. make sure the line break is working.
  5. copy any code from GitHub or editor
  6. past it on a chat.
  7. make sure the line break works when past.

uset the flow test cases :-

1- copy normal text hi this is test message
2- copy message contains number 123456
3- copy some links [link](www.google.com)
4- use code containing bold italic

*Lorem Ipsum* is simply dummy text of the _printing_ and typesetting industry.

Lorem Ipsum has been the industry's standard dummy text ever since the 1500s when an unknown printer took a galley of type and scrambled it to make a type specimen book.

Hello 👋

5- copy some lines from GitHub here (open the file and copy)
https://github.com/Expensify/App/blob/403fc28984e9d96f3127257a3dc3ac6e66a75cd6/src/components/TextInputFocusable/index.js#L263-L267

6- copy some code from the code editor (VS code for example)

  • Verify that no errors appear in the JS console
  • Verify line break is working fine on all cases

Screenshots

Web

copy multiple messages
https://user-images.githubusercontent.com/21364901/158659907-d8c1d90f-b641-4f10-af41-a51c5746811b.mov

copy from VScode
https://user-images.githubusercontent.com/21364901/158660512-af66417f-7c45-4b59-8264-4561e1fbc197.mov

copy from GitHub also works fine.
https://user-images.githubusercontent.com/21364901/158660921-9fff891f-be45-4cc8-94d3-8c9fd4aab0a1.mov

Mobile Web

Desktop

iOS

can't copy multiple messages

Android

can't copy multiple messages

@github-actions
Copy link

github-actions bot commented Mar 24, 2022

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@ahmdshrif
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@ahmdshrif ahmdshrif marked this pull request as ready for review March 24, 2022 07:24
@ahmdshrif ahmdshrif requested a review from a team as a code owner March 24, 2022 07:24
@melvin-bot melvin-bot bot requested review from amyevans and removed request for a team March 24, 2022 07:24
@rushatgabhane
Copy link
Member

rushatgabhane commented Mar 25, 2022

I'm gonna wait for approval here Expensify/App#7644 (comment)
In the meantime, @ahmdshrif could you please copy and fill the PR template from Expensify/App. Thanks!

And in details, link your proposal.

@ahmdshrif
Copy link
Contributor Author

ok, @rushatgabhane we get approval on 7644.
do we will include the fix for 7644 here or we will make a new pr

@rushatgabhane
Copy link
Member

do we will include the fix for 7644 here

@ahmdshrif yes please go ahead

@ahmdshrif ahmdshrif changed the title fix block new line fix new line issue Mar 29, 2022
iwiznia
iwiznia previously approved these changes Mar 29, 2022
Copy link
Contributor

@iwiznia iwiznia 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, but you have linting errors

@rushatgabhane
Copy link
Member

@ahmdshrif could you please add all the test cases to the tests and QA steps? Thanks so much!

@ahmdshrif
Copy link
Contributor Author

@iwiznia the project itself has a lot of linting issues. I fix this issue.
I think GitHub action will need approval to run the test again.

@ahmdshrif
Copy link
Contributor Author

ahmdshrif commented Mar 30, 2022

@rushatgabhane I make them as unit tests to run automatically instead of testing one by one manually.
but l add some tests also to QA steps

iwiznia
iwiznia previously approved these changes Mar 31, 2022
amyevans
amyevans previously approved these changes Apr 1, 2022
Copy link
Contributor

@amyevans amyevans left a comment

Choose a reason for hiding this comment

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

Looks okay to me. @roryabraham, you want a chance to review?

@rushatgabhane
Copy link
Member

I have some minor requests. I'm gonna loop back to this PR asap

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@ahmdshrif looks good, just some implementation changes requested.

Co-authored-by: Rushat Gabhane <[email protected]>
@ahmdshrif ahmdshrif dismissed stale reviews from amyevans and iwiznia via 786bcda April 3, 2022 17:21
Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@ahmdshrif I've addressed your comment about using indices.
A general note - wherever feasible, let's try to avoid mutation.

  • Mutation may lead to hard to debug and unexpected issues.
  • Mutation makes code harder to understand.

Thanks!

@ahmdshrif
Copy link
Contributor Author

ahmdshrif commented Apr 3, 2022

@rushatgabhane i do some refactors base on you review .

but for the mutation note i am not sure which line we should avoid mutation on it . if you mean replace . it return new string . also split do that . so they are immutable .

and we also return new string from mapBlock function .

Thanks

@rushatgabhane
Copy link
Member

rushatgabhane commented Apr 5, 2022

but for the mutation note i am not sure which line we should avoid mutation on it . if you mean replace . it return new string . also split do that . so they are immutable .

yeah, you're right! I must be mistaken

Co-authored-by: Rushat Gabhane <[email protected]>
Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@ahmdshrif general feedback is that we need to explain why and what of the code.

@ahmdshrif
Copy link
Contributor Author

@rushatgabhane ok now I add comments with details as you mention.
thanks.

Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

@ahmdshrif I've suggested some style changes.

Bug: The markdown formatting is lost after copying.
eg:

  1. Send this message normal text *bold* _italic_
  2. Copy and paste in compose box
Screen.Recording.2022-04-19.at.11.37.29.PM.mov

@ahmdshrif
Copy link
Contributor Author

ahmdshrif commented Apr 19, 2022

@rushatgabhane this issue repro in stage looks like other pr broken it. and should be reported as a new issue.
it looks new issue because it's not on prod yet.

also, i do the update you mention

thanks.

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

ahmdshrif and others added 2 commits April 19, 2022 22:43
Copy link
Member

@rushatgabhane rushatgabhane left a comment

Choose a reason for hiding this comment

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

this issue repro in stage looks like other pr broken it.

@ahmdshrif Yeah, you're right! Sorry for the confusion, and thanks for all the changes.

@roryabraham LGTM! 🎉

#### 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
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

LGTM. There could be edge cases like this where we wouldn't want a div to become a newline:

<div style="display: inline">
</div>

But I don't think that will be a real concern for our product, so we don't need to address it.

@roryabraham roryabraham merged commit 15237e0 into Expensify:main Apr 20, 2022
@ahmdshrif
Copy link
Contributor Author

Ok ,
Do we need another pr to update the liberary on app or you will update it automatically before any release . ?

@roryabraham
Copy link
Contributor

A separate PR in E/App will be needed.

@ahmdshrif
Copy link
Contributor Author

@roryabraham ok I raise a PR her Expensify/App#8743

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants