[KAFKA-9232] Coordinator new member heartbeat completion does not work for JoinGroup v3

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.1.1, 2.2.2, 2.4.0, 2.3.1
• Fix Version/s: 2.1.2, 2.2.3, 2.3.2, 2.4.1
• Assignee: A. Sophie Blee-Goldman
• Reporter: Jason Gustafson
• Created: 26/Nov/19 18:49
• Updated: 24/Dec/19 01:17
• Resolved: 24/Dec/19 01:17

Description

For older versions of the JoinGroup API, the coordinator implements a static timeout for new members of 5 minutes. This timeout is implemented using the heartbeat purgatory and we expect that the delayed operation will be force completed if the member successfully joins. This is implemented in GroupCoordinator with the following logic:

            group.maybeInvokeJoinCallback(member, joinResult)
            completeAndScheduleNextHeartbeatExpiration(group, member)
            member.isNew = false

However, heartbeat completion depends on this check:

  def shouldKeepAlive(deadlineMs: Long): Boolean = {
    if (isAwaitingJoin)
      !isNew || latestHeartbeat + GroupCoordinator.NewMemberJoinTimeoutMs > deadlineMs
    else awaitingSyncCallback != null ||
      latestHeartbeat + sessionTimeoutMs > deadlineMs
  }

Since we invoke the join callback first, we will fall to the second branch. This will only return true when the latest heartbeat plus session timeout exceeds the deadline. The deadline in this case depends only on the statically configured new member timeout, which means the heartbeat cannot complete until about 5 minutes have passed. If the member falls out of the group before then, then the heartbeat ultimately expires, which may trigger a spurious rebalance.

Newer versions of the protocol are not affected by this bug because we return immediately the first time a member joins the group.

Issue Links

• links to: GitHub Pull Request #7753