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.

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

feat: use existing transport options API to set transport #1276

Merged
merged 6 commits into from
Jan 16, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,18 @@
package com.google.cloud.datastore;

import static com.google.cloud.datastore.Validator.validateNamespace;
import static com.google.cloud.datastore.spi.v1.DatastoreRpc.Transport.GRPC;

import com.google.cloud.ServiceDefaults;
import com.google.cloud.ServiceOptions;
import com.google.cloud.ServiceRpc;
import com.google.cloud.TransportOptions;
import com.google.cloud.datastore.spi.DatastoreRpcFactory;
import com.google.cloud.datastore.spi.v1.DatastoreRpc;
import com.google.cloud.datastore.spi.v1.DatastoreRpc.Transport;
import com.google.cloud.datastore.spi.v1.GrpcDatastoreRpc;
import com.google.cloud.datastore.spi.v1.HttpDatastoreRpc;
import com.google.cloud.datastore.v1.DatastoreSettings;
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.http.HttpTransportOptions;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableSet;
import java.io.IOException;
Expand All @@ -50,7 +48,6 @@ public class DatastoreOptions extends ServiceOptions<Datastore, DatastoreOptions

private final String namespace;
private final String databaseId;
private final Transport transport;

public static class DefaultDatastoreFactory implements DatastoreFactory {

Expand All @@ -69,9 +66,14 @@ public static class DefaultDatastoreRpcFactory implements DatastoreRpcFactory {
@Override
public ServiceRpc create(DatastoreOptions options) {
try {
return options.transport == GRPC
? new GrpcDatastoreRpc(options)
: new HttpDatastoreRpc(options);
if (options.getTransportOptions() instanceof GrpcTransportOptions) {
return new GrpcDatastoreRpc(options);
} else if (options.getTransportOptions() instanceof HttpTransportOptions) {
return new HttpDatastoreRpc(options);
} else {
throw new IllegalArgumentException(
"unknown transport type: " + options.getTransportOptions());
}
} catch (IOException e) {
throw new RuntimeException(e);
}
Expand All @@ -82,23 +84,17 @@ public static class Builder extends ServiceOptions.Builder<Datastore, DatastoreO

private String namespace;
private String databaseId;
private Transport transport = GRPC;

private Builder() {}

private Builder(DatastoreOptions options) {
super(options);
namespace = options.namespace;
databaseId = options.databaseId;
transport = options.transport;
}

@Override
public Builder setTransportOptions(TransportOptions transportOptions) {
if (!(transportOptions instanceof HttpTransportOptions)) {
throw new IllegalArgumentException(
"Only http transport is allowed for " + API_SHORT_NAME + ".");
}
return super.setTransportOptions(transportOptions);
}

Expand All @@ -117,18 +113,12 @@ public Builder setDatabaseId(String databaseId) {
this.databaseId = databaseId;
return this;
}

public Builder setTransport(Transport transport) {
this.transport = transport;
return this;
}
}

private DatastoreOptions(Builder builder) {
super(DatastoreFactory.class, DatastoreRpcFactory.class, builder, new DatastoreDefaults());
namespace = MoreObjects.firstNonNull(builder.namespace, defaultNamespace());
databaseId = MoreObjects.firstNonNull(builder.databaseId, DEFAULT_DATABASE_ID);
transport = builder.transport;
}

@Override
Expand Down Expand Up @@ -157,14 +147,18 @@ public DatastoreRpcFactory getDefaultRpcFactory() {

@Override
public TransportOptions getDefaultTransportOptions() {
return getDefaultHttpTransportOptions();
return getDefaultGrpcTransportOptions();
}
}

public static HttpTransportOptions getDefaultHttpTransportOptions() {
return HttpTransportOptions.newBuilder().build();
}

public static GrpcTransportOptions getDefaultGrpcTransportOptions() {
return GrpcTransportOptions.newBuilder().build();
}

/** Returns the default namespace to be used by the datastore service. */
public String getNamespace() {
return namespace;
Expand All @@ -174,12 +168,6 @@ public String getDatabaseId() {
return this.databaseId;
}

/** Returns the current transport */
@VisibleForTesting
Transport getTransport() {
return this.transport;
}

/** Returns a default {@code DatastoreOptions} instance. */
public static DatastoreOptions getDefaultInstance() {
return newBuilder().build();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

package com.google.cloud.datastore.spi.v1;

import com.google.api.core.InternalApi;
import com.google.api.core.InternalExtensionOnly;
import com.google.api.gax.rpc.HeaderProvider;
import com.google.cloud.ServiceRpc;
Expand Down Expand Up @@ -117,11 +116,4 @@ protected DatastoreSettings.Builder setInternalHeaderProvider(
return super.setInternalHeaderProvider(internalHeaderProvider);
}
}

/** Transport used to sending requests. */
@InternalApi
enum Transport {
GRPC,
HTTP
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import com.google.cloud.datastore.Query;
import com.google.cloud.datastore.QueryResults;
import com.google.cloud.datastore.StructuredQuery;
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.http.HttpTransportOptions;
import java.util.UUID;
import org.threeten.bp.Duration;
Expand Down Expand Up @@ -79,9 +80,7 @@ public static RemoteDatastoreHelper create() {

/** Creates a {@code RemoteStorageHelper} object. */
public static RemoteDatastoreHelper create(String databaseId) {
HttpTransportOptions transportOptions = DatastoreOptions.getDefaultHttpTransportOptions();
transportOptions =
transportOptions.toBuilder().setConnectTimeout(60000).setReadTimeout(60000).build();
GrpcTransportOptions transportOptions = DatastoreOptions.getDefaultGrpcTransportOptions();
DatastoreOptions datastoreOption =
DatastoreOptions.newBuilder()
.setDatabaseId(databaseId)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,17 @@

package com.google.cloud.datastore;

import static com.google.cloud.datastore.spi.v1.DatastoreRpc.Transport.GRPC;
import static com.google.cloud.datastore.spi.v1.DatastoreRpc.Transport.HTTP;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;

import com.google.cloud.TransportOptions;
import com.google.cloud.datastore.spi.DatastoreRpcFactory;
import com.google.cloud.datastore.spi.v1.DatastoreRpc;
import com.google.cloud.grpc.GrpcTransportOptions;
import com.google.cloud.http.HttpTransportOptions;
import org.easymock.EasyMock;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;

Expand Down Expand Up @@ -87,17 +84,23 @@ public void testDatastore() {
@Test
public void testTransport() {
// default grpc transport
assertThat(options.build().getTransport()).isEqualTo(GRPC);
assertThat(options.build().getTransportOptions()).isInstanceOf(GrpcTransportOptions.class);

// custom http transport
DatastoreOptions httpDatastoreOptions =
DatastoreOptions.newBuilder().setTransport(HTTP).setProjectId(PROJECT_ID).build();
assertThat(httpDatastoreOptions.getTransport()).isEqualTo(HTTP);
DatastoreOptions.newBuilder()
.setTransportOptions(HttpTransportOptions.newBuilder().build())
.setProjectId(PROJECT_ID)
.build();
assertThat(httpDatastoreOptions.getTransportOptions()).isInstanceOf(HttpTransportOptions.class);

// custom grpc transport
DatastoreOptions grpcDatastoreOptions =
DatastoreOptions.newBuilder().setTransport(GRPC).setProjectId(PROJECT_ID).build();
assertThat(grpcDatastoreOptions.getTransport()).isEqualTo(GRPC);
DatastoreOptions.newBuilder()
.setTransportOptions(GrpcTransportOptions.newBuilder().build())
.setProjectId(PROJECT_ID)
.build();
assertThat(grpcDatastoreOptions.getTransportOptions()).isInstanceOf(GrpcTransportOptions.class);
}

@Test
Expand All @@ -116,15 +119,4 @@ public void testToBuilder() {
assertNotEquals(original, newOptions);
assertNotEquals(original.hashCode(), newOptions.hashCode());
}

@Test
public void testInvalidTransport() {
try {
DatastoreOptions.newBuilder()
.setTransportOptions(EasyMock.createMock(TransportOptions.class));
Assert.fail();
} catch (IllegalArgumentException ex) {
assertNotNull(ex.getMessage());
}
}
}