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

App allows '÷×' symbols in legal name even though error states that 'Name can only include letters' #25615

Merged
merged 1 commit into from
Aug 23, 2023
Merged

Conversation

Pluto0104
Copy link
Contributor

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

Details

The application currently allows the use of the symbols ÷ and × in the legal name field, which is not intended. This behavior is caused by the ALPHABETIC_AND_LATIN_CHARS regular expression in the codebase. This regular expression includes the Latin character range À-ÿ, which unintentionally includes the × and ÷ symbols.

To address this issue, I suggest modifying the following constants:

ALPHABETIC_AND_LATIN_CHARS: /^[\p{Script=Latin} ]*$/u
NON_ALPHABETIC_AND_NON_LATIN_CHARS: /[^\p{Script=Latin}]/gu

The updated ALPHABETIC_AND_LATIN_CHARS regular expression matches any string that consists of one or more characters from the Latin script. The NON_ALPHABETIC_AND_NON_LATIN_CHARS regular expression matches any character that is not a Latin character.

Fixed Issues

$ #24508
PROPOSAL: #24508 (comment)

Tests

  1. Go to Settings > Profile > Personal details > Legal name.
  2. In either the First name or Last name field, input the characters ÷ or ×. If you are using a web browser, you can copy and paste the characters from another source. For mobile devices, switch the keyboard to the number keypad to access these symbols.
  3. Once you have entered the characters, click on the Save button.
  4. Verify that the app does not allow you to save the data, indicating that the use of ÷ and × symbols in the legal name field is not permitted.
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to Settings > Profile > Personal details > Legal name.
  2. In either the First name or Last name field, input the characters ÷ or ×. If you are using a web browser, you can copy and paste the characters from another source. For mobile devices, switch the keyboard to the number keypad to access these symbols.
  3. Once you have entered the characters, click on the Save button.
  4. Verify that the app does not allow you to save the data, indicating that the use of ÷ and × symbols in the legal name field is not permitted.

QA Steps

  1. Go to Settings > Profile > Personal details > Legal name.
  2. In either the First name or Last name field, input the characters ÷ or ×. If you are using a web browser, you can copy and paste the characters from another source. For mobile devices, switch the keyboard to the number keypad to access these symbols.
  3. Once you have entered the characters, click on the Save button.
  4. Verify that the app does not allow you to save the data, indicating that the use of '÷' and '×' symbols in the legal name field is not permitted.
  • 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web

Mobile Web - Chrome

chrome

Mobile Web - Safari

safari

Desktop

desktop

iOS

iOS

Android

android

@Pluto0104 Pluto0104 requested a review from a team as a code owner August 21, 2023 19:19
@melvin-bot melvin-bot bot removed the request for review from a team August 21, 2023 19:19
@melvin-bot
Copy link

melvin-bot bot commented Aug 21, 2023

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

@melvin-bot melvin-bot bot requested a review from robertKozik August 21, 2023 19:19
@Pluto0104
Copy link
Contributor Author

Hi @robertKozik, Thank you for your time.
If we only want to validate standard Latin letters without considering any combining marks, \p{Script=Latin} would be sufficient. but if we want to validate Latin characters and their possible combinations with combining marks (diacritics), then \p{Script=Latin}\p{M} would be more suitable.

Considering the current code is using \p{Script=Latin} for only standard Latin letters, if we want to include the validation of Latin characters with combining marks, we should indeed add \p{M} to the pattern.

@robertKozik
Copy link
Contributor

@Pluto0104 Do we allow them until now?

@Pluto0104
Copy link
Contributor Author

Pluto0104 commented Aug 22, 2023

@Pluto0104 Do we allow them until now?

@robertKozik No, we only allowed ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ and ÷×. - À-ÿ until now. These characters are included in Script=Latin

@Pluto0104
Copy link
Contributor Author

@robertKozik so should we add them \p{M} to the pattern? If so, I can make the necessary changes and submit the pull request within 10 minutes.

@robertKozik
Copy link
Contributor

Sorry I went OOO for today, I'll come back to this PR tommorow. But basically I would stick to the behaviour we have until now

@robertKozik No, we only allowed ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõöøùúûüýþÿ and ÷×. - À-ÿ until now. These characters are included in Script=Latin

So i believe tour current changes are sufficient right?

@Pluto0104
Copy link
Contributor Author

Pluto0104 commented Aug 22, 2023

@robertKozik that's correct. thank you for your time.

@robertKozik
Copy link
Contributor

robertKozik commented Aug 23, 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
web.mov
Mobile Web - Chrome
android.web.mov
Mobile Web - Safari
ios.web.mov
Desktop
desktop.mov
iOS
iOS.-.native.mov
Android
android.-.native.mov

Copy link
Contributor

@robertKozik robertKozik left a comment

Choose a reason for hiding this comment

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

Looking good, let's push it forward

@melvin-bot melvin-bot bot requested a review from luacmartins August 23, 2023 09:55
@luacmartins luacmartins merged commit 8d70ff5 into Expensify:main Aug 23, 2023
13 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/luacmartins in version: 1.3.57-0 🚀

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

@kassahun-asefa
Copy link

I reported a similar bug a month ago. It was about using numbers in legal names. The error says 'only letters'. Is it okay if it includes numbers?

@madmax330
Copy link
Contributor

@robertKozik
Copy link
Contributor

@madmax330 the issue from slack is 11 days old - this PR was deployed on staging 4 hours ago. Are you sure this one caused it?

@madmax330
Copy link
Contributor

Good point, maybe this one? https://github.com/Expensify/App/pull/23650/files although not sure how that would cause a regression

@robertKozik
Copy link
Contributor

I'm not sure tbh, last change before the pull you provided is actually from the PR which fixes the Spanish characters.

But I think we have never supported non-latin chars (only latin with diacritics - for example the Spanish ones are working fine) - the video from the slack issue uses the Chinese characters which are not supported in regex even before the PR.

@Pluto0104
Copy link
Contributor Author

I'm not sure tbh, last change before the pull you provided is actually from the PR which fixes the Spanish characters.

But I think we have never supported non-latin chars (only latin with diacritics - for example the Spanish ones are working fine) - the video from the slack issue uses the Chinese characters which are not supported in regex even before the PR.

You're right - @robertKozik.

Even before this PR, we have never supported other characters except Latin and alphabetic ones. And current PR actually removed non-Latin characters such as ÷ and × from previous regex. So I don't think this causes a regression.

@madmax330
Copy link
Contributor

Cool, thanks guys

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.58-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.57-6 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.58-5 🚀

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.

6 participants