node_bulk_dispatch_test.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  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. }
  206. func TestNodeBulkSmallDeleteRemovesWholeRemoteClient(t *testing.T) {
  207. setupBulkDB(t)
  208. nodeID, fake := setupNodeRuntime(t)
  209. client := model.Client{ID: uuid.NewString(), Email: "full-delete@x", Enable: true}
  210. nodeInbound(t, nodeID, 30024, []model.Client{client})
  211. result, _, err := (&ClientService{}).BulkDelete(&InboundService{}, []string{client.Email}, true)
  212. if err != nil {
  213. t.Fatalf("BulkDelete: %v", err)
  214. }
  215. if result.Deleted != 1 || len(result.Skipped) != 0 {
  216. t.Fatalf("BulkDelete result = %+v, want one deleted client", result)
  217. }
  218. if got := fake.deleteClient.Load(); got != 1 {
  219. t.Fatalf("remote DeleteClient calls = %d, want 1", got)
  220. }
  221. if got := fake.deleteUser.Load(); got != 0 {
  222. t.Fatalf("remote DeleteUser detach calls = %d, want 0 for full deletion", got)
  223. }
  224. }
  225. func TestNodeUpdateInboundClientNoopSkipsRuntimeAndDirty(t *testing.T) {
  226. setupBulkDB(t)
  227. nodeID, fake := setupNodeRuntime(t)
  228. client := model.Client{
  229. ID: uuid.NewString(),
  230. Email: "noop@x",
  231. SubID: "sub-noop",
  232. Enable: true,
  233. CreatedAt: 111,
  234. UpdatedAt: 222,
  235. }
  236. ib := nodeInbound(t, nodeID, 30020, []model.Client{client})
  237. svc := &ClientService{}
  238. inboundSvc := &InboundService{}
  239. if _, err := svc.UpdateInboundClient(inboundSvc, &model.Inbound{
  240. Id: ib.Id,
  241. Protocol: model.VLESS,
  242. Settings: clientsSettings(t, []model.Client{client}),
  243. }, client.Email); err != nil {
  244. t.Fatalf("UpdateInboundClient: %v", err)
  245. }
  246. if got := fake.updateUser.Load(); got != 0 {
  247. t.Fatalf("no-op update streamed %d UpdateUser RPCs, want 0", got)
  248. }
  249. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  250. t.Fatalf("NodeSyncState: %v", err)
  251. } else if dirty {
  252. t.Fatal("no-op update must not mark the node dirty")
  253. }
  254. reloaded, err := inboundSvc.GetInbound(ib.Id)
  255. if err != nil {
  256. t.Fatalf("GetInbound: %v", err)
  257. }
  258. if reloaded.Settings != ib.Settings {
  259. t.Fatal("no-op update rewrote inbound settings")
  260. }
  261. }
  262. func TestNodeUpdateInboundClientLivePushKeepsDirtyBackup(t *testing.T) {
  263. setupBulkDB(t)
  264. nodeID, fake := setupNodeRuntime(t)
  265. client := model.Client{
  266. ID: uuid.NewString(),
  267. Email: "edit@x",
  268. SubID: "sub-edit",
  269. Enable: true,
  270. CreatedAt: 111,
  271. UpdatedAt: 222,
  272. }
  273. ib := nodeInbound(t, nodeID, 30021, []model.Client{client})
  274. edited := client
  275. edited.Comment = "changed"
  276. svc := &ClientService{}
  277. inboundSvc := &InboundService{}
  278. if _, err := svc.UpdateInboundClient(inboundSvc, &model.Inbound{
  279. Id: ib.Id,
  280. Protocol: model.VLESS,
  281. Settings: clientsSettings(t, []model.Client{edited}),
  282. }, client.Email); err != nil {
  283. t.Fatalf("UpdateInboundClient: %v", err)
  284. }
  285. if got := fake.updateUser.Load(); got != 1 {
  286. t.Fatalf("edit streamed %d UpdateUser RPCs, want 1", got)
  287. }
  288. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  289. t.Fatalf("NodeSyncState: %v", err)
  290. } else if !dirty {
  291. t.Fatal("successful live update should keep node dirty as reconcile backup")
  292. }
  293. }
  294. // TestNodeBulk_LargeDeleteFoldsToDirty: deleting more than the threshold from an
  295. // online node inbound must fold into a reconcile rather than per-client deletes.
  296. func TestNodeBulk_LargeDeleteFoldsToDirty(t *testing.T) {
  297. setupBulkDB(t)
  298. nodeID, fake := setupNodeRuntime(t)
  299. seed := makeNodeClients(nodeBulkPushThreshold + 10)
  300. nodeInbound(t, nodeID, 30003, seed)
  301. svc := &ClientService{}
  302. inboundSvc := &InboundService{}
  303. emails := make([]string, len(seed))
  304. for i := range seed {
  305. emails[i] = seed[i].Email
  306. }
  307. if _, _, err := svc.BulkDelete(inboundSvc, emails, false); err != nil {
  308. t.Fatalf("BulkDelete: %v", err)
  309. }
  310. if got := fake.deleteUser.Load(); got != 0 {
  311. t.Fatalf("large delete streamed %d DeleteUser RPCs, want 0 (should fold to dirty)", got)
  312. }
  313. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  314. t.Fatalf("NodeSyncState: %v", err)
  315. } else if !dirty {
  316. t.Fatal("large delete must mark the node dirty")
  317. }
  318. }
  319. func TestDelInbound_NodeSelectedModeDeletesRemoteImmediately(t *testing.T) {
  320. setupBulkDB(t)
  321. nodeID, fake := setupNodeRuntime(t)
  322. if err := database.GetDB().Model(&model.Node{}).Where("id = ?", nodeID).
  323. Updates(map[string]any{
  324. "inbound_sync_mode": "selected",
  325. "inbound_tags": []string{"other-tag"},
  326. }).Error; err != nil {
  327. t.Fatalf("set selected mode: %v", err)
  328. }
  329. ib := nodeInbound(t, nodeID, 30004, makeNodeClients(1))
  330. needRestart, err := (&InboundService{}).DelInbound(ib.Id)
  331. if err != nil {
  332. t.Fatalf("DelInbound: %v", err)
  333. }
  334. if needRestart {
  335. t.Fatal("node-owned delete should not request local restart")
  336. }
  337. if got := fake.delInbound.Load(); got != 1 {
  338. t.Fatalf("node-owned delete streamed %d DelInbound RPCs, want 1", got)
  339. }
  340. var count int64
  341. if err := database.GetDB().Model(&model.Inbound{}).Where("id = ?", ib.Id).Count(&count).Error; err != nil {
  342. t.Fatalf("count inbound: %v", err)
  343. }
  344. if count != 0 {
  345. t.Fatalf("deleted inbound row count = %d, want 0", count)
  346. }
  347. if _, _, dirty, _, err := (&NodeService{}).NodeSyncState(nodeID); err != nil {
  348. t.Fatalf("NodeSyncState: %v", err)
  349. } else if !dirty {
  350. t.Fatal("node-owned delete should still mark the node dirty as reconcile backup")
  351. }
  352. }