Refactor/Cleanup NetworkRequest and Related Code (#4633)

Cleanup unused code (Twitch v5)
Add json methods that simplify sending JSON. This also sets the Accepts header, since here, when JSON is sent, only JSON is accepted as a response (this is only done in Helix).
Clarify helix request creations
Cleaned some clang-tidy suggestions in Network{Request,Private}
This commit is contained in:
nerix 2023-05-16 17:28:20 +02:00 committed by GitHub
parent 4fa2cc26c9
commit ce47d27d41
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 184 additions and 170 deletions

View file

@ -72,12 +72,12 @@ void writeToCache(const std::shared_ptr<NetworkData> &data,
} }
} }
void loadUncached(const std::shared_ptr<NetworkData> &data) void loadUncached(std::shared_ptr<NetworkData> &&data)
{ {
DebugCount::increase("http request started"); DebugCount::increase("http request started");
NetworkRequester requester; NetworkRequester requester;
NetworkWorker *worker = new NetworkWorker; auto *worker = new NetworkWorker;
worker->moveToThread(&NetworkManager::workerThread); worker->moveToThread(&NetworkManager::workerThread);
@ -89,7 +89,7 @@ void loadUncached(const std::shared_ptr<NetworkData> &data)
data->timer_->start(data->timeoutMS_); data->timer_->start(data->timeoutMS_);
} }
auto reply = [&]() -> QNetworkReply * { auto *reply = [&]() -> QNetworkReply * {
switch (data->requestType_) switch (data->requestType_)
{ {
case NetworkRequestType::Get: case NetworkRequestType::Get:
@ -245,12 +245,16 @@ void loadUncached(const std::shared_ptr<NetworkData> &data)
if (data->onSuccess_) if (data->onSuccess_)
{ {
if (data->executeConcurrently_) if (data->executeConcurrently_)
{
QtConcurrent::run([onSuccess = std::move(data->onSuccess_), QtConcurrent::run([onSuccess = std::move(data->onSuccess_),
result = std::move(result)] { result = std::move(result)] {
onSuccess(result); onSuccess(result);
}); });
}
else else
{
data->onSuccess_(result); data->onSuccess_(result);
}
} }
// log("finished {}", data->request_.url().toString()); // log("finished {}", data->request_.url().toString());
@ -276,11 +280,15 @@ void loadUncached(const std::shared_ptr<NetworkData> &data)
if (data->finally_) if (data->finally_)
{ {
if (data->executeConcurrently_) if (data->executeConcurrently_)
{
QtConcurrent::run([finally = std::move(data->finally_)] { QtConcurrent::run([finally = std::move(data->finally_)] {
finally(); finally();
}); });
}
else else
{
data->finally_(); data->finally_();
}
} }
}; };
@ -316,87 +324,87 @@ void loadUncached(const std::shared_ptr<NetworkData> &data)
} }
// First tried to load cached, then uncached. // First tried to load cached, then uncached.
void loadCached(const std::shared_ptr<NetworkData> &data) void loadCached(std::shared_ptr<NetworkData> &&data)
{ {
QFile cachedFile(getPaths()->cacheDirectory() + "/" + data->getHash()); QFile cachedFile(getPaths()->cacheDirectory() + "/" + data->getHash());
if (!cachedFile.exists() || !cachedFile.open(QIODevice::ReadOnly)) if (!cachedFile.exists() || !cachedFile.open(QIODevice::ReadOnly))
{ {
// File didn't exist OR File could not be opened // File didn't exist OR File could not be opened
loadUncached(data); loadUncached(std::move(data));
return; return;
} }
else
{
// XXX: check if bytes is empty?
QByteArray bytes = cachedFile.readAll();
NetworkResult result(bytes, 200);
qCDebug(chatterinoHTTP) // XXX: check if bytes is empty?
<< QString("%1 [CACHED] 200 %2") QByteArray bytes = cachedFile.readAll();
.arg(networkRequestTypes.at(int(data->requestType_)), NetworkResult result(bytes, 200);
data->request_.url().toString());
if (data->onSuccess_) qCDebug(chatterinoHTTP)
<< QString("%1 [CACHED] 200 %2")
.arg(networkRequestTypes.at(int(data->requestType_)),
data->request_.url().toString());
if (data->onSuccess_)
{
if (data->executeConcurrently_ || isGuiThread())
{ {
if (data->executeConcurrently_ || isGuiThread()) // XXX: If outcome is Failure, we should invalidate the cache file
// somehow/somewhere
/*auto outcome =*/
if (data->hasCaller_ && !data->caller_.get())
{ {
// XXX: If outcome is Failure, we should invalidate the cache file return;
// somehow/somewhere }
/*auto outcome =*/ data->onSuccess_(result);
}
else
{
postToThread([data, result]() {
if (data->hasCaller_ && !data->caller_.get()) if (data->hasCaller_ && !data->caller_.get())
{ {
return; return;
} }
data->onSuccess_(result); data->onSuccess_(result);
} });
else
{
postToThread([data, result]() {
if (data->hasCaller_ && !data->caller_.get())
{
return;
}
data->onSuccess_(result);
});
}
} }
}
if (data->finally_) if (data->finally_)
{
if (data->executeConcurrently_ || isGuiThread())
{ {
if (data->executeConcurrently_ || isGuiThread()) if (data->hasCaller_ && !data->caller_.get())
{ {
return;
}
data->finally_();
}
else
{
postToThread([data]() {
if (data->hasCaller_ && !data->caller_.get()) if (data->hasCaller_ && !data->caller_.get())
{ {
return; return;
} }
data->finally_(); data->finally_();
} });
else
{
postToThread([data]() {
if (data->hasCaller_ && !data->caller_.get())
{
return;
}
data->finally_();
});
}
} }
} }
} }
void load(const std::shared_ptr<NetworkData> &data) void load(std::shared_ptr<NetworkData> &&data)
{ {
if (data->cache_) if (data->cache_)
{ {
QtConcurrent::run(loadCached, data); QtConcurrent::run([data = std::move(data)]() mutable {
loadCached(std::move(data));
});
} }
else else
{ {
loadUncached(data); loadUncached(std::move(data));
} }
} }

View file

@ -68,6 +68,6 @@ private:
QString hash_; QString hash_;
}; };
void load(const std::shared_ptr<NetworkData> &data); void load(std::shared_ptr<NetworkData> &&data);
} // namespace chatterino } // namespace chatterino

View file

@ -1,14 +1,8 @@
#include "common/NetworkRequest.hpp" #include "common/NetworkRequest.hpp"
#include "common/NetworkPrivate.hpp" #include "common/NetworkPrivate.hpp"
#include "common/Outcome.hpp"
#include "common/QLogging.hpp" #include "common/QLogging.hpp"
#include "common/Version.hpp" #include "common/Version.hpp"
#include "debug/AssertInGuiThread.hpp"
#include "providers/twitch/TwitchCommon.hpp"
#include "singletons/Paths.hpp"
#include "util/DebugCount.hpp"
#include "util/PostToThread.hpp"
#include <QDebug> #include <QDebug>
#include <QFile> #include <QFile>
@ -28,7 +22,7 @@ NetworkRequest::NetworkRequest(const std::string &url,
this->initializeDefaultValues(); this->initializeDefaultValues();
} }
NetworkRequest::NetworkRequest(QUrl url, NetworkRequestType requestType) NetworkRequest::NetworkRequest(const QUrl &url, NetworkRequestType requestType)
: data(new NetworkData) : data(new NetworkData)
{ {
this->data->request_.setUrl(url); this->data->request_.setUrl(url);
@ -37,10 +31,7 @@ NetworkRequest::NetworkRequest(QUrl url, NetworkRequestType requestType)
this->initializeDefaultValues(); this->initializeDefaultValues();
} }
NetworkRequest::~NetworkRequest() NetworkRequest::~NetworkRequest() = default;
{
//assert(!this->data || this->executed_);
}
NetworkRequest NetworkRequest::type(NetworkRequestType newRequestType) && NetworkRequest NetworkRequest::type(NetworkRequestType newRequestType) &&
{ {
@ -63,25 +54,25 @@ NetworkRequest NetworkRequest::caller(const QObject *caller) &&
NetworkRequest NetworkRequest::onReplyCreated(NetworkReplyCreatedCallback cb) && NetworkRequest NetworkRequest::onReplyCreated(NetworkReplyCreatedCallback cb) &&
{ {
this->data->onReplyCreated_ = cb; this->data->onReplyCreated_ = std::move(cb);
return std::move(*this); return std::move(*this);
} }
NetworkRequest NetworkRequest::onError(NetworkErrorCallback cb) && NetworkRequest NetworkRequest::onError(NetworkErrorCallback cb) &&
{ {
this->data->onError_ = cb; this->data->onError_ = std::move(cb);
return std::move(*this); return std::move(*this);
} }
NetworkRequest NetworkRequest::onSuccess(NetworkSuccessCallback cb) && NetworkRequest NetworkRequest::onSuccess(NetworkSuccessCallback cb) &&
{ {
this->data->onSuccess_ = cb; this->data->onSuccess_ = std::move(cb);
return std::move(*this); return std::move(*this);
} }
NetworkRequest NetworkRequest::finally(NetworkFinallyCallback cb) && NetworkRequest NetworkRequest::finally(NetworkFinallyCallback cb) &&
{ {
this->data->finally_ = cb; this->data->finally_ = std::move(cb);
return std::move(*this); return std::move(*this);
} }
@ -106,6 +97,13 @@ NetworkRequest NetworkRequest::header(const char *headerName,
return std::move(*this); return std::move(*this);
} }
NetworkRequest NetworkRequest::header(QNetworkRequest::KnownHeaders header,
const QVariant &value) &&
{
this->data->request_.setHeader(header, value);
return std::move(*this);
}
NetworkRequest NetworkRequest::headerList( NetworkRequest NetworkRequest::headerList(
const std::vector<std::pair<QByteArray, QByteArray>> &headers) && const std::vector<std::pair<QByteArray, QByteArray>> &headers) &&
{ {
@ -129,20 +127,6 @@ NetworkRequest NetworkRequest::concurrent() &&
return std::move(*this); return std::move(*this);
} }
NetworkRequest NetworkRequest::authorizeTwitchV5(const QString &clientID,
const QString &oauthToken) &&
{
// TODO: make two overloads, with and without oauth token
auto tmp = std::move(*this)
.header("Client-ID", clientID)
.header("Accept", "application/vnd.twitchtv.v5+json");
if (!oauthToken.isEmpty())
return std::move(tmp).header("Authorization", "OAuth " + oauthToken);
else
return tmp;
}
NetworkRequest NetworkRequest::multiPart(QHttpMultiPart *payload) && NetworkRequest NetworkRequest::multiPart(QHttpMultiPart *payload) &&
{ {
payload->setParent(this->data->lifetimeManager_); payload->setParent(this->data->lifetimeManager_);
@ -207,10 +191,28 @@ void NetworkRequest::initializeDefaultValues()
this->data->request_.setRawHeader("User-Agent", userAgent); this->data->request_.setRawHeader("User-Agent", userAgent);
} }
// Helper creator functions NetworkRequest NetworkRequest::json(const QJsonArray &root) &&
NetworkRequest NetworkRequest::twitchRequest(QUrl url)
{ {
return NetworkRequest(url).authorizeTwitchV5(getDefaultClientID()); return std::move(*this).json(QJsonDocument(root));
}
NetworkRequest NetworkRequest::json(const QJsonObject &root) &&
{
return std::move(*this).json(QJsonDocument(root));
}
NetworkRequest NetworkRequest::json(const QJsonDocument &document) &&
{
return std::move(*this).json(document.toJson(QJsonDocument::Compact));
}
NetworkRequest NetworkRequest::json(const QByteArray &payload) &&
{
return std::move(*this)
.payload(payload)
.header(QNetworkRequest::ContentTypeHeader, "application/json")
.header(QNetworkRequest::ContentLengthHeader, payload.length())
.header("Accept", "application/json");
} }
} // namespace chatterino } // namespace chatterino

View file

@ -6,6 +6,10 @@
#include <memory> #include <memory>
class QJsonArray;
class QJsonObject;
class QJsonDocument;
namespace chatterino { namespace chatterino {
struct NetworkData; struct NetworkData;
@ -24,8 +28,8 @@ public:
explicit NetworkRequest( explicit NetworkRequest(
const std::string &url, const std::string &url,
NetworkRequestType requestType = NetworkRequestType::Get); NetworkRequestType requestType = NetworkRequestType::Get);
explicit NetworkRequest( explicit NetworkRequest(const QUrl &url, NetworkRequestType requestType =
QUrl url, NetworkRequestType requestType = NetworkRequestType::Get); NetworkRequestType::Get);
// Enable move // Enable move
NetworkRequest(NetworkRequest &&other) = default; NetworkRequest(NetworkRequest &&other) = default;
@ -54,23 +58,25 @@ public:
NetworkRequest header(const char *headerName, const char *value) &&; NetworkRequest header(const char *headerName, const char *value) &&;
NetworkRequest header(const char *headerName, const QByteArray &value) &&; NetworkRequest header(const char *headerName, const QByteArray &value) &&;
NetworkRequest header(const char *headerName, const QString &value) &&; NetworkRequest header(const char *headerName, const QString &value) &&;
NetworkRequest header(QNetworkRequest::KnownHeaders header,
const QVariant &value) &&;
NetworkRequest headerList( NetworkRequest headerList(
const std::vector<std::pair<QByteArray, QByteArray>> &headers) &&; const std::vector<std::pair<QByteArray, QByteArray>> &headers) &&;
NetworkRequest timeout(int ms) &&; NetworkRequest timeout(int ms) &&;
NetworkRequest concurrent() &&; NetworkRequest concurrent() &&;
NetworkRequest authorizeTwitchV5(const QString &clientID,
const QString &oauthToken = QString()) &&;
NetworkRequest multiPart(QHttpMultiPart *payload) &&; NetworkRequest multiPart(QHttpMultiPart *payload) &&;
/** /**
* This will change `RedirectPolicyAttribute`. * This will change `RedirectPolicyAttribute`.
* `QNetworkRequest`'s defaults are used by default (Qt 5: no-follow, Qt 6: follow). * `QNetworkRequest`'s defaults are used by default (Qt 5: no-follow, Qt 6: follow).
*/ */
NetworkRequest followRedirects(bool on) &&; NetworkRequest followRedirects(bool on) &&;
NetworkRequest json(const QJsonObject &root) &&;
NetworkRequest json(const QJsonArray &root) &&;
NetworkRequest json(const QJsonDocument &document) &&;
NetworkRequest json(const QByteArray &payload) &&;
void execute(); void execute();
static NetworkRequest twitchRequest(QUrl url);
private: private:
void initializeDefaultValues(); void initializeDefaultValues();
}; };

View file

@ -52,7 +52,7 @@ void Helix::fetchUsers(QStringList userIds, QStringList userLogins,
} }
// TODO: set on success and on error // TODO: set on success and on error
this->makeRequest("users", urlQuery) this->makeGet("users", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -142,7 +142,7 @@ void Helix::fetchUsersFollows(
} }
// TODO: set on success and on error // TODO: set on success and on error
this->makeRequest("users/follows", urlQuery) this->makeGet("users/follows", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
if (root.empty()) if (root.empty())
@ -186,7 +186,7 @@ void Helix::fetchStreams(
} }
// TODO: set on success and on error // TODO: set on success and on error
this->makeRequest("streams", urlQuery) this->makeGet("streams", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -279,7 +279,7 @@ void Helix::fetchGames(QStringList gameIds, QStringList gameNames,
} }
// TODO: set on success and on error // TODO: set on success and on error
this->makeRequest("games", urlQuery) this->makeGet("games", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -315,7 +315,7 @@ void Helix::searchGames(QString gameName,
QUrlQuery urlQuery; QUrlQuery urlQuery;
urlQuery.addQueryItem("query", gameName); urlQuery.addQueryItem("query", gameName);
this->makeRequest("search/categories", urlQuery) this->makeGet("search/categories", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -372,8 +372,7 @@ void Helix::createClip(QString channelId,
QUrlQuery urlQuery; QUrlQuery urlQuery;
urlQuery.addQueryItem("broadcaster_id", channelId); urlQuery.addQueryItem("broadcaster_id", channelId);
this->makeRequest("clips", urlQuery) this->makePost("clips", urlQuery)
.type(NetworkRequestType::Post)
.header("Content-Type", "application/json") .header("Content-Type", "application/json")
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
@ -425,7 +424,7 @@ void Helix::getChannel(QString broadcasterId,
QUrlQuery urlQuery; QUrlQuery urlQuery;
urlQuery.addQueryItem("broadcaster_id", broadcasterId); urlQuery.addQueryItem("broadcaster_id", broadcasterId);
this->makeRequest("channels", urlQuery) this->makeGet("channels", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -460,10 +459,8 @@ void Helix::createStreamMarker(
} }
payload.insert("user_id", QJsonValue(broadcasterId)); payload.insert("user_id", QJsonValue(broadcasterId));
this->makeRequest("streams/markers", QUrlQuery()) this->makePost("streams/markers", QUrlQuery())
.type(NetworkRequestType::Post) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -515,7 +512,7 @@ void Helix::loadBlocks(QString userId,
urlQuery.addQueryItem("broadcaster_id", userId); urlQuery.addQueryItem("broadcaster_id", userId);
urlQuery.addQueryItem("first", "100"); urlQuery.addQueryItem("first", "100");
this->makeRequest("users/blocks", urlQuery) this->makeGet("users/blocks", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -551,8 +548,7 @@ void Helix::blockUser(QString targetUserId,
QUrlQuery urlQuery; QUrlQuery urlQuery;
urlQuery.addQueryItem("target_user_id", targetUserId); urlQuery.addQueryItem("target_user_id", targetUserId);
this->makeRequest("users/blocks", urlQuery) this->makePut("users/blocks", urlQuery)
.type(NetworkRequestType::Put)
.onSuccess([successCallback](auto /*result*/) -> Outcome { .onSuccess([successCallback](auto /*result*/) -> Outcome {
successCallback(); successCallback();
return Success; return Success;
@ -571,8 +567,7 @@ void Helix::unblockUser(QString targetUserId,
QUrlQuery urlQuery; QUrlQuery urlQuery;
urlQuery.addQueryItem("target_user_id", targetUserId); urlQuery.addQueryItem("target_user_id", targetUserId);
this->makeRequest("users/blocks", urlQuery) this->makeDelete("users/blocks", urlQuery)
.type(NetworkRequestType::Delete)
.onSuccess([successCallback](auto /*result*/) -> Outcome { .onSuccess([successCallback](auto /*result*/) -> Outcome {
successCallback(); successCallback();
return Success; return Success;
@ -590,7 +585,6 @@ void Helix::updateChannel(QString broadcasterId, QString gameId,
HelixFailureCallback failureCallback) HelixFailureCallback failureCallback)
{ {
QUrlQuery urlQuery; QUrlQuery urlQuery;
auto data = QJsonDocument();
auto obj = QJsonObject(); auto obj = QJsonObject();
if (!gameId.isEmpty()) if (!gameId.isEmpty())
{ {
@ -611,12 +605,9 @@ void Helix::updateChannel(QString broadcasterId, QString gameId,
return; return;
} }
data.setObject(obj);
urlQuery.addQueryItem("broadcaster_id", broadcasterId); urlQuery.addQueryItem("broadcaster_id", broadcasterId);
this->makeRequest("channels", urlQuery) this->makePatch("channels", urlQuery)
.type(NetworkRequestType::Patch) .json(obj)
.header("Content-Type", "application/json")
.payload(data.toJson())
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
successCallback(result); successCallback(result);
return Success; return Success;
@ -638,10 +629,8 @@ void Helix::manageAutoModMessages(
payload.insert("msg_id", msgID); payload.insert("msg_id", msgID);
payload.insert("action", action); payload.insert("action", action);
this->makeRequest("moderation/automod/message", QUrlQuery()) this->makePost("moderation/automod/message", QUrlQuery())
.type(NetworkRequestType::Post) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
successCallback(); successCallback();
return Success; return Success;
@ -697,7 +686,7 @@ void Helix::getCheermotes(
urlQuery.addQueryItem("broadcaster_id", broadcasterId); urlQuery.addQueryItem("broadcaster_id", broadcasterId);
this->makeRequest("bits/cheermotes", urlQuery) this->makeGet("bits/cheermotes", urlQuery)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto root = result.parseJson(); auto root = result.parseJson();
auto data = root.value("data"); auto data = root.value("data");
@ -735,7 +724,7 @@ void Helix::getEmoteSetData(QString emoteSetId,
urlQuery.addQueryItem("emote_set_id", emoteSetId); urlQuery.addQueryItem("emote_set_id", emoteSetId);
this->makeRequest("chat/emotes/set", urlQuery) this->makeGet("chat/emotes/set", urlQuery)
.onSuccess([successCallback, failureCallback, .onSuccess([successCallback, failureCallback,
emoteSetId](auto result) -> Outcome { emoteSetId](auto result) -> Outcome {
QJsonObject root = result.parseJson(); QJsonObject root = result.parseJson();
@ -767,7 +756,7 @@ void Helix::getChannelEmotes(
QUrlQuery urlQuery; QUrlQuery urlQuery;
urlQuery.addQueryItem("broadcaster_id", broadcasterId); urlQuery.addQueryItem("broadcaster_id", broadcasterId);
this->makeRequest("chat/emotes", urlQuery) this->makeGet("chat/emotes", urlQuery)
.onSuccess([successCallback, .onSuccess([successCallback,
failureCallback](NetworkResult result) -> Outcome { failureCallback](NetworkResult result) -> Outcome {
QJsonObject root = result.parseJson(); QJsonObject root = result.parseJson();
@ -807,10 +796,8 @@ void Helix::updateUserChatColor(
payload.insert("user_id", QJsonValue(userID)); payload.insert("user_id", QJsonValue(userID));
payload.insert("color", QJsonValue(color)); payload.insert("color", QJsonValue(color));
this->makeRequest("chat/color", QUrlQuery()) this->makePut("chat/color", QUrlQuery())
.type(NetworkRequestType::Put) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto obj = result.parseJson(); auto obj = result.parseJson();
if (result.status() != 204) if (result.status() != 204)
@ -887,8 +874,7 @@ void Helix::deleteChatMessages(
urlQuery.addQueryItem("message_id", messageID); urlQuery.addQueryItem("message_id", messageID);
} }
this->makeRequest("moderation/chat", urlQuery) this->makeDelete("moderation/chat", urlQuery)
.type(NetworkRequestType::Delete)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -966,8 +952,7 @@ void Helix::addChannelModerator(
urlQuery.addQueryItem("broadcaster_id", broadcasterID); urlQuery.addQueryItem("broadcaster_id", broadcasterID);
urlQuery.addQueryItem("user_id", userID); urlQuery.addQueryItem("user_id", userID);
this->makeRequest("moderation/moderators", urlQuery) this->makePost("moderation/moderators", urlQuery)
.type(NetworkRequestType::Post)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -1055,8 +1040,7 @@ void Helix::removeChannelModerator(
urlQuery.addQueryItem("broadcaster_id", broadcasterID); urlQuery.addQueryItem("broadcaster_id", broadcasterID);
urlQuery.addQueryItem("user_id", userID); urlQuery.addQueryItem("user_id", userID);
this->makeRequest("moderation/moderators", urlQuery) this->makeDelete("moderation/moderators", urlQuery)
.type(NetworkRequestType::Delete)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -1142,10 +1126,8 @@ void Helix::sendChatAnnouncement(
std::string{magic_enum::enum_name<HelixAnnouncementColor>(color)}; std::string{magic_enum::enum_name<HelixAnnouncementColor>(color)};
body.insert("color", QString::fromStdString(colorStr).toLower()); body.insert("color", QString::fromStdString(colorStr).toLower());
this->makeRequest("chat/announcements", urlQuery) this->makePost("chat/announcements", urlQuery)
.type(NetworkRequestType::Post) .json(body)
.header("Content-Type", "application/json")
.payload(QJsonDocument(body).toJson(QJsonDocument::Compact))
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -1214,8 +1196,7 @@ void Helix::addChannelVIP(
urlQuery.addQueryItem("broadcaster_id", broadcasterID); urlQuery.addQueryItem("broadcaster_id", broadcasterID);
urlQuery.addQueryItem("user_id", userID); urlQuery.addQueryItem("user_id", userID);
this->makeRequest("channels/vips", urlQuery) this->makePost("channels/vips", urlQuery)
.type(NetworkRequestType::Post)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -1293,8 +1274,7 @@ void Helix::removeChannelVIP(
urlQuery.addQueryItem("broadcaster_id", broadcasterID); urlQuery.addQueryItem("broadcaster_id", broadcasterID);
urlQuery.addQueryItem("user_id", userID); urlQuery.addQueryItem("user_id", userID);
this->makeRequest("channels/vips", urlQuery) this->makeDelete("channels/vips", urlQuery)
.type(NetworkRequestType::Delete)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -1383,8 +1363,7 @@ void Helix::unbanUser(
urlQuery.addQueryItem("moderator_id", moderatorID); urlQuery.addQueryItem("moderator_id", moderatorID);
urlQuery.addQueryItem("user_id", userID); urlQuery.addQueryItem("user_id", userID);
this->makeRequest("moderation/bans", urlQuery) this->makeDelete("moderation/bans", urlQuery)
.type(NetworkRequestType::Delete)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -1489,8 +1468,7 @@ void Helix::startRaid(
urlQuery.addQueryItem("from_broadcaster_id", fromBroadcasterID); urlQuery.addQueryItem("from_broadcaster_id", fromBroadcasterID);
urlQuery.addQueryItem("to_broadcaster_id", toBroadcasterID); urlQuery.addQueryItem("to_broadcaster_id", toBroadcasterID);
this->makeRequest("raids", urlQuery) this->makePost("raids", urlQuery)
.type(NetworkRequestType::Post)
.onSuccess( .onSuccess(
[successCallback, failureCallback](auto /*result*/) -> Outcome { [successCallback, failureCallback](auto /*result*/) -> Outcome {
successCallback(); successCallback();
@ -1570,8 +1548,7 @@ void Helix::cancelRaid(
urlQuery.addQueryItem("broadcaster_id", broadcasterID); urlQuery.addQueryItem("broadcaster_id", broadcasterID);
this->makeRequest("raids", urlQuery) this->makeDelete("raids", urlQuery)
.type(NetworkRequestType::Delete)
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -1731,10 +1708,8 @@ void Helix::updateChatSettings(
urlQuery.addQueryItem("broadcaster_id", broadcasterID); urlQuery.addQueryItem("broadcaster_id", broadcasterID);
urlQuery.addQueryItem("moderator_id", moderatorID); urlQuery.addQueryItem("moderator_id", moderatorID);
this->makeRequest("chat/settings", urlQuery) this->makePatch("chat/settings", urlQuery)
.type(NetworkRequestType::Patch) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
{ {
@ -1857,7 +1832,7 @@ void Helix::fetchChatters(
urlQuery.addQueryItem("after", after); urlQuery.addQueryItem("after", after);
} }
this->makeRequest("chat/chatters", urlQuery) this->makeGet("chat/chatters", urlQuery)
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
{ {
@ -1966,7 +1941,7 @@ void Helix::fetchModerators(
urlQuery.addQueryItem("after", after); urlQuery.addQueryItem("after", after);
} }
this->makeRequest("moderation/moderators", urlQuery) this->makeGet("moderation/moderators", urlQuery)
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
{ {
@ -2051,10 +2026,8 @@ void Helix::banUser(QString broadcasterID, QString moderatorID, QString userID,
payload["data"] = data; payload["data"] = data;
} }
this->makeRequest("moderation/bans", urlQuery) this->makePost("moderation/bans", urlQuery)
.type(NetworkRequestType::Post) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
{ {
@ -2150,10 +2123,8 @@ void Helix::sendWhisper(
QJsonObject payload; QJsonObject payload;
payload["message"] = message; payload["message"] = message;
this->makeRequest("whispers", urlQuery) this->makePost("whispers", urlQuery)
.type(NetworkRequestType::Post) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 204) if (result.status() != 204)
{ {
@ -2295,8 +2266,7 @@ void Helix::getChannelVIPs(
// as the mod list can go over 100 (I assume, I see no limit) // as the mod list can go over 100 (I assume, I see no limit)
urlQuery.addQueryItem("first", "100"); urlQuery.addQueryItem("first", "100");
this->makeRequest("channels/vips", urlQuery) this->makeGet("channels/vips", urlQuery)
.type(NetworkRequestType::Get)
.header("Content-Type", "application/json") .header("Content-Type", "application/json")
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
@ -2383,10 +2353,8 @@ void Helix::startCommercial(
payload.insert("broadcaster_id", QJsonValue(broadcasterID)); payload.insert("broadcaster_id", QJsonValue(broadcasterID));
payload.insert("length", QJsonValue(length)); payload.insert("length", QJsonValue(length));
this->makeRequest("channels/commercial", QUrlQuery()) this->makePost("channels/commercial", QUrlQuery())
.type(NetworkRequestType::Post) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback, failureCallback](auto result) -> Outcome { .onSuccess([successCallback, failureCallback](auto result) -> Outcome {
auto obj = result.parseJson(); auto obj = result.parseJson();
if (obj.isEmpty()) if (obj.isEmpty())
@ -2476,7 +2444,7 @@ void Helix::getGlobalBadges(
{ {
using Error = HelixGetGlobalBadgesError; using Error = HelixGetGlobalBadgesError;
this->makeRequest("chat/badges/global", QUrlQuery()) this->makeGet("chat/badges/global", QUrlQuery())
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
{ {
@ -2523,7 +2491,7 @@ void Helix::getChannelBadges(
QUrlQuery urlQuery; QUrlQuery urlQuery;
urlQuery.addQueryItem("broadcaster_id", broadcasterID); urlQuery.addQueryItem("broadcaster_id", broadcasterID);
this->makeRequest("chat/badges", urlQuery) this->makeGet("chat/badges", urlQuery)
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
{ {
@ -2575,10 +2543,8 @@ void Helix::updateShieldMode(
QJsonObject payload; QJsonObject payload;
payload["is_active"] = isActive; payload["is_active"] = isActive;
this->makeRequest("moderation/shield_mode", urlQuery) this->makePut("moderation/shield_mode", urlQuery)
.type(NetworkRequestType::Put) .json(payload)
.header("Content-Type", "application/json")
.payload(QJsonDocument(payload).toJson(QJsonDocument::Compact))
.onSuccess([successCallback](auto result) -> Outcome { .onSuccess([successCallback](auto result) -> Outcome {
if (result.status() != 200) if (result.status() != 200)
{ {
@ -2631,7 +2597,8 @@ void Helix::updateShieldMode(
.execute(); .execute();
} }
NetworkRequest Helix::makeRequest(QString url, QUrlQuery urlQuery) NetworkRequest Helix::makeRequest(const QString &url, const QUrlQuery &urlQuery,
NetworkRequestType type)
{ {
assert(!url.startsWith("/")); assert(!url.startsWith("/"));
@ -2655,13 +2622,38 @@ NetworkRequest Helix::makeRequest(QString url, QUrlQuery urlQuery)
fullUrl.setQuery(urlQuery); fullUrl.setQuery(urlQuery);
return NetworkRequest(fullUrl) return NetworkRequest(fullUrl, type)
.timeout(5 * 1000) .timeout(5 * 1000)
.header("Accept", "application/json") .header("Accept", "application/json")
.header("Client-ID", this->clientId) .header("Client-ID", this->clientId)
.header("Authorization", "Bearer " + this->oauthToken); .header("Authorization", "Bearer " + this->oauthToken);
} }
NetworkRequest Helix::makeGet(const QString &url, const QUrlQuery &urlQuery)
{
return this->makeRequest(url, urlQuery, NetworkRequestType::Get);
}
NetworkRequest Helix::makeDelete(const QString &url, const QUrlQuery &urlQuery)
{
return this->makeRequest(url, urlQuery, NetworkRequestType::Delete);
}
NetworkRequest Helix::makePost(const QString &url, const QUrlQuery &urlQuery)
{
return this->makeRequest(url, urlQuery, NetworkRequestType::Post);
}
NetworkRequest Helix::makePut(const QString &url, const QUrlQuery &urlQuery)
{
return this->makeRequest(url, urlQuery, NetworkRequestType::Put);
}
NetworkRequest Helix::makePatch(const QString &url, const QUrlQuery &urlQuery)
{
return this->makeRequest(url, urlQuery, NetworkRequestType::Patch);
}
void Helix::update(QString clientId, QString oauthToken) void Helix::update(QString clientId, QString oauthToken)
{ {
this->clientId = std::move(clientId); this->clientId = std::move(clientId);

View file

@ -1361,7 +1361,13 @@ protected:
FailureCallback<HelixGetModeratorsError, QString> failureCallback); FailureCallback<HelixGetModeratorsError, QString> failureCallback);
private: private:
NetworkRequest makeRequest(QString url, QUrlQuery urlQuery); NetworkRequest makeRequest(const QString &url, const QUrlQuery &urlQuery,
NetworkRequestType type);
NetworkRequest makeGet(const QString &url, const QUrlQuery &urlQuery);
NetworkRequest makeDelete(const QString &url, const QUrlQuery &urlQuery);
NetworkRequest makePost(const QString &url, const QUrlQuery &urlQuery);
NetworkRequest makePut(const QString &url, const QUrlQuery &urlQuery);
NetworkRequest makePatch(const QString &url, const QUrlQuery &urlQuery);
QString clientId; QString clientId;
QString oauthToken; QString oauthToken;