You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by re...@apache.org on 2025/01/13 11:58:31 UTC
(sling-org-apache-sling-resourceresolver) branch SLING-12611 created (now 0e3796e)
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a change to branch SLING-12611
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-resourceresolver.git
at 0e3796e SLING-12611: Resource Resolver: refactor MapEntries - extract PagedQueryIterator
This branch includes the following new commits:
new 0e3796e SLING-12611: Resource Resolver: refactor MapEntries - extract PagedQueryIterator
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(sling-org-apache-sling-resourceresolver) 01/01: SLING-12611: Resource Resolver: refactor MapEntries - extract PagedQueryIterator
Posted by re...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
reschke pushed a commit to branch SLING-12611
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-resourceresolver.git
commit 0e3796e9e2e555a0af60e39d227ba480f51ede22
Author: Julian Reschke <re...@apache.org>
AuthorDate: Mon Jan 13 12:58:15 2025 +0100
SLING-12611: Resource Resolver: refactor MapEntries - extract PagedQueryIterator
---
.../resourceresolver/impl/mapping/MapEntries.java | 142 +----------------
.../impl/mapping/PagedQueryIterator.java | 175 +++++++++++++++++++++
.../impl/mapping/PagedQueryIteratorTest.java | 29 ++--
3 files changed, 186 insertions(+), 160 deletions(-)
diff --git a/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java
index 801c66c..c87b2c3 100644
--- a/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java
+++ b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/MapEntries.java
@@ -960,7 +960,7 @@ public class MapEntries implements
}
// escapes string for use as literal in JCR SQL within single quotes
- private static String queryLiteral(String input) {
+ static String queryLiteral(String input) {
return input.replace("'", "''");
}
@@ -1370,146 +1370,6 @@ public class MapEntries implements
return it;
}
- /**
- * Utility class for running paged queries.
- */
- protected class PagedQueryIterator implements Iterator<Resource> {
-
- private ResourceResolver resolver;
- private String subject;
- private String propertyName;
- private String query;
- private String lastKey = "";
- private String lastValue = null;
- private Iterator<Resource> it;
- private int count = 0;
- private int page = 0;
- private int pageSize;
- private Resource next = null;
- private String[] defaultValue = new String[0];
- private int largestPage = 0;
- private String largestKeyValue = "";
- private int largestKeyCount = 0;
- private int currentKeyCount = 0;
-
- /**
- * @param subject name of the query, will be used only for logging
- * @param propertyName name of multivalued string property to query on (used for diagnostics)
- * @param resolver resource resolver
- * @param query query string in SQL2 syntax
- * @param pageSize page size (start a new query after page size is exceeded)
- */
- public PagedQueryIterator(String subject, String propertyName, ResourceResolver resolver, String query, int pageSize) {
- this.subject = subject;
- this.propertyName = propertyName;
- this.resolver = resolver;
- this.query = query;
- this.pageSize = pageSize;
- nextPage();
- }
-
- private void nextPage() {
- count = 0;
- String tquery = String.format(query, queryLiteral(lastKey));
- log.debug("start {} query (page {}): {}", subject, page, tquery);
- long queryStart = System.nanoTime();
- this.it = resolver.findResources(tquery, "JCR-SQL2");
- long queryElapsed = System.nanoTime() - queryStart;
- log.debug("end {} query (page {}); elapsed {}ms", subject, page, TimeUnit.NANOSECONDS.toMillis(queryElapsed));
- page += 1;
- }
-
- private Resource getNext() throws NoSuchElementException {
- Resource resource = it.next();
- count += 1;
- final String[] values = resource.getValueMap().get(propertyName, defaultValue);
-
- if (values.length > 0) {
- String value = values[0];
- if (value.compareTo(lastKey) < 0) {
- String message = String.format("unexpected query result in page %d, %s of '%s' despite querying for > '%s'",
- (page - 1), propertyName, value, lastKey);
- log.error(message);
- throw new RuntimeException(message);
- }
- if (lastValue != null && value.compareTo(lastValue) < 0) {
- String message = String.format("unexpected query result in page %d, property name '%s', got '%s', last value was '%s'",
- (page - 1), propertyName, value, lastValue);
- log.error(message);
- throw new RuntimeException(message);
- }
-
- // keep information about large key counts
- if (value.equals(lastValue)) {
- currentKeyCount += 1;
- } else {
- if (currentKeyCount > largestKeyCount) {
- largestKeyCount = currentKeyCount + 1;
- largestKeyValue = lastValue;
- }
- currentKeyCount = 0;
- }
-
- // start next page?
- if (count > pageSize && !value.equals(lastValue)) {
- updatePageStats();
- lastKey = value;
- nextPage();
- return getNext();
- }
- lastValue = value;
- }
-
- return resource;
- }
-
- @Override
- public boolean hasNext() {
- if (next == null) {
- try {
- next = getNext();
- } catch (NoSuchElementException ex) {
- if (currentKeyCount > largestKeyCount) {
- largestKeyCount = currentKeyCount + 1;
- largestKeyValue = lastValue;
- }
- updatePageStats();
- // there are no more
- next = null;
- }
- }
- return next != null;
- }
-
- @Override
- public Resource next() throws NoSuchElementException {
- Resource result = next != null ? next : getNext();
- next = null;
- return result;
- }
-
- private void updatePageStats() {
- largestPage = Math.max(largestPage, count - 1);
- log.debug("read {} query (page {}); {} entries, last key was: {}, largest page so far: {}", subject, page - 1,
- count, lastKey, largestPage);
- }
-
- public @NotNull String getStatistics() {
- return String.format(" (max. page size: %d, number of pages: %d)", largestPage, page);
- }
-
- public @NotNull String getWarning() {
- int warnAt = pageSize * 10;
- if (largestKeyCount > warnAt) {
- return String.format(
- "Largest number of aliases with the same 'first' selector exceeds expectation of %d (value '%s' appears %d times)",
- warnAt, largestKeyValue, largestKeyCount);
- } else {
- return "";
- }
- }
- }
-
/**
* Load vanity paths - search for all nodes (except under /jcr:system)
* having a sling:vanityPath property
diff --git a/src/main/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIterator.java b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIterator.java
new file mode 100644
index 0000000..090ee43
--- /dev/null
+++ b/src/main/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIterator.java
@@ -0,0 +1,175 @@
+/*
+ * 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.sling.resourceresolver.impl.mapping;
+
+import org.apache.sling.api.resource.Resource;
+import org.apache.sling.api.resource.ResourceResolver;
+import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+import java.util.concurrent.TimeUnit;
+
+import static org.apache.sling.resourceresolver.impl.mapping.MapEntries.queryLiteral;
+
+/**
+ * Utility class for running paged queries.
+ */
+public class PagedQueryIterator implements Iterator<Resource> {
+
+ /** default log */
+ private final Logger log = LoggerFactory.getLogger(PagedQueryIterator.class);
+
+ private final String subject;
+ private final String propertyName;
+ private final ResourceResolver resolver;
+ private final String query;
+ private final int pageSize;
+
+ private String lastKey = "";
+ private String lastValue = null;
+ private Iterator<Resource> it;
+ private int count = 0;
+ private int page = 0;
+ private Resource next = null;
+ private final String[] defaultValue = new String[0];
+ private int largestPage = 0;
+ private String largestKeyValue = "";
+ private int largestKeyCount = 0;
+ private int currentKeyCount = 0;
+
+ /**
+ * @param subject name of the query, will be used only for logging
+ * @param propertyName name of multivalued string property to query on (used for diagnostics)
+ * @param resolver resource resolver
+ * @param query query string in SQL2 syntax
+ * @param pageSize page size (start a new query after page size is exceeded)
+ */
+ public PagedQueryIterator(String subject, String propertyName, ResourceResolver resolver, String query, int pageSize) {
+ this.subject = subject;
+ this.propertyName = propertyName;
+ this.resolver = resolver;
+ this.query = query;
+ this.pageSize = pageSize;
+ nextPage();
+ }
+
+ private void nextPage() {
+ count = 0;
+ String formattedQuery = String.format(query, queryLiteral(lastKey));
+ log.debug("start {} query (page {}): {}", subject, page, formattedQuery);
+ long queryStart = System.nanoTime();
+ this.it = resolver.findResources(formattedQuery, "JCR-SQL2");
+ long queryElapsed = System.nanoTime() - queryStart;
+ log.debug("end {} query (page {}); elapsed {}ms", subject, page, TimeUnit.NANOSECONDS.toMillis(queryElapsed));
+ page += 1;
+ }
+
+ private Resource getNext() throws NoSuchElementException {
+ Resource resource = it.next();
+ count += 1;
+ final String[] values = resource.getValueMap().get(propertyName, defaultValue);
+
+ if (values.length > 0) {
+ String value = values[0];
+ if (value.compareTo(lastKey) < 0) {
+ String message = String.format("unexpected query result in page %d, %s of '%s' despite querying for > '%s'",
+ (page - 1), propertyName, value, lastKey);
+ log.error(message);
+ throw new RuntimeException(message);
+ }
+ if (lastValue != null && value.compareTo(lastValue) < 0) {
+ String message = String.format("unexpected query result in page %d, property name '%s', got '%s', last value was '%s'",
+ (page - 1), propertyName, value, lastValue);
+ log.error(message);
+ throw new RuntimeException(message);
+ }
+
+ // keep information about large key counts
+ if (value.equals(lastValue)) {
+ currentKeyCount += 1;
+ } else {
+ if (currentKeyCount > largestKeyCount) {
+ largestKeyCount = currentKeyCount + 1;
+ largestKeyValue = lastValue;
+ }
+ currentKeyCount = 0;
+ }
+
+ // start next page?
+ if (count > pageSize && !value.equals(lastValue)) {
+ updatePageStats();
+ lastKey = value;
+ nextPage();
+ return getNext();
+ }
+ lastValue = value;
+ }
+
+ return resource;
+ }
+
+ @Override
+ public boolean hasNext() {
+ if (next == null) {
+ try {
+ next = getNext();
+ } catch (NoSuchElementException ex) {
+ if (currentKeyCount > largestKeyCount) {
+ largestKeyCount = currentKeyCount + 1;
+ largestKeyValue = lastValue;
+ }
+ updatePageStats();
+ // there are no more
+ next = null;
+ }
+ }
+ return next != null;
+ }
+
+ @Override
+ public Resource next() throws NoSuchElementException {
+ Resource result = next != null ? next : getNext();
+ next = null;
+ return result;
+ }
+
+ private void updatePageStats() {
+ largestPage = Math.max(largestPage, count - 1);
+ log.debug("read {} query (page {}); {} entries, last key was: {}, largest page so far: {}", subject, page - 1,
+ count, lastKey, largestPage);
+ }
+
+ public @NotNull String getStatistics() {
+ return String.format(" (max. page size: %d, number of pages: %d)", largestPage, page);
+ }
+
+ public @NotNull String getWarning() {
+ int warnAt = pageSize * 10;
+ if (largestKeyCount > warnAt) {
+ return String.format(
+ "Largest number of %s entries with the same 'first' selector exceeds expectation of %d (value '%s' appears %d times)",
+ subject, warnAt, largestKeyValue, largestKeyCount);
+ } else {
+ return "";
+ }
+ }
+}
diff --git a/src/test/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIteratorTest.java b/src/test/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIteratorTest.java
index 7e23e1f..7ac0bb7 100644
--- a/src/test/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIteratorTest.java
+++ b/src/test/java/org/apache/sling/resourceresolver/impl/mapping/PagedQueryIteratorTest.java
@@ -31,7 +31,6 @@ import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.Map;
-import java.util.Optional;
import java.util.function.Predicate;
import java.util.stream.Collectors;
@@ -39,17 +38,13 @@ import org.apache.sling.api.resource.QuerySyntaxException;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.api.resource.ValueMap;
import org.apache.sling.api.resource.path.Path;
-import org.apache.sling.resourceresolver.impl.ResourceResolverMetrics;
-import org.apache.sling.resourceresolver.impl.mapping.MapEntries.PagedQueryIterator;
import org.junit.Before;
import org.junit.Test;
import org.mockito.MockitoAnnotations;
public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
- private MapEntries mapEntries;
-
- private static String PROPNAME = "prop";
+ private static final String PROPNAME = "prop";
@SuppressWarnings("unchecked")
@Override
@@ -62,23 +57,19 @@ public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
when(resourceResolverFactory.getServiceResourceResolver(any(Map.class))).thenReturn(resourceResolver);
when(resourceResolverFactory.getObservationPaths()).thenReturn(new Path[] { new Path("/") });
when(resourceResolverFactory.getMapRoot()).thenReturn(MapEntries.DEFAULT_MAP_ROOT);
-
- Optional<ResourceResolverMetrics> metrics = Optional.empty();
-
- mapEntries = new MapEntries(resourceResolverFactory, bundleContext, eventAdmin, stringInterpolationProvider, metrics);
}
@Test
public void testEmptyQuery() {
- when(resourceResolver.findResources(eq("empty"), eq("JCR-SQL2"))).thenReturn(Collections.<Resource> emptySet().iterator());
- Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver, "empty", 2000);
+ when(resourceResolver.findResources(eq("empty"), eq("JCR-SQL2"))).thenReturn(Collections.emptyIterator());
+ Iterator<Resource> it = new PagedQueryIterator("alias", PROPNAME, resourceResolver, "empty", 2000);
assertFalse(it.hasNext());
}
@Test(expected = QuerySyntaxException.class)
public void testMalformedQuery() {
when(resourceResolver.findResources(eq("malformed"), eq("JCR-SQL2"))).thenThrow(new QuerySyntaxException("x", "y", "z"));
- mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver, "malformed", 2000);
+ new PagedQueryIterator("alias", PROPNAME, resourceResolver, "malformed", 2000);
}
@Test
@@ -86,7 +77,7 @@ public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
String[] expected = new String[] { "a", "b", "c" };
Collection<Resource> expectedResources = toResourceList(expected);
when(resourceResolver.findResources(eq("simple"), eq("JCR-SQL2"))).thenReturn(expectedResources.iterator());
- PagedQueryIterator it = mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver, "simple", 2000);
+ PagedQueryIterator it = new PagedQueryIterator("alias", PROPNAME, resourceResolver, "simple", 2000);
for (String key : expected) {
assertEquals(key, getFirstValueOf(it.next(), PROPNAME));
}
@@ -99,7 +90,7 @@ public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
String[] expected = new String[] { "a", "b", "d", "c" };
Collection<Resource> expectedResources = toResourceList(expected);
when(resourceResolver.findResources(eq("testSimpleWrongOrder"), eq("JCR-SQL2"))).thenReturn(expectedResources.iterator());
- Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver, "testSimpleWrongOrder",
+ Iterator<Resource> it = new PagedQueryIterator("alias", PROPNAME, resourceResolver, "testSimpleWrongOrder",
2000);
while (it.hasNext()) {
it.next();
@@ -113,7 +104,7 @@ public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
Collection<Resource> expectedFilteredResources = filter("", expectedResources);
when(resourceResolver.findResources(eq("testPagedWithEmpty ''"), eq("JCR-SQL2")))
.thenReturn(expectedFilteredResources.iterator());
- PagedQueryIterator it = mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver, "testPagedWithEmpty '%s'",
+ PagedQueryIterator it = new PagedQueryIterator("alias", PROPNAME, resourceResolver, "testPagedWithEmpty '%s'",
2000);
checkResult(it, expected);
assertEquals("", it.getWarning());
@@ -129,10 +120,10 @@ public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
Collection<Resource> expectedFilteredResources = filter("", expectedResources);
when(resourceResolver.findResources(eq("testPagedLargePage ''"), eq("JCR-SQL2")))
.thenReturn(expectedFilteredResources.iterator());
- PagedQueryIterator it = mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver, "testPagedLargePage '%s'",
+ PagedQueryIterator it = new PagedQueryIterator("alias", PROPNAME, resourceResolver, "testPagedLargePage '%s'",
pageSize);
checkResult(it, expected);
- assertEquals("Largest number of aliases with the same 'first' selector exceeds expectation of " + pageSize * 10
+ assertEquals("Largest number of alias entries with the same 'first' selector exceeds expectation of " + pageSize * 10
+ " (value 'a' appears " + cnt + " times)", it.getWarning());
}
@@ -155,7 +146,7 @@ public class PagedQueryIteratorTest extends AbstractMappingMapEntriesTest {
.thenReturn(expectedFilteredResourcesC.iterator());
when(resourceResolver.findResources(eq("testPagedResourcesOnPageBoundaryLost 'd'"), eq("JCR-SQL2")))
.thenReturn(expectedFilteredResourcesD.iterator());
- Iterator<Resource> it = mapEntries.new PagedQueryIterator("alias", PROPNAME, resourceResolver,
+ Iterator<Resource> it = new PagedQueryIterator("alias", PROPNAME, resourceResolver,
"testPagedResourcesOnPageBoundaryLost '%s'", 5);
checkResult(it, expected);