usage_cleanup_handler_test.go 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463
  1. package admin
  2. import (
  3. "bytes"
  4. "context"
  5. "database/sql"
  6. "encoding/json"
  7. "errors"
  8. "net/http"
  9. "net/http/httptest"
  10. "sync"
  11. "testing"
  12. "time"
  13. "github.com/Wei-Shaw/sub2api/internal/config"
  14. "github.com/Wei-Shaw/sub2api/internal/handler/dto"
  15. "github.com/Wei-Shaw/sub2api/internal/pkg/pagination"
  16. "github.com/Wei-Shaw/sub2api/internal/pkg/response"
  17. "github.com/Wei-Shaw/sub2api/internal/server/middleware"
  18. "github.com/Wei-Shaw/sub2api/internal/service"
  19. "github.com/gin-gonic/gin"
  20. "github.com/stretchr/testify/require"
  21. )
  22. type cleanupRepoStub struct {
  23. mu sync.Mutex
  24. created []*service.UsageCleanupTask
  25. listTasks []service.UsageCleanupTask
  26. listResult *pagination.PaginationResult
  27. listErr error
  28. statusByID map[int64]string
  29. }
  30. func (s *cleanupRepoStub) CreateTask(ctx context.Context, task *service.UsageCleanupTask) error {
  31. if task == nil {
  32. return nil
  33. }
  34. s.mu.Lock()
  35. defer s.mu.Unlock()
  36. if task.ID == 0 {
  37. task.ID = int64(len(s.created) + 1)
  38. }
  39. if task.CreatedAt.IsZero() {
  40. task.CreatedAt = time.Now().UTC()
  41. }
  42. task.UpdatedAt = task.CreatedAt
  43. clone := *task
  44. s.created = append(s.created, &clone)
  45. return nil
  46. }
  47. func (s *cleanupRepoStub) ListTasks(ctx context.Context, params pagination.PaginationParams) ([]service.UsageCleanupTask, *pagination.PaginationResult, error) {
  48. s.mu.Lock()
  49. defer s.mu.Unlock()
  50. return s.listTasks, s.listResult, s.listErr
  51. }
  52. func (s *cleanupRepoStub) ClaimNextPendingTask(ctx context.Context, staleRunningAfterSeconds int64) (*service.UsageCleanupTask, error) {
  53. return nil, nil
  54. }
  55. func (s *cleanupRepoStub) GetTaskStatus(ctx context.Context, taskID int64) (string, error) {
  56. s.mu.Lock()
  57. defer s.mu.Unlock()
  58. if s.statusByID == nil {
  59. return "", sql.ErrNoRows
  60. }
  61. status, ok := s.statusByID[taskID]
  62. if !ok {
  63. return "", sql.ErrNoRows
  64. }
  65. return status, nil
  66. }
  67. func (s *cleanupRepoStub) UpdateTaskProgress(ctx context.Context, taskID int64, deletedRows int64) error {
  68. return nil
  69. }
  70. func (s *cleanupRepoStub) CancelTask(ctx context.Context, taskID int64, canceledBy int64) (bool, error) {
  71. s.mu.Lock()
  72. defer s.mu.Unlock()
  73. if s.statusByID == nil {
  74. s.statusByID = map[int64]string{}
  75. }
  76. status := s.statusByID[taskID]
  77. if status != service.UsageCleanupStatusPending && status != service.UsageCleanupStatusRunning {
  78. return false, nil
  79. }
  80. s.statusByID[taskID] = service.UsageCleanupStatusCanceled
  81. return true, nil
  82. }
  83. func (s *cleanupRepoStub) MarkTaskSucceeded(ctx context.Context, taskID int64, deletedRows int64) error {
  84. return nil
  85. }
  86. func (s *cleanupRepoStub) MarkTaskFailed(ctx context.Context, taskID int64, deletedRows int64, errorMsg string) error {
  87. return nil
  88. }
  89. func (s *cleanupRepoStub) DeleteUsageLogsBatch(ctx context.Context, filters service.UsageCleanupFilters, limit int) (int64, error) {
  90. return 0, nil
  91. }
  92. var _ service.UsageCleanupRepository = (*cleanupRepoStub)(nil)
  93. func setupCleanupRouter(cleanupService *service.UsageCleanupService, userID int64) *gin.Engine {
  94. gin.SetMode(gin.TestMode)
  95. router := gin.New()
  96. if userID > 0 {
  97. router.Use(func(c *gin.Context) {
  98. c.Set(string(middleware.ContextKeyUser), middleware.AuthSubject{UserID: userID})
  99. c.Next()
  100. })
  101. }
  102. handler := NewUsageHandler(nil, nil, nil, cleanupService)
  103. router.POST("/api/v1/admin/usage/cleanup-tasks", handler.CreateCleanupTask)
  104. router.GET("/api/v1/admin/usage/cleanup-tasks", handler.ListCleanupTasks)
  105. router.POST("/api/v1/admin/usage/cleanup-tasks/:id/cancel", handler.CancelCleanupTask)
  106. return router
  107. }
  108. func TestUsageHandlerCreateCleanupTaskUnauthorized(t *testing.T) {
  109. repo := &cleanupRepoStub{}
  110. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  111. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  112. router := setupCleanupRouter(cleanupService, 0)
  113. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewBufferString(`{}`))
  114. req.Header.Set("Content-Type", "application/json")
  115. recorder := httptest.NewRecorder()
  116. router.ServeHTTP(recorder, req)
  117. require.Equal(t, http.StatusUnauthorized, recorder.Code)
  118. }
  119. func TestUsageHandlerCreateCleanupTaskUnavailable(t *testing.T) {
  120. router := setupCleanupRouter(nil, 1)
  121. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewBufferString(`{}`))
  122. req.Header.Set("Content-Type", "application/json")
  123. recorder := httptest.NewRecorder()
  124. router.ServeHTTP(recorder, req)
  125. require.Equal(t, http.StatusServiceUnavailable, recorder.Code)
  126. }
  127. func TestUsageHandlerCreateCleanupTaskBindError(t *testing.T) {
  128. repo := &cleanupRepoStub{}
  129. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  130. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  131. router := setupCleanupRouter(cleanupService, 88)
  132. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewBufferString("{bad-json"))
  133. req.Header.Set("Content-Type", "application/json")
  134. recorder := httptest.NewRecorder()
  135. router.ServeHTTP(recorder, req)
  136. require.Equal(t, http.StatusBadRequest, recorder.Code)
  137. }
  138. func TestUsageHandlerCreateCleanupTaskMissingRange(t *testing.T) {
  139. repo := &cleanupRepoStub{}
  140. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  141. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  142. router := setupCleanupRouter(cleanupService, 88)
  143. payload := map[string]any{
  144. "start_date": "2024-01-01",
  145. "timezone": "UTC",
  146. }
  147. body, err := json.Marshal(payload)
  148. require.NoError(t, err)
  149. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewReader(body))
  150. req.Header.Set("Content-Type", "application/json")
  151. recorder := httptest.NewRecorder()
  152. router.ServeHTTP(recorder, req)
  153. require.Equal(t, http.StatusBadRequest, recorder.Code)
  154. }
  155. func TestUsageHandlerCreateCleanupTaskInvalidDate(t *testing.T) {
  156. repo := &cleanupRepoStub{}
  157. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  158. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  159. router := setupCleanupRouter(cleanupService, 88)
  160. payload := map[string]any{
  161. "start_date": "2024-13-01",
  162. "end_date": "2024-01-02",
  163. "timezone": "UTC",
  164. }
  165. body, err := json.Marshal(payload)
  166. require.NoError(t, err)
  167. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewReader(body))
  168. req.Header.Set("Content-Type", "application/json")
  169. recorder := httptest.NewRecorder()
  170. router.ServeHTTP(recorder, req)
  171. require.Equal(t, http.StatusBadRequest, recorder.Code)
  172. }
  173. func TestUsageHandlerCreateCleanupTaskInvalidEndDate(t *testing.T) {
  174. repo := &cleanupRepoStub{}
  175. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  176. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  177. router := setupCleanupRouter(cleanupService, 88)
  178. payload := map[string]any{
  179. "start_date": "2024-01-01",
  180. "end_date": "2024-02-40",
  181. "timezone": "UTC",
  182. }
  183. body, err := json.Marshal(payload)
  184. require.NoError(t, err)
  185. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewReader(body))
  186. req.Header.Set("Content-Type", "application/json")
  187. recorder := httptest.NewRecorder()
  188. router.ServeHTTP(recorder, req)
  189. require.Equal(t, http.StatusBadRequest, recorder.Code)
  190. }
  191. func TestUsageHandlerCreateCleanupTaskInvalidRequestType(t *testing.T) {
  192. repo := &cleanupRepoStub{}
  193. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  194. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  195. router := setupCleanupRouter(cleanupService, 88)
  196. payload := map[string]any{
  197. "start_date": "2024-01-01",
  198. "end_date": "2024-01-02",
  199. "timezone": "UTC",
  200. "request_type": "invalid",
  201. }
  202. body, err := json.Marshal(payload)
  203. require.NoError(t, err)
  204. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewReader(body))
  205. req.Header.Set("Content-Type", "application/json")
  206. recorder := httptest.NewRecorder()
  207. router.ServeHTTP(recorder, req)
  208. require.Equal(t, http.StatusBadRequest, recorder.Code)
  209. }
  210. func TestUsageHandlerCreateCleanupTaskRequestTypePriority(t *testing.T) {
  211. repo := &cleanupRepoStub{}
  212. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  213. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  214. router := setupCleanupRouter(cleanupService, 99)
  215. payload := map[string]any{
  216. "start_date": "2024-01-01",
  217. "end_date": "2024-01-02",
  218. "timezone": "UTC",
  219. "request_type": "ws_v2",
  220. "stream": false,
  221. }
  222. body, err := json.Marshal(payload)
  223. require.NoError(t, err)
  224. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewReader(body))
  225. req.Header.Set("Content-Type", "application/json")
  226. recorder := httptest.NewRecorder()
  227. router.ServeHTTP(recorder, req)
  228. require.Equal(t, http.StatusOK, recorder.Code)
  229. repo.mu.Lock()
  230. defer repo.mu.Unlock()
  231. require.Len(t, repo.created, 1)
  232. created := repo.created[0]
  233. require.NotNil(t, created.Filters.RequestType)
  234. require.Equal(t, int16(service.RequestTypeWSV2), *created.Filters.RequestType)
  235. require.Nil(t, created.Filters.Stream)
  236. }
  237. func TestUsageHandlerCreateCleanupTaskWithLegacyStream(t *testing.T) {
  238. repo := &cleanupRepoStub{}
  239. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  240. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  241. router := setupCleanupRouter(cleanupService, 99)
  242. payload := map[string]any{
  243. "start_date": "2024-01-01",
  244. "end_date": "2024-01-02",
  245. "timezone": "UTC",
  246. "stream": true,
  247. }
  248. body, err := json.Marshal(payload)
  249. require.NoError(t, err)
  250. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewReader(body))
  251. req.Header.Set("Content-Type", "application/json")
  252. recorder := httptest.NewRecorder()
  253. router.ServeHTTP(recorder, req)
  254. require.Equal(t, http.StatusOK, recorder.Code)
  255. repo.mu.Lock()
  256. defer repo.mu.Unlock()
  257. require.Len(t, repo.created, 1)
  258. created := repo.created[0]
  259. require.Nil(t, created.Filters.RequestType)
  260. require.NotNil(t, created.Filters.Stream)
  261. require.True(t, *created.Filters.Stream)
  262. }
  263. func TestUsageHandlerCreateCleanupTaskSuccess(t *testing.T) {
  264. repo := &cleanupRepoStub{}
  265. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  266. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  267. router := setupCleanupRouter(cleanupService, 99)
  268. payload := map[string]any{
  269. "start_date": " 2024-01-01 ",
  270. "end_date": "2024-01-02",
  271. "timezone": "UTC",
  272. "model": "gpt-4",
  273. }
  274. body, err := json.Marshal(payload)
  275. require.NoError(t, err)
  276. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks", bytes.NewReader(body))
  277. req.Header.Set("Content-Type", "application/json")
  278. recorder := httptest.NewRecorder()
  279. router.ServeHTTP(recorder, req)
  280. require.Equal(t, http.StatusOK, recorder.Code)
  281. var resp response.Response
  282. require.NoError(t, json.Unmarshal(recorder.Body.Bytes(), &resp))
  283. require.Equal(t, 0, resp.Code)
  284. repo.mu.Lock()
  285. defer repo.mu.Unlock()
  286. require.Len(t, repo.created, 1)
  287. created := repo.created[0]
  288. require.Equal(t, int64(99), created.CreatedBy)
  289. require.NotNil(t, created.Filters.Model)
  290. require.Equal(t, "gpt-4", *created.Filters.Model)
  291. start := time.Date(2024, 1, 1, 0, 0, 0, 0, time.UTC)
  292. end := time.Date(2024, 1, 2, 0, 0, 0, 0, time.UTC).Add(24*time.Hour - time.Nanosecond)
  293. require.True(t, created.Filters.StartTime.Equal(start))
  294. require.True(t, created.Filters.EndTime.Equal(end))
  295. }
  296. func TestUsageHandlerListCleanupTasksUnavailable(t *testing.T) {
  297. router := setupCleanupRouter(nil, 0)
  298. req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/usage/cleanup-tasks", nil)
  299. recorder := httptest.NewRecorder()
  300. router.ServeHTTP(recorder, req)
  301. require.Equal(t, http.StatusServiceUnavailable, recorder.Code)
  302. }
  303. func TestUsageHandlerListCleanupTasksSuccess(t *testing.T) {
  304. repo := &cleanupRepoStub{}
  305. repo.listTasks = []service.UsageCleanupTask{
  306. {
  307. ID: 7,
  308. Status: service.UsageCleanupStatusSucceeded,
  309. CreatedBy: 4,
  310. },
  311. }
  312. repo.listResult = &pagination.PaginationResult{Total: 1, Page: 1, PageSize: 20, Pages: 1}
  313. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  314. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  315. router := setupCleanupRouter(cleanupService, 1)
  316. req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/usage/cleanup-tasks", nil)
  317. recorder := httptest.NewRecorder()
  318. router.ServeHTTP(recorder, req)
  319. require.Equal(t, http.StatusOK, recorder.Code)
  320. var resp struct {
  321. Code int `json:"code"`
  322. Data struct {
  323. Items []dto.UsageCleanupTask `json:"items"`
  324. Total int64 `json:"total"`
  325. Page int `json:"page"`
  326. } `json:"data"`
  327. }
  328. require.NoError(t, json.Unmarshal(recorder.Body.Bytes(), &resp))
  329. require.Equal(t, 0, resp.Code)
  330. require.Len(t, resp.Data.Items, 1)
  331. require.Equal(t, int64(7), resp.Data.Items[0].ID)
  332. require.Equal(t, int64(1), resp.Data.Total)
  333. require.Equal(t, 1, resp.Data.Page)
  334. }
  335. func TestUsageHandlerListCleanupTasksError(t *testing.T) {
  336. repo := &cleanupRepoStub{listErr: errors.New("boom")}
  337. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true, MaxRangeDays: 31}}
  338. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  339. router := setupCleanupRouter(cleanupService, 1)
  340. req := httptest.NewRequest(http.MethodGet, "/api/v1/admin/usage/cleanup-tasks", nil)
  341. recorder := httptest.NewRecorder()
  342. router.ServeHTTP(recorder, req)
  343. require.Equal(t, http.StatusInternalServerError, recorder.Code)
  344. }
  345. func TestUsageHandlerCancelCleanupTaskUnauthorized(t *testing.T) {
  346. repo := &cleanupRepoStub{}
  347. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true}}
  348. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  349. router := setupCleanupRouter(cleanupService, 0)
  350. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks/1/cancel", nil)
  351. rec := httptest.NewRecorder()
  352. router.ServeHTTP(rec, req)
  353. require.Equal(t, http.StatusUnauthorized, rec.Code)
  354. }
  355. func TestUsageHandlerCancelCleanupTaskNotFound(t *testing.T) {
  356. repo := &cleanupRepoStub{}
  357. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true}}
  358. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  359. router := setupCleanupRouter(cleanupService, 1)
  360. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks/999/cancel", nil)
  361. rec := httptest.NewRecorder()
  362. router.ServeHTTP(rec, req)
  363. require.Equal(t, http.StatusNotFound, rec.Code)
  364. }
  365. func TestUsageHandlerCancelCleanupTaskConflict(t *testing.T) {
  366. repo := &cleanupRepoStub{statusByID: map[int64]string{2: service.UsageCleanupStatusSucceeded}}
  367. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true}}
  368. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  369. router := setupCleanupRouter(cleanupService, 1)
  370. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks/2/cancel", nil)
  371. rec := httptest.NewRecorder()
  372. router.ServeHTTP(rec, req)
  373. require.Equal(t, http.StatusConflict, rec.Code)
  374. }
  375. func TestUsageHandlerCancelCleanupTaskSuccess(t *testing.T) {
  376. repo := &cleanupRepoStub{statusByID: map[int64]string{3: service.UsageCleanupStatusPending}}
  377. cfg := &config.Config{UsageCleanup: config.UsageCleanupConfig{Enabled: true}}
  378. cleanupService := service.NewUsageCleanupService(repo, nil, nil, cfg)
  379. router := setupCleanupRouter(cleanupService, 1)
  380. req := httptest.NewRequest(http.MethodPost, "/api/v1/admin/usage/cleanup-tasks/3/cancel", nil)
  381. rec := httptest.NewRecorder()
  382. router.ServeHTTP(rec, req)
  383. require.Equal(t, http.StatusOK, rec.Code)
  384. }