xinyin025/3x-ui
1
0
Fork 0
mirror of https://github.com/MHSanaei/3x-ui.git synced 2026-08-20 10:00:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add per-client external link controls (#5650)

Browse Source 
* Add enable toggle for external client links

* Document external link enable API fields

* Extend external client link metadata

* Fix external subscription cache status updates

* fix(sub): address the review on per-client external link controls

Blocking: the expiry filter dropped legacy rows. expiry_time was added
without a default, so AutoMigrate makes it nullable and backfills NULL,
and `expiry_time = 0 OR expiry_time > ?` is false for NULL under
three-valued logic — every external link written before the upgrade
vanished from all subscriptions. Add `default:0` on expiry_time and
last_fetch_at, make the predicate NULL-tolerant, and backfill the NULLs
a pre-fix build could already have written.

Rework fetch-status recording. It ran inside the singleflight in-flight
window, so every goroutine parked on the shared fetch waited for a DB
write to commit on the public, unauthenticated subscription path — and
because it was keyed on the row id, waiters and cache hits recorded
nothing, leaving rows that lost the race stuck on "Not fetched yet"
forever. fetchSubscriptionLinks now reports whether it did the network
fetch and expandEntry records afterwards, off the serving path, keyed on
kind+value so every row sharing the URL is stamped by the one fetch.
Keying on value also closes the recycled-rowid hazard: saves delete and
re-insert rows, and SQLite reuses rowids, so an in-flight write could
land on an unrelated client's row. The write no longer discards its
error either.

Drop the inert id round-trip. The panel never sent it, and the byId
branch was guarded by the exact kind+value equality that byKindValue
already keys on, so it could not change an outcome. Matching on
kind+value alone is what actually preserves fetch status across saves.

Reject a negative expiryTime instead of storing a row that is silently
invisible in every subscription — elsewhere a negative expiryTime means
"a duration from first use", so an API caller reusing that convention
got no error and no links.

Drop the ~50 lines of .client-form-* / .client-inbounds-field CSS that
no component renders; it is leftover from the WireGuard PR this one was
split from.

i18n: reuse the already-translated pages.inbounds.leaveBlankToNeverExpire
instead of shipping an English duplicate under pages.clients, and
translate namePrefix, lastFetchAt, lastFetchError and neverFetched into
all 12 non-English locales.

Cover the persistence path that had no test: the fetch-status writer over
a real DB against a failing then a succeeding server, a cache hit writing
nothing, and the negative-expiry rejection.

---------

Co-authored-by: MHSanaei <ho3ein.sanaei@gmail.com>
This commit is contained in:
jason zhang
2026-08-18 19:55:04 +08:00
committed by GitHub
parent 708a69acde
commit abd320994a
29 changed files with 728 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files
internal/sub/external_subscription_test.go
+124 -4
View File
@@ -10,6 +10,9 @@ import (
"sync/atomic"
"testing"
"time"
"github.com/mhsanaei/3x-ui/v3/internal/database"
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
)
func resetSubscriptionCache(t *testing.T) {
@@ -44,7 +47,7 @@ func TestFetchSubscriptionLinksSharesConcurrentRefresh(t *testing.T) {
var wg sync.WaitGroup
for range callers {
wg.Go(func() {
results <- fetchSubscriptionLinks(srv.URL)
results <- fetchSubscriptionLinks(srv.URL).links
})
}
@@ -73,7 +76,7 @@ func TestFetchSubscriptionLinksBoundsCacheSize(t *testing.T) {
defer srv.Close()
for i := range subscriptionCacheCapacity + 1 {
links := fetchSubscriptionLinks(srv.URL + "?id=" + strconv.Itoa(i))
links := fetchSubscriptionLinks(srv.URL + "?id=" + strconv.Itoa(i)).links
if len(links) != 1 {
t.Fatalf("links at %d = %#v", i, links)
}
@@ -122,12 +125,12 @@ func TestFetchSubscriptionLinksSharesStaleResultAfterRefreshFailure(t *testing.T
var wg sync.WaitGroup
for range callers {
wg.Go(func() {
results <- fetchSubscriptionLinks(staleURL)
results <- fetchSubscriptionLinks(staleURL).links
})
}
time.Sleep(100 * time.Millisecond)
if links := fetchSubscriptionLinks(srv.URL + "/fresh"); len(links) != 1 || links[0] != "vless://fresh@example.com:443" {
if links := fetchSubscriptionLinks(srv.URL + "/fresh").links; len(links) != 1 || links[0] != "vless://fresh@example.com:443" {
t.Fatalf("fresh links = %#v", links)
}
close(release)
@@ -178,3 +181,120 @@ func TestDoFetchSubscriptionLinks_AcceptsBodyAtLimit(t *testing.T) {
t.Fatalf("links = %v, want [%q]", links, link)
}
}
func TestRecordExternalSubscriptionFetchStampsEveryRowForTheURL(t *testing.T) {
initMutDB(t)
resetSubscriptionCache(t)
db := database.GetDB()
var failing atomic.Bool
failing.Store(true)
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if failing.Load() {
w.WriteHeader(http.StatusBadGateway)
return
}
_, _ = w.Write([]byte("vless://uuid@example.com:443#Node"))
}))
defer srv.Close()
owners := []model.ClientRecord{
{Email: "one@example.com", SubID: "sub-fetch", UUID: "uuid-1", Enable: true},
{Email: "two@example.com", SubID: "sub-fetch", UUID: "uuid-2", Enable: true},
}
for i := range owners {
if err := db.Create(&owners[i]).Error; err != nil {
t.Fatalf("seed client %d: %v", i, err)
}
row := model.ClientExternalLink{
ClientId: owners[i].Id,
Kind: model.ExternalLinkKindSubscription,
Value: srv.URL,
}
if err := db.Create(&row).Error; err != nil {
t.Fatalf("seed external link %d: %v", i, err)
}
}
svc := NewSubService("")
entries, err := svc.getClientExternalLinksBySubId("sub-fetch")
if err != nil {
t.Fatalf("getClientExternalLinksBySubId: %v", err)
}
if len(entries) != 2 {
t.Fatalf("entries = %d, want 2", len(entries))
}
for _, e := range entries {
expandEntry(e)
}
var rows []model.ClientExternalLink
if err := db.Where("value = ?", srv.URL).Find(&rows).Error; err != nil {
t.Fatalf("read rows: %v", err)
}
if len(rows) != 2 {
t.Fatalf("rows = %d, want 2", len(rows))
}
for _, row := range rows {
if row.LastFetchAt <= 0 {
t.Fatalf("row %d lastFetchAt = %d, want a stamped timestamp", row.Id, row.LastFetchAt)
}
if row.LastFetchError != errBadStatus.Error() {
t.Fatalf("row %d lastFetchError = %q, want %q", row.Id, row.LastFetchError, errBadStatus)
}
}
failing.Store(false)
resetSubscriptionCache(t)
for _, e := range entries {
expandEntry(e)
}
if err := db.Where("value = ?", srv.URL).Find(&rows).Error; err != nil {
t.Fatalf("re-read rows: %v", err)
}
for _, row := range rows {
if row.LastFetchError != "" {
t.Fatalf("row %d lastFetchError = %q, want cleared after a good fetch", row.Id, row.LastFetchError)
}
if row.LastFetchAt <= 0 {
t.Fatalf("row %d lastFetchAt = %d, want a stamped timestamp", row.Id, row.LastFetchAt)
}
}
}
func TestExpandEntryCacheHitWritesNothing(t *testing.T) {
initMutDB(t)
resetSubscriptionCache(t)
db := database.GetDB()
const subURL = "https://provider.example/cached"
rec := model.ClientRecord{Email: "cached@example.com", SubID: "sub-cached", UUID: "uuid", Enable: true}
if err := db.Create(&rec).Error; err != nil {
t.Fatalf("seed client: %v", err)
}
row := model.ClientExternalLink{ClientId: rec.Id, Kind: model.ExternalLinkKindSubscription, Value: subURL}
if err := db.Create(&row).Error; err != nil {
t.Fatalf("seed external link: %v", err)
}
subscriptionCache.Lock()
subscriptionCache.m[subURL] = subscriptionCacheEntry{
links: []string{"vless://uuid@example.com:443#Node"},
fetchedAt: time.Now(),
}
subscriptionCache.Unlock()
if got := expandEntry(externalLinkEntry{Kind: model.ExternalLinkKindSubscription, Value: subURL}); len(got) != 1 {
t.Fatalf("expandEntry = %#v, want the cached link", got)
}
var after model.ClientExternalLink
if err := db.First(&after, row.Id).Error; err != nil {
t.Fatalf("read row: %v", err)
}
if after.LastFetchAt != 0 || after.LastFetchError != "" {
t.Fatalf("cache hit wrote fetch status: %#v", after)
}
}