http_(proxy,server): remove Close() from API

Listeners are created in constructor and closed in finalizer, specified in constructor. This is the 2nd time they are closed, the first close is issued on Shutdown().
saucelabs · Nov 28, 2024 · d79700d · d79700d
1 parent dbf5077
commit d79700d
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 9 deletions.
diff --git a/command/pac/server/server.go b/command/pac/server/server.go
@@ -102,7 +102,6 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 	if err != nil {
 		return err
 	}
-	defer s.Close()
 
 	return runctx.NewGroup(s.Run).Run()
 }

diff --git a/command/run/run.go b/command/run/run.go
@@ -228,7 +228,6 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 		if err != nil {
 			return err
 		}
-		defer p.Close()
 		g.Add(p.Run)
 
 		if ca := p.MITMCACert(); ca != nil {
@@ -273,7 +272,6 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 			if err != nil {
 				return err
 			}
-			defer a.Close()
 			g.Add(a.Run)
 		}
 	}

diff --git a/command/test/httpbin/httpbin.go b/command/test/httpbin/httpbin.go
@@ -81,7 +81,6 @@ func (c *command) runE(cmd *cobra.Command, _ []string) (cmdErr error) {
 	if err != nil {
 		return err
 	}
-	defer s.Close()
 	g.Add(s.Run)
 
 	g.Add(func(ctx context.Context) error {

diff --git a/http_proxy.go b/http_proxy.go
@@ -16,6 +16,7 @@ import (
 	"net"
 	"net/http"
 	"net/url"
+	"runtime"
 	"slices"
 	"strings"
 	"time"
@@ -188,6 +189,7 @@ func NewHTTPProxy(cfg *HTTPProxyConfig, pr PACResolver, cm *CredentialsMatcher,
 		return nil, err
 	}
 	hp.listeners = ll
+	runtime.SetFinalizer(hp, (*HTTPProxy).closeListeners)
 
 	for _, l := range hp.listeners {
 		hp.log.Infof("PROXY server listen address=%s protocol=%s", l.Addr(), hp.config.Protocol)
@@ -570,7 +572,7 @@ func (hp *HTTPProxy) run(ctx context.Context) error {
 		ctxErr := ctx.Err()
 
 		// Close listeners first to prevent new connections.
-		if err := hp.Close(); err != nil {
+		if err := hp.closeListeners(); err != nil {
 			hp.log.Debugf("failed to close listeners error=%s", err)
 		}
 
@@ -648,7 +650,7 @@ func (hp *HTTPProxy) Addr() (addrs []string, ok bool) {
 	return
 }
 
-func (hp *HTTPProxy) Close() error {
+func (hp *HTTPProxy) closeListeners() error {
 	var err error
 	for _, l := range hp.listeners {
 		if e := l.Close(); e != nil {

diff --git a/http_proxy_test.go b/http_proxy_test.go
@@ -30,7 +30,6 @@ func TestAbortIf(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	defer p.Close()
 
 	check := func(t *testing.T, rt http.RoundTripper) {
 		t.Helper()
@@ -95,7 +94,6 @@ func TestNopDialer(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	defer p.Close()
 
 	req := &http.Request{
 		Method: http.MethodGet,

diff --git a/http_server.go b/http_server.go
@@ -14,6 +14,7 @@ import (
 	"net"
 	"net/http"
 	"net/url"
+	"runtime"
 	"sync"
 	"time"
 
@@ -146,6 +147,7 @@ func NewHTTPServer(cfg *HTTPServerConfig, h http.Handler, log log.Logger) (*HTTP
 		return nil, err
 	}
 	hs.listener = l
+	runtime.SetFinalizer(hs, (*HTTPServer).closeListener)
 
 	hs.log.Infof("HTTP server listen address=%s protocol=%s", l.Addr(), hs.config.Protocol)
 
@@ -258,6 +260,6 @@ func (hs *HTTPServer) Addr() string {
 	return hs.listener.Addr().String()
 }
 
-func (hs *HTTPServer) Close() error {
+func (hs *HTTPServer) closeListener() error {
 	return hs.listener.Close()
 }