1
0

node_bulk_dispatch_test.go 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503
  1. package service
  2. import (
  3. "context"
  4. "errors"
  5. "fmt"
  6. "sync/atomic"
  7. "testing"
  8. "github.com/google/uuid"
  9. "gorm.io/gorm"
  10. "github.com/mhsanaei/3x-ui/v3/internal/database"
  11. "github.com/mhsanaei/3x-ui/v3/internal/database/model"
  12. "github.com/mhsanaei/3x-ui/v3/internal/web/runtime"
  13. )
  14. // fakeNodeRuntime is a runtime.Runtime stub that counts the per-client dispatch
  15. // calls so a test can assert a bulk op does NOT stream one RPC per client.
  16. type fakeNodeRuntime struct {
  17. addInbound atomic.Int32
  18. delInbound atomic.Int32
  19. addClient atomic.Int32
  20. deleteClient atomic.Int32
  21. deleteUser atomic.Int32
  22. updateInbound atomic.Int32
  23. updateSubSort atomic.Int32
  24. updateUser atomic.Int32
  25. }
  26. func (f *fakeNodeRuntime) Name() string { return "fake-node" }
  27. func (f *fakeNodeRuntime) AddInbound(context.Context, *model.Inbound) error {
  28. f.addInbound.Add(1)
  29. return nil
  30. }
  31. func (f *fakeNodeRuntime) DelInbound(context.Context, *model.Inbound) error {
  32. f.delInbound.Add(1)
  33. return nil
  34. }
  35. func (f *fakeNodeRuntime) UpdateInbound(context.Context, *model.Inbound, *model.Inbound) error {
  36. f.updateInbound.Add(1)
  37. return nil
  38. }
  39. func (f *fakeNodeRuntime) SetInboundSubSortIndex(context.Context, *model.Inbound, int) error {
  40. f.updateSubSort.Add(1)
  41. return nil
  42. }
  43. func (f *fakeNodeRuntime) AddUser(context.Context, *model.Inbound, map[string]any) error { return nil }
  44. func (f *fakeNodeRuntime) RemoveUser(context.Context, *model.Inbound, string) error { return nil }
  45. func (f *fakeNodeRuntime) UpdateUser(context.Context, *model.Inbound, string, model.Client) error {
  46. f.updateUser.Add(1)
  47. return nil
  48. }
  49. func (f *fakeNodeRuntime) DeleteUser(context.Context, *model.Inbound, string) error {
  50. f.deleteUser.Add(1)
  51. return nil
  52. }
  53. func (f *fakeNodeRuntime) DeleteClient(context.Context, string) error {
  54. f.deleteClient.Add(1)
  55. return nil
  56. }
  57. func (f *fakeNodeRuntime) AddClient(context.Context, *model.Inbound, model.Client) error {
  58. f.addClient.Add(1)
  59. return nil
  60. }
  61. func (f *fakeNodeRuntime) RestartXray(context.Context) error { return nil }
  62. func (f *fakeNodeRuntime) ResetClientTraffic(context.Context, *model.Inbound, string) error {
  63. return nil
  64. }
  65. func (f *fakeNodeRuntime) ResetInboundTraffic(context.Context, *model.Inbound) error { return nil }
  66. func (f *fakeNodeRuntime) ResetAllTraffics(context.Context) error { return nil }
  67. // setupNodeRuntime wires an online node + a fake runtime override and returns the
  68. // node id and the fake so a test can drive the service node-dispatch path without
  69. // a network node.
  70. func setupNodeRuntime(t *testing.T) (int, *fakeNodeRuntime) {
  71. t.Helper()
  72. prev := runtime.GetManager()
  73. mgr := runtime.NewManager(runtime.LocalDeps{APIPort: func() int { return 0 }, SetNeedRestart: func() {}})
  74. runtime.SetManager(mgr)
  75. t.Cleanup(func() { runtime.SetManager(prev) })
  76. node := &model.Node{Name: "n1-" + t.Name(), Address: "127.0.0.1", Port: 2096, ApiToken: "tok", Enable: true, Status: "online"}
  77. if err := database.GetDB().Create(node).Error; err != nil {
  78. t.Fatalf("create node: %v", err)
  79. }
  80. t.Cleanup(func() {
  81. _ = database.GetDB().Where("id = ?", node.Id).Delete(&model.Node{}).Error
  82. })
  83. fake := &fakeNodeRuntime{}
  84. mgr.SetRuntimeOverride(node.Id, fake)
  85. return node.Id, fake
  86. }
  87. func nodeInbound(t *testing.T, nodeID, port int, clients []model.Client) *model.Inbound {
  88. t.Helper()
  89. if clients == nil {
  90. clients = []model.Client{}
  91. }
  92. ib := &model.Inbound{
  93. UserId: 1, NodeID: &nodeID, Tag: fmt.Sprintf("in-%d", port), Enable: true,
  94. Port: port, Protocol: model.VLESS, Settings: clientsSettings(t, clients),
  95. }
  96. if err := database.GetDB().Create(ib).Error; err != nil {
  97. t.Fatalf("create node inbound: %v", err)
  98. }
  99. if err := (&ClientService{}).SyncInbound(nil, ib.Id, clients); err != nil {
  100. t.Fatalf("seed SyncInbound: %v", err)
  101. }
  102. return ib
  103. }
  104. func makeNodeClients(n int) []model.Client {
  105. out := make([]model.Client, n)
  106. for i := range n {
  107. out[i] = model.Client{ID: uuid.NewString(), Email: fmt.Sprintf("nu-%05d@x", i), Enable: true}
  108. }
  109. return out
  110. }
  111. // TestNodeBulk_LargeAddFoldsToDirty: adding more than the threshold of clients to
  112. // an online node inbound must NOT stream one AddClient RPC per client; it marks
  113. // the node dirty so a single reconcile push converges it instead.
  114. func TestNodeBulk_LargeAddFoldsToDirty(t *testing.T) {
  115. setupBulkDB(t)
  116. nodeID, fake := setupNodeRuntime(t)
  117. ib := nodeInbound(t, nodeID, 30001, nil)
  118. svc := &ClientService{}
  119. inboundSvc := &InboundService{}
  120. add := makeNodeClients(nodeBulkPushThreshold + 10)
  121. if _, err := svc.AddInboundClient(inboundSvc, &model.Inbound{Id: ib.Id, Protocol: model.VLESS, Settings: clientsSettings(t, add)}); err != nil {
  122. t.Fatalf("AddInboundClient: %v", err)
  123. }
  124. if got := fake.addClient.Load(); got != 0 {
  125. t.Fatalf("large add streamed %d AddClient RPCs, want 0 (should fold to dirty)", got)
  126. }
  127. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  128. t.Fatalf("NodeSyncState: %v", err)
  129. } else if !dirty {
  130. t.Fatal("large add must mark the node dirty")
  131. }
  132. }
  133. // TestNodeBulk_SmallAddPushesLive: a small add stays on the live per-client path.
  134. func TestNodeBulk_SmallAddPushesLive(t *testing.T) {
  135. setupBulkDB(t)
  136. nodeID, fake := setupNodeRuntime(t)
  137. ib := nodeInbound(t, nodeID, 30002, nil)
  138. svc := &ClientService{}
  139. inboundSvc := &InboundService{}
  140. const small = 3
  141. add := makeNodeClients(small)
  142. if _, err := svc.AddInboundClient(inboundSvc, &model.Inbound{Id: ib.Id, Protocol: model.VLESS, Settings: clientsSettings(t, add)}); err != nil {
  143. t.Fatalf("AddInboundClient: %v", err)
  144. }
  145. if got := fake.addClient.Load(); got != int32(small) {
  146. t.Fatalf("small add streamed %d AddClient RPCs, want %d", got, small)
  147. }
  148. }
  149. func TestNodeBulkAdjustDoesNotPushBeforeFailedCommit(t *testing.T) {
  150. setupBulkDB(t)
  151. nodeID, fake := setupNodeRuntime(t)
  152. client := model.Client{
  153. ID: uuid.NewString(),
  154. Email: "txfail-adjust@x",
  155. Enable: true,
  156. ExpiryTime: 1_900_000_000_000,
  157. }
  158. nodeInbound(t, nodeID, 30022, []model.Client{client})
  159. db := database.GetDB()
  160. const callbackName = "bulk-adjust:fail-inbound-update"
  161. if err := db.Callback().Update().After("gorm:update").Register(callbackName, func(tx *gorm.DB) {
  162. if tx.Statement != nil && tx.Statement.Table == "inbounds" {
  163. tx.AddError(errors.New("injected bulk-adjust transaction failure"))
  164. }
  165. }); err != nil {
  166. t.Fatalf("register callback: %v", err)
  167. }
  168. t.Cleanup(func() { _ = db.Callback().Update().Remove(callbackName) })
  169. result, _, err := (&ClientService{}).BulkAdjust(&InboundService{}, []string{client.Email}, 1, 0, "")
  170. if err != nil {
  171. t.Fatalf("BulkAdjust: %v", err)
  172. }
  173. if result.Adjusted != 0 || len(result.Skipped) != 1 {
  174. t.Fatalf("BulkAdjust result = %+v, want one skipped client after injected failure", result)
  175. }
  176. if got := fake.updateUser.Load(); got != 0 {
  177. t.Fatalf("failed transaction pushed %d UpdateUser call(s) to the node, want 0", got)
  178. }
  179. }
  180. func TestNodeBulkDeleteDoesNotPushBeforeFailedCommit(t *testing.T) {
  181. setupBulkDB(t)
  182. nodeID, fake := setupNodeRuntime(t)
  183. client := model.Client{ID: uuid.NewString(), Email: "txfail-delete@x", Enable: true}
  184. nodeInbound(t, nodeID, 30023, []model.Client{client})
  185. db := database.GetDB()
  186. const callbackName = "bulk-delete:fail-inbound-update"
  187. if err := db.Callback().Update().After("gorm:update").Register(callbackName, func(tx *gorm.DB) {
  188. if tx.Statement != nil && tx.Statement.Table == "inbounds" {
  189. tx.AddError(errors.New("injected bulk-delete transaction failure"))
  190. }
  191. }); err != nil {
  192. t.Fatalf("register callback: %v", err)
  193. }
  194. t.Cleanup(func() { _ = db.Callback().Update().Remove(callbackName) })
  195. result, _, err := (&ClientService{}).BulkDelete(&InboundService{}, []string{client.Email}, true)
  196. if err != nil {
  197. t.Fatalf("BulkDelete: %v", err)
  198. }
  199. if result.Deleted != 0 || len(result.Skipped) != 1 {
  200. t.Fatalf("BulkDelete result = %+v, want one skipped client after injected failure", result)
  201. }
  202. if got := fake.deleteClient.Load() + fake.deleteUser.Load(); got != 0 {
  203. t.Fatalf("failed transaction pushed %d delete call(s) to the node, want 0", got)
  204. }
  205. if isClientEmailTombstoned(client.Email) {
  206. t.Fatal("failed bulk delete left a live tombstone")
  207. }
  208. }
  209. func TestNodeBulkSmallDeleteRemovesWholeRemoteClient(t *testing.T) {
  210. setupBulkDB(t)
  211. nodeID, fake := setupNodeRuntime(t)
  212. client := model.Client{ID: uuid.NewString(), Email: "full-delete@x", Enable: true}
  213. nodeInbound(t, nodeID, 30024, []model.Client{client})
  214. var record model.ClientRecord
  215. if err := database.GetDB().Where("email = ?", client.Email).First(&record).Error; err != nil {
  216. t.Fatalf("load client record: %v", err)
  217. }
  218. result, _, err := (&ClientService{}).BulkDelete(&InboundService{}, []string{client.Email}, true)
  219. if err != nil {
  220. t.Fatalf("BulkDelete: %v", err)
  221. }
  222. if result.Deleted != 1 || len(result.Skipped) != 0 {
  223. t.Fatalf("BulkDelete result = %+v, want one deleted client", result)
  224. }
  225. if got := fake.deleteClient.Load(); got != 1 {
  226. t.Fatalf("remote DeleteClient calls = %d, want 1", got)
  227. }
  228. if got := fake.deleteUser.Load(); got != 0 {
  229. t.Fatalf("remote DeleteUser detach calls = %d, want 0 for full deletion", got)
  230. }
  231. var records, links int64
  232. if err := database.GetDB().Model(&model.ClientRecord{}).Where("email = ?", client.Email).Count(&records).Error; err != nil {
  233. t.Fatalf("count client records: %v", err)
  234. }
  235. if err := database.GetDB().Model(&model.ClientInbound{}).Where("client_id = ?", record.Id).Count(&links).Error; err != nil {
  236. t.Fatalf("count client links: %v", err)
  237. }
  238. if records != 0 || links != 0 {
  239. t.Fatalf("bulk delete left records=%d links=%d, want 0/0", records, links)
  240. }
  241. }
  242. func TestNodeBulkDeleteTreatsMissingSettingsClientAsAlreadyDeleted(t *testing.T) {
  243. setupBulkDB(t)
  244. nodeID, fake := setupNodeRuntime(t)
  245. client := model.Client{ID: uuid.NewString(), Email: "drifted-delete@x", Enable: true}
  246. ib := nodeInbound(t, nodeID, 30025, []model.Client{client})
  247. // Simulate a stale normalized link after the client has already disappeared
  248. // from the inbound settings JSON.
  249. if err := database.GetDB().Model(&model.Inbound{}).Where("id = ?", ib.Id).
  250. Update("settings", clientsSettings(t, nil)).Error; err != nil {
  251. t.Fatalf("drift inbound settings: %v", err)
  252. }
  253. result, _, err := (&ClientService{}).BulkDelete(&InboundService{}, []string{client.Email}, true)
  254. if err != nil {
  255. t.Fatalf("BulkDelete: %v", err)
  256. }
  257. if result.Deleted != 1 || len(result.Skipped) != 0 {
  258. t.Fatalf("BulkDelete result = %+v, want one deleted client", result)
  259. }
  260. if got := fake.deleteClient.Load(); got != 1 {
  261. t.Fatalf("remote DeleteClient calls = %d, want 1", got)
  262. }
  263. var records, links int64
  264. if err := database.GetDB().Model(&model.ClientRecord{}).Where("email = ?", client.Email).Count(&records).Error; err != nil {
  265. t.Fatalf("count client records: %v", err)
  266. }
  267. if err := database.GetDB().Model(&model.ClientInbound{}).Where("inbound_id = ?", ib.Id).Count(&links).Error; err != nil {
  268. t.Fatalf("count client links: %v", err)
  269. }
  270. if records != 0 || links != 0 {
  271. t.Fatalf("bulk delete left records=%d links=%d, want 0/0", records, links)
  272. }
  273. if !isClientEmailTombstoned(client.Email) {
  274. t.Fatal("successful bulk delete withdrew the client tombstone")
  275. }
  276. t.Cleanup(func() { withdrawClientTombstones(client.Email) })
  277. }
  278. func TestNodeBulkDeleteCompletesAcrossPresentAndMissingSettings(t *testing.T) {
  279. setupBulkDB(t)
  280. nodeID, fake := setupNodeRuntime(t)
  281. client := model.Client{ID: uuid.NewString(), Email: "mixed-delete@x", Enable: true}
  282. drifted := nodeInbound(t, nodeID, 30026, []model.Client{client})
  283. nodeInbound(t, nodeID, 30027, []model.Client{client})
  284. if err := database.GetDB().Model(&model.Inbound{}).Where("id = ?", drifted.Id).
  285. Update("settings", clientsSettings(t, nil)).Error; err != nil {
  286. t.Fatalf("drift inbound settings: %v", err)
  287. }
  288. result, _, err := (&ClientService{}).BulkDelete(&InboundService{}, []string{client.Email}, true)
  289. if err != nil {
  290. t.Fatalf("BulkDelete: %v", err)
  291. }
  292. if result.Deleted != 1 || len(result.Skipped) != 0 {
  293. t.Fatalf("BulkDelete result = %+v, want one deleted client", result)
  294. }
  295. if got := fake.deleteClient.Load(); got != 2 {
  296. t.Fatalf("remote DeleteClient calls = %d, want one per node inbound", got)
  297. }
  298. }
  299. func TestNodeBulkDeleteMalformedSettingsWithdrawsTombstone(t *testing.T) {
  300. setupBulkDB(t)
  301. nodeID, fake := setupNodeRuntime(t)
  302. client := model.Client{ID: uuid.NewString(), Email: "malformed-delete@x", Enable: true}
  303. ib := nodeInbound(t, nodeID, 30028, []model.Client{client})
  304. if err := database.GetDB().Model(&model.Inbound{}).Where("id = ?", ib.Id).
  305. Update("settings", `{"clients":[`).Error; err != nil {
  306. t.Fatalf("break inbound settings: %v", err)
  307. }
  308. result, _, err := (&ClientService{}).BulkDelete(&InboundService{}, []string{client.Email}, true)
  309. if err != nil {
  310. t.Fatalf("BulkDelete: %v", err)
  311. }
  312. if result.Deleted != 0 || len(result.Skipped) != 1 {
  313. t.Fatalf("BulkDelete result = %+v, want one skipped client", result)
  314. }
  315. if got := fake.deleteClient.Load() + fake.deleteUser.Load(); got != 0 {
  316. t.Fatalf("malformed settings pushed %d delete call(s) to the node, want 0", got)
  317. }
  318. if isClientEmailTombstoned(client.Email) {
  319. t.Fatal("failed bulk delete left a live tombstone")
  320. }
  321. }
  322. func TestNodeUpdateInboundClientNoopSkipsRuntimeAndDirty(t *testing.T) {
  323. setupBulkDB(t)
  324. nodeID, fake := setupNodeRuntime(t)
  325. client := model.Client{
  326. ID: uuid.NewString(),
  327. Email: "noop@x",
  328. SubID: "sub-noop",
  329. Enable: true,
  330. CreatedAt: 111,
  331. UpdatedAt: 222,
  332. }
  333. ib := nodeInbound(t, nodeID, 30020, []model.Client{client})
  334. svc := &ClientService{}
  335. inboundSvc := &InboundService{}
  336. if _, err := svc.UpdateInboundClient(inboundSvc, &model.Inbound{
  337. Id: ib.Id,
  338. Protocol: model.VLESS,
  339. Settings: clientsSettings(t, []model.Client{client}),
  340. }, client.Email); err != nil {
  341. t.Fatalf("UpdateInboundClient: %v", err)
  342. }
  343. if got := fake.updateUser.Load(); got != 0 {
  344. t.Fatalf("no-op update streamed %d UpdateUser RPCs, want 0", got)
  345. }
  346. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  347. t.Fatalf("NodeSyncState: %v", err)
  348. } else if dirty {
  349. t.Fatal("no-op update must not mark the node dirty")
  350. }
  351. reloaded, err := inboundSvc.GetInbound(ib.Id)
  352. if err != nil {
  353. t.Fatalf("GetInbound: %v", err)
  354. }
  355. if reloaded.Settings != ib.Settings {
  356. t.Fatal("no-op update rewrote inbound settings")
  357. }
  358. }
  359. func TestNodeUpdateInboundClientLivePushKeepsDirtyBackup(t *testing.T) {
  360. setupBulkDB(t)
  361. nodeID, fake := setupNodeRuntime(t)
  362. client := model.Client{
  363. ID: uuid.NewString(),
  364. Email: "edit@x",
  365. SubID: "sub-edit",
  366. Enable: true,
  367. CreatedAt: 111,
  368. UpdatedAt: 222,
  369. }
  370. ib := nodeInbound(t, nodeID, 30021, []model.Client{client})
  371. edited := client
  372. edited.Comment = "changed"
  373. svc := &ClientService{}
  374. inboundSvc := &InboundService{}
  375. if _, err := svc.UpdateInboundClient(inboundSvc, &model.Inbound{
  376. Id: ib.Id,
  377. Protocol: model.VLESS,
  378. Settings: clientsSettings(t, []model.Client{edited}),
  379. }, client.Email); err != nil {
  380. t.Fatalf("UpdateInboundClient: %v", err)
  381. }
  382. if got := fake.updateUser.Load(); got != 1 {
  383. t.Fatalf("edit streamed %d UpdateUser RPCs, want 1", got)
  384. }
  385. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  386. t.Fatalf("NodeSyncState: %v", err)
  387. } else if !dirty {
  388. t.Fatal("successful live update should keep node dirty as reconcile backup")
  389. }
  390. }
  391. // TestNodeBulk_LargeDeleteFoldsToDirty: deleting more than the threshold from an
  392. // online node inbound must fold into a reconcile rather than per-client deletes.
  393. func TestNodeBulk_LargeDeleteFoldsToDirty(t *testing.T) {
  394. setupBulkDB(t)
  395. nodeID, fake := setupNodeRuntime(t)
  396. seed := makeNodeClients(nodeBulkPushThreshold + 10)
  397. nodeInbound(t, nodeID, 30003, seed)
  398. svc := &ClientService{}
  399. inboundSvc := &InboundService{}
  400. emails := make([]string, len(seed))
  401. for i := range seed {
  402. emails[i] = seed[i].Email
  403. }
  404. if _, _, err := svc.BulkDelete(inboundSvc, emails, false); err != nil {
  405. t.Fatalf("BulkDelete: %v", err)
  406. }
  407. if got := fake.deleteClient.Load() + fake.deleteUser.Load(); got != 0 {
  408. t.Fatalf("large delete streamed %d delete RPCs, want 0 (should fold to dirty)", got)
  409. }
  410. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  411. t.Fatalf("NodeSyncState: %v", err)
  412. } else if !dirty {
  413. t.Fatal("large delete must mark the node dirty")
  414. }
  415. }
  416. func TestDelInbound_NodeSelectedModeDeletesRemoteImmediately(t *testing.T) {
  417. setupBulkDB(t)
  418. nodeID, fake := setupNodeRuntime(t)
  419. if err := database.GetDB().Model(&model.Node{}).Where("id = ?", nodeID).
  420. Updates(map[string]any{
  421. "inbound_sync_mode": "selected",
  422. "inbound_tags": []string{"other-tag"},
  423. }).Error; err != nil {
  424. t.Fatalf("set selected mode: %v", err)
  425. }
  426. ib := nodeInbound(t, nodeID, 30004, makeNodeClients(1))
  427. needRestart, err := (&InboundService{}).DelInbound(ib.Id)
  428. if err != nil {
  429. t.Fatalf("DelInbound: %v", err)
  430. }
  431. if needRestart {
  432. t.Fatal("node-owned delete should not request local restart")
  433. }
  434. if got := fake.delInbound.Load(); got != 1 {
  435. t.Fatalf("node-owned delete streamed %d DelInbound RPCs, want 1", got)
  436. }
  437. var count int64
  438. if err := database.GetDB().Model(&model.Inbound{}).Where("id = ?", ib.Id).Count(&count).Error; err != nil {
  439. t.Fatalf("count inbound: %v", err)
  440. }
  441. if count != 0 {
  442. t.Fatalf("deleted inbound row count = %d, want 0", count)
  443. }
  444. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  445. t.Fatalf("NodeSyncState: %v", err)
  446. } else if !dirty {
  447. t.Fatal("node-owned delete should still mark the node dirty as reconcile backup")
  448. }
  449. }