Disable page caching (close #3780) (#4013)

* initial * fix linting * small refactoring * fix lint * fix review issues * add lost option name * try to fix tests
DevExpress · Aug 16, 2019 · 62bf5a2 · 62bf5a2
1 parent 0e2f80f
commit 62bf5a2
Show file tree

Hide file tree

Showing 20 changed files with 163 additions and 39 deletions.
diff --git a/package.json b/package.json
@@ -114,7 +114,7 @@
     "source-map-support": "^0.5.5",
     "strip-bom": "^2.0.0",
     "testcafe-browser-tools": "1.6.8",
-    "testcafe-hammerhead": "14.7.4",
+    "testcafe-hammerhead": "14.8.0",
     "testcafe-legacy-api": "3.1.11",
     "testcafe-reporter-json": "^2.1.0",
     "testcafe-reporter-list": "^2.1.0",

diff --git a/src/api/structure/test-file.js b/src/api/structure/test-file.js
@@ -15,6 +15,9 @@ export default class TestFile {
 
             if (test.disablePageReloads === void 0)
                 test.disablePageReloads = test.fixture.disablePageReloads;
+
+            if (!test.disablePageCaching)
+                test.disablePageCaching = test.fixture.disablePageCaching;
         });
 
         return this.collectedTests;

diff --git a/src/api/structure/testing-unit.js b/src/api/structure/testing-unit.js
@@ -20,6 +20,7 @@ export default class TestingUnit {
         this.clientScripts   = [];
 
         this.disablePageReloads = void 0;
+        this.disablePageCaching = false;
 
         this.apiMethodWasCalled = new FlagList([OPTION_NAMES.clientScripts, OPTION_NAMES.requestHooks]);
 
@@ -99,6 +100,12 @@ export default class TestingUnit {
         return this.apiOrigin;
     }
 
+    _disablePageCaching$getter () {
+        this.disablePageCaching = true;
+
+        return this.apiOrigin;
+    }
+
     static _makeAPIListForChildClass (ChildClass) {
         ChildClass.API_LIST = TestingUnit.API_LIST.concat(getDelegatedAPIList(ChildClass.prototype));
     }

diff --git a/src/cli/argument-parser.js b/src/cli/argument-parser.js
@@ -98,6 +98,7 @@ export default class CLIArgumentParser {
             .option('--sf, --stop-on-first-fail', 'stop an entire test run if any test fails')
             .option('--ts-config-path <path>', 'use a custom TypeScript configuration file and specify its location')
             .option('--cs, --client-scripts <paths>', 'inject scripts into tested pages', this._parseList, [])
+            .option('--disable-page-caching', 'disable page caching during test execution')
 
             // NOTE: these options will be handled by chalk internally
             .option('--color', 'force colors in command line')

diff --git a/src/configuration/option-names.js b/src/configuration/option-names.js
@@ -33,5 +33,7 @@ export default {
     retryTestPages:         'retryTestPages',
     hostname:               'hostname',
     port1:                  'port1',
-    port2:                  'port2'
+    port2:                  'port2',
+    developmentMode:        'developmentMode',
+    disablePageCaching:     'disablePageCaching'
 };
diff --git a/src/configuration/testcafe-configuration.js b/src/configuration/testcafe-configuration.js
@@ -27,7 +27,10 @@ const OPTION_FLAG_NAMES = [
     OPTION_NAMES.debugOnFail,
     OPTION_NAMES.skipUncaughtErrors,
     OPTION_NAMES.stopOnFirstFail,
-    OPTION_NAMES.takeScreenshotsOnFails
+    OPTION_NAMES.takeScreenshotsOnFails,
+    OPTION_NAMES.disablePageCaching,
+    OPTION_NAMES.developmentMode,
+    OPTION_NAMES.retryTestPages,
 ];
 
 export default class TestCafeConfiguration extends Configuration {

diff --git a/src/runner/index.js b/src/runner/index.js
@@ -431,35 +431,7 @@ export default class Runner extends EventEmitter {
 
     run (options = {}) {
         this.apiMethodWasCalled.reset();
-
-        const {
-            skipJsErrors,
-            disablePageReloads,
-            quarantineMode,
-            debugMode,
-            selectorTimeout,
-            assertionTimeout,
-            pageLoadTimeout,
-            speed,
-            debugOnFail,
-            skipUncaughtErrors,
-            stopOnFirstFail
-        } = options;
-
-        this.configuration.mergeOptions({
-            skipJsErrors:       skipJsErrors,
-            disablePageReloads: disablePageReloads,
-            quarantineMode:     quarantineMode,
-            debugMode:          debugMode,
-            debugOnFail:        debugOnFail,
-            selectorTimeout:    selectorTimeout,
-            assertionTimeout:   assertionTimeout,
-            pageLoadTimeout:    pageLoadTimeout,
-            speed:              speed,
-            skipUncaughtErrors: skipUncaughtErrors,
-            stopOnFirstFail:    stopOnFirstFail
-        });
-
+        this.configuration.mergeOptions(options);
         this._setBootstrapperOptions();
 
         const runTaskPromise = Promise.resolve()

diff --git a/src/test-run/index.js b/src/test-run/index.js
@@ -87,6 +87,7 @@ export default class TestRun extends AsyncEventEmitter {
         this.pageLoadTimeout      = this.opts.pageLoadTimeout;
 
         this.disablePageReloads = test.disablePageReloads || opts.disablePageReloads && test.disablePageReloads !== false;
+        this.disablePageCaching = test.disablePageCaching || opts.disablePageCaching;
 
         this.session = SessionController.getSession(this);
 

diff --git a/src/test-run/session-controller.js b/src/test-run/session-controller.js
@@ -68,6 +68,8 @@ export default class SessionController extends Session {
                 session.currentTestRun = testRun;
             }
 
+            session.disablePageCaching = testRun.disablePageCaching;
+
             sessionInfo = {
                 session: session,
                 proxy:   null,

diff --git a/test/functional/fixtures/run-options/disable-page-caching/common/index.js b/test/functional/fixtures/run-options/disable-page-caching/common/index.js
@@ -0,0 +1,23 @@
+import { ClientFunction, Role, Selector, t } from 'testcafe';
+
+const getPageLocation = ClientFunction(() => window.location.toString());
+
+const url = 'http://localhost:3000/fixtures/run-options/disable-page-caching/pages/index.html';
+
+const expectedRoleLastPageLocation = 'http://localhost:3000/fixtures/run-options/disable-page-caching/pages/third.html';
+
+const role = Role(url, async () => {
+    await t
+        .click(Selector('#first'))
+        .click(Selector('#second'))
+        .click(Selector('#third'));
+
+    role.lastPageLocation = await getPageLocation();
+});
+
+export {
+    role,
+    url,
+    expectedRoleLastPageLocation
+};
+
diff --git a/test/functional/fixtures/run-options/disable-page-caching/pages/index.html b/test/functional/fixtures/run-options/disable-page-caching/pages/index.html
@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+</head>
+<body>
+    <button id="first">1. Set value in local storage</button>
+    <button id="second">2. Open link in a new window.</button>
+    <script>
+        var firstBtn  = document.getElementById("first");
+        var secondBtn = document.getElementById("second");
+
+        firstBtn.addEventListener('click', function () {
+            window.localStorage.setItem(
+                'testItem',
+                JSON.stringify({ link: './third.html' })
+            );
+        });
+
+        secondBtn.addEventListener('click', function () {
+            window.open('./second.html', '_blank');
+        });
+    </script>
+</body>
+</html>
diff --git a/test/functional/fixtures/run-options/disable-page-caching/pages/second.html b/test/functional/fixtures/run-options/disable-page-caching/pages/second.html
@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+</head>
+<body>
+    <a id="third">3. Link to the third page</a>
+    <script>
+        var data = JSON.parse(localStorage.getItem('testItem'));
+        var link = document.getElementById('third');
+
+        if (data)
+            link.href = data.link;
+    </script>
+</body>
+</html>
diff --git a/test/functional/fixtures/run-options/disable-page-caching/pages/third.html b/test/functional/fixtures/run-options/disable-page-caching/pages/third.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+</head>
+<body>
+    <h1>Third page</h1>
+</body>
+</html>
diff --git a/test/functional/fixtures/run-options/disable-page-caching/test.js b/test/functional/fixtures/run-options/disable-page-caching/test.js
@@ -0,0 +1,13 @@
+describe('Disable page caching', () => {
+    it('Test run', () => {
+        return runTests('testcafe-fixtures/test-run.js', null, { disablePageCaching: true });
+    });
+
+    it('Fixture', () => {
+        return runTests('testcafe-fixtures/fixture.js');
+    });
+
+    it('Single test', () => {
+        return runTests('testcafe-fixtures/single-test.js');
+    });
+});
diff --git a/test/functional/fixtures/run-options/disable-page-caching/testcafe-fixtures/fixture.js b/test/functional/fixtures/run-options/disable-page-caching/testcafe-fixtures/fixture.js
@@ -0,0 +1,12 @@
+import { role, url, expectedRoleLastPageLocation } from '../common/index';
+
+fixture
+    .disablePageCaching `Fixture`
+    .page(url)
+    .beforeEach( async t => {
+        await t.useRole(role);
+    });
+
+test('test', async t => {
+    await t.expect(role.lastPageLocation).eql(expectedRoleLastPageLocation);
+});
diff --git a/test/functional/fixtures/run-options/disable-page-caching/testcafe-fixtures/single-test.js b/test/functional/fixtures/run-options/disable-page-caching/testcafe-fixtures/single-test.js
@@ -0,0 +1,14 @@
+import { role, url, expectedRoleLastPageLocation } from '../common/index';
+
+fixture `Fixture`;
+
+test
+    .disablePageCaching
+    .page(url)
+    .before(async t => {
+        await t.useRole(role);
+    })
+    ('test', async t => {
+        await t.expect(role.lastPageLocation).eql(expectedRoleLastPageLocation);
+    });
+
diff --git a/test/functional/fixtures/run-options/disable-page-caching/testcafe-fixtures/test-run.js b/test/functional/fixtures/run-options/disable-page-caching/testcafe-fixtures/test-run.js
@@ -0,0 +1,11 @@
+import { role, url, expectedRoleLastPageLocation } from '../common/index';
+
+fixture `Fixture`
+    .page(url)
+    .beforeEach( async t => {
+        await t.useRole(role);
+    });
+
+test('test', async t => {
+    await t.expect(role.lastPageLocation).eql(expectedRoleLastPageLocation);
+});
diff --git a/test/functional/setup.js b/test/functional/setup.js
@@ -202,7 +202,8 @@ before(function () {
                     useProxy: proxy,
                     only: onlyOption,
                     skip: skipOption,
-                    stopOnFirstFail
+                    stopOnFirstFail,
+                    disablePageCaching
                 } = opts;
 
                 const actualBrowsers = browsersInfo.filter(browserInfo => {
@@ -259,7 +260,8 @@ before(function () {
                         pageLoadTimeout,
                         speed,
                         stopOnFirstFail,
-                        skipUncaughtErrors
+                        skipUncaughtErrors,
+                        disablePageCaching
                     })
                     .then(failedCount => {
                         if (customReporters)

diff --git a/test/functional/site/server.js b/test/functional/site/server.js
@@ -28,6 +28,9 @@ const NON_CACHEABLE_PAGES = [
 
 const UPLOAD_SUCCESS_PAGE_TEMPLATE = readSync('./views/upload-success.html.mustache');
 
+const shouldCachePage = function (reqUrl) {
+    return NON_CACHEABLE_PAGES.every(pagePrefix => !reqUrl.startsWith(pagePrefix));
+};
 
 const Server = module.exports = function (port, basePath) {
     const server = this;
@@ -73,7 +76,7 @@ Server.prototype._setupRoutes = function () {
             .then(function (content) {
                 res.setHeader('content-type', CONTENT_TYPES[path.extname(resourcePath)]);
 
-                if (NON_CACHEABLE_PAGES.every(pagePrefix => !reqPath.startsWith(pagePrefix)))
+                if (shouldCachePage(reqPath))
                     res.setHeader('cache-control', 'max-age=3600');
 
                 setTimeout(function () {

diff --git a/test/server/cli-argument-parser-test.js b/test/server/cli-argument-parser-test.js
@@ -1,8 +1,8 @@
-const expect            = require('chai').expect;
+const { expect }        = require('chai');
 const path              = require('path');
 const fs                = require('fs');
 const tmp               = require('tmp');
-const find              = require('lodash').find;
+const { find }          = require('lodash');
 const CliArgumentParser = require('../../lib/cli/argument-parser');
 const nanoid            = require('nanoid');
 
@@ -519,7 +519,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 --proxy-bypass localhost:5678 --qr-code --app run-app --speed 0.5 --debug-on-fail --disable-page-reloads --dev --sf 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 --disable-page-reloads --dev --sf --disable-page-caching ie test/server/data/file-list/file-1.js')
             .then(parser => {
                 expect(parser.browsers).eql(['ie']);
                 expect(parser.src).eql(['test/server/data/file-list/file-1.js']);
@@ -538,6 +538,7 @@ describe('CLI argument parser', function () {
                 expect(parser.opts.proxyBypass).to.be.ok;
                 expect(parser.opts.debugOnFail).to.be.ok;
                 expect(parser.opts.stopOnFirstFail).to.be.ok;
+                expect(parser.opts.disablePageCaching).to.be.ok;
             });
     });
 
@@ -584,7 +585,8 @@ describe('CLI argument parser', function () {
             { long: '--video-options' },
             { long: '--video-encoding-options' },
             { long: '--ts-config-path' },
-            { long: '--client-scripts', short: '--cs' }
+            { long: '--client-scripts', short: '--cs' },
+            { long: '--disable-page-caching' }
         ];
 
         const parser  = new CliArgumentParser('');