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

Rename QNetworkRequestFactory header functions to commonHeaders

Browse Source 
Resulted from API-review

Change-Id: Iae712e67839d27064a0155830fd201ab15693091
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
(cherry picked from commit 819a8f30f4cf2efe3b8e1f3f6356ff0afed0ae65)
This commit is contained in:
Juha Vuolle 2024-01-11 08:42:00 +02:00
parent aa2a569115
commit be67204568
3 changed files with 32 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -233,15 +233,15 @@ QNetworkRequest QNetworkRequestFactory::createRequest(const QString &path, const
} }
/*! /*!
Sets the headers to \a headers. Sets \a headers that are common to all requests.
These headers are added to individual requests' headers. These headers are added to individual requests' headers.
This is a convenience mechanism for setting headers that This is a convenience mechanism for setting headers that
repeat across requests. repeat across requests.
\sa headers(), clearHeaders() \sa headers(), clearHeaders(), createRequest()
*/ */
void QNetworkRequestFactory::setHeaders(const QHttpHeaders &headers) void QNetworkRequestFactory::setCommonHeaders(const QHttpHeaders &headers)
{ {
d.detach(); d.detach();
d->headers = headers; d->headers = headers;
@ -252,7 +252,7 @@ void QNetworkRequestFactory::setHeaders(const QHttpHeaders &headers)
\sa setHeaders(), clearHeaders() \sa setHeaders(), clearHeaders()
*/ */
QHttpHeaders QNetworkRequestFactory::headers() const QHttpHeaders QNetworkRequestFactory::commonHeaders() const
{ {
return d->headers; return d->headers;
} }
@ -262,7 +262,7 @@ QHttpHeaders QNetworkRequestFactory::headers() const
\sa headers(), setHeaders() \sa headers(), setHeaders()
*/ */
void QNetworkRequestFactory::clearHeaders() void QNetworkRequestFactory::clearCommonHeaders()
{ {
if (d->headers.isEmpty()) if (d->headers.isEmpty())
return; return;
@ -580,7 +580,7 @@ QDebug operator<<(QDebug debug, const QNetworkRequestFactory &factory)
debug.resetFormat().nospace(); debug.resetFormat().nospace();
debug << "QNetworkRequestFactory(baseUrl = " << factory.baseUrl() debug << "QNetworkRequestFactory(baseUrl = " << factory.baseUrl()
<< ", headers = " << factory.headers() << ", headers = " << factory.commonHeaders()
<< ", queryParameters = " << factory.queryParameters().queryItems() << ", queryParameters = " << factory.queryParameters().queryItems()
<< ", bearerToken = " << (factory.bearerToken().isEmpty() ? "(empty)" : "(is set)") << ", bearerToken = " << (factory.bearerToken().isEmpty() ? "(empty)" : "(is set)")
<< ", transferTimeout = " << factory.transferTimeout() << ", transferTimeout = " << factory.transferTimeout()

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

@ -51,9 +51,9 @@ public:
Q_NETWORK_EXPORT QNetworkRequest createRequest(const QString &path) const; Q_NETWORK_EXPORT QNetworkRequest createRequest(const QString &path) const;
Q_NETWORK_EXPORT QNetworkRequest createRequest(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 setCommonHeaders(const QHttpHeaders &headers);
Q_NETWORK_EXPORT QHttpHeaders headers() const; Q_NETWORK_EXPORT QHttpHeaders commonHeaders() const;
Q_NETWORK_EXPORT void clearHeaders(); Q_NETWORK_EXPORT void clearCommonHeaders();
Q_NETWORK_EXPORT QByteArray bearerToken() const; Q_NETWORK_EXPORT QByteArray bearerToken() const;
Q_NETWORK_EXPORT void setBearerToken(const QByteArray &token); Q_NETWORK_EXPORT void setBearerToken(const QByteArray &token);

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

@ -188,29 +188,29 @@ void tst_QNetworkRequestFactory::headers()
QNetworkRequestFactory factory{url1}; QNetworkRequestFactory factory{url1};
// Initial state when no headers are set // Initial state when no headers are set
QVERIFY(factory.headers().isEmpty()); QVERIFY(factory.commonHeaders().isEmpty());
QVERIFY(factory.headers().values(name1).isEmpty()); QVERIFY(factory.commonHeaders().values(name1).isEmpty());
QVERIFY(!factory.headers().contains(name1)); QVERIFY(!factory.commonHeaders().contains(name1));
// Set headers // Set headers
QHttpHeaders h1; QHttpHeaders h1;
h1.append(name1, value1); h1.append(name1, value1);
factory.setHeaders(h1); factory.setCommonHeaders(h1);
QVERIFY(factory.headers().contains(name1)); QVERIFY(factory.commonHeaders().contains(name1));
QCOMPARE(factory.headers().combinedValue(name1), value1); QCOMPARE(factory.commonHeaders().combinedValue(name1), value1);
QCOMPARE(factory.headers().size(), 1); QCOMPARE(factory.commonHeaders().size(), 1);
QVERIFY(factory.headers().values("nonexistent").isEmpty()); QVERIFY(factory.commonHeaders().values("nonexistent").isEmpty());
QNetworkRequest request = factory.createRequest(); QNetworkRequest request = factory.createRequest();
QVERIFY(request.hasRawHeader(name1)); QVERIFY(request.hasRawHeader(name1));
QCOMPARE(request.rawHeader(name1), value1); QCOMPARE(request.rawHeader(name1), value1);
// Check that empty header does not match // Check that empty header does not match
QVERIFY(!factory.headers().contains(""_ba)); QVERIFY(!factory.commonHeaders().contains(""_ba));
QVERIFY(factory.headers().values(""_ba).isEmpty()); QVERIFY(factory.commonHeaders().values(""_ba).isEmpty());
// Clear headers // Clear headers
factory.clearHeaders(); factory.clearCommonHeaders();
QVERIFY(factory.headers().isEmpty()); QVERIFY(factory.commonHeaders().isEmpty());
request = factory.createRequest(); request = factory.createRequest();
QVERIFY(!request.hasRawHeader(name1)); QVERIFY(!request.hasRawHeader(name1));
@ -218,12 +218,13 @@ void tst_QNetworkRequestFactory::headers()
h1.clear(); h1.clear();
h1.append(name1, value1); h1.append(name1, value1);
h1.append(name2, value2); h1.append(name2, value2);
factory.setHeaders(h1);
QVERIFY(factory.headers().contains(name1)); factory.setCommonHeaders(h1);
QVERIFY(factory.headers().contains(name2)); QVERIFY(factory.commonHeaders().contains(name1));
QCOMPARE(factory.headers().combinedValue(name1), value1); QVERIFY(factory.commonHeaders().contains(name2));
QCOMPARE(factory.headers().combinedValue(name2), value2); QCOMPARE(factory.commonHeaders().combinedValue(name1), value1);
QCOMPARE(factory.headers().size(), 2); QCOMPARE(factory.commonHeaders().combinedValue(name2), value2);
QCOMPARE(factory.commonHeaders().size(), 2);
request = factory.createRequest(); request = factory.createRequest();
QVERIFY(request.hasRawHeader(name1)); QVERIFY(request.hasRawHeader(name1));
QVERIFY(request.hasRawHeader(name2)); QVERIFY(request.hasRawHeader(name2));
@ -234,9 +235,9 @@ void tst_QNetworkRequestFactory::headers()
h1.append(name1, value1); h1.append(name1, value1);
h1.append(name1, value2); h1.append(name1, value2);
h1.append(name1, value3); h1.append(name1, value3);
factory.setHeaders(h1); factory.setCommonHeaders(h1);
QVERIFY(factory.headers().contains(name1)); QVERIFY(factory.commonHeaders().contains(name1));
QCOMPARE(factory.headers().combinedValue(name1), value1 + ',' + value2 + ',' + value3); QCOMPARE(factory.commonHeaders().combinedValue(name1), value1 + ',' + value2 + ',' + value3);
request = factory.createRequest(); 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);
@ -271,7 +272,7 @@ void tst_QNetworkRequestFactory::bearerToken()
const auto value = "headervalue"_ba; const auto value = "headervalue"_ba;
QHttpHeaders h1; QHttpHeaders h1;
h1.append(authHeader, value); h1.append(authHeader, value);
factory.setHeaders(h1); factory.setCommonHeaders(h1);
request = factory.createRequest(); 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