You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@kafka.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/04/19 15:18:41 UTC

[jira] [Commented] (KAFKA-5090) Kafka Streams SessionStore.findSessions javadoc broken

    [ https://issues.apache.org/jira/browse/KAFKA-5090?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15974897#comment-15974897 ] 

ASF GitHub Bot commented on KAFKA-5090:
---------------------------------------

GitHub user mihbor opened a pull request:

    https://github.com/apache/kafka/pull/2874

    KAFKA-5090 Kafka Streams SessionStore.findSessions javadoc broken

    

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mihbor/kafka patch-1

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/kafka/pull/2874.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #2874
    
----
commit 0bcb6fba658826964589fe409f80511a31c3164b
Author: mihbor <mb...@gmail.com>
Date:   2017-04-19T15:18:04Z

    KAFKA-5090 Kafka Streams SessionStore.findSessions javadoc broken

----


> Kafka Streams SessionStore.findSessions javadoc broken
> ------------------------------------------------------
>
>                 Key: KAFKA-5090
>                 URL: https://issues.apache.org/jira/browse/KAFKA-5090
>             Project: Kafka
>          Issue Type: Bug
>          Components: streams
>    Affects Versions: 0.10.2.0
>            Reporter: Michal Borowiecki
>            Priority: Trivial
>
> {code}
>     /**
>      * 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);
> {code}
> 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
> {code}
>     /**
>      * 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);
> {code}
> 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.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)