-
Notifications
You must be signed in to change notification settings - Fork 588
HDDS-9223. Use protobuf for SnapshotDiffJobCodec #8503
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 7 commits
54842d4
f09a925
9dfe382
6db1be4
4402ff7
db2e8df
fd68132
7b25069
1ddf5db
46796a1
1cc7964
d897d24
9bbeaf9
af93172
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -316,12 +316,17 @@ public Class<SnapshotDiffJob> getTypeClass() { | |
|
|
||
| @Override | ||
| public byte[] toPersistedFormatImpl(SnapshotDiffJob object) throws IOException { | ||
| return MAPPER.writeValueAsBytes(object); | ||
| return object.toProtoBuf().toByteArray(); | ||
szetszwo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| @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 (IOException e) { | ||
|
||
| return MAPPER.readValue(rawData, SnapshotDiffJob.class); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| 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 org.apache.hadoop.hdds.utils.db.Codec; | ||
| import java.io.IOException; | ||
|
|
||
|
|
||
| public class OldSnapshotDiffJobCodecForTesting | ||
peterxcli marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,57 @@ | ||||||
| package org.apache.hadoop.ozone.om.helpers; | ||||||
|
|
||||||
| 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; | ||||||
|
|
||||||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||||||
|
|
||||||
|
|
||||||
| /** | ||||||
| * Testing serialization of SnapshotDiffJobCodec objects to/from RocksDB. | ||||||
| */ | ||||||
| public class TestOmSnapshotDiffJobCodec { | ||||||
| private final OldSnapshotDiffJobCodecForTesting oldCodec | ||||||
| = new OldSnapshotDiffJobCodecForTesting(); | ||||||
| private final Codec<SnapshotDiffJob> newCodec = SnapshotDiffJob.getCodec(); | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit:
Suggested change
|
||||||
|
|
||||||
| @Test | ||||||
| public void testOldJsonSerializedDataCanBeReadByNewCodec() throws Exception { | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. getFromProtoBuf() appears to be a safe method that builds a POJO from a fully-parsed SnapshotDiffJobProto object. Since it relies on accessor methods like getCreationTime() and getVolume() which are expected to be present in a valid proto message, we don’t anticipate any checked exceptions being thrown during this process. Please correct me if I missed anything or overlooked a potential edge case.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was just wondering: does the fallback have to be triggered when |
||||||
| // 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); | ||||||
szetszwo marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| // 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()); | ||||||
| } | ||||||
| } | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The implementation no longer throws any exception. Change the method to
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated