Add proxy-bypass option to prevent using proxy depending on rule (#2187)

AlexKamaev · AndreyBelym · commit ff555e31f174 · 2018-03-06T16:46:18.000+03:00
diff --git a/src/cli/argument-parser.js b/src/cli/argument-parser.js
@@ -107,6 +107,7 @@ export default class CLIArgumentParser {
             .option('--ports <port1,port2>', 'specify custom port numbers')
             .option('--hostname <name>', 'specify the hostname')
             .option('--proxy <host>', 'specify the host of the proxy server')
+            .option('--proxy-bypass <rules>', 'specify a comma-separated list of rules that define URLs accessed bypassing the proxy server')
             .option('--qr-code', 'outputs QR-code that repeats URLs used to connect the remote browsers')
 
             // NOTE: these options will be handled by chalk internally
diff --git a/src/cli/cli.js b/src/cli/cli.js
@@ -68,6 +68,7 @@ async function runTests (argParser) {
     var port1             = opts.ports && opts.ports[0];
     var port2             = opts.ports && opts.ports[1];
     var externalProxyHost = opts.proxy;
+    var proxyBypass       = opts.proxyBypass;
 
     log.showSpinner();
 
@@ -87,7 +88,7 @@ async function runTests (argParser) {
     reporters.forEach(r => runner.reporter(r.name, r.outStream));
 
     runner
-        .useProxy(externalProxyHost)
+        .useProxy(externalProxyHost, proxyBypass)
         .src(argParser.src)
         .browsers(browsers)
         .concurrency(concurrency)
diff --git a/src/runner/index.js b/src/runner/index.js
@@ -9,6 +9,7 @@ import Reporter from '../reporter';
 import Task from './task';
 import { GeneralError } from '../errors/runtime';
 import MESSAGE from '../errors/runtime/message';
+import { assertType, is } from '../errors/runtime/type-assertions';
 
 
 const DEFAULT_SELECTOR_TIMEOUT  = 10000;
@@ -26,6 +27,7 @@ export default class Runner extends EventEmitter {
 
         this.opts = {
             externalProxyHost:      null,
+            proxyBypass:            null,
             screenshotPath:         null,
             takeScreenshotsOnFails: false,
             skipJsErrors:           false,
@@ -118,6 +120,21 @@ export default class Runner extends EventEmitter {
         assets.forEach(asset => this.proxy.GET(asset.path, asset.info));
     }
 
+    _validateRunOptions () {
+        const concurrency = this.bootstrapper.concurrency;
+        const speed       = this.opts.speed;
+        const proxyBypass = this.opts.proxyBypass;
+
+        if (typeof speed !== 'number' || isNaN(speed) || speed < 0.01 || speed > 1)
+            throw new GeneralError(MESSAGE.invalidSpeedValue);
+
+        if (typeof concurrency !== 'number' || isNaN(concurrency) || concurrency < 1)
+            throw new GeneralError(MESSAGE.invalidConcurrencyFactor);
+
+        if (proxyBypass)
+            assertType(is.string, null, '"proxyBypass" argument', proxyBypass);
+    }
+
 
     // API
     embeddingOptions (opts) {
@@ -142,9 +159,6 @@ export default class Runner extends EventEmitter {
     }
 
     concurrency (concurrency) {
-        if (typeof concurrency !== 'number' || isNaN(concurrency) || concurrency < 1)
-            throw new GeneralError(MESSAGE.invalidConcurrencyFactor);
-
         this.bootstrapper.concurrency = concurrency;
 
         return this;
@@ -165,8 +179,9 @@ export default class Runner extends EventEmitter {
         return this;
     }
 
-    useProxy (externalProxyHost) {
+    useProxy (externalProxyHost, proxyBypass) {
         this.opts.externalProxyHost = externalProxyHost;
+        this.opts.proxyBypass       = proxyBypass;
 
         return this;
     }
@@ -194,12 +209,13 @@ export default class Runner extends EventEmitter {
         this.opts.assertionTimeout = assertionTimeout === void 0 ? DEFAULT_ASSERTION_TIMEOUT : assertionTimeout;
         this.opts.pageLoadTimeout  = pageLoadTimeout === void 0 ? DEFAULT_PAGE_LOAD_TIMEOUT : pageLoadTimeout;
 
-        if (typeof speed !== 'number' || isNaN(speed) || speed < 0.01 || speed > 1)
-            throw new GeneralError(MESSAGE.invalidSpeedValue);
-
         this.opts.speed = speed;
 
-        var runTaskPromise = this.bootstrapper.createRunnableConfiguration()
+        var runTaskPromise = Promise.resolve()
+            .then(() => {
+                this._validateRunOptions();
+                return this.bootstrapper.createRunnableConfiguration();
+            })
             .then(({ reporterPlugins, browserSet, tests, testedApp }) => {
                 this.emit('done-bootstrapping');
 
diff --git a/src/runner/test-run-controller.js b/src/runner/test-run-controller.js
@@ -1,5 +1,6 @@
 import EventEmitter from 'events';
 import { TestRun as LegacyTestRun } from 'testcafe-legacy-api';
+import checkUrl from '../utils/check-url';
 import TestRun from '../test-run';
 
 
@@ -126,6 +127,10 @@ export default class TestRunController extends EventEmitter {
 
         testRun.start();
 
-        return this.proxy.openSession(testRun.test.pageUrl, testRun, this.opts.externalProxyHost);
+        const pageUrl           = testRun.test.pageUrl;
+        const needBypassHost    = this.opts.proxyBypass && checkUrl(pageUrl, this.opts.proxyBypass.split(','));
+        const externalProxyHost = needBypassHost ? null : this.opts.externalProxyHost;
+
+        return this.proxy.openSession(pageUrl, testRun, externalProxyHost);
     }
 }
diff --git a/src/utils/check-url.js b/src/utils/check-url.js
@@ -0,0 +1,68 @@
+import { escapeRegExp as escapeRe } from 'lodash';
+
+const startsWithWildcardRegExp = /^\*\./;
+const endsWithWildcardRegExp   = /\.\*$/;
+const trailingSlashesRegExp    = /\/.*$/;
+const portRegExp               = /:(\d+)$/;
+const protocolRegExp           = /^(\w+):\/\//;
+const wildcardRegExp           = /\\\.\\\*/g;
+
+function parseUrl (url) {
+    if (!url || typeof url !== 'string')
+        return null;
+
+    let protocol = url.match(protocolRegExp);
+
+    protocol = protocol ? protocol[1] : null;
+    url      = url.replace(protocolRegExp, '');
+    url      = url.replace(trailingSlashesRegExp, '');
+
+    let port = url.match(portRegExp);
+
+    port = port ? parseInt(port[1], 10) : null;
+    url  = url.replace(portRegExp, '');
+
+    return { protocol, url, port };
+}
+
+function prepareRule (url) {
+    const rule = parseUrl(url);
+
+    if (rule) {
+        rule.url = rule.url.replace(startsWithWildcardRegExp, '.');
+        rule.url = rule.url.replace(endsWithWildcardRegExp, '.');
+    }
+
+    return rule;
+}
+
+function urlMatchRule (sourceUrl, rule) {
+    if (!sourceUrl || !rule)
+        return false;
+
+    const matchByProtocols         = !rule.protocol || !sourceUrl.protocol || rule.protocol === sourceUrl.protocol;
+    const matchByPorts             = !rule.port || sourceUrl.port === rule.port;
+    const domainRequiredBeforeRule = rule.url.startsWith('.');
+    const domainRequiredAfterRule  = rule.url.endsWith('.');
+
+    let regExStr = '^';
+
+    if (domainRequiredBeforeRule)
+        regExStr += '.+';
+
+    regExStr += escapeRe(rule.url).replace(wildcardRegExp, '\\..*');
+
+    if (domainRequiredAfterRule)
+        regExStr += '.+';
+
+    regExStr += '$';
+
+    return new RegExp(regExStr).test(sourceUrl.url) && matchByProtocols && matchByPorts;
+}
+
+export default function (url, rules) {
+    if (!Array.isArray(rules))
+        rules = [rules];
+
+    return rules.some(rule => urlMatchRule(parseUrl(url), prepareRule(rule)));
+}
diff --git a/test/functional/fixtures/proxy/test.js b/test/functional/fixtures/proxy/test.js
@@ -2,6 +2,7 @@ var os = require('os');
 
 const TRUSTED_PROXY_URL     = os.hostname() + ':3004';
 const TRANSPARENT_PROXY_URL = os.hostname() + ':3005';
+const ERROR_PROXY_URL       = 'ERROR';
 
 describe('Using external proxy server', function () {
     it('Should open page via proxy server', function () {
@@ -12,3 +13,14 @@ describe('Using external proxy server', function () {
         return runTests('testcafe-fixtures/restricted-page.test.js', null, { useProxy: TRUSTED_PROXY_URL });
     });
 });
+
+describe('Using proxy-bypass', function () {
+    it('Should bypass using proxy by one rule', function () {
+        return runTests('testcafe-fixtures/index.test.js', null, { useProxy: ERROR_PROXY_URL, proxyBypass: 'localhost:3000' });
+    });
+
+    it('Should bypass using proxy by set of rules', function () {
+        return runTests('testcafe-fixtures/index.test.js', null, { useProxy: ERROR_PROXY_URL, proxyBypass: 'dummy,localhost:3000' });
+    });
+});
+
diff --git a/test/functional/setup.js b/test/functional/setup.js
@@ -165,6 +165,7 @@ before(function () {
                 var appCommand         = opts && opts.appCommand;
                 var appInitDelay       = opts && opts.appInitDelay;
                 var externalProxyHost  = opts && opts.useProxy;
+                var proxyBypass        = opts && opts.proxyBypass;
                 var customReporters    = opts && opts.reporters;
 
                 var actualBrowsers = browsersInfo.filter(function (browserInfo) {
@@ -208,7 +209,7 @@ before(function () {
                 }
 
                 return runner
-                    .useProxy(externalProxyHost)
+                    .useProxy(externalProxyHost, proxyBypass)
                     .browsers(connections)
                     .filter(function (test) {
                         return testName ? test === testName : true;
diff --git a/test/server/cli-argument-parser-test.js b/test/server/cli-argument-parser-test.js
@@ -333,7 +333,7 @@ describe('CLI argument parser', function () {
     });
 
     it('Should parse command line arguments', function () {
-        return parse('-r list -S -q -e --hostname myhost --proxy localhost:1234 --qr-code --app run-app --speed 0.5 --debug-on-fail ie test/server/data/file-list/file-1.js')
+        return parse('-r list -S -q -e --hostname myhost --proxy localhost:1234 --proxy-bypass localhost:5678 --qr-code --app run-app --speed 0.5 --debug-on-fail ie test/server/data/file-list/file-1.js')
             .then(function (parser) {
                 expect(parser.browsers).eql(['ie']);
                 expect(parser.src).eql([path.resolve(process.cwd(), 'test/server/data/file-list/file-1.js')]);
@@ -347,6 +347,7 @@ describe('CLI argument parser', function () {
                 expect(parser.opts.speed).eql(0.5);
                 expect(parser.opts.qrCode).to.be.ok;
                 expect(parser.opts.proxy).to.be.ok;
+                expect(parser.opts.proxyBypass).to.be.ok;
                 expect(parser.opts.debugOnFail).to.be.ok;
             });
     });
@@ -377,6 +378,7 @@ describe('CLI argument parser', function () {
             { long: '--ports' },
             { long: '--hostname' },
             { long: '--proxy' },
+            { long: '--proxy-bypass' },
             { long: '--qr-code' },
             { long: '--color' },
             { long: '--no-color' }
diff --git a/test/server/match-url-test.js b/test/server/match-url-test.js
diff --git a/test/server/runner-test.js b/test/server/runner-test.js

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`import EventEmitter from 'events';`
`2`	`2`	`import { TestRun as LegacyTestRun } from 'testcafe-legacy-api';`
	`3`	`+import checkUrl from '../utils/check-url';`
`3`	`4`	`import TestRun from '../test-run';`
`4`	`5`
`5`	`6`
`@@ -126,6 +127,10 @@ export default class TestRunController extends EventEmitter {`
`126`	`127`
`127`	`128`	`testRun.start();`
`128`	`129`
`129`		`- return this.proxy.openSession(testRun.test.pageUrl, testRun, this.opts.externalProxyHost);`
	`130`	`+ const pageUrl = testRun.test.pageUrl;`
	`131`	`+ const needBypassHost = this.opts.proxyBypass && checkUrl(pageUrl, this.opts.proxyBypass.split(','));`
	`132`	`+ const externalProxyHost = needBypassHost ? null : this.opts.externalProxyHost;`
	`133`	`+`
	`134`	`+ return this.proxy.openSession(pageUrl, testRun, externalProxyHost);`
`130`	`135`	`}`
`131`	`136`	`}`