Farfetch/kafkaflow

[Feature Request]: Renaming Consumer Extension Methods for Standardization

filipeesch opened this issue · 0 comments

Is your request related to a problem you have?

We are proposing a change to the method names used for configuring consumers' middlewares in KafkaFlow. The current method names are not as clear and standardized as we'd like them to be, which can lead to confusion among developers. We believe that renaming these methods will improve clarity and consistency in the framework.

Describe the solution you'd like

We are suggesting the following method name changes for configuring consumers' middlewares in KafkaFlow:

  1. Current Method: AddSerializer

    • Proposed Method Name: AddDeserializer
    • Description:
      • Rename the AddSerializer method to AddDeserializer to more accurately reflect its purpose, which is to configure deserialization of messages.
  2. Current Method: AddCompressor

    • Proposed Method Name: AddDecompressor
    • Description:
      • Rename the AddCompressor method to AddDecompressor to better convey its role in configuring message decompression.
  3. Current Method: BatchConsumer

    • Proposed Method Name: AddBatching
    • Description:
      • Rename the BatchConsumer method to AddBatching for a more intuitive method name that indicates its purpose of configuring message batching.

These proposed changes aim to enhance the consistency and clarity of the framework's API, making it easier for developers to understand and use KafkaFlow effectively.

Are you able to help bring it to life and contribute with a Pull Request?

Yes

Additional context

No response