style: format code annotations

Signed-off-by: adam <[email protected]>

Author: wujunwei

pkg/infra/search/storage/meilisearch/convert.go

@@ -1,10 +1,16 @@
-/**
- * @Author:      Adam wu
- * @Description:
- * @File:        convert.go
- * @Version:     1.0.0
- * @Date:        2025/3/21
- */
+// Copyright The Karpor Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
 
 package meilisearch
 
@@ -46,26 +52,26 @@ func ConvertWithDefaultFilter(sql string, defaultFilter []string) (*meilisearch.
 		return nil, "", fmt.Errorf("only single table queries are supported")
 	}
 
-	// 应用默认过滤器
+	// apply the default filter
 	sel = applyDefaultFilter(sel, defaultFilter)
 
-	// 获取表名
+	// obtain the table name
 	tableName := strings.ReplaceAll(sqlparser.String(sel.From), "`", "")
 
-	// 构建搜索请求
+	// build a search request
 	req := &meilisearch.SearchRequest{
 		Limit:  1000, //by default
 		Offset: 0,
 	}
 
-	// 处理WHERE条件
+	// handle the where condition
 	filter, err := buildFilter(sel.Where)
 	if err != nil {
 		return nil, "", err
 	}
 	req.Filter = filter
 
-	// 处理LIMIT/OFFSET
+	// deal with LIMIT/OFFSET
 	if sel.Limit != nil {
 		if offset, ok := sel.Limit.Offset.(*sqlparser.SQLVal); ok {
 			req.Offset = parseInt(string(offset.Val))
@@ -75,7 +81,7 @@ func ConvertWithDefaultFilter(sql string, defaultFilter []string) (*meilisearch.
 		}
 	}
 
-	// 处理ORDER BY
+	// deal with ORDER BY
 	if len(sel.OrderBy) > 0 {
 		sort := make([]string, 0, len(sel.OrderBy))
 		for _, order := range sel.OrderBy {

pkg/infra/search/storage/meilisearch/index.go

@@ -22,12 +22,10 @@ const (
 )
 
 var defaultResourceIndexSetting = &meilisearch.Settings{
-	// 对应 ES 的 max_result_window
 	Pagination: &meilisearch.Pagination{
-		MaxTotalHits: 1_000_000, // 控制最大返回结果数
+		MaxTotalHits: 1_000_000,
 	},
 
-	// 对应 ES analysis.normalizer
 	SortableAttributes: []string{
 		"creationTimestamp",
 		"deletionTimestamp",
@@ -42,15 +40,14 @@ var defaultResourceIndexSetting = &meilisearch.Settings{
 		},
 	},
 
-	// 对应 ES mappings.properties 字段配置
 	FilterableAttributes: []string{
 		"id",
 		"cluster",
 		"apiVersion",
-		"kind", // 启用过滤和精确匹配
+		"kind",
 		"namespace",
 		"name",
-		"labels", // 扁平化字段过滤
+		"labels",
 		"annotations",
 		"ownerReferences",
 		"content",
@@ -60,10 +57,9 @@ var defaultResourceIndexSetting = &meilisearch.Settings{
 	},
 
 	SearchableAttributes: []string{
-		"content", // 全文搜索字段
+		"content",
 	},
 
-	// 对应 _source.excludes 排除字段
 	DisplayedAttributes: []string{
 		"cluster",
 		"apiVersion",
@@ -77,16 +73,13 @@ var defaultResourceIndexSetting = &meilisearch.Settings{
 		"ownerReferences",
 		"resourceVersion",
 		"content",
-		// 排除 "custom" 字段
 	},
 }
 var defaultResourceGroupRuleIndexSetting = &meilisearch.Settings{
-	// 对应 Elasticsearch 的 max_result_window
 	Pagination: &meilisearch.Pagination{
-		MaxTotalHits: 1000000, // 控制最大返回结果数
-	}, // 控制最大返回结果数
+		MaxTotalHits: 1000000,
+	},
 
-	// 对应 mappings.properties 字段属性
 	FilterableAttributes: []string{
 		"id",
 		"name",
@@ -100,8 +93,6 @@ var defaultResourceGroupRuleIndexSetting = &meilisearch.Settings{
 		"deletedAt",
 	},
 
-	// 对应 mappings._source.excludes
-	// Meilisearch 无完全等效功能，但可通过以下方式近似实现
 	DisplayedAttributes: []string{
 		"id",
 		"name",
@@ -110,6 +101,5 @@ var defaultResourceGroupRuleIndexSetting = &meilisearch.Settings{
 		"createdAt",
 		"updatedAt",
 		"deletedAt",
-	}, // 显式指定返回字段
-
+	},
 }

pkg/infra/search/storage/meilisearch/parse.go

@@ -120,21 +120,21 @@ func ParseQueries(queries []storage.Query) ([]interface{}, error) {
 	return filter, nil
 }
 
-// ConvertToFilter 将 map 转换为 Meilisearch 等值过滤器
-// 输入示例:
+// ConvertToFilter convert the map to a meilisearch equivalent filter
+// Input:
 //
 //	{
 //	  "category": "electronics",
 //	  "tags": ["a", "b"],
 //	  "author": {"name": "Alice"}
 //	}
 //
-// 输出: ["category = 'electronics'", "tags IN ['a','b']", "author.name = 'Alice'"]
+// Output: ["category = 'electronics'", "tags IN ['a','b']", "author.name = 'Alice'"]
 func ConvertToFilter(query map[string]any) ([]any, error) {
 	return processMap(query, "")
 }
 
-// 递归处理嵌套 map
+// recursively handles nesting map
 func processMap(data map[string]any, parentKey string) ([]any, error) {
 	var filters []any
 
@@ -146,23 +146,20 @@ func processMap(data map[string]any, parentKey string) ([]any, error) {
 
 		switch v := value.(type) {
 		case map[string]any:
-			// 处理嵌套对象
 			nestedFilters, err := processMap(v, fullKey)
 			if err != nil {
 				return nil, err
 			}
 			filters = append(filters, nestedFilters)
 
 		case []any:
-			// 处理数组 (IN 查询)
 			inClause, err := buildInClause(fullKey, v)
 			if err != nil {
 				return nil, err
 			}
 			filters = append(filters, inClause)
 
 		default:
-			// 处理基本类型
 			eqClause, err := buildEqualClause(fullKey, v)
 			if err != nil {
 				return nil, err
@@ -174,7 +171,7 @@ func processMap(data map[string]any, parentKey string) ([]any, error) {
 	return filters, nil
 }
 
-// 构建等值条件
+// build an equivalence condition
 func buildEqualClause(key string, value any) (string, error) {
 	valueStr, err := convertValue(value)
 	if err != nil {
@@ -183,7 +180,7 @@ func buildEqualClause(key string, value any) (string, error) {
 	return fmt.Sprintf("%s = %s", key, valueStr), nil
 }
 
-// 构建 IN 条件
+// build an in condition
 func buildInClause(key string, values []any) (string, error) {
 	var elements []string
 	for _, v := range values {
@@ -196,7 +193,7 @@ func buildInClause(key string, values []any) (string, error) {
 	return fmt.Sprintf("%s IN [%s]", key, strings.Join(elements, ",")), nil
 }
 
-// 值类型转换
+// value type conversion
 func convertValue(value any) (string, error) {
 	switch v := value.(type) {
 	case string: