feat(indexd): add check-download verification of registered objects - #6
Merged
Conversation
Registration alone does not prove a file can be downloaded. Two failure modes stay invisible until a user clicks the file in the portal: an Indexd record with no storage URL, which can never download, and a record Fence refuses to sign a URL for — in one prod incident the API key's user held create but not read-storage on the record's authz resource, so every signed-URL request returned 401 while everything else looked healthy. check-download walks the exact chain the portal hits (Indexd record -> storage URLs -> DRS object -> access methods -> Fence signed URL) and reports PASS/FAIL per object. It exits non-zero on any failure, so it can gate deployment steps. The env selects the API key secret and the key's JWT selects the commons, so no URL is passed and Gen3Auth is constructed without an endpoint — avoiding the WTS fallback that surfaces as a misleading 502. With no GUIDs given, the newest objects are sampled from the indexd registry (latest revision per baseid, scoped to the commons via indexd_endpoint).
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
1 participant
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.
Supersedes #3 (auto-closed when its stacked base merged). Now that #1 is in main, the diff is just this PR's own commit.
Walks Indexd → storage URLs → DRS object → access methods → Fence signed URL for sampled (or explicit) GUIDs and exits non-zero on any failure, so it can gate a deployment step. Catches the two failure modes invisible to every other check: a record with no storage URL, and a record Fence refuses to sign — the production incident where the API key's user held
createbut notread-storage, so every registered object 401'd at the signed-URL step. Sampling is scoped byindexd_endpointso a prod check can never sample staging registrations. README gains the 404/empty-urls/401/500 interpretation table.324 tests pass.