From 41d43e852d07a9026ae5be2add860c1f6980c7d6 Mon Sep 17 00:00:00 2001 From: kolea2 <45548808+kolea2@users.noreply.github.com> Date: Wed, 29 Nov 2023 10:32:44 -0500 Subject: [PATCH] refactor: rename internal class QueryAndReadOptions to QueryConfig (#1245) --- .../clirr-ignored-differences.xml | 29 +++++-------------- .../google/cloud/datastore/ReadOption.java | 14 ++++----- .../execution/AggregationQueryExecutor.java | 10 +++---- .../AggregationQueryRequestProtoPreparer.java | 11 ++++--- ...regationQueryRequestProtoPreparerTest.java | 12 ++++---- 5 files changed, 31 insertions(+), 45 deletions(-) diff --git a/google-cloud-datastore/clirr-ignored-differences.xml b/google-cloud-datastore/clirr-ignored-differences.xml index 018afb17e..34395cc01 100644 --- a/google-cloud-datastore/clirr-ignored-differences.xml +++ b/google-cloud-datastore/clirr-ignored-differences.xml @@ -1,29 +1,16 @@ + - com/google/cloud/datastore/Datastore - java.util.List reserveIds(com.google.cloud.datastore.Key[]) - 7012 + com/google/cloud/datastore/ReadOption$QueryAndReadOptions + * + 8001 - com/google/cloud/datastore/spi/v1/DatastoreRpc - com.google.datastore.v1.ReserveIdsResponse reserveIds(com.google.datastore.v1.ReserveIdsRequest) - 7012 - - - com/google/cloud/datastore/spi/v1/DatastoreRpc - com.google.datastore.v1.RunAggregationQueryResponse runAggregationQuery(com.google.datastore.v1.RunAggregationQueryRequest) - 7012 - - - com/google/cloud/datastore/Datastore - com.google.cloud.datastore.AggregationResults runAggregation(com.google.cloud.datastore.AggregationQuery, com.google.cloud.datastore.ReadOption[]) - 7012 - - - com/google/cloud/datastore/DatastoreReader - com.google.cloud.datastore.AggregationResults runAggregation(com.google.cloud.datastore.AggregationQuery) - 7012 + com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparer + *QueryAndReadOptions* + *QueryConfig* + 7005 diff --git a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/ReadOption.java b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/ReadOption.java index be5644da0..c249e45a6 100644 --- a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/ReadOption.java +++ b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/ReadOption.java @@ -142,17 +142,17 @@ static Map, ReadOption> asImmutableMap(List> { + public static class QueryConfig> { Q query; List readOptions; - private QueryAndReadOptions(Q query, List readOptions) { + private QueryConfig(Q query, List readOptions) { this.query = query; this.readOptions = readOptions; } - private QueryAndReadOptions(Q query) { + private QueryConfig(Q query) { this.query = query; this.readOptions = Collections.emptyList(); } @@ -165,13 +165,13 @@ public List getReadOptions() { return readOptions; } - public static > QueryAndReadOptions create(Q query) { - return new QueryAndReadOptions<>(query); + public static > QueryConfig create(Q query) { + return new QueryConfig<>(query); } - public static > QueryAndReadOptions create( + public static > QueryConfig create( Q query, List readOptions) { - return new QueryAndReadOptions<>(query, readOptions); + return new QueryConfig<>(query, readOptions); } } } diff --git a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/AggregationQueryExecutor.java b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/AggregationQueryExecutor.java index 14e425845..5a1fdd2c3 100644 --- a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/AggregationQueryExecutor.java +++ b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/AggregationQueryExecutor.java @@ -20,7 +20,7 @@ import com.google.cloud.datastore.AggregationResults; import com.google.cloud.datastore.DatastoreOptions; import com.google.cloud.datastore.ReadOption; -import com.google.cloud.datastore.ReadOption.QueryAndReadOptions; +import com.google.cloud.datastore.ReadOption.QueryConfig; import com.google.cloud.datastore.execution.request.AggregationQueryRequestProtoPreparer; import com.google.cloud.datastore.execution.response.AggregationQueryResponseTransformer; import com.google.cloud.datastore.spi.v1.DatastoreRpc; @@ -57,10 +57,10 @@ public AggregationResults execute(AggregationQuery query, ReadOption... readOpti private RunAggregationQueryRequest getRunAggregationQueryRequest( AggregationQuery query, ReadOption... readOptions) { - QueryAndReadOptions queryAndReadOptions = + QueryConfig queryConfig = readOptions == null - ? QueryAndReadOptions.create(query) - : QueryAndReadOptions.create(query, Arrays.asList(readOptions)); - return this.protoPreparer.prepare(queryAndReadOptions); + ? QueryConfig.create(query) + : QueryConfig.create(query, Arrays.asList(readOptions)); + return this.protoPreparer.prepare(queryConfig); } } diff --git a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparer.java b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparer.java index 5c4fb3e5f..475a47b58 100644 --- a/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparer.java +++ b/google-cloud-datastore/src/main/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparer.java @@ -22,7 +22,7 @@ import com.google.cloud.datastore.DatastoreOptions; import com.google.cloud.datastore.GqlQueryProtoPreparer; import com.google.cloud.datastore.ReadOption; -import com.google.cloud.datastore.ReadOption.QueryAndReadOptions; +import com.google.cloud.datastore.ReadOption.QueryConfig; import com.google.cloud.datastore.ReadOptionProtoPreparer; import com.google.cloud.datastore.StructuredQueryProtoPreparer; import com.google.cloud.datastore.aggregation.Aggregation; @@ -37,7 +37,7 @@ @InternalApi public class AggregationQueryRequestProtoPreparer - implements ProtoPreparer, RunAggregationQueryRequest> { + implements ProtoPreparer, RunAggregationQueryRequest> { private final DatastoreOptions datastoreOptions; private final StructuredQueryProtoPreparer structuredQueryProtoPreparer; @@ -52,10 +52,9 @@ public AggregationQueryRequestProtoPreparer(DatastoreOptions datastoreOptions) { } @Override - public RunAggregationQueryRequest prepare( - QueryAndReadOptions aggregationQueryAndReadOptions) { - AggregationQuery aggregationQuery = aggregationQueryAndReadOptions.getQuery(); - List readOptions = aggregationQueryAndReadOptions.getReadOptions(); + public RunAggregationQueryRequest prepare(QueryConfig queryConfig) { + AggregationQuery aggregationQuery = queryConfig.getQuery(); + List readOptions = queryConfig.getReadOptions(); PartitionId partitionId = getPartitionId(aggregationQuery); RunAggregationQueryRequest.Builder aggregationQueryRequestBuilder = RunAggregationQueryRequest.newBuilder() diff --git a/google-cloud-datastore/src/test/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparerTest.java b/google-cloud-datastore/src/test/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparerTest.java index 5fbb35b6e..0f22828d9 100644 --- a/google-cloud-datastore/src/test/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparerTest.java +++ b/google-cloud-datastore/src/test/java/com/google/cloud/datastore/execution/request/AggregationQueryRequestProtoPreparerTest.java @@ -38,7 +38,7 @@ import com.google.cloud.datastore.GqlQuery; import com.google.cloud.datastore.Query; import com.google.cloud.datastore.ReadOption; -import com.google.cloud.datastore.ReadOption.QueryAndReadOptions; +import com.google.cloud.datastore.ReadOption.QueryConfig; import com.google.common.collect.ImmutableMap; import com.google.datastore.v1.RunAggregationQueryRequest; import java.util.HashMap; @@ -91,7 +91,7 @@ public class AggregationQueryRequestProtoPreparerTest { @Test public void shouldPrepareAggregationQueryRequestWithGivenStructuredQuery() { RunAggregationQueryRequest runAggregationQueryRequest = - protoPreparer.prepare(QueryAndReadOptions.create(AGGREGATION_OVER_STRUCTURED_QUERY)); + protoPreparer.prepare(QueryConfig.create(AGGREGATION_OVER_STRUCTURED_QUERY)); assertThat(runAggregationQueryRequest.getProjectId()).isEqualTo(PROJECT_ID); assertThat(runAggregationQueryRequest.getDatabaseId()).isEqualTo(DATABASE_ID); @@ -114,7 +114,7 @@ public void shouldPrepareAggregationQueryRequestWithGivenStructuredQuery() { @Test public void shouldPrepareAggregationQueryRequestWithGivenGqlQuery() { RunAggregationQueryRequest runAggregationQueryRequest = - protoPreparer.prepare(QueryAndReadOptions.create(AGGREGATION_OVER_GQL_QUERY)); + protoPreparer.prepare(QueryConfig.create(AGGREGATION_OVER_GQL_QUERY)); assertThat(runAggregationQueryRequest.getProjectId()).isEqualTo(PROJECT_ID); assertThat(runAggregationQueryRequest.getDatabaseId()).isEqualTo(DATABASE_ID); @@ -172,9 +172,9 @@ public void shouldPrepareAggregationQueryWithNamespaceFromDatastoreOptions() { Query.newAggregationQueryBuilder().over(COMPLETED_TASK_GQL_QUERY).build(); RunAggregationQueryRequest runAggregationQueryFromStructuredQuery = - protoPreparer.prepare(QueryAndReadOptions.create(structuredQueryWithoutNamespace)); + protoPreparer.prepare(QueryConfig.create(structuredQueryWithoutNamespace)); RunAggregationQueryRequest runAggregationQueryFromGqlQuery = - protoPreparer.prepare(QueryAndReadOptions.create(gqlQueryWithoutNamespace)); + protoPreparer.prepare(QueryConfig.create(gqlQueryWithoutNamespace)); assertThat(runAggregationQueryFromStructuredQuery.getPartitionId().getNamespaceId()) .isEqualTo(NAMESPACE); @@ -183,6 +183,6 @@ public void shouldPrepareAggregationQueryWithNamespaceFromDatastoreOptions() { } private RunAggregationQueryRequest prepareQuery(AggregationQuery query, ReadOption readOption) { - return protoPreparer.prepare(QueryAndReadOptions.create(query, singletonList(readOption))); + return protoPreparer.prepare(QueryConfig.create(query, singletonList(readOption))); } }