Skip to content

[admin-tool] update VeniceKafkaDecodedRecord with PubSubPosition field #2286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[admin-tool] update VeniceKafkaDecodedRecord with PubSubPosition field #2286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions internal/venice-common/src/main/resources/avro/VeniceKafkaDecodedRecord.avsc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
"doc": "Raw bytes of the value"
},
{
"name": "offset",
"type": "long",
"doc": "The offset of this record in Kafka"
"name": "position",
"type": "string",
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a breaking schema change that will cause backward compatibility issues. The field name change from 'offset' to 'position' and type change from 'long' to 'string' means existing consumers (like KafkaTopicDumper at line 459 in KafkaTopicDumper.java which references 'offset field') will break when reading new records. Consider: (1) adding an alias to the field definition using Avro's 'aliases' property to maintain backward compatibility, or (2) implementing a phased migration approach with both fields present temporarily, or (3) documenting this as a major breaking change requiring coordinated deployment.

Suggested change
"type": "string",
"type": "string",
"aliases": ["offset"],

Copilot uses AI. Check for mistakes.
"doc": "The position of this record in Kafka"
Copy link

Copilot AI Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation should clarify that 'position' contains a serialized PubSubPosition wire format string (base64-encoded), not just a simple offset value. This would help consumers understand the expected format and how to deserialize it. Consider updating to: 'The position of this record in Kafka as a serialized PubSubPosition wire format string'.

Suggested change
"doc": "The position of this record in Kafka"
"doc": "The position of this record in Kafka as a serialized PubSubPosition wire format string (base64-encoded)"

Copilot uses AI. Check for mistakes.
},
{
"name": "DELETED_TS",
Expand Down
Loading