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

Add html input validation in the form component #15315

Merged
merged 17 commits into from
Mar 10, 2023
Merged

Conversation

ctkochan22
Copy link

@ctkochan22 ctkochan22 commented Feb 21, 2023

Details

WAF input rules filter out html/xml tags in most API parameters. Given that we rarely want users to submit html tags as inputs, we have decided to validate all inputs for html. And we will do so in the Form component.

Here is what it would look like:
First/Last Name-
image

Workspage Settings -> General -
image

Fixed Issues

$ #14610
PROPOSAL: GH - Slack

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Let's test that it picks up for html tags, but the focus here is to make sure we don't have regressions

  • WorkspaceNewRoomPage.js
    • Create a new workspace room.
    • Add a name with html tags test<b>. Verify that there is an error
    • Now delete part of it so that it looks like test< and verify that you get an error saying you can only have characters
    • Now delete it so that its just text test. Verify that error is gone.
    • Select a workspace below that field. And submit and verify that you can create a workspace room
    • https://recordit.co/JgPnzb7FZf
  • CloseAccountPage.js
    • Have an account you're willing to close
    • Go to Security -> Close Account
    • Type in a message with html tags hello <b>. Verify you get an error
    • Now remove the html tag, hello
    • Add the email and close the account.
    • https://recordit.co/64J5ZbsT7i
  • WorkspaceSettingsPage.js
    • Go to Workspace Settings -> General Settings. Input <b> </b> as the workspace name. Verify that you see an error when you blur the field or submit the form
    • Remove the tags, add a valid name, and confirm that workspace name saves successfully
    • https://recordit.co/WW3Ne7UKHZ
  • DisplayName
    • Go to settings -> profile. Display Name
    • Add a name with a html tag in it Kosuke<b>. Verify that you get an error message
    • Remove the tag and verify that you can add a name successfully

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 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 correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies 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

0eTSnGSP6r

Web

https://recordit.co/0eTSnGSP6r

Mobile Web - Chrome

https://recordit.co/cIOjb7gHc7

Mobile Web - Safari

https://recordit.co/0L0CmlQRJF

Desktop

https://recordit.co/rrvronUa7p

iOS

https://recordit.co/6mxyX6mqLe

Android

https://recordit.co/F8zbIrxmPn

@ctkochan22 ctkochan22 requested a review from marcaaron February 21, 2023 06:03
@ctkochan22 ctkochan22 requested a review from a team as a code owner February 21, 2023 06:03
@ctkochan22 ctkochan22 self-assigned this Feb 21, 2023
@melvin-bot melvin-bot bot requested review from eVoloshchak and tgolen and removed request for a team February 21, 2023 06:03
@MelvinBot
Copy link

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

@ctkochan22 ctkochan22 changed the base branch from master to main February 21, 2023 06:05
@MelvinBot
Copy link

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

@ctkochan22 ctkochan22 changed the title [WIP] Add html input validation in the form component Add html input validation in the form component Feb 22, 2023
@ctkochan22 ctkochan22 changed the title Add html input validation in the form component Validate for anything that looks like html/xml tags in the form component Feb 22, 2023
@ctkochan22 ctkochan22 changed the title Validate for anything that looks like html/xml tags in the form component Add html input validation in the form component Feb 22, 2023
@ctkochan22
Copy link
Author

Waiting on copy, but ready for an initial review. Been testing it pretty heavily

@eVoloshchak
Copy link
Contributor

Tests well on all platforms
I think there are cases where this error superseding other errors isn't the best option, for instance on BankAccountManualStep. The error will be Please enter a valid routing number for every symbol or invalid combination of symbols, except for when there is a tag.
image
This is a small issue though, it will look better with Invalid character error

@ctkochan22
Copy link
Author

Yeah that is a good catch @eVoloshchak . I'd say its a rare case in general. If someone putting anything resembling tags where a routing number is supposed to be, they should be notified that that act is not allowed.

The "Please enter valid Routing Number" to me, is a "friendly" message for "friendly" users

@ctkochan22
Copy link
Author

Copy updated. Ready for review

tgolen
tgolen previously requested changes Feb 24, 2023
const validationErrors = this.props.validate(values);

// Validate the input for html tags. It should superseed any other error
_.every(values, (inputValue, inputID) => {
if (!inputValue || inputValue.search(/<(.|\n)*?>/g) === -1) {
Copy link
Contributor

Choose a reason for hiding this comment

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

The CONST.js file has VALIDATE_CODE_REGEX_STRING. Could you please move this regex to the same place and define it there?

return;
}

validationErrors[inputID] = this.props.translate('common.error.inputHasHtml');
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's rename this to common.error.invalidCharacter so that it matches the text

@ctkochan22
Copy link
Author

Updated

@eVoloshchak
Copy link
Contributor

It seems like it's validating only the first input, on Legal Name page tags aren't allowed only for the first name
image

@tgolen tgolen dismissed their stale review March 9, 2023 14:28

Because I'm the author now

@tgolen
Copy link
Contributor

tgolen commented Mar 9, 2023

@eVoloshchak Looks like this just needs an approved review from you now. Are you able?

eVoloshchak
eVoloshchak previously approved these changes Mar 9, 2023
@tgolen
Copy link
Contributor

tgolen commented Mar 9, 2023

Thanks! @marcaaron Could you add a review, please?

src/CONST.js Outdated Show resolved Hide resolved
src/components/Form.js Outdated Show resolved Hide resolved
src/components/Form.js Outdated Show resolved Hide resolved
Co-authored-by: Marc Glasser <marc.aaron.glasser@gmail.com>
@tgolen
Copy link
Contributor

tgolen commented Mar 10, 2023

Updated

@tgolen tgolen requested a review from marcaaron March 10, 2023 14:39
src/components/Form.js Outdated Show resolved Hide resolved
@tgolen tgolen requested a review from marcaaron March 10, 2023 18:56
marcaaron
marcaaron previously approved these changes Mar 10, 2023
// Validate the input for html tags. It should supercede any other error
_.each(values, (inputValue, inputID) => {
// Return early if there is no value OR the value is not a string OR there are no HTML characters
if (!inputValue || !_.isString(inputValue) || inputValue.search(CONST.VALIDATE_FOR_HTML_TAG_REGEX) === -1)
Copy link
Contributor

Choose a reason for hiding this comment

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

missing the opening curly brace

Copy link
Contributor

Choose a reason for hiding this comment

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

Akward :blush

@tgolen
Copy link
Contributor

tgolen commented Mar 10, 2023

Retested to be sure my curly braces are working

image

@tgolen tgolen merged commit 8998ee7 into main Mar 10, 2023
@tgolen tgolen deleted the ckt_form_htmlValidation branch March 10, 2023 20:32
@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/tgolen in version: 1.2.83-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/tgolen in version: 1.2.83-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 1.2.83-3 🚀

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