Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: Filters should be serializable #397

Merged
merged 7 commits into from Sep 22, 2020
Merged

fix: Filters should be serializable #397

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b78063f
fix: Filters should be serializable
dmitry-fa Aug 28, 2020
b3723f2
rollback changes to generated files
dmitry-fa Sep 1, 2020
2208adb
customize serialization of builders
dmitry-fa Sep 1, 2020
94ca9ec
customize serialization of builders
dmitry-fa Sep 2, 2020
9ce579f
customize serialization of builders
dmitry-fa Sep 2, 2020
e63841e
check serialization of non-filter instances
dmitry-fa Sep 2, 2020
2683ee7
test for spawned filters
dmitry-fa Sep 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 34 additions & 11 deletions google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/models/Filters.java
View file
Open in desktop
Expand Up @@ -200,6 +200,7 @@ public Filter label(@Nonnull String label) {
// Implementations of target specific filters.
/** DSL for adding filters to a chain. */
public static final class ChainFilter implements Filter {
private static final long serialVersionUID = -89237431180618430L;
igorbernstein2 marked this conversation as resolved.
Show resolved Hide resolved
private RowFilter.Chain.Builder builder;

private ChainFilter() {
Expand Down Expand Up @@ -241,6 +242,7 @@ public ChainFilter clone() {

/** DSL for adding filters to the interleave list. */
public static final class InterleaveFilter implements Filter {
private static final long serialVersionUID = -3866166430679348474L;
private RowFilter.Interleave.Builder builder;

private InterleaveFilter() {
Expand Down Expand Up @@ -281,6 +283,7 @@ public InterleaveFilter clone() {

/** DSL for configuring a conditional filter. */
public static final class ConditionFilter implements Filter {
private static final long serialVersionUID = -7576541105323990049L;
private RowFilter.Condition.Builder builder;

private ConditionFilter(@Nonnull Filter predicate) {
Expand Down Expand Up @@ -323,7 +326,9 @@ public ConditionFilter clone() {
}
}

public static final class KeyFilter {
public static final class KeyFilter implements Serializable {
private static final long serialVersionUID = 5137765114285539458L;

private KeyFilter() {}

/**
Expand Down Expand Up @@ -383,7 +388,9 @@ public Filter sample(double probability) {
}
}

public static final class FamilyFilter {
public static final class FamilyFilter implements Serializable {
private static final long serialVersionUID = -4470936841191831553L;

private FamilyFilter() {}

/**
Expand All @@ -405,7 +412,9 @@ public Filter exactMatch(@Nonnull String value) {
}
}

public static final class QualifierFilter {
public static final class QualifierFilter implements Serializable {
private static final long serialVersionUID = -1274850022909506559L;

private QualifierFilter() {}

/**
Expand Down Expand Up @@ -459,7 +468,8 @@ public QualifierRangeFilter rangeWithinFamily(@Nonnull String family) {

/** Matches only cells from columns within the given range. */
public static final class QualifierRangeFilter
extends AbstractByteStringRange<QualifierRangeFilter> implements Filter, Serializable {
extends AbstractByteStringRange<QualifierRangeFilter> implements Filter {
private static final long serialVersionUID = -1909319911147913630L;
private final String family;

private QualifierRangeFilter(String family) {
Expand Down Expand Up @@ -505,7 +515,9 @@ public QualifierRangeFilter clone() {
}
}

public static final class TimestampFilter {
public static final class TimestampFilter implements Serializable {
private static final long serialVersionUID = 5284219722591464991L;

private TimestampFilter() {}

/**
Expand All @@ -529,7 +541,9 @@ public TimestampRangeFilter exact(Long exactTimestamp) {

/** Matches only cells with microsecond timestamps within the given range. */
public static final class TimestampRangeFilter
extends AbstractTimestampRange<TimestampRangeFilter> implements Filter, Serializable {
extends AbstractTimestampRange<TimestampRangeFilter> implements Filter {
private static final long serialVersionUID = 8410980338603335276L;

private TimestampRangeFilter() {}

@InternalApi
Expand Down Expand Up @@ -571,7 +585,9 @@ public TimestampRangeFilter clone() {
}
}

public static final class ValueFilter {
public static final class ValueFilter implements Serializable {
private static final long serialVersionUID = 6722715229238811179L;

private ValueFilter() {}

/**
Expand Down Expand Up @@ -628,7 +644,9 @@ public Filter strip() {

/** Matches only cells with values that fall within the given value range. */
public static final class ValueRangeFilter extends AbstractByteStringRange<ValueRangeFilter>
implements Filter, Serializable {
implements Filter {
private static final long serialVersionUID = -2452360677825047088L;

private ValueRangeFilter() {}

@InternalApi
Expand Down Expand Up @@ -668,7 +686,9 @@ public ValueRangeFilter clone() {
}
}

public static final class OffsetFilter {
public static final class OffsetFilter implements Serializable {
private static final long serialVersionUID = 3228791236971884041L;

private OffsetFilter() {}

/**
Expand All @@ -681,7 +701,9 @@ public Filter cellsPerRow(int count) {
}
}

public static final class LimitFilter {
public static final class LimitFilter implements Serializable {
private static final long serialVersionUID = -794915549003008940L;

private LimitFilter() {}

/**
Expand All @@ -705,6 +727,7 @@ public Filter cellsPerColumn(int count) {
}

private static final class SimpleFilter implements Filter {
private static final long serialVersionUID = 3595911451325189833L;
private final RowFilter proto;

private SimpleFilter(@Nonnull RowFilter proto) {
Expand All @@ -729,7 +752,7 @@ public SimpleFilter clone() {
}

@InternalExtensionOnly
public interface Filter extends Cloneable {
public interface Filter extends Cloneable, Serializable {
@InternalApi
RowFilter toProto();
}
Expand Down
52 changes: 52 additions & 0 deletions ...le-cloud-bigtable/src/test/java/com/google/cloud/bigtable/data/v2/models/FiltersTest.java
View file
Open in desktop
Expand Up @@ -17,6 +17,7 @@

import static com.google.cloud.bigtable.data.v2.models.Filters.FILTERS;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.fail;

import com.google.bigtable.v2.ColumnRange;
import com.google.bigtable.v2.RowFilter;
Expand All @@ -26,6 +27,17 @@
import com.google.bigtable.v2.TimestampRange;
import com.google.bigtable.v2.ValueRange;
import com.google.protobuf.ByteString;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
Expand Down Expand Up @@ -528,4 +540,44 @@ public void labelTest() {

assertThat(actualFilter).isEqualTo(expectedFilter);
}

@Test
public void serializationTest() {
// checks that the all objects returned by the all methods of the Filters class
// can be serialized/deserialized.

// map methodName -> methodArguments (for those methods which require parameters)
Map<String, Object[]> parameterMap = new HashMap<>();
parameterMap.put("condition", new Object[] {FILTERS.pass()});
parameterMap.put("label", new Object[] {"label"});
parameterMap.put("fromProto", new Object[] {FILTERS.label("label").toProto()});

for (Method m : Filters.class.getDeclaredMethods()) {
String name = m.getName();
if (Modifier.isPublic(m.getModifiers())) {
Object[] params = parameterMap.get(name);
dmitry-fa marked this conversation as resolved.
Show resolved Hide resolved
if (params == null) {
params = new Object[] {};
}
try {
trySerialization(m.invoke(FILTERS, params));
} catch (Exception e) {
fail(name + ": " + e);
}
}
}
}

private void trySerialization(Object obj) throws IOException, ClassNotFoundException {
Path serFile = Files.createTempFile("filter", ".ser");
igorbernstein2 marked this conversation as resolved.
Show resolved Hide resolved
try (ObjectOutputStream outStream =
new ObjectOutputStream(new FileOutputStream(serFile.toFile()))) {
outStream.writeObject(obj);
}

try (ObjectInputStream inStream =
new ObjectInputStream(new FileInputStream(serFile.toFile()))) {
inStream.readObject();
}
}
}
40 changes: 28 additions & 12 deletions proto-google-cloud-bigtable-v2/src/main/java/com/google/bigtable/v2/RowFilter.java
View file
Open in desktop
Expand Up @@ -18,6 +18,8 @@

package com.google.bigtable.v2;

import java.io.Serializable;
igorbernstein2 marked this conversation as resolved.
Show resolved Hide resolved

/**
*
*
Expand Down Expand Up @@ -56,9 +58,11 @@
*/
public final class RowFilter extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(message_implements:google.bigtable.v2.RowFilter)
RowFilterOrBuilder {
private static final long serialVersionUID = 0L;
// @@protoc_insertion_point(message_implements:google.bigtable.v2.RowFilter)
RowFilterOrBuilder,
Serializable {
private static final long serialVersionUID = 5041615103476790190L;

// Use RowFilter.newBuilder() to construct.
private RowFilter(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
Expand Down Expand Up @@ -380,7 +384,8 @@ public static final class Chain extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(message_implements:google.bigtable.v2.RowFilter.Chain)
ChainOrBuilder {
private static final long serialVersionUID = 0L;
private static final long serialVersionUID = 3029099319991323890L;

// Use Chain.newBuilder() to construct.
private Chain(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
Expand Down Expand Up @@ -720,8 +725,11 @@ protected Builder newBuilderForType(
public static final class Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Builder>
implements
// @@protoc_insertion_point(builder_implements:google.bigtable.v2.RowFilter.Chain)
com.google.bigtable.v2.RowFilter.ChainOrBuilder {
// @@protoc_insertion_point(builder_implements:google.bigtable.v2.RowFilter.Chain)
com.google.bigtable.v2.RowFilter.ChainOrBuilder,
Serializable {
private static final long serialVersionUID = 3843969655199755334L;

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.bigtable.v2.DataProto
.internal_static_google_bigtable_v2_RowFilter_Chain_descriptor;
Expand Down Expand Up @@ -1346,8 +1354,9 @@ public com.google.bigtable.v2.RowFilter.Chain getDefaultInstanceForType() {

public interface InterleaveOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.RowFilter.Interleave)
com.google.protobuf.MessageOrBuilder {
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.RowFilter.Interleave)
com.google.protobuf.MessageOrBuilder,
Serializable {

/**
*
Expand Down Expand Up @@ -1524,7 +1533,7 @@ public static final class Interleave extends com.google.protobuf.GeneratedMessag
implements
// @@protoc_insertion_point(message_implements:google.bigtable.v2.RowFilter.Interleave)
InterleaveOrBuilder {
private static final long serialVersionUID = 0L;
private static final long serialVersionUID = -4010737514587512031L;
// Use Interleave.newBuilder() to construct.
private Interleave(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
Expand Down Expand Up @@ -1968,6 +1977,8 @@ public static final class Builder
implements
// @@protoc_insertion_point(builder_implements:google.bigtable.v2.RowFilter.Interleave)
com.google.bigtable.v2.RowFilter.InterleaveOrBuilder {
private static final long serialVersionUID = -194632601621153938L;

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.bigtable.v2.DataProto
.internal_static_google_bigtable_v2_RowFilter_Interleave_descriptor;
Expand Down Expand Up @@ -2952,8 +2963,9 @@ public com.google.bigtable.v2.RowFilter.Interleave getDefaultInstanceForType() {

public interface ConditionOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.RowFilter.Condition)
com.google.protobuf.MessageOrBuilder {
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.RowFilter.Condition)
com.google.protobuf.MessageOrBuilder,
Serializable {

/**
*
Expand Down Expand Up @@ -3090,7 +3102,7 @@ public static final class Condition extends com.google.protobuf.GeneratedMessage
implements
// @@protoc_insertion_point(message_implements:google.bigtable.v2.RowFilter.Condition)
ConditionOrBuilder {
private static final long serialVersionUID = 0L;
private static final long serialVersionUID = -721556095392940616L;
// Use Condition.newBuilder() to construct.
private Condition(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) {
super(builder);
Expand Down Expand Up @@ -3574,6 +3586,8 @@ public static final class Builder
implements
// @@protoc_insertion_point(builder_implements:google.bigtable.v2.RowFilter.Condition)
com.google.bigtable.v2.RowFilter.ConditionOrBuilder {
private static final long serialVersionUID = 2192459056488847085L;

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.bigtable.v2.DataProto
.internal_static_google_bigtable_v2_RowFilter_Condition_descriptor;
Expand Down Expand Up @@ -5736,6 +5750,8 @@ public static final class Builder extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(builder_implements:google.bigtable.v2.RowFilter)
com.google.bigtable.v2.RowFilterOrBuilder {
private static final long serialVersionUID = 3777165723978883886L;

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.bigtable.v2.DataProto
.internal_static_google_bigtable_v2_RowFilter_descriptor;
Expand Down
9 changes: 6 additions & 3 deletions proto-google-cloud-bigtable-v2/src/main/java/com/google/bigtable/v2/RowFilterOrBuilder.java
View file
Open in desktop
Expand Up @@ -18,10 +18,13 @@

package com.google.bigtable.v2;

import java.io.Serializable;

public interface RowFilterOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.RowFilter)
com.google.protobuf.MessageOrBuilder {
// @@protoc_insertion_point(interface_extends:google.bigtable.v2.RowFilter)
igorbernstein2 marked this conversation as resolved.
Show resolved Hide resolved
com.google.protobuf.MessageOrBuilder,
Serializable {

/**
*
Expand Down Expand Up @@ -545,5 +548,5 @@ public interface RowFilterOrBuilder
*/
com.google.protobuf.ByteString getApplyLabelTransformerBytes();

public com.google.bigtable.v2.RowFilter.FilterCase getFilterCase();
com.google.bigtable.v2.RowFilter.FilterCase getFilterCase();
}