jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-09-21 17:15:09 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[Oracle/Client] Report card database download progress (#7253)
Some checks failed
CodeQL / Analyze (cpp) (push) Has been cancelled
Details
CodeQL / Analyze (actions) (push) Has been cancelled
Details
Build Desktop / Configure (push) Has been cancelled
Details
Build Docker / Servatrice (arm) (push) Has been cancelled
Details
Build Docker / Servatrice (x86) (push) Has been cancelled
Details
Build Desktop / Debian 13 (push) Has been cancelled
Details
Build Desktop / Debian 12 (push) Has been cancelled
Details
Build Desktop / Fedora 44 (push) Has been cancelled
Details
Build Desktop / Fedora 43 (push) Has been cancelled
Details
Build Desktop / Servatrice_Debian 12 (push) Has been cancelled
Details
Build Desktop / Ubuntu 26.04 (push) Has been cancelled
Details
Build Desktop / Ubuntu 24.04 (push) Has been cancelled
Details
Build Desktop / Arch (push) Has been cancelled
Details
Build Desktop / macOS 13 Intel (push) Has been cancelled
Details
Build Desktop / macOS 14 (push) Has been cancelled
Details
Build Desktop / macOS 15 (push) Has been cancelled
Details
Build Desktop / macOS 26 Debug (push) Has been cancelled
Details
Build Desktop / Windows 10 (push) Has been cancelled
Details
Build Docker / Publish multi-platform Servatrice image (push) Has been cancelled
Details

Browse source 
* [Oracle/Client] Report card database download progress

Card database updates ran invisibly: MTGJSON parsing spun an indeterminate
bar on the UI thread and the set import blocked the window, while the
onboarding wizard spawned `oracle -b` with no progress to show at all.

- Add byte-level scan progress to `RawJson::scanSetRanges` via an optional
  callback, throttled to ~100 reports per scan.
- Emit `OracleImporter::dataReadProgress` during the scan and import sets on a
  worker thread, driving the wizard's progress bar per set.
- With `-b`, write machine-readable `PROGRESS <stage> <done> <total>` lines to
  stdout for the download/scan/import stages; stderr keeps the log output.
- Parse the oracle stdout in `MainWindow` and forward it to the onboarding
  wizard, giving the card database step a determinate bar with stage-specific
  status text.
- Guard the async workers against the wizard being closed mid-run.
- Add Google Test coverage for scan progress reporting.

* [Oracle/Client] Harden oracle progress workers and quit prompt

Address review feedback on the download-progress change: decompress and read
sets files off the UI thread, cancel the load/import workers before the
wizard can tear down the importer, and show an 'Extracting file...' status
plus a clean 100% tail so the poll never looks stuck. Quitting Cockatrice
while a card database update runs now asks for confirmation.

* Show 100% for 500ms on complete.

* Disable buttons on set import until done.

* Clean up progress bar.

* Drop wrapper around lambda

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>
This commit is contained in:
BruebachL 2026-09-09 22:27:16 +02:00 • committed by GitHub
parent 69e8f80fa1
commit 7d867b9745
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 821 additions and 197 deletions
Download patch file Download diff file Expand all files Collapse all files

184
oracle/src/raw_json_scanner.cpp
View file

@ -1,5 +1,6 @@
#include "raw_json_scanner.h"
#include <algorithm>
#include <cstring>
namespace
@ -11,6 +12,46 @@ namespace
// reason and reports DeepNesting).
constexpr int kMaxNestingDepth = 1024;
/**
* @brief Throttled byte-position reporting for scanSetRanges().
*
* Threaded through the skip walk so progress can be reported without materializing
* the whole document. Reports are rate-limited so a GUI showing progress isn't
* flooded with interrupts: a callback is invoked at most ~100 times per scan
* regardless of element count. The closing stretch (the last ~1%) is reported
* more finely so a large document doesn't stall the progress bar on the final
* percent before the scan wraps up.
*/
struct ScanProgress
{
const char *begin = nullptr;
qsizetype size = 0;
RawJson::ScanProgressCallback callback;
qsizetype step = 1;
qsizetype lastReported = 0;
/**
* @brief Reports the scanner's absolute offset, unless within @p step bytes
* of the previous report and not yet at the end of the document.
*/
void report(const char *p)
{
if (!callback) {
return;
}
const qsizetype offset = p - begin;
if (offset == lastReported) {
return; // the final element often already sits exactly at the end
}
const qsizetype reportingStep = offset >= size - step ? std::max<qsizetype>(1, step / 16) : step;
if (offset - lastReported < reportingStep && offset < size) {
return;
}
lastReported = offset;
callback(offset, size);
}
};
inline bool isWhitespace(char c)
{
return c == ' ' || c == '\t' || c == '\r' || c == '\n';
@ -296,9 +337,9 @@ bool skipNumber(const char *&p, const char *end)
return true;
}
bool skipValue(const char *&p, const char *end, int depth);
bool skipObject(const char *&p, const char *end, int depth);
bool skipArray(const char *&p, const char *end, int depth);
bool skipValue(const char *&p, const char *end, int depth, ScanProgress &scan);
bool skipObject(const char *&p, const char *end, int depth, ScanProgress &scan);
bool skipArray(const char *&p, const char *end, int depth, ScanProgress &scan);
bool skipPrimitive(const char *&p, const char *end)
{
@ -324,7 +365,7 @@ bool skipPrimitive(const char *&p, const char *end)
return false;
}
bool skipObject(const char *&p, const char *end, int depth)
bool skipObject(const char *&p, const char *end, int depth, ScanProgress &scan)
{
if (depth <= 0) {
return false; // nest deeper than the cap
@ -348,9 +389,10 @@ bool skipObject(const char *&p, const char *end, int depth)
return false;
}
++p;
if (!skipValue(p, end, depth - 1)) {
if (!skipValue(p, end, depth - 1, scan)) {
return false;
}
scan.report(p);
p = skipWhitespace(p, end);
if (p >= end) {
return false;
@ -367,7 +409,7 @@ bool skipObject(const char *&p, const char *end, int depth)
}
}
bool skipArray(const char *&p, const char *end, int depth)
bool skipArray(const char *&p, const char *end, int depth, ScanProgress &scan)
{
if (depth <= 0) {
return false; // nest deeper than the cap
@ -379,9 +421,10 @@ bool skipArray(const char *&p, const char *end, int depth)
return true;
}
for (;;) {
if (!skipValue(p, end, depth - 1)) {
if (!skipValue(p, end, depth - 1, scan)) {
return false;
}
scan.report(p);
p = skipWhitespace(p, end);
if (p >= end) {
return false;
@ -398,7 +441,7 @@ bool skipArray(const char *&p, const char *end, int depth)
}
}
bool skipValue(const char *&p, const char *end, int depth)
bool skipValue(const char *&p, const char *end, int depth, ScanProgress &scan)
{
p = skipWhitespace(p, end);
if (p >= end) {
@ -407,10 +450,10 @@ bool skipValue(const char *&p, const char *end, int depth)
const char c = *p;
if (c == '{') {
// pass depth through: skipObject consumes the single decrement for this level
return skipObject(p, end, depth);
return skipObject(p, end, depth, scan);
}
if (c == '[') {
return skipArray(p, end, depth);
return skipArray(p, end, depth, scan);
}
// a primitive is a leaf, so it never wastes a nesting level
return skipPrimitive(p, end);
@ -422,7 +465,8 @@ bool skipValue(const char *&p, const char *end, int depth)
* For each member invokes @p memberCallback with the key and the byte range of
* its value. Advancing @p p is unaffected by the callback.
*/
template <typename F> bool forEachObjectMember(const char *&p, const char *end, int depth, F &&memberCallback)
template <typename F>
bool forEachObjectMember(const char *&p, const char *end, int depth, F &&memberCallback, ScanProgress &scan)
{
if (depth <= 0) {
return false; // nest deeper than the cap
@ -449,7 +493,7 @@ template <typename F> bool forEachObjectMember(const char *&p, const char *end,
++p;
const char *valueStart = skipWhitespace(p, end);
const char *valueEnd = valueStart;
if (!skipValue(valueEnd, end, depth - 1)) {
if (!skipValue(valueEnd, end, depth - 1, scan)) {
return false;
}
if (!memberCallback(key, valueStart, valueEnd)) {
@ -473,7 +517,7 @@ template <typename F> bool forEachObjectMember(const char *&p, const char *end,
}
// Counts the direct elements of an array value; returns -1 if the array is malformed.
int countArrayElements(const char *p, const char *end, int depth)
int countArrayElements(const char *p, const char *end, int depth, ScanProgress &scan)
{
if (depth <= 0) {
return -1; // nest deeper than the cap
@ -485,9 +529,10 @@ int countArrayElements(const char *p, const char *end, int depth)
return 0;
}
for (;;) {
if (!skipValue(p, end, depth - 1)) {
if (!skipValue(p, end, depth - 1, scan)) {
return -1;
}
scan.report(p);
++count;
p = skipWhitespace(p, end);
if (p >= end) {
@ -509,7 +554,7 @@ int countArrayElements(const char *p, const char *end, int depth)
namespace RawJson
{
QList<SetRange> scanSetRanges(const QByteArray &json, ScanError *error)
QList<SetRange> scanSetRanges(const QByteArray &json, ScanError *error, const ScanProgressCallback &progress)
{
QList<SetRange> ranges;
if (error) {
@ -529,6 +574,14 @@ QList<SetRange> scanSetRanges(const QByteArray &json, ScanError *error)
return fail(QStringLiteral("empty JSON document"));
}
// Throttle reports to ~100 per scan so a GUI thread unthrottling them never
// drowns under per-card interrupts, whatever the document size.
ScanProgress scan;
scan.begin = begin;
scan.size = end - begin;
scan.step = std::max<qsizetype>(1, scan.size / 100);
scan.callback = progress;
const char *p = skipWhitespace(begin, end);
if (p >= end || *p != '{') {
return fail(QStringLiteral("top-level JSON must be an object"));
@ -545,55 +598,57 @@ QList<SetRange> scanSetRanges(const QByteArray &json, ScanError *error)
return false;
}
const char *setP = valueStart;
const bool ok = forEachObjectMember(setP, valueEnd, kMaxNestingDepth - 1,
[&](const QString &setCode, const char *setStart, const char *setEnd) {
if (setStart >= setEnd || *setStart != '{') {
malformedSetData = true;
return false;
}
SetRange range;
range.dataRange.start = setStart - begin;
range.dataRange.length = setEnd - setStart;
range.code = setCode;
const bool ok = forEachObjectMember(
setP, valueEnd, kMaxNestingDepth - 1,
[&](const QString &setCode, const char *setStart, const char *setEnd) {
if (setStart >= setEnd || *setStart != '{') {
malformedSetData = true;
return false;
}
SetRange range;
range.dataRange.start = setStart - begin;
range.dataRange.length = setEnd - setStart;
range.code = setCode;
const char *memberP = setStart;
const bool metaOk = forEachObjectMember(
memberP, setEnd, kMaxNestingDepth - 2,
[&](const QString &field, const char *fs, const char *fe) {
if (field == QStringLiteral("code")) {
return decodeStringMember(fs, fe, range.code);
}
if (field == QStringLiteral("name")) {
return decodeStringMember(fs, fe, range.name);
}
if (field == QStringLiteral("type")) {
return decodeStringMember(fs, fe, range.type);
}
if (field == QStringLiteral("releaseDate")) {
return decodeStringMember(fs, fe, range.releaseDate);
}
if (field == QStringLiteral("cards")) {
if (fs >= fe) {
return false;
}
if (*fs != '[') {
// e.g. "cards": null — treat as an empty array,
// matching Qt's tolerance.
return true;
}
range.dataRange.cardCount =
countArrayElements(fs, fe, kMaxNestingDepth - 2);
return range.dataRange.cardCount >= 0;
}
return true;
});
if (!metaOk) {
malformedSetData = true;
return false;
}
ranges.append(range);
return true;
});
const char *memberP = setStart;
const bool metaOk = forEachObjectMember(
memberP, setEnd, kMaxNestingDepth - 2,
[&](const QString &field, const char *fs, const char *fe) {
if (field == QStringLiteral("code")) {
return decodeStringMember(fs, fe, range.code);
}
if (field == QStringLiteral("name")) {
return decodeStringMember(fs, fe, range.name);
}
if (field == QStringLiteral("type")) {
return decodeStringMember(fs, fe, range.type);
}
if (field == QStringLiteral("releaseDate")) {
return decodeStringMember(fs, fe, range.releaseDate);
}
if (field == QStringLiteral("cards")) {
if (fs >= fe) {
return false;
}
if (*fs != '[') {
// e.g. "cards": null — treat as an empty array,
// matching Qt's tolerance.
return true;
}
range.dataRange.cardCount = countArrayElements(fs, fe, kMaxNestingDepth - 2, scan);
return range.dataRange.cardCount >= 0;
}
return true;
},
scan);
if (!metaOk) {
malformedSetData = true;
return false;
}
ranges.append(range);
return true;
},
scan);
if (!ok) {
malformedSetData = true;
return false;
@ -602,7 +657,7 @@ QList<SetRange> scanSetRanges(const QByteArray &json, ScanError *error)
return true;
};
if (!forEachObjectMember(p, end, kMaxNestingDepth, topLevelCallback)) {
if (!forEachObjectMember(p, end, kMaxNestingDepth, topLevelCallback, scan)) {
return fail(malformedSetData ? QStringLiteral("malformed set data") : QStringLiteral("malformed JSON"));
}
p = skipWhitespace(p, end);
@ -615,6 +670,7 @@ QList<SetRange> scanSetRanges(const QByteArray &json, ScanError *error)
if (ranges.isEmpty()) {
return fail(QStringLiteral("no sets found in \"data\""));
}
scan.report(end);
return ranges;
}