...

Discussion thread: here [Change the link from the KIP proposal email archive to your own email thread]

JIRA: here [Change the link from KAFKA-1 to your own ticket]

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

Motivation

Describe the problems you are trying to solve.

Public Interfaces

Briefly list any new interfaces that will be introduced as part of this proposal or any existing interfaces that will be removed or changed. The purpose of this section is to concisely call out the public contract that will come along with this feature.

A public interface is any change to the following:

• Binary log format

• The network protocol and api behavior

• Any class in the public packages under clientsConfiguration, especially client configuration

  • org/apache/kafka/common/serialization

  • org/apache/kafka/common

  • org/apache/kafka/common/errors

  • org/apache/kafka/clients/producer

  • org/apache/kafka/clients/consumer (eventually, once stable)

• Monitoring

• Command line tools and arguments

• Anything else that will likely break existing users in some way when they upgrade

Proposed Changes

KAFKA-16796

Motivation

We are going to move all tools-related code from core module (scala) to tools module (java) in 4.0. kafka.serializer.Decoder is a public APIs and it is in core module. Hence we need to introduce replacement to deprecate it in 3.8.0

Public Interfaces

The new java interface org.apache.kafka.tools.api.Decoder is shown below. It is located at tools-api module, since it must be accessible by core module.

@FunctionalInterface
public interface Decoder<T> {
    T fromBytes(byte[] bytes);
}

The old scala trait will extend the new java interface with deprecated  annotation

@deprecated(since = "3.8.0")
trait Decoder[T] extends org.apache.kafka.tools.api.Decoder[T] {
  def fromBytes(bytes: Array[Byte]): T
}

Proposed Changes

Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.Introduce a new java interface org.apache.kafka.tools.api.Decoder to replace scala trait kafka.serializer.Decoder

Compatibility, Deprecation, and Migration Plan

• What impact (if any) will there be on existing users?
• If we are changing behavior how will we phase out the older behavior?
• If we need special migration tools, describe them here.
• When will we remove the existing behavior?

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?

Rejected Alternatives

• before 4.0, users can keep using the deprecated kafka.serializer.Decoder
• after 4.0, all users need to update is the superclass is changed from kafka.serializer.Decoder to org.apache.kafka.tools.api.Decoder. They have same methods, so users don't need to change any code of method implementation
• before 4.0, users can access both interfaces by depending on core module.
• after 4.0, users need to import tools-api module if core module is gone

Test Plan

The new unit test used to verify the "warning messages" about deprecated kafka.serializer.Decoder will be added. The messages are used to encourage users to adopt the new interface

Rejected Alternatives

N/AIf there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way.