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

Disabling spell check on multiple pages #23447

Merged
merged 2 commits into from
Aug 2, 2023
Merged

Conversation

chiragxarora
Copy link
Contributor

@chiragxarora chiragxarora commented Jul 23, 2023

Details

Pronouns input and multiple others show spelling error by red underline

Fixed Issues

$ #23303
PROPOSAL: #23303 (comment)

Tests

  1. open the app
  2. go to settings > profile > pronouns
  3. select fae/faer and go back
  4. open the pronouns page again and see no red underline
  5. go to profile > display name and enter ksnkdnsd for first name and last name
  6. observe no red underline
  7. do the same for legal name
  8. go to FAB > new chat and enter ksnkdnsd
  9. o to FAB > new group and enter ksnkdnsd
  10. request money > enter amount > now again enter ksnkdnsd
  11. split bill > enter amount > now again enter ksnkdnsd
  12. go to settings > workspaces > new workspace > settings > WS name, do the same
  13. go to workspace > pick one > members > enter ksnkdnsd
  14. go to workspace > members > invite > enter ksnkdnsd
  15. click FAB > assign task > enter ksnkdnsd in title > complete other details > open the task again from report
  16. go to settings > payments > debit card > enter ksnkdnsd in name & shipping address
  17. go to settings > profile > personal details > home address > enter ksnkdnsd in address lines, state, city
  18. click FAB > new room > enter ksnkdnsd in room name
  19. observe that in all of the above, there is no red underline
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. open the app
  2. go to settings > profile > pronouns
  3. select fae/faer and go back
  4. open the pronouns page again and see no red underline
  5. go to profile > display name and enter ksnkdnsd for first name and last name
  6. observe no red underline
  7. do the same for legal name
  8. go to FAB > new chat and enter ksnkdnsd
  9. o to FAB > new group and enter ksnkdnsd
  10. request money > enter amount > now again enter ksnkdnsd
  11. split bill > enter amount > now again enter ksnkdnsd
  12. go to settings > workspaces > new workspace > settings > WS name, do the same
  13. go to workspace > pick one > members > enter ksnkdnsd
  14. go to workspace > members > invite > enter ksnkdnsd
  15. click FAB > assign task > enter ksnkdnsd in title > complete other details > open the task again from report
  16. go to settings > payments > debit card > enter ksnkdnsd in name & shipping address
  17. go to settings > profile > personal details > home address > enter ksnkdnsd in address lines, state, city
  18. click FAB > new room > enter ksnkdnsd in room name
  19. observe that in all of the above, there is no red underline
  • 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-25.at.11.24.38.PM.mov
Mobile Web - Chrome
256022293-2c15e912-fc18-40f8-beb6-3a386479f5e7.mov
Mobile Web - Safari
256022270-486e0bad-4d97-4355-92cc-21ed9c78f15b.mov
Desktop
Screen.Recording.2023-07-26.at.1.02.23.AM.mov
iOS
Screen.Recording.2023-07-26.at.12.53.14.AM.mov
Android
256022629-66dad2ba-2cac-44a3-b3d1-22da448a7f69.mov

@chiragxarora chiragxarora requested a review from a team as a code owner July 23, 2023 20:18
@melvin-bot melvin-bot bot removed the request for review from a team July 23, 2023 20:18
@melvin-bot
Copy link

melvin-bot bot commented Jul 23, 2023

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@melvin-bot melvin-bot bot requested a review from parasharrajat July 23, 2023 20:19
@melvin-bot
Copy link

melvin-bot bot commented Jul 23, 2023

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

@chiragxarora
Copy link
Contributor Author

@parasharrajat can you review the PR?

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.

Replace shouldEnableSpellCheck with spellCheck everywhere https://reactnative.dev/docs/textinput#spellcheck-ios

src/components/TextInput/baseTextInputPropTypes.js Outdated Show resolved Hide resolved
src/components/TextInput/baseTextInputPropTypes.js Outdated Show resolved Hide resolved
@chiragxarora
Copy link
Contributor Author

chiragxarora commented Jul 25, 2023

fixed, pls check now @parasharrajat

@@ -103,6 +103,7 @@ function NewTaskPage(props) {
autoGrowHeight
textAlignVertical="top"
containerStyles={[styles.autoGrowHeightMultilineInput]}
spellCheck={false}
Copy link
Member

Choose a reason for hiding this comment

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

We should allow it be checked here.

Suggested change
spellCheck={false}

Copy link
Member

Choose a reason for hiding this comment

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

Can you please rename the component name in this file to be NewTaskDetailsPage?

@@ -100,6 +100,7 @@ function NewTaskTitlePage(props) {
inputID="taskTitle"
label={props.translate('task.title')}
accessibilityLabel={props.translate('task.title')}
spellCheck={false}
Copy link
Member

Choose a reason for hiding this comment

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

Same as previous.

Suggested change
spellCheck={false}

@@ -88,6 +88,7 @@ function TaskTitlePage(props) {
accessibilityLabel={props.translate('task.title')}
defaultValue={(props.report && props.report.reportName) || ''}
ref={(el) => (inputRef.current = el)}
spellCheck={false}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
spellCheck={false}

@@ -135,6 +135,7 @@ function WorkspaceSettingsPage(props) {
containerStyles={[styles.mt4]}
defaultValue={props.policy.name}
maxLength={CONST.WORKSPACE_NAME_CHARACTER_LIMIT}
spellCheck={false}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
spellCheck={false}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is for workspaces's name, here too? I think for any kind of name spell check should be off, I can remove it if its supposed to, just asking again for confirmation

Copy link
Member

Choose a reason for hiding this comment

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

IMO, we should keep spell check on this. because this does not come under

  1. Person Name.
  2. Place name.
  3. Entity Name.
  4. Fixed terms.
  5. Preselection list.
  6. filter.
  7. Search.

What do you say?

Copy link
Member

Choose a reason for hiding this comment

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

These can be proper words too so it is better so show spell errors on mistype.

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 think in most cases they will have names of some organizations which usually aren't proper english words

Copy link
Member

Choose a reason for hiding this comment

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

Ok, then its fine. We can turn off spellcheck here.

Copy link
Member

Choose a reason for hiding this comment

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

as you mentioned disabled it.

@parasharrajat
Copy link
Member

Bump @chiragxarora

@parasharrajat
Copy link
Member

Attach following.

Screenshot 2023-07-26 at 12 08 48 AM

@parasharrajat
Copy link
Member

I am waiting on your updates. Please let me know when done.

@chiragxarora
Copy link
Contributor Author

done @parasharrajat , uploading attachments

@parasharrajat
Copy link
Member

@chiragxarora Can you please merge main?

@chiragxarora
Copy link
Contributor Author

done

@chiragxarora
Copy link
Contributor Author

chiragxarora commented Jul 25, 2023

Screenshot 2023-07-26 at 1 18 47 AM
Screen.Recording.2023-07-26.at.1.15.40.AM.mov

I'm unable to test for msafari, its not letting me sign in, was facing this error on web browser too, its throwing 429 error "too many requests"
@parasharrajat can you try this?

@parasharrajat
Copy link
Member

parasharrajat commented Jul 25, 2023

#23447 (comment)

You should be after merging main. That's why I asked. Restart all servers and test on the latest commit of this branch.

@parasharrajat
Copy link
Member

parasharrajat commented Jul 25, 2023

Screenshots

🔲 iOS / native

Screen.Recording.2023-07-26.at.1.25.16.AM.mov

🔲 iOS / Safari

Screen.Recording.2023-07-26.at.1.23.33.AM.mov

🔲 MacOS / Desktop

Screen.Recording.2023-07-26.at.1.19.52.AM.mov

🔲 MacOS / Chrome

Screen.Recording.2023-07-26.at.1.18.25.AM.mov

🔲 Android / Chrome

Screen.Recording.2023-07-26.at.1.24.25.AM.mov

🔲 Android / native

Screen.Recording.2023-07-26.at.1.28.37.AM.mov

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.

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot bot requested a review from grgia July 25, 2023 20:01
@parasharrajat
Copy link
Member

@chiragxarora Please merge main. Bump @grgia for review.

@chiragxarora chiragxarora force-pushed the fix/23303 branch 2 times, most recently from 39a4385 to 75e737b Compare July 26, 2023 16:37
@chiragxarora chiragxarora reopened this Jul 26, 2023
@chiragxarora
Copy link
Contributor Author

merge conflicts were too complex(for me I guess), I've merged main and reapplied the changes, you can have a look @parasharrajat

@grgia
Copy link
Contributor

grgia commented Jul 28, 2023

@chiragxarora sorry, there's one more conflicts

@chiragxarora
Copy link
Contributor Author

conflicts resolved @grgia , pls have a look again, thankyou

@chiragxarora
Copy link
Contributor Author

bump: @grgia

@grgia grgia merged commit d228257 into Expensify:main Aug 2, 2023
10 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 2, 2023

✋ 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

OSBotify commented Aug 3, 2023

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.50-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 7, 2023

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.50-3 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 7, 2023

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.51-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 9, 2023

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-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.

4 participants