feat: add lucene9 index provider as safe opt-in target

Introduce the oak-search-luceneNg module with lucene9 query/editor wiring, parity fixes, and indexing regressions covered while keeping behavior unchanged unless index definitions explicitly use type=lucene9.

Made-with: Cursor

Author: bhabegger

oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/ContextAwareCallback.java

@@ -19,11 +19,25 @@
 
 package org.apache.jackrabbit.oak.plugins.index;
 
+import org.apache.jackrabbit.oak.spi.state.NodeBuilder;
+
 /**
  * Extension to IndexUpdateCallback which also provides access to
- * {@link IndexingContext}
+ * {@link IndexingContext} and the root {@link NodeBuilder} for the current commit.
  */
 public interface ContextAwareCallback extends IndexUpdateCallback {
 
     IndexingContext getIndexingContext();
+
+    /**
+     * Returns the root {@link NodeBuilder} for the current commit, allowing
+     * index editors to write data outside the index definition subtree
+     * (e.g. to {@code /var/indexing/lucene/<indexName>}).
+     *
+     * @return the root NodeBuilder, or {@code null} when not available
+     *         (e.g. in test contexts where a plain mock is used)
+     */
+    default NodeBuilder getRootBuilder() {
+        return null;
+    }
 }

oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/IndexUpdate.java

@@ -637,6 +637,7 @@ private static final class IndexUpdateRootState {
         final IndexEditorProvider provider;
         final String async;
         final NodeState root;
+        final NodeBuilder rootBuilder;
         final CommitInfo commitInfo;
         final IndexDisabler indexDisabler;
         private boolean ignoreReindexFlags = IGNORE_REINDEX_FLAGS;
@@ -654,6 +655,7 @@ private IndexUpdateRootState(IndexEditorProvider provider, String async, NodeSta
             this.provider = requireNonNull(provider);
             this.async = async;
             this.root = requireNonNull(root);
+            this.rootBuilder = requireNonNull(builder);
             this.commitInfo = commitInfo;
             this.corruptIndexHandler = corruptIndexHandler;
             this.indexDisabler = new IndexDisabler(builder);
@@ -726,6 +728,11 @@ public IndexingContext getIndexingContext() {
                 return this;
             }
 
+            @Override
+            public NodeBuilder getRootBuilder() {
+                return IndexUpdateRootState.this.rootBuilder;
+            }
+
             //~--------------------------------< IndexingContext >
 
             @Override

oak-lucene/pom.xml

@@ -369,6 +369,12 @@
       <type>test-jar</type>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.apache.jackrabbit</groupId>
+      <artifactId>oak-search-test</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>org.apache.jackrabbit</groupId>
       <artifactId>jackrabbit-core</artifactId>

oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexProviderService.java

@@ -514,6 +514,7 @@ private void registerIndexEditor(BundleContext bundleContext, IndexTracker track
 
         Dictionary<String, Object> props = new Hashtable<>();
         props.put("type", TYPE_LUCENE);
+        props.put("leaf", Boolean.TRUE);
         regs.add(bundleContext.registerService(IndexEditorProvider.class.getName(), editorProvider, props));
         oakRegs.add(registerMBean(whiteboard,
                 TextExtractionStatsMBean.class,

oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexComparisonTest.java

@@ -0,0 +1,72 @@
+/*
+ * 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.plugins.index.lucene;
+
+import org.apache.jackrabbit.JcrConstants;
+import org.apache.jackrabbit.oak.InitialContent;
+import org.apache.jackrabbit.oak.Oak;
+import org.apache.jackrabbit.oak.api.ContentRepository;
+import org.apache.jackrabbit.oak.api.Tree;
+import org.apache.jackrabbit.oak.api.Type;
+import org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants;
+import org.apache.jackrabbit.oak.plugins.index.search.test.AbstractIndexComparisonTest;
+import org.apache.jackrabbit.oak.spi.commit.Observer;
+import org.apache.jackrabbit.oak.spi.query.QueryIndexProvider;
+import org.apache.jackrabbit.oak.spi.security.OpenSecurityProvider;
+
+import java.util.List;
+
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.INDEX_DEFINITIONS_NODE_TYPE;
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.REINDEX_PROPERTY_NAME;
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.TYPE_PROPERTY_NAME;
+import static org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants.INCLUDE_PROPERTY_NAMES;
+import static org.apache.jackrabbit.oak.plugins.memory.PropertyStates.createProperty;
+
+/**
+ * Runs the shared {@link AbstractIndexComparisonTest} scenarios against the legacy Lucene backend.
+ */
+public class LuceneIndexComparisonTest extends AbstractIndexComparisonTest {
+
+    @Override
+    protected ContentRepository createRepository() {
+        LuceneIndexProvider provider = new LuceneIndexProvider();
+        return new Oak()
+            .with(new InitialContent())
+            .with(new OpenSecurityProvider())
+            .with((QueryIndexProvider) provider)
+            .with((Observer) provider)
+            .with(new LuceneIndexEditorProvider())
+            .createContentRepository();
+    }
+
+    @Override
+    protected void createTestIndexNode() throws Exception {
+        setTraversalEnabled(false);
+    }
+
+    @Override
+    protected void createSearchIndex() throws Exception {
+        Tree def = root.getTree("/oak:index").addChild("luceneTestIndex");
+        def.setProperty(JcrConstants.JCR_PRIMARYTYPE, INDEX_DEFINITIONS_NODE_TYPE, Type.NAME);
+        def.setProperty(TYPE_PROPERTY_NAME, LuceneIndexConstants.TYPE_LUCENE);
+        def.setProperty(REINDEX_PROPERTY_NAME, true);
+        def.setProperty(FulltextIndexConstants.FULL_TEXT_ENABLED, false);
+        def.setProperty(createProperty(INCLUDE_PROPERTY_NAMES,
+                List.of("title", "description", "age", "price", "status", "category"), Type.STRINGS));
+        root.commit();
+    }
+}

oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexMinimalTest.java

@@ -0,0 +1,66 @@
+package org.apache.jackrabbit.oak.plugins.index.lucene;
+
+import org.apache.jackrabbit.oak.InitialContent;
+import org.apache.jackrabbit.oak.Oak;
+import org.apache.jackrabbit.oak.api.ContentRepository;
+import org.apache.jackrabbit.oak.api.Tree;
+import org.apache.jackrabbit.oak.api.Type;
+import org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants;
+import org.apache.jackrabbit.oak.query.AbstractQueryTest;
+import org.apache.jackrabbit.oak.spi.commit.Observer;
+import org.apache.jackrabbit.oak.spi.query.QueryIndexProvider;
+import org.apache.jackrabbit.oak.spi.security.OpenSecurityProvider;
+import org.junit.Test;
+
+import java.util.List;
+
+import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.*;
+import static org.apache.jackrabbit.oak.plugins.index.search.FulltextIndexConstants.INCLUDE_PROPERTY_NAMES;
+import static org.apache.jackrabbit.oak.plugins.memory.PropertyStates.createProperty;
+
+public class LuceneIndexMinimalTest extends AbstractQueryTest {
+    @Override protected void createTestIndexNode() throws Exception { setTraversalEnabled(false); }
+
+    @Override
+    protected ContentRepository createRepository() {
+        LuceneIndexProvider provider = new LuceneIndexProvider();
+        return new Oak().with(new InitialContent()).with(new OpenSecurityProvider())
+            .with((QueryIndexProvider) provider).with((Observer) provider)
+            .with(new LuceneIndexEditorProvider()).createContentRepository();
+    }
+
+    @Test
+    public void singleCommit() throws Exception {
+        // Index + content in ONE commit
+        Tree def = root.getTree("/oak:index").addChild("testIdx");
+        def.setProperty("jcr:primaryType", INDEX_DEFINITIONS_NODE_TYPE, Type.NAME);
+        def.setProperty(TYPE_PROPERTY_NAME, LuceneIndexConstants.TYPE_LUCENE);
+        def.setProperty(REINDEX_PROPERTY_NAME, true);
+        def.setProperty(FulltextIndexConstants.FULL_TEXT_ENABLED, false);
+        def.setProperty(createProperty(INCLUDE_PROPERTY_NAMES, List.of("title"), Type.STRINGS));
+
+        Tree page = root.getTree("/").addChild("content").addChild("page1");
+        page.setProperty("title", "Lucene Integration");
+        root.commit();
+
+        assertQuery("//element(*, nt:base)[@title = 'Lucene Integration']", "xpath", List.of("/content/page1"));
+    }
+
+    @Test
+    public void twoCommits() throws Exception {
+        // Index in first commit, content in second
+        Tree def = root.getTree("/oak:index").addChild("testIdx");
+        def.setProperty("jcr:primaryType", INDEX_DEFINITIONS_NODE_TYPE, Type.NAME);
+        def.setProperty(TYPE_PROPERTY_NAME, LuceneIndexConstants.TYPE_LUCENE);
+        def.setProperty(REINDEX_PROPERTY_NAME, true);
+        def.setProperty(FulltextIndexConstants.FULL_TEXT_ENABLED, false);
+        def.setProperty(createProperty(INCLUDE_PROPERTY_NAMES, List.of("title"), Type.STRINGS));
+        root.commit();
+
+        Tree page = root.getTree("/").addChild("content").addChild("page1");
+        page.setProperty("title", "Lucene Integration");
+        root.commit();
+
+        assertQuery("//element(*, nt:base)[@title = 'Lucene Integration']", "xpath", List.of("/content/page1"));
+    }
+}