Fix socket file handle leaks from old blocking queries upon consul reload. This fixes issue #3018

api/api.go

@@ -105,6 +105,10 @@ type QueryOptions struct {
 	// relayed back to the sender through N other random nodes. Must be
 	// a value from 0 to 5 (inclusive).
 	RelayFactor uint8
+
+	// Context (optional) is passed through to the underlying http request layer, can be used
+	// to set timeouts and deadlines as well as to cancel requests
+	Context context.Context
 }
 
 // WriteOptions are used to parameterize a write
@@ -457,6 +461,7 @@ type request struct {
 	body   io.Reader
 	header http.Header
 	obj    interface{}
+	ctx    context.Context
 }
 
 // setQueryOptions is used to annotate the request with
@@ -494,6 +499,7 @@ func (r *request) setQueryOptions(q *QueryOptions) {
 	if q.RelayFactor != 0 {
 		r.params.Set("relay-factor", strconv.Itoa(int(q.RelayFactor)))
 	}
+	r.ctx = q.Context
 }
 
 // durToMsec converts a duration to a millisecond specified string. If the
@@ -569,8 +575,11 @@ func (r *request) toHTTP() (*http.Request, error) {
 	if r.config.HttpAuth != nil {
 		req.SetBasicAuth(r.config.HttpAuth.Username, r.config.HttpAuth.Password)
 	}
-
+	if r.ctx != nil {
-	return req, nil
+		return req.WithContext(r.ctx), nil
+	} else {
+		return req, nil
+	}
 }
 
 // newRequest is used to create a new request

watch/funcs.go

@@ -1,6 +1,7 @@
 package watch
 
 import (
+	"context"
 	"fmt"
 
 	consulapi "github.com/hashicorp/consul/api"
@@ -41,7 +42,9 @@ func keyWatch(params map[string]interface{}) (WatcherFunc, error) {
 	}
 	fn := func(p *Plan) (uint64, interface{}, error) {
 		kv := p.client.KV()
-		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex}
+		ctx, cancel := context.WithCancel(context.Background())
+		p.cancelFunc = cancel
+		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex, Context: ctx}
 		pair, meta, err := kv.Get(key, &opts)
 		if err != nil {
 			return 0, nil, err
@@ -70,7 +73,9 @@ func keyPrefixWatch(params map[string]interface{}) (WatcherFunc, error) {
 	}
 	fn := func(p *Plan) (uint64, interface{}, error) {
 		kv := p.client.KV()
-		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex}
+		ctx, cancel := context.WithCancel(context.Background())
+		p.cancelFunc = cancel
+		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex, Context: ctx}
 		pairs, meta, err := kv.List(prefix, &opts)
 		if err != nil {
 			return 0, nil, err
@@ -89,7 +94,9 @@ func servicesWatch(params map[string]interface{}) (WatcherFunc, error) {
 
 	fn := func(p *Plan) (uint64, interface{}, error) {
 		catalog := p.client.Catalog()
-		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex}
+		ctx, cancel := context.WithCancel(context.Background())
+		p.cancelFunc = cancel
+		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex, Context: ctx}
 		services, meta, err := catalog.Services(&opts)
 		if err != nil {
 			return 0, nil, err
@@ -108,7 +115,9 @@ func nodesWatch(params map[string]interface{}) (WatcherFunc, error) {
 
 	fn := func(p *Plan) (uint64, interface{}, error) {
 		catalog := p.client.Catalog()
-		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex}
+		ctx, cancel := context.WithCancel(context.Background())
+		p.cancelFunc = cancel
+		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex, Context: ctx}
 		nodes, meta, err := catalog.Nodes(&opts)
 		if err != nil {
 			return 0, nil, err
@@ -144,7 +153,9 @@ func serviceWatch(params map[string]interface{}) (WatcherFunc, error) {
 
 	fn := func(p *Plan) (uint64, interface{}, error) {
 		health := p.client.Health()
-		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex}
+		ctx, cancel := context.WithCancel(context.Background())
+		p.cancelFunc = cancel
+		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex, Context: ctx}
 		nodes, meta, err := health.Service(service, tag, passingOnly, &opts)
 		if err != nil {
 			return 0, nil, err
@@ -177,7 +188,9 @@ func checksWatch(params map[string]interface{}) (WatcherFunc, error) {
 
 	fn := func(p *Plan) (uint64, interface{}, error) {
 		health := p.client.Health()
-		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex}
+		ctx, cancel := context.WithCancel(context.Background())
+		p.cancelFunc = cancel
+		opts := consulapi.QueryOptions{AllowStale: stale, WaitIndex: p.lastIndex, Context: ctx}
 		var checks []*consulapi.HealthCheck
 		var meta *consulapi.QueryMeta
 		var err error
@@ -205,7 +218,9 @@ func eventWatch(params map[string]interface{}) (WatcherFunc, error) {
 
 	fn := func(p *Plan) (uint64, interface{}, error) {
 		event := p.client.Event()
-		opts := consulapi.QueryOptions{WaitIndex: p.lastIndex}
+		ctx, cancel := context.WithCancel(context.Background())
+		p.cancelFunc = cancel
+		opts := consulapi.QueryOptions{WaitIndex: p.lastIndex, Context: ctx}
 		events, meta, err := event.List(name, &opts)
 		if err != nil {
 			return 0, nil, err

watch/plan.go

@@ -107,6 +107,9 @@ func (p *Plan) Stop() {
 		return
 	}
 	p.stop = true
+	if p.cancelFunc != nil {
+		p.cancelFunc()
+	}
 	close(p.stopCh)
 }
 

watch/watch.go

@@ -5,6 +5,8 @@ import (
 	"io"
 	"sync"
 
+	"context"
+
 	consulapi "github.com/hashicorp/consul/api"
 )
 
@@ -27,9 +29,10 @@ type Plan struct {
 	lastIndex  uint64
 	lastResult interface{}
 
-	stop     bool
+	stop       bool
-	stopCh   chan struct{}
+	stopCh     chan struct{}
-	stopLock sync.Mutex
+	stopLock   sync.Mutex
+	cancelFunc context.CancelFunc
 }
 
 // WatcherFunc is used to watch for a diff