fix: timeout issues for list.peerings

The previously used `DefaultContextTimeout` does not work well with the user-definable `WaitTime`, which can easily exceed this global timeout.

Fixes #2041

Author: EtienneBruines

dependency/consul_peering.go

@@ -99,10 +99,15 @@ func (l *ListPeeringQuery) Fetch(clients *ClientSet, opts *QueryOptions) (interf
 		RawQuery: opts.String(),
 	})
 
-	// list peering is a blocking API, so making sure the ctx passed while calling it
-	// times out after the default wait time.
-	ctx, cancel := context.WithTimeout(context.Background(), DefaultContextTimeout)
-	defer cancel()
+	// The first result needs to be "immediate", in which case we use the default timeout settings.
+	// For all other requests, we use a 'blocking' query, therefore setting the appropriate timeout.
+	// We add one second to allow for the Consul client to finish sending the response before
+	// declaring it an exceeded deadline.
+	var ctx context.Context
+	if opts.WaitTime != 0 {
+		ctx, cancel := context.WithTimeout(context.Background(), opts.WaitTime + time.Second)
+		defer cancel()
+	}
 
 	p, meta, err := clients.Consul().Peerings().List(ctx, opts.ToConsulOpts())
 	if err != nil {