Make ObjectIdConverter a top level class
We intend to reuse the methods of ProtoCacheSerializers for other protobuf conversions unrelated to CacheSerializers. Hence, we intend to move ProtoCacheSerializers to a more public package. As ObjectIdConverter is only necessary for CacheSerializers, keep it at the current package. Change-Id: I8763f00667b03a4e7bbe32d56a50f7ceaa0bef97
This commit is contained in:
@@ -25,8 +25,8 @@ import com.google.gerrit.reviewdb.client.Account;
|
||||
import com.google.gerrit.server.cache.proto.Cache.AllExternalIdsProto;
|
||||
import com.google.gerrit.server.cache.proto.Cache.AllExternalIdsProto.ExternalIdProto;
|
||||
import com.google.gerrit.server.cache.serialize.CacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import java.util.Collection;
|
||||
|
||||
/** Cache value containing all external IDs. */
|
||||
|
||||
56
java/com/google/gerrit/server/cache/serialize/ObjectIdConverter.java
vendored
Normal file
56
java/com/google/gerrit/server/cache/serialize/ObjectIdConverter.java
vendored
Normal file
@@ -0,0 +1,56 @@
|
||||
// Copyright (C) 2018 The Android Open Source Project
|
||||
//
|
||||
// Licensed 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 com.google.gerrit.server.cache.serialize;
|
||||
|
||||
import static com.google.common.base.Preconditions.checkArgument;
|
||||
import static org.eclipse.jgit.lib.Constants.OBJECT_ID_LENGTH;
|
||||
|
||||
import com.google.protobuf.ByteString;
|
||||
import org.eclipse.jgit.lib.ObjectId;
|
||||
|
||||
/**
|
||||
* Helper for serializing {@link ObjectId} instances to/from protobuf fields.
|
||||
*
|
||||
* <p>Reuse a single instance's {@link #toByteString(ObjectId)} and {@link
|
||||
* #fromByteString(ByteString)} within a single {@link CacheSerializer#serialize} or {@link
|
||||
* CacheSerializer#deserialize} method body to minimize allocation of temporary buffers.
|
||||
*
|
||||
* <p><strong>Note:</strong> This class is not threadsafe. Instances must not be stored in {@link
|
||||
* CacheSerializer} fields if the serializer instances will be used from multiple threads.
|
||||
*/
|
||||
public class ObjectIdConverter {
|
||||
public static ObjectIdConverter create() {
|
||||
return new ObjectIdConverter();
|
||||
}
|
||||
|
||||
private final byte[] buf = new byte[OBJECT_ID_LENGTH];
|
||||
|
||||
private ObjectIdConverter() {}
|
||||
|
||||
public ByteString toByteString(ObjectId id) {
|
||||
id.copyRawTo(buf, 0);
|
||||
return ByteString.copyFrom(buf);
|
||||
}
|
||||
|
||||
public ObjectId fromByteString(ByteString in) {
|
||||
checkArgument(
|
||||
in.size() == OBJECT_ID_LENGTH,
|
||||
"expected ByteString of length %s: %s",
|
||||
OBJECT_ID_LENGTH,
|
||||
in);
|
||||
in.copyTo(buf, 0);
|
||||
return ObjectId.fromRaw(buf);
|
||||
}
|
||||
}
|
||||
@@ -14,16 +14,12 @@
|
||||
|
||||
package com.google.gerrit.server.cache.serialize;
|
||||
|
||||
import static com.google.common.base.Preconditions.checkArgument;
|
||||
import static org.eclipse.jgit.lib.Constants.OBJECT_ID_LENGTH;
|
||||
|
||||
import com.google.gwtorm.protobuf.ProtobufCodec;
|
||||
import com.google.protobuf.ByteString;
|
||||
import com.google.protobuf.CodedOutputStream;
|
||||
import com.google.protobuf.MessageLite;
|
||||
import com.google.protobuf.Parser;
|
||||
import java.io.IOException;
|
||||
import org.eclipse.jgit.lib.ObjectId;
|
||||
|
||||
/** Static utilities for writing protobuf-based {@link CacheSerializer} implementations. */
|
||||
public class ProtoCacheSerializers {
|
||||
@@ -88,40 +84,5 @@ public class ProtoCacheSerializers {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper for serializing {@link ObjectId} instances to/from protobuf fields.
|
||||
*
|
||||
* <p>Reuse a single instance's {@link #toByteString(ObjectId)} and {@link
|
||||
* #fromByteString(ByteString)} within a single {@link CacheSerializer#serialize} or {@link
|
||||
* CacheSerializer#deserialize} method body to minimize allocation of temporary buffers.
|
||||
*
|
||||
* <p><strong>Note:</strong> This class is not threadsafe. Instances must not be stored in {@link
|
||||
* CacheSerializer} fields if the serializer instances will be used from multiple threads.
|
||||
*/
|
||||
public static class ObjectIdConverter {
|
||||
public static ObjectIdConverter create() {
|
||||
return new ObjectIdConverter();
|
||||
}
|
||||
|
||||
private final byte[] buf = new byte[OBJECT_ID_LENGTH];
|
||||
|
||||
private ObjectIdConverter() {}
|
||||
|
||||
public ByteString toByteString(ObjectId id) {
|
||||
id.copyRawTo(buf, 0);
|
||||
return ByteString.copyFrom(buf);
|
||||
}
|
||||
|
||||
public ObjectId fromByteString(ByteString in) {
|
||||
checkArgument(
|
||||
in.size() == OBJECT_ID_LENGTH,
|
||||
"expected ByteString of length %s: %s",
|
||||
OBJECT_ID_LENGTH,
|
||||
in);
|
||||
in.copyTo(buf, 0);
|
||||
return ObjectId.fromRaw(buf);
|
||||
}
|
||||
}
|
||||
|
||||
private ProtoCacheSerializers() {}
|
||||
}
|
||||
|
||||
@@ -32,8 +32,8 @@ import com.google.gerrit.server.cache.CacheModule;
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeKindKeyProto;
|
||||
import com.google.gerrit.server.cache.serialize.CacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.EnumCacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import com.google.gerrit.server.config.GerritServerConfig;
|
||||
import com.google.gerrit.server.git.GitRepositoryManager;
|
||||
import com.google.gerrit.server.git.InMemoryInserter;
|
||||
|
||||
@@ -30,8 +30,8 @@ import com.google.gerrit.server.cache.CacheModule;
|
||||
import com.google.gerrit.server.cache.proto.Cache.MergeabilityKeyProto;
|
||||
import com.google.gerrit.server.cache.serialize.BooleanCacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.CacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import com.google.gerrit.server.git.CodeReviewCommit;
|
||||
import com.google.gerrit.server.git.CodeReviewCommit.CodeReviewRevWalk;
|
||||
import com.google.gerrit.server.submit.SubmitDryRun;
|
||||
|
||||
@@ -24,7 +24,7 @@ import com.google.gerrit.reviewdb.client.RefNames;
|
||||
import com.google.gerrit.server.cache.proto.Cache.TagSetHolderProto.TagSetProto;
|
||||
import com.google.gerrit.server.cache.proto.Cache.TagSetHolderProto.TagSetProto.CachedRefProto;
|
||||
import com.google.gerrit.server.cache.proto.Cache.TagSetHolderProto.TagSetProto.TagProto;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.protobuf.ByteString;
|
||||
import java.io.IOException;
|
||||
import java.util.BitSet;
|
||||
|
||||
@@ -28,8 +28,8 @@ import com.google.gerrit.server.ReviewerSet;
|
||||
import com.google.gerrit.server.cache.CacheModule;
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesKeyProto;
|
||||
import com.google.gerrit.server.cache.serialize.CacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import com.google.gerrit.server.notedb.AbstractChangeNotes.Args;
|
||||
import com.google.gerrit.server.notedb.ChangeNotesCommit.ChangeNotesRevWalk;
|
||||
import com.google.inject.Inject;
|
||||
|
||||
@@ -59,8 +59,8 @@ import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto.Reviewer
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto.ReviewerSetEntryProto;
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto.ReviewerStatusUpdateProto;
|
||||
import com.google.gerrit.server.cache.serialize.CacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import com.google.gerrit.server.index.change.ChangeField.StoredSubmitRecord;
|
||||
import com.google.gerrit.server.notedb.NoteDbChangeState.PrimaryStorage;
|
||||
import com.google.gson.Gson;
|
||||
|
||||
@@ -22,8 +22,8 @@ import com.google.common.collect.Ordering;
|
||||
import com.google.gerrit.extensions.client.SubmitType;
|
||||
import com.google.gerrit.server.cache.proto.Cache.ConflictKeyProto;
|
||||
import com.google.gerrit.server.cache.serialize.CacheSerializer;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import org.eclipse.jgit.lib.AnyObjectId;
|
||||
import org.eclipse.jgit.lib.ObjectId;
|
||||
|
||||
|
||||
72
javatests/com/google/gerrit/server/cache/serialize/ObjectIdConverterTest.java
vendored
Normal file
72
javatests/com/google/gerrit/server/cache/serialize/ObjectIdConverterTest.java
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
// Copyright (C) 2018 The Android Open Source Project
|
||||
//
|
||||
// Licensed 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 com.google.gerrit.server.cache.serialize;
|
||||
|
||||
import static com.google.common.truth.Truth.assertThat;
|
||||
import static com.google.common.truth.Truth.assert_;
|
||||
import static com.google.gerrit.server.cache.testing.CacheSerializerTestUtil.byteString;
|
||||
|
||||
import com.google.gerrit.testing.GerritBaseTests;
|
||||
import com.google.protobuf.ByteString;
|
||||
import org.eclipse.jgit.lib.ObjectId;
|
||||
import org.junit.Test;
|
||||
|
||||
public class ObjectIdConverterTest extends GerritBaseTests {
|
||||
@Test
|
||||
public void objectIdFromByteString() {
|
||||
ObjectIdConverter idConverter = ObjectIdConverter.create();
|
||||
assertThat(
|
||||
idConverter.fromByteString(
|
||||
byteString(
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa)))
|
||||
.isEqualTo(ObjectId.fromString("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"));
|
||||
assertThat(
|
||||
idConverter.fromByteString(
|
||||
byteString(
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb)))
|
||||
.isEqualTo(ObjectId.fromString("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void objectIdFromByteStringWrongSize() {
|
||||
try {
|
||||
ObjectIdConverter.create().fromByteString(ByteString.copyFromUtf8("foo"));
|
||||
assert_().fail("expected IllegalArgumentException");
|
||||
} catch (IllegalArgumentException e) {
|
||||
// Expected.
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void objectIdToByteString() {
|
||||
ObjectIdConverter idConverter = ObjectIdConverter.create();
|
||||
assertThat(
|
||||
idConverter.toByteString(
|
||||
ObjectId.fromString("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")))
|
||||
.isEqualTo(
|
||||
byteString(
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa));
|
||||
assertThat(
|
||||
idConverter.toByteString(
|
||||
ObjectId.fromString("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb")))
|
||||
.isEqualTo(
|
||||
byteString(
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb));
|
||||
}
|
||||
}
|
||||
@@ -14,66 +14,16 @@
|
||||
|
||||
package com.google.gerrit.server.cache.serialize;
|
||||
|
||||
import static com.google.common.truth.Truth.assertThat;
|
||||
import static com.google.common.truth.Truth.assert_;
|
||||
import static com.google.common.truth.extensions.proto.ProtoTruth.assertThat;
|
||||
import static com.google.gerrit.server.cache.testing.CacheSerializerTestUtil.byteString;
|
||||
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesKeyProto;
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import com.google.gerrit.testing.GerritBaseTests;
|
||||
import com.google.protobuf.ByteString;
|
||||
import org.eclipse.jgit.lib.ObjectId;
|
||||
import org.junit.Test;
|
||||
|
||||
public class ProtoCacheSerializersTest extends GerritBaseTests {
|
||||
@Test
|
||||
public void objectIdFromByteString() {
|
||||
ObjectIdConverter idConverter = ObjectIdConverter.create();
|
||||
assertThat(
|
||||
idConverter.fromByteString(
|
||||
byteString(
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa)))
|
||||
.isEqualTo(ObjectId.fromString("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"));
|
||||
assertThat(
|
||||
idConverter.fromByteString(
|
||||
byteString(
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb)))
|
||||
.isEqualTo(ObjectId.fromString("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void objectIdFromByteStringWrongSize() {
|
||||
try {
|
||||
ObjectIdConverter.create().fromByteString(ByteString.copyFromUtf8("foo"));
|
||||
assert_().fail("expected IllegalArgumentException");
|
||||
} catch (IllegalArgumentException e) {
|
||||
// Expected.
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void objectIdToByteString() {
|
||||
ObjectIdConverter idConverter = ObjectIdConverter.create();
|
||||
assertThat(
|
||||
idConverter.toByteString(
|
||||
ObjectId.fromString("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")))
|
||||
.isEqualTo(
|
||||
byteString(
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
|
||||
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa));
|
||||
assertThat(
|
||||
idConverter.toByteString(
|
||||
ObjectId.fromString("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb")))
|
||||
.isEqualTo(
|
||||
byteString(
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb,
|
||||
0xbb, 0xbb, 0xbb, 0xbb, 0xbb, 0xbb));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void parseUncheckedWrongProtoType() {
|
||||
ChangeNotesKeyProto proto =
|
||||
|
||||
@@ -47,7 +47,7 @@ import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto.ChangeCo
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto.ReviewerByEmailSetEntryProto;
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto.ReviewerSetEntryProto;
|
||||
import com.google.gerrit.server.cache.proto.Cache.ChangeNotesStateProto.ReviewerStatusUpdateProto;
|
||||
import com.google.gerrit.server.cache.serialize.ProtoCacheSerializers.ObjectIdConverter;
|
||||
import com.google.gerrit.server.cache.serialize.ObjectIdConverter;
|
||||
import com.google.gerrit.server.notedb.ChangeNotesState.ChangeColumns;
|
||||
import com.google.gerrit.server.notedb.ChangeNotesState.Serializer;
|
||||
import com.google.gerrit.testing.GerritBaseTests;
|
||||
|
||||
Reference in New Issue
Block a user