MINIFICPP-2816 Add controller_service::api_implementations to C api by martinzink · Pull Request #2176 · apache/nifi-minifi-cpp

martinzink · 2026-05-15T11:03:55Z

Thank you for submitting a contribution to Apache NiFi - MiNiFi C++.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
Does your PR title start with MINIFICPP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
Has your PR been rebased against the latest commit within the target branch (typically main)?
Is your initial contribution a single, squashed commit?

For code changes:

If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
If applicable, have you updated the LICENSE file?
If applicable, have you updated the NOTICE file?

For documentation related changes:

Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions CI results for build issues and submit an update to your PR as soon as possible.

Copilot

Pull request overview

This PR extends the C extension API for MiNiFi C++ to let C-based controller services declare and expose multiple "provided interfaces" (additional C++ APIs they implement). The agent surfaces these as api_implementations in class descriptions, and MinifiProcessContextGetControllerService now uses a new get_interface callback to cast a controller service implementation to a requested API type. A new stable-api-sandbox test extension exercises the feature with Dog/Duck controller services that both implement CanFlyControllerApi and NumberOfLegsControllerApi, consumed by a ZooProcessor.

Changes:

Added provided_interfaces_* and a get_interface callback to the C controller-service ABI, plumbed through useControllerServiceClassDefinition and useCControllerServiceClassDescription into ClassDescription::api_implementations.
Introduced a C++-side ProvidedInterface / createProvidedInterface helper and a ControllerServiceType::minifiSystemControllerServiceType factory.
Added a new stable-api-sandbox extension (controller services, processor, init, tests, CMake) demonstrating and testing the multi-interface controller service flow.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
minifi-api/include/minifi-c/minifi-c.h	Adds `provided_interfaces_*` fields and `get_interface` callback to controller-service C ABI structs.
minifi-api/include/minifi-cpp/core/ControllerServiceType.h	Adds `minifiSystemControllerServiceType` factory and tightens reformatting; private ctor for raw fields.
minifi-api/common/include/minifi-cpp/core/ProvidedControllerServiceInterface.h	New header defining `ProvidedInterface` and the `createProvidedInterface` helper template.
extension-framework/cpp-extension-lib/include/api/core/Resource.h	Wires `Class::ProvidedInterfaces` into the C definition and implements the `get_interface` lambda.
libminifi/src/minifi-c.cpp	Builds `api_implementations` from C-side interface names; uses `get_interface` in `MinifiProcessContextGetControllerService`.
extensions/stable-api-sandbox/AnimalControllerServiceApis.h	Defines two abstract controller-service APIs used by the sandbox tests.
extensions/stable-api-sandbox/AnimalControllerServices.{h,cpp}	`DogController`/`DuckController` implementing both APIs and declaring `ProvidedInterfaces`.
extensions/stable-api-sandbox/ZooProcessor.{h,cpp}	Test processor that fetches both interfaces from configured controller services.
extensions/stable-api-sandbox/ExtensionInitializer.cpp	Registers the new processor and controller services as a C extension.
extensions/stable-api-sandbox/CMakeLists.txt	New CMake module building the sandbox extension.
extensions/stable-api-sandbox/tests/CMakeLists.txt	Builds the sandbox extension's tests.
extensions/stable-api-sandbox/tests/ZooTests.cpp	End-to-end test exercising multi-interface lookup via the C API.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 14 out of 14 changed files in this pull request and generated 5 comments.

martinzink · 2026-05-29T05:30:16Z


-  explicit ControllerServiceFactoryImpl(std::string group_name)
-      : group_name_(std::move(group_name)),
+  explicit ControllerServiceFactoryImpl(std::string module_name)


Ive renamed it from group_name to module_name, because this groupname was not the groupname in C2 but rather the artifact name

szaszm · 2026-06-15T14:51:39Z

I'm thinking we should call this stable-api-tests or something like that, so even at first glance it's clear that this is a test-only extension.

szaszm · 2026-06-15T14:59:24Z

+  EXTENSIONAPI static constexpr auto CanFlyService = core::PropertyDefinitionBuilder<>::createProperty("Can fly service")
+                                                         .withDescription("Test CanFlyService")
+                                                         .isRequired(true)
+                                                         .withAllowedTypes<CanFlyControllerApi>()
+                                                         .build();


Continuation indentation should be 4 spaces deeper. I'm against trying to maintain alignments, because we get right-heavy lines like these, plus renames and similar changes break alignment.

szaszm · 2026-06-17T13:01:42Z

+  {
+    LogTestController::getInstance().clear();
+    CHECK(controller.getProcessor()->setProperty(ZooProcessor::CanFlyService.name, "duck"));
+    CHECK(controller.getProcessor()->setProperty(ZooProcessor::NumberOfLegsService.name, "invalid"));


shouldn't this throw an error?

no we dont validate here, thats only done on C2 side, we theoratically could so its might be a good feature

szaszm · 2026-06-17T13:03:56Z

+  void initialize() override {}
+  void onEnable() override {}
+
+  [[nodiscard]] ControllerServiceHandle* getControllerServiceHandle() override { return this; }


Maybe this should be added to the macro ADD_COMMON_VIRTUAL_FUNCTIONS_FOR_CONTROLLER_SERVICES, tho it doesn't strictly belong in the scope of this change, so you decide

szaszm · 2026-06-17T13:11:15Z

+  constexpr auto system_allowed_types = std::to_array<std::string_view>({
+      controllers::SSLContextServiceInterface::ProvidesApi.type,
+      core::RecordSetWriter::ProvidesApi.type,
+      core::RecordSetReader::ProvidesApi.type,
+      controllers::ProxyConfigurationServiceInterface::ProvidesApi.type,
+      controllers::AttributeProviderService::ProvidesApi.type});
+  return ranges::contains(system_allowed_types, allowed_type);


I like the old version with inline comparisons better. No need to introduce an STL container and ranges when it doesn't have a benefit, and line patterns are easily readable, even if they are somewhat repetitive.

I just noticed that @lordgamez suggested the change, so CC.

It's not really what I suggested, but we discussed that the originally suggested improvement should be a separate PR. Until that is implemented the same issue persists that when any new system allowed type is introduced it needs to be manually inserted here which is not trivial to find and easily missed, does not really matter if it's inlined or extracted to a container. My original intent to alternatively extract the constants was to move them to a more accessible and discoverable place when introducing a new option, but there's not really a viable place for it now, so it can be reverted.

ah okay. If it's a temporary solution, I don't insist on changing it, but I would still prefer the simpler version.

Co-authored-by: Márton Szász <szaszm@apache.org>

martinzink requested a review from Copilot May 15, 2026 11:03

Copilot started reviewing on behalf of martinzink May 15, 2026 11:04 View session

martinzink added the c-api label May 15, 2026

Copilot AI reviewed May 15, 2026

View reviewed changes

martinzink force-pushed the c_api_controller_service_traits branch from 615a1aa to 8a61732 Compare May 15, 2026 12:35

martinzink changed the base branch from main to gcp_to_c_api May 15, 2026 12:35

martinzink requested a review from Copilot May 15, 2026 12:36

Copilot started reviewing on behalf of martinzink May 15, 2026 12:36 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

martinzink force-pushed the c_api_controller_service_traits branch 2 times, most recently from e37d114 to 3f19d56 Compare May 18, 2026 11:40

martinzink force-pushed the c_api_controller_service_traits branch from 3f19d56 to 4df654c Compare May 26, 2026 13:23

martinzink force-pushed the gcp_to_c_api branch 2 times, most recently from a663671 to b607c29 Compare May 27, 2026 15:14

martinzink force-pushed the c_api_controller_service_traits branch 3 times, most recently from 75dec07 to 6fc9e41 Compare May 28, 2026 05:48

martinzink force-pushed the gcp_to_c_api branch 2 times, most recently from 2cac27e to 97b90aa Compare May 28, 2026 13:52

martinzink force-pushed the c_api_controller_service_traits branch 2 times, most recently from 7d06f20 to e727372 Compare May 28, 2026 14:02

martinzink marked this pull request as ready for review May 29, 2026 14:57

martinzink commented May 29, 2026

View reviewed changes

adamdebreceni self-requested a review June 2, 2026 07:10

martinzink force-pushed the gcp_to_c_api branch from 97b90aa to a73ba37 Compare June 2, 2026 07:13

martinzink force-pushed the c_api_controller_service_traits branch 2 times, most recently from 62b57f8 to 1311c86 Compare June 2, 2026 08:27

martinzink added dependencies Pull requests that update a dependency file depends-on-another-PR and removed dependencies Pull requests that update a dependency file labels Jun 2, 2026

adamdebreceni reviewed Jun 2, 2026

View reviewed changes

Comment thread core-framework/include/core/ObjectFactory.h Outdated

Comment thread libminifi/src/minifi-c.cpp Outdated

martinzink force-pushed the gcp_to_c_api branch from 82d6dd3 to 4ec5f5c Compare June 4, 2026 10:00

martinzink force-pushed the c_api_controller_service_traits branch from 1311c86 to 9175793 Compare June 4, 2026 10:26

adamdebreceni approved these changes Jun 4, 2026

View reviewed changes

lordgamez reviewed Jun 5, 2026

View reviewed changes

Comment thread libminifi/src/core/state/nodes/AgentInformation.cpp Outdated

martinzink force-pushed the gcp_to_c_api branch from 4ec5f5c to ef5127e Compare June 15, 2026 11:30

martinzink force-pushed the c_api_controller_service_traits branch from 9175793 to 5955a53 Compare June 15, 2026 12:25

lordgamez approved these changes Jun 15, 2026

View reviewed changes

martinzink force-pushed the gcp_to_c_api branch 2 times, most recently from 6321c43 to 4429809 Compare June 15, 2026 16:09

martinzink added 6 commits June 16, 2026 14:29

MINIFICPP-2765 Move GCP Extension to stable C API (apache#2153)

7988c8b

MINIFICPP-2816 Add controller_service::api_implementations to C api

90289f6

more tests

8375ad0

AttributeProviderService::ProvidesApi

5c7ca43

review changes

e9a72f3

refactor minifiSystemAllowedType

c13b5b4

martinzink force-pushed the c_api_controller_service_traits branch from 5955a53 to c13b5b4 Compare June 17, 2026 11:05

szaszm reviewed Jun 17, 2026

View reviewed changes

Apply suggestions from code review

2e9abb6

Co-authored-by: Márton Szász <szaszm@apache.org>

Conversation

martinzink commented May 15, 2026

For all changes:

For code changes:

For documentation related changes:

Note:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lordgamez Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

szaszm Jun 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lordgamez Jun 17, 2026 •

edited

Loading

szaszm Jun 17, 2026 •

edited

Loading