MINIFICPP-2840 - Refactor provenance part 1#2195
Draft
adamdebreceni wants to merge 2 commits into
Draft
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR is the first part of a provenance refactor, focusing on modernizing the provenance/flowfile APIs (naming and types) and simplifying repository record retrieval to return a vector of deserialized components.
Changes:
- Renames
getlineageStartDate()togetLineageStartDate()across FlowFile/Provenance APIs and call sites. - Refactors
core::Repository::getElementsfrom an out-parameter/bool API tostd::vector<...> getElements(size_t max_size). - Updates provenance event/reporting plumbing (component id now uses processor UUID; JSON report builder returns a
std::string).
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| minifi-api/include/minifi-cpp/provenance/Provenance.h | API rename for lineage start date; removes parent/child “remove” APIs. |
| minifi-api/include/minifi-cpp/core/Repository.h | Changes getElements API to return a vector. |
| minifi-api/include/minifi-cpp/core/FlowFile.h | Renames getlineageStartDate to getLineageStartDate in the API. |
| libminifi/test/libtest/unit/ProvenanceTestHelper.h | Updates test repository to new getElements signature and provenance record creation. |
| libminifi/src/provenance/Provenance.cpp | Refactors ProvenanceEventRecordImpl fields/ctor usage; updates serialization/deserialization and reporter commit loop. |
| libminifi/src/core/reporting/SiteToSiteProvenanceReportingTask.cpp | Refactors JSON report generator to return string; adapts to new getElements API. |
| libminifi/src/core/ProcessSession.cpp | Passes processor UUID as provenance component id; updates lineage start date call. |
| libminifi/src/core/FlowFile.cpp | Renames FlowFileImpl method to getLineageStartDate. |
| libminifi/src/core/flow/FlowSchema.cpp | Adds NiFi flow JSON keys for provenance reporting section/fields. |
| libminifi/include/provenance/Provenance.h | Refactors provenance impl types/ctors and member naming; removes default ctor. |
| libminifi/include/core/reporting/SiteToSiteProvenanceReportingTask.h | Updates getJsonReport signature (returns string); removes onSchedule override declaration. |
| libminifi/include/core/FlowFile.h | Renames FlowFileImpl virtual override to getLineageStartDate. |
| extensions/standard-processors/tests/unit/ProcessorTests.cpp | Updates tests for provenance record creation and new reporting task API. |
| extensions/standard-processors/processors/LogAttribute.cpp | Updates lineage start date getter name. |
| extensions/rocksdb-repos/tests/ProvenanceTests.cpp | Updates record loading creation to use ProvenanceEventRecord::create(); removes child UUID removal assertions. |
| extensions/rocksdb-repos/ProvenanceRepository.h | Updates provenance repository interface to new getElements signature. |
| extensions/rocksdb-repos/ProvenanceRepository.cpp | Implements new getElements signature returning a vector. |
| extensions/grafana-loki/PushGrafanaLokiREST.cpp | Updates lineage start date getter name. |
| extensions/grafana-loki/PushGrafanaLokiGrpc.cpp | Updates lineage start date getter name. |
| core-framework/include/core/Repository.h | Updates default repository implementation to new getElements signature. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+55
to
56
| auto record2 = provenance::ProvenanceEventRecord::create(); | ||
| record2->setEventId(eventId); |
Comment on lines
160
to
+163
| std::shared_ptr<core::Repository> repo = context.getProvenanceRepository(); | ||
| if (!repo->getElements(records, deserialized) && deserialized == 0) { | ||
| if (!repo) { | ||
| throw minifi::Exception(ExceptionType::REPOSITORY_EXCEPTION, "Failed to retrieve provenance repository"); | ||
| } |
Comment on lines
80
to
83
| auto opendb = db_->open(); | ||
| if (!opendb) { | ||
| return false; | ||
| return {}; | ||
| } |
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.
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:
For documentation related changes:
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.