Versions Compared

Old Version 4

changes.mady.by.user Jacob Tomy

Saved on

compared with

New Version Current

changes.mady.by.user Jacob Tomy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Current state: "Under Discussion"

Discussion thread: https://lists.apache.org/thread/0f20kvfqkmhdqrwcb8vqgqn80szcrcdd here 

JIRA: KAFKA-15187 

Motivation

...

  • A new overloaded method partition(String topic, Object key, byte[] keyBytes, Object value, byte[] valueBytes, Cluster cluster, Headers headers) with default implementation to call the existing method.
  • The object passed as headers is readonly and cannot be updated.

  • Details :

    Code Block
     /**
* Compute the partition for the given record. Not overriding this method in the Partitioner interface has the same behaviour as using the existing method. The object passed as headers is readonly and cannot be updated.
* 
* @param topic The topic name
* @param key The key to partition on (or null if no key)
* @param keyBytes The serialized key to partition on( or null if no key)
* @param value The value to partition on or null
* @param valueBytes The serialized value to partition on or null
* @param cluster The current cluster metadata
* @param headers The headers to partition on or null
*/
default int partition(String topic, Object key, byte[] keyBytes, Object value, byte[] valueBytes, Cluster cluster, Headers headers) {
return partition(topic, key, keyBytes, value, valueBytes, cluster);
};


Proposed Changes

  • Add a new overloaded method partition(String topic, Object key, byte[] keyBytes, Object value, byte[] valueBytes, Cluster cluster, Headers headers) with default implementation to call the existing method in the Partitioner interface in org/apache/kafka/clients/producer.
    • This lets the users to implement the partitioner with ability to choose partition based on header values.
    • If a partitioner implements both the methods, the override of new method (one which accepts headers) will be in effect.
  • Make the call to partition method in KafkaProducer to use the new method.
    • Since it is defaulted to use the existing method, this should not cause any behaviour change.
    Mark headers as readonly before the first call for
    • Make sure the client cannot update the headers.
    • Ensure consistency as it get marked before the second call.

Total changes : https://github.com/apache/kafka/pull/13981

...

  • What impact (if any) will there be on existing users?
    • NoneAn implementation of the new interface will be incompatible with old clients.
  • If we are changing behavior how will we phase out the older behavior?
    • NA
  • If we need special migration tools, describe them here.
    • NA
  • When will we remove the existing behavior?
    • NA

This is a backward compatible change as mentioned in the proposed changes section. The new default method calls the existing method unless it is manually overridden by the user. 

Test Plan

Describe in few sentences how the KIP will be tested. We are mostly interested in system tests (since unit-tests are specific to implementation details). How will we know that the implementation works as expected? How will we know nothing broke?

<>This has an addition of a default method in the interface. The changes made in Kafka Producer should be covered in the existing tests and should not have any impact.

Rejected Alternatives

None