GODRIVER-3173 Fix typos

Author: prestonvasquez

bson/default_value_encoders.go

@@ -9,7 +9,6 @@ package bson
 import (
 	"encoding/json"
 	"errors"
-	"fmt"
 	"math"
 	"net/url"
 	"reflect"
@@ -166,7 +165,6 @@ func decimal128EncodeValue(_ EncodeContext, vw ValueWriter, val reflect.Value) e
 	if !val.IsValid() || val.Type() != tDecimal {
 		return ValueEncoderError{Name: "Decimal128EncodeValue", Types: []reflect.Type{tDecimal}, Received: val}
 	}
-	fmt.Println(val.Interface().(Decimal128))
 	return vw.WriteDecimal128(val.Interface().(Decimal128))
 }
 

event/monitoring.go

@@ -108,11 +108,10 @@ type PoolEvent struct {
 	Reason       string              `json:"reason"`
 	// ServiceID is only set if the Type is PoolCleared and the server is deployed behind a load balancer. This field
 	// can be used to distinguish between individual servers in a load balanced deployment.
-	ServiceID     *bson.ObjectID `json:"serviceId"`
-	Interruption  bool           `json:"interruptInUseConnections"`
-	Error         error          `json:"error"`
-	RequestID     int32          `json:"requestId"`
-	RemainingTime time.Duration  `json:"remainingTime"`
+	ServiceID    *bson.ObjectID `json:"serviceId"`
+	Interruption bool           `json:"interruptInUseConnections"`
+	Error        error          `json:"error"`
+	RequestID    int32          `json:"requestId"`
 }
 
 // PoolMonitor is a function that allows the user to gain access to events occurring in the pool

internal/integration/csot_prose_test.go

@@ -176,7 +176,6 @@ func TestCSOTProse(t *testing.T) {
 				time.Millisecond,
 				"expected ping to fail within 150ms")
 		})
-
 	})
 
 	mt.RunOpts("11. multi-batch bulkWrites", mtest.NewOptions().MinServerVersion("8.0").

internal/logger/component.go

@@ -14,35 +14,35 @@ import (
 )
 
 const (
-	CommandFailed                    = "Command failed"
-	CommandStarted                   = "Command started"
-	CommandSucceeded                 = "Command succeeded"
-	ConnectionPoolCreated            = "Connection pool created"
-	ConnectionPoolReady              = "Connection pool ready"
-	ConnectionPoolCleared            = "Connection pool cleared"
-	ConnectionPoolClosed             = "Connection pool closed"
-	ConnectionCreated                = "Connection created"
-	ConnectionReady                  = "Connection ready"
-	ConnectionClosed                 = "Connection closed"
-	ConnectionCheckoutStarted        = "Connection checkout started"
-	ConnectionCheckoutFailed         = "Connection checkout failed"
-	ConnectionCheckedOut             = "Connection checked out"
-	ConnectionCheckedIn              = "Connection checked in"
-	ConnectionPendingReadStarted     = "Pending response started"
-	ConnectionPendingReadSucceeded   = "Pending response succeeded"
-	ConnectionPendingReadFailed      = "Pending response failed"
-	ServerSelectionFailed            = "Server selection failed"
-	ServerSelectionStarted           = "Server selection started"
-	ServerSelectionSucceeded         = "Server selection succeeded"
-	ServerSelectionWaiting           = "Waiting for suitable server to become available"
-	TopologyClosed                   = "Stopped topology monitoring"
-	TopologyDescriptionChanged       = "Topology description changed"
-	TopologyOpening                  = "Starting topology monitoring"
-	TopologyServerClosed             = "Stopped server monitoring"
-	TopologyServerHeartbeatFailed    = "Server heartbeat failed"
-	TopologyServerHeartbeatStarted   = "Server heartbeat started"
-	TopologyServerHeartbeatSucceeded = "Server heartbeat succeeded"
-	TopologyServerOpening            = "Starting server monitoring"
+	CommandFailed                      = "Command failed"
+	CommandStarted                     = "Command started"
+	CommandSucceeded                   = "Command succeeded"
+	ConnectionPoolCreated              = "Connection pool created"
+	ConnectionPoolReady                = "Connection pool ready"
+	ConnectionPoolCleared              = "Connection pool cleared"
+	ConnectionPoolClosed               = "Connection pool closed"
+	ConnectionCreated                  = "Connection created"
+	ConnectionReady                    = "Connection ready"
+	ConnectionClosed                   = "Connection closed"
+	ConnectionCheckoutStarted          = "Connection checkout started"
+	ConnectionCheckoutFailed           = "Connection checkout failed"
+	ConnectionCheckedOut               = "Connection checked out"
+	ConnectionCheckedIn                = "Connection checked in"
+	ConnectionPendingResponseStarted   = "Pending response started"
+	ConnectionPendingResponseSucceeded = "Pending response succeeded"
+	ConnectionPendingResponseFailed    = "Pending response failed"
+	ServerSelectionFailed              = "Server selection failed"
+	ServerSelectionStarted             = "Server selection started"
+	ServerSelectionSucceeded           = "Server selection succeeded"
+	ServerSelectionWaiting             = "Waiting for suitable server to become available"
+	TopologyClosed                     = "Stopped topology monitoring"
+	TopologyDescriptionChanged         = "Topology description changed"
+	TopologyOpening                    = "Starting topology monitoring"
+	TopologyServerClosed               = "Stopped server monitoring"
+	TopologyServerHeartbeatFailed      = "Server heartbeat failed"
+	TopologyServerHeartbeatStarted     = "Server heartbeat started"
+	TopologyServerHeartbeatSucceeded   = "Server heartbeat succeeded"
+	TopologyServerOpening              = "Starting server monitoring"
 )
 
 const (

x/mongo/driver/topology/cmap_prose_test.go

@@ -272,7 +272,7 @@ func TestCMAPProse(t *testing.T) {
 
 	// Need to test the case where we attempt a non-blocking read to determine if
 	// we should refresh the remaining time. In the case of the Go Driver, we do
-	// this by attempt to "pee" at 1 byte with a deadline of 1ns.
+	// this by attempt to "peek" at 1 byte with a deadline of 1ns.
 	t.Run("connection attempts peek but fails", func(t *testing.T) {
 		const requestID = int32(-1)
 		timeout := 10 * time.Millisecond
@@ -342,7 +342,7 @@ func TestCMAPProse(t *testing.T) {
 		time.Sleep(3 * time.Second)
 
 		// Check out the connection again. The remaining time should be exhausted
-		// requiring us to "peek" at the connection to determine if we should
+		// requiring us to "peek" at the connection to determine if we should.
 		_, err = p.checkOut(context.Background())
 		assert.ErrorIs(t, err, io.EOF)
 
@@ -363,7 +363,6 @@ func TestCMAPProse(t *testing.T) {
 		assert.Equal(t, requestID, failed[0].RequestID)
 		assert.Equal(t, "error", failed[0].Reason)
 		assert.ErrorIs(t, failed[0].Error, io.EOF)
-		assert.Equal(t, time.Duration(0), failed[0].RemainingTime)
 
 		// There should be 0 ConnectionPendingResponseSucceeded event.
 		require.Len(t, poolEventsByType[event.ConnectionPendingResponseSucceeded], 0)
@@ -442,6 +441,7 @@ func TestCMAPProse(t *testing.T) {
 
 		// Check out the connection again. The remaining time should be exhausted
 		// requiring us to "peek" at the connection to determine if we should
+		// close as not alive.
 		_, err = p.checkOut(context.Background())
 		require.NoError(t, err)
 

x/mongo/driver/topology/connection.go

@@ -47,7 +47,7 @@ var (
 
 func nextConnectionID() uint64 { return atomic.AddUint64(&globalConnectionID, 1) }
 
-type pendingReadState struct {
+type pendingResponseState struct {
 	remainingBytes int32
 	requestID      int32
 	start          time.Time
@@ -88,11 +88,11 @@ type connection struct {
 	// accessTokens in the OIDC authenticator cache.
 	oidcTokenGenID uint64
 
-	// pendingReadState contains information required to attempt a pending read
+	// pendingResponseState contains information required to attempt a pending read
 	// in the event of a socket timeout for an operation that has appended
 	// maxTimeMS to the wire message.
-	pendingReadState *pendingReadState
-	pendingReadMu    sync.Mutex
+	pendingResponseState   *pendingResponseState
+	pendingResponseStateMu sync.Mutex
 }
 
 // newConnection handles the creation of a connection. It does not connect the connection.
@@ -415,14 +415,14 @@ func (c *connection) readWireMessage(ctx context.Context) ([]byte, error) {
 
 	dst, errMsg, err := c.read(ctx)
 	if err != nil {
-		c.pendingReadMu.Lock()
-		if c.pendingReadState == nil {
+		c.pendingResponseStateMu.Lock()
+		if c.pendingResponseState == nil {
 			// If there is no pending read on the connection, use the pre-CSOT
 			// behavior and close the connection because we don't know if there are
 			// other bytes left to read.
 			c.close()
 		}
-		c.pendingReadMu.Unlock()
+		c.pendingResponseStateMu.Unlock()
 		message := errMsg
 		if errors.Is(err, io.EOF) {
 			message = "socket was unexpectedly closed"
@@ -490,7 +490,7 @@ func (c *connection) read(ctx context.Context) (bytesRead []byte, errMsg string,
 		if l := int32(n); l == 0 && isCSOTTimeout(err) && driverutil.HasMaxTimeMS(ctx) {
 			requestID, _ := driverutil.GetRequestID(ctx)
 
-			c.pendingReadState = &pendingReadState{
+			c.pendingResponseState = &pendingResponseState{
 				remainingBytes: l,
 				requestID:      requestID,
 				start:          time.Now(),
@@ -512,7 +512,7 @@ func (c *connection) read(ctx context.Context) (bytesRead []byte, errMsg string,
 		if remainingBytes > 0 && isCSOTTimeout(err) && driverutil.HasMaxTimeMS(ctx) {
 			requestID, _ := driverutil.GetRequestID(ctx)
 
-			c.pendingReadState = &pendingReadState{
+			c.pendingResponseState = &pendingResponseState{
 				remainingBytes: remainingBytes,
 				requestID:      requestID,
 				start:          time.Now(),

x/mongo/driver/topology/pool.go

@@ -578,7 +578,7 @@ func (p *pool) checkOut(ctx context.Context) (conn *connection, err error) {
 			return nil, w.err
 		}
 
-		if err := awaitPendingRead(ctx, p, w.conn); err != nil {
+		if err := awaitPendingResponse(ctx, p, w.conn); err != nil {
 			return nil, err
 		}
 
@@ -638,7 +638,7 @@ func (p *pool) checkOut(ctx context.Context) (conn *connection, err error) {
 			return nil, w.err
 		}
 
-		if err := awaitPendingRead(ctx, p, w.conn); err != nil {
+		if err := awaitPendingResponse(ctx, p, w.conn); err != nil {
 			return nil, err
 		}
 
@@ -781,19 +781,18 @@ func (p *pool) removeConnection(conn *connection, reason reason, err error) erro
 	return nil
 }
 
-// PendingReadTimeout is the maximum amount of the to wait when trying to read
-// the server reply on a connection after an operation timed out. The
-// default is 400 milliseconds. This value is refreshed for every 4KB read from
-// the TCP stream.
+// PendingResponseTimeout is the maximum amount of the to wait when trying to
+// read the server reply on a connection after an operation timed out. The
+// default is 3000 milliseconds.
 //
-// Deprecated: PendingReadTimeout is intended for internal use only and may be
-// removed or modified at any time.
-var PendingReadTimeout = 3000 * time.Millisecond
+// Deprecated: PendingResponseTimeout is intended for internal use only and may
+// be removed or modified at any time.
+var PendingResponseTimeout = 3000 * time.Millisecond
 
-// publishPendingReadStarted will log a message to the pool logger and
+// publishPendingResponseStarted will log a message to the pool logger and
 // publish an event to the pool monitor if they are set.
-func publishPendingReadStarted(pool *pool, conn *connection) {
-	prs := conn.pendingReadState
+func publishPendingResponseStarted(pool *pool, conn *connection) {
+	prs := conn.pendingResponseState
 	if prs == nil {
 		return
 	}
@@ -805,7 +804,7 @@ func publishPendingReadStarted(pool *pool, conn *connection) {
 			logger.KeyRequestID, prs.requestID,
 		}
 
-		logPoolMessage(pool, logger.ConnectionPendingReadStarted, keysAndValues...)
+		logPoolMessage(pool, logger.ConnectionPendingResponseStarted, keysAndValues...)
 	}
 
 	// publish an event to the pool monitor if it is set.
@@ -821,8 +820,8 @@ func publishPendingReadStarted(pool *pool, conn *connection) {
 	}
 }
 
-func publishPendingReadFailed(pool *pool, conn *connection, err error) {
-	prs := conn.pendingReadState
+func publishPendingResponseFailed(pool *pool, conn *connection, err error) {
+	prs := conn.pendingResponseState
 	if prs == nil {
 		return
 	}
@@ -840,7 +839,7 @@ func publishPendingReadFailed(pool *pool, conn *connection, err error) {
 			logger.KeyError, err.Error(),
 		}
 
-		logPoolMessage(pool, logger.ConnectionPendingReadFailed, keysAndValues...)
+		logPoolMessage(pool, logger.ConnectionPendingResponseFailed, keysAndValues...)
 	}
 
 	if pool.monitor != nil {
@@ -856,8 +855,8 @@ func publishPendingReadFailed(pool *pool, conn *connection, err error) {
 	}
 }
 
-func publishPendingReadSucceeded(pool *pool, conn *connection, dur time.Duration) {
-	prs := conn.pendingReadState
+func publishPendingResponseSucceeded(pool *pool, conn *connection, dur time.Duration) {
+	prs := conn.pendingResponseState
 	if prs == nil {
 		return
 	}
@@ -869,7 +868,7 @@ func publishPendingReadSucceeded(pool *pool, conn *connection, dur time.Duration
 			logger.KeyDurationMS, dur.Milliseconds(),
 		}
 
-		logPoolMessage(pool, logger.ConnectionPendingReadSucceeded, keysAndValues...)
+		logPoolMessage(pool, logger.ConnectionPendingResponseSucceeded, keysAndValues...)
 	}
 
 	if pool.monitor != nil {
@@ -901,8 +900,8 @@ func peekConnectionAlive(conn *connection) (int, error) {
 	return len(bytes), err
 }
 
-func attemptPendingRead(ctx context.Context, conn *connection, remainingTime time.Duration) (int, error) {
-	pendingreadState := conn.pendingReadState
+func attemptPendingResponse(ctx context.Context, conn *connection, remainingTime time.Duration) (int, error) {
+	pendingreadState := conn.pendingResponseState
 	if pendingreadState == nil {
 		return 0, fmt.Errorf("no pending read state")
 	}
@@ -986,25 +985,25 @@ func attemptPendingRead(ctx context.Context, conn *connection, remainingTime tim
 	return int(totalRead), nil
 }
 
-// awaitPendingRead sets a new read deadline on the provided connection and
+// awaitPendingResponse sets a new read deadline on the provided connection and
 // tries to read any bytes returned by the server. If there are any errors, the
 // connection will be checked back into the pool to be retried.
-func awaitPendingRead(ctx context.Context, pool *pool, conn *connection) error {
-	conn.pendingReadMu.Lock()
-	defer conn.pendingReadMu.Unlock()
+func awaitPendingResponse(ctx context.Context, pool *pool, conn *connection) error {
+	conn.pendingResponseStateMu.Lock()
+	defer conn.pendingResponseStateMu.Unlock()
 
 	// If there are no bytes pending read, do nothing.
-	if conn.pendingReadState == nil {
+	if conn.pendingResponseState == nil {
 		return nil
 	}
 
-	publishPendingReadStarted(pool, conn)
+	publishPendingResponseStarted(pool, conn)
 
 	var (
-		pendingReadState = conn.pendingReadState
-		remainingTime    = pendingReadState.start.Add(PendingReadTimeout).Sub(time.Now())
-		err              error
-		bytesRead        int
+		pendingResponseState = conn.pendingResponseState
+		remainingTime        = pendingResponseState.start.Add(PendingResponseTimeout).Sub(time.Now())
+		err                  error
+		bytesRead            int
 	)
 
 	st := time.Now()
@@ -1013,7 +1012,7 @@ func awaitPendingRead(ctx context.Context, pool *pool, conn *connection) error {
 		// aliveness. In such cases, we don't want to close the connection.
 		bytesRead, err = peekConnectionAlive(conn)
 	} else {
-		bytesRead, err = attemptPendingRead(ctx, conn, remainingTime)
+		bytesRead, err = attemptPendingResponse(ctx, conn, remainingTime)
 	}
 
 	endTime := time.Now()
@@ -1029,13 +1028,12 @@ func awaitPendingRead(ctx context.Context, pool *pool, conn *connection) error {
 		// operations. This is likely a bug in the Go Driver. So it's possible that
 		// the connection is idle at the point of check-in.
 		defer func() {
-			publishPendingReadFailed(pool, conn, err)
+			publishPendingResponseFailed(pool, conn, err)
 
 			_ = pool.checkInNoEvent(conn)
 		}()
 
 		if netErr, ok := err.(net.Error); ok && !netErr.Timeout() {
-			fmt.Println(1)
 			if err := conn.close(); err != nil {
 				return err
 			}
@@ -1045,11 +1043,11 @@ func awaitPendingRead(ctx context.Context, pool *pool, conn *connection) error {
 
 	// If the read was successful, then we should refresh the remaining timeout.
 	if bytesRead > 0 {
-		pendingReadState.start = endTime
+		pendingResponseState.start = endTime
 	}
 
 	// If the remaining time has been exceeded, then close the connection.
-	if endTime.Sub(pendingReadState.start) > PendingReadTimeout {
+	if endTime.Sub(pendingResponseState.start) > PendingResponseTimeout {
 		if err := conn.close(); err != nil {
 			return err
 		}
@@ -1059,9 +1057,9 @@ func awaitPendingRead(ctx context.Context, pool *pool, conn *connection) error {
 		return err
 	}
 
-	publishPendingReadSucceeded(pool, conn, endDuration)
+	publishPendingResponseSucceeded(pool, conn, endDuration)
 
-	conn.pendingReadState = nil
+	conn.pendingResponseState = nil
 
 	return nil
 }