Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check if dandiset contains zarr assets using asset list endpoint #2170

Merged
merged 3 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions dandiapi/api/tests/test_asset.py
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,35 @@ def test_asset_rest_list_include_metadata(api_client, version, asset, asset_fact
assert r.json()['results'][0]['metadata'] == asset.full_metadata


@pytest.mark.django_db
def test_asset_rest_list_zarr_only(
api_client, draft_version, draft_asset_factory, zarr_archive_factory
):
# Create two blob assets and one zarr asset
zarr_asset = draft_asset_factory(
blob=None, zarr=zarr_archive_factory(dandiset=draft_version.dandiset)
)
draft_version.assets.add(zarr_asset)
draft_version.assets.add(draft_asset_factory())
draft_version.assets.add(draft_asset_factory())

# Assert missing and false both return all assets
ident = draft_version.dandiset.identifier
ver = draft_version.version
assert api_client.get(f'/api/dandisets/{ident}/versions/{ver}/assets/').json()['count'] == 3
assert (
api_client.get(f'/api/dandisets/{ident}/versions/{ver}/assets/', {'zarr': False}).json()[
'count'
]
== 3
)

# Test positive case
r = api_client.get(f'/api/dandisets/{ident}/versions/{ver}/assets/', {'zarr': True}).json()
assert r['count'] == 1
assert r['results'][0]['asset_id'] == str(zarr_asset.asset_id)


@pytest.mark.parametrize(
('path', 'result_indices'),
[
Expand Down
5 changes: 5 additions & 0 deletions dandiapi/api/views/asset.py
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,11 @@ def list(self, request, *args, **kwargs):
# Apply filtering from included filter class first
asset_queryset = self.filter_queryset(version.assets.all())

# Filter query to only zarr assets, if requested
zarr_only = serializer.validated_data['zarr']
if zarr_only:
asset_queryset = asset_queryset.filter(zarr__isnull=False)

# Must do glob pattern matching before pagination
glob_pattern: str | None = serializer.validated_data.get('glob')
if glob_pattern is not None:
Expand Down
1 change: 1 addition & 0 deletions dandiapi/api/views/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ class Meta(AssetSerializer.Meta):
class AssetListSerializer(serializers.Serializer):
glob = serializers.CharField(required=False)
metadata = serializers.BooleanField(required=False, default=False)
zarr = serializers.BooleanField(required=False, default=False)


class AssetPathsQueryParameterSerializer(serializers.Serializer):
Expand Down
14 changes: 9 additions & 5 deletions web/src/views/DandisetLandingView/DandisetPublish.vue
Original file line number Diff line number Diff line change
Expand Up @@ -305,11 +305,15 @@ const alreadyBeingPublishedError = ref(false);
const containsZarr = ref(false);
watchEffect(async () => {
if (currentDandiset.value) {
const zarr = await dandiRest.zarr({
dandiset: currentDandiset.value.dandiset.identifier,
});

containsZarr.value = zarr.count > 0;
const { identifier } = currentDandiset.value.dandiset;
const { version } = currentDandiset.value;
const res = await dandiRest.assets(
identifier,
version,
{ params: { zarr: true, page_size: 1 } },
);

containsZarr.value = res !== null && res.count > 0;
}
});

Expand Down