yuzu-emu
/
yuzu-mainline
Archived
1
0
Fork 0
Code
This repository has been archived on 2024-03-23. You can view files and clone it, but cannot push or open issues or pull requests.
yuzu-mainline/src/web_service/telemetry_json.cpp

131 lines
4.7 KiB
C++
Raw Normal View History

chore: make yuzu REUSE compliant [REUSE] is a specification that aims at making file copyright information consistent, so that it can be both human and machine readable. It basically requires that all files have a header containing copyright and licensing information. When this isn't possible, like when dealing with binary assets, generated files or embedded third-party dependencies, it is permitted to insert copyright information in the `.reuse/dep5` file. Oh, and it also requires that all the licenses used in the project are present in the `LICENSES` folder, that's why the diff is so huge. This can be done automatically with `reuse download --all`. The `reuse` tool also contains a handy subcommand that analyzes the project and tells whether or not the project is (still) compliant, `reuse lint`. Following REUSE has a few advantages over the current approach: - Copyright information is easy to access for users / downstream - Files like `dist/license.md` do not need to exist anymore, as `.reuse/dep5` is used instead - `reuse lint` makes it easy to ensure that copyright information of files like binary assets / images is always accurate and up to date To add copyright information of files that didn't have it I looked up who committed what and when, for each file. As yuzu contributors do not have to sign a CLA or similar I couldn't assume that copyright ownership was of the "yuzu Emulator Project", so I used the name and/or email of the commit author instead. [REUSE]: https://reuse.software Follow-up to 01cf05bc75b1e47beb08937439f3ed9339e7b254
2022-05-15 00:06:02 +00:00
// SPDX-FileCopyrightText: 2017 Citra Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
Port web_service from Citra
2018-09-16 18:05:51 +00:00
Replace externals with Conan (#3735) * Remove git submodules that will be loaded through conan * Move custom Find modules to their own folder * Use conan for downloading missing external dependencies * CI: Change the yuzu source folder user to the user that the containers run on * Attempt to remove dirty mingw build hack * Install conan on the msvc build * Only set release build type when using not using multi config generator * Re-add qt bundled to workaround an issue with conan qt not downloading prebuilt binaries * Add workaround for submodules that use legacy CMAKE variables * Re-add USE_BUNDLED_QT on the msvc build bot
2020-05-08 21:09:29 +00:00
#include <nlohmann/json.hpp>
Port web_service from Citra
2018-09-16 18:05:51 +00:00
#include "common/detached_tasks.h"
#include "web_service/telemetry_json.h"
#include "web_service/web_backend.h"
web_service: Move web_result.h into web_service This is the only place it's actively used. It's also more appropriate for web-related structures to be within the web service target. Especially given this one doesn't rely on anything in the common library.
2020-08-22 23:23:22 +00:00
#include "web_service/web_result.h"
Port web_service from Citra
2018-09-16 18:05:51 +00:00
namespace WebService {
common/telemetry: Migrate namespace into the Common namespace Migrates the Telemetry namespace into the Common namespace to make the code consistent with the rest of our common code.
2020-08-18 18:21:50 +00:00
namespace Telemetry = Common::Telemetry;
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
struct TelemetryJson::Impl {
web_service: Eliminate variable shadowing
2022-05-26 23:57:11 +00:00
Impl(std::string host_, std::string username_, std::string token_)
: host{std::move(host_)}, username{std::move(username_)}, token{std::move(token_)} {}
Address a bunch of review comments
2018-09-17 15:16:01 +00:00
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
nlohmann::json& TopSection() {
return sections[static_cast<u8>(Telemetry::FieldType::None)];
}
Port web_service from Citra
2018-09-16 18:05:51 +00:00
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
const nlohmann::json& TopSection() const {
return sections[static_cast<u8>(Telemetry::FieldType::None)];
}
template <class T>
void Serialize(Telemetry::FieldType type, const std::string& name, T value) {
sections[static_cast<u8>(type)][name] = value;
}
void SerializeSection(Telemetry::FieldType type, const std::string& name) {
TopSection()[name] = sections[static_cast<unsigned>(type)];
}
nlohmann::json output;
std::array<nlohmann::json, 7> sections;
std::string host;
std::string username;
std::string token;
};
TelemetryJson::TelemetryJson(std::string host, std::string username, std::string token)
: impl{std::make_unique<Impl>(std::move(host), std::move(username), std::move(token))} {}
TelemetryJson::~TelemetryJson() = default;
Port web_service from Citra
2018-09-16 18:05:51 +00:00
void TelemetryJson::Visit(const Telemetry::Field<bool>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<double>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<float>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<u8>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<u16>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<u32>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<u64>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<s8>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<s16>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<s32>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<s64>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<std::string>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<const char*>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), std::string(field.GetValue()));
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Visit(const Telemetry::Field<std::chrono::microseconds>& field) {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->Serialize(field.GetType(), field.GetName(), field.GetValue().count());
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
void TelemetryJson::Complete() {
telemetry_json: Use the PImpl idiom to avoid unnecessary dependency exposure Users of the web_service library shouldn't need to care about an external library like json.h. However, given it's exposed in our interface, this requires that other libraries publicly link in the JSON library. We can do better. By using the PImpl idiom, we can hide this dependency in the cpp file and remove the need to link that library in altogether.
2018-10-11 01:04:19 +00:00
impl->SerializeSection(Telemetry::FieldType::App, "App");
impl->SerializeSection(Telemetry::FieldType::Session, "Session");
impl->SerializeSection(Telemetry::FieldType::Performance, "Performance");
impl->SerializeSection(Telemetry::FieldType::UserConfig, "UserConfig");
impl->SerializeSection(Telemetry::FieldType::UserSystem, "UserSystem");
auto content = impl->TopSection().dump();
Port web_service from Citra
2018-09-16 18:05:51 +00:00
// Send the telemetry async but don't handle the errors since they were written to the log
compatdb: Use a seperate endpoint for testcase submission
2018-10-26 14:21:45 +00:00
Common::DetachedTasks::AddTask([host{impl->host}, content]() {
Client{host, "", ""}.PostJson("/telemetry", content, true);
});
}
bool TelemetryJson::SubmitTestcase() {
impl->SerializeSection(Telemetry::FieldType::App, "App");
impl->SerializeSection(Telemetry::FieldType::Session, "Session");
impl->SerializeSection(Telemetry::FieldType::UserFeedback, "UserFeedback");
impl->SerializeSection(Telemetry::FieldType::UserSystem, "UserSystem");
web_service/telemetry_json: Report USER_CONFIG
2020-01-21 19:38:36 +00:00
impl->SerializeSection(Telemetry::FieldType::UserConfig, "UserConfig");
compatdb: Use a seperate endpoint for testcase submission
2018-10-26 14:21:45 +00:00
auto content = impl->TopSection().dump();
Client client(impl->host, impl->username, impl->token);
auto value = client.PostJson("/gamedb/testcase", content, false);
web_service: Move web_result.h into web_service This is the only place it's actively used. It's also more appropriate for web-related structures to be within the web service target. Especially given this one doesn't rely on anything in the common library.
2020-08-22 23:23:22 +00:00
return value.result_code == WebResult::Code::Success;
Port web_service from Citra
2018-09-16 18:05:51 +00:00
}
} // namespace WebService