refactor: Abstracts rec storage

Author: NeedleInAJayStack

recController.go

@@ -6,35 +6,22 @@ import (
 	"net/http"
 
 	"github.com/google/uuid"
-	"gorm.io/datatypes"
-	"gorm.io/gorm"
 )
 
 type recController struct {
-	db *gorm.DB
+	store recStore
 }
 
 // GET /recs
 func (recController recController) getRecs(w http.ResponseWriter, r *http.Request) {
-	var sqlResult []rec
-	db := recController.db
-	tag := r.URL.Query().Get("tag")
-	if tag != "" {
-		db = db.Where(datatypes.JSONQuery("tags").HasKey(tag))
-	}
-	err := db.Order("dis").Find(&sqlResult).Error
+	recs, err := recController.store.readRecs(r.URL.Query().Get("tag"))
 	if err != nil {
 		log.Printf("SQL Error: %s", err)
 		w.WriteHeader(http.StatusInternalServerError)
 		return
 	}
 
-	httpResult := []apiRec{}
-	for _, sqlRow := range sqlResult {
-		httpResult = append(httpResult, apiRec(sqlRow))
-	}
-
-	httpJson, err := json.Marshal(httpResult)
+	httpJson, err := json.Marshal(recs)
 	if err != nil {
 		log.Printf("Cannot encode response JSON: %s", err)
 		w.WriteHeader(http.StatusBadRequest)
@@ -56,11 +43,9 @@ func (recController recController) postRecs(w http.ResponseWriter, r *http.Reque
 		return
 	}
 
-	rec := rec(apiRec)
-
-	err = recController.db.Create(&rec).Error
+	err = recController.store.createRec(apiRec)
 	if err != nil {
-		log.Printf("SQL Error: %s", err)
+		log.Printf("Storage Error: %s", err)
 		w.WriteHeader(http.StatusInternalServerError)
 		return
 	}
@@ -78,19 +63,13 @@ func (recController recController) postRecs(w http.ResponseWriter, r *http.Reque
 
 // GET /recs/tag/:tag
 func (recController recController) getRecsByTag(w http.ResponseWriter, r *http.Request) {
-	var recs []rec
-	err := recController.db.Where(datatypes.JSONQuery("tags").HasKey("siteMeter")).Order("dis").Find(&recs).Error
+	apiRecs, err := recController.store.readRecs("siteMeter")
 	if err != nil {
-		log.Printf("SQL Error: %s", err)
+		log.Printf("Storage Error: %s", err)
 		w.WriteHeader(http.StatusInternalServerError)
 		return
 	}
 
-	apiRecs := []apiRec{}
-	for _, rec := range recs {
-		apiRecs = append(apiRecs, apiRec(rec))
-	}
-
 	httpJson, err := json.Marshal(apiRecs)
 	if err != nil {
 		log.Printf("Cannot encode response JSON")
@@ -111,16 +90,13 @@ func (recController recController) getRec(w http.ResponseWriter, r *http.Request
 		w.WriteHeader(http.StatusNotFound)
 		return
 	}
-	var rec rec
-	err = recController.db.First(&rec, "id = ?", id).Error
+	apiRec, err := recController.store.readRec(id)
 	if err != nil {
-		log.Printf("SQL Error: %s", err)
+		log.Printf("Storage Error: %s", err)
 		w.WriteHeader(http.StatusInternalServerError)
 		return
 	}
 
-	apiRec := apiRec(rec)
-
 	httpJson, err := json.Marshal(apiRec)
 	if err != nil {
 		log.Printf("Cannot encode response JSON")
@@ -150,25 +126,9 @@ func (recController recController) putRec(w http.ResponseWriter, r *http.Request
 		w.WriteHeader(http.StatusBadRequest)
 		return
 	}
-
-	var rec rec
-	err = recController.db.First(&rec, id).Error
-	if err != nil {
-		log.Printf("No rec with ID: %s", id)
-		w.WriteHeader(http.StatusBadRequest)
-		return
-	}
-
-	if apiRec.Dis != nil {
-		rec.Dis = apiRec.Dis
-	}
-	if apiRec.Unit != nil {
-		rec.Unit = apiRec.Unit
-	}
-
-	err = recController.db.Save(&rec).Error
+	err = recController.store.updateRec(id, apiRec)
 	if err != nil {
-		log.Printf("Unable to update: %s", err)
+		log.Printf("Storage Error: %s", id)
 		w.WriteHeader(http.StatusBadRequest)
 		return
 	}
@@ -186,7 +146,7 @@ func (recController recController) deleteRec(w http.ResponseWriter, r *http.Requ
 		return
 	}
 
-	err = recController.db.Delete(&rec{}, id).Error
+	err = recController.store.deleteRec(id)
 	if err != nil {
 		log.Printf("Unable to delete: %s", err)
 		w.WriteHeader(http.StatusBadRequest)

recStore.go

@@ -0,0 +1,87 @@
+package main
+
+import (
+	"github.com/google/uuid"
+	"gorm.io/datatypes"
+	"gorm.io/gorm"
+)
+
+type recStore interface {
+	readRecs(string) ([]apiRec, error)
+	readRec(uuid.UUID) (*apiRec, error)
+	createRec(apiRec) error
+	updateRec(uuid.UUID, apiRec) error
+	deleteRec(uuid.UUID) error
+}
+
+// gormHistoryStore stores point historical values in a GORM database.
+type gormRecStore struct {
+	db *gorm.DB
+}
+
+func newGormRecStore(db *gorm.DB) gormRecStore {
+	return gormRecStore{db: db}
+}
+
+func (s gormRecStore) readRecs(
+	tag string,
+) ([]apiRec, error) {
+	var sqlResult []rec
+	db := s.db
+	if tag != "" {
+		db = db.Where(datatypes.JSONQuery("tags").HasKey(tag))
+	}
+	err := db.Order("dis").Find(&sqlResult).Error
+	if err != nil {
+		return []apiRec{}, err
+	}
+
+	result := []apiRec{}
+	for _, sqlRow := range sqlResult {
+		result = append(result, apiRec(sqlRow))
+	}
+	return result, nil
+}
+
+func (s gormRecStore) readRec(
+	id uuid.UUID,
+) (*apiRec, error) {
+	var rec rec
+	err := s.db.First(&rec, "id = ?", id).Error
+	if err != nil {
+		return nil, err
+	}
+	apiRec := apiRec(rec)
+	return &apiRec, nil
+}
+
+func (s gormRecStore) createRec(
+	apiRec apiRec,
+) error {
+	rec := rec(apiRec)
+	return s.db.Create(&rec).Error
+}
+
+func (s gormRecStore) updateRec(
+	id uuid.UUID,
+	apiRec apiRec,
+) error {
+	var rec rec
+	err := s.db.First(&rec, id).Error
+	if err != nil {
+		return err
+	}
+
+	if apiRec.Dis != nil {
+		rec.Dis = apiRec.Dis
+	}
+	if apiRec.Unit != nil {
+		rec.Unit = apiRec.Unit
+	}
+
+	return s.db.Save(&rec).Error
+}
+
+func (s gormRecStore) deleteRec(id uuid.UUID) error {
+	return s.db.Delete(&rec{}, id).Error
+}

server.go

@@ -45,7 +45,7 @@ func NewServer(serverConfig ServerConfig) (*http.ServeMux, error) {
 	tokenAuth.HandleFunc("DELETE /his/{pointId}", hisController.deleteHis) // Deprecated
 	server.Handle("/his/", tokenAuthMiddleware(serverConfig.jwtSecret, tokenAuth))
 
-	recController := recController{db: serverConfig.db}
+	recController := recController{store: newGormRecStore(serverConfig.db)}
 	tokenAuth.HandleFunc("GET /recs", recController.getRecs)
 	tokenAuth.HandleFunc("POST /recs", recController.postRecs)
 	server.Handle("/recs", tokenAuthMiddleware(serverConfig.jwtSecret, tokenAuth))