Merge pull request #145 from LDeakin/v0.19/update_zarrs_metadata

chore(deps): bump `zarrs_metadata` to 0.3.4
LDeakin · Feb 13, 2025 · f3f102d · f3f102d
2 parents 9971787 + d717d2c
commit f3f102d
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 9 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,9 +2,9 @@ name: build
 
 on:
   push:
-    branches: ["main", "v[0-9]+.[0-9]+"]
+    branches: ["main", "v[0-9]+.[0-9]+.x"]
   pull_request:
-    branches: ["main", "v[0-9]+.[0-9]+"]
+    branches: ["main", "v[0-9]+.[0-9]+.x"]
 
 env:
   CARGO_TERM_COLOR: always

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+- Bump `zarrs_metadata` to 0.3.4 which includes a number of Zarr metadata fixes
+  - See the [`zarrs_metadata` CHANGELOG.md](https://github.com/LDeakin/zarrs/blob/main/zarrs_metadata/CHANGELOG.md)
+
 ## [0.19.1] - 2025-01-19
 
 ### Added

diff --git a/Cargo.toml b/Cargo.toml
@@ -27,8 +27,8 @@ missing_panics_doc = "warn"
 missing_errors_doc = "warn"
 
 [workspace.dependencies.zarrs_metadata]
-version = "0.3.0"
-path = "zarrs_metadata"
+version = "0.3.4"
+# path = "zarrs_metadata"
 
 [workspace.dependencies.zarrs_storage]
 version = "0.3.0"

diff --git a/zarrs/src/array.rs b/zarrs/src/array.rs
@@ -89,6 +89,7 @@ pub use chunk_cache::{
 pub use array_sharded_ext::ArrayShardedExt;
 #[cfg(feature = "sharding")]
 pub use array_sync_sharded_readable_ext::{ArrayShardedReadableExt, ArrayShardedReadableExtCache};
+use zarrs_metadata::v3::UnsupportedAdditionalFieldError;
 // TODO: Add AsyncArrayShardedReadableExt and AsyncArrayShardedReadableExtCache
 
 use crate::{
@@ -394,6 +395,20 @@ impl<TStorage: ?Sized> Array<TStorage> {
                 .map_err(|err| ArrayCreateError::UnsupportedZarrV2Array(err.to_string())),
         }?;
 
+        // Check for unsupported additional fields that must be understood
+        if let Some(unsupported_additional_field) = metadata_v3
+            .additional_fields
+            .iter()
+            .find(|additional_field| additional_field.1.must_understand())
+        {
+            return Err(ArrayCreateError::UnsupportedAdditionalFieldError(
+                UnsupportedAdditionalFieldError::new(
+                    unsupported_additional_field.0.clone(),
+                    unsupported_additional_field.1.as_value().clone(),
+                ),
+            ));
+        }
+
         let data_type = DataType::from_metadata(&metadata_v3.data_type)
             .map_err(ArrayCreateError::DataTypeCreateError)?;
         let chunk_grid = ChunkGrid::from_metadata(&metadata_v3.chunk_grid)

diff --git a/zarrs/src/group.rs b/zarrs/src/group.rs
@@ -91,6 +91,23 @@ impl<TStorage: ?Sized> Group<TStorage> {
         path: &str,
         metadata: GroupMetadata,
     ) -> Result<Self, GroupCreateError> {
+        // Check for unsupported additional fields that must be understood
+        let additional_fields = match &metadata {
+            GroupMetadata::V2(metadata) => &metadata.additional_fields,
+            GroupMetadata::V3(metadata) => &metadata.additional_fields,
+        };
+        if let Some(unsupported_additional_field) = additional_fields
+            .iter()
+            .find(|additional_field| additional_field.1.must_understand())
+        {
+            return Err(GroupCreateError::UnsupportedAdditionalFieldError(
+                UnsupportedAdditionalFieldError::new(
+                    unsupported_additional_field.0.clone(),
+                    unsupported_additional_field.1.as_value().clone(),
+                ),
+            ));
+        }
+
         let path = NodePath::new(path)?;
         Ok(Self {
             storage,
@@ -754,8 +771,8 @@ mod tests {
     }
 
     #[test]
-    fn group_metadata_invalid_additional_field() {
-        let group_metadata = serde_json::from_str::<GroupMetadata>(
+    fn group_metadata_unknown_additional_field() {
+        let group_metadata = serde_json::from_str::<GroupMetadataV3>(
             r#"{
                 "zarr_format": 3,
                 "node_type": "group",
@@ -765,8 +782,14 @@ mod tests {
                 },
                 "unknown": "fail"
             }"#,
-        );
-        assert!(group_metadata.is_err());
+        )
+        .unwrap();
+        assert!(group_metadata.additional_fields.len() == 1);
+        assert!(group_metadata
+            .additional_fields
+            .get("unknown")
+            .unwrap()
+            .must_understand());
     }
 
     #[test]

diff --git a/zarrs/src/group/group_builder.rs b/zarrs/src/group/group_builder.rs
@@ -82,8 +82,12 @@ mod tests {
         attributes.insert("key".to_string(), "value".into());
         builder.attributes(attributes.clone());
 
+        let mut additional_field = serde_json::Map::new();
+        additional_field.insert("must_understand".to_string(), false.into());
+        // let additional_field =
+        //     zarrs_metadata::v3::AdditionalField::new(serde_json::Map::new(), false);
+
         let mut additional_fields = AdditionalFields::new();
-        let additional_field = serde_json::Map::new();
         additional_fields.insert("key".to_string(), additional_field.into());
         builder.additional_fields(additional_fields.clone());