Better errors

Author: joelseq

errors.go

@@ -0,0 +1,34 @@
+package sqliteadmin
+
+import (
+	"errors"
+	"fmt"
+)
+
+var (
+	ErrMissingTableName    = errors.New("missing table name")
+	ErrMissingRow          = errors.New("missing row")
+	ErrInvalidOrMissingIds = errors.New("invalid or missing ids")
+	ErrInvalidInput        = errors.New("invalid input")
+)
+
+type ApiError struct {
+	StatusCode int    `json:"statusCode"`
+	Message    string `json:"message"`
+}
+
+func (e ApiError) Error() string {
+	return fmt.Sprintf("api error: %d,  %s", e.StatusCode, e.Message)
+}
+
+func apiErrUnauthorized() ApiError {
+	return ApiError{StatusCode: 401, Message: "Invalid credentials"}
+}
+
+func apiErrBadRequest(details string) ApiError {
+	return ApiError{StatusCode: 400, Message: "Bad request: " + details}
+}
+
+func apiErrSomethingWentWrong() ApiError {
+	return ApiError{StatusCode: 500, Message: "Something went wrong"}
+}

queryhandlers.go

@@ -41,7 +41,7 @@ func (h *Handler) getTable(w http.ResponseWriter, params map[string]interface{})
 	// Parse table name
 	table, ok := params["tableName"].(string)
 	if !ok {
-		writeError(w, fmt.Errorf("Missing table name"), http.StatusBadRequest)
+		writeError(w, apiErrBadRequest(ErrMissingTableName.Error()))
 		return
 	}
 
@@ -82,7 +82,7 @@ func (h *Handler) getTable(w http.ResponseWriter, params map[string]interface{})
 	if err != nil {
 		// TODO: use better logging
 		fmt.Printf("Error querying table: %v\n", err)
-		writeError(w, fmt.Errorf("Something went wrong"), http.StatusInternalServerError)
+		writeError(w, apiErrSomethingWentWrong())
 		return
 	}
 	response := map[string]interface{}{"rows": data}
@@ -92,7 +92,7 @@ func (h *Handler) getTable(w http.ResponseWriter, params map[string]interface{})
 		if err != nil {
 			// TODO: use better logging
 			fmt.Printf("Error getting table info: %v\n", err)
-			writeError(w, fmt.Errorf("Something went wrong"), http.StatusInternalServerError)
+			writeError(w, apiErrSomethingWentWrong())
 			return
 		}
 		response["tableInfo"] = tableInfo
@@ -104,35 +104,35 @@ func (h *Handler) getTable(w http.ResponseWriter, params map[string]interface{})
 func (h *Handler) deleteRows(w http.ResponseWriter, params map[string]interface{}) {
 	table, ok := params["tableName"].(string)
 	if !ok {
-		writeError(w, fmt.Errorf("Missing table name"), http.StatusBadRequest)
+		writeError(w, apiErrBadRequest(ErrMissingTableName.Error()))
 		return
 	}
 
 	ids, ok := convertToStrSlice(params["ids"])
 	if !ok {
-		writeError(w, fmt.Errorf("Invalid or missing ids"), http.StatusBadRequest)
+		writeError(w, apiErrBadRequest(ErrInvalidOrMissingIds.Error()))
 		return
 	}
 
 	exists, err := checkTableExists(h.db, table)
 	if err != nil {
 		// TODO: use better logging
 		fmt.Printf("Error checking table existence: %v\n", err)
-		writeError(w, fmt.Errorf("Bad Request"), http.StatusBadRequest)
+		writeError(w, apiErrSomethingWentWrong())
 		return
 	}
 	if !exists {
 		// TODO: use better logging
 		fmt.Printf("Error table does not exist: %s\n", table)
-		writeError(w, fmt.Errorf("Bad Request"), http.StatusBadRequest)
+		writeError(w, apiErrBadRequest(ErrInvalidInput.Error()))
 		return
 	}
 
 	rowsAffected, err := batchDelete(h.db, table, ids)
 	if err != nil {
 		// TODO: use better logging
 		fmt.Printf("Error deleting rows from table: %v\n", err)
-		writeError(w, fmt.Errorf("Something went wrong"), http.StatusInternalServerError)
+		writeError(w, apiErrSomethingWentWrong())
 		return
 	}
 
@@ -142,19 +142,21 @@ func (h *Handler) deleteRows(w http.ResponseWriter, params map[string]interface{
 func (h *Handler) updateRow(w http.ResponseWriter, params map[string]interface{}) {
 	table, ok := params["tableName"].(string)
 	if !ok {
-		writeError(w, fmt.Errorf("Missing table name"), http.StatusBadRequest)
+		writeError(w, apiErrBadRequest(ErrMissingTableName.Error()))
 		return
 	}
 
 	row, ok := params["row"].(map[string]interface{})
 	if !ok {
-		writeError(w, fmt.Errorf("Missing row"), http.StatusBadRequest)
+		writeError(w, apiErrBadRequest(ErrMissingRow.Error()))
 		return
 	}
 
 	err := editRow(h.db, table, row)
 	if err != nil {
-		writeError(w, fmt.Errorf("Failed to update row"), http.StatusInternalServerError)
+		// TODO: use better logging
+		fmt.Printf("Error editing row: %v\n", err)
+		writeError(w, apiErrSomethingWentWrong())
 		return
 	}
 
@@ -478,9 +480,9 @@ func editRow(db *sql.DB, tableName string, row map[string]interface{}) error {
 	return nil
 }
 
-func writeError(w http.ResponseWriter, err error, status int) {
-	w.WriteHeader(status)
-	json.NewEncoder(w).Encode(map[string]string{"error": err.Error()})
+func writeError(w http.ResponseWriter, err ApiError) {
+	w.WriteHeader(err.StatusCode)
+	json.NewEncoder(w).Encode(err)
 }
 
 func convertToStrSlice(val interface{}) ([]any, bool) {

sqliteadmin.go

@@ -94,7 +94,7 @@ func (h *Handler) Handle(w http.ResponseWriter, r *http.Request) {
 	if h.username != "" && h.password != "" {
 		authHeader := r.Header.Get("Authorization")
 		if h.username+":"+h.password != authHeader {
-			w.WriteHeader(http.StatusUnauthorized)
+			writeError(w, apiErrUnauthorized())
 			return
 		}
 	}