fabriziofortino commented on code in PR #1187:
URL: https://github.com/apache/jackrabbit-oak/pull/1187#discussion_r1381788455
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/nodetype/NodeTypeIndex.java:
##########
@@ -102,7 +102,10 @@ public Cursor query(Filter filter, NodeState root) {
@Override
public String getPlan(Filter filter, NodeState root) {
- return "nodeType " + filter.toString();
+ return "nodeType\n" +
+ " path: " + filter.getPath() + "\n" +
+ " primaryTypes: " + filter.getPrimaryTypes().toString() +
"\n" +
+ " mixinTypes: " + filter.getMixinTypes().toString() + "\n";
Review Comment:
`toString` calls are redundant:
```suggestion
" primaryTypes: " + filter.getPrimaryTypes() + "\n" +
" mixinTypes: " + filter.getMixinTypes() + "\n";
```
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java:
##########
@@ -0,0 +1,150 @@
+/*
+ * 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.jackrabbit.oak.query;
+
+import java.util.Locale;
+
+/**
+ * Formatter for JCR queries in order to make them easier to read. Formatting
is
+ * done on a best-effort basis.
+ *
+ * Warning: Care was taken to not add newlines inside string literals and so
on,
+ * but there is still no guarantee that the formatted query is semantically
+ * equal to the original one. It is recommended to run queries that are
returned
+ * by these methods.
+ */
+public class QueryFormatter {
+
+ /**
+ * Detect whether the query is an XPath query.
+ *
+ * @param query the query
+ * @param language the language, if known, or null
+ * @return true if xpath
+ */
+ public static boolean isXPath(String query, String language) {
+ if (language != null) {
+ return "xpath".equals(language);
+ }
+ query = query.trim().toLowerCase(Locale.ENGLISH);
+ // explain queries
+ if (query.startsWith("explain")) {
+ query = query.substring("explain".length()).trim();
+ if (query.startsWith("measure")) {
+ query = query.substring("explain".length()).trim();
Review Comment:
should it be like this? can we add a test for this case?
```suggestion
query = query.substring("measure".length()).trim();
```
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java:
##########
@@ -0,0 +1,150 @@
+/*
+ * 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.jackrabbit.oak.query;
+
+import java.util.Locale;
+
+/**
+ * Formatter for JCR queries in order to make them easier to read. Formatting
is
+ * done on a best-effort basis.
+ *
+ * Warning: Care was taken to not add newlines inside string literals and so
on,
+ * but there is still no guarantee that the formatted query is semantically
+ * equal to the original one. It is recommended to run queries that are
returned
+ * by these methods.
+ */
+public class QueryFormatter {
+
+ /**
+ * Detect whether the query is an XPath query.
+ *
+ * @param query the query
+ * @param language the language, if known, or null
+ * @return true if xpath
+ */
+ public static boolean isXPath(String query, String language) {
+ if (language != null) {
+ return "xpath".equals(language);
+ }
+ query = query.trim().toLowerCase(Locale.ENGLISH);
+ // explain queries
+ if (query.startsWith("explain")) {
+ query = query.substring("explain".length()).trim();
+ if (query.startsWith("measure")) {
+ query = query.substring("explain".length()).trim();
+ }
+ }
+ // union queries
+ while (query.startsWith("(")) {
+ query = query.substring("(".length()).trim();
+ }
+ if (query.startsWith("select")) {
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Format the query into a more human-readable way, by adding newlines.
+ * Warning: newlines are also added inside e.g. string literals.
+ *
+ * @param query the query (may not be null)
+ * @param language the query language, or null if unknown
+ * @return the formatted query
+ */
+ public static String format(String query, String language) {
Review Comment:
since the `query` param cannot be `null`, what about annotating it?
```suggestion
public static String format(@NotNull String query, String language) {
```
##########
oak-core/src/test/java/org/apache/jackrabbit/oak/query/QueryFormatterTest.java:
##########
@@ -0,0 +1,178 @@
+/*
+ * 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.jackrabbit.oak.query;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.util.Random;
+
+import org.apache.jackrabbit.oak.query.QueryFormatter;
Review Comment:
not needed
```suggestion
```
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java:
##########
@@ -0,0 +1,150 @@
+/*
+ * 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.jackrabbit.oak.query;
+
+import java.util.Locale;
+
+/**
+ * Formatter for JCR queries in order to make them easier to read. Formatting
is
+ * done on a best-effort basis.
+ *
+ * Warning: Care was taken to not add newlines inside string literals and so
on,
+ * but there is still no guarantee that the formatted query is semantically
+ * equal to the original one. It is recommended to run queries that are
returned
+ * by these methods.
+ */
+public class QueryFormatter {
+
+ /**
+ * Detect whether the query is an XPath query.
+ *
+ * @param query the query
+ * @param language the language, if known, or null
+ * @return true if xpath
+ */
+ public static boolean isXPath(String query, String language) {
+ if (language != null) {
+ return "xpath".equals(language);
+ }
+ query = query.trim().toLowerCase(Locale.ENGLISH);
+ // explain queries
+ if (query.startsWith("explain")) {
+ query = query.substring("explain".length()).trim();
+ if (query.startsWith("measure")) {
+ query = query.substring("explain".length()).trim();
+ }
+ }
+ // union queries
+ while (query.startsWith("(")) {
+ query = query.substring("(".length()).trim();
+ }
+ if (query.startsWith("select")) {
+ return false;
+ }
+ return true;
Review Comment:
this could be simplified
```suggestion
return !query.startsWith("select");
```
##########
oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/SelectorImpl.java:
##########
@@ -427,10 +426,14 @@ public String getPlan(NodeState rootState) {
buff.append(index.getPlan(createFilter(true), rootState));
}
} else {
- buff.append("no-index");
+ buff.append("no-index\n");
}
if (!selectorConstraints.isEmpty()) {
Review Comment:
this `if` block is empty. Should we move it?
--
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]
