Make QueryBuilderProtoConverter and QueryBuilderProtoConverterRegistry an SPI

Signed-off-by: Karen Xu <karenxyr@gmail.com>

Author: karenyrx

CHANGELOG.md

@@ -9,6 +9,57 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Add temporal routing processors for time-based document routing ([#18920](https://github.com/opensearch-project/OpenSearch/issues/18920))
 
 
+- [Feature Request] Enhance Terms lookup query to support query clause instead of docId ([#18195](https://github.com/opensearch-project/OpenSearch/issues/18195))
+- Add hierarchical routing processors for ingest and search pipelines ([#18826](https://github.com/opensearch-project/OpenSearch/pull/18826))
+- Add ACL-aware routing processors for ingest and search pipelines ([#18834](https://github.com/opensearch-project/OpenSearch/pull/18834))
+- Add support for Warm Indices Write Block on Flood Watermark breach ([#18375](https://github.com/opensearch-project/OpenSearch/pull/18375))
+- FS stats for warm nodes based on addressable space ([#18767](https://github.com/opensearch-project/OpenSearch/pull/18767))
+- Add support for custom index name resolver from cluster plugin ([#18593](https://github.com/opensearch-project/OpenSearch/pull/18593))
+- Rename WorkloadGroupTestUtil to WorkloadManagementTestUtil ([#18709](https://github.com/opensearch-project/OpenSearch/pull/18709))
+- Disallow resize for Warm Index, add Parameterized ITs for close in remote store ([#18686](https://github.com/opensearch-project/OpenSearch/pull/18686))
+- Ability to run Code Coverage with Gradle and produce the jacoco reports locally ([#18509](https://github.com/opensearch-project/OpenSearch/issues/18509))
+- Extend BooleanQuery must_not rewrite to numeric must, term, and terms queries ([#18498](https://github.com/opensearch-project/OpenSearch/pull/18498))
+- [Workload Management] Update logging and Javadoc, rename QueryGroup to WorkloadGroup ([#18711](https://github.com/opensearch-project/OpenSearch/issues/18711))
+- Add NodeResourceUsageStats to ClusterInfo ([#18480](https://github.com/opensearch-project/OpenSearch/issues/18472))
+- Introduce SecureHttpTransportParameters experimental API (to complement SecureTransportParameters counterpart) ([#18572](https://github.com/opensearch-project/OpenSearch/issues/18572))
+- Create equivalents of JSM's AccessController in the java agent ([#18346](https://github.com/opensearch-project/OpenSearch/issues/18346))
+- [WLM] Add WLM mode validation for workload group CRUD requests ([#18652](https://github.com/opensearch-project/OpenSearch/issues/18652))
+- Introduced a new cluster-level API to fetch remote store metadata (segments and translogs) for each shard of an index. ([#18257](https://github.com/opensearch-project/OpenSearch/pull/18257))
+- Add last index request timestamp columns to the `_cat/indices` API. ([10766](https://github.com/opensearch-project/OpenSearch/issues/10766))
+- Introduce a new pull-based ingestion plugin for file-based indexing (for local testing) ([#18591](https://github.com/opensearch-project/OpenSearch/pull/18591))
+- Add support for search pipeline in search and msearch template ([#18564](https://github.com/opensearch-project/OpenSearch/pull/18564))
+- [Workload Management] Modify logging message in WorkloadGroupService ([#18712](https://github.com/opensearch-project/OpenSearch/pull/18712))
+- Add BooleanQuery rewrite moving constant-scoring must clauses to filter clauses ([#18510](https://github.com/opensearch-project/OpenSearch/issues/18510))
+- Add functionality for plugins to inject QueryCollectorContext during QueryPhase ([#18637](https://github.com/opensearch-project/OpenSearch/pull/18637))
+- Add support for non-timing info in profiler ([#18460](https://github.com/opensearch-project/OpenSearch/issues/18460))
+- [Rule-based auto tagging] Bug fix and improvements ([#18726](https://github.com/opensearch-project/OpenSearch/pull/18726))
+- Extend Approximation Framework to other numeric types ([#18530](https://github.com/opensearch-project/OpenSearch/issues/18530))
+- Add Semantic Version field type mapper and extensive unit tests([#18454](https://github.com/opensearch-project/OpenSearch/pull/18454))
+- Pass index settings to system ingest processor factories. ([#18708](https://github.com/opensearch-project/OpenSearch/pull/18708))
+- Add fetch phase profiling. ([#18664](https://github.com/opensearch-project/OpenSearch/pull/18664))
+- Include named queries from rescore contexts in matched_queries array ([#18697](https://github.com/opensearch-project/OpenSearch/pull/18697))
+- Add the configurable limit on rule cardinality ([#18663](https://github.com/opensearch-project/OpenSearch/pull/18663))
+- Disable approximation framework when dealing with multiple sorts ([#18763](https://github.com/opensearch-project/OpenSearch/pull/18763))
+- [Experimental] Start in "clusterless" mode if a clusterless ClusterPlugin is loaded ([#18479](https://github.com/opensearch-project/OpenSearch/pull/18479))
+- [Star-Tree] Add star-tree search related stats ([#18707](https://github.com/opensearch-project/OpenSearch/pull/18707))
+- Add support for plugins to profile information ([#18656](https://github.com/opensearch-project/OpenSearch/pull/18656))
+- Add support for Combined Fields query ([#18724](https://github.com/opensearch-project/OpenSearch/pull/18724))
+- Make GRPC transport extensible to allow plugins to register and expose their own GRPC services ([#18516](https://github.com/opensearch-project/OpenSearch/pull/18516))
+- Added approximation support for range queries with now in date field ([#18511](https://github.com/opensearch-project/OpenSearch/pull/18511))
+- Upgrade to protobufs 0.6.0 and clean up deprecated TermQueryProtoUtils code ([#18880](https://github.com/opensearch-project/OpenSearch/pull/18880))
+- Expand fetch phase profiling to multi-shard queries ([#18887](https://github.com/opensearch-project/OpenSearch/pull/18887))
+- Prevent shard initialization failure due to streaming consumer errors ([#18877](https://github.com/opensearch-project/OpenSearch/pull/18877))
+- APIs for stream transport and new stream-based search api action ([#18722](https://github.com/opensearch-project/OpenSearch/pull/18722))
+- Add support for custom remote store segment path prefix to support clusterless configurations ([#18750](https://github.com/opensearch-project/OpenSearch/issues/18750))
+- Added the core process for warming merged segments in remote-store enabled domains ([#18683](https://github.com/opensearch-project/OpenSearch/pull/18683))
+- Streaming aggregation ([#18874](https://github.com/opensearch-project/OpenSearch/pull/18874))
+- Optimize Composite Aggregations by removing unnecessary object allocations ([#18531](https://github.com/opensearch-project/OpenSearch/pull/18531))
+- [Star-Tree] Add search support for ip field type ([#18671](https://github.com/opensearch-project/OpenSearch/pull/18671))
+- [Derived Source] Add integration of derived source feature across various paths like get/search/recovery ([#18565](https://github.com/opensearch-project/OpenSearch/pull/18565))
+- Supporting Scripted Metric Aggregation when reducing aggregations in InternalValueCount and InternalAvg ([18411](https://github.com/opensearch-project/OpenSearch/pull18411)))
+- Support `search_after` numeric queries with Approximation Framework ([#18896](https://github.com/opensearch-project/OpenSearch/pull/18896))
+- Add skip_list parameter to Numeric Field Mappers (default false) ([#18889](https://github.com/opensearch-project/OpenSearch/pull/18889))
+- Publish transport-grpc-spi exposing QueryBuilderProtoConverter and QueryBuilderProtoConverterRegistry ([#18949](https://github.com/opensearch-project/OpenSearch/pull/18949))
 ### Changed
 - Add CompletionStage variants to methods in the Client Interface and default to ActionListener impl ([#18998](https://github.com/opensearch-project/OpenSearch/pull/18998))
 

modules/transport-grpc/build.gradle

@@ -21,6 +21,7 @@ testClusters {
 }
 
 dependencies {
+  api project('spi')
   compileOnly "com.google.code.findbugs:jsr305:3.0.2"
   runtimeOnly "com.google.guava:guava:${versions.guava}"
   implementation "com.google.errorprone:error_prone_annotations:2.24.1"

modules/transport-grpc/spi/README.md

@@ -0,0 +1,118 @@
+# transport-grpc-spi
+
+Service Provider Interface (SPI) for the OpenSearch gRPC transport module. This module provides interfaces and utilities that allow external plugins to extend the gRPC transport functionality.
+
+## Overview
+
+The `transport-grpc-spi` module enables plugin developers to:
+- Implement custom query converters for gRPC transport
+- Extend gRPC protocol buffer handling
+- Register custom query types that can be processed via gRPC
+
+## Key Components
+
+### QueryBuilderProtoConverter
+
+Interface for converting protobuf query messages to OpenSearch QueryBuilder objects.
+
+```java
+public interface QueryBuilderProtoConverter {
+    QueryContainer.QueryContainerCase getHandledQueryCase();
+    QueryBuilder fromProto(QueryContainer queryContainer);
+}
+```
+
+### QueryBuilderProtoConverterSpiRegistry
+
+Registry that manages and discovers all available query converters. External plugins can register their custom converters through this registry.
+
+## Usage for Plugin Developers
+
+### 1. Add Dependency
+
+Add the SPI dependency to your plugin's `build.gradle`:
+
+```gradle
+dependencies {
+    compileOnly 'org.opensearch.plugin:transport-grpc-spi:${opensearch.version}'
+    compileOnly 'org.opensearch:protobufs:${protobufs.version}'
+}
+```
+
+### 2. Implement Custom Query Converter
+
+```java
+public class MyCustomQueryConverter implements QueryBuilderProtoConverter {
+
+    @Override
+    public QueryContainer.QueryContainerCase getHandledQueryCase() {
+        return QueryContainer.QueryContainerCase.MY_CUSTOM_QUERY;
+    }
+
+    @Override
+    public QueryBuilder fromProto(QueryContainer queryContainer) {
+        // Convert your custom protobuf query to QueryBuilder
+        MyCustomQuery customQuery = queryContainer.getMyCustomQuery();
+        return new MyCustomQueryBuilder(customQuery.getField(), customQuery.getValue());
+    }
+}
+```
+
+### 3. Register Your Converter
+
+In your plugin's main class, register the converter:
+
+```java
+public class MyPlugin extends Plugin implements ExtensiblePlugin {
+
+    @Override
+    public Collection<Object> createComponents(Client client, ClusterService clusterService,
+                                             ThreadPool threadPool, ResourceWatcherService resourceWatcherService,
+                                             ScriptService scriptService, NamedXContentRegistry xContentRegistry,
+                                             Environment environment, NodeEnvironment nodeEnvironment,
+                                             NamedWriteableRegistry namedWriteableRegistry,
+                                             IndexNameExpressionResolver indexNameExpressionResolver,
+                                             Supplier<RepositoriesService> repositoriesServiceSupplier) {
+
+        // Get the registry and register your converter
+        QueryBuilderProtoConverterSpiRegistry registry =
+            // Obtain registry from OpenSearch's dependency injection
+        registry.registerConverter(new MyCustomQueryConverter());
+
+        return Collections.emptyList();
+    }
+}
+```
+
+## Testing
+
+### Unit Tests
+
+```bash
+./gradlew :modules:transport-grpc:spi:test
+```
+
+### Testing Your Custom Converter
+
+```java
+@Test
+public void testCustomQueryConverter() {
+    MyCustomQueryConverter converter = new MyCustomQueryConverter();
+
+    // Create test protobuf query
+    QueryContainer queryContainer = QueryContainer.newBuilder()
+        .setMyCustomQuery(MyCustomQuery.newBuilder()
+            .setField("test_field")
+            .setValue("test_value")
+            .build())
+        .build();
+
+    // Convert and verify
+    QueryBuilder result = converter.fromProto(queryContainer);
+    assertThat(result, instanceOf(MyCustomQueryBuilder.class));
+
+    MyCustomQueryBuilder customQuery = (MyCustomQueryBuilder) result;
+    assertEquals("test_field", customQuery.fieldName());
+    assertEquals("test_value", customQuery.value());
+}
+```

modules/transport-grpc/spi/build.gradle

@@ -0,0 +1,22 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+apply plugin: 'opensearch.build'
+apply plugin: 'opensearch.publish'
+
+base {
+  group = 'org.opensearch.plugin'
+  archivesName = 'transport-grpc-spi'
+}
+
+dependencies {
+  api project(":server")
+  api "org.opensearch:protobufs:0.6.0"
+
+  testImplementation project(":test:framework")
+}

modules/transport-grpc/spi/licenses/protobufs-0.6.0.jar.sha1

@@ -0,0 +1 @@
+1675c5085e1376fd1a107b87f7e325944ab5b4dc