Skip to content

SelectParser: add support for grouping labels #36887

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

Open
radu-gheorghe wants to merge 1 commit into
base: master
Choose a base branch
from
Open

SelectParser: add support for grouping labels #36887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 36 additions & 3 deletions container-search/src/main/java/com/yahoo/search/query/SelectParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import com.yahoo.collections.LazySet;
import com.yahoo.geo.DistanceParser;
import com.yahoo.geo.ParsedDegree;
import com.yahoo.javacc.UnicodeUtilities;
import com.yahoo.language.Language;
import com.yahoo.language.detect.Detector;
import com.yahoo.language.process.LinguisticsParameters;
Expand Down Expand Up @@ -358,20 +359,39 @@ private String toGroupingRequest(Inspector groupingJson) {
}

private void toGroupingRequest(Inspector groupingJson, StringBuilder b) {
toGroupingRequest(groupingJson, null, b);
}

private void toGroupingRequest(Inspector groupingJson, String parentKey, StringBuilder b) {
switch (groupingJson.type()) {
case ARRAY:
groupingJson.traverse((ArrayTraverser) (index, item) -> {
toGroupingRequest(item, b);
toGroupingRequest(item, parentKey, b);
if (index + 1 < groupingJson.entries())
b.append(",");
});
break;
case OBJECT:
groupingJson.traverse((ObjectTraverser) (name, object) -> {
if ("label".equals(name)) {
if (!"each".equals(parentKey)) {
throw new IllegalInputException(
"'label' is only valid inside an 'each' grouping operation, found inside '"
+ (parentKey == null ? "<root>" : parentKey) + "'");
}
return;
}
b.append(name);
b.append("(");
toGroupingRequest(object, b);
b.append(") ");
toGroupingRequest(object, name, b);
b.append(")");
if ("each".equals(name) && object.type() == OBJECT) {
String label = readLabel(object);
if (label != null) {
b.append(" as(").append(UnicodeUtilities.quote(label, '"')).append(")");
}
}
b.append(" ");
});
break;
case STRING:
Expand All @@ -383,6 +403,19 @@ private void toGroupingRequest(Inspector groupingJson, StringBuilder b) {
}
}

private static String readLabel(Inspector eachBody) {
Inspector field = eachBody.field("label");
if (!field.valid()) return null;
if (field.type() != STRING) {
throw new IllegalInputException("'label' in grouping must be a string, got " + field.type());
}
String s = field.asString();
if (s.isBlank()) {
throw new IllegalInputException("'label' in grouping must not be empty or whitespace");
}
return s;
}

private Item buildFunctionCall(String key, Inspector value) {
return switch (key) {
case WAND -> buildWand(key, value);
Expand Down
96 changes: 96 additions & 0 deletions container-search/src/test/java/com/yahoo/select/SelectTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import com.yahoo.search.grouping.request.AttributeValue;
import com.yahoo.search.grouping.request.CountAggregator;
import com.yahoo.search.grouping.request.EachOperation;
import com.yahoo.search.grouping.request.GroupingOperation;
import com.yahoo.search.grouping.request.MaxAggregator;
import com.yahoo.search.grouping.request.MinAggregator;
import com.yahoo.search.query.QueryTree;
Expand All @@ -57,6 +58,7 @@
import static org.junit.jupiter.api.Assertions.assertNotSame;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

Expand Down Expand Up @@ -916,6 +918,100 @@ void testMultipleOutputs() {
assertGrouping(expected, parseGrouping(grouping));
}

@Test
void testGroupingWithIdentifierLabel() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\", \"label\" : \"mylabel\" } } } ]";
String expected = "[[]all(group(a) each(output(count())) as(mylabel))]";
assertGrouping(expected, parseGrouping(grouping));
}

@Test
void testGroupingWithLabelContainingSpaces() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\", \"label\" : \"my label\" } } } ]";
GroupingOperation root = parseGrouping(grouping).get(0).getOperation();
EachOperation each = (EachOperation) root.getChild(0);
assertEquals("my label", each.getLabel());
}

@Test
void testGroupingWithLabelContainingQuoteAndBackslash() {
// Raw JSON: "label" : "a\"b\\c" -> decoded label should be the 5-char string a"b\c
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\", \"label\" : \"a\\\"b\\\\c\" } } } ]";
GroupingOperation root = parseGrouping(grouping).get(0).getOperation();
EachOperation each = (EachOperation) root.getChild(0);
assertEquals("a\"b\\c", each.getLabel());
}

@Test
void testGroupingWithLabelOnInnerEachOnly() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"group\" : \"b\", \"each\" : { \"output\" : \"count()\", \"label\" : \"inner\" } } } } ]";
GroupingOperation root = parseGrouping(grouping).get(0).getOperation();
EachOperation outer = (EachOperation) root.getChild(0);
EachOperation inner = (EachOperation) outer.getChild(0);
assertNull(outer.getLabel());
assertEquals("inner", inner.getLabel());
}

@Test
void testMultipleGroupingsOnlyOneLabeled() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\" } } }," +
" { \"all\" : { \"group\" : \"b\", \"each\" : { \"output\" : \"count()\", \"label\" : \"second\" } } } ]";
String expected = "[[]all(group(a) each(output(count()))), []all(group(b) each(output(count())) as(second))]";
assertGrouping(expected, parseGrouping(grouping));
}

@Test
void testGroupingLabelInsideAllIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"label\" : \"x\", \"each\" : { \"output\" : \"count()\" } } } ]";
var e = assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
assertTrue(e.getMessage().contains("'all'"), "Message should name 'all' parent: " + e.getMessage());
}

@Test
void testGroupingLabelInsideOutputObjectIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : { \"label\" : \"x\" } } } } ]";
var e = assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
assertTrue(e.getMessage().contains("'output'"), "Message should name 'output' parent: " + e.getMessage());
}

@Test
void testGroupingLabelInsideOutputArrayElementIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : [ \"count()\", { \"label\" : \"x\" } ] } } } ]";
var e = assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
assertTrue(e.getMessage().contains("'output'"), "Message should name 'output' parent: " + e.getMessage());
}

@Test
void testGroupingLabelAtTopLevelIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\" } }, \"label\" : \"x\" } ]";
var e = assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
assertTrue(e.getMessage().contains("<root>"), "Message should name <root> parent: " + e.getMessage());
}

@Test
void testGroupingLabelNumberIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\", \"label\" : 5 } } } ]";
assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
}

@Test
void testGroupingLabelNullIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\", \"label\" : null } } } ]";
assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
}

@Test
void testGroupingLabelEmptyIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\", \"label\" : \"\" } } } ]";
assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
}

@Test
void testGroupingLabelWhitespaceOnlyIsRejected() {
String grouping = "[ { \"all\" : { \"group\" : \"a\", \"each\" : { \"output\" : \"count()\", \"label\" : \" \" } } } ]";
assertThrows(IllegalInputException.class, () -> parseGrouping(grouping));
}

//------------------------------------------------------------------- Other tests

@Test
Expand Down