You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by nf...@apache.org on 2025/01/08 08:17:41 UTC
(jackrabbit-oak) branch trunk updated: OAK-11356 - Code cleanups to indexing module (#1954)
This is an automated email from the ASF dual-hosted git repository.
nfsantos pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
The following commit(s) were added to refs/heads/trunk by this push:
new 5c0cbfc834 OAK-11356 - Code cleanups to indexing module (#1954)
5c0cbfc834 is described below
commit 5c0cbfc834924ff96158af4872b257a75ddaa9d1
Author: Nuno Santos <ns...@adobe.com>
AuthorDate: Wed Jan 8 09:17:35 2025 +0100
OAK-11356 - Code cleanups to indexing module (#1954)
---
.../index/CompositeIndexEditorProvider.java | 16 ++++---------
.../plugins/index/property/PropertyIndexUtil.java | 21 +++++++----------
.../plugins/index/property/ValuePatternUtil.java | 2 +-
.../jackrabbit/oak/plugins/name/NameValidator.java | 9 ++++----
.../index/lucene/LuceneIndexEditorProvider.java | 27 +++++++++++-----------
.../property/PropertyIndexUpdateCallback.java | 16 ++++++-------
.../index/lucene/writer/DefaultIndexWriter.java | 14 +++++------
.../jackrabbit/oak/index/IndexerSupport.java | 2 +-
.../jackrabbit/oak/index/OutOfBandIndexerBase.java | 2 +-
.../jackrabbit/oak/index/OutOfBandIndexer.java | 5 ++--
.../search/spi/editor/FulltextIndexEditor.java | 3 +--
11 files changed, 51 insertions(+), 66 deletions(-)
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/CompositeIndexEditorProvider.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/CompositeIndexEditorProvider.java
index a9c59e8c72..531540d8e6 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/CompositeIndexEditorProvider.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/CompositeIndexEditorProvider.java
@@ -34,21 +34,13 @@ import org.jetbrains.annotations.NotNull;
public class CompositeIndexEditorProvider implements IndexEditorProvider {
@NotNull
- public static IndexEditorProvider compose(
- @NotNull Collection<IndexEditorProvider> providers) {
+ public static IndexEditorProvider compose(@NotNull Collection<IndexEditorProvider> providers) {
if (providers.isEmpty()) {
- return new IndexEditorProvider() {
- @Override
- public Editor getIndexEditor(
- @NotNull String type, @NotNull NodeBuilder builder, @NotNull NodeState root, @NotNull IndexUpdateCallback callback) {
- return null;
- }
- };
+ return (type, builder, root, callback) -> null;
} else if (providers.size() == 1) {
return providers.iterator().next();
} else {
- return new CompositeIndexEditorProvider(
- List.copyOf(providers));
+ return new CompositeIndexEditorProvider(List.copyOf(providers));
}
}
@@ -66,7 +58,7 @@ public class CompositeIndexEditorProvider implements IndexEditorProvider {
public Editor getIndexEditor(
@NotNull String type, @NotNull NodeBuilder builder, @NotNull NodeState root, @NotNull IndexUpdateCallback callback)
throws CommitFailedException {
- List<Editor> indexes = new ArrayList<>();
+ List<Editor> indexes = new ArrayList<>(providers.size());
for (IndexEditorProvider provider : providers) {
Editor e = provider.getIndexEditor(type, builder, root, callback);
if (e != null) {
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndexUtil.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndexUtil.java
index fa84a97524..413ac01587 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndexUtil.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndexUtil.java
@@ -19,7 +19,6 @@
package org.apache.jackrabbit.oak.plugins.index.property;
-import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.HashSet;
@@ -44,22 +43,18 @@ public class PropertyIndexUtil {
if (set == null || set.isEmpty()) {
return set;
}
- try {
- Set<String> values = new HashSet<String>();
- for(String v : set) {
+ Set<String> values = new HashSet<>();
+ for (String v : set) {
+ if (v.isEmpty()) {
+ v = EMPTY_TOKEN;
+ } else {
if (v.length() > MAX_STRING_LENGTH) {
v = v.substring(0, MAX_STRING_LENGTH);
}
- if (v.isEmpty()) {
- v = EMPTY_TOKEN;
- } else {
- v = URLEncoder.encode(v, StandardCharsets.UTF_8.name());
- }
- values.add(v);
+ v = URLEncoder.encode(v, StandardCharsets.UTF_8);
}
- return values;
- } catch (UnsupportedEncodingException e) {
- throw new IllegalStateException("UTF-8 is unsupported", e);
+ values.add(v);
}
+ return values;
}
}
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/ValuePatternUtil.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/ValuePatternUtil.java
index fcab0575af..a7ae8843a5 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/ValuePatternUtil.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/ValuePatternUtil.java
@@ -152,7 +152,7 @@ public final class ValuePatternUtil {
if (value == null) {
return null;
}
- Set<String> values = new HashSet<String>();
+ Set<String> values = new HashSet<>();
for (String v : value.getValue(Type.STRINGS)) {
if (!pattern.matches(v)) {
continue;
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/name/NameValidator.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/name/NameValidator.java
index 9ede34e829..c8e0db0f4a 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/name/NameValidator.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/name/NameValidator.java
@@ -48,7 +48,6 @@ class NameValidator extends DefaultValidator {
* Flag controlling the strictness of the namespace checks. if {@code true}
* namespaces existence will not be checked, otherwise referencing a
* non-existent namespace will cause a {@link CommitFailedException}.
- *
* Used only for the case where lucene index definitions are registered via
* {@link RepositoryInitializer}s.
*/
@@ -117,7 +116,8 @@ class NameValidator extends DefaultValidator {
private void checkPrefix(String prefix) throws CommitFailedException {
if (prefix.isEmpty() || !contains(prefixes, namespaces, prefix)) {
- String msg = "Invalid namespace prefix(" + prefixes + "): " + prefix;
+ String msg = "Invalid namespace prefix(" + prefixes + "): " + prefix +
+ " in " + namespaces + " " + CollectionUtils.toSet(namespaces.getChildNodeNames());
if (initPhase && !strictInitialNSChecks) {
LOG.warn(msg);
return;
@@ -138,7 +138,7 @@ class NameValidator extends DefaultValidator {
}
} else if (Type.PATH.equals(property.getType()) || Type.PATHS.equals(property.getType())) {
for (String value : property.getValue(Type.PATHS)) {
- for (String name: PathUtils.elements(value)) {
+ for (String name : PathUtils.elements(value)) {
checkValidValue(name);
}
}
@@ -180,8 +180,7 @@ class NameValidator extends DefaultValidator {
}
@Override
- public Validator childNodeChanged(
- String name, NodeState before, NodeState after) {
+ public Validator childNodeChanged(String name, NodeState before, NodeState after) {
return this;
}
diff --git a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditorProvider.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditorProvider.java
index db34a5eaa1..668f91df98 100644
--- a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditorProvider.java
+++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditorProvider.java
@@ -71,21 +71,22 @@ import static org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexConstant
*
*/
public class LuceneIndexEditorProvider implements IndexEditorProvider {
+ private final static Logger LOG = LoggerFactory.getLogger(LuceneIndexEditorProvider.class);
- private final Logger log = LoggerFactory.getLogger(getClass());
private final IndexCopier indexCopier;
private final ExtractedTextCache extractedTextCache;
private final IndexAugmentorFactory augmentorFactory;
private final IndexTracker indexTracker;
private final MountInfoProvider mountInfoProvider;
private final ActiveDeletedBlobCollector activeDeletedBlobCollector;
+ private final LuceneIndexMBean mbean;
+ private final StatisticsProvider statisticsProvider;
+
private GarbageCollectableBlobStore blobStore;
private IndexingQueue indexingQueue;
private boolean nrtIndexingEnabled;
private LuceneIndexWriterConfig writerConfig = new LuceneIndexWriterConfig();
- private final LuceneIndexMBean mbean;
- private final StatisticsProvider statisticsProvider;
/**
* Number of indexed Lucene document that can be held in memory
@@ -153,8 +154,8 @@ public class LuceneIndexEditorProvider implements IndexEditorProvider {
@NotNull IndexUpdateCallback callback)
throws CommitFailedException {
if (TYPE_LUCENE.equals(type)) {
- checkArgument(callback instanceof ContextAwareCallback, "callback instance not of type " +
- "ContextAwareCallback [%s]", callback);
+ checkArgument(callback instanceof ContextAwareCallback,
+ "callback instance not of type ContextAwareCallback [%s]", callback);
IndexingContext indexingContext = ((ContextAwareCallback)callback).getIndexingContext();
BlobDeletionCallback blobDeletionCallback = activeDeletedBlobCollector.getBlobDeletionCallback();
indexingContext.registerIndexCommitCallback(blobDeletionCallback);
@@ -179,15 +180,14 @@ public class LuceneIndexEditorProvider implements IndexEditorProvider {
//some initializer code does the commit with out it. So ignore such calls with
//warning now
//TODO Revisit use of warn level once all such cases are analyzed
- log.warn("No CommitContext found for commit", new Exception());
+ LOG.warn("No CommitContext found for commit", new Exception());
return null;
}
//TODO Also check if index has been done once
- writerFactory = new LocalIndexWriterFactory(getDocumentHolder(commitContext),
- indexPath);
+ writerFactory = new LocalIndexWriterFactory(getDocumentHolder(commitContext), indexPath);
//IndexDefinition from tracker might differ from one passed here for reindexing
//case which should be fine. However reusing existing definition would avoid
@@ -195,15 +195,16 @@ public class LuceneIndexEditorProvider implements IndexEditorProvider {
if (indexTracker != null){
indexDefinition = indexTracker.getIndexDefinition(indexPath);
if (indexDefinition != null && !indexDefinition.hasMatchingNodeTypeReg(root)){
- log.debug("Detected change in NodeType registry for index {}. Would not use " +
+ LOG.debug("Detected change in NodeType registry for index {}. Would not use " +
"existing index definition", indexDefinition.getIndexPath());
indexDefinition = null;
}
}
if (indexDefinition == null) {
- indexDefinition = LuceneIndexDefinition.newBuilder(root, definition.getNodeState(),
- indexPath).build();
+ indexDefinition = LuceneIndexDefinition
+ .newBuilder(root, definition.getNodeState(), indexPath)
+ .build();
}
if (indexDefinition.hasSyncPropertyDefinitions()) {
@@ -314,8 +315,8 @@ public class LuceneIndexEditorProvider implements IndexEditorProvider {
private static class COWDirectoryCleanupCallback implements IndexCommitCallback, COWDirectoryTracker {
private static final Logger LOG = LoggerFactory.getLogger(COWDirectoryCleanupCallback.class);
- private List<CopyOnWriteDirectory> openedCoWDirectories = new ArrayList<>();
- private List<File> reindexingLocalDirectories = new ArrayList<>();
+ private final List<CopyOnWriteDirectory> openedCoWDirectories = new ArrayList<>();
+ private final List<File> reindexingLocalDirectories = new ArrayList<>();
@Override
public void commitProgress(IndexProgress indexProgress) {
diff --git a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/PropertyIndexUpdateCallback.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/PropertyIndexUpdateCallback.java
index 773032f20b..376444fc48 100644
--- a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/PropertyIndexUpdateCallback.java
+++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/property/PropertyIndexUpdateCallback.java
@@ -42,7 +42,6 @@ import org.slf4j.LoggerFactory;
import static java.util.Objects.requireNonNull;
import static org.apache.jackrabbit.guava.common.base.Suppliers.ofInstance;
-import static java.util.Collections.emptySet;
import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.INDEX_CONTENT_NODE_NAME;
import static org.apache.jackrabbit.oak.plugins.index.lucene.property.HybridPropertyIndexUtil.PROPERTY_INDEX;
import static org.apache.jackrabbit.oak.plugins.index.lucene.property.HybridPropertyIndexUtil.PROP_CREATED;
@@ -79,11 +78,11 @@ public class PropertyIndexUpdateCallback implements PropertyUpdateCallback {
return;
}
- Set<String> beforeKeys = getValueKeys(before, pd.valuePattern);
- Set<String> afterKeys = getValueKeys(after, pd.valuePattern);
+ HashSet<String> beforeKeys = getValueKeys(before, pd.valuePattern);
+ HashSet<String> afterKeys = getValueKeys(after, pd.valuePattern);
//Remove duplicates
- Set<String> sharedKeys = new HashSet<>(beforeKeys);
+ HashSet<String> sharedKeys = new HashSet<>(beforeKeys);
sharedKeys.retainAll(afterKeys);
beforeKeys.removeAll(sharedKeys);
afterKeys.removeAll(sharedKeys);
@@ -107,7 +106,7 @@ public class PropertyIndexUpdateCallback implements PropertyUpdateCallback {
nodePath,
null,
null,
- emptySet(), //Disable pruning with empty before keys
+ Set.of(), //Disable pruning with empty before keys
afterKeys);
}
@@ -150,8 +149,7 @@ public class PropertyIndexUpdateCallback implements PropertyUpdateCallback {
}
String headBucketName = idx.getString(PROP_HEAD_BUCKET);
- requireNonNull(headBucketName, String.format("[%s] property not found in [%s] for index [%s]",
- PROP_HEAD_BUCKET, idx, indexPath));
+ requireNonNull(headBucketName, "[" + PROP_HEAD_BUCKET + "] property not found in [" + idx + "] for index [" + indexPath + "]");
return idx.child(headBucketName);
}
@@ -164,8 +162,8 @@ public class PropertyIndexUpdateCallback implements PropertyUpdateCallback {
return idx;
}
- private static Set<String> getValueKeys(PropertyState property, ValuePattern pattern) {
- Set<String> keys = new HashSet<>();
+ private static HashSet<String> getValueKeys(PropertyState property, ValuePattern pattern) {
+ HashSet<String> keys = new HashSet<>();
if (property != null
&& property.getType().tag() != PropertyType.BINARY
&& property.count() != 0) {
diff --git a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/DefaultIndexWriter.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/DefaultIndexWriter.java
index b080d73140..536a3d6527 100644
--- a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/DefaultIndexWriter.java
+++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/writer/DefaultIndexWriter.java
@@ -30,6 +30,7 @@ import java.util.List;
import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.api.Type;
+import org.apache.jackrabbit.oak.commons.IOUtils;
import org.apache.jackrabbit.oak.commons.PerfLogger;
import org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexDefinition;
import org.apache.jackrabbit.oak.plugins.index.lucene.directory.DirectoryFactory;
@@ -121,7 +122,7 @@ class DefaultIndexWriter implements LuceneIndexWriter {
//it indicates that the index is empty. In such a case trigger
//creation of write such that an empty Lucene index state is persisted
//in directory
- if (reindex && writer == null){
+ if (reindex && writer == null) {
getWriter();
}
@@ -148,7 +149,7 @@ class DefaultIndexWriter implements LuceneIndexWriter {
writer.close();
PERF_LOGGER.end(start, -1, "Closed writer for directory {}", definition);
- if (!indexUpdated){
+ if (!indexUpdated) {
long genAtEnd = getLatestGeneration(directory);
indexUpdated = genAtEnd != genAtStart;
}
@@ -184,8 +185,9 @@ class DefaultIndexWriter implements LuceneIndexWriter {
/**
* eventually update suggest dictionary
- * @throws IOException if suggest dictionary update fails
+ *
* @param analyzer the analyzer used to update the suggester
+ * @throws IOException if suggest dictionary update fails
*/
private boolean updateSuggester(Analyzer analyzer, Calendar currentTime) throws IOException {
synchronized (this) {
@@ -228,7 +230,7 @@ class DefaultIndexWriter implements LuceneIndexWriter {
Calendar suggesterLastUpdatedTime = ISO8601.parse(suggesterLastUpdatedValue.getValue(Type.DATE));
int updateFrequency = definition.getSuggesterUpdateFrequencyMinutes();
- Calendar nextSuggestUpdateTime = (Calendar)suggesterLastUpdatedTime.clone();
+ Calendar nextSuggestUpdateTime = (Calendar) suggesterLastUpdatedTime.clone();
nextSuggestUpdateTime.add(Calendar.MINUTE, updateFrequency);
if (currentTime.after(nextSuggestUpdateTime)) {
updateSuggestions = (writer != null || isIndexUpdatedAfter(suggesterLastUpdatedTime));
@@ -292,8 +294,6 @@ class DefaultIndexWriter implements LuceneIndexWriter {
}
sb.append(", ");
}
- log.trace("Directory overall size: {}, files: {}",
- org.apache.jackrabbit.oak.commons.IOUtils.humanReadableByteCount(overallSize),
- sb.toString());
+ log.trace("Directory overall size: {}, files: {}", IOUtils.humanReadableByteCount(overallSize), sb);
}
}
diff --git a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/IndexerSupport.java b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/IndexerSupport.java
index e6fec0a9ac..1e37232b27 100644
--- a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/IndexerSupport.java
+++ b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/IndexerSupport.java
@@ -136,7 +136,7 @@ public class IndexerSupport {
LOG.warn("Using head state for indexing. Such an index cannot be imported back");
} else {
checkpointedState = indexHelper.getNodeStore().retrieve(checkpoint);
- requireNonNull(checkpointedState, String.format("Not able to retrieve revision referred via checkpoint [%s]", checkpoint));
+ requireNonNull(checkpointedState, "Not able to retrieve revision referred via checkpoint [" + checkpoint + "]");
checkpointInfo = indexHelper.getNodeStore().checkpointInfo(checkpoint);
}
return checkpointedState;
diff --git a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexerBase.java b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexerBase.java
index 2a9fb02b72..7b28f47215 100644
--- a/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexerBase.java
+++ b/oak-run-commons/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexerBase.java
@@ -133,7 +133,7 @@ public abstract class OutOfBandIndexerBase implements Closeable, IndexUpdateCall
nodesTraversed++;
}
- protected void preformIndexUpdate(NodeState baseState) throws IOException, CommitFailedException {
+ private void preformIndexUpdate(NodeState baseState) throws IOException, CommitFailedException {
NodeBuilder builder = copyOnWriteStore.getRoot().builder();
IndexUpdate indexUpdate = new IndexUpdate(
diff --git a/oak-run/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexer.java b/oak-run/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexer.java
index 3b12efee0a..a4fe341e8e 100644
--- a/oak-run/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexer.java
+++ b/oak-run/src/main/java/org/apache/jackrabbit/oak/index/OutOfBandIndexer.java
@@ -20,13 +20,14 @@ package org.apache.jackrabbit.oak.index;
import java.io.File;
import java.io.IOException;
+import java.util.List;
+
import org.apache.jackrabbit.oak.plugins.index.CompositeIndexEditorProvider;
import org.apache.jackrabbit.oak.plugins.index.IndexEditorProvider;
import org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexEditorProvider;
import org.apache.jackrabbit.oak.plugins.index.lucene.directory.DirectoryFactory;
import org.apache.jackrabbit.oak.plugins.index.lucene.directory.FSDirectoryFactory;
-import static java.util.Arrays.asList;
import static java.util.Objects.requireNonNull;
public class OutOfBandIndexer extends OutOfBandIndexerBase {
@@ -44,7 +45,7 @@ public class OutOfBandIndexer extends OutOfBandIndexerBase {
IndexEditorProvider lucene = createLuceneEditorProvider();
IndexEditorProvider property = createPropertyEditorProvider();
- return CompositeIndexEditorProvider.compose(asList(lucene, property));
+ return CompositeIndexEditorProvider.compose(List.of(lucene, property));
}
private IndexEditorProvider createPropertyEditorProvider() throws IOException {
diff --git a/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/FulltextIndexEditor.java b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/FulltextIndexEditor.java
index d229c81223..e636842df2 100644
--- a/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/FulltextIndexEditor.java
+++ b/oak-search/src/main/java/org/apache/jackrabbit/oak/plugins/index/search/spi/editor/FulltextIndexEditor.java
@@ -320,8 +320,7 @@ public class FulltextIndexEditor<D> implements IndexEditor, Aggregate.AggregateR
}
static class MatcherState {
- final static MatcherState NONE = new MatcherState(Collections.<Aggregate.Matcher>emptyList(),
- Collections.<Aggregate.Matcher>emptyList());
+ final static MatcherState NONE = new MatcherState(List.of(), List.of());
final List<Aggregate.Matcher> matched;
final List<Aggregate.Matcher> inherited;