Improve error information when query terminates in unexpected state. (#143)

When a query terminated in either an unknown or an unexpected operation
state the connection was creating a driver error with a static message.
Updated to include the operation state in the error message for an
unknown operation state situation.
Updated the case of an unexpected operation state to include the state
and the operation status display message.
Updated unit tests based on the new error message.
Signed-off-by: Raymond Cypher <[email protected]>

Author: rcypher-databricks

connection.go

@@ -200,7 +200,7 @@ func (c *conn) runQuery(ctx context.Context, query string, args []driver.NamedVa
 			cli_service.TOperationState_ERROR_STATE,
 			cli_service.TOperationState_TIMEDOUT_STATE:
 			logBadQueryState(log, opStatus)
-			return exStmtResp, opStatus, errors.New(opStatus.GetDisplayMessage())
+			return exStmtResp, opStatus, unexpectedOperationState(opStatus)
 		// live states
 		case cli_service.TOperationState_INITIALIZED_STATE,
 			cli_service.TOperationState_PENDING_STATE,
@@ -220,16 +220,16 @@ func (c *conn) runQuery(ctx context.Context, query string, args []driver.NamedVa
 				cli_service.TOperationState_ERROR_STATE,
 				cli_service.TOperationState_TIMEDOUT_STATE:
 				logBadQueryState(log, statusResp)
-				return exStmtResp, statusResp, dbsqlerrint.NewRequestError(ctx, dbsqlerr.ErrInvalidOperationState, nil)
+				return exStmtResp, statusResp, unexpectedOperationState(statusResp)
 				// live states
 			default:
 				logBadQueryState(log, statusResp)
-				return exStmtResp, statusResp, dbsqlerrint.NewDriverError(ctx, dbsqlerr.ErrInvalidOperationState, nil)
+				return exStmtResp, statusResp, invalidOperationState(ctx, statusResp)
 			}
 		// weird states
 		default:
 			logBadQueryState(log, opStatus)
-			return exStmtResp, opStatus, dbsqlerrint.NewDriverError(ctx, dbsqlerr.ErrInvalidOperationState, nil)
+			return exStmtResp, opStatus, invalidOperationState(ctx, opStatus)
 		}
 
 	} else {
@@ -248,18 +248,27 @@ func (c *conn) runQuery(ctx context.Context, query string, args []driver.NamedVa
 			cli_service.TOperationState_ERROR_STATE,
 			cli_service.TOperationState_TIMEDOUT_STATE:
 			logBadQueryState(log, statusResp)
-			return exStmtResp, statusResp, dbsqlerrint.NewDriverError(ctx, dbsqlerr.ErrInvalidOperationState, nil)
+			return exStmtResp, statusResp, unexpectedOperationState(statusResp)
 			// live states
 		default:
 			logBadQueryState(log, statusResp)
-			return exStmtResp, statusResp, dbsqlerrint.NewDriverError(ctx, dbsqlerr.ErrInvalidOperationState, nil)
+			return exStmtResp, statusResp, invalidOperationState(ctx, statusResp)
 		}
 	}
 }
 
 func logBadQueryState(log *logger.DBSQLLogger, opStatus *cli_service.TGetOperationStatusResp) {
 	log.Error().Msgf("databricks: query state: %s", opStatus.GetOperationState())
-	log.Error().Msg(opStatus.GetErrorMessage())
+	log.Error().Msg(opStatus.GetDisplayMessage())
+	log.Debug().Msg(opStatus.GetDiagnosticInfo())
+}
+
+func unexpectedOperationState(opStatus *cli_service.TGetOperationStatusResp) error {
+	return errors.WithMessage(errors.New(opStatus.GetDisplayMessage()), dbsqlerr.ErrUnexpectedOperationState(opStatus.GetOperationState().String()))
+}
+
+func invalidOperationState(ctx context.Context, opStatus *cli_service.TGetOperationStatusResp) error {
+	return dbsqlerrint.NewDriverError(ctx, dbsqlerr.ErrInvalidOperationState(opStatus.GetOperationState().String()), nil)
 }
 
 func (c *conn) executeStatement(ctx context.Context, query string, args []driver.NamedValue) (*cli_service.TExecuteStatementResp, error) {

connection_test.go

@@ -161,7 +161,7 @@ func TestConn_executeStatement(t *testing.T) {
 			if opTest.err == "" {
 				assert.NoError(t, err)
 			} else {
-				assert.EqualError(t, err, "databricks: execution error: failed to execute query: "+opTest.err)
+				assert.EqualError(t, err, "databricks: execution error: failed to execute query: unexpected operation state "+opTest.state.String()+": "+opTest.err)
 			}
 			assert.Equal(t, 1, executeStatementCount)
 			assert.Equal(t, opTest.closeOperationCount, closeOperationCount)

errors/errors.go

@@ -1,6 +1,7 @@
 package errors
 
 import (
+	"fmt"
 	"time"
 
 	"github.com/pkg/errors"
@@ -12,7 +13,6 @@ const (
 	ErrNotImplemented           = "not implemented"
 	ErrTransactionsNotSupported = "transactions are not supported"
 	ErrParametersNotSupported   = "query parameters are not supported"
-	ErrInvalidOperationState    = "invalid operation state. This should not have happened"
 	ErrReadQueryStatus          = "could not read query status"
 	ErrSentinelTimeout          = "sentinel timed out waiting for operation to complete"
 
@@ -33,6 +33,14 @@ const (
 	ErrQueryExecution = "failed to execute query"
 )
 
+func ErrInvalidOperationState(state string) string {
+	return fmt.Sprintf("invalid operation state %s. This should not have happened", state)
+}
+
+func ErrUnexpectedOperationState(state string) string {
+	return fmt.Sprintf("unexpected operation state %s", state)
+}
+
 // value to be used with errors.Is() to determine if an error chain contains a request error
 var RequestError error = errors.New("Request Error")