Fix bulk card image downloader to use Scryfall CDN - #10928
Open
phughk wants to merge 8 commits into
Open
Conversation
Contributor
Author
|
Uuid lookup is now code committed and can be run whenever. |
Contributor
Author
This was referenced Jun 9, 2026
phughk
force-pushed
the
fix-10413-card-image-downloader
branch
3 times, most recently
from
June 9, 2026 22:22
c1f6b16 to
e4dd5ad
Compare
Introduces CdnUuidCache which lazily loads res/cdn_uuid/{setCode}/{cn}.json
files and resolves CDN URLs (cards.scryfall.io, no rate limit) for card image
fetching. ImageFetcher and GuiDownloadFilteredCardImages prefer CDN URLs when
the asset files are present, falling back to the Scryfall API and then the
cardforge server as before.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
phughk
force-pushed
the
fix-10413-card-image-downloader
branch
from
June 9, 2026 22:34
e4dd5ad to
6430183
Compare
- Add package-private `cdnBaseDirOverride` and `clearCacheForTesting()` so tests can supply a temp directory without triggering ForgeConstants/GUI init - Switch ensureSetLoaded to use the override when set (production path unchanged) - Log DEBUG with absolute path when a set directory is not found, making path-resolution failures visible in runtime logs - Add CdnUuidCacheTest covering happy path, language fallback, DFC front/back, same-UUID DFC, missing set (MISSING_SET sentinel caching), missing collector number, null inputs, and set-code case normalisation (16 tests total, all pass) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Both SwingImageFetcher and LibGDXImageFetcher only applied the .full → .fullborder path transform for api.scryfall.com URLs. CDN URLs (cards.scryfall.io) were saved as .full.jpg, which the game's image display code doesn't find — causing repeated re-download attempts. Add URL_SCRYFALL_CDN constant to ForgeConstants and use it in both fetchers so CDN downloads are treated identically to API downloads for file-path purposes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
CdnUuidCache now loads per-set JSON from {cacheDir}/cdn_uuid/{set}.json.
On first lookup for a set the file is fetched from forge-extras (no rate
limit) and written to the local cache for all subsequent resolutions.
Returns null on any failure — callers fall back to the Scryfall API as before.
ForgeConstants: replace CDN_UUID_DIR (res/) with CACHE_CDN_UUID_DIR (cache/)
and FORGE_EXTRAS_CDN_UUID_URL.
Tests use localCacheDirOverride + remoteBaseUrlOverride (file:// in tests)
to verify the full local-hit and remote-fetch paths without network access.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
This PR has not been updated in a while nad has been marked on stale. Stale PRs will be auto closed |
Contributor
Author
|
Will tackle tonight or tomorrow night |
added 2 commits
July 28, 2026 08:34
- Request Accept-Encoding: gzip when fetching a set's UUID JSON from forge-extras; raw.githubusercontent.com honors it (~48% smaller on the wire for this UUID-heavy JSON), decompressed transparently. - Store the local disk cache gzip-compressed too (.json.gz), saving space for whichever sets a user actually triggers a lookup for. The files committed to forge-extras itself stay plain, sorted text — compressing those would turn every regeneration into a full binary rewrite instead of the minimal diff the CLI now produces. Verified against the live forge-extras branch: server returns Content-Encoding: gzip (110,709 bytes) and decompresses back to the full 214,541-byte file. All 17 CdnUuidCacheTest cases still pass.
tool4ever
reviewed
Jul 28, 2026
added 2 commits
July 29, 2026 11:33
…est API Addresses the Discord discussion on forge-owned vs. user-owned CDN data: this adds a user-triggered path that doesn't depend on forge-extras at all, alongside (not instead of) the existing hosted data. Scryfall's /cards/manifest endpoint returns just id/set/collector_number /lang per card -- everything this lookup needs -- in ~15k-entry pages, without the ~100MB-2.5GB cost of a full bulk-data export. English coverage is currently ~8 pages (~25-30MB). It doesn't expose the actual CDN image URL, so a double-faced card's back face is assumed to share the front's id; verified against live Scryfall data that this holds for the overwhelming majority of DFCs (the CDN URL only differs by a front/back path segment), and the existing CDN-miss fallback already covers the rare exceptions. ScryfallManifestSync paginates the manifest (respecting its documented 10/minute rate limit), and supports incremental resync: entries are requested newest-image-update-first, with a persisted per-language watermark so a repeat sync typically stops after one page instead of re-walking the whole catalog. CdnUuidCache gains mergeSetEntries() (fills gaps without ever overwriting existing entries -- forge-extras/CLI data can carry a double-faced card's real distinct front/back UUIDs, which a manifest- derived guess must not clobber) and a public clearCache(), covering the simpler "let users purge it from settings" alternative to per-file expiry that came up in the same discussion. Both actions are wired into the mobile card-image-download screen, which is where this whole feature already lives (desktop never exposed "Download Card Images" -- only mobile/CardImageBrowserScreen does). 10 new tests in ScryfallManifestSyncTest (embedded HTTP server, no live network dependency) cover pagination, the incremental watermark, the never-overwrite merge policy, and cache clearing; all 27 CDN-related tests pass together.
Addresses tool4ever's review comment on PR Card-Forge#10928: a single-method class wrapping a URL format string didn't warrant its own file. CdnUuidCache.getCdnUrl() was the only production caller, so cdnUrl() moves there as a public static method; test call sites updated to match, and ScryfallBulkDataTest's formula assertion is folded into CdnUuidCacheTest instead of being dropped.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Problem
Forge fetches card images by hitting
api.scryfall.com/cards/{set}/{cn}once per card. That endpoint is rate-limited. When many users run the game simultaneously, the flood of per-card requests causes Scryfall to return HTTP 429 errors and eventually block the application entirely — a problem reported on the PR thread in June 2026 and confirmed by Scryfall staff:Scryfall's own recommendation:
Solution
When a UUID is available for a card, skip the API call and fetch from the CDN directly. UUIDs are stored per-set in the forge-extras repository and fetched on demand at runtime.
flowchart LR A[Card needs image] --> B{Local set JSON\ncached?} B -- yes --> C{UUID found\nfor set/cn?} B -- no --> D[Fetch set JSON\nfrom forge-extras] D --> E[Write to local\ncache] E --> C C -- yes --> F[cards.scryfall.io CDN\nno rate limit] C -- no/stale --> G[api.scryfall.com\nrate-limited fallback] F --> H[Image saved] G --> HCDN URL formula (from Scryfall staff):
On-demand caching
The first lookup for any set (e.g.
neo) triggers a single HTTP GET to forge-extras forcdn_uuid/neo.json. That file is written to{cacheDir}/cdn_uuid/neo.jsonand used for all subsequent lookups in the same run and in future sessions — no re-download until the file is manually cleared.Sets released after the last forge-extras update have no JSON file —
getCdnUrlreturnsnulland the caller falls back to the API as before.Graceful fallback — CDN is always optional
CdnUuidCache.getCdnUrlreturnsnullin every failure case:In any of these cases the caller falls back to
api.scryfall.comexactly as before. No card ever fails to download because of a missing UUID.Language priority
The set JSON stores a UUID per language for each collector number. Selection order:
CardEdition.getCardsLangCode()) — e.g."ja"for Japanese reprints"en") fallback — used when the preferred language has no UUID on recordnull— when neither is present; caller falls back to the Scryfall API, which resolves language in the URL itselfChanges
forge-gui/…/download/CdnUuidCache.javacdn_uuid/{set}.jsonfrom forge-extras; caches locally in{cacheDir}/cdn_uuid/; maps (set, cn, lang) → UUIDforge-gui/…/download/ScryfallBulkData.javaforge-gui/…/util/ImageFetcher.javaaddScryfallUrl; API URL is fallbackforge-gui/…/download/GuiDownloadFilteredCardImages.javaforge-gui-desktop/…/util/SwingImageFetcher.java.fullborder.jpgpath transformforge-gui-mobile/…/util/LibGDXImageFetcher.javaforge-gui/…/properties/ForgeConstants.javaCACHE_CDN_UUID_DIRandFORGE_EXTRAS_CDN_UUID_URL; removesCDN_UUID_DIRforge-gui/pom.xmlUnit tests
CdnUuidCacheTest(17 tests, no GUI required, no network):ja→en)Depends on
forge-extras PR — the
cdn_uuid/*.jsonfiles must be present in the forge-extras repository. Without them every CDN lookup returnsnulland the API fallback is used; this PR is safe to merge independently.