Files
pangolin/server/internal/devices/service.go
T
wangjia 315c343ed5
ci-pangolin / Lint — shellcheck (push) Successful in 7s
ci-pangolin / OpenAPI Sync Check (push) Successful in 17s
ci-pangolin / Redline Scan — 脱敏 (UI 文案) (push) Successful in 6s
ci-pangolin / Flutter — analyze + test (push) Failing after 14s
ci-pangolin / Portable SQL — 可移植性 (mysql/sqlite) (push) Successful in 5s
ci-pangolin / Codegen Drift — token 生成物未漂移 (push) Successful in 6s
ci-pangolin / Go — build + test (push) Successful in 11s
ci-pangolin / E2E Smoke — L4 进程级端到端 (push) Successful in 14s
ci-pangolin / Go — integration (mysql/redis testcontainers) (push) Failing after 4m3s
ci-pangolin / Golden — 视觉回归 (components + auth) (push) Successful in 14s
feat(devices): 设备默认名「平台简写·主机名」+ 支持重命名(1.0.13)
① 默认名:DeviceIdentity 改「平台简写(Win/Mac/Linux/iOS/Andr)·主机名」,主机名截
   到 8、总长≈12(替代裸主机名,更短)。
② 重命名:新端点 POST /v1/me/devices/{uuid}/rename(Service.RenameDevice 校验归属+
   截 64);store.UpdateName;客户端 account_api.renameDevice + provider.rename +
   「我的设备」⋯ 菜单加「重命名」+ 输入弹窗;l10n(zh/en)。
③ 版本 1.0.13。
测试:server RenameDevice(归属/空名/404)+ 客户端 rename widget;全量 go/flutter 绿。

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-29 09:12:36 +08:00

507 lines
16 KiB
Go

package devices
import (
"context"
"encoding/json"
"fmt"
"strings"
"time"
"github.com/wangjia/pangolin/server/internal/apierr"
)
// CredentialRevoker recalls a device's data-plane credential (its dp_uuid) on the
// node side when the device is cleared. Per migration 000015 the credential is
// per-device, so revocation targets the dp_uuid. Defined consumer-side to avoid an
// import cycle; nodes.Service satisfies it (push Revoke to the holding node(s) +
// drop the connect_credentials row). Best-effort: node resync reconciles misses.
type CredentialRevoker interface {
RevokeDevice(ctx context.Context, dpUUID string) error
}
// NoopRevoker is the default CredentialRevoker (tests / before nodes wiring).
// It records the dp_uuids passed so callers/tests can assert on it.
type NoopRevoker struct {
Calls []string
}
// RevokeDevice implements CredentialRevoker by recording the dp_uuid.
func (n *NoopRevoker) RevokeDevice(_ context.Context, dpUUID string) error {
n.Calls = append(n.Calls, dpUUID)
return nil
}
// SessionPort provides per-device session reads/revocations. Satisfied by
// sessions.Store; injected to keep packages decoupled.
type SessionPort interface {
LastLoginByDevice(ctx context.Context, userID int64) (map[int64]time.Time, error)
RevokeByDevice(ctx context.Context, userID, deviceID int64) ([]string, error)
}
// JTIRevoker drops a refresh JTI from the Redis whitelist. Satisfied by
// auth.TokenManager (so a force-logged-out device's tokens stop refreshing).
type JTIRevoker interface {
Revoke(ctx context.Context, jti string) error
}
// Service implements the devices business logic.
type Service struct {
store *Store
revoker CredentialRevoker
sessions SessionPort // nil until wired (P2/P3)
jtiRevoker JTIRevoker // nil until wired (P3)
}
// NewService creates a Service. If revoker is nil a NoopRevoker is used so the
// module can be wired and tested before nodes is available.
func NewService(store *Store, revoker CredentialRevoker) *Service {
if revoker == nil {
revoker = &NoopRevoker{}
}
return &Service{store: store, revoker: revoker}
}
// SetSessionPort / SetJTIRevoker / SetCredentialRevoker wire collaborators after
// construction (main keeps devices, sessions, auth and nodes decoupled).
func (svc *Service) SetSessionPort(s SessionPort) { svc.sessions = s }
func (svc *Service) SetJTIRevoker(r JTIRevoker) { svc.jtiRevoker = r }
func (svc *Service) SetCredentialRevoker(r CredentialRevoker) {
if r != nil {
svc.revoker = r
}
}
// Device is the API representation of a registered device.
type Device struct {
UUID string `json:"uuid"`
Name string `json:"name"`
Platform string `json:"platform"`
LastSeen *string `json:"last_seen"` // RFC 3339 UTC; null when never seen
ClientVersion string `json:"client_version,omitempty"` // 000016
Online bool `json:"online"` // last_seen within onlineWindow (data-plane active)
LastLogin *string `json:"last_login"` // most recent session created_at; null when none
}
// onlineWindow: a device is "online" if its last_seen (touched by connect +
// periodic usage reports) is within this window.
const onlineWindow = 3 * time.Minute
func toAPIDevice(d DeviceRow) Device {
out := Device{UUID: d.UUID, Name: d.Name, Platform: d.Platform}
if d.LastSeen.Valid {
s := d.LastSeen.Time.UTC().Format(time.RFC3339)
out.LastSeen = &s
out.Online = time.Since(d.LastSeen.Time) < onlineWindow
}
if d.ClientVersion.Valid {
out.ClientVersion = d.ClientVersion.String
}
return out
}
// ListDevices returns the user's devices with online status (from last_seen) and
// last-login time (most recent session, when a LastLoginSource is wired).
func (svc *Service) ListDevices(ctx context.Context, userID int64) ([]Device, *apierr.Error) {
rows, err := svc.store.ListByUser(ctx, userID)
if err != nil {
return nil, apierr.ErrInternal
}
var lastLogin map[int64]time.Time
if svc.sessions != nil {
if m, e := svc.sessions.LastLoginByDevice(ctx, userID); e == nil {
lastLogin = m
}
}
out := make([]Device, 0, len(rows))
for _, r := range rows {
d := toAPIDevice(r)
if t, ok := lastLogin[r.ID]; ok {
s := t.UTC().Format(time.RFC3339)
d.LastLogin = &s
}
out = append(out, d)
}
return out, nil
}
// RegisterInput carries the inputs for implicit device registration, called by
// nodes.connect when a client presents a device_id.
type RegisterInput struct {
UserID int64
DeviceUUID string
Name string // client-reported, may come from UA; truncated to 64 runes
Platform string // ios | android | windows | macos | linux
ClientVersion string // app version, stored/refreshed on devices.client_version
MaxDevices int // plan cap; 0 = no cap
}
// RegisterIfAbsent registers a device on first sight and refreshes last_seen on
// subsequent sights. The device count is checked against MaxDevices before
// inserting a brand-new device. Per-user serialization is achieved by locking
// the users row for the duration of the transaction.
// Returns the internal device id (for session binding), the API device, or an error.
func (svc *Service) RegisterIfAbsent(ctx context.Context, in RegisterInput) (int64, *Device, *apierr.Error) {
uuid := strings.TrimSpace(in.DeviceUUID)
if uuid == "" {
return 0, nil, apierr.ErrBadRequest
}
platform, ok := normalizePlatform(in.Platform)
if !ok {
return 0, nil, apierr.ErrBadRequest
}
name := normalizeName(in.Name, platform)
tx, err := svc.store.BeginTx(ctx)
if err != nil {
return 0, nil, apierr.ErrInternal
}
committed := false
defer func() {
if !committed {
_ = tx.Rollback()
}
}()
// Lock the owning user to serialize concurrent registrations.
exists, status, err := svc.store.lockUser(ctx, tx, in.UserID)
if err != nil {
return 0, nil, apierr.ErrInternal
}
if !exists {
return 0, nil, apierr.ErrUnauthorized
}
if status == "banned" {
return 0, nil, apierr.ErrAccountBanned
}
existing, err := svc.store.findDeviceByUUIDTx(ctx, tx, uuid)
if err != nil {
return 0, nil, apierr.ErrInternal
}
if existing != nil {
if existing.UserID != in.UserID {
// UUID is client-generated; a collision across users is treated as
// a conflict rather than silently rebinding the device.
return 0, nil, apierr.ErrForbidden
}
if err := svc.store.touchLastSeenTx(ctx, tx, existing.ID, in.ClientVersion); err != nil {
return 0, nil, apierr.ErrInternal
}
if err := tx.Commit(); err != nil {
return 0, nil, apierr.ErrInternal
}
committed = true
d := toAPIDevice(*existing)
return existing.ID, &d, nil
}
// New device: enforce the plan device cap.
count, err := svc.store.countDevicesTx(ctx, tx, in.UserID)
if err != nil {
return 0, nil, apierr.ErrInternal
}
if in.MaxDevices > 0 && count >= in.MaxDevices {
return 0, nil, errDeviceLimit(in.MaxDevices)
}
row, err := svc.store.insertDeviceTx(ctx, tx, uuid, in.UserID, name, platform, in.ClientVersion)
if err != nil {
return 0, nil, apierr.ErrInternal
}
if err := svc.store.writeAuditLogTx(ctx, tx,
fmt.Sprintf("user:%d", in.UserID), "device.register", "device:"+uuid,
deviceAuditMeta(name, platform)); err != nil {
_ = err // audit failure must not abort the business transaction
}
if err := tx.Commit(); err != nil {
return 0, nil, apierr.ErrInternal
}
committed = true
d := toAPIDevice(*row)
return row.ID, &d, nil
}
// DeleteDevice hard-deletes a device (transactionally, with an audit_log entry)
// and then triggers per-user credential recall on the node side.
//
// - device not found → 404 NOT_FOUND
// - device owned by another user → 403 FORBIDDEN (does not delete)
func (svc *Service) DeleteDevice(ctx context.Context, userID int64, deviceUUID string) *apierr.Error {
uuid := strings.TrimSpace(deviceUUID)
if uuid == "" {
return apierr.ErrBadRequest
}
// Resolve + ownership check (non-tx) so sessions can be revoked BEFORE the
// delete tx: SQLite (_txlock=immediate) holds a write lock for the tx, so a
// session write on another pool connection would deadlock against it.
dev, err := svc.store.FindByUUID(ctx, uuid)
if err != nil {
return apierr.ErrInternal
}
if dev == nil {
return apierr.ErrNotFound
}
if dev.UserID != userID {
return apierr.ErrForbidden
}
// Revoke the device's sessions (drop their refresh JTIs from Redis) while the
// rows still exist; the device delete then cascades them away.
svc.revokeDeviceSessions(ctx, userID, dev.ID)
tx, err := svc.store.BeginTx(ctx)
if err != nil {
return apierr.ErrInternal
}
committed := false
defer func() {
if !committed {
_ = tx.Rollback()
}
}()
if err := svc.store.deleteDeviceTx(ctx, tx, dev.ID); err != nil {
return apierr.ErrInternal
}
if err := svc.store.writeAuditLogTx(ctx, tx,
fmt.Sprintf("user:%d", userID), "device.delete", "device:"+uuid,
deviceAuditMeta(dev.Name, dev.Platform)); err != nil {
_ = err // audit failure must not abort the delete
}
if err := tx.Commit(); err != nil {
return apierr.ErrInternal
}
committed = true
// Recall the device's data-plane credential so a live connection is dropped
// too. Best-effort: the device row is already gone; a transient failure is
// reconciled by node resync, so we never fail the request. (Sessions were
// already revoked above, before the cascade removed their rows.)
if dev.DpUUID.Valid && dev.DpUUID.String != "" {
if err := svc.revoker.RevokeDevice(ctx, dev.DpUUID.String); err != nil {
_ = err
}
}
return nil
}
// ForceLogout revokes a device's login sessions (kicks it offline; the device
// stays in the list). The device's data-plane credential is left intact so the
// user can simply log in again.
//
// - device not found → 404 NOT_FOUND
// - device owned by another user → 403 FORBIDDEN
func (svc *Service) ForceLogout(ctx context.Context, userID int64, deviceUUID string) *apierr.Error {
uuid := strings.TrimSpace(deviceUUID)
if uuid == "" {
return apierr.ErrBadRequest
}
dev, err := svc.store.FindByUUID(ctx, uuid)
if err != nil {
return apierr.ErrInternal
}
if dev == nil {
return apierr.ErrNotFound
}
if dev.UserID != userID {
return apierr.ErrForbidden
}
svc.revokeDeviceSessions(ctx, userID, dev.ID)
return nil
}
// RenameDevice sets a device's display name (ownership-checked). Empty name →
// 400; name is trimmed + truncated to 64 runes.
//
// - device not found → 404
// - device owned by another user → 403
func (svc *Service) RenameDevice(ctx context.Context, userID int64, deviceUUID, rawName string) *apierr.Error {
uuid := strings.TrimSpace(deviceUUID)
name := strings.TrimSpace(rawName)
if uuid == "" || name == "" {
return apierr.ErrBadRequest
}
if r := []rune(name); len(r) > 64 {
name = string(r[:64])
}
dev, err := svc.store.FindByUUID(ctx, uuid)
if err != nil {
return apierr.ErrInternal
}
if dev == nil {
return apierr.ErrNotFound
}
if dev.UserID != userID {
return apierr.ErrForbidden
}
if err := svc.store.UpdateName(ctx, dev.ID, name); err != nil {
return apierr.ErrInternal
}
return nil
}
// revokeDeviceSessions marks all of a device's sessions revoked and drops their
// refresh JTIs from the Redis whitelist. Best-effort.
func (svc *Service) revokeDeviceSessions(ctx context.Context, userID, deviceID int64) {
if svc.sessions == nil {
return
}
jtis, err := svc.sessions.RevokeByDevice(ctx, userID, deviceID)
if err != nil {
return
}
if svc.jtiRevoker != nil {
for _, jti := range jtis {
_ = svc.jtiRevoker.Revoke(ctx, jti)
}
}
}
// SubscriptionInfo is the /v1/me subscription summary provided by this module.
type SubscriptionInfo struct {
PlanCode string `json:"plan_code"`
ExpiresAt *string `json:"expires_at"` // RFC 3339 UTC; null for free fallback
Source string `json:"source"`
}
// SubscriptionSummary resolves the user's effective plan and returns the /v1/me
// subscription summary.
func (svc *Service) SubscriptionSummary(ctx context.Context, userID int64) (*SubscriptionInfo, *apierr.Error) {
p, apiErr := svc.ResolvePlan(ctx, userID)
if apiErr != nil {
return nil, apiErr
}
info := &SubscriptionInfo{PlanCode: p.PlanCode, Source: p.Source}
if p.ExpiresAt != nil {
s := p.ExpiresAt.UTC().Format(time.RFC3339)
info.ExpiresAt = &s
}
return info, nil
}
// ResolvePlan loads the user's status + subscriptions and resolves the effective
// plan. It is the shared entry point used by SubscriptionMiddleware and
// SubscriptionSummary.
func (svc *Service) ResolvePlan(ctx context.Context, userID int64) (Plan, *apierr.Error) {
status, exists, err := svc.store.GetUserStatus(ctx, userID)
if err != nil {
return Plan{}, apierr.ErrInternal
}
if !exists {
return Plan{}, apierr.ErrUnauthorized
}
subs, err := svc.store.GetSubscriptions(ctx, userID)
if err != nil {
return Plan{}, apierr.ErrInternal
}
free, err := svc.store.GetFreePlan(ctx)
if err != nil {
return Plan{}, apierr.ErrInternal
}
return resolveEffectivePlan(time.Now().UTC(), status, subs, free)
}
// resolveEffectivePlan is the pure plan-resolution rule (no I/O), unit-tested
// directly:
//
// - banned account → ErrAccountBanned
// - among subscriptions with expires_at>now, pick the highest tier;
// ties broken by the latest expiry
// - no active subscription → free fallback (ExpiresAt nil)
//
// now must be in UTC. The boundary is strict: expires_at == now counts as expired.
func resolveEffectivePlan(now time.Time, status string, subs []effSub, free Plan) (Plan, *apierr.Error) {
if status == "banned" {
return Plan{}, apierr.ErrAccountBanned
}
var best *effSub
for i := range subs {
s := &subs[i]
if !s.ExpiresAt.After(now) {
continue // expired (strict UTC boundary)
}
if best == nil {
best = s
continue
}
bt, st := planTier(best.PlanCode), planTier(s.PlanCode)
if st > bt || (st == bt && s.ExpiresAt.After(best.ExpiresAt)) {
best = s
}
}
if best == nil {
return free, nil
}
exp := best.ExpiresAt.UTC()
p := Plan{
PlanCode: best.PlanCode,
ExpiresAt: &exp,
MaxDevices: best.MaxDevices,
AdGate: best.AdGate,
Source: best.Source,
}
if best.DailyMinutes.Valid {
m := int(best.DailyMinutes.Int64)
p.DailyMinutes = &m
}
return p, nil
}
// --------------------------------------------------------------------------
// helpers
// --------------------------------------------------------------------------
// normalizePlatform validates/canonicalizes a platform string against the
// devices.platform ENUM (ios/android/windows/macos). Note: the OpenAPI Device
// schema also lists "linux", but the DB ENUM (migration #1) does not include
// it, so "linux" is rejected until the schema is widened.
func normalizePlatform(s string) (string, bool) {
switch strings.ToLower(strings.TrimSpace(s)) {
case "ios":
return "ios", true
case "android":
return "android", true
case "windows":
return "windows", true
case "macos":
return "macos", true
case "linux":
return "linux", true
}
return "", false
}
// normalizeName trims the client-reported name, falls back to the platform when
// empty, and truncates to the devices.name VARCHAR(64) limit (by rune).
func normalizeName(name, platform string) string {
name = strings.TrimSpace(name)
if name == "" {
name = platform
}
r := []rune(name)
if len(r) > 64 {
name = string(r[:64])
}
return name
}
// deviceAuditMeta builds a compact JSON meta blob for audit_log.
func deviceAuditMeta(name, platform string) string {
b, _ := json.Marshal(map[string]string{"name": name, "platform": platform})
return string(b)
}
// errDeviceLimit builds a bilingual device-cap error that embeds the limit.
func errDeviceLimit(max int) *apierr.Error {
return &apierr.Error{
Code: "DEVICE_LIMIT_EXCEEDED",
MessageZH: fmt.Sprintf("设备数量已达上限(%d 台),请先在其他设备上退出后重试", max),
MessageEn: fmt.Sprintf("Device limit reached (%d devices). Please remove another device and try again.", max),
}
}