feat: optimize variable set and variable apis

api/openapispec/docs.go

@@ -3391,8 +3391,8 @@ const docTemplate = `{
                     },
                     {
                         "type": "boolean",
-                        "description": "Whether to sort the list in ascending order. Default to false",
-                        "name": "ascending",
+                        "description": "Whether to sort the list in descending order. Default to false",
+                        "name": "descending",
                         "in": "query"
                     },
                     {
@@ -3762,8 +3762,8 @@ const docTemplate = `{
                     },
                     {
                         "type": "boolean",
-                        "description": "Whether to sort the list in ascending order. Default to false",
-                        "name": "ascending",
+                        "description": "Whether to sort the list in descending order. Default to false",
+                        "name": "descending",
                         "in": "query"
                     },
                     {
@@ -4763,18 +4763,18 @@ const docTemplate = `{
         "constant.SourceProviderType": {
             "type": "string",
             "enum": [
-                "git",
                 "git",
                 "github",
                 "oci",
-                "local"
+                "local",
+                "git"
             ],
             "x-enum-varnames": [
-                "DefaultSourceType",
                 "SourceProviderTypeGit",
                 "SourceProviderTypeGithub",
                 "SourceProviderTypeOCI",
-                "SourceProviderTypeLocal"
+                "SourceProviderTypeLocal",
+                "DefaultSourceType"
             ]
         },
         "constant.StackState": {

api/openapispec/swagger.json

@@ -3380,8 +3380,8 @@
                     },
                     {
                         "type": "boolean",
-                        "description": "Whether to sort the list in ascending order. Default to false",
-                        "name": "ascending",
+                        "description": "Whether to sort the list in descending order. Default to false",
+                        "name": "descending",
                         "in": "query"
                     },
                     {
@@ -3751,8 +3751,8 @@
                     },
                     {
                         "type": "boolean",
-                        "description": "Whether to sort the list in ascending order. Default to false",
-                        "name": "ascending",
+                        "description": "Whether to sort the list in descending order. Default to false",
+                        "name": "descending",
                         "in": "query"
                     },
                     {
@@ -4752,18 +4752,18 @@
         "constant.SourceProviderType": {
             "type": "string",
             "enum": [
-                "git",
                 "git",
                 "github",
                 "oci",
-                "local"
+                "local",
+                "git"
             ],
             "x-enum-varnames": [
-                "DefaultSourceType",
                 "SourceProviderTypeGit",
                 "SourceProviderTypeGithub",
                 "SourceProviderTypeOCI",
-                "SourceProviderTypeLocal"
+                "SourceProviderTypeLocal",
+                "DefaultSourceType"
             ]
         },
         "constant.StackState": {

api/openapispec/swagger.yaml

@@ -30,17 +30,17 @@ definitions:
   constant.SourceProviderType:
     enum:
     - git
-    - git
     - github
     - oci
     - local
+    - git
     type: string
     x-enum-varnames:
-    - DefaultSourceType
     - SourceProviderTypeGit
     - SourceProviderTypeGithub
     - SourceProviderTypeOCI
     - SourceProviderTypeLocal
+    - DefaultSourceType
   constant.StackState:
     enum:
     - UnSynced
@@ -3754,9 +3754,9 @@ paths:
         in: query
         name: sortBy
         type: string
-      - description: Whether to sort the list in ascending order. Default to false
+      - description: Whether to sort the list in descending order. Default to false
         in: query
-        name: ascending
+        name: descending
         type: boolean
       - description: Whether to list all the variables
         in: query
@@ -3999,9 +3999,9 @@ paths:
         in: query
         name: sortBy
         type: string
-      - description: Whether to sort the list in ascending order. Default to false
+      - description: Whether to sort the list in descending order. Default to false
         in: query
-        name: ascending
+        name: descending
         type: boolean
       - description: Whether to list all the variable sets
         in: query

pkg/domain/constant/global.go

@@ -27,7 +27,7 @@ const (
 	ResourcePageSizeLarge   = 1000
 	CommonPageDefault       = 1
 	CommonPageSizeDefault   = 10
-	CommonMaxResultLimit    = 1000
+	CommonMaxResultLimit    = 10000
 	SortByCreateTimestamp   = "createTimestamp"
 	SortByModifiedTimestamp = "modifiedTimestamp"
 	SortByName              = "name"

pkg/domain/entity/types.go

@@ -6,6 +6,7 @@ type Pagination struct {
 }
 
 type SortOptions struct {
-	Field     string
-	Ascending bool
+	Field      string
+	Ascending  bool
+	Descending bool
 }

pkg/infra/persistence/util.go

@@ -249,7 +249,7 @@ func GetVariableQuery(filter *entity.VariableFilter) (string, []interface{}) {
 		args = append(args, filter.Name)
 	}
 	if filter.VariableSet != "" {
-		pattern = append(pattern, "variable.variable_set LIKE ?")
+		pattern = append(pattern, "variable.variable_set = ?")
 		args = append(args, filter.VariableSet)
 	}
 	return CombineQueryParts(pattern), args

pkg/infra/persistence/variable.go

@@ -105,7 +105,7 @@ func (v *variableRepository) List(ctx context.Context,
 	pattern, args := GetVariableQuery(filter)
 
 	sortArgs := sortOptions.Field
-	if !sortOptions.Ascending {
+	if sortOptions.Descending {
 		sortArgs += " DESC"
 	}
 

pkg/infra/persistence/variable_set.go

@@ -104,7 +104,7 @@ func (vs *variableSetRepository) List(ctx context.Context,
 	pattern, args := GetVariableSetQuery(filter)
 
 	sortArgs := sortOptions.Field
-	if !sortOptions.Ascending {
+	if sortOptions.Descending {
 		sortArgs += " DESC"
 	}
 

pkg/server/handler/render.go

@@ -18,11 +18,21 @@ func GenerateResponse(ctx context.Context, data any, err error) render.Renderer
 	// Set the Success and Message fields based on the error parameter.
 	if err == nil {
 		resp.Success = true
-		resp.Message = SuccessMessage
+		// Get the response message from the context.
+		if rspMsg := appmiddleware.GetResponseMessage(ctx); rspMsg != "" {
+			resp.Message = rspMsg
+		} else {
+			resp.Message = SuccessMessage
+		}
 		resp.Data = data
 	} else {
 		resp.Success = false
-		resp.Message = err.Error()
+		// Get the response message from the context.
+		if rspMsg := appmiddleware.GetResponseMessage(ctx); rspMsg != "" {
+			resp.Message = rspMsg
+		} else {
+			resp.Message = err.Error()
+		}
 	}
 
 	// Include the request trace ID if available.

pkg/server/handler/variable/handler.go

@@ -13,6 +13,7 @@ import (
 	"kusionstack.io/kusion/pkg/server/handler"
 	"kusionstack.io/kusion/pkg/server/manager/variable"
 	"kusionstack.io/kusion/pkg/server/manager/variableset"
+	"kusionstack.io/kusion/pkg/server/middleware"
 	logutil "kusionstack.io/kusion/pkg/server/util/logging"
 )
 
@@ -100,7 +101,7 @@ func (h *Handler) DeleteVariable() http.HandlerFunc {
 // @Failure		429													{object}	error									"Too Many Requests"
 // @Failure		404													{object}	error									"Not Found"
 // @Failure		500													{object}	error									"Internal Server Error"
-// @Router			/api/v1/variables/{variableSetName}/{variableName} 																																																																																																																																																																																																																																														[put]
+// @Router			/api/v1/variables/{variableSetName}/{variableName} 																																																																																																																																																																																																																																																									[put]
 func (h *Handler) UpdateVariable() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// Getting stuff from context.
@@ -154,7 +155,7 @@ func (h *Handler) UpdateVariable() http.HandlerFunc {
 // @Failure		429													{object}	error									"Too Many Requests"
 // @Failure		404													{object}	error									"Not Found"
 // @Failure		500													{object}	error									"Internal Server Error"
-// @Router			/api/v1/variables/{variableSetName}/{variableName} 																																																																																																																																																																																																																												[get]
+// @Router			/api/v1/variables/{variableSetName}/{variableName} 																																																																																																																																																																																																																																							[get]
 func (h *Handler) GetVariable() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// Getting stuff from context.
@@ -181,7 +182,7 @@ func (h *Handler) GetVariable() http.HandlerFunc {
 // @Param			page			query		uint														false	"The current page to fetch. Default to 1"
 // @Param			pageSize		query		uint														false	"The size of the page. Default to 10"
 // @Param			sortBy			query		string														false	"Which field to sort the list by. Default to id"
-// @Param			ascending		query		bool														false	"Whether to sort the list in ascending order. Default to false"
+// @Param			descending		query		bool														false	"Whether to sort the list in descending order. Default to false"
 // @Param			fetchAll		query		bool														false	"Whether to list all the variables"
 // @Success		200				{object}	handler.Response{data=response.PaginatedVariableResponse}	"Success"
 // @Failure		400				{object}	error														"Bad Request"
@@ -213,6 +214,12 @@ func (h *Handler) ListVariables() http.HandlerFunc {
 			return
 		}
 
+		// If the amount of variable sets exceeds the maximum result limit,
+		// then indicate in the response message.
+		if len(variableEntities.Variables) < variableEntities.Total {
+			ctx = context.WithValue(ctx, middleware.ResponseMessageKey, "the result exceeds the maximum amount limit")
+		}
+
 		paginatedResponse := response.PaginatedVariableResponse{
 			Variables:   variableEntities.Variables,
 			Total:       variableEntities.Total,

pkg/server/handler/variableset/handler.go

@@ -15,6 +15,7 @@ import (
 	"kusionstack.io/kusion/pkg/domain/response"
 	"kusionstack.io/kusion/pkg/server/handler"
 	"kusionstack.io/kusion/pkg/server/manager/variableset"
+	"kusionstack.io/kusion/pkg/server/middleware"
 	logutil "kusionstack.io/kusion/pkg/server/util/logging"
 )
 
@@ -100,7 +101,7 @@ func (h *Handler) DeleteVariableSet() http.HandlerFunc {
 // @Failure		429										{object}	error										"Too Many Requests"
 // @Failure		404										{object}	error										"Not Found"
 // @Failure		500										{object}	error										"Internal Server Error"
-// @Router			/api/v1/variablesets/{variableSetName} 																																																																																																																																																																																																																																															[put]
+// @Router			/api/v1/variablesets/{variableSetName} 																																																																																																																																																																																																																																																											[put]
 func (h *Handler) UpdateVariableSet() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// Getting stuff from context.
@@ -147,7 +148,7 @@ func (h *Handler) UpdateVariableSet() http.HandlerFunc {
 // @Failure		429										{object}	error										"Too Many Requests"
 // @Failure		404										{object}	error										"Not Found"
 // @Failure		500										{object}	error										"Internal Server Error"
-// @Router			/api/v1/variablesets/{variableSetName} 																																																																																																																																																																																																																													[get]
+// @Router			/api/v1/variablesets/{variableSetName} 																																																																																																																																																																																																																																									[get]
 func (h *Handler) GetVariableSet() http.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) {
 		// Getting stuff from context.
@@ -172,7 +173,7 @@ func (h *Handler) GetVariableSet() http.HandlerFunc {
 // @Param			page			query		uint															false	"The current page to fetch. Default to 1"
 // @Param			pageSize		query		uint															false	"The size of the page. Default to 10"
 // @Param			sortBy			query		string															false	"Which field to sort the list by. Default to id"
-// @Param			ascending		query		bool															false	"Whether to sort the list in ascending order. Default to false"
+// @Param			descending		query		bool															false	"Whether to sort the list in descending order. Default to false"
 // @Param			fetchAll		query		bool															false	"Whether to list all the variable sets"
 // @Success		200				{object}	handler.Response{data=response.PaginatedVariableSetResponse}	"Success"
 // @Failure		400				{object}	error															"Bad Request"
@@ -204,6 +205,12 @@ func (h *Handler) ListVariableSets() http.HandlerFunc {
 			return
 		}
 
+		// If the amount of variable sets exceeds the maximum result limit,
+		// then indicate in the response message.
+		if len(variableSetEntities.VariableSets) < variableSetEntities.Total {
+			ctx = context.WithValue(ctx, middleware.ResponseMessageKey, "the result exceeds the maximum amount limit")
+		}
+
 		paginatedResponse := response.PaginatedVariableSetResponse{
 			VariableSets: variableSetEntities.VariableSets,
 			Total:        variableSetEntities.Total,
@@ -247,13 +254,13 @@ func (h *Handler) ListVariableSetsByLabels() http.HandlerFunc {
 		filter := &entity.VariableSetFilter{
 			Pagination: &entity.Pagination{
 				Page:     constant.CommonPageDefault,
-				PageSize: constant.CommonPageSizeDefault,
+				PageSize: constant.CommonMaxResultLimit,
 			},
 			FetchAll: true,
 		}
 		sortOptions := &entity.SortOptions{
-			Field:     constant.SortByID,
-			Ascending: false,
+			Field:      constant.SortByID,
+			Descending: false,
 		}
 
 		variableSetEntities, err := h.variableSetManager.ListVariableSets(ctx, filter, sortOptions)
@@ -263,21 +270,9 @@ func (h *Handler) ListVariableSetsByLabels() http.HandlerFunc {
 		}
 
 		// If the amount of variable sets exceeds the maximum result limit,
-		// then retrieve the complete result through a looped query.
-		for len(variableSetEntities.VariableSets) < variableSetEntities.Total {
-			filter = &entity.VariableSetFilter{
-				Pagination: &entity.Pagination{
-					Page:     2,
-					PageSize: len(variableSetEntities.VariableSets),
-				},
-				FetchAll: true,
-			}
-			tmpVariableSetEntities, err := h.variableSetManager.ListVariableSets(ctx, filter, sortOptions)
-			if err != nil {
-				render.Render(w, r, handler.FailureResponse(ctx, err))
-				return
-			}
-			variableSetEntities.VariableSets = append(variableSetEntities.VariableSets, tmpVariableSetEntities.VariableSets...)
+		// then indicate in the response message.
+		if len(variableSetEntities.VariableSets) < variableSetEntities.Total {
+			ctx = context.WithValue(ctx, middleware.ResponseMessageKey, "the result exceeds the maximum amount limit")
 		}
 
 		var matchedVariableSets []*entity.VariableSet

pkg/server/manager/variable/variable_manager.go

@@ -143,11 +143,11 @@ func (v *VariableManager) BuildVariableFilterAndSortOptions(ctx context.Context,
 	if err != nil {
 		return nil, nil, err
 	}
-	SortOrderAscending, _ := strconv.ParseBool(query.Get("ascending"))
-	variableSetSortOptions := &entity.SortOptions{
-		Field:     sortBy,
-		Ascending: SortOrderAscending,
+	sortOrderDescending, _ := strconv.ParseBool(query.Get("descending"))
+	variableSortOptions := &entity.SortOptions{
+		Field:      sortBy,
+		Descending: sortOrderDescending,
 	}
 
-	return &filter, variableSetSortOptions, nil
+	return &filter, variableSortOptions, nil
 }

pkg/server/manager/variableset/variable_set_manager.go

@@ -135,10 +135,10 @@ func (vs *VariableSetManager) BuildVariableSetFilterAndSortOptions(ctx context.C
 	if err != nil {
 		return nil, nil, err
 	}
-	SortOrderAscending, _ := strconv.ParseBool(query.Get("ascending"))
+	sortOrderDescending, _ := strconv.ParseBool(query.Get("descending"))
 	variableSetSortOptions := &entity.SortOptions{
-		Field:     sortBy,
-		Ascending: SortOrderAscending,
+		Field:      sortBy,
+		Descending: sortOrderDescending,
 	}
 
 	return &filter, variableSetSortOptions, nil

pkg/server/middleware/message.go

@@ -0,0 +1,25 @@
+package middleware
+
+import (
+	"context"
+)
+
+// Key to use when setting the response message.
+type (
+	ctxKeyResponseMessage string
+)
+
+// ResponseMessageKey is a context key used for associating a message with a response.
+const ResponseMessageKey ctxKeyResponseMessage = "response_message"
+
+// GetResponseMessage returns a response message from the given context.
+func GetResponseMessage(ctx context.Context) string {
+	if ctx == nil {
+		return ""
+	}
+	if responseMessage, ok := ctx.Value(ResponseMessageKey).(string); ok {
+		return responseMessage
+	}
+
+	return ""
+}