add BufferedZipStore parameter flushOnWrite

Author: brokkoli71

src/main/java/dev/zarr/zarrjava/store/BufferedZipStore.java

@@ -25,6 +25,7 @@ public class BufferedZipStore implements Store, Store.ListableStore {
     private final StoreHandle underlyingStore;
     private final Store.ListableStore bufferStore;
     private String archiveComment;
+    private boolean flushOnWrite;
 
     private void writeBuffer() throws IOException{
         // create zip file bytes from buffer store and write to underlying store
@@ -147,17 +148,22 @@ private void loadBuffer() throws IOException{
         }
     }
 
-    public BufferedZipStore(@Nonnull StoreHandle underlyingStore, @Nonnull Store.ListableStore bufferStore, @Nullable String archiveComment) {
+    public BufferedZipStore(@Nonnull StoreHandle underlyingStore, @Nonnull Store.ListableStore bufferStore, @Nullable String archiveComment, boolean flushOnWrite) {
         this.underlyingStore = underlyingStore;
         this.bufferStore = bufferStore;
         this.archiveComment = archiveComment;
+        this.flushOnWrite = flushOnWrite;
         try {
             loadBuffer();
         } catch (IOException e) {
             throw new RuntimeException("Failed to load buffer from underlying store", e);
         }
     }
 
+    public BufferedZipStore(@Nonnull StoreHandle underlyingStore, @Nonnull Store.ListableStore bufferStore, @Nullable String archiveComment) {
+        this(underlyingStore, bufferStore, archiveComment, true);
+    }
+
     public BufferedZipStore(@Nonnull StoreHandle underlyingStore, @Nonnull Store.ListableStore bufferStore) {
         this(underlyingStore, bufferStore, null);
     }
@@ -186,6 +192,35 @@ public BufferedZipStore(@Nonnull String underlyingStorePath) {
         this(underlyingStorePath, null);
     }
 
+    public BufferedZipStore(@Nonnull StoreHandle underlyingStore, @Nonnull Store.ListableStore bufferStore, boolean flushOnWrite) {
+        this(underlyingStore, bufferStore, null, flushOnWrite);
+    }
+
+    public BufferedZipStore(@Nonnull StoreHandle underlyingStore, String archiveComment, boolean flushOnWrite) {
+        this(underlyingStore, new MemoryStore(), archiveComment, flushOnWrite);
+    }
+
+    public BufferedZipStore(@Nonnull StoreHandle underlyingStore, boolean flushOnWrite) {
+        this(underlyingStore, (String) null, flushOnWrite);
+    }
+
+    public BufferedZipStore(@Nonnull Path underlyingStore, String archiveComment, boolean flushOnWrite) {
+        this(new FilesystemStore(underlyingStore.getParent()).resolve(underlyingStore.getFileName().toString()), archiveComment, flushOnWrite);
+    }
+
+    public BufferedZipStore(@Nonnull Path underlyingStore, boolean flushOnWrite) {
+        this(underlyingStore, null, flushOnWrite);
+    }
+
+    public BufferedZipStore(@Nonnull String underlyingStorePath, String archiveComment, boolean flushOnWrite) {
+        this(Paths.get(underlyingStorePath), archiveComment, flushOnWrite);
+    }
+
+    public BufferedZipStore(@Nonnull String underlyingStorePath, boolean flushOnWrite) {
+        this(underlyingStorePath, null, flushOnWrite);
+    }
+
+
     /**
      *  Flushes the buffer and archiveComment to the underlying store as a zip file.
      */
@@ -228,11 +263,25 @@ public ByteBuffer get(String[] keys, long start, long end) {
     @Override
     public void set(String[] keys, ByteBuffer bytes) {
         bufferStore.set(keys, bytes);
+        if (flushOnWrite) {
+            try {
+                writeBuffer();
+            } catch (IOException e) {
+                throw new RuntimeException("Failed to flush buffer to underlying store after set operation", e);
+            }
+        }
     }
 
     @Override
     public void delete(String[] keys) {
         bufferStore.delete(keys);
+        if (flushOnWrite) {
+            try {
+                writeBuffer();
+            } catch (IOException e) {
+                throw new RuntimeException("Failed to flush buffer to underlying store after delete operation", e);
+            }
+        }
     }
 
     @Nonnull

src/test/java/dev/zarr/zarrjava/ZarrStoreTest.java

@@ -156,32 +156,37 @@ public void testOpenZipStore() throws ZarrException, IOException {
 
         BufferedZipStore zipStore = new BufferedZipStore(targetDir);
         assertIsTestGroupV3(Group.open(zipStore.resolve()), true);
+
+        ReadOnlyZipStore readOnlyZipStore = new ReadOnlyZipStore(targetDir);
+        assertIsTestGroupV3(Group.open(readOnlyZipStore.resolve()), true);
     }
 
-    @Test
-    public void testWriteZipStore() throws ZarrException, IOException {
-        Path path = TESTOUTPUT.resolve("testWriteZipStore.zip");
-        BufferedZipStore zipStore = new BufferedZipStore(path);
+    @ParameterizedTest
+    @CsvSource({"false", "true",})
+    public void testWriteZipStore(boolean flushOnWrite) throws ZarrException, IOException {
+        Path path = TESTOUTPUT.resolve("testWriteZipStore" + (flushOnWrite ? "Flush" : "NoFlush") + ".zip");
+        BufferedZipStore zipStore = new BufferedZipStore(path, flushOnWrite);
         writeTestGroupV3(zipStore, true);
-        zipStore.flush();
+        if(!flushOnWrite) zipStore.flush();
 
         BufferedZipStore zipStoreRead = new BufferedZipStore(path);
         assertIsTestGroupV3(Group.open(zipStoreRead.resolve()), true);
 
-        Path unzippedPath = TESTOUTPUT.resolve("testWriteZipStoreUnzipped");
+        Path unzippedPath = TESTOUTPUT.resolve("testWriteZipStoreUnzipped" + (flushOnWrite ? "Flush" : "NoFlush"));
 
         unzipFile(path, unzippedPath);
         FilesystemStore fsStore = new FilesystemStore(unzippedPath);
         assertIsTestGroupV3(Group.open(fsStore.resolve()), true);
     }
 
-    @Test
-    public void testZipStoreWithComment() throws ZarrException, IOException {
-        Path path = TESTOUTPUT.resolve("testZipStoreWithComment.zip");
+    @ParameterizedTest
+    @CsvSource({"false", "true",})
+    public void testZipStoreWithComment(boolean flushOnWrite) throws ZarrException, IOException {
+        Path path = TESTOUTPUT.resolve("testZipStoreWithComment"+ (flushOnWrite ? "Flush" : "NoFlush") + ".zip");
         String comment = "{\"ome\": { \"version\": \"XX.YY\" }}";
-        BufferedZipStore zipStore = new BufferedZipStore(path, comment);
+        BufferedZipStore zipStore = new BufferedZipStore(path, comment, flushOnWrite);
         writeTestGroupV3(zipStore, true);
-        zipStore.flush();
+        if(!flushOnWrite) zipStore.flush();
 
         try (java.util.zip.ZipFile zipFile = new java.util.zip.ZipFile(path.toFile())) {
             String retrievedComment = zipFile.getComment();
@@ -246,12 +251,13 @@ public void testZipStoreRequirements() throws ZarrException, IOException {
     }
 
 
-    @Test
-    public void testZipStoreV2() throws ZarrException, IOException {
-        Path path = TESTOUTPUT.resolve("testZipStoreV2.zip");
-        BufferedZipStore zipStore = new BufferedZipStore(path);
+    @ParameterizedTest
+    @CsvSource({"false", "true",})
+    public void testZipStoreV2(boolean flushOnWrite) throws ZarrException, IOException {
+        Path path = TESTOUTPUT.resolve("testZipStoreV2" + (flushOnWrite ? "Flush" : "NoFlush") + ".zip");
+        BufferedZipStore zipStore = new BufferedZipStore(path, flushOnWrite);
         writeTestGroupV2(zipStore, true);
-        zipStore.flush();
+        if(!flushOnWrite) zipStore.flush();
 
         BufferedZipStore zipStoreRead = new BufferedZipStore(path);
         assertIsTestGroupV2(dev.zarr.zarrjava.core.Group.open(zipStoreRead.resolve()), true);
@@ -280,8 +286,8 @@ public void testReadOnlyZipStore() throws ZarrException, IOException {
     static Stream<Store> localStores() {
         return Stream.of(
                 new MemoryStore(),
-                new FilesystemStore(TESTOUTPUT.resolve("testLocalStoresFS"))
-//                new BufferedZipStore(TESTOUTPUT.resolve("testLocalStoresZIP.zip"))
+                new FilesystemStore(TESTOUTPUT.resolve("testLocalStoresFS")),
+                new BufferedZipStore(TESTOUTPUT.resolve("testLocalStoresZIP.zip"))
         );
     }