| /**************************************************************************** |
| ** |
| ** Copyright (C) 2017 The Qt Company Ltd. |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the QtWebEngine module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:GPL-EXCEPT$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "../../widgets/util.h" |
| #include <QtTest/QtTest> |
| #include <QtWebEngineCore/qwebengineurlrequestinfo.h> |
| #include <QtWebEngineCore/qwebengineurlrequestinterceptor.h> |
| #include <QtWebEngineWidgets/qwebenginepage.h> |
| #include <QtWebEngineWidgets/qwebengineprofile.h> |
| #include <QtWebEngineWidgets/qwebenginesettings.h> |
| |
| #include <httpserver.h> |
| #include <httpreqrep.h> |
| |
| typedef void (QWebEngineProfile::*InterceptorSetter)(QWebEngineUrlRequestInterceptor *interceptor); |
| Q_DECLARE_METATYPE(InterceptorSetter) |
| class tst_QWebEngineUrlRequestInterceptor : public QObject |
| { |
| Q_OBJECT |
| |
| public: |
| tst_QWebEngineUrlRequestInterceptor(); |
| ~tst_QWebEngineUrlRequestInterceptor(); |
| |
| public Q_SLOTS: |
| void init(); |
| void cleanup(); |
| |
| private Q_SLOTS: |
| void initTestCase(); |
| void cleanupTestCase(); |
| void interceptRequest_data(); |
| void interceptRequest(); |
| void ipv6HostEncoding_data(); |
| void ipv6HostEncoding(); |
| void requestedUrl_data(); |
| void requestedUrl(); |
| void setUrlSameUrl_data(); |
| void setUrlSameUrl(); |
| void firstPartyUrl_data(); |
| void firstPartyUrl(); |
| void firstPartyUrlNestedIframes_data(); |
| void firstPartyUrlNestedIframes(); |
| void requestInterceptorByResourceType_data(); |
| void requestInterceptorByResourceType(); |
| void firstPartyUrlHttp_data(); |
| void firstPartyUrlHttp(); |
| void passRefererHeader_data(); |
| void passRefererHeader(); |
| void initiator_data(); |
| void initiator(); |
| void jsServiceWorker_data(); |
| void jsServiceWorker(); |
| }; |
| |
| tst_QWebEngineUrlRequestInterceptor::tst_QWebEngineUrlRequestInterceptor() |
| { |
| } |
| |
| tst_QWebEngineUrlRequestInterceptor::~tst_QWebEngineUrlRequestInterceptor() |
| { |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::init() |
| { |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::cleanup() |
| { |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::initTestCase() |
| { |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::cleanupTestCase() |
| { |
| } |
| |
| struct RequestInfo { |
| RequestInfo(QWebEngineUrlRequestInfo &info) |
| : requestUrl(info.requestUrl()) |
| , firstPartyUrl(info.firstPartyUrl()) |
| , initiator(info.initiator()) |
| , resourceType(info.resourceType()) |
| {} |
| |
| QUrl requestUrl; |
| QUrl firstPartyUrl; |
| QUrl initiator; |
| 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"); |
| |
| class TestRequestInterceptor : public QWebEngineUrlRequestInterceptor |
| { |
| public: |
| QList<RequestInfo> requestInfos; |
| bool shouldRedirect = false; |
| QMap<QUrl, QSet<QUrl>> requestInitiatorUrls; |
| QMap<QByteArray, QByteArray> headers; |
| |
| void interceptRequest(QWebEngineUrlRequestInfo &info) override |
| { |
| QCOMPARE(QThread::currentThread() == QCoreApplication::instance()->thread(), !property("deprecated").toBool()); |
| |
| // 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; |
| |
| 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()); |
| } |
| |
| requestInitiatorUrls[info.requestUrl()].insert(info.initiator()); |
| requestInfos.append(info); |
| |
| // MEMO avoid unintentionally changing request when it is not needed for test logic |
| // since api behavior depends on 'changed' state of the info object |
| Q_ASSERT(info.changed() == (block || redirect || !headers.empty())); |
| } |
| |
| bool shouldSkipRequest(const RequestInfo &requestInfo) |
| { |
| if (requestInfo.resourceType == QWebEngineUrlRequestInfo::ResourceTypeMainFrame || |
| requestInfo.resourceType == QWebEngineUrlRequestInfo::ResourceTypeSubFrame) |
| return false; |
| |
| // Skip import documents and sandboxed documents. |
| // See Document::SiteForCookies() in chromium/third_party/blink/renderer/core/dom/document.cc. |
| return requestInfo.firstPartyUrl == QUrl(""); |
| } |
| |
| QList<RequestInfo> getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceType type) |
| { |
| QList<RequestInfo> infos; |
| |
| foreach (auto requestInfo, requestInfos) { |
| if (shouldSkipRequest(requestInfo)) |
| continue; |
| |
| if (type == requestInfo.resourceType) |
| infos.append(requestInfo); |
| } |
| |
| return infos; |
| } |
| |
| bool hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceType type) |
| { |
| foreach (auto requestInfo, requestInfos) { |
| if (shouldSkipRequest(requestInfo)) |
| continue; |
| |
| if (type == requestInfo.resourceType) |
| return true; |
| } |
| |
| return false; |
| } |
| |
| TestRequestInterceptor(bool redirect) |
| : shouldRedirect(redirect) |
| { |
| } |
| }; |
| |
| class TestServer : public HttpServer |
| { |
| public: |
| TestServer() |
| { |
| connect(this, &HttpServer::newRequest, this, &TestServer::onNewRequest); |
| } |
| |
| private: |
| void onNewRequest(HttpReqRep *rr) |
| { |
| const QDir resourceDir(TESTS_SOURCE_DIR "qwebengineurlrequestinterceptor/resources"); |
| QString path = rr->requestPath(); |
| path.remove(0, 1); |
| |
| if (rr->requestMethod() != "GET" || !resourceDir.exists(path)) |
| { |
| rr->setResponseStatus(404); |
| rr->sendResponse(); |
| return; |
| } |
| |
| QFile file(resourceDir.filePath(path)); |
| file.open(QIODevice::ReadOnly); |
| QByteArray data = file.readAll(); |
| rr->setResponseBody(data); |
| QMimeDatabase db; |
| QMimeType mime = db.mimeTypeForFileNameAndData(file.fileName(), data); |
| rr->setResponseHeader(QByteArrayLiteral("content-type"), mime.name().toUtf8()); |
| rr->sendResponse(); |
| } |
| }; |
| |
| class ConsolePage : public QWebEnginePage { |
| Q_OBJECT |
| public: |
| ConsolePage(QWebEngineProfile* profile) : QWebEnginePage(profile) {} |
| |
| virtual void javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, const QString& message, int lineNumber, const QString& sourceID) |
| { |
| levels.append(level); |
| messages.append(message); |
| lineNumbers.append(lineNumber); |
| sourceIDs.append(sourceID); |
| } |
| |
| QList<int> levels; |
| QStringList messages; |
| QList<int> lineNumbers; |
| QStringList sourceIDs; |
| }; |
| |
| void tst_QWebEngineUrlRequestInterceptor::interceptRequest_data() |
| { |
| QTest::addColumn<InterceptorSetter>("setter"); |
| QTest::newRow("ui") << &QWebEngineProfile::setUrlRequestInterceptor; |
| QTest::newRow("io") << &QWebEngineProfile::setRequestInterceptor; |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::interceptRequest() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QWebEngineProfile profile; |
| profile.settings()->setAttribute(QWebEngineSettings::ErrorPageEnabled, false); |
| TestRequestInterceptor interceptor(/* intercept */ false); |
| (profile.*setter)(&interceptor); |
| QWebEnginePage page(&profile); |
| QSignalSpy loadSpy(&page, SIGNAL(loadFinished(bool))); |
| |
| page.load(QUrl("qrc:///resources/index.html")); |
| QTRY_COMPARE(loadSpy.count(), 1); |
| QVariant success = loadSpy.takeFirst().takeFirst(); |
| QVERIFY(success.toBool()); |
| loadSpy.clear(); |
| QVariant ok; |
| |
| page.runJavaScript("post();", [&ok](const QVariant result){ ok = result; }); |
| QTRY_VERIFY(ok.toBool()); |
| QTRY_COMPARE(loadSpy.count(), 1); |
| success = loadSpy.takeFirst().takeFirst(); |
| // We block non-GET requests, so this should not succeed. |
| QVERIFY(!success.toBool()); |
| loadSpy.clear(); |
| |
| interceptor.shouldRedirect = true; |
| page.load(QUrl("qrc:///resources/__placeholder__")); |
| QTRY_COMPARE(loadSpy.count(), 1); |
| success = loadSpy.takeFirst().takeFirst(); |
| // The redirection for __placeholder__ should succeed. |
| QVERIFY(success.toBool()); |
| loadSpy.clear(); |
| QCOMPARE(interceptor.requestInfos.count(), 4); |
| |
| // Make sure that registering an observer does not modify the request. |
| TestRequestInterceptor observer(/* intercept */ false); |
| (profile.*setter)(&observer); |
| page.load(QUrl("qrc:///resources/__placeholder__")); |
| QTRY_COMPARE(loadSpy.count(), 1); |
| success = loadSpy.takeFirst().takeFirst(); |
| // Since we do not intercept, loading an invalid path should not succeed. |
| QVERIFY(!success.toBool()); |
| QCOMPARE(observer.requestInfos.count(), 1); |
| } |
| |
| class LocalhostContentProvider : public QWebEngineUrlRequestInterceptor |
| { |
| public: |
| LocalhostContentProvider() { } |
| |
| void interceptRequest(QWebEngineUrlRequestInfo &info) override |
| { |
| // Since 63 we also intercept the original data requests |
| if (info.requestUrl().scheme() == QLatin1String("data")) |
| return; |
| if (info.resourceType() == QWebEngineUrlRequestInfo::ResourceTypeFavicon) |
| return; |
| |
| requestedUrls.append(info.requestUrl()); |
| info.redirect(QUrl("data:text/html,<p>hello")); |
| } |
| |
| QList<QUrl> requestedUrls; |
| }; |
| |
| void tst_QWebEngineUrlRequestInterceptor::ipv6HostEncoding_data() |
| { |
| interceptRequest_data(); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::ipv6HostEncoding() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QWebEngineProfile profile; |
| LocalhostContentProvider contentProvider; |
| (profile.*setter)(&contentProvider); |
| |
| QWebEnginePage page(&profile); |
| QSignalSpy spyLoadFinished(&page, SIGNAL(loadFinished(bool))); |
| |
| page.setHtml("<p>Hi", QUrl::fromEncoded("http://[::1]/index.html")); |
| QTRY_COMPARE(spyLoadFinished.count(), 1); |
| QCOMPARE(contentProvider.requestedUrls.count(), 0); |
| |
| evaluateJavaScriptSync(&page, "var r = new XMLHttpRequest();" |
| "r.open('GET', 'http://[::1]/test.xml', false);" |
| "r.send(null);" |
| ); |
| |
| QCOMPARE(contentProvider.requestedUrls.count(), 1); |
| QCOMPARE(contentProvider.requestedUrls.at(0), QUrl::fromEncoded("http://[::1]/test.xml")); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::requestedUrl_data() |
| { |
| QTest::addColumn<InterceptorSetter>("setter"); |
| QTest::addColumn<bool>("interceptInPage"); |
| QTest::newRow("ui profile intercept") << &QWebEngineProfile::setUrlRequestInterceptor << false; |
| QTest::newRow("ui page intercept") << &QWebEngineProfile::setUrlRequestInterceptor << true; |
| QTest::newRow("io profile intercept") << &QWebEngineProfile::setRequestInterceptor << false; |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::requestedUrl() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QFETCH(bool, interceptInPage); |
| |
| QWebEngineProfile profile; |
| profile.settings()->setAttribute(QWebEngineSettings::ErrorPageEnabled, false); |
| TestRequestInterceptor interceptor(/* intercept */ true); |
| if (!interceptInPage) |
| (profile.*setter)(&interceptor); |
| |
| QWebEnginePage page(&profile); |
| if (interceptInPage) |
| page.setUrlRequestInterceptor(&interceptor); |
| QSignalSpy spy(&page, SIGNAL(loadFinished(bool))); |
| |
| page.setUrl(QUrl("qrc:///resources/__placeholder__")); |
| QVERIFY(spy.wait()); |
| QTRY_COMPARE(spy.count(), 1); |
| QVERIFY(interceptor.requestInfos.count() >= 1); |
| QCOMPARE(interceptor.requestInfos.at(0).requestUrl, QUrl("qrc:///resources/content.html")); |
| QCOMPARE(page.requestedUrl(), QUrl("qrc:///resources/__placeholder__")); |
| QCOMPARE(page.url(), QUrl("qrc:///resources/content.html")); |
| |
| interceptor.shouldRedirect = false; |
| |
| page.setUrl(QUrl("qrc:/non-existent.html")); |
| QTRY_COMPARE(spy.count(), 2); |
| QVERIFY(interceptor.requestInfos.count() >= 3); |
| QCOMPARE(interceptor.requestInfos.at(2).requestUrl, QUrl("qrc:/non-existent.html")); |
| QCOMPARE(page.requestedUrl(), QUrl("qrc:///resources/__placeholder__")); |
| QCOMPARE(page.url(), QUrl("qrc:///resources/content.html")); |
| |
| page.setUrl(QUrl("http://abcdef.abcdef")); |
| QTRY_COMPARE_WITH_TIMEOUT(spy.count(), 3, 15000); |
| QVERIFY(interceptor.requestInfos.count() >= 4); |
| QCOMPARE(interceptor.requestInfos.at(3).requestUrl, QUrl("http://abcdef.abcdef/")); |
| QCOMPARE(page.requestedUrl(), QUrl("qrc:///resources/__placeholder__")); |
| QCOMPARE(page.url(), QUrl("qrc:///resources/content.html")); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::setUrlSameUrl_data() |
| { |
| requestedUrl_data(); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::setUrlSameUrl() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QFETCH(bool, interceptInPage); |
| |
| QWebEngineProfile profile; |
| TestRequestInterceptor interceptor(/* intercept */ true); |
| if (!interceptInPage) |
| (profile.*setter)(&interceptor); |
| |
| QWebEnginePage page(&profile); |
| if (interceptInPage) |
| page.setUrlRequestInterceptor(&interceptor); |
| QSignalSpy spy(&page, SIGNAL(loadFinished(bool))); |
| |
| page.setUrl(QUrl("qrc:///resources/__placeholder__")); |
| QVERIFY(spy.wait()); |
| QCOMPARE(page.url(), QUrl("qrc:///resources/content.html")); |
| QCOMPARE(spy.count(), 1); |
| |
| page.setUrl(QUrl("qrc:///resources/__placeholder__")); |
| QVERIFY(spy.wait()); |
| QCOMPARE(page.url(), QUrl("qrc:///resources/content.html")); |
| QCOMPARE(spy.count(), 2); |
| |
| // Now a case without redirect. |
| page.setUrl(QUrl("qrc:///resources/content.html")); |
| QVERIFY(spy.wait()); |
| QCOMPARE(page.url(), QUrl("qrc:///resources/content.html")); |
| QCOMPARE(spy.count(), 3); |
| |
| page.setUrl(QUrl("qrc:///resources/__placeholder__")); |
| QVERIFY(spy.wait()); |
| QCOMPARE(page.url(), QUrl("qrc:///resources/content.html")); |
| QCOMPARE(spy.count(), 4); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::firstPartyUrl_data() |
| { |
| interceptRequest_data(); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::firstPartyUrl() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QWebEngineProfile profile; |
| TestRequestInterceptor interceptor(/* intercept */ false); |
| (profile.*setter)(&interceptor); |
| |
| QWebEnginePage page(&profile); |
| QSignalSpy spy(&page, SIGNAL(loadFinished(bool))); |
| |
| page.setUrl(QUrl("qrc:///resources/firstparty.html")); |
| QVERIFY(spy.wait()); |
| QVERIFY(interceptor.requestInfos.count() >= 2); |
| QCOMPARE(interceptor.requestInfos.at(0).requestUrl, QUrl("qrc:///resources/firstparty.html")); |
| QCOMPARE(interceptor.requestInfos.at(1).requestUrl, QUrl("qrc:///resources/content.html")); |
| QCOMPARE(interceptor.requestInfos.at(0).firstPartyUrl, QUrl("qrc:///resources/firstparty.html")); |
| QCOMPARE(interceptor.requestInfos.at(1).firstPartyUrl, QUrl("qrc:///resources/firstparty.html")); |
| QCOMPARE(spy.count(), 1); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::firstPartyUrlNestedIframes_data() |
| { |
| QUrl url = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/iframe.html")); |
| QTest::addColumn<InterceptorSetter>("setter"); |
| QTest::addColumn<QUrl>("requestUrl"); |
| QTest::newRow("ui file") << &QWebEngineProfile::setUrlRequestInterceptor << url; |
| QTest::newRow("io file") << &QWebEngineProfile::setRequestInterceptor << url; |
| QTest::newRow("ui qrc") << &QWebEngineProfile::setUrlRequestInterceptor |
| << QUrl("qrc:///resources/iframe.html"); |
| QTest::newRow("io qrc") << &QWebEngineProfile::setRequestInterceptor |
| << QUrl("qrc:///resources/iframe.html"); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::firstPartyUrlNestedIframes() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QFETCH(QUrl, requestUrl); |
| |
| if (requestUrl.scheme() == "file" && !QDir(TESTS_SOURCE_DIR).exists()) |
| W_QSKIP(QString("This test requires access to resources found in '%1'").arg(TESTS_SOURCE_DIR).toLatin1().constData(), SkipAll); |
| |
| QString adjustedUrl = requestUrl.adjusted(QUrl::RemoveFilename).toString(); |
| |
| QWebEngineProfile profile; |
| TestRequestInterceptor interceptor(/* intercept */ false); |
| (profile.*setter)(&interceptor); |
| |
| QWebEnginePage page(&profile); |
| QSignalSpy loadSpy(&page, SIGNAL(loadFinished(bool))); |
| page.setUrl(requestUrl); |
| QTRY_COMPARE(loadSpy.count(), 1); |
| |
| QVERIFY(interceptor.requestInfos.count() >= 1); |
| RequestInfo info = interceptor.requestInfos.at(0); |
| QCOMPARE(info.requestUrl, requestUrl); |
| QCOMPARE(info.firstPartyUrl, requestUrl); |
| QCOMPARE(info.resourceType, QWebEngineUrlRequestInfo::ResourceTypeMainFrame); |
| |
| QVERIFY(interceptor.requestInfos.count() >= 2); |
| info = interceptor.requestInfos.at(1); |
| QCOMPARE(info.requestUrl, QUrl(adjustedUrl + "iframe2.html")); |
| QCOMPARE(info.firstPartyUrl, requestUrl); |
| QCOMPARE(info.resourceType, QWebEngineUrlRequestInfo::ResourceTypeSubFrame); |
| |
| QVERIFY(interceptor.requestInfos.count() >= 3); |
| info = interceptor.requestInfos.at(2); |
| QCOMPARE(info.requestUrl, QUrl(adjustedUrl + "iframe3.html")); |
| QCOMPARE(info.firstPartyUrl, requestUrl); |
| QCOMPARE(info.resourceType, QWebEngineUrlRequestInfo::ResourceTypeSubFrame); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::requestInterceptorByResourceType_data() |
| { |
| QUrl firstPartyUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/resource_in_iframe.html")); |
| QUrl styleRequestUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/style.css")); |
| QUrl scriptRequestUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/script.js")); |
| QUrl fontRequestUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/fontawesome.woff")); |
| QUrl xhrRequestUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/test")); |
| QUrl imageFirstPartyUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/image_in_iframe.html")); |
| QUrl imageRequestUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/icons/favicon.png")); |
| QUrl mediaFirstPartyUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/media_in_iframe.html")); |
| QUrl mediaRequestUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/media.mp4")); |
| QUrl faviconFirstPartyUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/favicon.html")); |
| QUrl faviconRequestUrl = QUrl::fromLocalFile(TESTS_SOURCE_DIR + QLatin1String("qwebengineurlrequestinterceptor/resources/icons/favicon.png")); |
| |
| QTest::addColumn<InterceptorSetter>("setter"); |
| QTest::addColumn<QUrl>("requestUrl"); |
| QTest::addColumn<QUrl>("firstPartyUrl"); |
| QTest::addColumn<int>("resourceType"); |
| |
| QStringList name = { "ui", "io" }; |
| QVector<InterceptorSetter> setters = { &QWebEngineProfile::setUrlRequestInterceptor, |
| &QWebEngineProfile::setRequestInterceptor }; |
| for (int i = 0; i < 2; i++) { |
| QTest::newRow(qPrintable(name[i] + "StyleSheet")) |
| << setters[i] << styleRequestUrl << firstPartyUrl |
| << static_cast<int>(QWebEngineUrlRequestInfo::ResourceTypeStylesheet); |
| QTest::newRow(qPrintable(name[i] + "Script")) << setters[i] << scriptRequestUrl << firstPartyUrl |
| << static_cast<int>(QWebEngineUrlRequestInfo::ResourceTypeScript); |
| QTest::newRow(qPrintable(name[i] + "Image")) << setters[i] << imageRequestUrl << imageFirstPartyUrl |
| << static_cast<int>(QWebEngineUrlRequestInfo::ResourceTypeImage); |
| QTest::newRow(qPrintable(name[i] + "FontResource")) |
| << setters[i] << fontRequestUrl << firstPartyUrl |
| << static_cast<int>(QWebEngineUrlRequestInfo::ResourceTypeFontResource); |
| QTest::newRow(qPrintable(name[i] + "Media")) << setters[i] << mediaRequestUrl << mediaFirstPartyUrl |
| << static_cast<int>(QWebEngineUrlRequestInfo::ResourceTypeMedia); |
| QTest::newRow(qPrintable(name[i] + "Favicon")) |
| << setters[i] << faviconRequestUrl << faviconFirstPartyUrl |
| << static_cast<int>(QWebEngineUrlRequestInfo::ResourceTypeFavicon); |
| QTest::newRow(qPrintable(name[i] + "Xhr")) << setters[i] << xhrRequestUrl << firstPartyUrl |
| << static_cast<int>(QWebEngineUrlRequestInfo::ResourceTypeXhr); |
| } |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::requestInterceptorByResourceType() |
| { |
| if (!QDir(TESTS_SOURCE_DIR).exists()) |
| W_QSKIP(QString("This test requires access to resources found in '%1'").arg(TESTS_SOURCE_DIR).toLatin1().constData(), SkipAll); |
| QFETCH(InterceptorSetter, setter); |
| QFETCH(QUrl, requestUrl); |
| QFETCH(QUrl, firstPartyUrl); |
| QFETCH(int, resourceType); |
| |
| QWebEngineProfile profile; |
| TestRequestInterceptor interceptor(/* intercept */ false); |
| (profile.*setter)(&interceptor); |
| |
| QWebEnginePage page(&profile); |
| QSignalSpy loadSpy(&page, SIGNAL(loadFinished(bool))); |
| page.setUrl(firstPartyUrl); |
| QTRY_COMPARE(loadSpy.count(), 1); |
| |
| QTRY_COMPARE(interceptor.getUrlRequestForType(static_cast<QWebEngineUrlRequestInfo::ResourceType>(resourceType)).count(), 1); |
| QList<RequestInfo> infos = interceptor.getUrlRequestForType(static_cast<QWebEngineUrlRequestInfo::ResourceType>(resourceType)); |
| QVERIFY(infos.count() >= 1); |
| QCOMPARE(infos.at(0).requestUrl, requestUrl); |
| QCOMPARE(infos.at(0).firstPartyUrl, firstPartyUrl); |
| QCOMPARE(infos.at(0).resourceType, resourceType); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::firstPartyUrlHttp_data() |
| { |
| interceptRequest_data(); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::firstPartyUrlHttp() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QWebEngineProfile profile; |
| TestRequestInterceptor interceptor(/* intercept */ false); |
| (profile.*setter)(&interceptor); |
| |
| QWebEnginePage page(&profile); |
| QSignalSpy loadSpy(&page, SIGNAL(loadFinished(bool))); |
| QUrl firstPartyUrl = QUrl("https://www.w3schools.com/tags/tryit.asp?filename=tryhtml5_video"); |
| page.setUrl(QUrl(firstPartyUrl)); |
| if (!loadSpy.wait(15000) || !loadSpy.at(0).at(0).toBool()) |
| QSKIP("Couldn't load page from network, skipping test."); |
| |
| QList<RequestInfo> infos; |
| |
| // SubFrame |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeSubFrame)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeSubFrame); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| // Stylesheet |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeStylesheet)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeStylesheet); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| // Script |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeScript)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeScript); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| // Image |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeImage)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeImage); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| // FontResource |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFontResource)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFontResource); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| // Media |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeMedia)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeMedia); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| // Favicon |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFavicon)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFavicon); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| // XMLHttpRequest |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeXhr)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeXhr); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::passRefererHeader_data() |
| { |
| interceptRequest_data(); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::passRefererHeader() |
| { |
| 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->setResponseStatus(200); |
| rr->sendResponse(); |
| }); |
| |
| 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); |
| |
| QVERIFY(spy.wait()); |
| (void) httpServer.stop(); |
| QVERIFY(succeeded); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::initiator_data() |
| { |
| interceptRequest_data(); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::initiator() |
| { |
| QFETCH(InterceptorSetter, setter); |
| QWebEngineProfile profile; |
| TestRequestInterceptor interceptor(/* intercept */ false); |
| (profile.*setter)(&interceptor); |
| |
| QWebEnginePage page(&profile); |
| QSignalSpy loadSpy(&page, SIGNAL(loadFinished(bool))); |
| QUrl url = QUrl("https://www.w3schools.com/tags/tryit.asp?filename=tryhtml5_video"); |
| page.setUrl(QUrl(url)); |
| if (!loadSpy.wait(15000) || !loadSpy.at(0).at(0).toBool()) |
| QSKIP("Couldn't load page from network, skipping test."); |
| |
| QList<RequestInfo> infos; |
| |
| // SubFrame |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeSubFrame)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeSubFrame); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| |
| // Stylesheet |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeStylesheet)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeStylesheet); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| |
| // Script |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeScript)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeScript); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| |
| // Image |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeImage)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeImage); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| |
| // FontResource |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFontResource)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFontResource); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| |
| // Media |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeMedia)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeMedia); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| |
| // Favicon |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFavicon)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeFavicon); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| |
| // XMLHttpRequest |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeXhr)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeXhr); |
| foreach (auto info, infos) |
| QVERIFY(interceptor.requestInitiatorUrls[info.requestUrl].contains(info.initiator)); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::jsServiceWorker_data() |
| { |
| interceptRequest_data(); |
| } |
| |
| void tst_QWebEngineUrlRequestInterceptor::jsServiceWorker() |
| { |
| QFETCH(InterceptorSetter, setter); |
| |
| TestServer server; |
| QVERIFY(server.start()); |
| |
| QWebEngineProfile profile(QStringLiteral("Test")); |
| std::unique_ptr<ConsolePage> page; |
| page.reset(new ConsolePage(&profile)); |
| TestRequestInterceptor interceptor(/* intercept */ false); |
| (profile.*setter)(&interceptor); |
| QVERIFY(loadSync(page.get(), server.url("/sw.html"))); |
| |
| // We expect only one message here, because logging of services workers is not exposed in our API. |
| QTRY_COMPARE(page->messages.count(), 1); |
| QCOMPARE(page->levels.at(0), QWebEnginePage::InfoMessageLevel); |
| |
| QUrl firstPartyUrl = QUrl(server.url().toString() + "sw.js"); |
| QList<RequestInfo> infos; |
| // Service Worker |
| QTRY_VERIFY(interceptor.hasUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeServiceWorker)); |
| infos = interceptor.getUrlRequestForType(QWebEngineUrlRequestInfo::ResourceTypeServiceWorker); |
| foreach (auto info, infos) |
| QCOMPARE(info.firstPartyUrl, firstPartyUrl); |
| |
| QVERIFY(server.stop()); |
| } |
| |
| QTEST_MAIN(tst_QWebEngineUrlRequestInterceptor) |
| #include "tst_qwebengineurlrequestinterceptor.moc" |
