Repository navigation
Viewer: explain why a recording has no interactive view - #116
Merged
Merged
Conversation
When a recording cannot be shown, surface the producer-supplied reason
instead of a generic 'not available'. The Zarr index now carries a
failures array ({path, code, reason}) for recordings that could not be
converted for a reason that is a property of the data (a trial-averaged/
epoched derivative, a corrupt/truncated file, an unsupported format);
transient/infra failures are not listed, so an absent recording is simply
still generating.
- zarr-index: parse the optional failures array (back-compatible with
older indexes); zarrFailureReasonByPath maps path + .zarr path -> reason.
- dataset/[id]: annotate each signal row with data-zarr-failure-reason and
show it (and as the row title) when the recording has no store.
- eeg-viewer: ViewerOptions.failureReason + renderUnavailable shows it.
582 tests pass (3 new), typecheck + biome clean.
Deploying nemar-website with
|
| Latest commit: |
eb9828c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b7853a16.nemar-website.pages.dev |
| Branch Preview URL: | https://feat-viewer-failure-reason.nemar-website.pages.dev |
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.
Why
When a recording has no Zarr serving store, the viewer shows a generic "No interactive viewer is available for this recording yet." This surfaces the producer-supplied reason instead — e.g. "This file is a trial-averaged or epoched derivative, not a continuous recording, so the time-series viewer is not available."
Phase 3 of a 3-part change. The producer (
nemarDatasets/.github#48) writes afailuresarray intoindex.json, sourced from biosigIO 1.1.7's typed errors:Only data failures (derivative / corrupt / unsupported) are listed; transient/infra failures are not — so a recording absent from both
storesandfailuresis simply still generating and keeps the existing "may still be generating" copy.What
zarr-index.ts: parse the optionalfailuresarray (back-compatible — older indexes →[]);zarrFailureReasonByPath()maps both the BIDS path and the.zarrpath → reason.dataset/[id].astro: each signal row getsdata-zarr-failure-reason(+ matchingtitle); the no-store click branch shows the reason with a download link.eeg-viewer/viewer.ts:ViewerOptions.failureReason+renderUnavailable()prefers it (defensive, for a listed store that fails to open at runtime).Reason text is single-sourced from the producer (biosigIO
REASONS); the website just displays it.Tests
3 new (failures parsing + legacy-absent tolerance;
zarrFailureReasonByPathpath/.zarr keys + reasonless skip). 582 tests pass,astro check0 errors, biome clean.Depends on the producer side (
.github#48, merged) and biosigIO 1.1.7 (released).