Add DeltaFile

Author: agilelab-tmnd1991

server/app/src/main/java/io/whitefox/api/deltasharing/model/v1/delta/DeltaFile.java

@@ -0,0 +1,73 @@
+package io.whitefox.api.deltasharing.model.v1.delta;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.JsonNode;
+import java.util.Optional;
+import lombok.Builder;
+import lombok.NonNull;
+import lombok.Value;
+import lombok.experimental.SuperBuilder;
+import lombok.extern.jackson.Jacksonized;
+
+@Value
+@SuperBuilder
+@Jacksonized
+public class DeltaFile {
+
+  @JsonProperty
+  @NonNull File file;
+
+  @Value
+  @SuperBuilder
+  @Jacksonized
+  @JsonInclude(JsonInclude.Include.NON_ABSENT)
+  public static class File {
+
+    /**
+     * A unique string for the file in a table.
+     * The same file is guaranteed to have the same id across multiple requests.
+     * A client may cache the file content and use this id as a key to decide whether to use the cached file content.
+     */
+    @JsonProperty
+    @NonNull String id;
+
+    /**
+     * A unique string for the deletion vector file in a table.
+     * The same deletion vector file is guaranteed to have the same id across multiple requests.
+     * A client may cache the file content and use this id as a key to decide whether to use the cached file content.
+     */
+    @JsonProperty
+    @Builder.Default
+    Optional<String> deletionVectorFileId = Optional.empty();
+
+    /**
+     * The table version of the file, returned when querying a table data with a version or timestamp parameter.
+     */
+    @JsonProperty
+    @Builder.Default
+    Optional<Long> version = Optional.empty();
+
+    /**
+     * The unix timestamp corresponding to the table version of the file, in milliseconds,
+     * returned when querying a table data with a version or timestamp parameter.
+     */
+    @JsonProperty
+    @Builder.Default
+    Optional<Long> timestamp = Optional.empty();
+
+    /**
+     * The unix timestamp corresponding to the expiration of the url, in milliseconds,
+     * returned when the server supports the feature.
+     */
+    @JsonProperty
+    @Builder.Default
+    Optional<Long> expirationTimestamp = Optional.empty();
+
+    /**
+     * Need to be parsed by a delta library as a delta single action, the path field is replaced by pr-signed url.
+     */
+    @JsonProperty
+    @NonNull JsonNode deltaSingleAction;
+  }
+}

server/app/src/main/java/io/whitefox/api/deltasharing/model/v1/delta/DeltaFiles.yaml

@@ -0,0 +1,44 @@
+package io.whitefox.api.deltasharing.model.v1.delta;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
+import java.io.IOException;
+import java.util.Optional;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+public class DeltaFileSerializationTest {
+  String singleActionJson;
+  String json;
+
+  DeltaFile object;
+  ObjectMapper om;
+
+  public DeltaFileSerializationTest() throws JsonProcessingException {
+    om = new ObjectMapper();
+    om.registerModule(new Jdk8Module());
+    singleActionJson =
+        "{\"add\":{\"dataChange\":false,\"modificationTime\":0,\"partitionValues\":{\"date\":\"2021-04-28\"},\"path\":\"https://s3-bucket-name.s3.us-west-2.amazonaws.com/delta-exchange-test/table2/date%3D2021-04-28/part-00000-591723a8-6a27-4240-a90e-57426f4736d2.c000.snappy.parquet?...\",\"pathAsUri\":\"https://s3-bucket-name.s3.us-west-2.amazonaws.com/delta-exchange-test/table2/date%3D2021-04-28/part-00000-591723a8-6a27-4240-a90e-57426f4736d2.c000.snappy.parquet?...\",\"size\":0,\"stats\":\"{\\\"numRecords\\\":1,\\\"minValues\\\":{\\\"eventTime\\\":\\\"2021-04-28T23:33:48.719Z\\\"},\\\"maxValues\\\":{\\\"eventTime\\\":\\\"2021-04-28T23:33:48.719Z\\\"},\\\"nullCount\\\":{\\\"eventTime\\\":0}}\"}}";
+    json =
+        "{\"file\":{\"id\":\"591723a8-6a27-4240-a90e-57426f4736d2\",\"expirationTimestamp\":1652140800000,\"deltaSingleAction\":"
+            + singleActionJson + "}}";
+    object = DeltaFile.builder()
+        .file(DeltaFile.File.builder()
+            .id("591723a8-6a27-4240-a90e-57426f4736d2")
+            .expirationTimestamp(Optional.of(1652140800000L))
+            .deltaSingleAction(om.readTree(singleActionJson))
+            .build())
+        .build();
+  }
+
+  @Test
+  void serialize() throws IOException {
+    Assertions.assertEquals(json, om.writer().writeValueAsString(object));
+  }
+
+  @Test
+  void deserialize() throws IOException {
+    Assertions.assertEquals(object, om.reader().readValue(json, DeltaFile.class));
+  }
+}