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 2022/08/17 16:39:44 UTC

[GitHub] [nifi] Lehel44 opened a new pull request, #6310: NIFI-10366: Make Default Run Duration configurable

Lehel44 opened a new pull request, #6310:
URL: https://github.com/apache/nifi/pull/6310

   <!-- 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. -->
   
   # Summary
   
   [NIFI-10366](https://issues.apache.org/jira/browse/NIFI-10366)
   
   # Tracking
   
   Please complete the following tracking steps prior to pull request creation.
   
   ### Issue Tracking
   
   - [ ] [Apache NiFi Jira](https://issues.apache.org/jira/browse/NIFI-10366) issue created
   
   ### Pull Request Tracking
   
   - [ ] Pull Request title starts with Apache NiFi Jira issue number, such as `NIFI-00000`
   - [ ] Pull Request commit message starts with Apache NiFi Jira issue number, as such `NIFI-00000`
   
   ### Pull Request Formatting
   
   - [ ] Pull Request based on current revision of the `main` branch
   - [ ] Pull Request refers to a feature branch with one commit containing changes
   
   # Verification
   
   Please indicate the verification steps performed prior to pull request creation.
   
   ### Build
   
   - [ ] Build completed using `mvn clean install -P contrib-check`
     - [ ] JDK 8
     - [ ] JDK 11
     - [ ] JDK 17
   
   ### Licensing
   
   - [ ] New dependencies are compatible with the [Apache License 2.0](https://apache.org/licenses/LICENSE-2.0) according to the [License Policy](https://www.apache.org/legal/resolved.html)
   - [ ] New dependencies are documented in applicable `LICENSE` and `NOTICE` files
   
   ### Documentation
   
   - [ ] Documentation formatting appears as expected in rendered files
   


-- 
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] exceptionfactory commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r952801009


##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DefaultRunDuration.java:
##########
@@ -0,0 +1,40 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+import java.time.Duration;
+
+public enum DefaultRunDuration {
+    NO_BATCHING(Duration.ZERO),
+    TWENTY_FIVE_MILLIS(Duration.ofMillis(25)),
+    FIFTY_MILLIS(Duration.ofMillis(50)),
+    ONE_HUNDRED_MILLIS(Duration.ofMillis(100)),
+    TWO_HUNDRED_FIFTY_MILLIS(Duration.ofMillis(250)),
+    FIVE_HUNDRED_MILLIS(Duration.ofMillis(500)),
+    ONE_SECOND(Duration.ofSeconds(1)),
+    TWO_SECONDS(Duration.ofSeconds(2));
+
+    private final Duration duration;
+
+    DefaultRunDuration(final Duration duration) {
+        this.duration = duration;
+    }
+
+    public Duration getDuration() {
+        return Duration.ofMillis(1000);

Review Comment:
   This needs to be changed to return the `duration` property.
   ```suggestion
           return duration;
   ```



-- 
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] Lehel44 commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
Lehel44 commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r949369250


##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java:
##########
@@ -47,5 +47,5 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Inherited
 public @interface SupportsBatching {
-
+    RunDuration duration() default RunDuration.ZERO_MILLIS;

Review Comment:
   Yes, that's a good idea! Thanks.



-- 
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] Lehel44 commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
Lehel44 commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r949369950


##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/RunDuration.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+public enum RunDuration {
+    ZERO_MILLIS(0),

Review Comment:
   NO_BATCHING is more expressing, I think it's better.



-- 
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] markap14 commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
markap14 commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r948385921


##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/SupportsBatching.java:
##########
@@ -47,5 +47,5 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Inherited
 public @interface SupportsBatching {
-
+    RunDuration duration() default RunDuration.ZERO_MILLIS;

Review Comment:
   We should probably call this `defaultDuration` or `defaultRunDuration`, rather than just `duration`. Can we also add some JavaDocs here to explain exactly what happens when this value is set?



##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/RunDuration.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+public enum RunDuration {
+    ZERO_MILLIS(0),

Review Comment:
   Perhaps it makes sense to call this `NO_BATCHING`? Will leave it up to you, if you think `ZERO_MILLIS` works better than `NO_BATCHING` that's fine, just wanted to make the suggestion



##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/RunDuration.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+public enum RunDuration {
+    ZERO_MILLIS(0),
+    TWENTY_FIVE_MILLIS(25),
+    FIFTY_MILLIS(50),
+    ONE_HUNDRED_MILLIS(100),
+    TWO_HUNDRED_FIFTY_MILLIS(250),
+    FIVE_HUNDRED_MILLIS(500),
+    ONE_SECONDS(1000),

Review Comment:
   Should probably use `ONE_SECOND` rather than `ONE_SECONDS`



-- 
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] Lehel44 commented on pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
Lehel44 commented on PR #6310:
URL: https://github.com/apache/nifi/pull/6310#issuecomment-1223826758

   Thanks for the review @markap14 @exceptionfactory !


-- 
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] markap14 merged pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
markap14 merged PR #6310:
URL: https://github.com/apache/nifi/pull/6310


-- 
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] exceptionfactory commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r948394015


##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/RunDuration.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+public enum RunDuration {
+    ZERO_MILLIS(0),
+    TWENTY_FIVE_MILLIS(25),
+    FIFTY_MILLIS(50),
+    ONE_HUNDRED_MILLIS(100),
+    TWO_HUNDRED_FIFTY_MILLIS(250),
+    FIVE_HUNDRED_MILLIS(500),
+    ONE_SECONDS(1000),
+    TWO_SECONDS(2000);
+
+    private final long millis;
+
+    RunDuration(final long millis) {
+        this.millis = millis;
+    }
+
+    public long getMillis() {
+        return millis;
+    }

Review Comment:
   @Lehel44 and @markap14, what do you think about returning a [java.time.Duration](https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html) object? That would provide greater flexibility on the consuming side, and also preserve the intent of the time being a duration.



-- 
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] Lehel44 commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
Lehel44 commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r952323731


##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DefaultRunDuration.java:
##########
@@ -0,0 +1,40 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+import java.time.Duration;
+
+public enum DefaultRunDuration {
+    NO_BATCHING(0),
+    TWENTY_FIVE_MILLIS(25),
+    FIFTY_MILLIS(50),
+    ONE_HUNDRED_MILLIS(100),
+    TWO_HUNDRED_FIFTY_MILLIS(250),
+    FIVE_HUNDRED_MILLIS(500),
+    ONE_SECOND(1000),
+    TWO_SECONDS(2000);
+
+    private final long millis;
+
+    DefaultRunDuration(final long millis) {

Review Comment:
   Thanks for the suggestion. I have ambivalent feeling about this since it makes the code less readable and I'm not convinced about the introduction of new future run duration intervals. However, it won't harm to make the code more extensible and give up a little bit of simplicity.



-- 
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] markap14 commented on pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
markap14 commented on PR #6310:
URL: https://github.com/apache/nifi/pull/6310#issuecomment-1232026596

   Thanks, all looks good to me. +1 merged 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


[GitHub] [nifi] exceptionfactory commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r950241739


##########
nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/ExtensionBuilder.java:
##########
@@ -359,6 +363,19 @@ private void applyDefaultSettings(final ProcessorNode processorNode) {
         }
     }
 
+    private void applyDefaultRunDuration(final ProcessorNode processorNode) {
+        try {
+            final Class<?> procClass = processorNode.getProcessor().getClass();
+
+            final SupportsBatching sb = procClass.getAnnotation(SupportsBatching.class);
+            if (sb != null) {
+                processorNode.setRunDuration(sb.defaultDuration().getDuration().toMillis(), TimeUnit.MILLISECONDS);
+            }
+        } catch (final Exception ex) {
+            logger.error("Error while setting default run duration from SupportsBatching annotation: {}", ex.toString(), ex);

Review Comment:
   Including the `ex.toString()` argument should not be necessary since the exception stack trace will include the same details.
   ```suggestion
               logger.error("Set default Run Duration failed", ex);
   ```



##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/DefaultRunDuration.java:
##########
@@ -0,0 +1,40 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+import java.time.Duration;
+
+public enum DefaultRunDuration {
+    NO_BATCHING(0),
+    TWENTY_FIVE_MILLIS(25),
+    FIFTY_MILLIS(50),
+    ONE_HUNDRED_MILLIS(100),
+    TWO_HUNDRED_FIFTY_MILLIS(250),
+    FIVE_HUNDRED_MILLIS(500),
+    ONE_SECOND(1000),
+    TWO_SECONDS(2000);
+
+    private final long millis;
+
+    DefaultRunDuration(final long millis) {

Review Comment:
   Minor detail, but with the change to use `java.time.Duration` in the `getDuration()` method, recommend changing the constructor argument as well. That will provide the opportunity for more semantic definition of the enum options, such as `Duration.ofMillis()` for smaller values, and `Duration.ofSeconds()` for larger values.



-- 
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] Lehel44 commented on a diff in pull request #6310: NIFI-10366: Make Default Run Duration configurable

Posted by GitBox <gi...@apache.org>.
Lehel44 commented on code in PR #6310:
URL: https://github.com/apache/nifi/pull/6310#discussion_r949371390


##########
nifi-api/src/main/java/org/apache/nifi/annotation/behavior/RunDuration.java:
##########
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+package org.apache.nifi.annotation.behavior;
+
+public enum RunDuration {
+    ZERO_MILLIS(0),
+    TWENTY_FIVE_MILLIS(25),
+    FIFTY_MILLIS(50),
+    ONE_HUNDRED_MILLIS(100),
+    TWO_HUNDRED_FIFTY_MILLIS(250),
+    FIVE_HUNDRED_MILLIS(500),
+    ONE_SECONDS(1000),
+    TWO_SECONDS(2000);
+
+    private final long millis;
+
+    RunDuration(final long millis) {
+        this.millis = millis;
+    }
+
+    public long getMillis() {
+        return millis;
+    }

Review Comment:
   Yes sure, so it can be manipulated if needed easily.



-- 
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