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

fix: add a ReadFirstRow callable to set future in onComplete #1326

Merged
merged 4 commits into from
Aug 2, 2022
Merged

fix: add a ReadFirstRow callable to set future in onComplete #1326

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7b56f2c
fix: add a ReadFirstRow callable to set future in onComplete
mutianf Jul 27, 2022
3d2eb93
use ReadRowsFirst callable instead
mutianf Aug 1, 2022
1b0ca9e
don't use atomic
mutianf Aug 2, 2022
d3f7108
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Aug 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions ...d-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/stub/EnhancedBigtableStub.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
import com.google.cloud.bigtable.data.v2.stub.mutaterows.MutateRowsRetryingCallable;
import com.google.cloud.bigtable.data.v2.stub.readrows.FilterMarkerRowsCallable;
import com.google.cloud.bigtable.data.v2.stub.readrows.ReadRowsBatchingDescriptor;
import com.google.cloud.bigtable.data.v2.stub.readrows.ReadRowsFirstCallable;
import com.google.cloud.bigtable.data.v2.stub.readrows.ReadRowsResumptionStrategy;
import com.google.cloud.bigtable.data.v2.stub.readrows.ReadRowsRetryCompletedCallable;
import com.google.cloud.bigtable.data.v2.stub.readrows.ReadRowsUserCallable;
Expand Down Expand Up @@ -366,10 +367,16 @@ public <RowT> UnaryCallable<Query, RowT> createReadRowCallable(RowAdapter<RowT>
.build(),
rowAdapter);

UnaryCallable<Query, RowT> readRowCallable =
new ReadRowsUserCallable<>(readRowsCallable, requestContext).first();
ReadRowsUserCallable<RowT> readRowCallable =
new ReadRowsUserCallable<>(readRowsCallable, requestContext);

ServerStreamingCallable<Query, RowT> traced =
new TracedServerStreamingCallable<>(
readRowCallable, clientContext.getTracerFactory(), getSpanName("ReadRow"));

ReadRowsFirstCallable<RowT> firstRow = new ReadRowsFirstCallable<>(traced);

return createUserFacingUnaryCallable("ReadRow", readRowCallable);
return firstRow.withDefaultCallContext(clientContext.getDefaultCallContext());
}

/**
Expand Down
48 changes: 44 additions & 4 deletions .../src/main/java/com/google/cloud/bigtable/data/v2/stub/readrows/ReadRowsFirstCallable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,63 @@
package com.google.cloud.bigtable.data.v2.stub.readrows;

import com.google.api.core.ApiFuture;
import com.google.api.core.InternalApi;
import com.google.api.core.SettableApiFuture;
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.StateCheckingResponseObserver;
import com.google.api.gax.rpc.StreamController;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.bigtable.data.v2.models.Query;
import java.util.concurrent.atomic.AtomicReference;

/**
* Enhancement for `readRowsCallable().first()` to gracefully limit the row count instead of
* cancelling the RPC
*/
class ReadRowsFirstCallable<RowT> extends UnaryCallable<Query, RowT> {
private final UnaryCallable<Query, RowT> inner;
@InternalApi
public class ReadRowsFirstCallable<RowT> extends UnaryCallable<Query, RowT> {

ReadRowsFirstCallable(UnaryCallable<Query, RowT> inner) {
private final ServerStreamingCallable<Query, RowT> inner;

public ReadRowsFirstCallable(ServerStreamingCallable<Query, RowT> inner) {
this.inner = inner;
}

@Override
public ApiFuture<RowT> futureCall(Query query, ApiCallContext context) {
return inner.futureCall(query.limit(1), context);
ReadRowsFirstResponseObserver<RowT> observer = new ReadRowsFirstResponseObserver<>();
this.inner.call(query.limit(1), observer, context);
return observer.getFuture();
}

private class ReadRowsFirstResponseObserver<RowT> extends StateCheckingResponseObserver<RowT> {
private StreamController innerController;
private AtomicReference<RowT> newItem = new AtomicReference<>();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think this needs to be atomic, grpc should ensure a happens before relationship of onResponse & onComplete

Copy link
Contributor Author

@mutianf mutianf Aug 1, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's safer in case for some reason grpc still returned multiple rows? This garuantees that only the first row will be set?

private SettableApiFuture<RowT> settableFuture = SettableApiFuture.create();

@Override
protected void onStartImpl(StreamController streamController) {
this.innerController = streamController;
}

@Override
protected void onResponseImpl(RowT response) {
newItem.compareAndSet(null, response);
}

@Override
protected void onErrorImpl(Throwable throwable) {
settableFuture.setException(throwable);
}

@Override
protected void onCompleteImpl() {
settableFuture.set(newItem.get());
}

protected ApiFuture<RowT> getFuture() {
return settableFuture;
}
}
}
12 changes: 0 additions & 12 deletions ...e/src/main/java/com/google/cloud/bigtable/data/v2/stub/readrows/ReadRowsUserCallable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.ResponseObserver;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.bigtable.v2.ReadRowsRequest;
import com.google.cloud.bigtable.data.v2.internal.RequestContext;
import com.google.cloud.bigtable.data.v2.models.Query;
Expand All @@ -34,27 +33,16 @@
public class ReadRowsUserCallable<RowT> extends ServerStreamingCallable<Query, RowT> {
private final ServerStreamingCallable<ReadRowsRequest, RowT> inner;
private final RequestContext requestContext;
private final ReadRowsFirstCallable<RowT> firstCallable;

public ReadRowsUserCallable(
ServerStreamingCallable<ReadRowsRequest, RowT> inner, RequestContext requestContext) {
this.inner = inner;
this.requestContext = requestContext;

this.firstCallable = new ReadRowsFirstCallable<>(super.first());
}

@Override
public void call(Query request, ResponseObserver<RowT> responseObserver, ApiCallContext context) {
ReadRowsRequest innerRequest = request.toProto(requestContext);
inner.call(innerRequest, responseObserver, context);
}

// Optimization: since the server supports row limits, override the first callable.
// This way unnecessary data doesn't need to be buffered and the number of CANCELLED request
// statuses is minimized
@Override
public UnaryCallable<Query, RowT> first() {
return firstCallable;
}
}
30 changes: 16 additions & 14 deletions .../test/java/com/google/cloud/bigtable/data/v2/stub/readrows/ReadRowsFirstCallableTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,13 @@
*/
package com.google.cloud.bigtable.data.v2.stub.readrows;

import com.google.api.core.SettableApiFuture;
import com.google.api.gax.rpc.UnaryCallable;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.verify;

import com.google.api.gax.grpc.GrpcCallContext;
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.ResponseObserver;
import com.google.api.gax.rpc.ServerStreamingCallable;
import com.google.cloud.bigtable.data.v2.internal.RequestContext;
import com.google.cloud.bigtable.data.v2.models.Query;
import com.google.cloud.bigtable.data.v2.models.Row;
Expand All @@ -38,36 +43,33 @@ public class ReadRowsFirstCallableTest {

private static final RequestContext REQUEST_CONTEXT =
RequestContext.create("fake-project", "fake-instance", "fake-profile");
private UnaryCallable<Query, Row> innerCallable;

private ServerStreamingCallable<Query, Row> innerCallable;
private ArgumentCaptor<Query> innerQuery;
private SettableApiFuture<Row> innerResult;

@SuppressWarnings("unchecked")
@Before
public void setUp() {
innerCallable = Mockito.mock(UnaryCallable.class);
innerCallable = Mockito.mock(ServerStreamingCallable.class);
innerQuery = ArgumentCaptor.forClass(Query.class);
innerResult = SettableApiFuture.create();
Mockito.when(innerCallable.futureCall(innerQuery.capture(), Mockito.any()))
.thenReturn(innerResult);
}

@Test
public void testLimitAdded() {
ReadRowsFirstCallable<Row> callable = new ReadRowsFirstCallable<>(innerCallable);
innerResult.set(null);
callable.call(Query.create("fake-table"));

callable.futureCall(Query.create("fake-table"), GrpcCallContext.createDefault());
verify(innerCallable)
.call(innerQuery.capture(), any(ResponseObserver.class), any(ApiCallContext.class));
Truth.assertThat(innerQuery.getValue().toProto(REQUEST_CONTEXT))
.isEqualTo(Query.create("fake-table").limit(1).toProto(REQUEST_CONTEXT));
}

@Test
public void testLimitChanged() {
ReadRowsFirstCallable<Row> callable = new ReadRowsFirstCallable<>(innerCallable);
innerResult.set(null);
callable.call(Query.create("fake-table").limit(1_000));

callable.futureCall(Query.create("fake-table").limit(10), GrpcCallContext.createDefault());
verify(innerCallable)
.call(innerQuery.capture(), any(ResponseObserver.class), any(ApiCallContext.class));
Truth.assertThat(innerQuery.getValue().toProto(REQUEST_CONTEXT))
.isEqualTo(Query.create("fake-table").limit(1).toProto(REQUEST_CONTEXT));
}
Expand Down
13 changes: 0 additions & 13 deletions ...c/test/java/com/google/cloud/bigtable/data/v2/stub/readrows/ReadRowsUserCallableTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,4 @@ public void testRequestConverted() {

Truth.assertThat(innerCallable.getActualRequest()).isEqualTo(query.toProto(REQUEST_CONTEXT));
}

@Test
public void testFirstIsLimited() {
ServerStreamingStashCallable<ReadRowsRequest, Row> innerCallable =
new ServerStreamingStashCallable<>();
ReadRowsUserCallable<Row> callable = new ReadRowsUserCallable<>(innerCallable, REQUEST_CONTEXT);
Query query = Query.create("fake-table");

callable.first().call(query);

Truth.assertThat(innerCallable.getActualRequest())
.isEqualTo(query.limit(1).toProto(REQUEST_CONTEXT));
}
}