feat(idempotency): 为关键写接口接入幂等并完善并发容错
This commit is contained in:
yangjianbo
237
backend/internal/repository/idempotency_repo.go
Normal file
237
backend/internal/repository/idempotency_repo.go
Normal file
@@ -0,0 +1,237 @@
|
||||
package repository
|
||||
|
||||
import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"errors"
|
||||
"time"
|
||||
|
||||
dbent "github.com/Wei-Shaw/sub2api/ent"
|
||||
"github.com/Wei-Shaw/sub2api/internal/service"
|
||||
)
|
||||
|
||||
type idempotencyRepository struct {
|
||||
sql sqlExecutor
|
||||
}
|
||||
|
||||
func NewIdempotencyRepository(_ *dbent.Client, sqlDB *sql.DB) service.IdempotencyRepository {
|
||||
return &idempotencyRepository{sql: sqlDB}
|
||||
}
|
||||
|
||||
func (r *idempotencyRepository) CreateProcessing(ctx context.Context, record *service.IdempotencyRecord) (bool, error) {
|
||||
if record == nil {
|
||||
return false, nil
|
||||
}
|
||||
query := `
|
||||
INSERT INTO idempotency_records (
|
||||
scope, idempotency_key_hash, request_fingerprint, status, locked_until, expires_at
|
||||
) VALUES ($1, $2, $3, $4, $5, $6)
|
||||
ON CONFLICT (scope, idempotency_key_hash) DO NOTHING
|
||||
RETURNING id, created_at, updated_at
|
||||
`
|
||||
var createdAt time.Time
|
||||
var updatedAt time.Time
|
||||
err := scanSingleRow(ctx, r.sql, query, []any{
|
||||
record.Scope,
|
||||
record.IdempotencyKeyHash,
|
||||
record.RequestFingerprint,
|
||||
record.Status,
|
||||
record.LockedUntil,
|
||||
record.ExpiresAt,
|
||||
}, &record.ID, &createdAt, &updatedAt)
|
||||
if errors.Is(err, sql.ErrNoRows) {
|
||||
return false, nil
|
||||
}
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
record.CreatedAt = createdAt
|
||||
record.UpdatedAt = updatedAt
|
||||
return true, nil
|
||||
}
|
||||
|
||||
func (r *idempotencyRepository) GetByScopeAndKeyHash(ctx context.Context, scope, keyHash string) (*service.IdempotencyRecord, error) {
|
||||
query := `
|
||||
SELECT
|
||||
id, scope, idempotency_key_hash, request_fingerprint, status, response_status,
|
||||
response_body, error_reason, locked_until, expires_at, created_at, updated_at
|
||||
FROM idempotency_records
|
||||
WHERE scope = $1 AND idempotency_key_hash = $2
|
||||
`
|
||||
record := &service.IdempotencyRecord{}
|
||||
var responseStatus sql.NullInt64
|
||||
var responseBody sql.NullString
|
||||
var errorReason sql.NullString
|
||||
var lockedUntil sql.NullTime
|
||||
err := scanSingleRow(ctx, r.sql, query, []any{scope, keyHash},
|
||||
&record.ID,
|
||||
&record.Scope,
|
||||
&record.IdempotencyKeyHash,
|
||||
&record.RequestFingerprint,
|
||||
&record.Status,
|
||||
&responseStatus,
|
||||
&responseBody,
|
||||
&errorReason,
|
||||
&lockedUntil,
|
||||
&record.ExpiresAt,
|
||||
&record.CreatedAt,
|
||||
&record.UpdatedAt,
|
||||
)
|
||||
if errors.Is(err, sql.ErrNoRows) {
|
||||
return nil, nil
|
||||
}
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if responseStatus.Valid {
|
||||
v := int(responseStatus.Int64)
|
||||
record.ResponseStatus = &v
|
||||
}
|
||||
if responseBody.Valid {
|
||||
v := responseBody.String
|
||||
record.ResponseBody = &v
|
||||
}
|
||||
if errorReason.Valid {
|
||||
v := errorReason.String
|
||||
record.ErrorReason = &v
|
||||
}
|
||||
if lockedUntil.Valid {
|
||||
v := lockedUntil.Time
|
||||
record.LockedUntil = &v
|
||||
}
|
||||
return record, nil
|
||||
}
|
||||
|
||||
func (r *idempotencyRepository) TryReclaim(
|
||||
ctx context.Context,
|
||||
id int64,
|
||||
fromStatus string,
|
||||
now, newLockedUntil, newExpiresAt time.Time,
|
||||
) (bool, error) {
|
||||
query := `
|
||||
UPDATE idempotency_records
|
||||
SET status = $2,
|
||||
locked_until = $3,
|
||||
error_reason = NULL,
|
||||
updated_at = NOW(),
|
||||
expires_at = $4
|
||||
WHERE id = $1
|
||||
AND status = $5
|
||||
AND (locked_until IS NULL OR locked_until <= $6)
|
||||
`
|
||||
res, err := r.sql.ExecContext(ctx, query,
|
||||
id,
|
||||
service.IdempotencyStatusProcessing,
|
||||
newLockedUntil,
|
||||
newExpiresAt,
|
||||
fromStatus,
|
||||
now,
|
||||
)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
affected, err := res.RowsAffected()
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return affected > 0, nil
|
||||
}
|
||||
|
||||
func (r *idempotencyRepository) ExtendProcessingLock(
|
||||
ctx context.Context,
|
||||
id int64,
|
||||
requestFingerprint string,
|
||||
newLockedUntil,
|
||||
newExpiresAt time.Time,
|
||||
) (bool, error) {
|
||||
query := `
|
||||
UPDATE idempotency_records
|
||||
SET locked_until = $2,
|
||||
expires_at = $3,
|
||||
updated_at = NOW()
|
||||
WHERE id = $1
|
||||
AND status = $4
|
||||
AND request_fingerprint = $5
|
||||
`
|
||||
res, err := r.sql.ExecContext(
|
||||
ctx,
|
||||
query,
|
||||
id,
|
||||
newLockedUntil,
|
||||
newExpiresAt,
|
||||
service.IdempotencyStatusProcessing,
|
||||
requestFingerprint,
|
||||
)
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
affected, err := res.RowsAffected()
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return affected > 0, nil
|
||||
}
|
||||
|
||||
func (r *idempotencyRepository) MarkSucceeded(ctx context.Context, id int64, responseStatus int, responseBody string, expiresAt time.Time) error {
|
||||
query := `
|
||||
UPDATE idempotency_records
|
||||
SET status = $2,
|
||||
response_status = $3,
|
||||
response_body = $4,
|
||||
error_reason = NULL,
|
||||
locked_until = NULL,
|
||||
expires_at = $5,
|
||||
updated_at = NOW()
|
||||
WHERE id = $1
|
||||
`
|
||||
_, err := r.sql.ExecContext(ctx, query,
|
||||
id,
|
||||
service.IdempotencyStatusSucceeded,
|
||||
responseStatus,
|
||||
responseBody,
|
||||
expiresAt,
|
||||
)
|
||||
return err
|
||||
}
|
||||
|
||||
func (r *idempotencyRepository) MarkFailedRetryable(ctx context.Context, id int64, errorReason string, lockedUntil, expiresAt time.Time) error {
|
||||
query := `
|
||||
UPDATE idempotency_records
|
||||
SET status = $2,
|
||||
error_reason = $3,
|
||||
locked_until = $4,
|
||||
expires_at = $5,
|
||||
updated_at = NOW()
|
||||
WHERE id = $1
|
||||
`
|
||||
_, err := r.sql.ExecContext(ctx, query,
|
||||
id,
|
||||
service.IdempotencyStatusFailedRetryable,
|
||||
errorReason,
|
||||
lockedUntil,
|
||||
expiresAt,
|
||||
)
|
||||
return err
|
||||
}
|
||||
|
||||
func (r *idempotencyRepository) DeleteExpired(ctx context.Context, now time.Time, limit int) (int64, error) {
|
||||
if limit <= 0 {
|
||||
limit = 500
|
||||
}
|
||||
query := `
|
||||
WITH victims AS (
|
||||
SELECT id
|
||||
FROM idempotency_records
|
||||
WHERE expires_at <= $1
|
||||
ORDER BY expires_at ASC
|
||||
LIMIT $2
|
||||
)
|
||||
DELETE FROM idempotency_records
|
||||
WHERE id IN (SELECT id FROM victims)
|
||||
`
|
||||
res, err := r.sql.ExecContext(ctx, query, now, limit)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
return res.RowsAffected()
|
||||
}
|
||||
144
backend/internal/repository/idempotency_repo_integration_test.go
Normal file
144
backend/internal/repository/idempotency_repo_integration_test.go
Normal file
@@ -0,0 +1,144 @@
|
||||
//go:build integration
|
||||
|
||||
package repository
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/Wei-Shaw/sub2api/internal/service"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
func TestIdempotencyRepo_CreateProcessing_CompeteSameKey(t *testing.T) {
|
||||
tx := testTx(t)
|
||||
repo := &idempotencyRepository{sql: tx}
|
||||
ctx := context.Background()
|
||||
|
||||
now := time.Now().UTC()
|
||||
record := &service.IdempotencyRecord{
|
||||
Scope: uniqueTestValue(t, "idem-scope-create"),
|
||||
IdempotencyKeyHash: uniqueTestValue(t, "idem-hash"),
|
||||
RequestFingerprint: uniqueTestValue(t, "idem-fp"),
|
||||
Status: service.IdempotencyStatusProcessing,
|
||||
LockedUntil: ptrTime(now.Add(30 * time.Second)),
|
||||
ExpiresAt: now.Add(24 * time.Hour),
|
||||
}
|
||||
owner, err := repo.CreateProcessing(ctx, record)
|
||||
require.NoError(t, err)
|
||||
require.True(t, owner)
|
||||
require.NotZero(t, record.ID)
|
||||
|
||||
duplicate := &service.IdempotencyRecord{
|
||||
Scope: record.Scope,
|
||||
IdempotencyKeyHash: record.IdempotencyKeyHash,
|
||||
RequestFingerprint: uniqueTestValue(t, "idem-fp-other"),
|
||||
Status: service.IdempotencyStatusProcessing,
|
||||
LockedUntil: ptrTime(now.Add(30 * time.Second)),
|
||||
ExpiresAt: now.Add(24 * time.Hour),
|
||||
}
|
||||
owner, err = repo.CreateProcessing(ctx, duplicate)
|
||||
require.NoError(t, err)
|
||||
require.False(t, owner, "same scope+key hash should be de-duplicated")
|
||||
}
|
||||
|
||||
func TestIdempotencyRepo_TryReclaim_StatusAndLockWindow(t *testing.T) {
|
||||
tx := testTx(t)
|
||||
repo := &idempotencyRepository{sql: tx}
|
||||
ctx := context.Background()
|
||||
|
||||
now := time.Now().UTC()
|
||||
record := &service.IdempotencyRecord{
|
||||
Scope: uniqueTestValue(t, "idem-scope-reclaim"),
|
||||
IdempotencyKeyHash: uniqueTestValue(t, "idem-hash-reclaim"),
|
||||
RequestFingerprint: uniqueTestValue(t, "idem-fp-reclaim"),
|
||||
Status: service.IdempotencyStatusProcessing,
|
||||
LockedUntil: ptrTime(now.Add(10 * time.Second)),
|
||||
ExpiresAt: now.Add(24 * time.Hour),
|
||||
}
|
||||
owner, err := repo.CreateProcessing(ctx, record)
|
||||
require.NoError(t, err)
|
||||
require.True(t, owner)
|
||||
|
||||
require.NoError(t, repo.MarkFailedRetryable(
|
||||
ctx,
|
||||
record.ID,
|
||||
"RETRYABLE_FAILURE",
|
||||
now.Add(-2*time.Second),
|
||||
now.Add(24*time.Hour),
|
||||
))
|
||||
|
||||
newLockedUntil := now.Add(20 * time.Second)
|
||||
reclaimed, err := repo.TryReclaim(
|
||||
ctx,
|
||||
record.ID,
|
||||
service.IdempotencyStatusFailedRetryable,
|
||||
now,
|
||||
newLockedUntil,
|
||||
now.Add(24*time.Hour),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
require.True(t, reclaimed, "failed_retryable + expired lock should allow reclaim")
|
||||
|
||||
got, err := repo.GetByScopeAndKeyHash(ctx, record.Scope, record.IdempotencyKeyHash)
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, got)
|
||||
require.Equal(t, service.IdempotencyStatusProcessing, got.Status)
|
||||
require.NotNil(t, got.LockedUntil)
|
||||
require.True(t, got.LockedUntil.After(now))
|
||||
|
||||
require.NoError(t, repo.MarkFailedRetryable(
|
||||
ctx,
|
||||
record.ID,
|
||||
"RETRYABLE_FAILURE",
|
||||
now.Add(20*time.Second),
|
||||
now.Add(24*time.Hour),
|
||||
))
|
||||
|
||||
reclaimed, err = repo.TryReclaim(
|
||||
ctx,
|
||||
record.ID,
|
||||
service.IdempotencyStatusFailedRetryable,
|
||||
now,
|
||||
now.Add(40*time.Second),
|
||||
now.Add(24*time.Hour),
|
||||
)
|
||||
require.NoError(t, err)
|
||||
require.False(t, reclaimed, "within lock window should not reclaim")
|
||||
}
|
||||
|
||||
func TestIdempotencyRepo_StatusTransition_ToSucceeded(t *testing.T) {
|
||||
tx := testTx(t)
|
||||
repo := &idempotencyRepository{sql: tx}
|
||||
ctx := context.Background()
|
||||
|
||||
now := time.Now().UTC()
|
||||
record := &service.IdempotencyRecord{
|
||||
Scope: uniqueTestValue(t, "idem-scope-success"),
|
||||
IdempotencyKeyHash: uniqueTestValue(t, "idem-hash-success"),
|
||||
RequestFingerprint: uniqueTestValue(t, "idem-fp-success"),
|
||||
Status: service.IdempotencyStatusProcessing,
|
||||
LockedUntil: ptrTime(now.Add(10 * time.Second)),
|
||||
ExpiresAt: now.Add(24 * time.Hour),
|
||||
}
|
||||
owner, err := repo.CreateProcessing(ctx, record)
|
||||
require.NoError(t, err)
|
||||
require.True(t, owner)
|
||||
|
||||
require.NoError(t, repo.MarkSucceeded(ctx, record.ID, 200, `{"ok":true}`, now.Add(24*time.Hour)))
|
||||
|
||||
got, err := repo.GetByScopeAndKeyHash(ctx, record.Scope, record.IdempotencyKeyHash)
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, got)
|
||||
require.Equal(t, service.IdempotencyStatusSucceeded, got.Status)
|
||||
require.NotNil(t, got.ResponseStatus)
|
||||
require.Equal(t, 200, *got.ResponseStatus)
|
||||
require.NotNil(t, got.ResponseBody)
|
||||
require.Equal(t, `{"ok":true}`, *got.ResponseBody)
|
||||
require.Nil(t, got.LockedUntil)
|
||||
}
|
||||
|
||||
func ptrTime(v time.Time) *time.Time {
|
||||
return &v
|
||||
}
|
||||
@@ -60,6 +60,7 @@ var ProviderSet = wire.NewSet(
|
||||
NewAnnouncementRepository,
|
||||
NewAnnouncementReadRepository,
|
||||
NewUsageLogRepository,
|
||||
NewIdempotencyRepository,
|
||||
NewUsageCleanupRepository,
|
||||
NewDashboardAggregationRepository,
|
||||
NewSettingRepository,
|
||||
|
||||
Reference in New Issue
Block a user