Added a clear message about failed CORS validation requests (close #2482

) (#2613) * add clear message about failed CORS validation requests (close #2482) * tmp * formatting * rename * add condition * fix lint
DevExpress · Jul 11, 2018 · 3cd7b7d · 3cd7b7d
1 parent 4b5547a
commit 3cd7b7d
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -106,7 +106,7 @@
     "source-map-support": "^0.5.5",
     "strip-bom": "^2.0.0",
     "testcafe-browser-tools": "1.6.4",
-    "testcafe-hammerhead": "14.2.0",
+    "testcafe-hammerhead": "14.2.1",
     "testcafe-legacy-api": "3.1.7",
     "testcafe-reporter-json": "^2.1.0",
     "testcafe-reporter-list": "^2.1.0",

diff --git a/src/api/request-hooks/hook.js b/src/api/request-hooks/hook.js
@@ -6,6 +6,8 @@ export default class RequestHook {
         this.requestFilterRules              = this._prepareRequestFilterRules(requestFilterRules);
         this._instantiatedRequestFilterRules = [];
         this.responseEventConfigureOpts      = responseEventConfigureOpts;
+
+        this.warningLog = null;
     }
 
     _prepareRequestFilterRules (rules) {

diff --git a/src/api/request-hooks/request-mock.js b/src/api/request-hooks/request-mock.js
@@ -1,7 +1,8 @@
 import RequestHook from './hook';
-import { ResponseMock, RequestFilterRule } from 'testcafe-hammerhead';
+import { ResponseMock, RequestFilterRule, SAME_ORIGIN_CHECK_FAILED_STATUS_CODE } from 'testcafe-hammerhead';
 import { APIError } from '../../errors/runtime';
 import MESSAGE from '../../errors/runtime/message';
+import WARNING_MESSAGE from '../../notifications/warning-message';
 
 class RequestMock extends RequestHook {
     constructor () {
@@ -17,7 +18,10 @@ class RequestMock extends RequestHook {
         event.setMock(mock);
     }
 
-    onResponse () {}
+    onResponse (event) {
+        if (event.statusCode === SAME_ORIGIN_CHECK_FAILED_STATUS_CODE)
+            this.warningLog.addWarning(WARNING_MESSAGE.requestMockCORSValidationFailed, RequestMock.name, event._requestFilterRule);
+    }
 
     // API
     onRequestTo (requestFilterRuleInit) {

diff --git a/src/notifications/warning-message.js b/src/notifications/warning-message.js
diff --git a/src/test-run/index.js b/src/test-run/index.js
@@ -110,6 +110,8 @@ export default class TestRun extends EventEmitter {
 
         this.quarantine = null;
 
+        this.warningLog = warningLog;
+
         this.injectable.scripts.push('/testcafe-core.js');
         this.injectable.scripts.push('/testcafe-ui.js');
         this.injectable.scripts.push('/testcafe-automation.js');
@@ -150,6 +152,8 @@ export default class TestRun extends EventEmitter {
     }
 
     _initRequestHook (hook) {
+        hook.warningLog = this.warningLog;
+
         hook._instantiateRequestFilterRules();
         hook._instantiatedRequestFilterRules.forEach(rule => {
             this.session.addRequestEventListeners(rule, {
@@ -161,6 +165,8 @@ export default class TestRun extends EventEmitter {
     }
 
     _disposeRequestHook (hook) {
+        hook.warningLog = null;
+
         hook._instantiatedRequestFilterRules.forEach(rule => {
             this.session.removeRequestEventListeners(rule);
         });

diff --git a/test/functional/fixtures/api/es-next/request-hooks/pages/failed-cors-validation.html b/test/functional/fixtures/api/es-next/request-hooks/pages/failed-cors-validation.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+</head>
+<body>
+    <button id="btnSendFetch">Send fetch request</button>
+    <span>Request status:</span><span id="requestStatusText">Not send</span>
+    <script>
+        var btnSendFetch = document.getElementById('btnSendFetch');
+
+        btnSendFetch.addEventListener('click', function () {
+            fetch('http://dummy-url.com/get')
+                .then(res => {
+                    return res.text();
+                })
+                .then(() => {
+                    document.getElementById('requestStatusText').textContent = 'Sent';
+                });
+        });
+    </script>
+</body>
+</html>
diff --git a/test/functional/fixtures/api/es-next/request-hooks/test.js b/test/functional/fixtures/api/es-next/request-hooks/test.js
@@ -1,6 +1,19 @@
+const expect = require('chai').expect;
+
 describe('Request Hooks', () => {
-    it('RequestMock', () => {
-        return runTests('./testcafe-fixtures/request-mock.js', 'Basic', { only: 'chrome' });
+    describe('RequestMock', () => {
+        it('Basic', () => {
+            return runTests('./testcafe-fixtures/request-mock/basic.js', 'Basic', { only: 'chrome' });
+        });
+
+        it('Request failed the CORS validation', () => {
+            return runTests('./testcafe-fixtures/request-mock/failed-cors-validation.js', 'Failed CORS validation', { only: 'chrome' })
+                .then(() => {
+                    expect(testReport.warnings).eql([
+                        'RequestMock: CORS validation failed for a request specified as { url: "http://dummy-url.com/get" }'
+                    ]);
+                });
+        });
     });
 
     describe('RequestLogger', () => {

diff --git a/...t-hooks/testcafe-fixtures/request-mock.js → ...s/testcafe-fixtures/request-mock/basic.js b/...t-hooks/testcafe-fixtures/request-mock.js → ...s/testcafe-fixtures/request-mock/basic.js
diff --git a/...xtures/api/es-next/request-hooks/testcafe-fixtures/request-mock/failed-cors-validation.js b/...xtures/api/es-next/request-hooks/testcafe-fixtures/request-mock/failed-cors-validation.js
@@ -0,0 +1,15 @@
+import { Selector, RequestMock } from 'testcafe';
+
+const mock = RequestMock()
+    .onRequestTo('http://dummy-url.com/get')
+    .respond({ prop: 'value' }, 200, { 'not-specify-cors-headers': true });
+
+fixture `Failed CORS validation`
+    .page('http://localhost:3000/fixtures/api/es-next/request-hooks/pages/failed-cors-validation.html')
+    .requestHooks(mock);
+
+test('Failed CORS validation', async t => {
+    await t
+        .click('#btnSendFetch')
+        .expect(Selector('#requestStatusText').textContent).eql('Sent');
+});