[KAFKA-5090] Kafka Streams SessionStore.findSessions javadoc broken - ASF JIRA

Attach files

Attach Screenshot

Voters

Watch issue

Watchers

Create sub-task

Link

Clone

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: Bug
Status: Resolved
Priority: Trivial
Resolution: Fixed
Affects Version/s: 0.10.2.0, 0.10.2.1
Fix Version/s: 0.11.0.0
Component/s: streams
Labels:
None

Description

    /**
     * Fetch any sessions with the matching key and the sessions end is &le earliestEndTime and the sessions
     * start is &ge latestStartTime
     */
    KeyValueIterator<Windowed<K>, AGG> findSessions(final K key, long earliestSessionEndTime, final long latestSessionStartTime);

The conditions in the javadoc comment are inverted (le should be ge and ge shoudl be le), since this is what the code does. They were correct in the original KIP:
https://cwiki.apache.org/confluence/display/KAFKA/KIP-94+Session+Windows

    /**
     * Find any aggregated session values with the matching key and where the
     * session’s end time is >= earliestSessionEndTime, i.e, the oldest session to
     * merge with, and the session’s start time is <= latestSessionStartTime, i.e,
     * the newest session to merge with.
     */
   KeyValueIterator<Windowed<K>, AGG> findSessionsToMerge(final K key, final long earliestSessionEndTime, final long latestSessionStartTime);

Also, the escaped html character references are missing the trailing semicolon making them render as-is.

Happy to have this assigned to me to fix as it seems trivial.