More unit tests and html coverage report

jc21 · jc21 · commit 9faa36315f06 · 2023-07-27T12:38:35.000+10:00
also fixes a limit bug on listquery
diff --git a/.gitignore b/.gitignore
@@ -8,6 +8,7 @@ bin/*
 backend/config.json
 backend/embed/assets
 backend/.task
+backend/coverage.html
 test/node_modules
 */node_modules
 docs/.vuepress/dist
diff --git a/backend/internal/api/middleware/auth.go b/backend/internal/api/middleware/auth.go
@@ -49,7 +49,7 @@ func Enforce(permission string) func(http.Handler) http.Handler {
 				}
 
 				userID := uint(claims["uid"].(float64))
-				_, enabled := user.IsEnabled(userID)
+				_, enabled, _ := user.IsEnabled(userID)
 				if token == nil || !enabled {
 					h.ResultErrorJSON(w, r, http.StatusUnauthorized, "Unauthorised", nil)
 					return
diff --git a/backend/internal/api/middleware/sse_auth.go b/backend/internal/api/middleware/sse_auth.go
@@ -32,7 +32,7 @@ func SSEAuth(next http.Handler) http.Handler {
 		}
 
 		userID := uint(claims["uid"].(float64))
-		_, enabled := user.IsEnabled(userID)
+		_, enabled, _ := user.IsEnabled(userID)
 		if token == nil || !enabled {
 			h.ResultErrorJSON(w, r, http.StatusUnauthorized, "Unauthorised", nil)
 			return
diff --git a/backend/internal/entity/accesslist/methods.go b/backend/internal/entity/accesslist/methods.go
@@ -30,8 +30,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/certificate/methods.go b/backend/internal/entity/certificate/methods.go
@@ -46,8 +46,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter, expand []string) (ent
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/certificateauthority/methods.go b/backend/internal/entity/certificateauthority/methods.go
@@ -30,8 +30,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/dnsprovider/methods.go b/backend/internal/entity/dnsprovider/methods.go
@@ -30,8 +30,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/host/methods.go b/backend/internal/entity/host/methods.go
@@ -32,8 +32,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter, expand []string) (ent
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/lists.go b/backend/internal/entity/lists.go
@@ -7,11 +7,6 @@ import (
 	"gorm.io/gorm"
 )
 
-// ListableModel is a interface for common use
-type ListableModel interface {
-	TableName() string
-}
-
 // ListResponse is the JSON response for users list
 type ListResponse struct {
 	Total  int64          `json:"total"`
@@ -29,7 +24,6 @@ func ListQueryBuilder(
 	filterMap map[string]model.FilterMapValue,
 ) *gorm.DB {
 	scopes := make([]func(*gorm.DB) *gorm.DB, 0)
-	scopes = append(scopes, ScopeOffsetLimit(pageInfo))
 	scopes = append(scopes, ScopeFilters(filters, filterMap))
 	return database.GetDB().Scopes(scopes...)
 }
@@ -38,8 +32,16 @@ func ListQueryBuilder(
 // Postgres in particular doesn't like count(*) when ordering at the same time
 func AddOrderToList(
 	dbo *gorm.DB,
-	pageInfo *model.PageInfo,
+	sort []model.Sort,
 	defaultSort model.Sort,
 ) *gorm.DB {
-	return dbo.Scopes(ScopeOrderBy(pageInfo, defaultSort))
+	return dbo.Scopes(ScopeOrderBy(sort, defaultSort))
+}
+
+// AddOffsetLimitToList is used after query above is used for pagination
+func AddOffsetLimitToList(
+	dbo *gorm.DB,
+	pageInfo *model.PageInfo,
+) *gorm.DB {
+	return dbo.Scopes(ScopeOffsetLimit(pageInfo))
 }
diff --git a/backend/internal/entity/nginxtemplate/methods.go b/backend/internal/entity/nginxtemplate/methods.go
@@ -30,8 +30,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/scopes.go b/backend/internal/entity/scopes.go
@@ -19,11 +19,11 @@ func ScopeOffsetLimit(pageInfo *model.PageInfo) func(db *gorm.DB) *gorm.DB {
 	}
 }
 
-func ScopeOrderBy(pageInfo *model.PageInfo, defaultSort model.Sort) func(db *gorm.DB) *gorm.DB {
+func ScopeOrderBy(sort []model.Sort, defaultSort model.Sort) func(db *gorm.DB) *gorm.DB {
 	return func(db *gorm.DB) *gorm.DB {
-		if pageInfo.Sort != nil {
+		if sort != nil {
 			// Sort by items in slice
-			return db.Order(sortToOrderString(pageInfo.Sort))
+			return db.Order(sortToOrderString(sort))
 		} else if defaultSort.Field != "" {
 			// Default to this sort
 			str := defaultSort.Field
diff --git a/backend/internal/entity/setting/methods.go b/backend/internal/entity/setting/methods.go
@@ -37,8 +37,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/stream/methods.go b/backend/internal/entity/stream/methods.go
@@ -30,8 +30,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/upstream/methods.go b/backend/internal/entity/upstream/methods.go
@@ -30,8 +30,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter, expand []string) (ent
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/upstreamserver/methods.go b/backend/internal/entity/upstreamserver/methods.go
@@ -39,8 +39,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,
 	}
 
 	// Get rows
+	dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)
+	dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)
 	items := make([]Model, 0)
-	if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {
+	if res := dbo.Find(&items); res.Error != nil {
 		return result, res.Error
 	}
 
diff --git a/backend/internal/entity/user/entity_test.go b/backend/internal/entity/user/entity_test.go
diff --git a/backend/internal/entity/user/methods.go b/backend/internal/entity/user/methods.go
diff --git a/backend/internal/entity/user/model_test.go b/backend/internal/entity/user/model_test.go
diff --git a/backend/scripts/test.sh b/backend/scripts/test.sh

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ func Enforce(permission string) func(http.Handler) http.Handler {`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`userID := uint(claims["uid"].(float64))`
`52`		`- _, enabled := user.IsEnabled(userID)`
	`52`	`+ _, enabled, _ := user.IsEnabled(userID)`
`53`	`53`	`if token == nil \|\| !enabled {`
`54`	`54`	`h.ResultErrorJSON(w, r, http.StatusUnauthorized, "Unauthorised", nil)`
`55`	`55`	`return`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ func SSEAuth(next http.Handler) http.Handler {`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`userID := uint(claims["uid"].(float64))`
`35`		`- _, enabled := user.IsEnabled(userID)`
	`35`	`+ _, enabled, _ := user.IsEnabled(userID)`
`36`	`36`	`if token == nil \|\| !enabled {`
`37`	`37`	`h.ResultErrorJSON(w, r, http.StatusUnauthorized, "Unauthorised", nil)`
`38`	`38`	`return`
Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter) (entity.ListResponse,`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`// Get rows`
	`33`	`+ dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)`
	`34`	`+ dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)`
`33`	`35`	`items := make([]Model, 0)`
`34`		`- if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {`
	`36`	`+ if res := dbo.Find(&items); res.Error != nil {`
`35`	`37`	`return result, res.Error`
`36`	`38`	`}`
`37`	`39`
Original file line number	Diff line number	Diff line change
`@@ -46,8 +46,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter, expand []string) (ent`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`// Get rows`
	`49`	`+ dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)`
	`50`	`+ dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)`
`49`	`51`	`items := make([]Model, 0)`
`50`		`- if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {`
	`52`	`+ if res := dbo.Find(&items); res.Error != nil {`
`51`	`53`	`return result, res.Error`
`52`	`54`	`}`
`53`	`55`
Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,10 @@ func List(pageInfo model.PageInfo, filters []model.Filter, expand []string) (ent`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`// Get rows`
	`35`	`+ dbo = entity.AddOffsetLimitToList(dbo, &pageInfo)`
	`36`	`+ dbo = entity.AddOrderToList(dbo, pageInfo.Sort, defaultSort)`
`35`	`37`	`items := make([]Model, 0)`
`36`		`- if res := entity.AddOrderToList(dbo, &pageInfo, defaultSort).Find(&items); res.Error != nil {`
	`38`	`+ if res := dbo.Find(&items); res.Error != nil {`
`37`	`39`	`return result, res.Error`
`38`	`40`	`}`
`39`	`41`