You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2021/12/17 21:59:15 UTC
[GitHub] [nifi] bbende opened a new pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
bbende opened a new pull request #5612:
URL: https://github.com/apache/nifi/pull/5612
- Write additional fields to extnesion-manifest.xml for processors
- Update C2 model classes to support new fields for processors, properties, and scheduling
- Create converter between NiFi model and C2 model
- Create generator and execute during the build
<!--
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.
-->
Thank you for submitting a contribution to Apache NiFi.
Please provide a short description of the PR here:
#### Description of PR
_Enables X functionality; fixes bug NIFI-YYYY._
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 **NIFI-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? _Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not `squash` or use `--force` when pushing to allow for clean monitoring of changes._
### For code changes:
- [ ] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] Have you verified that the full build is successful on JDK 8?
- [ ] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE` file, including the main `LICENSE` file under `nifi-assembly`?
- [ ] If applicable, have you updated the `NOTICE` file, including the main `NOTICE` file found under `nifi-assembly`?
- [ ] If adding new Properties, have you added `.displayName` in addition to .name (programmatic access) for each of the new properties?
### 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 for build issues and submit an update to your PR as soon as possible.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] bbende commented on a change in pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
Posted by GitBox <gi...@apache.org>.
bbende commented on a change in pull request #5612:
URL: https://github.com/apache/nifi/pull/5612#discussion_r771750038
##########
File path: c2/c2-protocol/c2-protocol-component-api/src/main/java/org/apache/nifi/c2/protocol/component/api/ProcessorDefinition.java
##########
@@ -85,4 +102,130 @@ public boolean getSupportsDynamicRelationships() {
public void setSupportsDynamicRelationships(boolean supportsDynamicRelationships) {
this.supportsDynamicRelationships = supportsDynamicRelationships;
}
+
+ @ApiModelProperty("Whether or not this processor should be triggered serially")
+ public boolean getTriggerSerially() {
+ return triggerSerially;
+ }
+
+ public void setTriggerSerially(boolean triggerSerially) {
+ this.triggerSerially = triggerSerially;
+ }
+
+ @ApiModelProperty("Whether or not this processor should be triggered when incoming queues are empty")
+ public boolean getTriggerWhenEmpty() {
+ return triggerWhenEmpty;
+ }
+
+ public void setTriggerWhenEmpty(boolean triggerWhenEmpty) {
+ this.triggerWhenEmpty = triggerWhenEmpty;
+ }
+
+ @ApiModelProperty("Whether or not this processor should be triggered when any destination queue has room")
+ public boolean getTriggerWhenAnyDestinationAvailable() {
+ return triggerWhenAnyDestinationAvailable;
+ }
+
+ public void setTriggerWhenAnyDestinationAvailable(boolean triggerWhenAnyDestinationAvailable) {
+ this.triggerWhenAnyDestinationAvailable = triggerWhenAnyDestinationAvailable;
+ }
+
+ @ApiModelProperty("Whether or not this processor supports batching")
+ public boolean getSupportsBatching() {
+ return supportsBatching;
+ }
+
+ public void setSupportsBatching(boolean supportsBatching) {
+ this.supportsBatching = supportsBatching;
+ }
+
+ @ApiModelProperty("Whether or not this processor supports event driven scheduling")
+ public boolean getSupportsEventDriven() {
+ return supportsEventDriven;
+ }
+
+ public void setSupportsEventDriven(boolean supportsEventDriven) {
+ this.supportsEventDriven = supportsEventDriven;
+ }
+
+ @ApiModelProperty("Whether or not this processor should be scheduled only on the primary node in a cluster")
+ public boolean getPrimaryNodeOnly() {
+ return primaryNodeOnly;
+ }
+
+ public void setPrimaryNodeOnly(boolean primaryNodeOnly) {
+ this.primaryNodeOnly = primaryNodeOnly;
+ }
+
+ @ApiModelProperty("Whether or not this processor is considered side-effect free")
Review comment:
Sure I can elaborate on the docs for all the new fields.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] bbende commented on a change in pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
Posted by GitBox <gi...@apache.org>.
bbende commented on a change in pull request #5612:
URL: https://github.com/apache/nifi/pull/5612#discussion_r771749943
##########
File path: nifi-manifest/nifi-runtime-manifest/pom.xml
##########
@@ -0,0 +1,155 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.nifi</groupId>
+ <artifactId>nifi-manifest</artifactId>
+ <version>1.16.0-SNAPSHOT</version>
+ </parent>
+ <artifactId>nifi-runtime-manifest</artifactId>
+ <packaging>jar</packaging>
+
+ <properties>
+ <extension.manifest.unpack.dir>${project.build.directory}</extension.manifest.unpack.dir>
+ <build.properties.file>${project.build.directory}/classes/build.properties</build.properties.file>
+ <runtime.manifest.file>${project.build.directory}/classes/nifi-runtime-manifest.json</runtime.manifest.file>
+ <runtime.manifest.id>apache-nifi</runtime.manifest.id>
+ </properties>
+
+ <dependencies>
+ <!-- Needed to unpack the extension-manifest.xml files during the build, marked as optional
Review comment:
I have to look into why the GitHub Actions build is failing. I did a full clean build after deleting my local m2/repository/org/apache/nifi and it worked, so I thought it was good.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] bbende commented on a change in pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
Posted by GitBox <gi...@apache.org>.
bbende commented on a change in pull request #5612:
URL: https://github.com/apache/nifi/pull/5612#discussion_r772651055
##########
File path: nifi-manifest/nifi-runtime-manifest/pom.xml
##########
@@ -0,0 +1,155 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.nifi</groupId>
+ <artifactId>nifi-manifest</artifactId>
+ <version>1.16.0-SNAPSHOT</version>
+ </parent>
+ <artifactId>nifi-runtime-manifest</artifactId>
+ <packaging>jar</packaging>
+
+ <properties>
+ <extension.manifest.unpack.dir>${project.build.directory}</extension.manifest.unpack.dir>
+ <build.properties.file>${project.build.directory}/classes/build.properties</build.properties.file>
+ <runtime.manifest.file>${project.build.directory}/classes/nifi-runtime-manifest.json</runtime.manifest.file>
+ <runtime.manifest.id>apache-nifi</runtime.manifest.id>
+ </properties>
+
+ <dependencies>
+ <!-- Needed to unpack the extension-manifest.xml files during the build, marked as optional
Review comment:
Was able to straighten this out... the GA build was excluding the nifi-assembly module to save time, but my new module depends on nifi-assembly, so I created a new profile that disables the binary assembly part but still builds nifi-assembly module.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 closed pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
Posted by GitBox <gi...@apache.org>.
mattyb149 closed pull request #5612:
URL: https://github.com/apache/nifi/pull/5612
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] bbende commented on a change in pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
Posted by GitBox <gi...@apache.org>.
bbende commented on a change in pull request #5612:
URL: https://github.com/apache/nifi/pull/5612#discussion_r771749541
##########
File path: c2/c2-protocol/c2-protocol-component-api/pom.xml
##########
@@ -15,9 +15,9 @@ 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.
-->
-<project xmlns="https://maven.apache.org/POM/4.0.0"
- xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
Review comment:
My IntelliJ couldn't resolve this one as https and others looked liked http so I switched, but if we think that's incorrect then I can switch it back.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 commented on a change in pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
Posted by GitBox <gi...@apache.org>.
mattyb149 commented on a change in pull request #5612:
URL: https://github.com/apache/nifi/pull/5612#discussion_r771740656
##########
File path: c2/c2-protocol/c2-protocol-component-api/pom.xml
##########
@@ -15,9 +15,9 @@ 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.
-->
-<project xmlns="https://maven.apache.org/POM/4.0.0"
- xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
Review comment:
These look like an IDE did that and IIRC we were supposed to have them use HTTPS?
##########
File path: nifi-manifest/nifi-runtime-manifest/pom.xml
##########
@@ -0,0 +1,155 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.apache.nifi</groupId>
+ <artifactId>nifi-manifest</artifactId>
+ <version>1.16.0-SNAPSHOT</version>
+ </parent>
+ <artifactId>nifi-runtime-manifest</artifactId>
+ <packaging>jar</packaging>
+
+ <properties>
+ <extension.manifest.unpack.dir>${project.build.directory}</extension.manifest.unpack.dir>
+ <build.properties.file>${project.build.directory}/classes/build.properties</build.properties.file>
+ <runtime.manifest.file>${project.build.directory}/classes/nifi-runtime-manifest.json</runtime.manifest.file>
+ <runtime.manifest.id>apache-nifi</runtime.manifest.id>
+ </properties>
+
+ <dependencies>
+ <!-- Needed to unpack the extension-manifest.xml files during the build, marked as optional
Review comment:
I couldn't figure/track the Maven chain here, is there a chicken-and-egg-thing (with a pristine build environment) or is everything happening in the correct order?
##########
File path: c2/c2-protocol/c2-protocol-component-api/src/main/java/org/apache/nifi/c2/protocol/component/api/ProcessorDefinition.java
##########
@@ -85,4 +102,130 @@ public boolean getSupportsDynamicRelationships() {
public void setSupportsDynamicRelationships(boolean supportsDynamicRelationships) {
this.supportsDynamicRelationships = supportsDynamicRelationships;
}
+
+ @ApiModelProperty("Whether or not this processor should be triggered serially")
+ public boolean getTriggerSerially() {
+ return triggerSerially;
+ }
+
+ public void setTriggerSerially(boolean triggerSerially) {
+ this.triggerSerially = triggerSerially;
+ }
+
+ @ApiModelProperty("Whether or not this processor should be triggered when incoming queues are empty")
+ public boolean getTriggerWhenEmpty() {
+ return triggerWhenEmpty;
+ }
+
+ public void setTriggerWhenEmpty(boolean triggerWhenEmpty) {
+ this.triggerWhenEmpty = triggerWhenEmpty;
+ }
+
+ @ApiModelProperty("Whether or not this processor should be triggered when any destination queue has room")
+ public boolean getTriggerWhenAnyDestinationAvailable() {
+ return triggerWhenAnyDestinationAvailable;
+ }
+
+ public void setTriggerWhenAnyDestinationAvailable(boolean triggerWhenAnyDestinationAvailable) {
+ this.triggerWhenAnyDestinationAvailable = triggerWhenAnyDestinationAvailable;
+ }
+
+ @ApiModelProperty("Whether or not this processor supports batching")
+ public boolean getSupportsBatching() {
+ return supportsBatching;
+ }
+
+ public void setSupportsBatching(boolean supportsBatching) {
+ this.supportsBatching = supportsBatching;
+ }
+
+ @ApiModelProperty("Whether or not this processor supports event driven scheduling")
+ public boolean getSupportsEventDriven() {
+ return supportsEventDriven;
+ }
+
+ public void setSupportsEventDriven(boolean supportsEventDriven) {
+ this.supportsEventDriven = supportsEventDriven;
+ }
+
+ @ApiModelProperty("Whether or not this processor should be scheduled only on the primary node in a cluster")
+ public boolean getPrimaryNodeOnly() {
+ return primaryNodeOnly;
+ }
+
+ public void setPrimaryNodeOnly(boolean primaryNodeOnly) {
+ this.primaryNodeOnly = primaryNodeOnly;
+ }
+
+ @ApiModelProperty("Whether or not this processor is considered side-effect free")
Review comment:
Do we want more info here, either what side-effect-free means or a link to some other docs?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 commented on pull request #5612: NIFI-9452 Generate a RuntimeManifest for NiFi at build time
Posted by GitBox <gi...@apache.org>.
mattyb149 commented on pull request #5612:
URL: https://github.com/apache/nifi/pull/5612#issuecomment-999110037
+1 LGTM, verified the model and manifests look as expected. Thanks for the new feature! Merging to main
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org