Might be good to restart a new discuss thread using the new KIP-1035 number to split both threads?

I added the KIP to the table in the wiki page in the mean time.



In Kafka Streams we did rename config names in the past in the exact same way as proposed: deprecate the old config, and add the new one in parallel. -- Yes, it's a little bit of noise, but it does indeed improve user experience, especially for new users (and Kafka is still growing fast...)

I would not be objected to +1 this KIP, however, the KIP should list out explicitly which public configs / variable names would be affected to judge the actual impact. The current phrase:

The proposed change would be to deprecate the old variable and add the newly 
named variable.

with a single example is not sufficient IMHO.


For StreamsConfig, I actually notices that a view `xxx_DOC` variables are public, which is incorrect -- I think they should be private. We should mark them as deprecate do we can make them private in 5.0 (?) release?

Otherwise, I could only spot a few internal variable name that don't follow the recommended naming patterns. Do you want to just do a PR so we can rename it?

I like the idea of checkstyle rules, but to apply them, we indeed need to first do the cleanup to make the checkstyle pass.

Not sure if there is anything else in StreamsConfig which would need to be cleaned up? (Well, as mentioned above, the KIP should list all these changes explicitly...)


Of course, if we believe that it's not worth the trouble to do this cleanup, I also don't feel strong about it to push this KIP forward. Not sure what others think.


-Matthias



On 6/13/24 9:36 AM, Welch, Matt wrote:
Hi Eric,

Apologies for the KIP number conflict.  I'm not sure how the community handles 
these race conditions, but I think we've got it sorted.
Also not sure if this is the right action, but it might be less confusing if 
you re-send your DISCUSS email to the dev list with the correct title and link 
to your KIP.
Also, please add your KIP-1053 to the wiki table as it's still missing.

Best Regards,
Matt

-----Original Message-----
From: Eric Lu <erickandmorty2...@gmail.com>
Sent: Thursday, June 6, 2024 6:09 PM
To: dev@kafka.apache.org
Subject: Re: [DISCUSS] KIP-1052: Align the naming convention for config and 
default variables in *Config classes

Hi Divij,

Thanks for the response, you are right that changing the external interface leads to 
some repetition. The main benefit is that the variables would follow the normalized 
naming convention. It was a concern brought up in this ticket 
<https://issues.apache.org/jira/browse/KAFKA-16638>.

Also, I forgot to increment the KIP number and another dev took KIP-1052. I 
changed mine to 1053.

Another thing, I also did not receive the Pony Mail link. Did I do something 
wrong?

Cheers,

Eric

On Thu, Jun 6, 2024 at 5:37 PM Divij Vaidya <divijvaidy...@gmail.com> wrote:

Hi Eric

Thank you for writing the KIP.

Standardizing the internal variables and classes as per a convention
is a good idea. Even better would be to enforce that convention using
check style rules so that the convention is enforced via a mechanism
in the future code. You don’t need a KIP for it.

However, I am not able to appreciate the benefit of changing the
external interfaces for the sake of alignment. Keeping two similar
names, as you proposed for backward compatibility, only adds to the
additional overhead in code maintenance (reduces readability and adds
to confusion). This cost, just  to get a better aligned conventional does not 
seem worthwhile to me.

Is there an obvious benefit that I am missing here which would make
this proposal a good trade off with the cost?

—
Divij Vaidya



On Thu 6. Jun 2024 at 21:13, Eric Lu <erickandmorty2...@gmail.com> wrote:

  Hi,

I wanted to follow-up on the discussion thread since I have not
received anything yet.

Best regards,

Eric

On Thu, Jun 6, 2024 at 12:39 PM Eric Lu
<erickandmorty2...@gmail.com>
wrote:

Hi,

I'd like to start a discussion thread for my KIP:
KIP-1052: Align the naming convention for config and default
variables
in
*Config classes




https://cwiki.apache.org/confluence/display/KAFKA/KIP-1052%3A+Align+th
e+naming+convention+for+config+and+default+variables+in+*Config+classe
s


Thanks,

Eric



Reply via email to