feat(validators): host, ipv4 and domain name validators (#1212)

* feat(validators): host, ipv4 and domain name validators

Changes share modal email validation to use new email validator.
@hapi/address is used by @hapi/Joi JSON schema validator

BREAKING CHANGE: Adds peer dependency of @hapi/address used for email and domain validation

* fix: added uncommon tlds for email checking

* fix: adding some bad tlds

Author: priyajeet

package.json

@@ -148,6 +148,7 @@
         "@commitlint/cli": "^7.2.1",
         "@commitlint/config-conventional": "^7.1.2",
         "@commitlint/travis-cli": "^7.2.1",
+        "@hapi/address": "^2.0.0",
         "autoprefixer": "^9.4.8",
         "axios": "^0.18.0",
         "babel-core": "^7.0.0-bridge.0",
@@ -260,6 +261,7 @@
         "worker-farm": "^1.6.0"
     },
     "peerDependencies": {
+        "@hapi/address": "^2.0.0",
         "axios": "^0.18.0",
         "classnames": "^2.2.5",
         "draft-js": "^0.10.1",

src/features/unified-share-modal/EmailForm.js

@@ -16,6 +16,7 @@ import Tooltip from '../../components/tooltip';
 import InlineNotice from '../../components/inline-notice';
 import PillSelectorDropdown from '../../components/pill-selector-dropdown';
 import commonMessages from '../../common/messages';
+import { emailValidator } from '../../utils/validators';
 import type { inlineNoticeType } from '../../common/box-types';
 
 import ContactsField from './ContactsField';
@@ -195,9 +196,7 @@ class EmailForm extends React.Component<Props, State> {
     };
 
     isValidEmail = (text: string): boolean => {
-        // TODO-AH: make this a constant somewhere
-        const emailValidation = /^[^\s<>@,]+@[^\s<>@,/\\]+\.[^\s<>@,]+$/i;
-        return emailValidation.test(text);
+        return emailValidator(text);
     };
 
     render() {

src/features/unified-share-modal/__tests__/EmailForm-test.js

@@ -283,6 +283,18 @@ describe('features/unified-share-modal/EmailForm', () => {
                 email: 'test.box.com',
                 expectedValue: false,
             },
+            {
+                email: 'foo@bar.dog',
+                expectedValue: true,
+            },
+            {
+                email: 'foo@bar.design',
+                expectedValue: true,
+            },
+            {
+                email: 'foo@bar.dev',
+                expectedValue: true,
+            },
             {
                 email: 'test@@example.com',
                 expectedValue: false,

src/utils/__tests__/validators-test.js

@@ -0,0 +1,107 @@
+// @flow
+
+import { domainNameValidator, emailValidator, hostnameValidator, ipv4AddressValidator } from '../validators';
+
+describe('util/validators', () => {
+    describe('domainNameValidator()', () => {
+        test.each([
+            ['a.com', true],
+            ['www.a.com', true],
+            ['a-1.com', true],
+            ['www.a-1.com', true],
+            ['-a.com', false],
+            ['www.a.com-', false],
+            ['a@b.com', false],
+            ['a.', false],
+            ['1.1.1.1', false],
+            ['1.1.1', false],
+            ['1.1', false],
+            ['a', false],
+        ])('domainNameValidator(%s) should return %s', (domain, expected) => {
+            expect(domainNameValidator(domain)).toBe(expected);
+        });
+    });
+
+    describe('hostnameValidator()', () => {
+        test.each([
+            ['a.com', true],
+            ['www.a.com', true],
+            ['a-1.com', true],
+            ['www.a-1.com', true],
+            ['-a.com', false],
+            ['www.a.com-', false],
+            ['a@b.com', false],
+            ['a.', false],
+            ['1.1.1.1', true],
+            ['1.1.1', true],
+            ['1.1', true],
+            ['a', true],
+        ])('hostnameValidator(%s) should return %s', (hostname, expected) => {
+            expect(hostnameValidator(hostname)).toBe(expected);
+        });
+    });
+
+    describe('ipv4AddressValidator()', () => {
+        test.each([
+            ['a.com', false],
+            ['www.a.com', false],
+            ['a-1.com', false],
+            ['www.a-1.com', false],
+            ['-a.com', false],
+            ['www.a.com-', false],
+            ['a@b.com', false],
+            ['a.', false],
+            ['1.1.1.1', true],
+            ['256.1.1.1', false],
+            ['1.256.1.1', false],
+            ['1.1.256.1', false],
+            ['1.1.1.256', false],
+            ['1.1.1', false],
+            ['1.1', false],
+            ['1.1.', false],
+            ['1.', false],
+            ['a', false],
+        ])('ipv4AddressValidator(%s) should return %s', (address, expected) => {
+            expect(ipv4AddressValidator(address)).toBe(expected);
+        });
+    });
+
+    describe('emailValidator()', () => {
+        test.each([
+            ['a.com', false],
+            ['www.a.com', false],
+            ['a-1.com', false],
+            ['www.a-1.com', false],
+            ['-a.com', false],
+            ['www.a.com-', false],
+            ['a@b.com', true],
+            ['a@b.dfdsfsdffs', false],
+            ['a@b.whatever', false],
+            ['a@b.junk', false],
+            ['a@b.design', true],
+            ['a@b.dog', true],
+            ['a@b.business', true],
+            ['a@b.club', true],
+            ['a@b.life', true],
+            ['a@b.co.com', true],
+            ['a@.com', false],
+            ['a.x@b.com', true],
+            ['a:x@b.com', false],
+            ['a..x@b.com', false],
+            ['@b.com', false],
+            ['a.', false],
+            ['1.1.1.1', false],
+            ['256.1.1.1', false],
+            ['1.256.1.1', false],
+            ['1.1.256.1', false],
+            ['1.1.1.256', false],
+            ['1.1.1', false],
+            ['1.1', false],
+            ['1.1.', false],
+            ['1.', false],
+            ['a', false],
+        ])('emailValidator(%s) should return %s', (email, expected) => {
+            expect(emailValidator(email)).toBe(expected);
+        });
+    });
+});

src/utils/validators.js

@@ -0,0 +1,24 @@
+// @flow
+import Address from '@hapi/address';
+
+function hostnameValidator(value: string): boolean {
+    // @see https://github.com/hapijs/joi/blame/3516cf0b995c9fe415634c4612c0ac2f8792f0b4/lib/types/string/index.js#L530
+    const regex = /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$/;
+    return regex.test(value);
+}
+
+function ipv4AddressValidator(value: string): boolean {
+    // @see https://www.oreilly.com/library/view/regular-expressions-cookbook/9780596802837/ch07s16.html
+    const regex = /^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/;
+    return regex.test(value);
+}
+
+function domainNameValidator(value: string): boolean {
+    return Address.domain.isValid(value);
+}
+
+function emailValidator(value: string): boolean {
+    return Address.email.isValid(value);
+}
+
+export { domainNameValidator, emailValidator, hostnameValidator, ipv4AddressValidator };

yarn.lock

@@ -1277,6 +1277,11 @@
     debug "^3.1.0"
     lodash.once "^4.1.1"
 
+"@hapi/address@^2.0.0":
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/@hapi/address/-/address-2.0.0.tgz#9f05469c88cb2fd3dcd624776b54ee95c312126a"
+  integrity sha512-mV6T0IYqb0xL1UALPFplXYQmR0twnXG0M6jUswpquqT2sD12BOiCiLy3EvMp/Fy7s3DZElC4/aPjEjo2jeZpvw==
+
 "@jest/console@^24.3.0":
   version "24.3.0"
   resolved "https://registry.yarnpkg.com/@jest/console/-/console-24.3.0.tgz#7bd920d250988ba0bf1352c4493a48e1cb97671e"