clean up TODOs

Author: xiazcy

gremlin-go/driver/auth.go

@@ -56,7 +56,10 @@ func Sigv4AuthWithCredentials(region, service string, credentialsProvider aws.Cr
 		}
 
 		signer := v4.NewSigner()
-		stdReq := req.ToStdRequest()
+		stdReq, err := req.ToStdRequest()
+		if err != nil {
+			return err
+		}
 		stdReq.Body = nil // Body is handled separately via payload hash
 
 		if err := signer.SignHTTP(ctx, creds, stdReq, req.PayloadHash(), service, region, time.Now()); err != nil {

gremlin-go/driver/client.go

@@ -112,8 +112,10 @@ func NewClient(url string, configurations ...func(settings *ClientSettings)) (*C
 // Close closes the client via connection.
 // This is idempotent due to the underlying close() methods being idempotent as well.
 func (client *Client) Close() {
-	// TODO check what needs to be closed
 	client.logHandler.logf(Info, closeClient, client.url)
+	if client.protocol != nil {
+		client.protocol.close()
+	}
 }
 
 func (client *Client) errorCallback() {
@@ -124,9 +126,6 @@ func (client *Client) errorCallback() {
 func (client *Client) SubmitWithOptions(traversalString string, requestOptions RequestOptions) (ResultSet, error) {
 	client.logHandler.logf(Debug, submitStartedString, traversalString)
 	request := MakeStringRequest(traversalString, client.traversalSource, requestOptions)
-
-	// TODO interceptors (ie. auth)
-
 	rs, err := client.protocol.send(&request)
 	return rs, err
 }
@@ -143,10 +142,8 @@ func (client *Client) Submit(traversalString string, bindings ...map[string]inte
 }
 
 // submitGremlinLang submits GremlinLang to the server to execute and returns a ResultSet.
-// TODO test and update when connection is set up
 func (client *Client) submitGremlinLang(gremlinLang *GremlinLang) (ResultSet, error) {
 	client.logHandler.logf(Debug, submitStartedString, *gremlinLang)
-	// TODO placeholder
 	requestOptionsBuilder := new(RequestOptionsBuilder)
 	if len(gremlinLang.GetParameters()) > 0 {
 		requestOptionsBuilder.SetBindings(gremlinLang.GetParameters())

gremlin-go/driver/driverRemoteConnection.go

@@ -125,7 +125,6 @@ func (driver *DriverRemoteConnection) Submit(traversalString string) (ResultSet,
 }
 
 // submitGremlinLang sends a GremlinLang traversal to the server.
-// TODO test and update when connection is set up
 func (driver *DriverRemoteConnection) submitGremlinLang(gremlinLang *GremlinLang) (ResultSet, error) {
 	if driver.isClosed {
 		return nil, newError(err0203SubmitGremlinLangToClosedConnectionError)

gremlin-go/driver/gremlinlang.go

@@ -567,17 +567,3 @@ func (gl *GremlinLang) convertArgument(arg interface{}) (interface{}, error) {
 		}
 	}
 }
-
-// TODO revisit and remove if necessary
-//var withOptionsMap map[any]string = map[any]string{
-//	WithOptions.Tokens:  "WithOptions.tokens",
-//	WithOptions.None:    "WithOptions.none",
-//	WithOptions.Ids:     "WithOptions.ids",
-//	WithOptions.Labels:  "WithOptions.labels",
-//	WithOptions.Keys:    "WithOptions.keys",
-//	WithOptions.Values:  "WithOptions.values",
-//	WithOptions.All:     "WithOptions.all",
-//	WithOptions.Indexer: "WithOptions.indexer",
-//	WithOptions.List:    "WithOptions.list",
-//	WithOptions.Map:     "WithOptions.map",
-//}

gremlin-go/driver/httpConnection.go

@@ -62,10 +62,14 @@ func NewHttpRequest(method, rawURL string) (*HttpRequest, error) {
 }
 
 // ToStdRequest converts HttpRequest to a standard http.Request for signing.
-func (r *HttpRequest) ToStdRequest() *http.Request {
-	req, _ := http.NewRequest(r.Method, r.URL.String(), bytes.NewReader(r.Body))
+// Returns nil if the request cannot be created (invalid method or URL).
+func (r *HttpRequest) ToStdRequest() (*http.Request, error) {
+	req, err := http.NewRequest(r.Method, r.URL.String(), bytes.NewReader(r.Body))
+	if err != nil {
+		return nil, err
+	}
 	req.Header = r.Headers
-	return req
+	return req, nil
 }
 
 // PayloadHash returns the SHA256 hash of the request body for SigV4 signing.
@@ -184,7 +188,11 @@ func (c *httpConnection) executeAndStream(data []byte, rs ResultSet) {
 		rs.setError(err)
 		return
 	}
-	defer resp.Body.Close()
+	defer func() {
+		if err := resp.Body.Close(); err != nil {
+			c.logHandler.logf(Debug, failedToCloseResponseBody, err.Error())
+		}
+	}()
 
 	reader, zlibReader, err := c.getReader(resp)
 	if err != nil {
@@ -193,7 +201,11 @@ func (c *httpConnection) executeAndStream(data []byte, rs ResultSet) {
 		return
 	}
 	if zlibReader != nil {
-		defer zlibReader.Close()
+		defer func() {
+			if err := zlibReader.Close(); err != nil {
+				c.logHandler.logf(Debug, failedToCloseDecompReader, err.Error())
+			}
+		}()
 	}
 
 	c.streamToResultSet(reader, rs)
@@ -224,8 +236,8 @@ func (c *httpConnection) getReader(resp *http.Response) (io.Reader, io.Closer, e
 }
 
 func (c *httpConnection) streamToResultSet(reader io.Reader, rs ResultSet) {
-	d := newStreamingDeserializer(reader)
-	if err := d.readHeader(); err != nil {
+	d := NewStreamingDeserializer(reader)
+	if err := d.ReadHeader(); err != nil {
 		if err != io.EOF {
 			c.logHandler.logf(Error, failedToReceiveResponse, err.Error())
 			rs.setError(err)
@@ -234,7 +246,7 @@ func (c *httpConnection) streamToResultSet(reader io.Reader, rs ResultSet) {
 	}
 
 	for {
-		obj, err := d.readFullyQualified()
+		obj, err := d.ReadFullyQualified()
 		if err != nil {
 			if err != io.EOF {
 				c.logHandler.logf(Error, failedToReceiveResponse, err.Error())
@@ -244,7 +256,7 @@ func (c *httpConnection) streamToResultSet(reader io.Reader, rs ResultSet) {
 		}
 
 		if marker, ok := obj.(Marker); ok && marker == EndOfStream() {
-			code, msg, _, err := d.readStatus()
+			code, msg, _, err := d.ReadStatus()
 			if err != nil {
 				c.logHandler.logf(Error, failedToReceiveResponse, err.Error())
 				rs.setError(err)

gremlin-go/driver/logger.go

@@ -114,4 +114,6 @@ const (
 	logErrorGeneric              errorKey = "LOG_ERROR_GENERIC"
 	closeDriverRemoteConnection  errorKey = "CLOSE_DRIVER_REMOTE_CONNECTION"
 	closeClient                  errorKey = "CLOSE_CLIENT"
+	failedToCloseResponseBody    errorKey = "FAILED_TO_CLOSE_RESPONSE_BODY"
+	failedToCloseDecompReader    errorKey = "FAILED_TO_CLOSE_DECOMPRESSION_READER"
 )

gremlin-go/driver/resources/logger-messages/en.json

@@ -20,5 +20,7 @@
   "POOL_NEW_CONNECTION_ERROR": "Falling back to least-used connection. Creating new connection due to least-used connection exceeding concurrent usage threshold failed: %s",
   "POOL_INITIAL_EXCEEDS_MAXIMUM": "InitialConcurrentConnections setting %d exceeded MaximumConcurrentConnections setting %d - limiting InitialConcurrentConnections to %d.",
   "FAILED_TO_RECEIVE_RESPONSE": "Failed to receive response: %s",
-  "FAILED_TO_SEND_REQUEST": "Failed to send request: %s"
+  "FAILED_TO_SEND_REQUEST": "Failed to send request: %s",
+  "FAILED_TO_CLOSE_RESPONSE_BODY": "Error closing response body: %s",
+  "FAILED_TO_CLOSE_DECOMPRESSION_READER": "Error closing decompression reader: %s"
 }

gremlin-go/driver/serializer.go

@@ -149,26 +149,20 @@ func (gs *GraphBinarySerializer) DeserializeMessage(message []byte) (Response, e
 
 	//Skip version and nullable byte.
 	i := 2
-	// TODO temp serialization before fully streaming set-up
 	for len(message) > 0 {
 		n, err := readFullyQualifiedNullable(&message, &i, true)
 		if err != nil {
 			return msg, err
 		}
-		// TODO for debug, remove later
-		//_, _ = fmt.Fprintf(os.Stdout, "Deserializing data : %v\n", n)
 		if n == EndOfStream() {
 			break
 		}
 		results = append(results, n)
 	}
 
-	// TODO for debug, remove later
-	//_, _ = fmt.Fprintf(os.Stdout, "Deserialized results : %s\n", results)
 	msg.ResponseResult.Data = results
 	code := readUint32Safe(&message, &i)
 	msg.ResponseStatus.code = code
-	// TODO read status message
 	msg.ResponseStatus.message = "OK"
 	statusMsg, err := readUnqualified(&message, &i, stringType, true)
 	if err != nil {