Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix zookeeper connection leak #192

Merged
merged 2 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions go/vt/topo/zk2topo/zk_conn.go
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,8 @@ func (c *ZkConn) withRetry(ctx context.Context, action func(conn *zk.Conn) error
c.conn = nil
}
c.mu.Unlock()
log.Infof("zk conn: got ErrConnectionClosed: closing")
conn.Close()
}
return
}
Expand Down Expand Up @@ -327,23 +329,18 @@ func (c *ZkConn) maybeAddAuth(ctx context.Context) {
// clears out the connection record.
func (c *ZkConn) handleSessionEvents(conn *zk.Conn, session <-chan zk.Event) {
for event := range session {
closeRequired := false

switch event.State {
case zk.StateExpired, zk.StateConnecting:
closeRequired = true
fallthrough
case zk.StateDisconnected:
case zk.StateDisconnected, zk.StateExpired, zk.StateConnecting:
c.mu.Lock()
if c.conn == conn {
// The ZkConn still references this
// connection, let's nil it.
c.conn = nil
}
c.mu.Unlock()
if closeRequired {
conn.Close()
}
log.Infof("zk conn: got %v: closing", event.State)
conn.Close()
log.Infof("zk conn: session for addr %v ended: %v", c.addr, event)
return
}
Expand Down
65 changes: 65 additions & 0 deletions go/vt/topo/zk2topo/zk_conn_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
Copyright 2019 The Vitess Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package zk2topo

import (
"context"
"testing"

"github.com/stretchr/testify/require"
"github.com/z-division/go-zookeeper/zk"

"vitess.io/vitess/go/testfiles"
"vitess.io/vitess/go/vt/zkctl"
)

func TestZkConnClosedOnDisconnect(t *testing.T) {
zkd, serverAddr := zkctl.StartLocalZk(testfiles.GoVtTopoZk2topoZkID, testfiles.GoVtTopoZk2topoPort)
defer zkd.Teardown()

conn := Connect(serverAddr)
shanth96 marked this conversation as resolved.
Show resolved Hide resolved
defer conn.Close()

_, _, err := conn.Get(context.Background(), "/")
if err != nil {
t.Fatalf("Get() failed: %v", err)
}

if !conn.conn.State().IsConnected() {
t.Fatalf("Connection not connected: %v", conn.conn.State())
}

oldConn := conn.conn

// force a disconnect
zkd.Shutdown()
zkd.Start()

// do another get to trigger a new connection
_, _, err = conn.Get(context.Background(), "/")
if err != nil {
t.Fatalf("Get() failed: %v", err)
}

// Check that old connection is closed
_, _, err = oldConn.Get("/")
require.ErrorContains(t, err, "zookeeper is closing")

if oldConn.State() != zk.StateDisconnected {
t.Fatalf("Connection is not in disconnected state: %v", oldConn.State())
}
}
Loading