From da6c599efd8da34d23d3668371fbb5ac70399e9d Mon Sep 17 00:00:00 2001 From: Luis Pater Date: Tue, 5 May 2026 03:02:25 +0800 Subject: [PATCH] refactor(management): rename `GetUsage` to `GetUsageQueue` and update routes/tests - Renamed handler and test methods for better clarity on functionality. - Updated route from `/v0/management/usage` to `/v0/management/usage-queue`. - Adjusted integration and unit tests to reflect new naming and routes. --- internal/api/handlers/management/usage.go | 4 ++-- internal/api/handlers/management/usage_test.go | 12 ++++++------ internal/api/server.go | 2 +- internal/api/server_test.go | 12 ++++++++++-- 4 files changed, 19 insertions(+), 11 deletions(-) diff --git a/internal/api/handlers/management/usage.go b/internal/api/handlers/management/usage.go index 8cb175eb..dfddf503 100644 --- a/internal/api/handlers/management/usage.go +++ b/internal/api/handlers/management/usage.go @@ -20,8 +20,8 @@ func (r usageQueueRecord) MarshalJSON() ([]byte, error) { return json.Marshal(string(r)) } -// GetUsage pops queued usage records from the Redis-compatible usage queue. -func (h *Handler) GetUsage(c *gin.Context) { +// GetUsageQueue pops queued usage records from the usage queue. +func (h *Handler) GetUsageQueue(c *gin.Context) { if h == nil { c.JSON(http.StatusInternalServerError, gin.H{"error": "handler unavailable"}) return diff --git a/internal/api/handlers/management/usage_test.go b/internal/api/handlers/management/usage_test.go index 5c5f5c69..ca46d976 100644 --- a/internal/api/handlers/management/usage_test.go +++ b/internal/api/handlers/management/usage_test.go @@ -10,7 +10,7 @@ import ( "github.com/router-for-me/CLIProxyAPI/v6/internal/redisqueue" ) -func TestGetUsagePopsRequestedRecords(t *testing.T) { +func TestGetUsageQueuePopsRequestedRecords(t *testing.T) { gin.SetMode(gin.TestMode) withManagementUsageQueue(t, func() { redisqueue.Enqueue([]byte(`{"id":1}`)) @@ -19,10 +19,10 @@ func TestGetUsagePopsRequestedRecords(t *testing.T) { rec := httptest.NewRecorder() ginCtx, _ := gin.CreateTestContext(rec) - ginCtx.Request = httptest.NewRequest(http.MethodGet, "/v0/management/usage?count=2", nil) + ginCtx.Request = httptest.NewRequest(http.MethodGet, "/v0/management/usage-queue?count=2", nil) h := &Handler{} - h.GetUsage(ginCtx) + h.GetUsageQueue(ginCtx) if rec.Code != http.StatusOK { t.Fatalf("status = %d, want %d body=%s", rec.Code, http.StatusOK, rec.Body.String()) @@ -45,17 +45,17 @@ func TestGetUsagePopsRequestedRecords(t *testing.T) { }) } -func TestGetUsageInvalidCountDoesNotPop(t *testing.T) { +func TestGetUsageQueueInvalidCountDoesNotPop(t *testing.T) { gin.SetMode(gin.TestMode) withManagementUsageQueue(t, func() { redisqueue.Enqueue([]byte(`{"id":1}`)) rec := httptest.NewRecorder() ginCtx, _ := gin.CreateTestContext(rec) - ginCtx.Request = httptest.NewRequest(http.MethodGet, "/v0/management/usage?count=0", nil) + ginCtx.Request = httptest.NewRequest(http.MethodGet, "/v0/management/usage-queue?count=0", nil) h := &Handler{} - h.GetUsage(ginCtx) + h.GetUsageQueue(ginCtx) if rec.Code != http.StatusBadRequest { t.Fatalf("status = %d, want %d body=%s", rec.Code, http.StatusBadRequest, rec.Body.String()) diff --git a/internal/api/server.go b/internal/api/server.go index 5c43db48..487ea571 100644 --- a/internal/api/server.go +++ b/internal/api/server.go @@ -551,7 +551,7 @@ func (s *Server) registerManagementRoutes() { mgmt.PATCH("/api-keys", s.mgmt.PatchAPIKeys) mgmt.DELETE("/api-keys", s.mgmt.DeleteAPIKeys) mgmt.GET("/api-key-usage", s.mgmt.GetAPIKeyUsage) - mgmt.GET("/usage", s.mgmt.GetUsage) + mgmt.GET("/usage-queue", s.mgmt.GetUsageQueue) mgmt.GET("/gemini-api-key", s.mgmt.GetGeminiKeys) mgmt.PUT("/gemini-api-key", s.mgmt.PutGeminiKeys) diff --git a/internal/api/server_test.go b/internal/api/server_test.go index d5718091..fe37cb72 100644 --- a/internal/api/server_test.go +++ b/internal/api/server_test.go @@ -100,14 +100,22 @@ func TestManagementUsageRequiresManagementAuthAndPopsArray(t *testing.T) { redisqueue.Enqueue([]byte(`{"id":1}`)) redisqueue.Enqueue([]byte(`{"id":2}`)) - missingKeyReq := httptest.NewRequest(http.MethodGet, "/v0/management/usage?count=2", nil) + missingKeyReq := httptest.NewRequest(http.MethodGet, "/v0/management/usage-queue?count=2", nil) missingKeyRR := httptest.NewRecorder() server.engine.ServeHTTP(missingKeyRR, missingKeyReq) if missingKeyRR.Code != http.StatusUnauthorized { t.Fatalf("missing key status = %d, want %d body=%s", missingKeyRR.Code, http.StatusUnauthorized, missingKeyRR.Body.String()) } - authReq := httptest.NewRequest(http.MethodGet, "/v0/management/usage?count=2", nil) + legacyReq := httptest.NewRequest(http.MethodGet, "/v0/management/usage?count=2", nil) + legacyReq.Header.Set("Authorization", "Bearer test-management-key") + legacyRR := httptest.NewRecorder() + server.engine.ServeHTTP(legacyRR, legacyReq) + if legacyRR.Code != http.StatusNotFound { + t.Fatalf("legacy usage status = %d, want %d body=%s", legacyRR.Code, http.StatusNotFound, legacyRR.Body.String()) + } + + authReq := httptest.NewRequest(http.MethodGet, "/v0/management/usage-queue?count=2", nil) authReq.Header.Set("Authorization", "Bearer test-management-key") authRR := httptest.NewRecorder() server.engine.ServeHTTP(authRR, authReq)