feat(extension): add SPI-based enterprise API routing#3246
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces an SPI (Service Provider Interface) mechanism for routing enterprise/extension API requests to pluggable handlers, both on the broker and controller sides. Extension APIs are identified by API key IDs in the [10000, 19999] range. The PR adds request/response parsing extensions via RequestResponseExtensionProvider, broker-side dispatch via BrokerExtensionHandleDispatcher, and controller-side routing via the existing Controller.handleExtensionRequest.
Changes:
- Added
isExtensionApitoApiKeysand SPI-basedRequestResponseExtensionProvider/RequestResponseExtensionsfor parsing extension API requests/responses, replacing hard-codedAssertionErrorfallbacks inAbstractRequest/AbstractResponse. - Introduced
BrokerExtensionHandle,BrokerExtensionHandleProvider,BrokerExtensionContext, andBrokerExtensionHandleDispatcherSPI mechanism inElasticKafkaApisfor broker-side extension API routing. - Added extension API routing in
ElasticControllerApisto delegate unrecognized extension APIs toController.handleExtensionRequest.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
clients/src/main/java/org/apache/kafka/common/protocol/ApiKeys.java |
Added isExtensionApi() static method to identify extension APIs by ID range |
clients/src/main/java/org/apache/kafka/common/requests/RequestResponseExtensionProvider.java |
New SPI interface for extension request/response parsing |
clients/src/main/java/org/apache/kafka/common/requests/RequestResponseExtensions.java |
SPI loader and facade for extension parsing |
clients/src/main/java/org/apache/kafka/common/requests/AbstractRequest.java |
Default case now delegates to extension provider instead of throwing |
clients/src/main/java/org/apache/kafka/common/requests/AbstractResponse.java |
Default case now delegates to extension provider instead of throwing |
core/src/main/scala/kafka/server/streamaspect/extension/BrokerExtensionHandle.scala |
New traits: BrokerExtensionHandle, BrokerExtensionHandleProvider, BrokerExtensionContext, BrokerExtensionHandleDispatcher |
core/src/main/scala/kafka/server/streamaspect/ElasticKafkaApis.scala |
Integrates BrokerExtensionHandleDispatcher for broker-side extension API routing |
core/src/main/scala/kafka/server/streamaspect/ElasticControllerApis.scala |
Routes extension APIs to Controller.handleExtensionRequest |
clients/src/test/java/org/apache/kafka/common/protocol/ApiKeysTest.java |
Tests for isExtensionApi |
clients/src/test/java/org/apache/kafka/common/requests/RequestResponseTest.java |
Skip set for stream/enterprise APIs + extension provider tests |
clients/src/test/java/org/apache/kafka/common/requests/TestRequestResponseExtensionProvider.java |
Test SPI provider implementation |
clients/src/test/resources/META-INF/services/org.apache.kafka.common.requests.RequestResponseExtensionProvider |
SPI registration for test provider |
core/src/test/scala/.../BrokerExtensionHandleDispatcherTest.scala |
Unit tests for dispatcher behavior |
core/src/test/scala/.../BrokerExtensionHandleContractsTest.scala |
Contract tests for handle/provider traits |
core/src/test/scala/.../ElasticKafkaApisTest.scala |
Integration tests for broker extension routing |
core/src/test/scala/.../ElasticControllerApisTest.scala |
Integration tests for controller extension routing |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Gezi-lzq
requested review from
1sonofqiu,
superhx and
woshigaopp
as code owners
superhx
reviewed
Mar 10, 2026
superhx
approved these changes
Mar 10, 2026
Gezi-lzq
added a commit
that referenced
this pull request
May 13, 2026
* feat(protocol): add enterprise request/response extension routing * feat(core): add broker extension handle SPI contracts * feat(core): add broker extension handle dispatcher * feat(core): route extension APIs via broker handle SPI * test(clients): skip enterprise stream APIs in generic serialization sweep * fix(clients): reject multiple request/response extension providers * refactor(core): consolidate broker extension SPI definitions * style: align extension no-handler exception with KafkaApis * refactor(core): route extension API fallback directly in controller handle * refactor(core): rename BrokerHandleOps to BrokerExtensionContext * docs(core): clarify broker extension SPI roles * fix(extension): align controller fallback and provider arg order * chore: add AutoMQ copyright headers * refactor: extract broker extension context * style: move broker extension context to class end (cherry picked from commit c3bf2cd)
Gezi-lzq
added a commit
that referenced
this pull request
May 13, 2026
## Summary - cherry-pick #3246 to main: SPI-based enterprise API routing prerequisite - cherry-pick #3248 to main: fetch listener callbacks and InterBrokerAsyncSender support - cherry-pick #3359 to main: harden InterBrokerAsyncSender validation ## Context #3359 was merged to 1.7, but main did not yet contain its prerequisites. #3248 depends on #3246, so this PR now carries the full dependency order: #3246 -> #3248 -> #3359. Conflict adaptation: #3248 conflicted in UnifiedLog because main keeps the 4-argument LocalLog.append signature. The resolution preserves main's append call and adds the latest-append-state update from #3248. ## Tests - ./gradlew :server-common:spotlessJavaCheck :server-common:test --tests org.apache.kafka.server.util.InterBrokerAsyncSenderTest :core:compileScala :core:compileTestScala
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.