Comment fixes, bool -> enum for connectiontype

connect/connection.go

@@ -2,6 +2,7 @@ package connect
 
 import (
 	"github.com/ktr0731/grpc-web-go-client/grpcweb"
+	jww "github.com/spf13/jwalterweatherman"
 	"google.golang.org/grpc"
 )
 
@@ -9,6 +10,27 @@ const (
 	tlsError = "TLS cannot be disabled in production, only for testing suites!"
 )
 
+// ConnectionType is intended to act as an enum for different methods of host connection
+type ConnectionType uint8
+
+// Enumerate the extant connection methods
+const (
+	Grpc ConnectionType = iota
+	Web
+)
+
+// Stringify connection constants
+func (ct ConnectionType) String() string {
+	switch ct {
+	case Grpc:
+		return "grpc"
+	case Web:
+		return "web"
+	default:
+		return "unknown"
+	}
+}
+
 // Connection is an interface designed to sit between hosts and connections
 // to allow use of grpcweb clients.
 type Connection interface {
@@ -36,15 +58,15 @@ type clientConnHelpers interface {
 	disconnect()
 }
 
-// newConnection initializes a webConn and returns it wrapped as a Connection
-func newConnection(isWeb bool, host *Host) Connection {
-	if isWeb {
-		return &webConn{
-			h: host,
-		}
-	} else {
-		return &grpcConn{
-			h: host,
-		}
+// newConnection initializes a webConn or grpcConn and returns it wrapped as a Connection
+func newConnection(t ConnectionType, host *Host) Connection {
+	switch t {
+	case Web:
+		return &webConn{h: host}
+	case Grpc:
+		return &grpcConn{h: host}
+	default:
+		jww.ERROR.Printf("Cannot make connection of type %s", t)
+		return nil
 	}
 }

connect/connection_test.go

@@ -39,8 +39,9 @@ func TestWebConnection(t *testing.T) {
 	}
 	hostParams := GetDefaultHostParams()
 	TestingOnlyDisableTLS = true
+	hostParams.ConnectionType = Web
 
-	h, err := newHost(hostId, addr, nil, hostParams, true)
+	h, err := newHost(hostId, addr, nil, hostParams)
 	if err != nil {
 		t.Fatal(err)
 	}

connect/grpcConn.go

@@ -12,11 +12,10 @@ import (
 	"time"
 )
 
-// webConn implements the Connection interface
+// grpcConn implements the Connection interface
 type grpcConn struct {
 	h          *Host
-	webConn  *grpcweb.ClientConn
-	grpcConn *grpc.ClientConn
+	connection *grpc.ClientConn
 }
 
 // GetWebConn returns the grpcweb ClientConn object
@@ -27,7 +26,7 @@ func (gc *grpcConn) GetWebConn() *grpcweb.ClientConn {
 
 // GetGrpcConn returns the grpc ClientConn object
 func (gc *grpcConn) GetGrpcConn() *grpc.ClientConn {
-	return gc.grpcConn
+	return gc.connection
 }
 
 // Connect initializes the appropriate connection using helper functions.
@@ -35,7 +34,7 @@ func (gc *grpcConn) Connect() error {
 	return gc.connectGrpcHelper()
 }
 
-// IsWeb returns true if the webConn is configured for web connections
+// IsWeb returns true if the connection is configured for web connections
 func (gc *grpcConn) IsWeb() bool {
 	return false
 }
@@ -90,7 +89,7 @@ func (gc *grpcConn) connectGrpcHelper() (err error) {
 		}
 
 		// Create the connection
-		gc.grpcConn, err = grpc.DialContext(ctx, gc.h.GetAddress(),
+		gc.connection, err = grpc.DialContext(ctx, gc.h.GetAddress(),
 			dialOpts...)
 
 		if err != nil {
@@ -113,12 +112,12 @@ func (gc *grpcConn) connectGrpcHelper() (err error) {
 	return
 }
 
-// Close calls the internal Close function on the grpcConn
+// Close calls the internal Close function on the connection
 func (gc *grpcConn) Close() error {
-	if gc.grpcConn == nil {
+	if gc.connection == nil {
 		return nil
 	}
-	return gc.grpcConn.Close()
+	return gc.connection.Close()
 }
 
 // disconnect closes the grpcConn connection while not under a write lock.
@@ -127,14 +126,14 @@ func (gc *grpcConn) disconnect() {
 	// it's possible to close a host which never sent so that it never made a
 	// connection. In that case, we should not close a connection which does not
 	// exist
-	if gc.grpcConn != nil {
+	if gc.connection != nil {
 		jww.INFO.Printf("Disconnected from %s at %s", gc.h.GetId(), gc.h.GetAddress())
-		err := gc.grpcConn.Close()
+		err := gc.connection.Close()
 		if err != nil {
 			jww.ERROR.Printf("Unable to close connection to %s: %+v",
 				gc.h.GetAddress(), errors.New(err.Error()))
 		} else {
-			gc.grpcConn = nil
+			gc.connection = nil
 		}
 	}
 }
@@ -142,10 +141,10 @@ func (gc *grpcConn) disconnect() {
 // isAlive returns true if the grpcConn is non-nil and alive
 // must already be under the connectionMux
 func (gc *grpcConn) isAlive() bool {
-	if gc.grpcConn == nil {
+	if gc.connection == nil {
 		return false
 	}
-	state := gc.grpcConn.GetState()
+	state := gc.connection.GetState()
 	return state == connectivity.Idle || state == connectivity.Connecting ||
 		state == connectivity.Ready
 }

connect/host.go

@@ -83,18 +83,11 @@ type Host struct {
 // NewHost creates a new host object which will use GRPC.
 func NewHost(id *id.ID, address string, cert []byte,
 	params HostParams) (host *Host, err error) {
-	return newHost(id, address, cert, params, false)
-}
-
-// NewHostWeb creates a new host object which will use the grpcweb library.
-func NewHostWeb(id *id.ID, address string, cert []byte,
-	params HostParams) (host *Host, err error) {
-	return newHost(id, address, cert, params, true)
+	return newHost(id, address, cert, params)
 }
 
 // newHost is a helper which creates a new Host object
-func newHost(id *id.ID, address string, cert []byte, params HostParams,
-	isWeb bool) (host *Host, err error) {
+func newHost(id *id.ID, address string, cert []byte, params HostParams) (host *Host, err error) {
 
 	windowSize := int32(0)
 
@@ -110,7 +103,7 @@ func newHost(id *id.ID, address string, cert []byte, params HostParams,
 		windowSize:        &windowSize,
 	}
 
-	host.connection = newConnection(isWeb, host)
+	host.connection = newConnection(params.ConnectionType, host)
 
 	if params.EnableCoolOff {
 		host.coolOffBucket = rateLimiting.CreateBucket(

connect/hostParams.go

@@ -56,6 +56,9 @@ type HostParams struct {
 	// ProxyErrorMetricParams are the parameters used for the proxy error
 	// tracker that uses exponential moving average (exponential.MovingAvg).
 	ProxyErrorMetricParams exponential.MovingAvgParams
+
+	// ConnectionType describes the method for the underlying host connection
+	ConnectionType ConnectionType
 }
 
 // GetDefaultHostParams Get default set of host params
@@ -81,5 +84,6 @@ func GetDefaultHostParams() HostParams {
 			PermitWithoutStream: true,
 		},
 		ProxyErrorMetricParams: exponential.DefaultMovingAvgParams(),
+		ConnectionType:         Grpc,
 	}
 }

connect/webConn.go

@@ -11,13 +11,12 @@ import (
 // webConn implements the Connection interface
 type webConn struct {
 	h          *Host
-	webConn  *grpcweb.ClientConn
-	grpcConn *grpc.ClientConn
+	connection *grpcweb.ClientConn
 }
 
 // GetWebConn returns the grpcweb ClientConn object
 func (wc *webConn) GetWebConn() *grpcweb.ClientConn {
-	return wc.webConn
+	return wc.connection
 }
 
 // GetGrpcConn returns the grpc ClientConn object
@@ -31,7 +30,7 @@ func (wc *webConn) Connect() error {
 	return wc.connectWebHelper()
 }
 
-// IsWeb returns true if the webConn is configured for web connections
+// IsWeb returns true if the connection is configured for web connections
 func (wc *webConn) IsWeb() bool {
 	return true
 }
@@ -84,7 +83,7 @@ func (wc *webConn) connectWebHelper() (err error) {
 		//}
 
 		// Create the connection
-		wc.webConn, err = grpcweb.DialContext(wc.h.GetAddress(),
+		wc.connection, err = grpcweb.DialContext(wc.h.GetAddress(),
 			dialOpts...)
 
 		if err != nil {
@@ -110,7 +109,7 @@ func (wc *webConn) connectWebHelper() (err error) {
 // Close handles closing the http connection.
 func (wc *webConn) Close() error {
 	// TODO this needs work on the grpc-web-go-client side
-	if wc.webConn == nil {
+	if wc.connection == nil {
 		return nil
 	}
 	return nil
@@ -123,9 +122,9 @@ func (wc *webConn) disconnect() {
 	// it's possible to close a host which never sent so that it never made a
 	// connection. In that case, we should not close a connection which does not
 	// exist
-	if wc.webConn != nil {
+	if wc.connection != nil {
 		// TODO webconn cannot close yet, this needs work on that side
-		wc.webConn = nil
+		wc.connection = nil
 	}
 
 }
@@ -134,7 +133,7 @@ func (wc *webConn) disconnect() {
 // must already be under the connectionMux
 func (wc *webConn) isAlive() bool {
 	// TODO this cannot be determined until grpcweb clients have a persistent connection
-	if wc.webConn == nil {
+	if wc.connection == nil {
 		return false
 	}
 	return true