You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2020/07/23 18:50:09 UTC
[GitHub] [pulsar] srkukarni opened a new pull request #7647: Allow ability to specify retain key ordering in functions
srkukarni opened a new pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647
<!--
### Contribution Checklist
- Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
Skip *Issue XYZ* if there is no associated github issue for this pull request.
Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
*(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*
Fixes #<xyz>
*(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*
Master Issue: #<xyz>
### Motivation
Just like retainOrdering, sometimes applications want to retain ordering over the message keys. This pr adds support to that.
### Modifications
*Describe the modifications you've done.*
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads (10MB)*
- *Extended integration test for recovery after broker failure*
### Does this pull request potentially affect one of the following parts:
*If `yes` was chosen, please highlight the changes*
- Dependencies (does it add or upgrade a dependency): (yes / no)
- The public API: (yes / no)
- The schema: (yes / no / don't know)
- The default values of configurations: (yes / no)
- The wire protocol: (yes / no)
- The rest endpoints: (yes / no)
- The admin cli options: (yes / no)
- Anything that affects deployment: (yes / no / don't know)
### Documentation
- Does this pull request introduce a new feature? (yes / no)
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
- If a feature is not applicable for documentation, explain why?
- If a feature is not documented yet in this PR, please create a followup issue for adding the documentation
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
srkukarni commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459869808
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -317,9 +319,15 @@ public static FunctionConfig convertFromDetails(FunctionDetails functionDetails)
}
if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.FAILOVER) {
functionConfig.setRetainOrdering(true);
+ functionConfig.setRetainKeyOrdering(false);
functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.EFFECTIVELY_ONCE);
+ } else if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.KEY_SHARED) {
Review comment:
That can be added later.
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
srkukarni commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459854783
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -317,9 +319,15 @@ public static FunctionConfig convertFromDetails(FunctionDetails functionDetails)
}
if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.FAILOVER) {
functionConfig.setRetainOrdering(true);
+ functionConfig.setRetainKeyOrdering(false);
functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.EFFECTIVELY_ONCE);
+ } else if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.KEY_SHARED) {
+ functionConfig.setRetainOrdering(false);
+ functionConfig.setRetainKeyOrdering(true);
+ functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.ATLEAST_ONCE);
Review comment:
Yes. Even the existing code is broken in that regard. I will fix that
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459715084
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -639,6 +655,16 @@ private static void doCommonChecks(FunctionConfig functionConfig) {
if ((functionConfig.getMaxMessageRetries() == null || functionConfig.getMaxMessageRetries() < 0) && !org.apache.commons.lang3.StringUtils.isEmpty(functionConfig.getDeadLetterTopic())) {
throw new IllegalArgumentException("Dead Letter Topic specified, however max retries is set to infinity");
}
+ if (functionConfig.getRetainKeyOrdering() != null
+ && functionConfig.getRetainKeyOrdering()
Review comment:
I would remove this stanza. We should return an error if the retain order or retain key ordering is set at all
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459718664
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -317,9 +319,15 @@ public static FunctionConfig convertFromDetails(FunctionDetails functionDetails)
}
if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.FAILOVER) {
Review comment:
This whole conditional statement doesn't see right to me. Why are se setting the processing guarantee by looking at what the subscription is? We already setting the processing guarantee in a previous line:
https://github.com/apache/pulsar/pull/7647/files#diff-239e167c18ea8591c85432948ab5040aL297
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -317,9 +319,15 @@ public static FunctionConfig convertFromDetails(FunctionDetails functionDetails)
}
if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.FAILOVER) {
Review comment:
This whole conditional statement doesn't seem right to me. Why are se setting the processing guarantee by looking at what the subscription is? We already setting the processing guarantee in a previous line:
https://github.com/apache/pulsar/pull/7647/files#diff-239e167c18ea8591c85432948ab5040aL297
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459719810
##########
File path: pulsar-common/src/main/java/org/apache/pulsar/common/functions/FunctionConfig.java
##########
@@ -87,6 +87,7 @@
private String logTopic;
private ProcessingGuarantees processingGuarantees;
private Boolean retainOrdering;
+ private Boolean retainKeyOrdering;
Review comment:
also need to add this for SinkConfig
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
srkukarni commented on pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#issuecomment-663376492
@jerrypeng addressed your comments. PTAL
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459712534
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -142,6 +142,8 @@ public static FunctionDetails convert(FunctionConfig functionConfig, ClassLoader
Function.SubscriptionType subType = ((functionConfig.getRetainOrdering() != null && functionConfig.getRetainOrdering())
|| FunctionConfig.ProcessingGuarantees.EFFECTIVELY_ONCE.equals(functionConfig.getProcessingGuarantees()))
? Function.SubscriptionType.FAILOVER
+ : (functionConfig.getRetainKeyOrdering() != null && functionConfig.getRetainKeyOrdering())
Review comment:
Can we re-organize this giant conditional statement to be more readable?
if (effectively-once) {
subType = Failover
} else if (retain order) {
subType = failover
} else if (retain key order) {
subType = shared_key
} else {
subType = shared
}
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459701140
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -317,9 +319,15 @@ public static FunctionConfig convertFromDetails(FunctionDetails functionDetails)
}
if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.FAILOVER) {
functionConfig.setRetainOrdering(true);
+ functionConfig.setRetainKeyOrdering(false);
functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.EFFECTIVELY_ONCE);
+ } else if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.KEY_SHARED) {
Review comment:
We also need to do this in SinkConfigUtils
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459716218
##########
File path: pulsar-common/src/main/java/org/apache/pulsar/common/functions/FunctionConfig.java
##########
@@ -87,6 +87,7 @@
private String logTopic;
private ProcessingGuarantees processingGuarantees;
private Boolean retainOrdering;
+ private Boolean retainKeyOrdering;
Review comment:
Can we add some comments here for retainOrdering and retainKeyOrdering so people understand what they do and what the difference between the two is?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459715501
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -639,6 +655,16 @@ private static void doCommonChecks(FunctionConfig functionConfig) {
if ((functionConfig.getMaxMessageRetries() == null || functionConfig.getMaxMessageRetries() < 0) && !org.apache.commons.lang3.StringUtils.isEmpty(functionConfig.getDeadLetterTopic())) {
throw new IllegalArgumentException("Dead Letter Topic specified, however max retries is set to infinity");
}
+ if (functionConfig.getRetainKeyOrdering() != null
+ && functionConfig.getRetainKeyOrdering()
Review comment:
Can you also check whether retain ordering is set?
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni merged pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
srkukarni merged pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7647: Allow ability to specify retain key ordering in functions
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7647:
URL: https://github.com/apache/pulsar/pull/7647#discussion_r459710411
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -317,9 +319,15 @@ public static FunctionConfig convertFromDetails(FunctionDetails functionDetails)
}
if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.FAILOVER) {
functionConfig.setRetainOrdering(true);
+ functionConfig.setRetainKeyOrdering(false);
functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.EFFECTIVELY_ONCE);
+ } else if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.KEY_SHARED) {
+ functionConfig.setRetainOrdering(false);
+ functionConfig.setRetainKeyOrdering(true);
+ functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.ATLEAST_ONCE);
Review comment:
We are we assuming ATLEAST_ONCE here? A user can set the processing guarantee to be at most once and still set the retain ordering to be true
##########
File path: pulsar-functions/utils/src/main/java/org/apache/pulsar/functions/utils/FunctionConfigUtils.java
##########
@@ -317,9 +319,15 @@ public static FunctionConfig convertFromDetails(FunctionDetails functionDetails)
}
if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.FAILOVER) {
functionConfig.setRetainOrdering(true);
+ functionConfig.setRetainKeyOrdering(false);
functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.EFFECTIVELY_ONCE);
+ } else if (functionDetails.getSource().getSubscriptionType() == Function.SubscriptionType.KEY_SHARED) {
+ functionConfig.setRetainOrdering(false);
+ functionConfig.setRetainKeyOrdering(true);
+ functionConfig.setProcessingGuarantees(FunctionConfig.ProcessingGuarantees.ATLEAST_ONCE);
Review comment:
Why are we assuming ATLEAST_ONCE here? A user can set the processing guarantee to be at most once and still set the retain ordering to be true
----------------------------------------------------------------
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.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org