mirror of
https://github.com/Cockatrice/Cockatrice.git
synced 2026-09-21 00:55:09 -07:00
Compare commits
11 commits
8052676b29
...
a7f9b8ff37
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a7f9b8ff37 | ||
|
|
57117322e6 | ||
|
|
e960471c69 | ||
|
|
ad75153e0f | ||
|
|
b3b930587b | ||
|
|
21ca53962d | ||
|
|
d6dea73be5 | ||
|
|
ab72ba8132 | ||
|
|
310caa7dc0 | ||
|
|
5956dcab83 | ||
|
|
91519166f9 |
17 changed files with 1403 additions and 83 deletions
|
|
@ -58,33 +58,33 @@ signals:
|
|||
void themeChanged();
|
||||
|
||||
private:
|
||||
QSettings *settings;
|
||||
ShortcutsSettings *shortcutsSettings;
|
||||
CardDatabaseSettings *cardDatabaseSettings;
|
||||
ServersSettings *serversSettings;
|
||||
MessageSettings *messageSettings;
|
||||
GameFiltersSettings *gameFiltersSettings;
|
||||
LayoutsSettings *layoutsSettings;
|
||||
DownloadSettings *downloadSettings;
|
||||
RecentsSettings *recentsSettings;
|
||||
CardOverrideSettings *cardOverrideSettings;
|
||||
DebugSettings *debugSettings;
|
||||
CardCounterSettings *cardCounterSettings;
|
||||
TabsSettings *tabsSettings;
|
||||
SoundSettings *soundSettings;
|
||||
GameSettings *gameSettings;
|
||||
ChatSettings *chatSettings;
|
||||
CacheStorageSettings *cacheStorageSettings;
|
||||
UpdatesSettings *updatesSettings;
|
||||
PersonalSettings *personalSettings;
|
||||
CardsDisplaySettings *cardsDisplaySettings;
|
||||
InterfaceSettings *interfaceSettings;
|
||||
DeckEditorSettings *deckEditorSettings;
|
||||
PathsSettings *pathsSettings;
|
||||
VisualDeckStorageSettings *visualDeckStorageSettings;
|
||||
AppearanceSettings *appearanceSettings;
|
||||
NetworkSettings *networkSettings;
|
||||
CommanderBracketSettings *commanderBracketSettings;
|
||||
QSettings *settings = nullptr;
|
||||
ShortcutsSettings *shortcutsSettings = nullptr;
|
||||
CardDatabaseSettings *cardDatabaseSettings = nullptr;
|
||||
ServersSettings *serversSettings = nullptr;
|
||||
MessageSettings *messageSettings = nullptr;
|
||||
GameFiltersSettings *gameFiltersSettings = nullptr;
|
||||
LayoutsSettings *layoutsSettings = nullptr;
|
||||
DownloadSettings *downloadSettings = nullptr;
|
||||
RecentsSettings *recentsSettings = nullptr;
|
||||
CardOverrideSettings *cardOverrideSettings = nullptr;
|
||||
DebugSettings *debugSettings = nullptr;
|
||||
CardCounterSettings *cardCounterSettings = nullptr;
|
||||
TabsSettings *tabsSettings = nullptr;
|
||||
SoundSettings *soundSettings = nullptr;
|
||||
GameSettings *gameSettings = nullptr;
|
||||
ChatSettings *chatSettings = nullptr;
|
||||
CacheStorageSettings *cacheStorageSettings = nullptr;
|
||||
UpdatesSettings *updatesSettings = nullptr;
|
||||
PersonalSettings *personalSettings = nullptr;
|
||||
CardsDisplaySettings *cardsDisplaySettings = nullptr;
|
||||
InterfaceSettings *interfaceSettings = nullptr;
|
||||
DeckEditorSettings *deckEditorSettings = nullptr;
|
||||
PathsSettings *pathsSettings = nullptr;
|
||||
VisualDeckStorageSettings *visualDeckStorageSettings = nullptr;
|
||||
AppearanceSettings *appearanceSettings = nullptr;
|
||||
NetworkSettings *networkSettings = nullptr;
|
||||
CommanderBracketSettings *commanderBracketSettings = nullptr;
|
||||
|
||||
QString themeName;
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@
|
|||
#include <QDirIterator>
|
||||
#include <QFileInfo>
|
||||
#include <QMainWindow>
|
||||
#include <QMetaObject>
|
||||
#include <QMovie>
|
||||
#include <QNetworkRequest>
|
||||
#include <QPainter>
|
||||
|
|
@ -40,6 +41,7 @@ CardPictureLoader::CardPictureLoader() : QObject(nullptr)
|
|||
|
||||
qRegisterMetaType<ExactCard>();
|
||||
connect(worker, &CardPictureLoaderWorker::imageLoaded, this, &CardPictureLoader::imageLoaded);
|
||||
connect(worker, &CardPictureLoaderWorker::networkCacheCleared, this, &CardPictureLoader::networkCacheCleared);
|
||||
|
||||
statusBar = new CardPictureLoaderStatusBar(nullptr);
|
||||
QMainWindow *mainWindow = qobject_cast<QMainWindow *>(QApplication::activeWindow());
|
||||
|
|
@ -55,7 +57,18 @@ CardPictureLoader::CardPictureLoader() : QObject(nullptr)
|
|||
|
||||
CardPictureLoader::~CardPictureLoader()
|
||||
{
|
||||
worker->deleteLater();
|
||||
if (worker) {
|
||||
// Capture the thread first: shutdownThread() blocks until the worker has been freed by the
|
||||
// finished() -> deleteLater chain, after which the worker pointer must not be dereferenced.
|
||||
QThread *pictureLoaderThread = worker->workerThread();
|
||||
const bool stopped = worker->shutdownThread();
|
||||
worker = nullptr;
|
||||
// Deleting a QThread that is still running is undefined behaviour, so only free it once the
|
||||
// bounded wait in shutdownThread() confirmed that it stopped.
|
||||
if (stopped) {
|
||||
delete pictureLoaderThread;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void CardPictureLoader::getCardBackPixmap(QPixmap &pixmap, QSize size)
|
||||
|
|
@ -295,7 +308,17 @@ void CardPictureLoader::clearPixmapCache()
|
|||
|
||||
void CardPictureLoader::clearNetworkCache()
|
||||
{
|
||||
getInstance().worker->clearNetworkCache();
|
||||
// During teardown the worker is released before this singleton, so a queued clear may still
|
||||
// arrive with no worker left to run it.
|
||||
CardPictureLoaderWorker *worker = getInstance().worker;
|
||||
if (!worker) {
|
||||
return;
|
||||
}
|
||||
// The disk cache and redirect cache are owned by the worker thread, so the clear has to run
|
||||
// there. Invoke it asynchronously to keep the GUI responsive while the worker may be walking
|
||||
// the user's picture directories or recursively deleting the cache directory; callers that
|
||||
// need to know when it is done can listen for networkCacheCleared().
|
||||
QMetaObject::invokeMethod(worker, &CardPictureLoaderWorker::clearNetworkCache, Qt::QueuedConnection);
|
||||
}
|
||||
|
||||
void CardPictureLoader::cacheCardPixmaps(const QList<ExactCard> &cards)
|
||||
|
|
|
|||
|
|
@ -110,6 +110,9 @@ public:
|
|||
public slots:
|
||||
/**
|
||||
* @brief Clears the network disk cache of the worker.
|
||||
*
|
||||
* The clear runs on the worker thread, so this returns before it has completed; connect to
|
||||
* networkCacheCleared() to act once it is done.
|
||||
*/
|
||||
static void clearNetworkCache();
|
||||
|
||||
|
|
@ -122,6 +125,10 @@ public slots:
|
|||
void imageLoaded(const ExactCard &card, const QImage &image);
|
||||
void saveCardImageToLocalStorage(const ExactCard &card, const QPixmap &pixmap);
|
||||
|
||||
signals:
|
||||
/** @brief Emitted after the worker has finished clearing the network and redirect caches. */
|
||||
void networkCacheCleared();
|
||||
|
||||
private slots:
|
||||
/**
|
||||
* @brief Triggered when the user changes the picture download settings.
|
||||
|
|
|
|||
|
|
@ -16,15 +16,16 @@
|
|||
#include <utility>
|
||||
#include <version_string.h>
|
||||
|
||||
static constexpr int MAX_REQUESTS_PER_SEC = 10;
|
||||
static constexpr int MIN_HOST_QUOTA = 1; ///< Floor for the per-host request allowance
|
||||
static constexpr int MAX_REQUESTS_PER_SEC = DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT;
|
||||
static constexpr int MIN_HOST_QUOTA = DownloadSettings::MIN_HOST_REQUEST_LIMIT;
|
||||
static constexpr qint64 QUOTA_RECOVER_MS = 60000; ///< Idle time before a reduced quota starts recovering
|
||||
static constexpr int DISPATCH_INTERVAL_MS = 100; ///< Pacing between individual network requests
|
||||
static constexpr qint64 QUOTA_RESET_INTERVAL_MS = 1000; ///< Interval at which the request quota resets
|
||||
static constexpr int THREAD_SHUTDOWN_WAIT_MS = 5000; ///< Bounded wait for the worker thread to stop at exit
|
||||
|
||||
CardPictureLoaderWorker::CardPictureLoaderWorker()
|
||||
: QObject(nullptr), picDownload(SettingsCache::instance().downloads().getPicDownload()),
|
||||
requestQuota(MAX_REQUESTS_PER_SEC)
|
||||
hostRequestLimits(SettingsCache::instance().downloads().getHostRequestLimits())
|
||||
{
|
||||
networkManager = new QNetworkAccessManager(this);
|
||||
// We need a timeout to ensure requests don't hang indefinitely in case of
|
||||
|
|
@ -59,6 +60,9 @@ CardPictureLoaderWorker::CardPictureLoaderWorker()
|
|||
localLoader = new CardPictureLoaderLocal(this);
|
||||
|
||||
pictureLoaderThread = new QThread;
|
||||
// The worker object frees itself once its thread finishes, so no event loop is left
|
||||
// running and the QThread is never destroyed while still executing.
|
||||
connect(pictureLoaderThread, &QThread::finished, this, &QObject::deleteLater);
|
||||
pictureLoaderThread->start(QThread::LowPriority);
|
||||
moveToThread(pictureLoaderThread);
|
||||
|
||||
|
|
@ -74,12 +78,41 @@ CardPictureLoaderWorker::CardPictureLoaderWorker()
|
|||
|
||||
connect(&dispatchTimer, &QTimer::timeout, this, &CardPictureLoaderWorker::dispatchQueuedRequest);
|
||||
dispatchTimer.setInterval(DISPATCH_INTERVAL_MS);
|
||||
|
||||
connect(&SettingsCache::instance().downloads(), &DownloadSettings::hostRequestLimitsChanged, this,
|
||||
[this] { hostRequestLimits = SettingsCache::instance().downloads().getHostRequestLimits(); });
|
||||
}
|
||||
|
||||
CardPictureLoaderWorker::~CardPictureLoaderWorker()
|
||||
{
|
||||
saveRedirectCache();
|
||||
pictureLoaderThread->deleteLater();
|
||||
}
|
||||
|
||||
bool CardPictureLoaderWorker::shutdownThread()
|
||||
{
|
||||
// The finished() -> deleteLater chain (wired in the constructor) frees this worker as soon as
|
||||
// its event loop exits, so nothing - not even a member read - may run once wait() returns.
|
||||
// QThread::quit() and QThread::wait() are thread-safe and may be called from the owning thread.
|
||||
QThread *thread = pictureLoaderThread;
|
||||
if (!thread) {
|
||||
return true;
|
||||
}
|
||||
thread->quit();
|
||||
// Only an unbounded wait() would guarantee the thread stops, but this runs from a function-local
|
||||
// static destructor after main() has returned, with no UI left to interrupt a worker stuck in a
|
||||
// slow slot or on a stalled filesystem. Bound the wait and leave such a thread to the OS rather
|
||||
// than hanging the process forever.
|
||||
if (!thread->wait(THREAD_SHUTDOWN_WAIT_MS)) {
|
||||
qCWarning(CardPictureLoaderWorkerLog) << "Picture loader worker thread did not stop within"
|
||||
<< THREAD_SHUTDOWN_WAIT_MS << "ms; leaving it to be torn down by the OS";
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
QThread *CardPictureLoaderWorker::workerThread() const
|
||||
{
|
||||
return pictureLoaderThread;
|
||||
}
|
||||
|
||||
void CardPictureLoaderWorker::queueRequest(const QUrl &url, CardPictureLoaderWorkerWork *worker)
|
||||
|
|
@ -109,6 +142,14 @@ QNetworkReply *CardPictureLoaderWorker::makeRequest(const QUrl &url, CardPicture
|
|||
QUrl cachedRedirect = getCachedRedirect(url);
|
||||
if (!cachedRedirect.isEmpty()) {
|
||||
emit imageRequestSucceeded(url);
|
||||
// The redirect target is a different host, which may itself be in 429 backoff; hand the
|
||||
// entry back to its worker so it waits the backoff out instead of dispatching straight
|
||||
// onto the backed-off host.
|
||||
if (CardPictureLoaderWorkerWork::rateLimiter().isRateLimited(cachedRedirect.host(),
|
||||
QDateTime::currentDateTime())) {
|
||||
worker->scheduleDeferredRetry();
|
||||
return nullptr;
|
||||
}
|
||||
return makeRequest(cachedRedirect, worker);
|
||||
}
|
||||
|
||||
|
|
@ -129,26 +170,45 @@ QNetworkReply *CardPictureLoaderWorker::makeRequest(const QUrl &url, CardPicture
|
|||
|
||||
QNetworkReply *reply = networkManager->get(req);
|
||||
|
||||
// Track in-flight replies per host so the unlocked fast path can bound how many requests it
|
||||
// issues at once, instead of creating replies that time out before Qt opens a connection.
|
||||
const QString host = url.host();
|
||||
hostInFlight.insert(host, hostInFlight.value(host) + 1);
|
||||
|
||||
// Connect reply handling
|
||||
connect(reply, &QNetworkReply::finished, worker, [reply, worker] { worker->handleNetworkReply(reply); });
|
||||
connect(reply, &QNetworkReply::finished, worker, [this, reply, worker, host] {
|
||||
hostInFlight.insert(host, qMax(0, hostInFlight.value(host) - 1));
|
||||
worker->handleNetworkReply(reply);
|
||||
});
|
||||
|
||||
return reply;
|
||||
}
|
||||
|
||||
void CardPictureLoaderWorker::resetRequestQuota()
|
||||
{
|
||||
requestQuota = MAX_REQUESTS_PER_SEC;
|
||||
// Allowances are seeded lazily per host in processSingleRequest() when a request is first
|
||||
// looked at in a new second, so a host that enters the queue mid-second now gets its reduced
|
||||
// per-host allowance instead of falling through to the full per-second default.
|
||||
hostQuotaRemaining.clear();
|
||||
|
||||
QDateTime now = QDateTime::currentDateTime();
|
||||
for (auto it = hostRequestQuota.begin(); it != hostRequestQuota.end(); ++it) {
|
||||
for (auto it = hostRequestQuota.begin(); it != hostRequestQuota.end();) {
|
||||
if (!hostLast429.contains(it.key()) || now.msecsTo(hostLast429.value(it.key())) < -QUOTA_RECOVER_MS) {
|
||||
it.value() = qMin(MAX_REQUESTS_PER_SEC, it.value() + 1);
|
||||
if (hostAllowanceCeiling(it.key()) == DownloadSettings::UNLIMITED_HOST_QUOTA) {
|
||||
// A developer-unlocked host that fell back after a 429 recovers towards the default
|
||||
// allowance; once it gets there it becomes unlocked (fast-path) again.
|
||||
if (it.value() + 1 >= DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT) {
|
||||
it = hostRequestQuota.erase(it);
|
||||
continue;
|
||||
}
|
||||
it.value() += 1;
|
||||
} else {
|
||||
// Recover towards the host's effective allowance ceiling, which may be
|
||||
// lowered by the user's per-host request limits.
|
||||
it.value() = qMin(hostAllowanceCeiling(it.key()), it.value() + 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
for (const auto &request : requestLoadQueue) {
|
||||
const QString host = request.first.host();
|
||||
hostQuotaRemaining.insert(host, hostRequestQuota.value(host, MAX_REQUESTS_PER_SEC));
|
||||
++it;
|
||||
}
|
||||
|
||||
processQueuedRequests();
|
||||
|
|
@ -156,38 +216,112 @@ void CardPictureLoaderWorker::resetRequestQuota()
|
|||
|
||||
void CardPictureLoaderWorker::processQueuedRequests()
|
||||
{
|
||||
Q_ASSERT(thread() == QThread::currentThread());
|
||||
|
||||
if (requestLoadQueue.isEmpty()) {
|
||||
dispatchTimer.stop();
|
||||
requestTimer.stop();
|
||||
return;
|
||||
}
|
||||
// Start lazily from the worker's own thread: QTimer must be started in the thread it lives in.
|
||||
if (!requestTimer.isActive()) {
|
||||
requestTimer.start();
|
||||
}
|
||||
dispatchTimer.start();
|
||||
// Restarting an active timer would reset the pacing countdown, so a burst of enqueues could
|
||||
// keep starving the dispatcher; only start it when it has actually stopped.
|
||||
if (!dispatchTimer.isActive()) {
|
||||
dispatchTimer.start();
|
||||
}
|
||||
}
|
||||
|
||||
void CardPictureLoaderWorker::dispatchQueuedRequest()
|
||||
{
|
||||
if (requestLoadQueue.isEmpty() || requestQuota <= 0) {
|
||||
if (requestLoadQueue.isEmpty()) {
|
||||
// All queued requests have been dispatched; stop the pacing and quota-reset timers.
|
||||
dispatchTimer.stop();
|
||||
requestTimer.stop();
|
||||
return;
|
||||
}
|
||||
|
||||
QDateTime now = QDateTime::currentDateTime();
|
||||
bool dispatched = false;
|
||||
// Set while an unlocked host still has queued work blocked only by the in-flight cap; the
|
||||
// timer must keep running so it gets another try as soon as a slot frees. A host blocked by
|
||||
// its 429 backoff instead waits for the next quota-reset tick to restart the dispatcher.
|
||||
bool unlockedCapped = false;
|
||||
|
||||
// Unlocked hosts (developer cap UNLIMITED_HOST_QUOTA) skip the pacing and the per-host
|
||||
// allowance: dispatch their queued requests back-to-back, bounded by their 429 backoff and the
|
||||
// per-host in-flight cap so a large burst can't queue replies that time out before Qt opens a
|
||||
// connection for them.
|
||||
for (int i = 0; i < requestLoadQueue.size();) {
|
||||
const auto &request = requestLoadQueue.at(i);
|
||||
const QString host = request.first.host();
|
||||
if (isUnlockedHost(host)) {
|
||||
if (CardPictureLoaderWorkerWork::rateLimiter().isRateLimited(host, now)) {
|
||||
++i;
|
||||
continue;
|
||||
}
|
||||
if (hostInFlight.value(host) < MAX_IN_FLIGHT_PER_HOST) {
|
||||
makeRequest(request.first, request.second);
|
||||
requestLoadQueue.removeAt(i);
|
||||
dispatched = true;
|
||||
continue;
|
||||
}
|
||||
unlockedCapped = true;
|
||||
}
|
||||
++i;
|
||||
}
|
||||
|
||||
if (requestLoadQueue.isEmpty()) {
|
||||
dispatchTimer.stop();
|
||||
requestTimer.stop();
|
||||
return;
|
||||
}
|
||||
|
||||
if (processSingleRequest()) {
|
||||
--requestQuota;
|
||||
} else {
|
||||
// No queued host currently has allowance left in this second; wait for the quota reset.
|
||||
dispatched = true;
|
||||
}
|
||||
|
||||
// Keep the timer running while there is progress to make or unlocked work waiting on a free
|
||||
// in-flight slot; otherwise no host has allowance left this second, so wait for the quota reset.
|
||||
if (!dispatched && !unlockedCapped) {
|
||||
dispatchTimer.stop();
|
||||
}
|
||||
}
|
||||
|
||||
bool CardPictureLoaderWorker::processSingleRequest()
|
||||
{
|
||||
QDateTime now = QDateTime::currentDateTime();
|
||||
for (int i = 0; i < requestLoadQueue.size(); ++i) {
|
||||
const auto &request = requestLoadQueue.at(i);
|
||||
QString host = request.first.host();
|
||||
int allowance = hostQuotaRemaining.value(host, MAX_REQUESTS_PER_SEC);
|
||||
const QString host = request.first.host();
|
||||
// Don't dispatch requests to a host that is currently in its 429 backoff; hand the entry
|
||||
// back to its worker so it can wait the backoff out or fall through to another source,
|
||||
// instead of leaving it parked in the queue with no reply pending.
|
||||
if (CardPictureLoaderWorkerWork::rateLimiter().isRateLimited(host, now)) {
|
||||
requestLoadQueue.removeAt(i);
|
||||
request.second->startNextPicDownload();
|
||||
return true;
|
||||
}
|
||||
// Unlocked hosts are handled by dispatchQueuedRequest's fast path, bounded by the in-flight
|
||||
// cap; they must not fall through to the per-host allowance arithmetic below.
|
||||
if (isUnlockedHost(host)) {
|
||||
continue;
|
||||
}
|
||||
int ceiling = hostAllowanceCeiling(host);
|
||||
if (ceiling == DownloadSettings::UNLIMITED_HOST_QUOTA) {
|
||||
// A 429 dropped this unlocked host out of the fast path and installed a concrete
|
||||
// allowance; pace it against that allowance until the recovery loop unlocks it again.
|
||||
ceiling = hostRequestQuota.value(host, DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT);
|
||||
}
|
||||
// Seed the allowance lazily so a host that enters the queue mid-second gets its reduced
|
||||
// per-host allowance, clamped against the ceiling so a lowered user cap applies from this
|
||||
// second onward.
|
||||
if (!hostQuotaRemaining.contains(host)) {
|
||||
hostQuotaRemaining.insert(host, qMin(ceiling, hostRequestQuota.value(host, ceiling)));
|
||||
}
|
||||
int allowance = hostQuotaRemaining.value(host);
|
||||
if (allowance > 0) {
|
||||
hostQuotaRemaining.insert(host, allowance - 1);
|
||||
makeRequest(request.first, request.second);
|
||||
|
|
@ -198,9 +332,30 @@ bool CardPictureLoaderWorker::processSingleRequest()
|
|||
return false;
|
||||
}
|
||||
|
||||
int CardPictureLoaderWorker::hostAllowanceCeiling(const QString &host) const
|
||||
{
|
||||
const int devCap = DownloadSettings::getDeveloperHostCaps().value(host, MAX_REQUESTS_PER_SEC);
|
||||
if (devCap == DownloadSettings::UNLIMITED_HOST_QUOTA && !hostRequestLimits.contains(host)) {
|
||||
return DownloadSettings::UNLIMITED_HOST_QUOTA;
|
||||
}
|
||||
const int requested = hostRequestLimits.value(host, devCap);
|
||||
return SettingsCache::instance().downloads().clampHostRequestLimit(host, requested);
|
||||
}
|
||||
|
||||
bool CardPictureLoaderWorker::isUnlockedHost(const QString &host) const
|
||||
{
|
||||
return hostAllowanceCeiling(host) == DownloadSettings::UNLIMITED_HOST_QUOTA && !hostRequestQuota.contains(host);
|
||||
}
|
||||
|
||||
void CardPictureLoaderWorker::onHostRateLimited(const QString &host)
|
||||
{
|
||||
hostRequestQuota.insert(host, qMax(MIN_HOST_QUOTA, hostRequestQuota.value(host, MAX_REQUESTS_PER_SEC) / 2));
|
||||
const int ceiling = hostAllowanceCeiling(host);
|
||||
// An unlocked host has no per-host allowance to halve. Install one instead so it drops out of
|
||||
// the unlocked fast path and is paced like a throttled host; the recovery loop in
|
||||
// resetRequestQuota() then walks it back up and unlocks it again.
|
||||
const int base =
|
||||
ceiling == DownloadSettings::UNLIMITED_HOST_QUOTA ? DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT : ceiling;
|
||||
hostRequestQuota.insert(host, qMax(MIN_HOST_QUOTA, hostRequestQuota.value(host, base) / 2));
|
||||
hostLast429.insert(host, QDateTime::currentDateTime());
|
||||
}
|
||||
|
||||
|
|
@ -310,4 +465,5 @@ void CardPictureLoaderWorker::clearNetworkCache()
|
|||
{
|
||||
networkManager->cache()->clear();
|
||||
redirectCache.clear();
|
||||
emit networkCacheCleared();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -74,10 +74,37 @@ public:
|
|||
*/
|
||||
void onHostRateLimited(const QString &host);
|
||||
|
||||
/** @brief Clears the network cache and redirect cache. */
|
||||
void clearNetworkCache();
|
||||
/**
|
||||
* @brief Stops the worker thread and reports whether it stopped.
|
||||
*
|
||||
* Called from the owning thread (CardPictureLoader) on its way out. QThread::quit() posts an
|
||||
* exit request to the worker's event loop and QThread::wait() blocks (bounded) until the loop
|
||||
* has returned and the thread finished. Only QThread members are touched here, so this method
|
||||
* is safe to call from the owning thread. The worker object itself is freed by the finished()
|
||||
* -> deleteLater chain (see the constructor); the QThread object is deleted afterwards by the
|
||||
* owner (CardPictureLoader::~CardPictureLoader), not by this method.
|
||||
*
|
||||
* @return true if the thread stopped within the timeout, false if it is still running (in
|
||||
* which case the owner must not delete the QThread).
|
||||
*/
|
||||
[[nodiscard]] bool shutdownThread();
|
||||
|
||||
/**
|
||||
* @brief Returns the worker's QThread.
|
||||
* @return The worker thread
|
||||
*
|
||||
* Only meaningful while the worker object is alive; capture it before calling shutdownThread().
|
||||
*/
|
||||
QThread *workerThread() const;
|
||||
|
||||
public slots:
|
||||
/**
|
||||
* @brief Clears the network cache and redirect cache.
|
||||
*
|
||||
* Runs on the worker thread; invoke it via a queued call when coming from another thread,
|
||||
* since both caches are owned by the worker thread.
|
||||
*/
|
||||
void clearNetworkCache();
|
||||
/**
|
||||
* @brief Makes a network request for the given URL using the specified worker.
|
||||
* @param url URL to load
|
||||
|
|
@ -86,7 +113,7 @@ public slots:
|
|||
*/
|
||||
QNetworkReply *makeRequest(const QUrl &url, CardPictureLoaderWorkerWork *workThread);
|
||||
|
||||
/** @brief Processes all queued requests respecting the request quota. */
|
||||
/** @brief Starts the pacing timers if there is queued work, stops them when the queue is empty. */
|
||||
void processQueuedRequests();
|
||||
|
||||
/** @brief Chooses a request from the queue and starts it, respecting the quota and pacing. */
|
||||
|
|
@ -121,16 +148,36 @@ private:
|
|||
bool picDownload; ///< Whether downloading images from network is enabled
|
||||
QQueue<QPair<QUrl, CardPictureLoaderWorkerWork *>> requestLoadQueue; ///< Queue of pending network requests
|
||||
|
||||
int requestQuota; ///< Remaining requests allowed per second
|
||||
QTimer requestTimer; ///< Timer to reset the request quota
|
||||
QTimer dispatchTimer; ///< Timer pacing individual network requests
|
||||
QHash<QString, int> hostRequestQuota; ///< Sustained per-host request allowance
|
||||
QHash<QString, int> hostRequestLimits; ///< User-set per-host request allowances
|
||||
QHash<QString, int> hostQuotaRemaining; ///< Per-host allowance left in the current second
|
||||
QHash<QString, QDateTime> hostLast429; ///< When each host was last rate limited
|
||||
QHash<QString, int> hostInFlight; ///< Network replies currently in flight, per host
|
||||
|
||||
/** @brief Maximum concurrent in-flight network replies per host. */
|
||||
static constexpr int MAX_IN_FLIGHT_PER_HOST = 6;
|
||||
|
||||
CardPictureLoaderLocal *localLoader; ///< Loader for local images
|
||||
QSet<QString> currentlyLoading; ///< Deduplication: contains pixmapCacheKey currently being loaded
|
||||
|
||||
/**
|
||||
* @brief Effective per-host allowance ceiling for a host.
|
||||
* @param host The host to look up
|
||||
* @return The allowance ceiling in requests/second, or DownloadSettings::UNLIMITED_HOST_QUOTA
|
||||
* when the developer unlocked the host and no user limit is set for it.
|
||||
*/
|
||||
[[nodiscard]] int hostAllowanceCeiling(const QString &host) const;
|
||||
|
||||
/**
|
||||
* @brief Whether a host may skip dispatch pacing and per-host allowance entirely.
|
||||
*
|
||||
* A host is unlocked while it has no user limit and no reduced allowance installed by a 429.
|
||||
* A 429 drops it out of the fast path until resetRequestQuota() walks the allowance back up.
|
||||
*/
|
||||
[[nodiscard]] bool isUnlockedHost(const QString &host) const;
|
||||
|
||||
/** @brief Returns cached redirect URL for the given original URL, if available. */
|
||||
[[nodiscard]] QUrl getCachedRedirect(const QUrl &originalUrl) const;
|
||||
|
||||
|
|
@ -162,6 +209,9 @@ signals:
|
|||
|
||||
/** @brief Emitted when a network request successfully completes. */
|
||||
void imageRequestSucceeded(const QUrl &url);
|
||||
|
||||
/** @brief Emitted after clearNetworkCache() has finished clearing both caches. */
|
||||
void networkCacheCleared();
|
||||
};
|
||||
|
||||
#endif // PICTURE_LOADER_WORKER_H
|
||||
|
|
|
|||
|
|
@ -22,8 +22,13 @@ static const QStringList MD5_BLACKLIST = {
|
|||
"fbc7d763c08771c260b39e2115414eeb" // Current card back hash
|
||||
};
|
||||
|
||||
CardPictureLoaderWorkerWork::CardPictureLoaderWorkerWork(const CardPictureLoaderWorker *worker, const ExactCard &toLoad)
|
||||
: QObject(nullptr), cardToDownload(CardPictureToLoad(toLoad)),
|
||||
const ServerRateLimiter &CardPictureLoaderWorkerWork::rateLimiter()
|
||||
{
|
||||
return s_rateLimiter;
|
||||
}
|
||||
|
||||
CardPictureLoaderWorkerWork::CardPictureLoaderWorkerWork(CardPictureLoaderWorker *worker, const ExactCard &toLoad)
|
||||
: QObject(worker), cardToDownload(CardPictureToLoad(toLoad)),
|
||||
picDownload(SettingsCache::instance().downloads().getPicDownload())
|
||||
{
|
||||
// Hook up signals to the orchestrator
|
||||
|
|
|
|||
|
|
@ -36,13 +36,37 @@ class CardPictureLoaderWorkerWork : public QObject
|
|||
public:
|
||||
/**
|
||||
* @brief Constructs a worker for downloading a specific card image.
|
||||
* @param worker The orchestrating CardPictureLoaderWorker
|
||||
* @param worker The orchestrating CardPictureLoaderWorker; the work object becomes its child so
|
||||
* it is destroyed with the worker even if it never reaches concludeImageLoad().
|
||||
* @param toLoad The ExactCard to download
|
||||
*/
|
||||
explicit CardPictureLoaderWorkerWork(const CardPictureLoaderWorker *worker, const ExactCard &toLoad);
|
||||
explicit CardPictureLoaderWorkerWork(CardPictureLoaderWorker *worker, const ExactCard &toLoad);
|
||||
|
||||
CardPictureToLoad cardToDownload; ///< The card and associated URLs to try downloading
|
||||
|
||||
/** @brief Shared per-server 429 backoff state. */
|
||||
static const ServerRateLimiter &rateLimiter();
|
||||
|
||||
/**
|
||||
* @brief Starts downloading the next URL for this card.
|
||||
*
|
||||
* Skips URLs whose server is currently in 429 backoff, either waiting the
|
||||
* backoff out or falling through to the other configured sources. Also used by
|
||||
* the dispatch machinery to hand an entry back after it was removed from the
|
||||
* request queue when its host turned out to be backed off.
|
||||
*/
|
||||
void startNextPicDownload();
|
||||
|
||||
/**
|
||||
* @brief Schedules a deferred retry after the relevant server backoff expires.
|
||||
*
|
||||
* Waits on the current URL's server when it is the reason we are blocked,
|
||||
* otherwise on the earliest active backoff. If no servers are in backoff,
|
||||
* concludes with failure. Otherwise resets the CardPictureToLoad indices and
|
||||
* retries after the backoff period.
|
||||
*/
|
||||
void scheduleDeferredRetry();
|
||||
|
||||
public slots:
|
||||
/**
|
||||
* @brief Handles a finished network reply for the card image.
|
||||
|
|
@ -55,9 +79,6 @@ private:
|
|||
|
||||
static ServerRateLimiter s_rateLimiter; ///< Shared per-server 429 backoff state
|
||||
|
||||
/** @brief Starts downloading the next URL for this card. */
|
||||
void startNextPicDownload();
|
||||
|
||||
/** @brief Called when all URLs have been exhausted or download failed. */
|
||||
void picDownloadFailed();
|
||||
|
||||
|
|
@ -82,16 +103,6 @@ private:
|
|||
*/
|
||||
void concludeImageLoad(const QImage &image);
|
||||
|
||||
/**
|
||||
* @brief Schedules a deferred retry after the relevant server backoff expires.
|
||||
*
|
||||
* Waits on the current URL's server when it is the reason we are blocked,
|
||||
* otherwise on the earliest active backoff. If no servers are in backoff,
|
||||
* concludes with failure. Otherwise resets the CardPictureToLoad indices and
|
||||
* retries after the backoff period.
|
||||
*/
|
||||
void scheduleDeferredRetry();
|
||||
|
||||
private slots:
|
||||
/** @brief Updates the picDownload setting when it changes. */
|
||||
void picDownloadChanged();
|
||||
|
|
|
|||
|
|
@ -10,7 +10,9 @@
|
|||
#include <QInputDialog>
|
||||
#include <QLineEdit>
|
||||
#include <QMessageBox>
|
||||
#include <QSet>
|
||||
#include <QToolBar>
|
||||
#include <QUrl>
|
||||
#include <libcockatrice/settings/download_settings.h>
|
||||
#include <libcockatrice/settings/paths_settings.h>
|
||||
#include <libcockatrice/settings/personal_settings.h>
|
||||
|
|
@ -51,7 +53,9 @@ DeckEditorSettingsPage::DeckEditorSettingsPage()
|
|||
urlList->setDragDropMode(QAbstractItemView::InternalMove);
|
||||
connect(urlList->model(), &QAbstractItemModel::rowsMoved, this, &DeckEditorSettingsPage::urlListChanged);
|
||||
|
||||
urlList->addItems(SettingsCache::instance().downloads().getAllURLs());
|
||||
for (const QString &url : SettingsCache::instance().downloads().getAllURLs()) {
|
||||
addUrlItem(url);
|
||||
}
|
||||
|
||||
aAdd = new QAction(this);
|
||||
aAdd->setIcon(themePixmap(QStringLiteral("icons/increment")));
|
||||
|
|
@ -65,11 +69,16 @@ DeckEditorSettingsPage::DeckEditorSettingsPage()
|
|||
aRemove->setIcon(themePixmap(QStringLiteral("icons/decrement")));
|
||||
connect(aRemove, &QAction::triggered, this, &DeckEditorSettingsPage::actRemoveURL);
|
||||
|
||||
aRateLimit = new QAction(this);
|
||||
aRateLimit->setIcon(themePixmap(QStringLiteral("icons/cogwheel")));
|
||||
connect(aRateLimit, &QAction::triggered, this, &DeckEditorSettingsPage::actAdjustRateLimit);
|
||||
|
||||
auto *urlToolBar = new QToolBar;
|
||||
urlToolBar->setOrientation(Qt::Vertical);
|
||||
urlToolBar->addAction(aAdd);
|
||||
urlToolBar->addAction(aRemove);
|
||||
urlToolBar->addAction(aEdit);
|
||||
urlToolBar->addAction(aRateLimit);
|
||||
urlToolBar->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::MinimumExpanding);
|
||||
|
||||
auto *urlListLayout = new QHBoxLayout;
|
||||
|
|
@ -117,7 +126,9 @@ void DeckEditorSettingsPage::resetDownloadedURLsButtonClicked()
|
|||
{
|
||||
SettingsCache::instance().downloads().resetToDefaultURLs();
|
||||
urlList->clear();
|
||||
urlList->addItems(SettingsCache::instance().downloads().getAllURLs());
|
||||
for (const QString &url : SettingsCache::instance().downloads().getAllURLs()) {
|
||||
addUrlItem(url);
|
||||
}
|
||||
QMessageBox::information(this, tr("Success"), tr("Download URLs have been reset."));
|
||||
}
|
||||
|
||||
|
|
@ -126,7 +137,7 @@ void DeckEditorSettingsPage::actAddURL()
|
|||
bool ok;
|
||||
QString msg = QInputDialog::getText(this, tr("Add URL"), tr("URL:"), QLineEdit::Normal, QString(), &ok);
|
||||
if (ok) {
|
||||
urlList->addItem(msg);
|
||||
addUrlItem(msg);
|
||||
storeSettings();
|
||||
}
|
||||
}
|
||||
|
|
@ -141,12 +152,14 @@ void DeckEditorSettingsPage::actRemoveURL()
|
|||
|
||||
void DeckEditorSettingsPage::actEditURL()
|
||||
{
|
||||
if (urlList->currentItem()) {
|
||||
QString oldText = urlList->currentItem()->text();
|
||||
QListWidgetItem *item = urlList->currentItem();
|
||||
if (item) {
|
||||
const QString oldText = urlForItem(item);
|
||||
bool ok;
|
||||
QString msg = QInputDialog::getText(this, tr("Edit URL"), tr("URL:"), QLineEdit::Normal, oldText, &ok);
|
||||
if (ok) {
|
||||
urlList->currentItem()->setText(msg);
|
||||
item->setData(Qt::UserRole, msg);
|
||||
item->setText(urlLabel(msg));
|
||||
storeSettings();
|
||||
}
|
||||
}
|
||||
|
|
@ -158,10 +171,128 @@ void DeckEditorSettingsPage::storeSettings()
|
|||
|
||||
QStringList downloadUrls;
|
||||
for (int i = 0; i < urlList->count(); i++) {
|
||||
qInfo() << "Priority" << i << ":" << urlList->item(i)->text();
|
||||
downloadUrls << urlList->item(i)->text();
|
||||
const QString url = urlForItem(urlList->item(i));
|
||||
qInfo() << "Priority" << i << ":" << url;
|
||||
downloadUrls << url;
|
||||
}
|
||||
SettingsCache::instance().downloads().setDownloadUrls(downloadUrls);
|
||||
|
||||
// Drop per-host limits whose host is no longer referenced by any configured URL, so removing
|
||||
// a URL doesn't leave a stale throttle behind that reactivates if the host is re-added.
|
||||
QSet<QString> usedHosts;
|
||||
for (const QString &url : downloadUrls) {
|
||||
const QString host = QUrl(url).host();
|
||||
if (!host.isEmpty()) {
|
||||
usedHosts.insert(host);
|
||||
}
|
||||
}
|
||||
QHash<QString, int> limits = SettingsCache::instance().downloads().getHostRequestLimits();
|
||||
bool limitsChanged = false;
|
||||
for (auto it = limits.begin(); it != limits.end();) {
|
||||
if (!usedHosts.contains(it.key())) {
|
||||
it = limits.erase(it);
|
||||
limitsChanged = true;
|
||||
} else {
|
||||
++it;
|
||||
}
|
||||
}
|
||||
if (limitsChanged) {
|
||||
SettingsCache::instance().downloads().setHostRequestLimits(limits);
|
||||
}
|
||||
|
||||
refreshUrlItems();
|
||||
}
|
||||
|
||||
QListWidgetItem *DeckEditorSettingsPage::addUrlItem(const QString &url)
|
||||
{
|
||||
auto *item = new QListWidgetItem(urlLabel(url));
|
||||
item->setData(Qt::UserRole, url);
|
||||
urlList->addItem(item);
|
||||
return item;
|
||||
}
|
||||
|
||||
QString DeckEditorSettingsPage::urlForItem(const QListWidgetItem *item) const
|
||||
{
|
||||
return item->data(Qt::UserRole).toString();
|
||||
}
|
||||
|
||||
QString DeckEditorSettingsPage::urlLabel(const QString &url) const
|
||||
{
|
||||
const QString host = QUrl(url).host();
|
||||
if (host.isEmpty()) {
|
||||
return url;
|
||||
}
|
||||
|
||||
const QHash<QString, int> limits = SettingsCache::instance().downloads().getHostRequestLimits();
|
||||
const int devCap =
|
||||
DownloadSettings::getDeveloperHostCaps().value(host, DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT);
|
||||
if (devCap == DownloadSettings::UNLIMITED_HOST_QUOTA && !limits.contains(host)) {
|
||||
return tr("%1 (unlimited)").arg(url);
|
||||
}
|
||||
|
||||
const int requested = limits.value(
|
||||
host, devCap == DownloadSettings::UNLIMITED_HOST_QUOTA ? DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT : devCap);
|
||||
const int effective = SettingsCache::instance().downloads().clampHostRequestLimit(host, requested);
|
||||
return tr("%1 (%2/s)").arg(url).arg(effective);
|
||||
}
|
||||
|
||||
void DeckEditorSettingsPage::refreshUrlItems()
|
||||
{
|
||||
for (int i = 0; i < urlList->count(); ++i) {
|
||||
QListWidgetItem *item = urlList->item(i);
|
||||
item->setText(urlLabel(urlForItem(item)));
|
||||
}
|
||||
}
|
||||
|
||||
void DeckEditorSettingsPage::actAdjustRateLimit()
|
||||
{
|
||||
if (urlList->currentItem() == nullptr) {
|
||||
QMessageBox::information(this, tr("Adjust Rate Limit"), tr("Select a URL in the list first."));
|
||||
return;
|
||||
}
|
||||
|
||||
const QString host = QUrl(urlForItem(urlList->currentItem())).host();
|
||||
if (host.isEmpty()) {
|
||||
QMessageBox::information(this, tr("Adjust Rate Limit"), tr("The selected URL does not have a valid host."));
|
||||
return;
|
||||
}
|
||||
|
||||
const QHash<QString, int> &devCaps = DownloadSettings::getDeveloperHostCaps();
|
||||
const QHash<QString, int> currentLimits = SettingsCache::instance().downloads().getHostRequestLimits();
|
||||
const int devCap = devCaps.value(host, DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT);
|
||||
const bool unlocked = devCap == DownloadSettings::UNLIMITED_HOST_QUOTA;
|
||||
|
||||
bool ok = false;
|
||||
int minimum;
|
||||
int maximum;
|
||||
int defaultValue;
|
||||
QString prompt;
|
||||
if (unlocked) {
|
||||
minimum = 0; // 0 means "unlimited"
|
||||
maximum = DownloadSettings::DEFAULT_HOST_REQUEST_LIMIT;
|
||||
defaultValue = currentLimits.value(host, 0);
|
||||
prompt = tr("Requests per second (0 = unlimited, fastest; up to %1):").arg(maximum);
|
||||
} else {
|
||||
minimum = DownloadSettings::MIN_HOST_REQUEST_LIMIT;
|
||||
maximum = devCap;
|
||||
defaultValue = currentLimits.value(host, devCap);
|
||||
prompt = tr("Requests per second (developer maximum is %1):").arg(maximum);
|
||||
}
|
||||
|
||||
const int value = QInputDialog::getInt(this, tr("Adjust Rate Limit for %1").arg(host), prompt, defaultValue,
|
||||
minimum, maximum, 1, &ok);
|
||||
if (!ok) {
|
||||
return;
|
||||
}
|
||||
|
||||
QHash<QString, int> limits = currentLimits;
|
||||
if (unlocked ? value == 0 : value == devCap) {
|
||||
limits.remove(host);
|
||||
} else {
|
||||
limits.insert(host, value);
|
||||
}
|
||||
SettingsCache::instance().downloads().setHostRequestLimits(limits);
|
||||
refreshUrlItems();
|
||||
}
|
||||
|
||||
void DeckEditorSettingsPage::urlListChanged(const QModelIndex &, int, int, const QModelIndex &, int)
|
||||
|
|
@ -244,4 +375,8 @@ void DeckEditorSettingsPage::retranslateUi()
|
|||
aAdd->setText(tr("Add New URL"));
|
||||
aEdit->setText(tr("Edit URL"));
|
||||
aRemove->setText(tr("Remove URL"));
|
||||
}
|
||||
aRateLimit->setText(tr("Adjust Rate Limit"));
|
||||
|
||||
// The per-URL rate limit suffixes are translated, so refresh them when the language changes.
|
||||
refreshUrlItems();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ private slots:
|
|||
void actAddURL();
|
||||
void actRemoveURL();
|
||||
void actEditURL();
|
||||
void actAdjustRateLimit();
|
||||
void resetDownloadedURLsButtonClicked();
|
||||
|
||||
private:
|
||||
|
|
@ -34,7 +35,7 @@ private:
|
|||
QLabel urlLinkLabel;
|
||||
QCheckBox picDownloadCheckBox;
|
||||
QListWidget *urlList;
|
||||
QAction *aAdd, *aEdit, *aRemove;
|
||||
QAction *aAdd, *aEdit, *aRemove, *aRateLimit;
|
||||
QCheckBox mcDownloadSpoilersCheckBox;
|
||||
QLabel msDownloadSpoilersLabel;
|
||||
QGroupBox *mpGeneralGroupBox;
|
||||
|
|
@ -46,6 +47,18 @@ private:
|
|||
QLabel infoOnSpoilersLabel;
|
||||
QPushButton *mpSpoilerPathButton;
|
||||
QPushButton *updateNowButton;
|
||||
|
||||
/** @brief Adds a list item for the given URL, storing the raw URL alongside its displayed label. */
|
||||
QListWidgetItem *addUrlItem(const QString &url);
|
||||
|
||||
/** @brief Returns the raw URL stored on a list item. */
|
||||
[[nodiscard]] QString urlForItem(const QListWidgetItem *item) const;
|
||||
|
||||
/** @brief Returns the display label for a URL, including its current effective rate limit. */
|
||||
[[nodiscard]] QString urlLabel(const QString &url) const;
|
||||
|
||||
/** @brief Refreshes the displayed label of every URL item after limits or settings change. */
|
||||
void refreshUrlItems();
|
||||
};
|
||||
|
||||
#endif // COCKATRICE_DECK_EDITOR_SETTINGS_PAGE_H
|
||||
|
|
|
|||
|
|
@ -181,9 +181,14 @@ StorageSettingsPage::StorageSettingsPage()
|
|||
|
||||
void StorageSettingsPage::clearDownloadedPicsButtonClicked()
|
||||
{
|
||||
CardPictureLoader::clearNetworkCache();
|
||||
// The network cache is cleared asynchronously on the worker thread, so wait for the completion
|
||||
// signal before confirming; the in-memory pixmap cache is cleared synchronously right away.
|
||||
connect(
|
||||
&CardPictureLoader::getInstance(), &CardPictureLoader::networkCacheCleared, this,
|
||||
[this] { QMessageBox::information(this, tr("Success"), tr("Cached card pictures have been reset.")); },
|
||||
Qt::SingleShotConnection);
|
||||
CardPictureLoader::clearPixmapCache();
|
||||
QMessageBox::information(this, tr("Success"), tr("Cached card pictures have been reset."));
|
||||
CardPictureLoader::clearNetworkCache();
|
||||
}
|
||||
|
||||
void StorageSettingsPage::clearImageBackupsButtonClicked()
|
||||
|
|
|
|||
|
|
@ -9,6 +9,22 @@ const QStringList DownloadSettings::DEFAULT_DOWNLOAD_URLS = {
|
|||
"https://gatherer.wizards.com/Handlers/Image.ashx?multiverseid=!set:muid!&type=card",
|
||||
"https://gatherer.wizards.com/Handlers/Image.ashx?name=!name!&type=card"};
|
||||
|
||||
// Developer-set ceilings for the per-host request allowance. Users may lower a host's
|
||||
// allowance via the download settings, but can never raise it above these values. Hosts
|
||||
// not listed default to DEFAULT_HOST_REQUEST_LIMIT. A cap of UNLIMITED_HOST_QUOTA marks a
|
||||
// host that is never throttled per host and skips the dispatch pacing (429 backoff still applies).
|
||||
const QHash<QString, int> DownloadSettings::DEVELOPER_HOST_CAPS = {
|
||||
// The Scryfall API enforces 10 requests/second; stay one under so a burst can't trip 429s.
|
||||
{"api.scryfall.com", 9},
|
||||
// The Scryfall image CDN has no documented per-client rate limit.
|
||||
{"cards.scryfall.io", UNLIMITED_HOST_QUOTA},
|
||||
};
|
||||
|
||||
const QHash<QString, int> &DownloadSettings::getDeveloperHostCaps()
|
||||
{
|
||||
return DEVELOPER_HOST_CAPS;
|
||||
}
|
||||
|
||||
DownloadSettings::DownloadSettings(const QString &settingPath, QObject *parent = nullptr)
|
||||
: SettingsManager(settingPath + "downloads.ini", "downloads", QString(), parent)
|
||||
{
|
||||
|
|
@ -50,3 +66,57 @@ void DownloadSettings::setDownloadSpoilerStatus(bool _spoilerStatus)
|
|||
setValue(_spoilerStatus, "downloadSpoilers");
|
||||
emit downloadSpoilerStatusChanged();
|
||||
}
|
||||
|
||||
QHash<QString, int> DownloadSettings::getHostRequestLimits() const
|
||||
{
|
||||
auto settings = getSettings();
|
||||
if (!defaultGroup.isEmpty()) {
|
||||
settings.beginGroup(defaultGroup);
|
||||
}
|
||||
settings.beginGroup("hostRequestLimits");
|
||||
|
||||
QHash<QString, int> hostRequestLimits;
|
||||
const QStringList hosts = settings.childKeys();
|
||||
for (const QString &host : hosts) {
|
||||
hostRequestLimits.insert(host, settings.value(host).toInt());
|
||||
}
|
||||
|
||||
settings.endGroup();
|
||||
if (!defaultGroup.isEmpty()) {
|
||||
settings.endGroup();
|
||||
}
|
||||
return hostRequestLimits;
|
||||
}
|
||||
|
||||
void DownloadSettings::setHostRequestLimits(const QHash<QString, int> &hostRequestLimits)
|
||||
{
|
||||
auto settings = getSettings();
|
||||
if (!defaultGroup.isEmpty()) {
|
||||
settings.beginGroup(defaultGroup);
|
||||
}
|
||||
|
||||
// Drop the legacy single-key form (an opaque @Variant blob) written by earlier builds so each
|
||||
// host is stored as a plain, hand-editable key in its own subgroup.
|
||||
settings.remove("hostRequestLimits");
|
||||
settings.beginGroup("hostRequestLimits");
|
||||
settings.remove(QString());
|
||||
for (auto it = hostRequestLimits.cbegin(); it != hostRequestLimits.cend(); ++it) {
|
||||
settings.setValue(it.key(), it.value());
|
||||
}
|
||||
settings.endGroup();
|
||||
|
||||
if (!defaultGroup.isEmpty()) {
|
||||
settings.endGroup();
|
||||
}
|
||||
settings.sync();
|
||||
emit hostRequestLimitsChanged();
|
||||
}
|
||||
|
||||
int DownloadSettings::clampHostRequestLimit(const QString &host, int requested) const
|
||||
{
|
||||
const int devCap = DEVELOPER_HOST_CAPS.value(host, DEFAULT_HOST_REQUEST_LIMIT);
|
||||
if (devCap == UNLIMITED_HOST_QUOTA) {
|
||||
return qMax(MIN_HOST_REQUEST_LIMIT, requested);
|
||||
}
|
||||
return qBound(MIN_HOST_REQUEST_LIMIT, requested, devCap);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -9,14 +9,34 @@
|
|||
|
||||
#include "settings_manager.h"
|
||||
|
||||
#include <QHash>
|
||||
|
||||
class DownloadSettings : public SettingsManager
|
||||
{
|
||||
Q_OBJECT
|
||||
friend class SettingsCache;
|
||||
|
||||
static const QStringList DEFAULT_DOWNLOAD_URLS;
|
||||
static const QHash<QString, int> DEVELOPER_HOST_CAPS;
|
||||
|
||||
public:
|
||||
/** @brief Per-host request allowance (requests/second) when no developer cap applies. */
|
||||
static constexpr int DEFAULT_HOST_REQUEST_LIMIT = 10;
|
||||
/** @brief Floor for any per-host request allowance. */
|
||||
static constexpr int MIN_HOST_REQUEST_LIMIT = 1;
|
||||
/** @brief Developer cap marking a host as never throttled per host or by the dispatch pacing. */
|
||||
static constexpr int UNLIMITED_HOST_QUOTA = -1;
|
||||
|
||||
/**
|
||||
* @brief Developer-set per-host allowance ceilings (requests/second), keyed by host.
|
||||
*
|
||||
* Hosts not present default to DEFAULT_HOST_REQUEST_LIMIT. An entry of
|
||||
* UNLIMITED_HOST_QUOTA marks a host that users may still lower, but that is never
|
||||
* throttled per host by default. Users can never raise a host's allowance above its
|
||||
* developer cap.
|
||||
*/
|
||||
static const QHash<QString, int> &getDeveloperHostCaps();
|
||||
|
||||
explicit DownloadSettings(const QString &, QObject *);
|
||||
|
||||
QStringList getAllURLs() const;
|
||||
|
|
@ -27,9 +47,23 @@ public:
|
|||
[[nodiscard]] bool getDownloadSpoilersStatus() const;
|
||||
void setDownloadSpoilerStatus(bool _spoilerStatus);
|
||||
|
||||
/** @brief User-set per-host request allowances (requests/second). Missing hosts use the developer default. */
|
||||
QHash<QString, int> getHostRequestLimits() const;
|
||||
void setHostRequestLimits(const QHash<QString, int> &hostRequestLimits);
|
||||
|
||||
/**
|
||||
* @brief Clamps the user's requested allowance for a host against its developer cap.
|
||||
* @param host The host to clamp for
|
||||
* @param requested The user-requested allowance in requests/second
|
||||
* @return The effective allowance. Users may lower a host's allowance but never raise it
|
||||
* above the developer cap; hosts with UNLIMITED_HOST_QUOTA have no upper bound.
|
||||
*/
|
||||
[[nodiscard]] int clampHostRequestLimit(const QString &host, int requested) const;
|
||||
|
||||
signals:
|
||||
void picDownloadChanged();
|
||||
void downloadSpoilerStatusChanged();
|
||||
void hostRequestLimitsChanged();
|
||||
};
|
||||
|
||||
#endif // COCKATRICE_DOWNLOADSETTINGS_H
|
||||
|
|
|
|||
|
|
@ -132,3 +132,9 @@ add_subdirectory(loading_from_clipboard)
|
|||
add_subdirectory(movecard_tests)
|
||||
add_subdirectory(oracle)
|
||||
add_subdirectory(settings)
|
||||
|
||||
# picture_loader_benchmark links libcockatrice_settings, which only exists when
|
||||
# a client/UI-capable target is being built.
|
||||
if(WITH_ORACLE OR WITH_CLIENT)
|
||||
add_subdirectory(picture_loader_benchmark)
|
||||
endif()
|
||||
|
|
|
|||
26
tests/picture_loader_benchmark/CMakeLists.txt
Normal file
26
tests/picture_loader_benchmark/CMakeLists.txt
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# Manual benchmark hitting the real card image hosts. Not registered with
|
||||
# add_test(): it requires a cards.xml, touches the network for minutes at a
|
||||
# time, and needs network access. Build it explicitly and run by hand.
|
||||
add_executable(
|
||||
picture_loader_benchmark_test
|
||||
${VERSION_STRING_CPP}
|
||||
../../cockatrice/src/interface/card_picture_loader/card_picture_loader_local.cpp
|
||||
../../cockatrice/src/interface/card_picture_loader/card_picture_to_load.cpp
|
||||
../../cockatrice/src/interface/card_picture_loader/card_picture_loader_worker.cpp
|
||||
../../cockatrice/src/interface/card_picture_loader/card_picture_loader_worker_work.cpp
|
||||
../../cockatrice/src/client/settings/cache_settings.h
|
||||
picture_loader_benchmark.cpp
|
||||
settings_cache_mock.cpp
|
||||
)
|
||||
|
||||
target_include_directories(picture_loader_benchmark_test PRIVATE ${CMAKE_SOURCE_DIR}/cockatrice/src)
|
||||
|
||||
target_link_libraries(
|
||||
picture_loader_benchmark_test
|
||||
libcockatrice_card
|
||||
libcockatrice_settings
|
||||
libcockatrice_interfaces
|
||||
libcockatrice_utility
|
||||
Threads::Threads
|
||||
${TEST_QT_MODULES}
|
||||
)
|
||||
547
tests/picture_loader_benchmark/picture_loader_benchmark.cpp
Normal file
547
tests/picture_loader_benchmark/picture_loader_benchmark.cpp
Normal file
|
|
@ -0,0 +1,547 @@
|
|||
/*
|
||||
* Picture loader benchmark / regression suite against the real card image hosts.
|
||||
*
|
||||
* Deliberately not registered with ctest: it hits live Scryfall / Gatherer
|
||||
* endpoints at ~10 requests per second and takes minutes. Run it by hand.
|
||||
*
|
||||
* picture_loader_benchmark_test --carddb /path/to/cards.xml [options]
|
||||
*
|
||||
* Modes
|
||||
* -----
|
||||
* default : for every URL template in the configured download list (or for each
|
||||
* --url given), load #count pictures twice: once cold (network) and
|
||||
* once cached (served from the QNetworkDiskCache). Both passes must
|
||||
* load every card with zero failures. The cached pass must complete
|
||||
* well under the cold time, which is the regression gate for serving
|
||||
* cached pictures instead of re-fetching them. The cold pass must stay
|
||||
* above a pacing lower bound, the regression gate for burst-free
|
||||
* request throttling.
|
||||
* --stress: two CardPictureLoaderWorker instances loading the same cards
|
||||
* concurrently against one host (~20 req/s aggregate), which forces
|
||||
* real 429 responses. Both workers must still complete 100% of their
|
||||
* cards via the shared backoff logic.
|
||||
*/
|
||||
|
||||
#include "client/settings/cache_settings.h"
|
||||
#include "interface/card_picture_loader/card_picture_loader_worker.h"
|
||||
#include "interface/card_picture_loader/card_picture_to_load.h"
|
||||
|
||||
#include <QCoreApplication>
|
||||
#include <QDir>
|
||||
#include <QElapsedTimer>
|
||||
#include <QEventLoop>
|
||||
#include <QFile>
|
||||
#include <QImage>
|
||||
#include <QList>
|
||||
#include <QMessageLogContext>
|
||||
#include <QMetaType>
|
||||
#include <QMutex>
|
||||
#include <QTemporaryDir>
|
||||
#include <QThread>
|
||||
#include <QTimer>
|
||||
#include <QUrl>
|
||||
#include <QtLogging>
|
||||
#include <atomic>
|
||||
#include <cstdio>
|
||||
#include <libcockatrice/card/database/card_database.h>
|
||||
#include <libcockatrice/card/printing/exact_card.h>
|
||||
#include <libcockatrice/card/printing/printing_info.h>
|
||||
#include <libcockatrice/interfaces/interface_card_database_path_provider.h>
|
||||
#include <libcockatrice/interfaces/noop_card_preference_provider.h>
|
||||
#include <libcockatrice/interfaces/noop_card_set_priority_controller.h>
|
||||
#include <libcockatrice/settings/download_settings.h>
|
||||
#include <optional>
|
||||
|
||||
class BenchmarkCardDatabasePathProvider : public ICardDatabasePathProvider
|
||||
{
|
||||
public:
|
||||
BenchmarkCardDatabasePathProvider(QString _cardsXml, QString _customSetsDir)
|
||||
: cardsXml(std::move(_cardsXml)), customSetsDir(std::move(_customSetsDir))
|
||||
{
|
||||
}
|
||||
|
||||
QString getCardDatabasePath() const override
|
||||
{
|
||||
return cardsXml;
|
||||
}
|
||||
|
||||
QString getCustomCardDatabasePath() const override
|
||||
{
|
||||
return customSetsDir;
|
||||
}
|
||||
|
||||
QString getTokenDatabasePath() const override
|
||||
{
|
||||
return QString();
|
||||
}
|
||||
|
||||
QString getSpoilerCardDatabasePath() const override
|
||||
{
|
||||
return QString();
|
||||
}
|
||||
|
||||
private:
|
||||
QString cardsXml;
|
||||
QString customSetsDir;
|
||||
};
|
||||
|
||||
struct PassResult
|
||||
{
|
||||
int enqueued = 0;
|
||||
int finished = 0;
|
||||
int failed = 0;
|
||||
qint64 elapsedMs = 0;
|
||||
QStringList failedCards;
|
||||
};
|
||||
|
||||
static QList<ExactCard> selectCardsForTemplate(CardDatabase &db, const QString &urlTemplate, int maxCards)
|
||||
{
|
||||
QList<ExactCard> selected;
|
||||
const QList<CardInfoPtr> cards = db.getCardList().values();
|
||||
for (const CardInfoPtr &card : cards) {
|
||||
if (selected.size() >= maxCards) {
|
||||
break;
|
||||
}
|
||||
const SetToPrintingsMap &sets = card->getSets();
|
||||
if (sets.isEmpty()) {
|
||||
continue;
|
||||
}
|
||||
const QList<PrintingInfo> printings = sets.first();
|
||||
if (printings.isEmpty()) {
|
||||
continue;
|
||||
}
|
||||
const ExactCard cardToLoad(card, printings.first());
|
||||
if (CardPictureToLoad(cardToLoad).transformUrl(urlTemplate).isEmpty()) {
|
||||
continue;
|
||||
}
|
||||
selected.append(cardToLoad);
|
||||
}
|
||||
return selected;
|
||||
}
|
||||
|
||||
static PassResult runPass(CardPictureLoaderWorker *worker, const QList<ExactCard> &cards, int timeoutMs)
|
||||
{
|
||||
PassResult result;
|
||||
result.enqueued = cards.size();
|
||||
|
||||
QEventLoop loop;
|
||||
QTimer watchdog;
|
||||
watchdog.setSingleShot(true);
|
||||
watchdog.setInterval(timeoutMs);
|
||||
QObject::connect(&watchdog, &QTimer::timeout, &loop, &QEventLoop::quit);
|
||||
|
||||
QElapsedTimer clock;
|
||||
QObject::connect(worker, &CardPictureLoaderWorker::imageLoaded, &loop,
|
||||
[&](const ExactCard &card, const QImage &image) {
|
||||
++result.finished;
|
||||
if (image.isNull()) {
|
||||
++result.failed;
|
||||
if (result.failedCards.size() < 10) {
|
||||
result.failedCards.append(card.getName());
|
||||
}
|
||||
}
|
||||
if (result.finished >= result.enqueued) {
|
||||
loop.quit();
|
||||
}
|
||||
});
|
||||
|
||||
clock.start();
|
||||
for (const ExactCard &card : cards) {
|
||||
worker->enqueueImageLoad(card);
|
||||
}
|
||||
watchdog.start();
|
||||
loop.exec();
|
||||
result.elapsedMs = clock.elapsed();
|
||||
return result;
|
||||
}
|
||||
|
||||
struct StressResult
|
||||
{
|
||||
PassResult a;
|
||||
PassResult b;
|
||||
int http429Count = 0;
|
||||
};
|
||||
|
||||
struct LogCounters
|
||||
{
|
||||
int http429 = 0;
|
||||
QMutex mutex;
|
||||
};
|
||||
|
||||
static std::atomic<LogCounters *> s_activeCounters{nullptr};
|
||||
static QtMessageHandler s_previousMessageHandler = nullptr;
|
||||
|
||||
static void stressLogHandler(QtMsgType type, const QMessageLogContext &context, const QString &msg)
|
||||
{
|
||||
if (LogCounters *counters = s_activeCounters.load(std::memory_order_acquire);
|
||||
counters && msg.contains(QStringLiteral("Too many requests from"))) {
|
||||
QMutexLocker locker(&counters->mutex);
|
||||
++counters->http429;
|
||||
}
|
||||
if (s_previousMessageHandler) {
|
||||
s_previousMessageHandler(type, context, msg);
|
||||
} else {
|
||||
// qInstallMessageHandler() reports the built-in handler as nullptr, so a plain `if` would
|
||||
// swallow every message - including the 429 warnings this run is meant to surface. Fall
|
||||
// back to Qt's message pattern written to stderr instead.
|
||||
std::fprintf(stderr, "%s\n", qPrintable(qFormatLogMessage(type, context, msg)));
|
||||
}
|
||||
}
|
||||
|
||||
// Stops a worker's thread and frees it. shutdownThread()'s bounded wait guarantees that the worker
|
||||
// object was freed by its finished() -> deleteLater chain, so the thread itself can then be deleted
|
||||
// safely. A worker whose thread refused to stop is left alone (and leaked) rather than freed while
|
||||
// still running.
|
||||
static void destroyWorker(CardPictureLoaderWorker *worker)
|
||||
{
|
||||
if (!worker) {
|
||||
return;
|
||||
}
|
||||
QThread *thread = worker->workerThread();
|
||||
if (worker->shutdownThread()) {
|
||||
delete thread;
|
||||
}
|
||||
}
|
||||
|
||||
static StressResult runStress(CardPictureLoaderWorker *workerA,
|
||||
CardPictureLoaderWorker *workerB,
|
||||
const QList<ExactCard> &cards,
|
||||
int timeoutMs)
|
||||
{
|
||||
StressResult result;
|
||||
result.a.enqueued = cards.size();
|
||||
result.b.enqueued = cards.size();
|
||||
|
||||
int completed = 0;
|
||||
QMutex completedMutex;
|
||||
|
||||
QEventLoop loop;
|
||||
QTimer watchdog;
|
||||
watchdog.setSingleShot(true);
|
||||
watchdog.setInterval(timeoutMs);
|
||||
QObject::connect(&watchdog, &QTimer::timeout, &loop, &QEventLoop::quit);
|
||||
|
||||
const auto finishOne = [&](PassResult &pass, const ExactCard &card, const QImage &image) {
|
||||
++pass.finished;
|
||||
if (image.isNull()) {
|
||||
++pass.failed;
|
||||
if (pass.failedCards.size() < 10) {
|
||||
pass.failedCards.append(card.getName());
|
||||
}
|
||||
}
|
||||
QMutexLocker locker(&completedMutex);
|
||||
++completed;
|
||||
if (completed >= result.a.enqueued + result.b.enqueued) {
|
||||
loop.quit();
|
||||
}
|
||||
};
|
||||
|
||||
QElapsedTimer clock;
|
||||
QObject::connect(workerA, &CardPictureLoaderWorker::imageLoaded, &loop,
|
||||
[&](const ExactCard &card, const QImage &image) { finishOne(result.a, card, image); });
|
||||
QObject::connect(workerB, &CardPictureLoaderWorker::imageLoaded, &loop,
|
||||
[&](const ExactCard &card, const QImage &image) { finishOne(result.b, card, image); });
|
||||
|
||||
// Count 429 responses as seen by the shared rate limiter.
|
||||
LogCounters counters;
|
||||
s_activeCounters = &counters;
|
||||
s_previousMessageHandler = qInstallMessageHandler(stressLogHandler);
|
||||
|
||||
clock.start();
|
||||
for (const ExactCard &card : cards) {
|
||||
workerA->enqueueImageLoad(card);
|
||||
workerB->enqueueImageLoad(card);
|
||||
}
|
||||
watchdog.start();
|
||||
loop.exec();
|
||||
const qint64 elapsedMs = clock.elapsed();
|
||||
result.a.elapsedMs = elapsedMs;
|
||||
result.b.elapsedMs = elapsedMs;
|
||||
|
||||
// Stop both workers before touching the counters or restoring the message handler: their
|
||||
// threads log from stressLogHandler, and must not outlive the stack-local counters (which is
|
||||
// guaranteed on the watchdog path, where requests and deferred retries are still pending).
|
||||
destroyWorker(workerA);
|
||||
destroyWorker(workerB);
|
||||
|
||||
result.http429Count = counters.http429;
|
||||
s_activeCounters.store(nullptr, std::memory_order_release);
|
||||
qInstallMessageHandler(s_previousMessageHandler);
|
||||
return result;
|
||||
}
|
||||
|
||||
static QString formatDuration(qint64 ms)
|
||||
{
|
||||
return QStringLiteral("%1.%2 s").arg(ms / 1000).arg((ms % 1000) / 100);
|
||||
}
|
||||
|
||||
static bool likelyRedirects(const QString &urlTemplate)
|
||||
{
|
||||
return urlTemplate.contains(QStringLiteral("api.scryfall.com"));
|
||||
}
|
||||
|
||||
static QString hostOf(const QString &urlTemplate)
|
||||
{
|
||||
return QUrl(urlTemplate).host();
|
||||
}
|
||||
|
||||
static void printUsage()
|
||||
{
|
||||
std::printf("usage: picture_loader_benchmark_test --carddb <path> [options]\n"
|
||||
"\n"
|
||||
"Loads card pictures from the real configured hosts (not a mock server) and\n"
|
||||
"verifies the picture loader's pacing / cache 429 behavior.\n"
|
||||
"\n"
|
||||
"options:\n"
|
||||
" --carddb <path> cards.xml to load card data from (required)\n"
|
||||
" --count <N> cards to load per template (default 300)\n"
|
||||
" --url <template> test only this URL template; repeatable\n"
|
||||
" --stress run the two-worker concurrency stress instead\n"
|
||||
" --stress-url <t> template used by --stress (default: scryfall uuid)\n"
|
||||
" --timeout-min <N> per-pass watchdog in minutes (default auto)\n"
|
||||
" --cache-dir <dir> reuse this directory as the sandbox root; non-empty\n"
|
||||
" cache skips the cold pacing lower bound\n"
|
||||
" --help show this help\n");
|
||||
}
|
||||
|
||||
int main(int argc, char **argv)
|
||||
{
|
||||
QString cardDbArg;
|
||||
QStringList explicitUrls;
|
||||
int count = 300;
|
||||
bool stress = false;
|
||||
bool stressUrlSet = false;
|
||||
QString stressUrl(QStringLiteral("https://api.scryfall.com/cards/!set:uuid!?format=image"));
|
||||
QString cacheDirArg;
|
||||
std::optional<int> timeoutMin;
|
||||
|
||||
QStringList args;
|
||||
for (int i = 1; i < argc; ++i) {
|
||||
args.append(QString::fromLocal8Bit(argv[i]));
|
||||
}
|
||||
for (int i = 0; i < args.size(); ++i) {
|
||||
const QString &arg = args.at(i);
|
||||
const auto value = [&]() -> QString { return i + 1 < args.size() ? args.at(++i) : QString(); };
|
||||
if (arg == QLatin1String("--carddb")) {
|
||||
cardDbArg = value();
|
||||
} else if (arg == QLatin1String("--count")) {
|
||||
count = value().toInt();
|
||||
} else if (arg == QLatin1String("--url")) {
|
||||
explicitUrls.append(value());
|
||||
} else if (arg == QLatin1String("--stress")) {
|
||||
stress = true;
|
||||
} else if (arg == QLatin1String("--stress-url")) {
|
||||
stressUrl = value();
|
||||
stressUrlSet = true;
|
||||
} else if (arg == QLatin1String("--timeout-min")) {
|
||||
bool ok = false;
|
||||
const int parsed = value().toInt(&ok);
|
||||
if (!ok || parsed <= 0) {
|
||||
std::fprintf(stderr, "error: --timeout-min must be a positive integer\n");
|
||||
return 2;
|
||||
}
|
||||
timeoutMin = parsed;
|
||||
} else if (arg == QLatin1String("--cache-dir")) {
|
||||
cacheDirArg = value();
|
||||
} else if (arg == QLatin1String("--help") || arg == QLatin1String("-h")) {
|
||||
printUsage();
|
||||
return 0;
|
||||
} else {
|
||||
std::fprintf(stderr, "unknown argument: %s\n", qPrintable(arg));
|
||||
printUsage();
|
||||
return 2;
|
||||
}
|
||||
}
|
||||
|
||||
if (cardDbArg.isEmpty()) {
|
||||
std::fprintf(stderr, "error: --carddb is required (a cards.xml generated by Oracle)\n");
|
||||
printUsage();
|
||||
return 2;
|
||||
}
|
||||
if (count <= 0) {
|
||||
std::fprintf(stderr, "error: --count must be positive\n");
|
||||
return 2;
|
||||
}
|
||||
|
||||
// In --stress mode an explicit --url selects the template to hammer, matching --url's meaning
|
||||
// in the normal mode; only fall back to the built-in Scryfall template when neither --stress-url
|
||||
// nor --url was supplied.
|
||||
if (stress && !stressUrlSet && !explicitUrls.isEmpty()) {
|
||||
stressUrl = explicitUrls.first();
|
||||
}
|
||||
|
||||
QCoreApplication app(argc, argv);
|
||||
// Unique names so a benchmark run can never read or write the real client's settings, cache or
|
||||
// picture URLs on platforms where the XDG redirection below does not apply (macOS, Windows).
|
||||
app.setApplicationName(QStringLiteral("Cockatrice-benchmark"));
|
||||
app.setOrganizationName(QStringLiteral("Cockatrice-benchmark"));
|
||||
app.setApplicationVersion(QStringLiteral("9.0.0-benchmark"));
|
||||
|
||||
// The ExactCard argument of imageLoaded crosses threads via a queued connection.
|
||||
qRegisterMetaType<ExactCard>();
|
||||
|
||||
QTemporaryDir sandbox;
|
||||
if (cacheDirArg.isEmpty() && !sandbox.isValid()) {
|
||||
std::fprintf(stderr, "error: could not create a temporary sandbox directory\n");
|
||||
return 2;
|
||||
}
|
||||
const QString rootDir = cacheDirArg.isEmpty() ? sandbox.path() : cacheDirArg;
|
||||
QDir().mkpath(rootDir);
|
||||
QDir().mkpath(rootDir + "/config");
|
||||
QDir().mkpath(rootDir + "/data");
|
||||
QDir().mkpath(rootDir + "/cache");
|
||||
|
||||
#ifdef Q_OS_LINUX
|
||||
// Redirect every QStandardPaths lookup (and therefore SettingsCache paths) into the sandbox so
|
||||
// the benchmark never touches user config or caches. XDG_* only affects Qt's path resolution on
|
||||
// Linux; elsewhere the unique application/organization names above keep the run isolated.
|
||||
qputenv("XDG_CONFIG_HOME", (rootDir + "/config").toUtf8());
|
||||
qputenv("XDG_DATA_HOME", (rootDir + "/data").toUtf8());
|
||||
qputenv("XDG_CACHE_HOME", (rootDir + "/cache").toUtf8());
|
||||
#endif
|
||||
|
||||
// Derive the probe from SettingsCache rather than reconstructing it: Qt appends both the
|
||||
// organization and the application name, so a hand-built path is easy to get wrong.
|
||||
const bool warmStart = QDir(SettingsCache::instance().getNetworkCachePath())
|
||||
.entryList(QDir::Files | QDir::AllDirs | QDir::NoDotAndDotDot, QDir::Name)
|
||||
.size() > 0;
|
||||
|
||||
// Copied into the sandbox so the loader's binary cache ("cards.xml.cache")
|
||||
// is written next to it instead of next to the user's file, and so a
|
||||
// --cache-dir rerun can pick it up again.
|
||||
const QString dataPath = SettingsCache::instance().getDataPath();
|
||||
QDir().mkpath(dataPath);
|
||||
const QString cardsXml = dataPath + "/cards.xml";
|
||||
if (!QFile::exists(cardsXml)) {
|
||||
if (!QFile::copy(cardDbArg, cardsXml)) {
|
||||
std::fprintf(stderr, "error: could not copy %s to sandbox\n", qPrintable(cardDbArg));
|
||||
return 2;
|
||||
}
|
||||
}
|
||||
const QString customSetsDir = dataPath + "/customsets";
|
||||
QDir().mkpath(customSetsDir);
|
||||
|
||||
auto *prefs = new NoopCardPreferenceProvider();
|
||||
auto *priorityController = new NoopCardSetPriorityController();
|
||||
auto *pathProvider = new BenchmarkCardDatabasePathProvider(cardsXml, customSetsDir);
|
||||
CardDatabase db(nullptr, prefs, pathProvider, priorityController);
|
||||
db.loadCardDatabases();
|
||||
if (db.getLoadStatus() != Ok || db.getCardList().isEmpty()) {
|
||||
std::fprintf(stderr, "error: failed to load card database from %s\n", qPrintable(cardsXml));
|
||||
return 1;
|
||||
}
|
||||
const int availableCards = db.getCardList().size();
|
||||
|
||||
const QStringList urlsToTest =
|
||||
explicitUrls.isEmpty() ? SettingsCache::instance().downloads().getAllURLs() : explicitUrls;
|
||||
|
||||
if (stress) {
|
||||
const QList<ExactCard> cards = selectCardsForTemplate(db, stressUrl, count);
|
||||
if (cards.isEmpty()) {
|
||||
std::fprintf(stderr, "error: no cards satisfy template %s\n", qPrintable(stressUrl));
|
||||
return 1;
|
||||
}
|
||||
SettingsCache::instance().downloads().setDownloadUrls({stressUrl});
|
||||
|
||||
std::printf("=== STRESS: 2 workers x %d cards, host %s ===\n", static_cast<int>(cards.size()),
|
||||
qPrintable(hostOf(stressUrl)));
|
||||
auto *workerA = new CardPictureLoaderWorker();
|
||||
auto *workerB = new CardPictureLoaderWorker();
|
||||
const int timeoutMs = (timeoutMin.has_value() ? timeoutMin.value() : 15) * 60 * 1000;
|
||||
const StressResult result = runStress(workerA, workerB, cards, timeoutMs);
|
||||
|
||||
const bool completeA = result.a.finished >= result.a.enqueued;
|
||||
const bool completeB = result.b.finished >= result.b.enqueued;
|
||||
const bool zeroFailures = result.a.failed == 0 && result.b.failed == 0;
|
||||
const bool pass = completeA && completeB && zeroFailures;
|
||||
|
||||
std::printf("worker A: %d/%d loaded, %d failed (%.2f images/s)\n", result.a.finished, result.a.enqueued,
|
||||
result.a.failed,
|
||||
result.a.elapsedMs > 0
|
||||
? static_cast<double>(result.a.finished) * 1000.0 / static_cast<double>(result.a.elapsedMs)
|
||||
: 0.0);
|
||||
std::printf("worker B: %d/%d loaded, %d failed (%.2f images/s)\n", result.b.finished, result.b.enqueued,
|
||||
result.b.failed,
|
||||
result.b.elapsedMs > 0
|
||||
? static_cast<double>(result.b.finished) * 1000.0 / static_cast<double>(result.b.elapsedMs)
|
||||
: 0.0);
|
||||
std::printf("429 responses observed: %d\n", result.http429Count);
|
||||
std::printf("elapsed: %s\n", qPrintable(formatDuration(result.a.elapsedMs)));
|
||||
if (result.a.failed > 0) {
|
||||
std::printf(" worker A failures: %s\n", qPrintable(result.a.failedCards.join(QStringLiteral(", "))));
|
||||
}
|
||||
if (result.b.failed > 0) {
|
||||
std::printf(" worker B failures: %s\n", qPrintable(result.b.failedCards.join(QStringLiteral(", "))));
|
||||
}
|
||||
std::printf("RESULT: %s\n", pass ? "PASS" : "FAIL");
|
||||
return pass ? 0 : 1;
|
||||
}
|
||||
|
||||
bool allPass = true;
|
||||
std::printf("=== PICTURE LOADER BENCHMARK (%d cards available, %d per template)%s ===\n", availableCards, count,
|
||||
warmStart ? ", WARM cache from previous run" : "");
|
||||
|
||||
for (const QString &urlTemplate : urlsToTest) {
|
||||
const QList<ExactCard> cards = selectCardsForTemplate(db, urlTemplate, count);
|
||||
if (cards.isEmpty()) {
|
||||
std::printf("SKIP %-22s %-52s (no cards satisfy the template)\n", qPrintable(hostOf(urlTemplate)),
|
||||
qPrintable(urlTemplate));
|
||||
continue;
|
||||
}
|
||||
SettingsCache::instance().downloads().setDownloadUrls({urlTemplate});
|
||||
|
||||
const bool redirects = likelyRedirects(urlTemplate);
|
||||
const qint64 perCardMs = redirects ? 200 : 100;
|
||||
const int timeoutMs =
|
||||
(timeoutMin.has_value() ? timeoutMin.value() : (cards.size() * perCardMs * 8 + 60000) / 60000) * 60 * 1000;
|
||||
const qint64 coldLowerMs = static_cast<qint64>(cards.size()) * perCardMs / 2;
|
||||
// Decoding and cache-reading scale with the card count, so a flat budget would spuriously
|
||||
// fail larger --count runs served entirely from a healthy cache.
|
||||
const qint64 cachedUpperMs = qMax<qint64>(2000, static_cast<qint64>(cards.size()) * 10);
|
||||
|
||||
// A fresh worker per pass: if the cold pass hits the watchdog, its outstanding cards stay
|
||||
// in the worker's currentlyLoading set, which would make the cached pass silently skip them
|
||||
// and burn its own watchdog; late cold replies would also be misattributed to the cached
|
||||
// pass.
|
||||
auto *coldWorker = new CardPictureLoaderWorker();
|
||||
const PassResult cold = runPass(coldWorker, cards, timeoutMs);
|
||||
destroyWorker(coldWorker);
|
||||
|
||||
auto *cachedWorker = new CardPictureLoaderWorker();
|
||||
const PassResult cached = runPass(cachedWorker, cards, timeoutMs);
|
||||
destroyWorker(cachedWorker);
|
||||
|
||||
const bool coldComplete = cold.finished >= cold.enqueued;
|
||||
const bool coldZeroFailures = cold.failed == 0;
|
||||
const bool coldPaced = warmStart || cold.elapsedMs >= coldLowerMs;
|
||||
const bool cachedComplete = cached.finished >= cached.enqueued;
|
||||
const bool cachedZeroFailures = cached.failed == 0;
|
||||
const bool cachedFast = cached.elapsedMs < cachedUpperMs;
|
||||
|
||||
const bool pass =
|
||||
coldComplete && coldZeroFailures && coldPaced && cachedComplete && cachedZeroFailures && cachedFast;
|
||||
allPass = allPass && pass;
|
||||
|
||||
std::printf("%s %-22s %-52s cold %s (paced>=%s) cached %s (must be <%.0fs) | %d/%d %d/%d loaded, "
|
||||
"%d/%d failed\n",
|
||||
pass ? "PASS " : "FAIL ", qPrintable(hostOf(urlTemplate)), qPrintable(urlTemplate),
|
||||
qPrintable(formatDuration(cold.elapsedMs)), qPrintable(formatDuration(coldLowerMs)),
|
||||
qPrintable(formatDuration(cached.elapsedMs)), static_cast<double>(cachedUpperMs) / 1000.0,
|
||||
cold.finished, cold.enqueued, cached.finished, cached.enqueued, cold.failed, cached.failed);
|
||||
if (cold.failed > 0) {
|
||||
std::printf(" cold failures: %s\n", qPrintable(cold.failedCards.join(QStringLiteral(", "))));
|
||||
}
|
||||
if (cached.failed > 0) {
|
||||
std::printf(" cached failures: %s\n", qPrintable(cached.failedCards.join(QStringLiteral(", "))));
|
||||
}
|
||||
}
|
||||
|
||||
if (cacheDirArg.isEmpty()) {
|
||||
std::printf("cache root: %s (temporary; pass --cache-dir <dir> to persist it for a warm rerun)\n",
|
||||
qPrintable(rootDir));
|
||||
} else {
|
||||
std::printf("cache root: %s\n", qPrintable(rootDir));
|
||||
}
|
||||
std::printf("RESULT: %s\n", allPass ? "PASS" : "FAIL");
|
||||
return allPass ? 0 : 1;
|
||||
}
|
||||
200
tests/picture_loader_benchmark/settings_cache_mock.cpp
Normal file
200
tests/picture_loader_benchmark/settings_cache_mock.cpp
Normal file
|
|
@ -0,0 +1,200 @@
|
|||
/*
|
||||
* Minimal SettingsCache implementation for the picture loader benchmark.
|
||||
*
|
||||
* The picture loader code insists on reading every URL, cache and path via
|
||||
* SettingsCache::instance(). Compiling the real client SettingsCache would drag
|
||||
* in the network update-checker graph, so instead we provide the SettingsCache
|
||||
* member functions it actually uses, backed by the real libcockatrice_settings
|
||||
* manager classes pointed at a sandboxed settings directory.
|
||||
*
|
||||
* The mock must be named SettingsCache: PathsSettings declares
|
||||
* `friend class SettingsCache`, which is the only way to construct it.
|
||||
*
|
||||
* Paths resolved through QStandardPaths are redirected into the sandbox by
|
||||
* setting the XDG_* environment variables before the first instance() call.
|
||||
*/
|
||||
|
||||
#include "client/settings/cache_settings.h"
|
||||
#include "interface/card_picture_loader/card_picture_loader_cache_method.h"
|
||||
|
||||
#include <QDir>
|
||||
#include <QFile>
|
||||
#include <QSettings>
|
||||
#include <QStandardPaths>
|
||||
#include <libcockatrice/settings/cache_storage_settings.h>
|
||||
#include <libcockatrice/settings/cards_display_settings.h>
|
||||
#include <libcockatrice/settings/download_settings.h>
|
||||
#include <libcockatrice/settings/paths_settings.h>
|
||||
#include <utility>
|
||||
|
||||
QString SettingsCache::getDataPath()
|
||||
{
|
||||
return QStandardPaths::writableLocation(QStandardPaths::AppLocalDataLocation);
|
||||
}
|
||||
|
||||
QString SettingsCache::getSettingsPath()
|
||||
{
|
||||
return getDataPath() + "/settings/";
|
||||
}
|
||||
|
||||
QString SettingsCache::getCachePath() const
|
||||
{
|
||||
return QStandardPaths::writableLocation(QStandardPaths::CacheLocation);
|
||||
}
|
||||
|
||||
QString SettingsCache::getNetworkCachePath() const
|
||||
{
|
||||
return getCachePath() + "/downloaded/";
|
||||
}
|
||||
|
||||
QString SettingsCache::getCustomCardDatabasePath() const
|
||||
{
|
||||
return paths().getCustomCardDatabasePath();
|
||||
}
|
||||
|
||||
QString SettingsCache::getCardDatabasePath() const
|
||||
{
|
||||
return paths().getCardDatabasePath();
|
||||
}
|
||||
|
||||
QString SettingsCache::getSpoilerCardDatabasePath() const
|
||||
{
|
||||
return paths().getSpoilerCardDatabasePath();
|
||||
}
|
||||
|
||||
QString SettingsCache::getTokenDatabasePath() const
|
||||
{
|
||||
return paths().getTokenDatabasePath();
|
||||
}
|
||||
|
||||
int SettingsCache::getKeepAlive() const
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
int SettingsCache::getTimeOut() const
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
bool SettingsCache::getNotifyAboutUpdates() const
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
void SettingsCache::setKnownMissingFeatures(const QString & /*_knownMissingFeatures*/)
|
||||
{
|
||||
}
|
||||
|
||||
QString SettingsCache::getKnownMissingFeatures()
|
||||
{
|
||||
return QString();
|
||||
}
|
||||
|
||||
QString SettingsCache::getClientID()
|
||||
{
|
||||
return QString();
|
||||
}
|
||||
|
||||
DownloadSettings &SettingsCache::downloads() const
|
||||
{
|
||||
return *downloadSettings;
|
||||
}
|
||||
|
||||
CacheStorageSettings &SettingsCache::cacheStorage() const
|
||||
{
|
||||
return *cacheStorageSettings;
|
||||
}
|
||||
|
||||
CardsDisplaySettings &SettingsCache::cardsDisplay() const
|
||||
{
|
||||
return *cardsDisplaySettings;
|
||||
}
|
||||
|
||||
PathsSettings &SettingsCache::paths() const
|
||||
{
|
||||
return *pathsSettings;
|
||||
}
|
||||
|
||||
SettingsCache::SettingsCache()
|
||||
{
|
||||
settings = nullptr;
|
||||
isPortableBuild = false;
|
||||
|
||||
const QString settingsPath = getSettingsPath();
|
||||
QDir().mkpath(settingsPath);
|
||||
|
||||
downloadSettings = new DownloadSettings(settingsPath, this);
|
||||
cacheStorageSettings = new CacheStorageSettings(settingsPath, this);
|
||||
cardsDisplaySettings = new CardsDisplaySettings(settingsPath, this);
|
||||
pathsSettings = new PathsSettings(settingsPath, this);
|
||||
|
||||
// Picture downloads enabled, default host list, network disk cache storage.
|
||||
downloadSettings->setPicDownload(true);
|
||||
downloadSettings->resetToDefaultURLs();
|
||||
cacheStorageSettings->setCardImageCacheMethod(
|
||||
static_cast<int>(CardPictureLoaderCacheMethod::CacheMethod::NETWORK_CACHE));
|
||||
|
||||
loadPaths();
|
||||
}
|
||||
|
||||
void SettingsCache::loadPaths()
|
||||
{
|
||||
QString dataPath = getDataPath();
|
||||
QSettings pathsIni(getSettingsPath() + "paths.ini", QSettings::IniFormat);
|
||||
|
||||
auto computePath = [&](const QString &key, const QString &defaultPath) -> QString {
|
||||
QString val = pathsIni.value("paths/" + key).toString();
|
||||
if (val.isEmpty() || !QDir(val).exists()) {
|
||||
if (!QDir().mkpath(defaultPath)) {
|
||||
qCInfo(SettingsCacheLog) << "[SettingsCache] Could not create folder:" << defaultPath;
|
||||
}
|
||||
val = defaultPath;
|
||||
pathsIni.setValue("paths/" + key, val);
|
||||
}
|
||||
return val;
|
||||
};
|
||||
|
||||
auto computeFilePath = [&](const QString &key, const QString &defaultPath) -> QString {
|
||||
QString val = pathsIni.value("paths/" + key).toString();
|
||||
if (!QFile::exists(val) || val.isEmpty()) {
|
||||
val = defaultPath;
|
||||
pathsIni.setValue("paths/" + key, val);
|
||||
}
|
||||
return val;
|
||||
};
|
||||
|
||||
computePath("decks", dataPath + "/decks/");
|
||||
computePath("filters", dataPath + "/filters/");
|
||||
computePath("replays", dataPath + "/replays/");
|
||||
computePath("themes", dataPath + "/themes/");
|
||||
computePath("pics", dataPath + "/pics/");
|
||||
computePath("redirects", getCachePath() + "/redirects/");
|
||||
|
||||
// customPicsPath derived from picsPath
|
||||
QString picsPath = pathsIni.value("paths/pics").toString();
|
||||
if (picsPath.endsWith("/")) {
|
||||
computePath("customPics", picsPath + "CUSTOM/");
|
||||
} else {
|
||||
computePath("customPics", picsPath + "/CUSTOM/");
|
||||
}
|
||||
|
||||
computePath("customSets", dataPath + "/customsets/");
|
||||
computeFilePath("cardDatabase", dataPath + "/cards.xml");
|
||||
computeFilePath("tokenDatabase", dataPath + "/tokens.xml");
|
||||
computeFilePath("spoilerDatabase", dataPath + "/spoiler.xml");
|
||||
}
|
||||
|
||||
void SettingsCache::setThemeName(const QString &_themeName)
|
||||
{
|
||||
if (themeName != _themeName) {
|
||||
themeName = _themeName;
|
||||
emit themeChanged();
|
||||
}
|
||||
}
|
||||
|
||||
SettingsCache &SettingsCache::instance()
|
||||
{
|
||||
static SettingsCache settingsCache;
|
||||
return settingsCache;
|
||||
}
|
||||
|
|
@ -334,6 +334,38 @@ TEST_F(SettingsDefaultsTest, Download_DownloadSpoilersStatus_Default)
|
|||
ASSERT_EQ(s.getDownloadSpoilersStatus(), false);
|
||||
}
|
||||
|
||||
TEST_F(SettingsDefaultsTest, Download_HostRequestLimits_Default)
|
||||
{
|
||||
DownloadSettings s(settingsPath, nullptr);
|
||||
ASSERT_TRUE(s.getHostRequestLimits().isEmpty());
|
||||
}
|
||||
|
||||
TEST_F(SettingsDefaultsTest, Download_HostRequestLimits_SetAndGet)
|
||||
{
|
||||
DownloadSettings s(settingsPath, nullptr);
|
||||
s.setHostRequestLimits({{"api.scryfall.com", 5}});
|
||||
const QHash<QString, int> limits = s.getHostRequestLimits();
|
||||
ASSERT_EQ(limits.size(), 1);
|
||||
ASSERT_EQ(limits.value("api.scryfall.com"), 5);
|
||||
}
|
||||
|
||||
TEST_F(SettingsDefaultsTest, Download_HostRequestLimits_StackedHostCaps)
|
||||
{
|
||||
DownloadSettings s(settingsPath, nullptr);
|
||||
// The developer cap for the Scryfall API lowers the ceiling to 9; a user can
|
||||
// reduce it further but can never raise it above the cap.
|
||||
ASSERT_EQ(s.clampHostRequestLimit("api.scryfall.com", 9), 9);
|
||||
ASSERT_EQ(s.clampHostRequestLimit("api.scryfall.com", 20), 9);
|
||||
ASSERT_EQ(s.clampHostRequestLimit("api.scryfall.com", 5), 5);
|
||||
ASSERT_EQ(s.clampHostRequestLimit("api.scryfall.com", 0), 1);
|
||||
// Hosts without a developer cap fall back to the global default ceiling.
|
||||
ASSERT_EQ(s.clampHostRequestLimit("gatherer.wizards.com", 10), 10);
|
||||
ASSERT_EQ(s.clampHostRequestLimit("gatherer.wizards.com", 20), 10);
|
||||
// The Scryfall CDN is unlocked: no upper bound (values are only floored).
|
||||
ASSERT_EQ(s.clampHostRequestLimit("cards.scryfall.io", 20), 20);
|
||||
ASSERT_EQ(s.clampHostRequestLimit("cards.scryfall.io", 0), 1);
|
||||
}
|
||||
|
||||
// --- AppearanceSettings ---
|
||||
|
||||
TEST_F(SettingsDefaultsTest, Appearance_ThemeName_Default)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue