Uploaded image for project: 'Kafka'
  1. Kafka
  2. KAFKA-5090

Kafka Streams SessionStore.findSessions javadoc broken

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Trivial
    • Resolution: Fixed
    • 0.10.2.0, 0.10.2.1
    • 0.11.0.0
    • streams
    • 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.

      Attachments

        Issue Links

          Activity

            People

              mihbor Michal Borowiecki
              mihbor Michal Borowiecki
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: