feat(feedback): feat(feedback): add ListFeedback service

api/handler/api/feedback_service.go

@@ -20,8 +20,10 @@ import (
 	"context"
 
 	"github.com/cloudwego/hertz/pkg/app"
+	"github.com/cloudwego/hertz/pkg/protocol/consts"
 
 	api "github.com/west2-online/fzuhelper-server/api/model/api"
+	"github.com/west2-online/fzuhelper-server/api/model/model"
 	"github.com/west2-online/fzuhelper-server/api/pack"
 	"github.com/west2-online/fzuhelper-server/api/rpc"
 	oa "github.com/west2-online/fzuhelper-server/kitex_gen/oa"
@@ -38,8 +40,7 @@ func CreateFeedback(ctx context.Context, c *app.RequestContext) {
 	}
 
 	resp := new(api.CreateFeedbackResponse)
-	err := rpc.CreateFeedbackRPC(ctx, &oa.CreateFeedbackRequest{
-		ReportId:       req.GetReportID(),
+	reportID, err := rpc.CreateFeedbackRPC(ctx, &oa.CreateFeedbackRequest{
 		StuId:          req.GetStuID(),
 		Name:           req.GetName(),
 		College:        req.GetCollege(),
@@ -64,22 +65,83 @@ func CreateFeedback(ctx context.Context, c *app.RequestContext) {
 		pack.RespError(c, err)
 		return
 	}
+	resp.ReportID = reportID
 	pack.RespData(c, resp)
 }
 
-// GetFeedback .
-// @router /api/v1/feedback/get [POST]
-func GetFeedback(ctx context.Context, c *app.RequestContext) {
-	var req api.GetFeedbackRequest
-	if err := c.BindAndValidate(&req); err != nil {
-		pack.RespError(c, errno.ParamError.WithError(err))
+// GetFeedbackByID .
+// @router /api/v1/feedbacks/detail [GET]
+func GetFeedbackByID(ctx context.Context, c *app.RequestContext) {
+	var err error
+	var req api.GetFeedbackByIDRequest
+	err = c.BindAndValidate(&req)
+	if err != nil {
+		c.String(consts.StatusBadRequest, err.Error())
+		return
+	}
+
+	resp := new(api.FeedbackDetailResponse)
+	data, err := rpc.GetFeedbackByIdRPC(ctx, &oa.GetFeedbackByIDRequest{ReportId: req.ReportID})
+	if err != nil {
+		pack.RespError(c, err)
+		return
+	}
+	resp.Data = &model.Feedback{
+		ReportID:       data.ReportId,
+		StuID:          data.StuId,
+		Name:           data.Name,
+		College:        data.College,
+		ContactPhone:   data.ContactPhone,
+		ContactQq:      data.ContactQq,
+		ContactEmail:   data.ContactEmail,
+		NetworkEnv:     data.NetworkEnv,
+		IsOnCampus:     data.IsOnCampus,
+		OsName:         data.OsName,
+		OsVersion:      data.OsVersion,
+		Manufacturer:   data.Manufacturer,
+		DeviceModel:    data.DeviceModel,
+		ProblemDesc:    data.ProblemDesc,
+		Screenshots:    data.Screenshots,
+		AppVersion:     data.AppVersion,
+		VersionHistory: data.VersionHistory,
+		NetworkTraces:  data.NetworkTraces,
+		Events:         data.Events,
+		UserSettings:   data.UserSettings,
+	}
+	pack.RespData(c, resp)
+}
+
+// ListFeedback .
+// @router /api/v1/feedbacks/get/list [GET]
+func ListFeedback(ctx context.Context, c *app.RequestContext) {
+	var err error
+	var req api.GetListFeedbackRequest
+	err = c.BindAndValidate(&req)
+	if err != nil {
+		c.String(consts.StatusBadRequest, err.Error())
 		return
 	}
 
-	resp, err := rpc.GetFeedbackRPC(ctx, &oa.GetFeedbackRequest{ReportId: req.ReportID})
+	resp := new(api.GetListFeedbackResponse)
+	data, pageToken, err := rpc.GetFeedbackListRPC(ctx, &oa.GetListFeedbackRequest{
+		StuId:       req.StuID,
+		Name:        req.Name,
+		NetworkEnv:  req.NetworkEnv,
+		IsOnCampus:  req.IsOnCampus,
+		OsName:      req.OsName,
+		ProblemDesc: req.ProblemDesc,
+		AppVersion:  req.AppVersion,
+		BeginTimeMs: req.BeginTimeMs,
+		EndTimeMs:   req.EndTimeMs,
+		Limit:       req.Limit,
+		PageToken:   req.PageToken,
+		OrderDesc:   req.OrderDesc,
+	})
 	if err != nil {
 		pack.RespError(c, err)
 		return
 	}
+	resp.Data = pack.BuildFeedbackList(data)
+	resp.PageToken = pageToken
 	pack.RespData(c, resp)
 }

api/handler/api/feedback_service_test.go

@@ -22,13 +22,15 @@ import (
 	"testing"
 
 	"github.com/bytedance/mockey"
+	"github.com/cloudwego/hertz/pkg/app"
 	"github.com/cloudwego/hertz/pkg/common/config"
 	"github.com/cloudwego/hertz/pkg/common/ut"
 	"github.com/cloudwego/hertz/pkg/protocol/consts"
 	"github.com/cloudwego/hertz/pkg/route"
 	"github.com/stretchr/testify/assert"
 
 	"github.com/west2-online/fzuhelper-server/api/rpc"
+	"github.com/west2-online/fzuhelper-server/kitex_gen/model"
 	oa "github.com/west2-online/fzuhelper-server/kitex_gen/oa"
 	"github.com/west2-online/fzuhelper-server/pkg/errno"
 )
@@ -44,26 +46,25 @@ func TestCreateFeedback(t *testing.T) {
 	}
 
 	okBody := `{
-		"reportId": 1,
-		"stuId": "102301000",
+		"stu_id": "102301000",
 		"name": "张三",
 		"college": "计算机与大数据学院",
-		"contactPhone": "13800000000",
-		"contactQQ": "10001",
-		"contactEmail": "a@b.com",
-		"networkEnv": "wifi",
-		"isOnCampus": true,
-		"osName": "Android",
-		"osVersion": "14",
+		"contact_phone": "13800000000",
+		"contact_qq": "10001",
+		"contact_email": "a@b.com",
+		"network_env": "wifi",
+		"is_on_campus": true,
+		"os_name": "Android",
+		"os_version": "14",
 		"manufacturer": "Xiaomi",
-		"deviceModel": "Mi 14",
-		"problemDesc": "登录白屏",
+		"device_model": "Mi 14",
+		"problem_desc": "登录白屏",
 		"screenshots": "[]",
-		"appVersion": "1.2.3",
-		"versionHistory": "[]",
-		"networkTraces": "[]",
+		"app_version": "1.2.3",
+		"version_history": "[]",
+		"network_traces": "[]",
 		"events": "[]",
-		"userSettings": "{}"
+		"user_settings": "{}"
 	}`
 
 	testCases := []testCase{
@@ -99,8 +100,11 @@ func TestCreateFeedback(t *testing.T) {
 	defer mockey.UnPatchAll()
 	for _, tc := range testCases {
 		mockey.PatchConvey(tc.name, t, func() {
-			mockey.Mock(rpc.CreateFeedbackRPC).To(func(ctx context.Context, req *oa.CreateFeedbackRequest) error {
-				return tc.mockRPCError
+			mockey.Mock(rpc.CreateFeedbackRPC).To(func(ctx context.Context, req *oa.CreateFeedbackRequest) (int64, error) {
+				if tc.mockRPCError != nil {
+					return 0, tc.mockRPCError
+				}
+				return 1, nil
 			}).Build()
 
 			result := ut.PerformRequest(router, "POST", tc.url,
@@ -111,3 +115,169 @@ func TestCreateFeedback(t *testing.T) {
 		})
 	}
 }
+
+func TestGetFeedbackByID(t *testing.T) {
+	type testCase struct {
+		name           string
+		url            string
+		mockData       *model.Feedback
+		mockRPCError   error
+		expectStatus   int
+		expectContains string
+	}
+
+	okData := &model.Feedback{
+		ReportId:       763136510504468480,
+		StuId:          "2023123456",
+		Name:           "张三",
+		College:        "数学与统计学院",
+		ContactPhone:   "13800000000",
+		ContactQq:      "10001",
+		ContactEmail:   "a@b.com",
+		NetworkEnv:     "wifi",
+		IsOnCampus:     true,
+		OsName:         "Android",
+		OsVersion:      "14",
+		Manufacturer:   "Xiaomi",
+		DeviceModel:    "Mi 14",
+		ProblemDesc:    "登录白屏",
+		Screenshots:    "[]",
+		AppVersion:     "1.2.3",
+		VersionHistory: "[]",
+		NetworkTraces:  "[]",
+		Events:         "[]",
+		UserSettings:   "{}",
+	}
+
+	testCases := []testCase{
+		{
+			name:           "success",
+			url:            "/api/v1/feedbacks/detail?report_id=763136510504468480",
+			mockData:       okData,
+			mockRPCError:   nil,
+			expectStatus:   consts.StatusOK,
+			expectContains: `{"code":"10000","message":`,
+		},
+		{
+			name:           "bind error",
+			url:            "/api/v1/feedbacks/detail", // 缺少 report_id
+			mockData:       nil,
+			mockRPCError:   nil,
+			expectStatus:   consts.StatusBadRequest,
+			expectContains: `does not have this parameter`,
+		},
+		{
+			name:           "rpc error",
+			url:            "/api/v1/feedbacks/detail?report_id=763136510504468480",
+			mockData:       nil,
+			mockRPCError:   errno.InternalServiceError,
+			expectStatus:   consts.StatusOK,
+			expectContains: `{"code":"50001","message":`,
+		},
+	}
+
+	router := route.NewEngine(&config.Options{})
+	router.GET("/api/v1/feedbacks/detail", func(c context.Context, h *app.RequestContext) {
+		GetFeedbackByID(c, h)
+	})
+
+	defer mockey.UnPatchAll()
+	for _, tc := range testCases {
+		mockey.PatchConvey(tc.name, t, func() {
+			mockey.Mock(rpc.GetFeedbackByIdRPC).To(func(ctx context.Context, req *oa.GetFeedbackByIDRequest) (*model.Feedback, error) {
+				if tc.mockRPCError != nil {
+					return nil, tc.mockRPCError
+				}
+				return tc.mockData, nil
+			}).Build()
+
+			res := ut.PerformRequest(router, "GET", tc.url, nil)
+			assert.Equal(t, tc.expectStatus, res.Result().StatusCode())
+			if tc.expectContains != `` {
+				assert.Contains(t, string(res.Result().Body()), tc.expectContains)
+			}
+		})
+	}
+}
+
+func TestListFeedback(t *testing.T) {
+	type testCase struct {
+		name           string
+		url            string
+		mockData       []*model.FeedbackListItem
+		mockPageToken  int64
+		mockRPCError   error
+		expectStatus   int
+		expectContains string
+	}
+
+	okList := []*model.FeedbackListItem{
+		{
+			ReportId:    763136510504468480,
+			Name:        "张三",
+			NetworkEnv:  "wifi",
+			ProblemDesc: "登录白屏",
+			AppVersion:  "1.2.3",
+		},
+		{
+			ReportId:    763136253519462400,
+			Name:        "张三",
+			NetworkEnv:  "wifi",
+			ProblemDesc: "页面卡顿",
+			AppVersion:  "1.2.3",
+		},
+	}
+
+	testCases := []testCase{
+		{
+			name:           "success",
+			url:            "/api/v1/feedbacks/get/list?limit=2&order_desc=true",
+			mockData:       okList,
+			mockPageToken:  0,
+			mockRPCError:   nil,
+			expectStatus:   consts.StatusOK,
+			expectContains: `{"code":"10000","message":`,
+		},
+		{
+			name:           "bind error",
+			url:            "/api/v1/feedbacks/get/list?limit=abc",
+			mockData:       nil,
+			mockPageToken:  0,
+			mockRPCError:   nil,
+			expectStatus:   consts.StatusBadRequest,
+			expectContains: `unable to decode`,
+		},
+		{
+			name:           "rpc error",
+			url:            "/api/v1/feedbacks/get/list?limit=2",
+			mockData:       nil,
+			mockPageToken:  0,
+			mockRPCError:   errno.InternalServiceError,
+			expectStatus:   consts.StatusOK,
+			expectContains: `{"code":"50001","message":`,
+		},
+	}
+
+	router := route.NewEngine(&config.Options{})
+	router.GET("/api/v1/feedbacks/get/list", func(c context.Context, h *app.RequestContext) {
+		ListFeedback(c, h)
+	})
+
+	defer mockey.UnPatchAll()
+	for _, tc := range testCases {
+		mockey.PatchConvey(tc.name, t, func() {
+			mockey.Mock(rpc.GetFeedbackListRPC).To(func(ctx context.Context, req *oa.GetListFeedbackRequest) ([]*model.FeedbackListItem, *int64, error) {
+				if tc.mockRPCError != nil {
+					return nil, nil, tc.mockRPCError
+				}
+				return tc.mockData, &tc.mockPageToken, nil
+			}).Build()
+
+			res := ut.PerformRequest(router, "GET", tc.url, nil)
+			assert.Equal(t, tc.expectStatus, res.Result().StatusCode())
+			if tc.expectContains != `` {
+				assert.Contains(t, string(res.Result().Body()), tc.expectContains)
+			}
+		})
+	}
+}