add @JsonIgnore annotation to codec name fields for serialization

brokkoli71 · brokkoli71 · commit a2ffa6bb84b2 · 2025-11-10T13:53:57.000+01:00
diff --git a/src/main/java/dev/zarr/zarrjava/v3/ArrayMetadataBuilder.java b/src/main/java/dev/zarr/zarrjava/v3/ArrayMetadataBuilder.java
@@ -73,6 +73,12 @@ public ArrayMetadataBuilder withDefaultChunkKeyEncoding(Separator separator) {
     return this;
   }
 
+    public ArrayMetadataBuilder withDefaultChunkKeyEncoding() {
+        this.chunkKeyEncoding = new DefaultChunkKeyEncoding(
+            new DefaultChunkKeyEncoding.Configuration(Separator.SLASH));
+        return this;
+    }
+
   public ArrayMetadataBuilder withDefaultChunkKeyEncoding(String separator) {
     this.chunkKeyEncoding =
         new DefaultChunkKeyEncoding(
@@ -85,6 +91,12 @@ public ArrayMetadataBuilder withV2ChunkKeyEncoding(Separator separator) {
     return this;
   }
 
+  public ArrayMetadataBuilder withV2ChunkKeyEncoding() {
+    this.chunkKeyEncoding = new V2ChunkKeyEncoding(
+        new V2ChunkKeyEncoding.Configuration(Separator.DOT));
+    return this;
+  }
+
   public ArrayMetadataBuilder withV2ChunkKeyEncoding(String separator) {
     this.chunkKeyEncoding =
         new V2ChunkKeyEncoding(new V2ChunkKeyEncoding.Configuration(Separator.valueOf(separator)));
diff --git a/src/main/java/dev/zarr/zarrjava/v3/chunkgrid/RegularChunkGrid.java b/src/main/java/dev/zarr/zarrjava/v3/chunkgrid/RegularChunkGrid.java
@@ -1,12 +1,14 @@
 package dev.zarr.zarrjava.v3.chunkgrid;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import javax.annotation.Nonnull;
 
 
 public class RegularChunkGrid extends ChunkGrid {
 
+  @JsonIgnore
   public final String name = "regular";
   @Nonnull
   public final Configuration configuration;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/chunkkeyencoding/DefaultChunkKeyEncoding.java b/src/main/java/dev/zarr/zarrjava/v3/chunkkeyencoding/DefaultChunkKeyEncoding.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.chunkkeyencoding;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import dev.zarr.zarrjava.core.chunkkeyencoding.Separator;
 
@@ -11,6 +12,7 @@
 
 public class DefaultChunkKeyEncoding extends ChunkKeyEncoding {
 
+  @JsonIgnore
   public final String name = "default";
   @Nonnull
   public final Configuration configuration;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/chunkkeyencoding/V2ChunkKeyEncoding.java b/src/main/java/dev/zarr/zarrjava/v3/chunkkeyencoding/V2ChunkKeyEncoding.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.chunkkeyencoding;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import dev.zarr.zarrjava.core.chunkkeyencoding.Separator;
 
@@ -11,6 +12,7 @@
 
 public class V2ChunkKeyEncoding extends ChunkKeyEncoding {
 
+  @JsonIgnore
   public final String name = "v2";
   @Nonnull
   public final Configuration configuration;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/BloscCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/BloscCodec.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.codec.core;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParseException;
@@ -23,6 +24,7 @@
 
 public class BloscCodec extends dev.zarr.zarrjava.core.codec.core.BloscCodec implements Codec{
 
+  @JsonIgnore
   public final String name = "blosc";
   @Nonnull
   public final Configuration configuration;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/BytesCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/BytesCodec.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.codec.core;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import dev.zarr.zarrjava.ZarrException;
@@ -14,6 +15,7 @@
 @JsonInclude(JsonInclude.Include.NON_NULL)
 public class BytesCodec extends dev.zarr.zarrjava.core.codec.core.BytesCodec implements Codec {
 
+  @JsonIgnore
   public final String name = "bytes";
   @Nullable
   public final Configuration configuration;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/Crc32cCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/Crc32cCodec.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.codec.core;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.v3.codec.Codec;
 import dev.zarr.zarrjava.utils.CRC32C;
@@ -12,6 +13,7 @@
 
 public class Crc32cCodec extends  BytesBytesCodec implements Codec {
 
+  @JsonIgnore
   public final String name = "crc32c";
 
   @JsonCreator
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/GzipCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/GzipCodec.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.codec.core;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.v3.codec.Codec;
@@ -17,6 +18,7 @@
 
 public class GzipCodec extends BytesBytesCodec implements Codec {
 
+  @JsonIgnore
   public final String name = "gzip";
   @Nonnull
   public final Configuration configuration;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/ShardingIndexedCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/ShardingIndexedCodec.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.codec.core;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.store.StoreHandle;
@@ -24,6 +25,7 @@
 
 public class ShardingIndexedCodec extends ArrayBytesCodec.WithPartialDecode implements Codec {
 
+  @JsonIgnore
   public final String name = "sharding_indexed";
   @Nonnull
   public final Configuration configuration;
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/TransposeCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/TransposeCodec.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.codec.core;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import dev.zarr.zarrjava.ZarrException;
 import dev.zarr.zarrjava.v3.codec.Codec;
@@ -16,6 +17,7 @@
 
 public class TransposeCodec extends ArrayArrayCodec implements Codec{
 
+    @JsonIgnore
     @Nonnull
     public final String name = "transpose";
     @Nonnull
diff --git a/src/main/java/dev/zarr/zarrjava/v3/codec/core/ZstdCodec.java b/src/main/java/dev/zarr/zarrjava/v3/codec/core/ZstdCodec.java
@@ -1,6 +1,7 @@
 package dev.zarr.zarrjava.v3.codec.core;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.github.luben.zstd.Zstd;
 import com.github.luben.zstd.ZstdCompressCtx;
@@ -14,6 +15,7 @@
 
 public class ZstdCodec extends BytesBytesCodec implements Codec {
 
+    @JsonIgnore
     public final String name = "zstd";
     @Nonnull
     public final Configuration configuration;
diff --git a/src/test/java/dev/zarr/zarrjava/ZarrV3Test.java b/src/test/java/dev/zarr/zarrjava/ZarrV3Test.java
@@ -552,22 +552,6 @@ public void testCreateArray() throws ZarrException, IOException {
         Assertions.assertTrue(Files.exists(Paths.get(storeHandleString).resolve("zarr.json")));
     }
 
-    @Test
-    public void testZarrJsonFormat() throws ZarrException, IOException {
-        // regression test: ensure that 'name' keyword of named configurations (e.g. codecs) are only written once.
-        StoreHandle storeHandle = new FilesystemStore(TESTOUTPUT).resolve("testZarrJsonFormatV3");
-        Array.create(storeHandle, Array.metadataBuilder()
-            .withShape(10, 10)
-            .withDataType(DataType.UINT8)
-            .withChunkShape(5, 5)
-            .build());
-
-        try (BufferedReader reader = Files.newBufferedReader(storeHandle.resolve("zarr.json").toPath())) {
-            String jsonInString = reader.lines().collect(Collectors.joining(System.lineSeparator()));
-            JsonNode JSON = new ObjectMapper().readTree(jsonInString);
-            Assertions.assertEquals(JSON.toPrettyString(), jsonInString);
-        }
-    }
 
     @Test
     public void testCreateGroup() throws ZarrException, IOException {
@@ -604,13 +588,46 @@ public void testCodecWithoutConfiguration() throws ZarrException, IOException {
         Codec bytesCodec = array.metadata().codecs[0];
         Assertions.assertInstanceOf(BytesCodec.class, bytesCodec);
         Assertions.assertNull(((BytesCodec) bytesCodec).configuration);
-        // further todo: remove redundant "name" attribute from codec metadata serialization
     }
 
-    @Test
-    public void testParseZarrJson(){
+    static Stream<Function<CodecBuilder, CodecBuilder>> codecBuilders() {
+        return Stream.of(
+                CodecBuilder::withBlosc,
+                c -> c.withTranspose(new int[]{1, 0}),
+                CodecBuilder::withBytes,
+                CodecBuilder::withGzip,
+                CodecBuilder::withZstd,
+                c -> c.withSharding(new int[]{2, 2}),
+                CodecBuilder::withCrc32c
+        );
+    }
+    static Stream<Function<ArrayMetadataBuilder, ArrayMetadataBuilder>> chunkKeyEncodingsAndCodecs() {
+        Stream<Function<ArrayMetadataBuilder, ArrayMetadataBuilder>> builders = Stream.of(
+                ArrayMetadataBuilder::withDefaultChunkKeyEncoding,
+                ArrayMetadataBuilder::withV2ChunkKeyEncoding
+        );
 
+        return Stream.concat(builders, codecBuilders().map(codecFunc -> b -> b.withCodecs(codecFunc)));
+    }
 
 
+    @ParameterizedTest
+    @MethodSource("chunkKeyEncodingsAndCodecs")
+    public void testZarrJsonFormat(Function<ArrayMetadataBuilder, ArrayMetadataBuilder> chunkKeyEncodingsAndCodecs) throws ZarrException, IOException {
+        // regression test: ensure that 'name' keyword of named configurations (e.g. codecs) are only written once.
+        StoreHandle storeHandle = new FilesystemStore(TESTOUTPUT).resolve("testZarrJsonFormatV3").resolve(String.valueOf(chunkKeyEncodingsAndCodecs.hashCode()));
+        ArrayMetadataBuilder builder = Array.metadataBuilder()
+                .withShape(10, 10)
+                .withDataType(DataType.UINT8)
+                .withChunkShape(6, 6);
+        builder = chunkKeyEncodingsAndCodecs.apply(builder);
+
+        Array.create(storeHandle, builder.build());
+
+        try (BufferedReader reader = Files.newBufferedReader(storeHandle.resolve("zarr.json").toPath())) {
+            String jsonInString = reader.lines().collect(Collectors.joining(System.lineSeparator()));
+            JsonNode JSON = new ObjectMapper().readTree(jsonInString);
+            Assertions.assertEquals(JSON.toPrettyString(), jsonInString);
+        }
     }
 }
