Set custom headers from QWebEngineUrlRequestInfo before triggering redirect

Fixes: QTBUG-88861 Change-Id: I7091aca70aaf87edf0b1e67ec3fa705a59c8192c Reviewed-by: Michal Klocek <michal.klocek@qt.io>
author: Kirill Burtsev <kirill.burtsev@qt.io> 2020-11-26 19:29:02 +0100
committer: Kirill Burtsev <kirill.burtsev@qt.io> 2020-12-01 12:18:35 +0100
commit: 518cb95730dd1ac889cbe732fab11019085a5cd8 (patch)
tree: 871e9eef0ad6bb147fd3136001529b8f316bd22c /tests/auto/core/qwebengineurlrequestinterceptor
parent: f5800f41752c566957e269f51fe4109f64c68f01 (diff)
3 files changed, 67 insertions, 31 deletions
diff --git a/tests/auto/core/qwebengineurlrequestinterceptor/resources/content.html b/tests/auto/core/qwebengineurlrequestinterceptor/resources/content.html
index 360ad65ef..84bf55036 100644
--- a/tests/auto/core/qwebengineurlrequestinterceptor/resources/content.html
+++ b/tests/auto/core/qwebengineurlrequestinterceptor/resources/content.html
@@ -1,5 +1,6 @@
 <html>
+<head><link rel="icon" href="data:,"></head>
 <body>
-<a>This is test content</a>
+<a>Simple test page without favicon (meaning no separate request from http server)</a>
 </body>
 </html>
diff --git a/tests/auto/core/qwebengineurlrequestinterceptor/resources/content2.html b/tests/auto/core/qwebengineurlrequestinterceptor/resources/content2.html
new file mode 100644
index 000000000..84bf55036
--- /dev/null
+++ b/tests/auto/core/qwebengineurlrequestinterceptor/resources/content2.html
@@ -0,0 +1,6 @@
+<html>
+<head><link rel="icon" href="data:,"></head>
+<body>
+<a>Simple test page without favicon (meaning no separate request from http server)</a>
+</body>
+</html>
diff --git a/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp b/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp
index 20e191a4f..bf4acec14 100644
--- a/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp
+++ b/tests/auto/core/qwebengineurlrequestinterceptor/tst_qwebengineurlrequestinterceptor.cpp
@@ -70,8 +70,8 @@ private Q_SLOTS:
     void requestInterceptorByResourceType();
     void firstPartyUrlHttp_data();
     void firstPartyUrlHttp();
-    void passRefererHeader_data();
-    void passRefererHeader();
+    void customHeaders_data();
+    void customHeaders();
     void initiator_data();
     void initiator();
     void jsServiceWorker_data();
@@ -116,36 +116,39 @@ struct RequestInfo {
     int resourceType;
 };
 
-static const QByteArray kHttpHeaderReferrerValue = QByteArrayLiteral("http://somereferrer.com/");
-static const QByteArray kHttpHeaderRefererName = QByteArrayLiteral("referer");
 static const QUrl kRedirectUrl = QUrl("qrc:///resources/content.html");
 
+Q_LOGGING_CATEGORY(lc, "qt.webengine.tests")
+
 class TestRequestInterceptor : public QWebEngineUrlRequestInterceptor
 {
 public:
     QList<RequestInfo> requestInfos;
     bool shouldRedirect = false;
+    QUrl redirectUrl;
     QMap<QUrl, QSet<QUrl>> requestInitiatorUrls;
     QMap<QByteArray, QByteArray> headers;
 
     void interceptRequest(QWebEngineUrlRequestInfo &info) override
     {
         QCOMPARE(QThread::currentThread() == QCoreApplication::instance()->thread(), !property("deprecated").toBool());
+        qCDebug(lc) << this << "Type:" << info.resourceType() << info.requestMethod() << "Navigation:" << info.navigationType()
+                    << info.requestUrl() << "Initiator:" << info.initiator();
 
         // Since 63 we also intercept some unrelated blob requests..
         if (info.requestUrl().scheme() == QLatin1String("blob"))
             return;
 
         bool block = info.requestMethod() != QByteArrayLiteral("GET");
-        bool redirect = shouldRedirect && info.requestUrl() != kRedirectUrl;
+        bool redirect = shouldRedirect && info.requestUrl() != redirectUrl;
+
+        // set additional headers if any required by test
+        for (auto it = headers.begin(); it != headers.end(); ++it) info.setHttpHeader(it.key(), it.value());
 
         if (block) {
             info.block(true);
         } else if (redirect) {
-            info.redirect(kRedirectUrl);
-        } else {
-            // set additional headers if any required by test
-            for (auto it = headers.begin(); it != headers.end(); ++it) info.setHttpHeader(it.key(), it.value());
+            info.redirect(redirectUrl);
         }
 
         requestInitiatorUrls[info.requestUrl()].insert(info.initiator());
@@ -195,8 +198,8 @@ public:
         return false;
     }
 
-    TestRequestInterceptor(bool redirect)
-        : shouldRedirect(redirect)
+    TestRequestInterceptor(bool redirect = false, const QUrl &url = kRedirectUrl)
+        : shouldRedirect(redirect), redirectUrl(url)
     {
     }
 };
@@ -627,43 +630,69 @@ void tst_QWebEngineUrlRequestInterceptor::firstPartyUrlHttp()
         QCOMPARE(info.firstPartyUrl, firstPartyUrl);
 }
 
-void tst_QWebEngineUrlRequestInterceptor::passRefererHeader_data()
+void tst_QWebEngineUrlRequestInterceptor::customHeaders_data()
 {
     interceptRequest_data();
 }
 
-void tst_QWebEngineUrlRequestInterceptor::passRefererHeader()
+void tst_QWebEngineUrlRequestInterceptor::customHeaders()
 {
     QFETCH(InterceptorSetter, setter);
     // Create HTTP Server to parse the request.
     HttpServer httpServer;
-
-    if (!httpServer.start())
-        QSKIP("Failed to start http server");
-
-    bool succeeded = false;
-    connect(&httpServer, &HttpServer::newRequest, [&succeeded](HttpReqRep *rr) {
-        const QByteArray headerValue = rr->requestHeader(kHttpHeaderRefererName);
-        QCOMPARE(headerValue, kHttpHeaderReferrerValue);
-        succeeded = headerValue == kHttpHeaderReferrerValue;
-        rr->sendResponse();
-    });
+    httpServer.setResourceDirs({ TESTS_SOURCE_DIR "qwebengineurlrequestinterceptor/resources" });
+    QVERIFY(httpServer.start());
 
     QWebEngineProfile profile;
     TestRequestInterceptor interceptor(false);
-    interceptor.headers.insert(kHttpHeaderRefererName, kHttpHeaderReferrerValue);
     (profile.*setter)(&interceptor);
 
     QWebEnginePage page(&profile);
     QSignalSpy spy(&page, SIGNAL(loadFinished(bool)));
-    QWebEngineHttpRequest httpRequest;
-    QUrl requestUrl = httpServer.url();
-    httpRequest.setUrl(requestUrl);
-    page.load(httpRequest);
 
+    interceptor.headers = {
+        { "referer", "http://somereferrer.com/" },
+        { "from", "user@example.com" },
+        { "user-agent", "mozilla/5.0 (x11; linux x86_64; rv:12.0) gecko/20100101 firefox/12.0" },
+    };
+
+    QMap<QByteArray, QByteArray> actual, expected;
+    connect(&httpServer, &HttpServer::newRequest, [&] (HttpReqRep *rr) {
+        for (auto it = expected.begin(); it != expected.end(); ++it) {
+            auto headerValue = rr->requestHeader(it.key());
+            actual[it.key()] = headerValue;
+            QCOMPARE(headerValue, it.value());
+        }
+    });
+
+    auto dumpHeaders = [&] () {
+        QString s; QDebug d(&s);
+        for (auto it = expected.begin(); it != expected.end(); ++it)
+            d << "\n\tHeader:" << it.key() << "| actual:" << actual[it.key()] << "expected:" << it.value();
+        return s;
+    };
+
+    expected = interceptor.headers;
+    page.load(httpServer.url("/content.html"));
+    QVERIFY(spy.wait());
+    QVERIFY2(actual == expected, qPrintable(dumpHeaders()));
+
+    // test that custom headers are also applied on redirect
+    interceptor.shouldRedirect = true;
+    interceptor.redirectUrl = httpServer.url("/content2.html");
+    interceptor.headers = {
+        { "referer", "http://somereferrer2.com/" },
+        { "from", "user2@example.com" },
+        { "user-agent", "mozilla/5.0 (compatible; googlebot/2.1; +http://www.google.com/bot.html)" },
+    };
+
+    actual.clear();
+    expected = interceptor.headers;
+    page.triggerAction(QWebEnginePage::Reload);
     QVERIFY(spy.wait());
+    QVERIFY2(actual == expected, qPrintable(dumpHeaders()));
+
     (void) httpServer.stop();
-    QVERIFY(succeeded);
 }
 
 void tst_QWebEngineUrlRequestInterceptor::initiator_data()
author	Kirill Burtsev <kirill.burtsev@qt.io>	2020-11-26 19:29:02 +0100
committer	Kirill Burtsev <kirill.burtsev@qt.io>	2020-12-01 12:18:35 +0100
commit	518cb95730dd1ac889cbe732fab11019085a5cd8 (patch)
tree	871e9eef0ad6bb147fd3136001529b8f316bd22c /tests/auto/core/qwebengineurlrequestinterceptor
parent	f5800f41752c566957e269f51fe4109f64c68f01 (diff)