yixiaoshen commented on code in PR #22175:
URL: https://github.com/apache/beam/pull/22175#discussion_r916367451
##########
sdks/java/io/google-cloud-platform/src/test/java/org/apache/beam/sdk/io/gcp/firestore/FirestoreV1FnRunQueryTest.java:
##########
@@ -283,62 +299,86 @@ protected RunQueryFn getFn(
private static final class TestData {
+ static final FieldReference FILTER_FIELD_PATH =
+ FieldReference.newBuilder().setFieldPath("foo").build();
+ static final Filter FIELD_EQUALS_BAR =
+ Filter.newBuilder()
+ .setFieldFilter(
+ FieldFilter.newBuilder()
+ .setField(FILTER_FIELD_PATH)
+ .setOp(Operator.EQUAL)
+ .setValue(Value.newBuilder().setStringValue("bar"))
+ .build())
+ .build();
+ static final Filter FIELD_NOT_EQUALS_FOO =
+ Filter.newBuilder()
+ .setFieldFilter(
+ FieldFilter.newBuilder()
+ .setField(FILTER_FIELD_PATH)
+ .setOp(Operator.NOT_EQUAL)
+ .setValue(Value.newBuilder().setStringValue("foo"))
+ .build())
+ .build();
+
private final RunQueryRequest request;
private final RunQueryResponse response1;
private final RunQueryResponse response2;
private final RunQueryResponse response3;
- public TestData(String projectId, Function<FieldReference, List<Order>>
orderFunction) {
- String fieldPath = "foo";
- FieldReference foo =
FieldReference.newBuilder().setFieldPath(fieldPath).build();
+ public TestData(
+ String projectId, Function<FieldReference, List<Order>> orderFunction,
Filter filter) {
StructuredQuery.Builder builder =
StructuredQuery.newBuilder()
.addFrom(
CollectionSelector.newBuilder()
.setAllDescendants(false)
.setCollectionId("collection"))
- .setWhere(
- Filter.newBuilder()
- .setFieldFilter(
- FieldFilter.newBuilder()
- .setField(foo)
- .setOp(Operator.EQUAL)
-
.setValue(Value.newBuilder().setStringValue("bar"))
- .build()));
-
- orderFunction.apply(foo).forEach(builder::addOrderBy);
+ .setWhere(filter);
+
+ orderFunction.apply(FILTER_FIELD_PATH).forEach(builder::addOrderBy);
request =
RunQueryRequest.newBuilder()
.setParent(String.format("projects/%s/databases/(default)/document", projectId))
.setStructuredQuery(builder)
.build();
- response1 = newResponse(fieldPath, 1);
- response2 = newResponse(fieldPath, 2);
- response3 = newResponse(fieldPath, 3);
+ response1 = newResponse(1);
+ response2 = newResponse(2);
+ response3 = newResponse(3);
}
- private static RunQueryResponse newResponse(String field, int docNumber) {
+ /**
+ * Returns single-document response like this: { "__name__":
"doc-{docNumber}", "foo": "bar",
+ * "fo`o.m`ap": { "bar.key": "bar.val" } }
Review Comment:
You added a super complicated case "\`fo\\\\\`o.m\\\\\`ap\`.\`bar.key\`" and
the most simple case "foo" for the order by, can we also add two test cases
that are in between these two: (1) x.y as y inside the map x, both x and y are
simple strings and not escaped; (2) \`x.y\` as a single property with a dot in
the property name. So the document might look like this:
```
{
"foo": "bar"
"fo`o.m`ap": { "bar.key": "bar.val" }
"baz" : {"qux" : "val"}
"quux.quuz" : 123
}
```
you might parameterize the tests if it makes things easier, or just writing
these 4 separate tests also seem fine.
##########
sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/firestore/QueryUtils.java:
##########
@@ -0,0 +1,311 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you 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 org.apache.beam.sdk.io.gcp.firestore;
+
+import com.google.firestore.v1.StructuredQuery;
+import com.google.firestore.v1.StructuredQuery.Direction;
+import com.google.firestore.v1.StructuredQuery.FieldFilter;
+import com.google.firestore.v1.StructuredQuery.FieldFilter.Operator;
+import com.google.firestore.v1.StructuredQuery.FieldReference;
+import com.google.firestore.v1.StructuredQuery.Filter;
+import com.google.firestore.v1.StructuredQuery.Order;
+import com.google.firestore.v1.StructuredQuery.UnaryFilter;
+import com.google.firestore.v1.Value;
+import com.google.firestore.v1.Value.ValueTypeCase;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Ascii;
+import
org.apache.beam.vendor.guava.v26_0_jre.com.google.common.collect.ImmutableSet;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+/**
+ * Contains several internal utility functions for Firestore query handling,
such as filling
+ * implicit ordering or escaping field references.
+ */
+class QueryUtils {
+
+ private static final ImmutableSet<Operator> INEQUALITY_FIELD_FILTER_OPS =
+ ImmutableSet.of(
+ FieldFilter.Operator.LESS_THAN,
+ FieldFilter.Operator.LESS_THAN_OR_EQUAL,
+ FieldFilter.Operator.GREATER_THAN,
+ FieldFilter.Operator.GREATER_THAN_OR_EQUAL,
+ FieldFilter.Operator.NOT_EQUAL,
+ FieldFilter.Operator.NOT_IN);
+ private static final ImmutableSet<UnaryFilter.Operator>
INEQUALITY_UNARY_FILTER_OPS =
+ ImmutableSet.of(UnaryFilter.Operator.IS_NOT_NAN,
UnaryFilter.Operator.IS_NOT_NULL);
+
+ static List<Order> getImplicitOrderBy(StructuredQuery query) {
+ List<String> expectedImplicitOrders = new ArrayList<>();
+ if (query.hasWhere()) {
+ fillInequalityFields(query.getWhere(), expectedImplicitOrders);
+ }
+ if (!expectedImplicitOrders.contains("__name__")) {
+ expectedImplicitOrders.add("__name__");
+ }
+ for (Order order : query.getOrderByList()) {
+ String orderField = order.getField().getFieldPath();
+ expectedImplicitOrders.remove(orderField);
+ }
+
+ List<Order> additionalOrders = new ArrayList<>();
+ if (!expectedImplicitOrders.isEmpty()) {
+ Direction lastDirection =
+ query.getOrderByCount() == 0
+ ? Direction.ASCENDING
+ : query.getOrderByList().get(query.getOrderByCount() -
1).getDirection();
+
+ for (String field : expectedImplicitOrders) {
+ additionalOrders.add(
+ Order.newBuilder()
+ .setDirection(lastDirection)
+
.setField(FieldReference.newBuilder().setFieldPath(field).build())
+ .build());
+ }
+ }
+
+ return additionalOrders;
+ }
+
+ private static void fillInequalityFields(Filter filter, List<String> result)
{
+ switch (filter.getFilterTypeCase()) {
+ case FIELD_FILTER:
+ if
(INEQUALITY_FIELD_FILTER_OPS.contains(filter.getFieldFilter().getOp())) {
+ String fieldPath = filter.getFieldFilter().getField().getFieldPath();
+ if (!result.contains(fieldPath)) {
+ result.add(fieldPath);
+ }
+ }
+ break;
+ case COMPOSITE_FILTER:
+ filter.getCompositeFilter().getFiltersList().forEach(f ->
fillInequalityFields(f, result));
+ break;
+ case UNARY_FILTER:
+ if
(INEQUALITY_UNARY_FILTER_OPS.contains(filter.getUnaryFilter().getOp())) {
+ String fieldPath = filter.getUnaryFilter().getField().getFieldPath();
+ if (!result.contains(fieldPath)) {
+ result.add(fieldPath);
+ }
+ }
+ break;
+ default:
+ break;
+ }
+ }
+
+ @Nullable
+ static Value lookupDocumentValue(List<String> segments, Map<String, Value>
valueMap) {
+ String field = segments.remove(0);
+ Value value = valueMap.get(field);
+ if (segments.isEmpty()) {
+ return value;
+ }
+ // Field path traversal is not done, recurse into map values.
+ if (value == null ||
!value.getValueTypeCase().equals(ValueTypeCase.MAP_VALUE)) {
+ return null;
+ }
+ return lookupDocumentValue(segments, value.getMapValue().getFieldsMap());
+ }
+
+ private static final String UNQUOTED_NAME_REGEX_STRING =
"([a-zA-Z_][a-zA-Z_0-9]*)";
+ private static final String QUOTED_NAME_REGEX_STRING =
"(`(?:[^`\\\\]|(?:\\\\.))+`)";
+ // After each segment follows a dot and more characters, or the end of the
string.
+ private static final Pattern FIELD_PATH_SEGMENT_REGEX =
+ Pattern.compile(
+ String.format("(?:%s|%s)(\\..+|$)", UNQUOTED_NAME_REGEX_STRING,
QUOTED_NAME_REGEX_STRING),
+ Pattern.DOTALL);
+
+ static List<String> resolveOrderByFieldPath(String fieldPath) throws
IllegalArgumentException {
+ if (fieldPath.isEmpty()) {
+ throw new IllegalArgumentException("Could not resolve empty field path");
+ }
+ List<String> segments = new ArrayList<>();
+ while (!fieldPath.isEmpty()) {
+ Matcher segmentMatcher = FIELD_PATH_SEGMENT_REGEX.matcher(fieldPath);
+ boolean foundMatch = segmentMatcher.lookingAt();
+ if (!foundMatch) {
+ throw new IllegalArgumentException("OrderBy field path was malformed");
+ }
+ String fieldName = segmentMatcher.group(1);
+ // Unquoted group is null, use quoted group.
+ if (fieldName == null) {
+ fieldName = segmentMatcher.group(2);
+ String escaped = escapeFieldName(fieldName.substring(1,
fieldName.length() - 1));
+ segments.add(escaped);
+ } else {
+ segments.add(fieldName);
+ }
+ fieldPath = fieldPath.substring(fieldName.length());
+ if (fieldPath.startsWith(".")) {
Review Comment:
SG, maybe add a inline comment that when fieldPath is not empty it must
start with "." here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
