Skip to content

[GSoC 2026] Kafka Streams runner: shorten comments, and fix the license header and Python formatting - #39781

Merged
je-ik merged 2 commits into
apache:feat/18479-kafka-streams-runner-skeletonfrom
junaiddshaukat:feat/ks-comments-and-ci
Aug 17, 2026
Merged

[GSoC 2026] Kafka Streams runner: shorten comments, and fix the license header and Python formatting#39781
je-ik merged 2 commits into
apache:feat/18479-kafka-streams-runner-skeletonfrom
junaiddshaukat:feat/ks-comments-and-ci

Conversation

@junaiddshaukat

Copy link
Copy Markdown
Contributor

Part of #18479. The changes that were sitting on the master merge, moved onto the feature branch so the merge to master can come from the branch itself.

Two of them are CI fixes the feature branch never exercised, because its own workflow only built the runner. RAT rejects the measurement docker-compose.yml for having no Apache license header, and yapf wants one line in the Python wrapper joined.

The rest is shortening the explanation comments. Measured against the other runners, comment lines as a fraction of code were 33% here against 17% for core-java, 14% for Spark, 12% for direct-java and 9% for Flink, and long blocks were about three times as frequent per file as the worst of those. This takes it to 29% and cuts the longest block from 52 lines to 36; the worst class comments are rewritten and the reasoning kept.

It also corrects four comments that had gone stale: two translators claiming topics are not created automatically, though KafkaStreamsTopicManager has created them for months; KStreamsPayload saying its serde does not exist yet; and ReadTranslator pointing at the test runner for a conversion the runner now does itself.

Verified with ./gradlew -Pwith-kafka-streams-runner :runners:kafka-streams:build.

…g for master CI

The measurement docker-compose file had no Apache license header, which RAT
rejects, and one line in the Python wrapper was not as yapf formats it.
Neither ran on the feature branch, whose CI only built the runner.
Several class comments explained more than they needed to, which makes them
less likely to be read rather than more. Shortened the longest, keeping the
reasoning and dropping the retelling.

Also corrects four that had gone stale: two translators claiming topics are
not created automatically, the payload claiming its serde does not exist
yet, and the read translator pointing at the test runner for a conversion
the runner now does itself.
@je-ik
je-ik merged commit 8d5f651 into apache:feat/18479-kafka-streams-runner-skeleton Aug 17, 2026
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants