Merge pull request #12 from database-playground/pan93412/dbp-47-return-detailed-errors-when-querying-sql-in-backend

feat: return detailed error in SQL Runner

Author: pan93412

internal/sqlrunner/models.go

@@ -1,12 +1,7 @@
 package sqlrunner
 
-import "errors"
-
-var (
-	ErrQueryError    = errors.New("query error")
-	ErrSchemaError   = errors.New("schema error")
-	ErrBadPayload    = errors.New("payload is invalid")
-	ErrInternalError = errors.New("internal error")
+import (
+	"fmt"
 )
 
 // QueryRequest is the request to the SQL Runner API.
@@ -34,27 +29,19 @@ type DataResponse struct {
 	Rows    [][]string `json:"rows"`
 }
 
+const (
+	ErrorCodeQueryError    = "QUERY_ERROR"
+	ErrorCodeSchemaError   = "SCHEMA_ERROR"
+	ErrorCodeBadPayload    = "BAD_PAYLOAD"
+	ErrorCodeInternalError = "INTERNAL_ERROR"
+)
+
 // ErrorResponse is the error response from the SQL Runner API.
 type ErrorResponse struct {
 	Message string `json:"message"`
 	Code    string `json:"code"`
 }
 
-// ConvertHttpError converts the error response from
-// the SQL Runner API to a more specific error.
-func ConvertHttpError(errResp *ErrorResponse) error {
-	if errResp == nil {
-		return nil
-	}
-
-	switch errResp.Code {
-	case "QUERY_ERROR":
-		return ErrQueryError
-	case "SCHEMA_ERROR":
-		return ErrSchemaError
-	case "BAD_PAYLOAD":
-		return ErrBadPayload
-	default:
-		return ErrInternalError
-	}
+func (e ErrorResponse) Error() string {
+	return fmt.Sprintf("%s: %s", e.Code, e.Message)
 }

internal/sqlrunner/sqlrunner.go

@@ -56,7 +56,7 @@ func (s *SqlRunner) Query(ctx context.Context, schema, query string) (DataRespon
 
 	// check if success
 	if respBody.ErrorResponse != nil {
-		return DataResponse{}, ConvertHttpError(respBody.ErrorResponse)
+		return DataResponse{}, respBody.ErrorResponse
 	}
 
 	if respBody.SuccessResponse == nil {

internal/sqlrunner/sqlrunner_test.go

@@ -3,36 +3,21 @@ package sqlrunner_test
 import (
 	"context"
 	"errors"
-	"os"
 	"testing"
 
-	"github.com/database-playground/backend-v2/internal/config"
 	"github.com/database-playground/backend-v2/internal/sqlrunner"
+	"github.com/database-playground/backend-v2/internal/testhelper"
 )
 
-func newTestSqlRunner(t *testing.T) *sqlrunner.SqlRunner {
-	t.Helper()
-
-	baseUri := os.Getenv("SQLRUNNER_BASE_URI")
-	if baseUri == "" {
-		t.Skip("SQLRUNNER_BASE_URI is not set")
-	}
-
-	cfg := config.SqlRunnerConfig{
-		URI: baseUri,
-	}
-	return sqlrunner.NewSqlRunner(cfg)
-}
-
 func TestHealthz(t *testing.T) {
-	s := newTestSqlRunner(t)
+	s := testhelper.NewSQLRunnerClient(t)
 	if !s.IsHealthy(context.Background()) {
 		t.Error("Expected IsHealthy to return true, got false")
 	}
 }
 
 func TestQuery_Success(t *testing.T) {
-	s := newTestSqlRunner(t)
+	s := testhelper.NewSQLRunnerClient(t)
 	data, err := s.Query(context.Background(), "CREATE TABLE dev(ID int); INSERT INTO dev VALUES(1);", "SELECT * FROM dev;")
 	if err != nil {
 		t.Fatalf("Expected success, got error: %v", err)
@@ -46,23 +31,33 @@ func TestQuery_Success(t *testing.T) {
 }
 
 func TestQuery_QueryError(t *testing.T) {
-	s := newTestSqlRunner(t)
+	s := testhelper.NewSQLRunnerClient(t)
 	_, err := s.Query(context.Background(), "CREATE TABLE dev(ID int); INSERT INTO dev VALUES(1);", "SELECT * FROM non_existing_table;")
 	if err == nil || err.Error() == "" {
 		t.Error("Expected query error, got nil")
 	}
-	if !errors.Is(err, sqlrunner.ErrQueryError) {
-		t.Errorf("Expected QUERY_ERROR, got %v", err)
+
+	var errResp *sqlrunner.ErrorResponse
+	if !errors.As(err, &errResp) {
+		t.Errorf("Expected ErrorResponse, got %v", err)
+	}
+	if errResp.Code != sqlrunner.ErrorCodeQueryError {
+		t.Errorf("Expected QUERY_ERROR, got %v", errResp.Code)
 	}
 }
 
 func TestQuery_SchemaError(t *testing.T) {
-	s := newTestSqlRunner(t)
+	s := testhelper.NewSQLRunnerClient(t)
 	_, err := s.Query(context.Background(), "CREATE TABLE dev(ID int", "SELECT * FROM dev;")
 	if err == nil || err.Error() == "" {
 		t.Error("Expected schema error, got nil")
 	}
-	if !errors.Is(err, sqlrunner.ErrSchemaError) {
-		t.Errorf("Expected SCHEMA_ERROR, got %v", err)
+
+	var errResp *sqlrunner.ErrorResponse
+	if !errors.As(err, &errResp) {
+		t.Errorf("Expected ErrorResponse, got %v", err)
+	}
+	if errResp.Code != sqlrunner.ErrorCodeSchemaError {
+		t.Errorf("Expected SCHEMA_ERROR, got %v", errResp.Code)
 	}
 }

internal/submission/submission_test.go

@@ -155,7 +155,7 @@ func TestSubmitAnswer_Failed_UserQueryError(t *testing.T) {
 	require.Equal(t, submission.StatusFailed, result.Status)
 	require.Nil(t, result.QueryResult)
 	require.NotNil(t, result.Error)
-	require.Contains(t, *result.Error, "query error")
+	require.Contains(t, *result.Error, "QUERY_ERROR")
 }
 
 func TestSubmitAnswer_Failed_ReferenceQueryError(t *testing.T) {
@@ -471,7 +471,7 @@ func TestSubmitAnswer_EventAndSubmissionRecordGeneration(t *testing.T) {
 		require.Equal(t, "SELECT * FROM nonexistent_table;", failedSubmission.SubmittedCode)
 		require.Nil(t, failedSubmission.QueryResult) // Should be nil for failed queries
 		require.NotNil(t, failedSubmission.Error)
-		require.Contains(t, *failedSubmission.Error, "query error")
+		require.Contains(t, *failedSubmission.Error, "QUERY_ERROR")
 		require.NotZero(t, failedSubmission.SubmittedAt)
 
 		// Verify event count increased (should now have 2 events total)