HDDS-9223. Use protobuf for SnapshotDiffJobCodec

hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/om/helpers/SnapshotDiffJob.java

@@ -20,6 +20,7 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.protobuf.InvalidProtocolBufferException;
 import java.io.IOException;
 import java.util.Objects;
 import org.apache.commons.lang3.StringUtils;
@@ -315,13 +316,19 @@ public Class<SnapshotDiffJob> getTypeClass() {
     }
 
     @Override
-    public byte[] toPersistedFormatImpl(SnapshotDiffJob object) throws IOException {
-      return MAPPER.writeValueAsBytes(object);
+    public byte[] toPersistedFormat(SnapshotDiffJob object) {
+      return object.toProtoBuf().toByteArray();
     }
 
     @Override
     public SnapshotDiffJob fromPersistedFormatImpl(byte[] rawData) throws IOException {
-      return MAPPER.readValue(rawData, SnapshotDiffJob.class);
+      try {
+        SnapshotDiffJobProto proto = SnapshotDiffJobProto.parseFrom(rawData);
+        return SnapshotDiffJob.getFromProtoBuf(proto);
+      } catch (InvalidProtocolBufferException e) {
+        // the rawData was in old format, fallback to the old implementation
+        return MAPPER.readValue(rawData, SnapshotDiffJob.class);
+      }
     }
 
     @Override

hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/OldSnapshotDiffJobCodecForTesting.java

@@ -0,0 +1,56 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.hadoop.ozone.om.helpers;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import java.io.IOException;
+import org.apache.hadoop.hdds.utils.db.Codec;
+
+/**
+ * Codec to serialize / deserialize SnapshotDiffJob.
+ */
+public class OldSnapshotDiffJobCodecForTesting
+    implements Codec<SnapshotDiffJob> {
+
+  private static final ObjectMapper MAPPER = new ObjectMapper()
+      .setSerializationInclusion(JsonInclude.Include.NON_NULL)
+      .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+
+  @Override
+  public Class<SnapshotDiffJob> getTypeClass() {
+    return SnapshotDiffJob.class;
+  }
+
+  @Override
+  public byte[] toPersistedFormatImpl(SnapshotDiffJob object) throws IOException {
+    return MAPPER.writeValueAsBytes(object);
+  }
+
+  @Override
+  public SnapshotDiffJob fromPersistedFormatImpl(byte[] rawData) throws IOException {
+    return MAPPER.readValue(rawData, SnapshotDiffJob.class);
+  }
+
+  @Override
+  public SnapshotDiffJob copyObject(SnapshotDiffJob object) {
+    // Note: Not really a "copy". from OmDBDiffReportEntryCodec
+    return object;
+  }
+}

hadoop-ozone/common/src/test/java/org/apache/hadoop/ozone/om/helpers/TestOmSnapshotDiffJobCodec.java

@@ -0,0 +1,73 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.hadoop.ozone.om.helpers;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.apache.hadoop.hdds.utils.db.Codec;
+import org.apache.hadoop.ozone.snapshot.SnapshotDiffResponse.JobStatus;
+import org.apache.hadoop.ozone.snapshot.SnapshotDiffResponse.SubStatus;
+import org.junit.jupiter.api.Test;
+
+/**
+ * Testing serialization of SnapshotDiffJobCodec objects to/from RocksDB.
+ */
+public class TestOmSnapshotDiffJobCodec {
+  private final OldSnapshotDiffJobCodecForTesting oldCodec
+      = new OldSnapshotDiffJobCodecForTesting();
+  private final Codec<SnapshotDiffJob> newCodec = SnapshotDiffJob.getCodec();
+
+  @Test
+  public void testOldJsonSerializedDataCanBeReadByNewCodec() throws Exception {
+    // Step 1: Construct a SnapshotDiffJob instance
+    SnapshotDiffJob original = new SnapshotDiffJob(
+        123456789L,
+        "job-001",
+        JobStatus.IN_PROGRESS,
+        "volA",
+        "buckB",
+        "snap1",
+        "snap2",
+        true,
+        false,
+        100L,
+        SubStatus.SST_FILE_DELTA_DAG_WALK,
+        0.0
+    );
+
+    // Step 2: Serialize using the old Jackson-based codec
+    byte[] oldFormatData = oldCodec.toPersistedFormatImpl(original);
+
+    // Step 3: Deserialize using the new default codec (with Protobuf + JSON fallback)
+    SnapshotDiffJob parsed = newCodec.fromPersistedFormatImpl(oldFormatData);
+
+    // Step 4: Verify critical fields remain consistent after round-trip
+    assertEquals(original.getJobId(), parsed.getJobId());
+    assertEquals(original.getStatus(), parsed.getStatus());
+    assertEquals(original.getVolume(), parsed.getVolume());
+    assertEquals(original.getBucket(), parsed.getBucket());
+    assertEquals(original.getFromSnapshot(), parsed.getFromSnapshot());
+    assertEquals(original.getToSnapshot(), parsed.getToSnapshot());
+    assertEquals(original.isForceFullDiff(), parsed.isForceFullDiff());
+    assertEquals(original.isNativeDiffDisabled(), parsed.isNativeDiffDisabled());
+    assertEquals(original.getSubStatus(), parsed.getSubStatus());
+    assertEquals(original.getTotalDiffEntries(), parsed.getTotalDiffEntries());
+
+    assertEquals(0.0, parsed.getKeysProcessedPct());
+  }
+}