1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename qnetworkrequestfactory's request() to createRequest()

Browse Source 
Resulted from API-review

Change-Id: I09349dbddbfc191d871563b834396b387c6153c9
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
(cherry picked from commit f0db08088025005c765037ae53216fb7ee45c29c)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Juha Vuolle 2024-01-11 08:23:04 +02:00 committed by Qt Cherry-pick Bot
parent 31a94ee00d
commit a18964adf0
5 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/network/access/qnetworkrequestfactory.cpp
View File

@ -214,7 +214,7 @@ void QNetworkRequestFactory::setSslConfiguration(const QSslConfiguration &config
\sa request(const QUrlQuery&), request(const QString&, const QUrlQuery&) \sa request(const QUrlQuery&), request(const QString&, const QUrlQuery&)
*/ */
QNetworkRequest QNetworkRequestFactory::request() const QNetworkRequest QNetworkRequestFactory::createRequest() const
{ {
return d->newRequest(d->requestUrl()); return d->newRequest(d->requestUrl());
} }
@ -227,7 +227,7 @@ QNetworkRequest QNetworkRequestFactory::request() const
\sa request(const QString &, const QUrlQuery &), request(), baseUrl() \sa request(const QString &, const QUrlQuery &), request(), baseUrl()
*/ */
QNetworkRequest QNetworkRequestFactory::request(const QString &path) const QNetworkRequest QNetworkRequestFactory::createRequest(const QString &path) const
{ {
return d->newRequest(d->requestUrl(&path)); return d->newRequest(d->requestUrl(&path));
} }
@ -240,7 +240,7 @@ QNetworkRequest QNetworkRequestFactory::request(const QString &path) const
\sa request(const QString &, const QUrlQuery &), request(), baseUrl() \sa request(const QString &, const QUrlQuery &), request(), baseUrl()
*/ */
QNetworkRequest QNetworkRequestFactory::request(const QUrlQuery &query) const QNetworkRequest QNetworkRequestFactory::createRequest(const QUrlQuery &query) const
{ {
return d->newRequest(d->requestUrl(nullptr, &query)); return d->newRequest(d->requestUrl(nullptr, &query));
} }
@ -256,7 +256,7 @@ QNetworkRequest QNetworkRequestFactory::request(const QUrlQuery &query) const
\sa request(const QUrlQuery&), request(), baseUrl() \sa request(const QUrlQuery&), request(), baseUrl()
*/ */
QNetworkRequest QNetworkRequestFactory::request(const QString &path, const QUrlQuery &query) const QNetworkRequest QNetworkRequestFactory::createRequest(const QString &path, const QUrlQuery &query) const
{ {
return d->newRequest(d->requestUrl(&path, &query)); return d->newRequest(d->requestUrl(&path, &query));
} }

8
src/network/access/qnetworkrequestfactory.h
View File

@ -46,10 +46,10 @@ public:
Q_NETWORK_EXPORT void setSslConfiguration(const QSslConfiguration &configuration); Q_NETWORK_EXPORT void setSslConfiguration(const QSslConfiguration &configuration);
#endif #endif
Q_NETWORK_EXPORT QNetworkRequest request() const; Q_NETWORK_EXPORT QNetworkRequest createRequest() const;
Q_NETWORK_EXPORT QNetworkRequest request(const QUrlQuery &query) const; Q_NETWORK_EXPORT QNetworkRequest createRequest(const QUrlQuery &query) const;
Q_NETWORK_EXPORT QNetworkRequest request(const QString &path) const; Q_NETWORK_EXPORT QNetworkRequest createRequest(const QString &path) const;
Q_NETWORK_EXPORT QNetworkRequest request(const QString &path, const QUrlQuery &query) const; Q_NETWORK_EXPORT QNetworkRequest createRequest(const QString &path, const QUrlQuery &query) const;
Q_NETWORK_EXPORT void setHeaders(const QHttpHeaders &headers); Q_NETWORK_EXPORT void setHeaders(const QHttpHeaders &headers);
Q_NETWORK_EXPORT QHttpHeaders headers() const; Q_NETWORK_EXPORT QHttpHeaders headers() const;

8
src/network/doc/snippets/code/src_network_access_qnetworkrequestfactory.cpp
View File

@ -10,9 +10,9 @@ QNetworkRequestFactory api{{"https://example.com/v1"_L1}};
api.setBearerToken("my_token"); api.setBearerToken("my_token");
// Issue requests (reply handling omitted for brevity) // Issue requests (reply handling omitted for brevity)
manager.get(api.request("models"_L1)); // https://example.com/v1/models manager.get(api.createRequest("models"_L1)); // https://example.com/v1/models
// The conventional leading '/' for the path can be used as well // The conventional leading '/' for the path can be used as well
manager.get(api.request("/models"_L1)); // https://example.com/v1/models manager.get(api.createRequest("/models"_L1)); // https://example.com/v1/models
//! [0] //! [0]
@ -20,8 +20,8 @@ manager.get(api.request("/models"_L1)); // https://example.com/v1/models
// Here the API version v2 is used as the base path: // Here the API version v2 is used as the base path:
QNetworkRequestFactory api{{"https://example.com/v2"_L1}}; QNetworkRequestFactory api{{"https://example.com/v2"_L1}};
// ... // ...
manager.get(api.request("models"_L1)); // https://example.com/v2/models manager.get(api.createRequest("models"_L1)); // https://example.com/v2/models
// Equivalent with a leading '/' // Equivalent with a leading '/'
manager.get(api.request("/models"_L1)); // https://example.com/v2/models manager.get(api.createRequest("/models"_L1)); // https://example.com/v2/models
//! [1] //! [1]

56
tests/auto/network/access/qnetworkrequestfactory/tst_qnetworkrequestfactory.cpp
View File

@ -88,9 +88,9 @@ void tst_QNetworkRequestFactory::urlAndPath()
QCOMPARE(factory2.baseUrl(), baseUrl); QCOMPARE(factory2.baseUrl(), baseUrl);
// Request path // Request path
QNetworkRequest request = factory1.request(); QNetworkRequest request = factory1.createRequest();
QCOMPARE(request.url(), baseUrl); // No path was provided for request(), expect baseUrl QCOMPARE(request.url(), baseUrl); // No path was provided for createRequest(), expect baseUrl
request = factory1.request(requestPath); request = factory1.createRequest(requestPath);
QCOMPARE(request.url(), expectedRequestUrl); QCOMPARE(request.url(), expectedRequestUrl);
// Check the request path didn't change base url // Check the request path didn't change base url
@ -103,9 +103,9 @@ void tst_QNetworkRequestFactory::queryParameters()
const QUrlQuery query1{{"q1k", "q1v"}}; const QUrlQuery query1{{"q1k", "q1v"}};
const QUrlQuery query2{{"q2k", "q2v"}}; const QUrlQuery query2{{"q2k", "q2v"}};
// Set query parameters in request() call // Set query parameters in createRequest() call
QCOMPARE(factory.request(query1).url(), QUrl{"http://example.com?q1k=q1v"}); QCOMPARE(factory.createRequest(query1).url(), QUrl{"http://example.com?q1k=q1v"});
QCOMPARE(factory.request(query2).url(), QUrl{"http://example.com?q2k=q2v"}); QCOMPARE(factory.createRequest(query2).url(), QUrl{"http://example.com?q2k=q2v"});
// Set query parameters into the factory // Set query parameters into the factory
factory.setQueryParameters(query1); factory.setQueryParameters(query1);
@ -114,38 +114,38 @@ void tst_QNetworkRequestFactory::queryParameters()
QVERIFY(resultQuery.hasQueryItem(item.first)); QVERIFY(resultQuery.hasQueryItem(item.first));
QCOMPARE(resultQuery.queryItemValue(item.first), item.second); QCOMPARE(resultQuery.queryItemValue(item.first), item.second);
} }
QCOMPARE(factory.request().url(), QUrl{"http://example.com?q1k=q1v"}); QCOMPARE(factory.createRequest().url(), QUrl{"http://example.com?q1k=q1v"});
// Set query parameters into both request() and factory // Set query parameters into both createRequest() and factory
QCOMPARE(factory.request(query2).url(), QUrl{"http://example.com?q2k=q2v&q1k=q1v"}); QCOMPARE(factory.createRequest(query2).url(), QUrl{"http://example.com?q2k=q2v&q1k=q1v"});
// Clear query parameters // Clear query parameters
factory.clearQueryParameters(); factory.clearQueryParameters();
QVERIFY(factory.queryParameters().isEmpty()); QVERIFY(factory.queryParameters().isEmpty());
QCOMPARE(factory.request().url(), QUrl{"http://example.com"}); QCOMPARE(factory.createRequest().url(), QUrl{"http://example.com"});
const QString pathWithQuery{"content?raw=1"}; const QString pathWithQuery{"content?raw=1"};
// Set query parameters in per-request path // Set query parameters in per-request path
QCOMPARE(factory.request(pathWithQuery).url(), QCOMPARE(factory.createRequest(pathWithQuery).url(),
QUrl{"http://example.com/content?raw=1"}); QUrl{"http://example.com/content?raw=1"});
// Set query parameters in per-request path and the query parameter // Set query parameters in per-request path and the query parameter
QCOMPARE(factory.request(pathWithQuery, query1).url(), QCOMPARE(factory.createRequest(pathWithQuery, query1).url(),
QUrl{"http://example.com/content?q1k=q1v&raw=1"}); QUrl{"http://example.com/content?q1k=q1v&raw=1"});
// Set query parameter in per-request path and into the factory // Set query parameter in per-request path and into the factory
factory.setQueryParameters(query2); factory.setQueryParameters(query2);
QCOMPARE(factory.request(pathWithQuery).url(), QCOMPARE(factory.createRequest(pathWithQuery).url(),
QUrl{"http://example.com/content?raw=1&q2k=q2v"}); QUrl{"http://example.com/content?raw=1&q2k=q2v"});
// Set query parameters in per-request, as additional parameters, and into the factory // Set query parameters in per-request, as additional parameters, and into the factory
QCOMPARE(factory.request(pathWithQuery, query1).url(), QCOMPARE(factory.createRequest(pathWithQuery, query1).url(),
QUrl{"http://example.com/content?q1k=q1v&raw=1&q2k=q2v"}); QUrl{"http://example.com/content?q1k=q1v&raw=1&q2k=q2v"});
// Test that other than path and query items as part of path are ignored // Test that other than path and query items as part of path are ignored
factory.setQueryParameters(query1); factory.setQueryParameters(query1);
QRegularExpression re("The provided path*"); QRegularExpression re("The provided path*");
QTest::ignoreMessage(QtMsgType::QtWarningMsg, re); QTest::ignoreMessage(QtMsgType::QtWarningMsg, re);
QCOMPARE(factory.request("https://example2.com").url(), QUrl{"http://example.com?q1k=q1v"}); QCOMPARE(factory.createRequest("https://example2.com").url(), QUrl{"http://example.com?q1k=q1v"});
QTest::ignoreMessage(QtMsgType::QtWarningMsg, re); QTest::ignoreMessage(QtMsgType::QtWarningMsg, re);
QCOMPARE(factory.request("https://example2.com?q3k=q3v").url(), QCOMPARE(factory.createRequest("https://example2.com?q3k=q3v").url(),
QUrl{"http://example.com?q3k=q3v&q1k=q1v"}); QUrl{"http://example.com?q3k=q3v&q1k=q1v"});
} }
@ -175,9 +175,9 @@ void tst_QNetworkRequestFactory::sslConfiguration()
QCOMPARE_NE(factory1, factory2); QCOMPARE_NE(factory1, factory2);
// Verify requests are set with appropriate SSL configs // Verify requests are set with appropriate SSL configs
QNetworkRequest request1 = factory1.request(); QNetworkRequest request1 = factory1.createRequest();
QCOMPARE(request1.sslConfiguration(), config1); QCOMPARE(request1.sslConfiguration(), config1);
QNetworkRequest request2 = factory2.request(); QNetworkRequest request2 = factory2.createRequest();
QCOMPARE(request2.sslConfiguration(), config2); QCOMPARE(request2.sslConfiguration(), config2);
#endif #endif
} }
@ -204,7 +204,7 @@ void tst_QNetworkRequestFactory::headers()
QCOMPARE(factory.headers().combinedValue(name1), value1); QCOMPARE(factory.headers().combinedValue(name1), value1);
QCOMPARE(factory.headers().size(), 1); QCOMPARE(factory.headers().size(), 1);
QVERIFY(factory.headers().values("nonexistent").isEmpty()); QVERIFY(factory.headers().values("nonexistent").isEmpty());
QNetworkRequest request = factory.request(); QNetworkRequest request = factory.createRequest();
QVERIFY(request.hasRawHeader(name1)); QVERIFY(request.hasRawHeader(name1));
QCOMPARE(request.rawHeader(name1), value1); QCOMPARE(request.rawHeader(name1), value1);
@ -215,7 +215,7 @@ void tst_QNetworkRequestFactory::headers()
// Clear headers // Clear headers
factory.clearHeaders(); factory.clearHeaders();
QVERIFY(factory.headers().isEmpty()); QVERIFY(factory.headers().isEmpty());
request = factory.request(); request = factory.createRequest();
QVERIFY(!request.hasRawHeader(name1)); QVERIFY(!request.hasRawHeader(name1));
// Set headers with more entries // Set headers with more entries
@ -228,7 +228,7 @@ void tst_QNetworkRequestFactory::headers()
QCOMPARE(factory.headers().combinedValue(name1), value1); QCOMPARE(factory.headers().combinedValue(name1), value1);
QCOMPARE(factory.headers().combinedValue(name2), value2); QCOMPARE(factory.headers().combinedValue(name2), value2);
QCOMPARE(factory.headers().size(), 2); QCOMPARE(factory.headers().size(), 2);
request = factory.request(); request = factory.createRequest();
QVERIFY(request.hasRawHeader(name1)); QVERIFY(request.hasRawHeader(name1));
QVERIFY(request.hasRawHeader(name2)); QVERIFY(request.hasRawHeader(name2));
QCOMPARE(request.rawHeader(name1), value1); QCOMPARE(request.rawHeader(name1), value1);
@ -241,7 +241,7 @@ void tst_QNetworkRequestFactory::headers()
factory.setHeaders(h1); factory.setHeaders(h1);
QVERIFY(factory.headers().has(name1)); QVERIFY(factory.headers().has(name1));
QCOMPARE(factory.headers().combinedValue(name1), value1 + ',' + value2 + ',' + value3); QCOMPARE(factory.headers().combinedValue(name1), value1 + ',' + value2 + ',' + value3);
request = factory.request(); request = factory.createRequest();
QVERIFY(request.hasRawHeader(name1)); QVERIFY(request.hasRawHeader(name1));
QCOMPARE(request.rawHeader(name1), value1 + ',' + value2 + ',' + value3); QCOMPARE(request.rawHeader(name1), value1 + ',' + value2 + ',' + value3);
} }
@ -254,7 +254,7 @@ void tst_QNetworkRequestFactory::bearerToken()
factory.setBearerToken(bearerToken1); factory.setBearerToken(bearerToken1);
QCOMPARE(factory.bearerToken(), bearerToken1); QCOMPARE(factory.bearerToken(), bearerToken1);
QNetworkRequest request = factory.request(); QNetworkRequest request = factory.createRequest();
QVERIFY(request.hasRawHeader(authHeader)); QVERIFY(request.hasRawHeader(authHeader));
QCOMPARE(request.rawHeader(authHeader), "Bearer "_ba + bearerToken1); QCOMPARE(request.rawHeader(authHeader), "Bearer "_ba + bearerToken1);
@ -267,7 +267,7 @@ void tst_QNetworkRequestFactory::bearerToken()
factory.setBearerToken(bearerToken2); factory.setBearerToken(bearerToken2);
QCOMPARE(factory.bearerToken(), bearerToken2); QCOMPARE(factory.bearerToken(), bearerToken2);
request = factory.request(); request = factory.createRequest();
QVERIFY(request.hasRawHeader(authHeader)); QVERIFY(request.hasRawHeader(authHeader));
QCOMPARE(request.rawHeader(authHeader), "Bearer "_ba + bearerToken2); QCOMPARE(request.rawHeader(authHeader), "Bearer "_ba + bearerToken2);
@ -276,13 +276,13 @@ void tst_QNetworkRequestFactory::bearerToken()
QHttpHeaders h1; QHttpHeaders h1;
h1.append(authHeader, value); h1.append(authHeader, value);
factory.setHeaders(h1); factory.setHeaders(h1);
request = factory.request(); request = factory.createRequest();
QVERIFY(request.hasRawHeader(authHeader)); QVERIFY(request.hasRawHeader(authHeader));
// bearerToken has precedence over manually set header // bearerToken has precedence over manually set header
QCOMPARE(request.rawHeader(authHeader), "Bearer "_ba + bearerToken2); QCOMPARE(request.rawHeader(authHeader), "Bearer "_ba + bearerToken2);
// clear bearer token, the manually set header is now used // clear bearer token, the manually set header is now used
factory.clearBearerToken(); factory.clearBearerToken();
request = factory.request(); request = factory.createRequest();
QVERIFY(request.hasRawHeader(authHeader)); QVERIFY(request.hasRawHeader(authHeader));
QCOMPARE(request.rawHeader(authHeader), value); QCOMPARE(request.rawHeader(authHeader), value);
} }
@ -326,12 +326,12 @@ void tst_QNetworkRequestFactory::timeout()
constexpr auto timeout = 150ms; constexpr auto timeout = 150ms;
QNetworkRequestFactory factory; QNetworkRequestFactory factory;
QNetworkRequest request = factory.request(); QNetworkRequest request = factory.createRequest();
QCOMPARE(factory.transferTimeout(), defaultTimeout); QCOMPARE(factory.transferTimeout(), defaultTimeout);
QCOMPARE(request.transferTimeoutAsDuration(), defaultTimeout); QCOMPARE(request.transferTimeoutAsDuration(), defaultTimeout);
factory.setTransferTimeout(timeout); factory.setTransferTimeout(timeout);
request = factory.request(); request = factory.createRequest();
QCOMPARE(factory.transferTimeout(), timeout); QCOMPARE(factory.transferTimeout(), timeout);
QCOMPARE(request.transferTimeoutAsDuration(), timeout); QCOMPARE(request.transferTimeoutAsDuration(), timeout);
} }

2
tests/auto/network/access/qrestaccessmanager/tst_qrestaccessmanager.cpp
View File

@ -584,7 +584,7 @@ void tst_QRestAccessManager::userInfo()
serverSideRequest = request; // store for checking later the 'Authorization' header value serverSideRequest = request; // store for checking later the 'Authorization' header value
}); });
ReplyPtr reply(manager.get(factory.request())); ReplyPtr reply(manager.get(factory.createRequest()));
QTRY_VERIFY(reply.get()->isFinished()); QTRY_VERIFY(reply.get()->isFinished());
QVERIFY(reply.get()->isSuccess()); QVERIFY(reply.get()->isSuccess());
QCOMPARE(reply.get()->httpStatus(), 200); QCOMPARE(reply.get()->httpStatus(), 200);