nfsantos commented on code in PR #1187: URL: https://github.com/apache/jackrabbit-oak/pull/1187#discussion_r1383668625
########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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. Review Comment: Don't you mean that it is recommended **not** to run queries...? ########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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); Review Comment: If we do not want any locale related interpretation, it's better to use [Locale.ROOT](https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html#ROOT). ########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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("measure".length()).trim(); + } + } + // union queries + while (query.startsWith("(")) { + query = query.substring("(".length()).trim(); Review Comment: Maybe replace with `substring(1)` since we are just removing the first character? I understand the reason for this convention when it is a word, prevents mistakes, but when it's only a single character, maybe it is simpler to use 1. ########## oak-core/src/test/java/org/apache/jackrabbit/oak/plugins/index/property/MultiPropertyOrTest.java: ########## @@ -121,22 +121,17 @@ public void unionSortResultCount() throws Exception { root.commit(); List<Integer> nodes = Lists.newArrayList(); - Random r = new Random(); - int seed = -2; + Random r = new Random(1); Review Comment: Why? You want the test to be deterministic? ########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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("measure".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. Review Comment: ```suggestion * Format the query into a more human-readable way by adding newlines. ``` Adding newlines where? This sentence could be a bit more clear. ########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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("measure".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. Review Comment: ```suggestion * Warning: newlines are also added inside string literals. ``` In what conditions? Do you mean that they may also be added in some rare cases? ########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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); Review Comment: Being case sensitive is intentional? The query string is treated as case insensitive. If the language is supposed to be case sensitive, maybe add a note about it in the comments. ########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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("measure".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(@NotNull String query, String language) { + boolean xpath = isXPath(query, language); + if (xpath) { + return formatXPath(query); + } else { + return formatSQL(query); Review Comment: We are not sure here if the language is sql. If language is specified, add a check that it is either sql or xpath. If we autodetect, then can we check if it is sql by looking at if it starts with `select`? That way, we could have a nice error message saying that we do not recognize the language instead of failing with a syntax error or returning a string with newlines added in random places. ########## oak-core/src/main/java/org/apache/jackrabbit/oak/query/QueryFormatter.java: ########## @@ -0,0 +1,154 @@ +/* + * 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; + +import org.jetbrains.annotations.NotNull; + +/** + * 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("measure".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(@NotNull String query, String language) { + boolean xpath = isXPath(query, language); + if (xpath) { + return formatXPath(query); + } else { + return formatSQL(query); + } + } + + private static String formatXPath(String query) { + StringBuilder buff = new StringBuilder(query); + for (int i = 0; i < buff.length(); i++) { + char c = buff.charAt(i); + if (c == '\'' || c == '"') { Review Comment: This could be transformed into a switch. -- 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]
