mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-10-08 08:36:37 +08:00
merge(wavelet): pull v1-only cap and healthz routes
Bring Wavelet feat/cordis-alignment so OpenFlare registers /api/v1/cap and GET /api/healthz only.
This commit is contained in:
@@ -134,7 +134,7 @@ func (p *Plugin) Apply(ctx *core.Context) error {
|
|||||||
"/api/v1/user/send-email-code",
|
"/api/v1/user/send-email-code",
|
||||||
"/api/v1/cap/challenge",
|
"/api/v1/cap/challenge",
|
||||||
"/api/v1/cap/redeem",
|
"/api/v1/cap/redeem",
|
||||||
"/healthz",
|
"/api/healthz",
|
||||||
"/metrics",
|
"/metrics",
|
||||||
}
|
}
|
||||||
RegisterWhitelist(publicEndpoints...)
|
RegisterWhitelist(publicEndpoints...)
|
||||||
|
|||||||
@@ -20,7 +20,8 @@ import (
|
|||||||
// @Param request body challengeRequest false "可选范围限制参数"
|
// @Param request body challengeRequest false "可选范围限制参数"
|
||||||
// @Success 200 {object} response.Any{data=cap.ChallengeResponse} "成功返回 PoW 难题"
|
// @Success 200 {object} response.Any{data=cap.ChallengeResponse} "成功返回 PoW 难题"
|
||||||
// @Failure 500 {object} response.Any "内部服务错误"
|
// @Failure 500 {object} response.Any "内部服务错误"
|
||||||
// @Router /api/cap/challenge [post]
|
// @Router /api/v1/cap/challenge [get]
|
||||||
|
// @Router /api/v1/cap/challenge [post]
|
||||||
func Challenge(c *gin.Context) {
|
func Challenge(c *gin.Context) {
|
||||||
var req challengeRequest
|
var req challengeRequest
|
||||||
_ = c.ShouldBind(&req) // 允许不传 body,默认使用 login scope
|
_ = c.ShouldBind(&req) // 允许不传 body,默认使用 login scope
|
||||||
@@ -54,7 +55,7 @@ func Challenge(c *gin.Context) {
|
|||||||
// @Success 200 {object} response.Any{data=cap.RedeemResponse} "核销成功,返回 X-Cap-Token"
|
// @Success 200 {object} response.Any{data=cap.RedeemResponse} "核销成功,返回 X-Cap-Token"
|
||||||
// @Failure 400 {object} response.Any "参数错误或核销失败"
|
// @Failure 400 {object} response.Any "参数错误或核销失败"
|
||||||
// @Failure 500 {object} response.Any "内部服务错误"
|
// @Failure 500 {object} response.Any "内部服务错误"
|
||||||
// @Router /api/cap/redeem [post]
|
// @Router /api/v1/cap/redeem [post]
|
||||||
func Redeem(c *gin.Context) {
|
func Redeem(c *gin.Context) {
|
||||||
var req redeemRequest
|
var req redeemRequest
|
||||||
if err := c.ShouldBindJSON(&req); err != nil {
|
if err := c.ShouldBindJSON(&req); err != nil {
|
||||||
|
|||||||
@@ -86,11 +86,7 @@ func (p *Plugin) Apply(ctx *core.Context) error {
|
|||||||
capGroup.POST("/challenge", Challenge)
|
capGroup.POST("/challenge", Challenge)
|
||||||
capGroup.POST("/redeem", Redeem)
|
capGroup.POST("/redeem", Redeem)
|
||||||
}
|
}
|
||||||
|
ctx.Router().RegisterWhitelist("/api/v1/cap/challenge", "/api/v1/cap/redeem")
|
||||||
legacy := ctx.Router().Group("/api/cap")
|
|
||||||
legacy.POST("/challenge", Challenge)
|
|
||||||
legacy.POST("/redeem", Redeem)
|
|
||||||
ctx.Router().RegisterWhitelist("/api/cap/challenge", "/api/cap/redeem")
|
|
||||||
|
|
||||||
// Register Settings Schemas
|
// Register Settings Schemas
|
||||||
ctx.Settings().Register(extpoints.SettingSchema{
|
ctx.Settings().Register(extpoints.SettingSchema{
|
||||||
|
|||||||
@@ -34,15 +34,18 @@ func TestApplyRegistersUnversionedCapRoutes(t *testing.T) {
|
|||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
want := map[string]bool{
|
want := map[string]bool{
|
||||||
|
"GET /api/v1/cap/challenge": false,
|
||||||
"POST /api/v1/cap/challenge": false,
|
"POST /api/v1/cap/challenge": false,
|
||||||
"POST /api/cap/challenge": false,
|
"POST /api/v1/cap/redeem": false,
|
||||||
"POST /api/cap/redeem": false,
|
|
||||||
}
|
}
|
||||||
for _, rd := range ctx.Router().Routes() {
|
for _, rd := range ctx.Router().Routes() {
|
||||||
key := rd.Method + " " + rd.Path
|
key := rd.Method + " " + rd.Path
|
||||||
if _, ok := want[key]; ok {
|
if _, ok := want[key]; ok {
|
||||||
want[key] = true
|
want[key] = true
|
||||||
}
|
}
|
||||||
|
if key == "POST /api/cap/challenge" || key == "POST /api/cap/redeem" {
|
||||||
|
t.Errorf("legacy route must not exist: %s", key)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
for key, ok := range want {
|
for key, ok := range want {
|
||||||
if !ok {
|
if !ok {
|
||||||
|
|||||||
@@ -15,56 +15,40 @@ import (
|
|||||||
"github.com/gin-gonic/gin"
|
"github.com/gin-gonic/gin"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestHealthRouteReturnsOKNil(t *testing.T) {
|
func TestHealthzIsTheOnlyHealthRoute(t *testing.T) {
|
||||||
gin.SetMode(gin.TestMode)
|
gin.SetMode(gin.TestMode)
|
||||||
ctx := core.NewContext(context.Background())
|
ctx := core.NewContext(context.Background())
|
||||||
if err := New().Apply(ctx); err != nil {
|
if err := New().Apply(ctx); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
healthHandler := routeHandler(t, ctx, "GET", "/api/health")
|
var hasHealthz bool
|
||||||
routeHandler(t, ctx, "GET", "/healthz")
|
for _, rd := range ctx.Router().Routes() {
|
||||||
if !ctx.Router().IsWhitelisted("/api/health") {
|
key := rd.Method + " " + rd.Path
|
||||||
t.Fatal("GET /api/health is not whitelisted")
|
switch key {
|
||||||
|
case "GET /api/healthz":
|
||||||
|
hasHealthz = true
|
||||||
|
case "GET /healthz", "GET /api/health":
|
||||||
|
t.Errorf("removed health route still registered: %s", key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !hasHealthz {
|
||||||
|
t.Fatal("GET /api/healthz missing")
|
||||||
|
}
|
||||||
|
if !ctx.Router().IsWhitelisted("/api/healthz") {
|
||||||
|
t.Fatal("GET /api/healthz not whitelisted")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
handler := routeHandler(t, ctx, "GET", "/api/healthz")
|
||||||
w := httptest.NewRecorder()
|
w := httptest.NewRecorder()
|
||||||
c, _ := gin.CreateTestContext(w)
|
c, _ := gin.CreateTestContext(w)
|
||||||
c.Request = httptest.NewRequest(http.MethodGet, "/api/health", nil)
|
c.Request = httptest.NewRequest(http.MethodGet, "/api/healthz", nil)
|
||||||
healthHandler(c)
|
handler(c)
|
||||||
|
|
||||||
if w.Code != http.StatusOK {
|
if w.Code != http.StatusOK {
|
||||||
t.Fatalf("status = %d, want %d", w.Code, http.StatusOK)
|
t.Fatalf("status = %d, want %d", w.Code, http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
var body struct {
|
|
||||||
ErrorMsg string `json:"error_msg"`
|
|
||||||
Data any `json:"data"`
|
|
||||||
}
|
|
||||||
if err := json.Unmarshal(w.Body.Bytes(), &body); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if body.ErrorMsg != "" {
|
|
||||||
t.Fatalf("error_msg = %q, want empty", body.ErrorMsg)
|
|
||||||
}
|
|
||||||
if body.Data != nil {
|
|
||||||
t.Fatalf("data = %#v, want null", body.Data)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHealthzRouteUnchanged(t *testing.T) {
|
|
||||||
gin.SetMode(gin.TestMode)
|
|
||||||
ctx := core.NewContext(context.Background())
|
|
||||||
if err := New().Apply(ctx); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
handler := routeHandler(t, ctx, "GET", "/healthz")
|
|
||||||
w := httptest.NewRecorder()
|
|
||||||
c, _ := gin.CreateTestContext(w)
|
|
||||||
c.Request = httptest.NewRequest(http.MethodGet, "/healthz", nil)
|
|
||||||
handler(c)
|
|
||||||
|
|
||||||
var body map[string]any
|
var body map[string]any
|
||||||
if err := json.Unmarshal(w.Body.Bytes(), &body); err != nil {
|
if err := json.Unmarshal(w.Body.Bytes(), &body); err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
|
|||||||
@@ -50,14 +50,10 @@ func (p *Plugin) Apply(ctx *core.Context) error {
|
|||||||
appName := ctx.Config().String("app.app_name", "Wavelet")
|
appName := ctx.Config().String("app.app_name", "Wavelet")
|
||||||
|
|
||||||
// 1. Health check
|
// 1. Health check
|
||||||
ctx.Router().GET("/healthz", func(c *gin.Context) {
|
|
||||||
c.JSON(http.StatusOK, gin.H{"status": "ok"})
|
|
||||||
})
|
|
||||||
ctx.Router().GET("/api/healthz", func(c *gin.Context) {
|
ctx.Router().GET("/api/healthz", func(c *gin.Context) {
|
||||||
c.JSON(http.StatusOK, gin.H{"status": "ok"})
|
c.JSON(http.StatusOK, gin.H{"status": "ok"})
|
||||||
})
|
})
|
||||||
ctx.Router().GET("/api/health", Health)
|
ctx.Router().RegisterWhitelist("/api/healthz")
|
||||||
ctx.Router().RegisterWhitelist("/api/health")
|
|
||||||
|
|
||||||
// 2. Public config
|
// 2. Public config
|
||||||
ctx.Router().GET("/api/v1/config/public", func(c *gin.Context) {
|
ctx.Router().GET("/api/v1/config/public", func(c *gin.Context) {
|
||||||
@@ -90,14 +86,3 @@ func (p *Plugin) Apply(ctx *core.Context) error {
|
|||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Health 健康检查
|
|
||||||
// @Summary 健康检查
|
|
||||||
// @Description 检查服务是否正常运行,可用于负载均衡存活探测
|
|
||||||
// @Tags health
|
|
||||||
// @Produce json
|
|
||||||
// @Success 200 {object} response.Any{data=string} "服务正常"
|
|
||||||
// @Router /api/health [get]
|
|
||||||
func Health(c *gin.Context) {
|
|
||||||
c.JSON(http.StatusOK, response.OKNil())
|
|
||||||
}
|
|
||||||
|
|||||||
Reference in New Issue
Block a user