@bsv/overlay-express 2.4.2 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/LICENSE.txt +57 -27
  2. package/README.md +141 -56
  3. package/dist/cjs/mod.d.ts +11 -0
  4. package/dist/cjs/mod.d.ts.map +1 -0
  5. package/dist/cjs/mod.js.map +1 -1
  6. package/dist/cjs/package.json +26 -13
  7. package/dist/cjs/src/ArcadeProvider.d.ts +37 -0
  8. package/dist/cjs/src/ArcadeProvider.d.ts.map +1 -0
  9. package/dist/cjs/src/ArcadeProvider.js.map +1 -1
  10. package/dist/cjs/src/BanAwareDiscoveryStorage.d.ts +36 -0
  11. package/dist/cjs/src/BanAwareDiscoveryStorage.d.ts.map +1 -0
  12. package/dist/cjs/src/BanAwareDiscoveryStorage.js +5 -4
  13. package/dist/cjs/src/BanAwareDiscoveryStorage.js.map +1 -1
  14. package/dist/cjs/src/BanAwareLookupWrapper.d.ts +31 -0
  15. package/dist/cjs/src/BanAwareLookupWrapper.d.ts.map +1 -0
  16. package/dist/cjs/src/BanAwareLookupWrapper.js +3 -2
  17. package/dist/cjs/src/BanAwareLookupWrapper.js.map +1 -1
  18. package/dist/cjs/src/BanAwareTopicManager.d.ts +28 -0
  19. package/dist/cjs/src/BanAwareTopicManager.d.ts.map +1 -0
  20. package/dist/cjs/src/BanAwareTopicManager.js +3 -2
  21. package/dist/cjs/src/BanAwareTopicManager.js.map +1 -1
  22. package/dist/cjs/src/BanService.d.ts +79 -0
  23. package/dist/cjs/src/BanService.d.ts.map +1 -0
  24. package/dist/cjs/src/BanService.js +18 -5
  25. package/dist/cjs/src/BanService.js.map +1 -1
  26. package/dist/cjs/src/ChaintracksProvider.d.ts +29 -0
  27. package/dist/cjs/src/ChaintracksProvider.d.ts.map +1 -0
  28. package/dist/cjs/src/ChaintracksProvider.js +1 -1
  29. package/dist/cjs/src/ChaintracksProvider.js.map +1 -1
  30. package/dist/cjs/src/JanitorService.d.ts +135 -0
  31. package/dist/cjs/src/JanitorService.d.ts.map +1 -0
  32. package/dist/cjs/src/JanitorService.js +168 -48
  33. package/dist/cjs/src/JanitorService.js.map +1 -1
  34. package/dist/cjs/src/OverlayExpress.d.ts +472 -0
  35. package/dist/cjs/src/OverlayExpress.d.ts.map +1 -0
  36. package/dist/cjs/src/OverlayExpress.js +483 -193
  37. package/dist/cjs/src/OverlayExpress.js.map +1 -1
  38. package/dist/cjs/src/OverlayMonitor.d.ts +197 -0
  39. package/dist/cjs/src/OverlayMonitor.d.ts.map +1 -0
  40. package/dist/cjs/src/OverlayMonitor.js +6 -4
  41. package/dist/cjs/src/OverlayMonitor.js.map +1 -1
  42. package/dist/cjs/src/ProviderChainBroadcaster.d.ts +18 -0
  43. package/dist/cjs/src/ProviderChainBroadcaster.d.ts.map +1 -0
  44. package/dist/cjs/src/ProviderChainBroadcaster.js +7 -3
  45. package/dist/cjs/src/ProviderChainBroadcaster.js.map +1 -1
  46. package/dist/cjs/src/ReorgStream.d.ts +74 -0
  47. package/dist/cjs/src/ReorgStream.d.ts.map +1 -0
  48. package/dist/cjs/src/ReorgStream.js +14 -6
  49. package/dist/cjs/src/ReorgStream.js.map +1 -1
  50. package/dist/cjs/src/ResourceBoundedLookupWrapper.d.ts +26 -0
  51. package/dist/cjs/src/ResourceBoundedLookupWrapper.d.ts.map +1 -0
  52. package/dist/cjs/src/ResourceBoundedLookupWrapper.js +70 -0
  53. package/dist/cjs/src/ResourceBoundedLookupWrapper.js.map +1 -0
  54. package/dist/cjs/src/generalGuide.md.d.ts +3 -0
  55. package/dist/cjs/src/generalGuide.md.d.ts.map +1 -0
  56. package/dist/cjs/src/generalGuide.md.js.map +1 -1
  57. package/dist/cjs/src/makeUserInterface.d.ts +22 -0
  58. package/dist/cjs/src/makeUserInterface.d.ts.map +1 -0
  59. package/dist/cjs/src/makeUserInterface.js +4 -4
  60. package/dist/cjs/src/makeUserInterface.js.map +1 -1
  61. package/dist/cjs/src/security/edgePolicy.d.ts +84 -0
  62. package/dist/cjs/src/security/edgePolicy.d.ts.map +1 -0
  63. package/dist/cjs/src/security/edgePolicy.js +533 -0
  64. package/dist/cjs/src/security/edgePolicy.js.map +1 -0
  65. package/dist/esm/mod.js.map +1 -1
  66. package/dist/esm/src/ArcadeProvider.js.map +1 -1
  67. package/dist/esm/src/BanAwareDiscoveryStorage.js +5 -4
  68. package/dist/esm/src/BanAwareDiscoveryStorage.js.map +1 -1
  69. package/dist/esm/src/BanAwareLookupWrapper.js +3 -2
  70. package/dist/esm/src/BanAwareLookupWrapper.js.map +1 -1
  71. package/dist/esm/src/BanAwareTopicManager.js +3 -2
  72. package/dist/esm/src/BanAwareTopicManager.js.map +1 -1
  73. package/dist/esm/src/BanService.js +18 -5
  74. package/dist/esm/src/BanService.js.map +1 -1
  75. package/dist/esm/src/ChaintracksProvider.js +1 -1
  76. package/dist/esm/src/ChaintracksProvider.js.map +1 -1
  77. package/dist/esm/src/JanitorService.js +146 -19
  78. package/dist/esm/src/JanitorService.js.map +1 -1
  79. package/dist/esm/src/OverlayExpress.js +465 -176
  80. package/dist/esm/src/OverlayExpress.js.map +1 -1
  81. package/dist/esm/src/ProviderChainBroadcaster.js +7 -3
  82. package/dist/esm/src/ProviderChainBroadcaster.js.map +1 -1
  83. package/dist/esm/src/ReorgStream.js +14 -6
  84. package/dist/esm/src/ReorgStream.js.map +1 -1
  85. package/dist/esm/src/ResourceBoundedLookupWrapper.js +70 -0
  86. package/dist/esm/src/ResourceBoundedLookupWrapper.js.map +1 -0
  87. package/dist/esm/src/makeUserInterface.js +3 -4
  88. package/dist/esm/src/makeUserInterface.js.map +1 -1
  89. package/dist/esm/src/security/edgePolicy.js +522 -0
  90. package/dist/esm/src/security/edgePolicy.js.map +1 -0
  91. package/dist/types/mod.d.ts +1 -1
  92. package/dist/types/mod.d.ts.map +1 -1
  93. package/dist/types/src/ArcadeProvider.d.ts.map +1 -1
  94. package/dist/types/src/BanAwareDiscoveryStorage.d.ts.map +1 -1
  95. package/dist/types/src/BanAwareLookupWrapper.d.ts.map +1 -1
  96. package/dist/types/src/BanAwareTopicManager.d.ts.map +1 -1
  97. package/dist/types/src/BanService.d.ts +2 -4
  98. package/dist/types/src/BanService.d.ts.map +1 -1
  99. package/dist/types/src/ChaintracksProvider.d.ts.map +1 -1
  100. package/dist/types/src/JanitorService.d.ts +21 -1
  101. package/dist/types/src/JanitorService.d.ts.map +1 -1
  102. package/dist/types/src/OverlayExpress.d.ts +54 -2
  103. package/dist/types/src/OverlayExpress.d.ts.map +1 -1
  104. package/dist/types/src/OverlayMonitor.d.ts.map +1 -1
  105. package/dist/types/src/ProviderChainBroadcaster.d.ts.map +1 -1
  106. package/dist/types/src/ReorgStream.d.ts.map +1 -1
  107. package/dist/types/src/ResourceBoundedLookupWrapper.d.ts +26 -0
  108. package/dist/types/src/ResourceBoundedLookupWrapper.d.ts.map +1 -0
  109. package/dist/types/src/generalGuide.md.d.ts +1 -1
  110. package/dist/types/src/generalGuide.md.d.ts.map +1 -1
  111. package/dist/types/src/makeUserInterface.d.ts +1 -2
  112. package/dist/types/src/makeUserInterface.d.ts.map +1 -1
  113. package/dist/types/src/security/edgePolicy.d.ts +84 -0
  114. package/dist/types/src/security/edgePolicy.d.ts.map +1 -0
  115. package/package.json +47 -25
  116. package/dist/cjs/tsconfig.cjs.tsbuildinfo +0 -1
  117. package/dist/esm/tsconfig.esm.tsbuildinfo +0 -1
  118. package/dist/types/tsconfig.types.tsbuildinfo +0 -1
  119. package/mod.ts +0 -47
  120. package/src/ArcadeProvider.ts +0 -232
  121. package/src/BanAwareDiscoveryStorage.ts +0 -91
  122. package/src/BanAwareLookupWrapper.ts +0 -95
  123. package/src/BanAwareTopicManager.ts +0 -87
  124. package/src/BanService.ts +0 -154
  125. package/src/ChaintracksProvider.ts +0 -79
  126. package/src/JanitorService.ts +0 -423
  127. package/src/OverlayExpress.ts +0 -2479
  128. package/src/OverlayMonitor.ts +0 -817
  129. package/src/ProviderChainBroadcaster.ts +0 -108
  130. package/src/ReorgStream.ts +0 -221
  131. package/src/__tests__/BanAwareDiscoveryStorage.test.ts +0 -131
  132. package/src/__tests__/BanAwareLookupWrapper.test.ts +0 -255
  133. package/src/__tests__/BanAwareTopicManager.test.ts +0 -132
  134. package/src/__tests__/BanService.test.ts +0 -310
  135. package/src/__tests__/InMemoryMigrationSource.test.ts +0 -11
  136. package/src/__tests__/JanitorService.test.ts +0 -941
  137. package/src/__tests__/OverlayExpress.test.ts +0 -1300
  138. package/src/__tests__/OverlayMonitor.test.ts +0 -255
  139. package/src/__tests__/OverlayProviders.live.test.ts +0 -43
  140. package/src/__tests__/OverlayProviders.test.ts +0 -123
  141. package/src/__tests__/README.md +0 -105
  142. package/src/__tests__/ReorgStream.test.ts +0 -66
  143. package/src/__tests__/makeUserInterface.test.ts +0 -193
  144. package/src/__tests__/setup.ts +0 -36
  145. package/src/auth-express-middleware.d.ts +0 -16
  146. package/src/generalGuide.md.ts +0 -74
  147. package/src/makeUserInterface.ts +0 -1224
@@ -1,1300 +0,0 @@
1
- import { describe, it, expect, jest, beforeEach } from '@jest/globals'
2
- import OverlayExpress from '../OverlayExpress.js'
3
- import Knex from 'knex'
4
- import { MongoClient } from 'mongodb'
5
- import { TopicManager, LookupService } from '@bsv/overlay'
6
- import { ChainTracker } from '@bsv/sdk'
7
- import * as DiscoveryServices from '@bsv/overlay-discovery-services'
8
-
9
- // Mock dependencies
10
- jest.mock('knex')
11
- jest.mock('mongodb')
12
- jest.mock('@bsv/overlay')
13
- jest.mock('@bsv/sdk')
14
- jest.mock('@bsv/overlay-discovery-services')
15
-
16
- /** Creates a mock MongoDB Db object with a collection stub that supports BanService */
17
- function createMockDbValue (): Record<string, any> {
18
- const mockCollection = {
19
- createIndex: jest.fn<any>().mockResolvedValue(undefined),
20
- find: jest.fn<any>().mockReturnValue({ sort: jest.fn<any>().mockReturnValue({ toArray: jest.fn<any>().mockResolvedValue([]) }), toArray: jest.fn<any>().mockResolvedValue([]) }),
21
- findOne: jest.fn<any>().mockResolvedValue(null),
22
- updateOne: jest.fn<any>().mockResolvedValue({}),
23
- deleteOne: jest.fn<any>().mockResolvedValue({}),
24
- countDocuments: jest.fn<any>().mockResolvedValue(0)
25
- }
26
- return {
27
- collection: jest.fn<any>().mockReturnValue(mockCollection),
28
- command: jest.fn<any>().mockResolvedValue({ ok: 1 }),
29
- databaseName: 'TestService_lookup_services'
30
- }
31
- }
32
-
33
- describe('OverlayExpress', () => {
34
- let overlayExpress: OverlayExpress
35
-
36
- beforeEach(() => {
37
- jest.clearAllMocks()
38
- overlayExpress = new OverlayExpress(
39
- 'TestService',
40
- 'test-private-key-123',
41
- 'test.example.com'
42
- )
43
- })
44
-
45
- describe('constructor', () => {
46
- it('should create instance with required parameters', () => {
47
- const instance = new OverlayExpress(
48
- 'MyService',
49
- 'private-key',
50
- 'example.com'
51
- )
52
-
53
- expect(instance.name).toBe('MyService')
54
- expect(instance.privateKey).toBe('private-key')
55
- expect(instance.advertisableFQDN).toBe('example.com')
56
- expect(instance.app).toBeDefined()
57
- })
58
-
59
- it('should generate random admin token if not provided', () => {
60
- const instance = new OverlayExpress(
61
- 'MyService',
62
- 'private-key',
63
- 'example.com'
64
- )
65
-
66
- const token = instance.getAdminToken()
67
- expect(token).toBeDefined()
68
- expect(typeof token).toBe('string')
69
- expect(token.length).toBeGreaterThan(0)
70
- })
71
-
72
- it('should use provided admin token', () => {
73
- const customToken = 'my-custom-token-123'
74
- const instance = new OverlayExpress(
75
- 'MyService',
76
- 'private-key',
77
- 'example.com',
78
- customToken
79
- )
80
-
81
- expect(instance.getAdminToken()).toBe(customToken)
82
- })
83
-
84
- it('should initialize with default values', () => {
85
- expect(overlayExpress.port).toBe(3000)
86
- expect(overlayExpress.network).toBe('main')
87
- expect(overlayExpress.enableGASPSync).toBe(true)
88
- expect(overlayExpress.verboseRequestLogging).toBe(false)
89
- expect(overlayExpress.managers).toEqual({})
90
- expect(overlayExpress.services).toEqual({})
91
- })
92
- })
93
-
94
- describe('getAdminToken', () => {
95
- it('should return the admin token', () => {
96
- const token = overlayExpress.getAdminToken()
97
- expect(typeof token).toBe('string')
98
- expect(token.length).toBeGreaterThan(0)
99
- })
100
-
101
- it('should return consistent token', () => {
102
- const token1 = overlayExpress.getAdminToken()
103
- const token2 = overlayExpress.getAdminToken()
104
- expect(token1).toBe(token2)
105
- })
106
- })
107
-
108
- describe('configurePort', () => {
109
- it('should set the port', () => {
110
- overlayExpress.configurePort(8080)
111
- expect(overlayExpress.port).toBe(8080)
112
- })
113
-
114
- it('should accept different port numbers', () => {
115
- overlayExpress.configurePort(3001)
116
- expect(overlayExpress.port).toBe(3001)
117
-
118
- overlayExpress.configurePort(5000)
119
- expect(overlayExpress.port).toBe(5000)
120
- })
121
- })
122
-
123
- describe('configureWebUI', () => {
124
- it('should set web UI config', () => {
125
- const config = {
126
- host: 'https://example.com',
127
- primaryColor: '#ff0000'
128
- }
129
- overlayExpress.configureWebUI(config)
130
- expect(overlayExpress.webUIConfig).toEqual(config)
131
- })
132
-
133
- it('should accept empty config', () => {
134
- overlayExpress.configureWebUI({})
135
- expect(overlayExpress.webUIConfig).toEqual({})
136
- })
137
- })
138
-
139
- describe('configureJanitor', () => {
140
- it('should merge janitor config', () => {
141
- overlayExpress.configureJanitor({
142
- requestTimeoutMs: 5000
143
- })
144
- expect(overlayExpress.janitorConfig.requestTimeoutMs).toBe(5000)
145
- expect(overlayExpress.janitorConfig.hostDownRevokeScore).toBe(3) // default
146
- })
147
-
148
- it('should update hostDownRevokeScore', () => {
149
- overlayExpress.configureJanitor({
150
- hostDownRevokeScore: 5
151
- })
152
- expect(overlayExpress.janitorConfig.hostDownRevokeScore).toBe(5)
153
- })
154
-
155
- it('should update both config values', () => {
156
- overlayExpress.configureJanitor({
157
- requestTimeoutMs: 20000,
158
- hostDownRevokeScore: 10
159
- })
160
- expect(overlayExpress.janitorConfig.requestTimeoutMs).toBe(20000)
161
- expect(overlayExpress.janitorConfig.hostDownRevokeScore).toBe(10)
162
- })
163
- })
164
-
165
- describe('configureLogger', () => {
166
- it('should set custom logger', () => {
167
- const customLogger = {
168
- log: jest.fn(),
169
- warn: jest.fn(),
170
- error: jest.fn()
171
- } as any
172
-
173
- overlayExpress.configureLogger(customLogger)
174
- expect(overlayExpress.logger).toBe(customLogger)
175
- })
176
- })
177
-
178
- describe('configureNetwork', () => {
179
- it('should set network to main', () => {
180
- overlayExpress.configureNetwork('main')
181
- expect(overlayExpress.network).toBe('main')
182
- })
183
-
184
- it('should set network to test', () => {
185
- overlayExpress.configureNetwork('test')
186
- expect(overlayExpress.network).toBe('test')
187
- })
188
-
189
- it('should reinitialize chainTracker for network', () => {
190
- overlayExpress.configureNetwork('test')
191
- expect(overlayExpress.chainTracker).toBeDefined()
192
- })
193
- })
194
-
195
- describe('configureChainTracker', () => {
196
- it('should set custom chain tracker', () => {
197
- const mockChainTracker: ChainTracker = Object.create(null)
198
- overlayExpress.configureChainTracker(mockChainTracker)
199
- expect(overlayExpress.chainTracker).toBe(mockChainTracker)
200
- })
201
-
202
- it('should accept "scripts only" mode', () => {
203
- overlayExpress.configureChainTracker('scripts only')
204
- expect(overlayExpress.chainTracker).toBe('scripts only')
205
- })
206
- })
207
-
208
- describe('configureArcApiKey', () => {
209
- it('should set ARC API key', () => {
210
- overlayExpress.configureArcApiKey('test-api-key')
211
- expect(overlayExpress.arcApiKey).toBe('test-api-key')
212
- })
213
- })
214
-
215
- describe('configureEnableGASPSync', () => {
216
- it('should enable GASP sync', () => {
217
- overlayExpress.configureEnableGASPSync(true)
218
- expect(overlayExpress.enableGASPSync).toBe(true)
219
- })
220
-
221
- it('should disable GASP sync', () => {
222
- overlayExpress.configureEnableGASPSync(false)
223
- expect(overlayExpress.enableGASPSync).toBe(false)
224
- })
225
- })
226
-
227
- describe('configureVerboseRequestLogging', () => {
228
- it('should enable verbose logging', () => {
229
- overlayExpress.configureVerboseRequestLogging(true)
230
- expect(overlayExpress.verboseRequestLogging).toBe(true)
231
- })
232
-
233
- it('should disable verbose logging', () => {
234
- overlayExpress.configureVerboseRequestLogging(false)
235
- expect(overlayExpress.verboseRequestLogging).toBe(false)
236
- })
237
- })
238
-
239
- describe('configureKnex', () => {
240
- it('should configure Knex with object config', async () => {
241
- const mockKnex = { raw: jest.fn() }
242
- ;(Knex as any).mockReturnValue(mockKnex)
243
-
244
- const config = {
245
- client: 'mysql2',
246
- connection: {
247
- host: 'localhost',
248
- user: 'test',
249
- password: 'test',
250
- database: 'test'
251
- }
252
- }
253
-
254
- await overlayExpress.configureKnex(config)
255
- expect(overlayExpress.knex).toBeDefined()
256
- expect(overlayExpress.knex).toBe(mockKnex)
257
- })
258
-
259
- it('should configure Knex with connection string', async () => {
260
- const mockKnex = { raw: jest.fn() }
261
- ;(Knex as any).mockReturnValue(mockKnex)
262
-
263
- const connectionString = 'mysql://user:pass@localhost:3306/db'
264
-
265
- await overlayExpress.configureKnex(connectionString)
266
- expect(overlayExpress.knex).toBeDefined()
267
- expect(Knex).toHaveBeenCalledWith({
268
- client: 'mysql2',
269
- connection: connectionString
270
- })
271
- })
272
- })
273
-
274
- describe('configureMongo', () => {
275
- it('should configure MongoDB connection', async () => {
276
- // @ts-expect-error - Mock resolved value
277
- const mockConnect = jest.fn().mockResolvedValue(undefined)
278
- const mockDb = jest.fn().mockReturnValue(createMockDbValue())
279
- const mockClient = {
280
- connect: mockConnect,
281
- db: mockDb
282
- }
283
-
284
- ;(MongoClient as any).mockImplementation(() => mockClient)
285
-
286
- await overlayExpress.configureMongo('mongodb://localhost:27017')
287
-
288
- expect(mockConnect).toHaveBeenCalled()
289
- expect(mockDb).toHaveBeenCalledWith('TestService_lookup_services')
290
- expect(overlayExpress.mongoDb).toBeDefined()
291
- })
292
- })
293
-
294
- describe('configureTopicManager', () => {
295
- it('should add topic manager', () => {
296
- const mockManager: TopicManager = Object.create(null)
297
- overlayExpress.configureTopicManager('test_manager', mockManager)
298
-
299
- expect(overlayExpress.managers.test_manager).toBe(mockManager)
300
- })
301
-
302
- it('should add multiple topic managers', () => {
303
- const manager1: TopicManager = Object.create(null)
304
- const manager2: TopicManager = Object.create(null)
305
-
306
- overlayExpress.configureTopicManager('manager1', manager1)
307
- overlayExpress.configureTopicManager('manager2', manager2)
308
-
309
- expect(overlayExpress.managers.manager1).toBe(manager1)
310
- expect(overlayExpress.managers.manager2).toBe(manager2)
311
- })
312
- })
313
-
314
- describe('configureLookupService', () => {
315
- it('should add lookup service', () => {
316
- const mockService: LookupService = Object.create(null)
317
- overlayExpress.configureLookupService('test_service', mockService)
318
-
319
- expect(overlayExpress.services.test_service).toBe(mockService)
320
- })
321
-
322
- it('should add multiple lookup services', () => {
323
- const service1: LookupService = Object.create(null)
324
- const service2: LookupService = Object.create(null)
325
-
326
- overlayExpress.configureLookupService('service1', service1)
327
- overlayExpress.configureLookupService('service2', service2)
328
-
329
- expect(overlayExpress.services.service1).toBe(service1)
330
- expect(overlayExpress.services.service2).toBe(service2)
331
- })
332
- })
333
-
334
- describe('configureLookupServiceWithKnex', () => {
335
- beforeEach(async () => {
336
- const mockKnex = { raw: jest.fn() }
337
- ;(Knex as any).mockReturnValue(mockKnex)
338
- await overlayExpress.configureKnex({
339
- client: 'mysql2',
340
- connection: {}
341
- })
342
- })
343
-
344
- it('should configure lookup service with Knex', () => {
345
- const mockService: LookupService = Object.create(null)
346
- const mockFactory = jest.fn().mockReturnValue({
347
- service: mockService,
348
- migrations: []
349
- })
350
-
351
- // @ts-expect-error - Mock factory function
352
- overlayExpress.configureLookupServiceWithKnex('test_service', mockFactory)
353
-
354
- expect(mockFactory).toHaveBeenCalledWith(overlayExpress.knex)
355
- expect(overlayExpress.services.test_service).toBe(mockService)
356
- })
357
-
358
- it('should add migrations from factory', () => {
359
- const mockService: LookupService = Object.create(null)
360
- const mockMigrations = [
361
- { name: 'migration1', up: jest.fn() },
362
- { name: 'migration2', up: jest.fn() }
363
- ]
364
- const mockFactory = jest.fn().mockReturnValue({
365
- service: mockService,
366
- migrations: mockMigrations
367
- })
368
-
369
- // @ts-expect-error - Mock factory function
370
- overlayExpress.configureLookupServiceWithKnex('test_service', mockFactory)
371
-
372
- expect(overlayExpress.migrationsToRun).toContain(mockMigrations[0])
373
- expect(overlayExpress.migrationsToRun).toContain(mockMigrations[1])
374
- })
375
-
376
- it('should check Knex configuration', () => {
377
- const freshInstance = new OverlayExpress('Test', 'key', 'example.com')
378
- const mockLookupService: LookupService = Object.create(null)
379
- const mockFactory = jest.fn().mockReturnValue({
380
- service: mockLookupService,
381
- migrations: []
382
- })
383
-
384
- // @ts-expect-error - Mock factory function
385
- expect(() => freshInstance.configureLookupServiceWithKnex('test', mockFactory))
386
- .toThrow('You must configure your SQL database')
387
- })
388
- })
389
-
390
- describe('configureLookupServiceWithMongo', () => {
391
- beforeEach(async () => {
392
- // @ts-expect-error - Mock resolved value
393
- const mockConnect = jest.fn().mockResolvedValue(undefined)
394
- const mockDb = jest.fn().mockReturnValue(createMockDbValue())
395
- const mockClient = {
396
- connect: mockConnect,
397
- db: mockDb
398
- }
399
-
400
- ;(MongoClient as any).mockImplementation(() => mockClient)
401
-
402
- await overlayExpress.configureMongo('mongodb://localhost:27017')
403
- })
404
-
405
- it('should configure lookup service with MongoDB', () => {
406
- const mockService: LookupService = Object.create(null)
407
- const mockFactory = jest.fn().mockReturnValue(mockService)
408
-
409
- // @ts-expect-error - Mock factory function
410
- overlayExpress.configureLookupServiceWithMongo('test_service', mockFactory)
411
-
412
- expect(mockFactory).toHaveBeenCalledWith(overlayExpress.mongoDb)
413
- expect(overlayExpress.services.test_service).toBe(mockService)
414
- })
415
-
416
- it('should check MongoDB configuration', () => {
417
- const freshInstance = new OverlayExpress('Test', 'key', 'example.com')
418
- const mockLookupService: LookupService = Object.create(null)
419
- const mockFactory = jest.fn().mockReturnValue(mockLookupService)
420
-
421
- // @ts-expect-error - Mock factory function
422
- expect(() => freshInstance.configureLookupServiceWithMongo('test', mockFactory))
423
- .toThrow('You must configure your MongoDB connection')
424
- })
425
- })
426
-
427
- describe('configureEngineParams', () => {
428
- it('should set engine params', () => {
429
- const params = {
430
- logTime: true,
431
- throwOnBroadcastFailure: true
432
- }
433
-
434
- overlayExpress.configureEngineParams(params)
435
-
436
- expect(overlayExpress.engineConfig.logTime).toBe(true)
437
- expect(overlayExpress.engineConfig.throwOnBroadcastFailure).toBe(true)
438
- })
439
-
440
- it('should merge engine params', () => {
441
- overlayExpress.configureEngineParams({ logTime: true })
442
- overlayExpress.configureEngineParams({ throwOnBroadcastFailure: false })
443
-
444
- expect(overlayExpress.engineConfig.logTime).toBe(true)
445
- expect(overlayExpress.engineConfig.throwOnBroadcastFailure).toBe(false)
446
- })
447
-
448
- it('should accept all engine config properties', () => {
449
- const params = {
450
- logTime: true,
451
- logPrefix: '[TEST]',
452
- throwOnBroadcastFailure: true,
453
- suppressDefaultSyncAdvertisements: false
454
- }
455
-
456
- overlayExpress.configureEngineParams(params)
457
-
458
- expect(overlayExpress.engineConfig).toMatchObject(params)
459
- })
460
- })
461
-
462
- describe('configureEngine', () => {
463
- beforeEach(async () => {
464
- const mockKnex = { raw: jest.fn() }
465
- ;(Knex as any).mockReturnValue(mockKnex)
466
- await overlayExpress.configureKnex({
467
- client: 'mysql2',
468
- connection: {}
469
- })
470
-
471
- // @ts-expect-error - Mock resolved value
472
- const mockConnect = jest.fn().mockResolvedValue(undefined)
473
- const mockDb = jest.fn().mockReturnValue(createMockDbValue())
474
- const mockClient = {
475
- connect: mockConnect,
476
- db: mockDb
477
- }
478
-
479
- ;(MongoClient as any).mockImplementation(() => mockClient)
480
- await overlayExpress.configureMongo('mongodb://localhost:27017')
481
- })
482
-
483
- it('should check Knex before configuring engine', async () => {
484
- const freshInstance = new OverlayExpress('Test', 'key', 'example.com')
485
-
486
- // Note: due to initialization with empty object, ensureKnex check doesn't actually
487
- // throw when knex is not properly configured. This is a known limitation.
488
- // Just verify the method can be called
489
- try {
490
- await freshInstance.configureEngine()
491
- } catch (e) {
492
- // May fail for other reasons like missing dependencies
493
- }
494
- expect(true).toBe(true)
495
- })
496
-
497
- it('should configure engine with auto SHIP/SLAP', async () => {
498
- await overlayExpress.configureEngine(true)
499
-
500
- expect(overlayExpress.engine).toBeDefined()
501
- expect(overlayExpress.managers.tm_ship).toBeDefined()
502
- expect(overlayExpress.managers.tm_slap).toBeDefined()
503
- expect(overlayExpress.services.ls_ship).toBeDefined()
504
- expect(overlayExpress.services.ls_slap).toBeDefined()
505
- })
506
-
507
- it('should initialize SHIP/SLAP indexes before completing engine configuration', async () => {
508
- const shipEnsureIndexes = jest.fn<any>().mockResolvedValue(undefined)
509
- const slapEnsureIndexes = jest.fn<any>().mockResolvedValue(undefined)
510
- ;(DiscoveryServices.SHIPStorage as any).mockImplementationOnce(() => ({
511
- ensureIndexes: shipEnsureIndexes
512
- }))
513
- ;(DiscoveryServices.SLAPStorage as any).mockImplementationOnce(() => ({
514
- ensureIndexes: slapEnsureIndexes
515
- }))
516
-
517
- await overlayExpress.configureEngine(true)
518
-
519
- expect(shipEnsureIndexes).toHaveBeenCalledTimes(1)
520
- expect(slapEnsureIndexes).toHaveBeenCalledTimes(1)
521
- expect(overlayExpress.engine).toBeDefined()
522
- })
523
-
524
- it('should fail engine configuration when discovery index initialization fails', async () => {
525
- const indexError = new Error('discovery index migration failed')
526
- const shipEnsureIndexes = jest.fn<any>().mockRejectedValue(indexError)
527
- const slapEnsureIndexes = jest.fn<any>().mockResolvedValue(undefined)
528
- ;(DiscoveryServices.SHIPStorage as any).mockImplementationOnce(() => ({
529
- ensureIndexes: shipEnsureIndexes
530
- }))
531
- ;(DiscoveryServices.SLAPStorage as any).mockImplementationOnce(() => ({
532
- ensureIndexes: slapEnsureIndexes
533
- }))
534
-
535
- await expect(overlayExpress.configureEngine(true)).rejects.toThrow(indexError)
536
-
537
- expect(shipEnsureIndexes).toHaveBeenCalledTimes(1)
538
- expect(slapEnsureIndexes).not.toHaveBeenCalled()
539
- expect(overlayExpress.engine).toBeUndefined()
540
- expect(overlayExpress.services.ls_ship).toBeUndefined()
541
- expect(overlayExpress.services.ls_slap).toBeUndefined()
542
- })
543
-
544
- it('should configure engine without auto SHIP/SLAP', async () => {
545
- await overlayExpress.configureEngine(false)
546
-
547
- expect(overlayExpress.engine).toBeDefined()
548
- expect(overlayExpress.managers.tm_ship).toBeUndefined()
549
- expect(overlayExpress.managers.tm_slap).toBeUndefined()
550
- })
551
-
552
- it('should respect enableGASPSync setting', async () => {
553
- const mockKnex = { raw: jest.fn() }
554
- ;(Knex as any).mockReturnValue(mockKnex)
555
- await overlayExpress.configureKnex({
556
- client: 'mysql2',
557
- connection: {}
558
- })
559
-
560
- // @ts-expect-error - Mock resolved value
561
- const mockConnect = jest.fn().mockResolvedValue(undefined)
562
- const mockDb = jest.fn().mockReturnValue(createMockDbValue())
563
- const mockClient = {
564
- connect: mockConnect,
565
- db: mockDb
566
- }
567
-
568
- ;(MongoClient as any).mockImplementation(() => mockClient)
569
- await overlayExpress.configureMongo('mongodb://localhost:27017')
570
-
571
- overlayExpress.configureEnableGASPSync(false)
572
- await overlayExpress.configureEngine()
573
-
574
- expect(overlayExpress.engine).toBeDefined()
575
- })
576
- })
577
-
578
- describe('error handling', () => {
579
- it('should handle Knex configuration errors', async () => {
580
- const freshInstance = new OverlayExpress('Test', 'key', 'example.com')
581
-
582
- ;(Knex as any).mockImplementationOnce(() => {
583
- throw new Error('Knex error')
584
- })
585
-
586
- await expect(
587
- freshInstance.configureKnex({ client: 'mysql2' })
588
- ).rejects.toThrow('Knex error')
589
- })
590
-
591
- it('should handle MongoDB connection errors', async () => {
592
- const freshInstance = new OverlayExpress('Test', 'key', 'example.com')
593
- ;(MongoClient as any).mockImplementation(() => ({
594
- // @ts-expect-error - Mock rejected value
595
- connect: jest.fn().mockRejectedValue(new Error('Connection failed'))
596
- }))
597
-
598
- await expect(
599
- freshInstance.configureMongo('mongodb://localhost:27017')
600
- ).rejects.toThrow('Connection failed')
601
- })
602
- })
603
-
604
- describe('integration scenarios', () => {
605
- it('should allow full configuration workflow', async () => {
606
- const instance = new OverlayExpress(
607
- 'FullTest',
608
- 'private-key',
609
- 'example.com'
610
- )
611
-
612
- instance.configurePort(8080)
613
- instance.configureNetwork('test')
614
- instance.configureEnableGASPSync(true)
615
- instance.configureVerboseRequestLogging(false)
616
-
617
- const mockKnex = { raw: jest.fn() }
618
- ;(Knex as any).mockReturnValue(mockKnex)
619
- await instance.configureKnex({
620
- client: 'mysql2',
621
- connection: {}
622
- })
623
-
624
- // @ts-expect-error - Mock resolved value
625
- const mockConnect = jest.fn().mockResolvedValue(undefined)
626
- const mockDb = jest.fn().mockReturnValue(createMockDbValue())
627
- const mockClient = {
628
- connect: mockConnect,
629
- db: mockDb
630
- }
631
-
632
- ;(MongoClient as any).mockImplementation(() => mockClient)
633
- await instance.configureMongo('mongodb://localhost:27017')
634
-
635
- await instance.configureEngine()
636
-
637
- expect(instance.port).toBe(8080)
638
- expect(instance.network).toBe('test')
639
- expect(instance.enableGASPSync).toBe(true)
640
- expect(instance.engine).toBeDefined()
641
- })
642
-
643
- it('should handle configuration with custom admin token', () => {
644
- const customToken = 'secure-token-123'
645
- const instance = new OverlayExpress(
646
- 'SecureService',
647
- 'private-key',
648
- 'example.com',
649
- customToken
650
- )
651
-
652
- expect(instance.getAdminToken()).toBe(customToken)
653
- })
654
-
655
- it('should maintain separate topic managers and lookup services', () => {
656
- const manager1: TopicManager = Object.create(null)
657
- const manager2: TopicManager = Object.create(null)
658
- const service1: LookupService = Object.create(null)
659
- const service2: LookupService = Object.create(null)
660
-
661
- overlayExpress.configureTopicManager('tm1', manager1)
662
- overlayExpress.configureTopicManager('tm2', manager2)
663
- overlayExpress.configureLookupService('ls1', service1)
664
- overlayExpress.configureLookupService('ls2', service2)
665
-
666
- expect(Object.keys(overlayExpress.managers)).toHaveLength(2)
667
- expect(Object.keys(overlayExpress.services)).toHaveLength(2)
668
- })
669
- })
670
-
671
- describe('start method', () => {
672
- let mockKnex: any
673
- let mockEngine: any
674
- let instance: OverlayExpress
675
-
676
- beforeEach(async () => {
677
- instance = new OverlayExpress('TestServer', 'test-key', 'test.example.com')
678
-
679
- // Mock Knex with migrations
680
- mockKnex = {
681
- raw: jest.fn(),
682
- migrate: {
683
- // @ts-expect-error - Mock return value
684
- latest: jest.fn().mockResolvedValue([1, ['migration1']])
685
- }
686
- }
687
- ;(Knex as any).mockReturnValue(mockKnex)
688
-
689
- // Mock Engine with required methods
690
- mockEngine = {
691
- // @ts-expect-error - Mock return values
692
- listTopicManagers: jest.fn().mockResolvedValue([]),
693
- // @ts-expect-error - Mock return values
694
- listLookupServiceProviders: jest.fn().mockResolvedValue([]),
695
- // @ts-expect-error - Mock return values
696
- getDocumentationForTopicManager: jest.fn().mockResolvedValue('# Docs'),
697
- // @ts-expect-error - Mock return values
698
- getDocumentationForLookupServiceProvider: jest.fn().mockResolvedValue('# Docs'),
699
- // @ts-expect-error - Mock return values
700
- submit: jest.fn().mockResolvedValue({ status: 'success' }),
701
- // @ts-expect-error - Mock return values
702
- lookup: jest.fn().mockResolvedValue({ outputs: [] }),
703
- // @ts-expect-error - Mock return values
704
- handleNewMerkleProof: jest.fn().mockResolvedValue(undefined),
705
- // @ts-expect-error - Mock return values
706
- provideForeignSyncResponse: jest.fn().mockResolvedValue({}),
707
- // @ts-expect-error - Mock return values
708
- provideForeignGASPNode: jest.fn().mockResolvedValue({}),
709
- // @ts-expect-error - Mock return values
710
- syncAdvertisements: jest.fn().mockResolvedValue(undefined),
711
- // @ts-expect-error - Mock return values
712
- startGASPSync: jest.fn().mockResolvedValue(undefined),
713
- // @ts-expect-error - Mock return values
714
- refreshUnprovenTransactionProofs: jest.fn().mockResolvedValue({}),
715
- // @ts-expect-error - Mock return values
716
- maintainUnprovenTransactions: jest.fn().mockResolvedValue({}),
717
- // @ts-expect-error - Mock return values
718
- evictAppliedTransaction: jest.fn().mockResolvedValue({ evictedTransactions: 1, evictedOutputs: 1 }),
719
- lookupServices: {},
720
- advertiser: {
721
- // @ts-expect-error - Mock return values
722
- init: jest.fn().mockResolvedValue(undefined)
723
- }
724
- }
725
-
726
- // Configure databases
727
- await instance.configureKnex({ client: 'mysql2', connection: {} })
728
-
729
- // @ts-expect-error - Mock return value
730
- const mockConnect = jest.fn().mockResolvedValue(undefined)
731
- const mockDb = jest.fn().mockReturnValue(createMockDbValue())
732
- const mockClient = {
733
- connect: mockConnect,
734
- db: mockDb
735
- }
736
- ;(MongoClient as any).mockImplementation(() => mockClient)
737
- await instance.configureMongo('mongodb://localhost:27017')
738
-
739
- // Don't call configureEngine() - just set the engine and knex directly
740
- instance.engine = mockEngine
741
- instance.knex = mockKnex
742
- })
743
-
744
- it('should throw if engine not configured', async () => {
745
- const freshInstance = new OverlayExpress('Test', 'key', 'example.com')
746
- const mockKnex = {
747
- raw: jest.fn(),
748
- migrate: {
749
- // @ts-expect-error - Mock return value
750
- latest: jest.fn().mockResolvedValue([])
751
- }
752
- }
753
- ;(Knex as any).mockReturnValue(mockKnex)
754
- await freshInstance.configureKnex({ client: 'mysql2', connection: {} })
755
-
756
- await expect(freshInstance.start()).rejects.toThrow(
757
- 'You must configure your Overlay Services engine'
758
- )
759
- })
760
-
761
- it('should throw if knex not configured', async () => {
762
- const freshInstance = new OverlayExpress('Test', 'key', 'example.com')
763
- freshInstance.engine = mockEngine
764
-
765
- await expect(freshInstance.start()).rejects.toThrow(
766
- 'You must configure your SQL database'
767
- )
768
- })
769
-
770
- it('should set up Express middleware', async () => {
771
- const useSpy = jest.spyOn(instance.app, 'use')
772
- const getSpy = jest.spyOn(instance.app, 'get')
773
- const postSpy = jest.spyOn(instance.app, 'post')
774
- const listenSpy = jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
775
- callback()
776
- return {} as any
777
- })
778
-
779
- await instance.start()
780
-
781
- expect(useSpy).toHaveBeenCalled()
782
- expect(getSpy).toHaveBeenCalled()
783
- expect(postSpy).toHaveBeenCalled()
784
- expect(listenSpy).toHaveBeenCalledWith(3000, expect.any(Function))
785
- })
786
-
787
- it('accepts canonical and legacy X-Topics formats on /submit', async () => {
788
- const postSpy = jest.spyOn(instance.app, 'post')
789
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
790
- callback()
791
- return {} as any
792
- })
793
- await instance.start()
794
-
795
- const route = postSpy.mock.calls.find(call => call[0] === '/submit')
796
- const handler: any = route === undefined ? undefined : route[route.length - 1]
797
- expect(handler).toBeDefined()
798
-
799
- for (const topicsHeader of ['tm_foo,tm_bar', '["tm_foo","tm_bar"]']) {
800
- const res: any = {
801
- status: jest.fn().mockReturnThis(),
802
- json: jest.fn().mockReturnThis()
803
- }
804
- handler?.({
805
- headers: { 'x-topics': topicsHeader },
806
- body: Buffer.from([1, 2, 3])
807
- }, res)
808
- await new Promise(resolve => setImmediate(resolve))
809
- }
810
-
811
- expect(mockEngine.submit).toHaveBeenCalledTimes(2)
812
- for (const call of mockEngine.submit.mock.calls) {
813
- expect(call[0]).toEqual({
814
- beef: [1, 2, 3],
815
- topics: ['tm_foo', 'tm_bar'],
816
- offChainValues: undefined
817
- })
818
- }
819
- })
820
-
821
- it('returns a clean 400 for an empty /submit body', async () => {
822
- const postSpy = jest.spyOn(instance.app, 'post')
823
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
824
- callback()
825
- return {} as any
826
- })
827
- const consoleError = jest.spyOn(console, 'error').mockImplementation(() => {})
828
- await instance.start()
829
-
830
- const route = postSpy.mock.calls.find(call => call[0] === '/submit')
831
- const handler: any = route === undefined ? undefined : route[route.length - 1]
832
- const res: any = {
833
- status: jest.fn().mockReturnThis(),
834
- json: jest.fn().mockReturnThis()
835
- }
836
- handler?.({ headers: { 'x-topics': 'tm_foo' }, body: undefined }, res)
837
- await new Promise(resolve => setImmediate(resolve))
838
-
839
- expect(res.status).toHaveBeenCalledWith(400)
840
- expect(res.json).toHaveBeenCalledWith({
841
- status: 'error',
842
- message: 'Missing or empty BEEF body'
843
- })
844
- expect(mockEngine.submit).not.toHaveBeenCalled()
845
- consoleError.mockRestore()
846
- })
847
-
848
- it.each([
849
- ['', 'an empty comma-separated list'],
850
- ['tm_foo,', 'an empty comma-separated topic'],
851
- ['["tm_foo",42]', 'a JSON array containing a non-string topic']
852
- ])('returns a clean 400 when X-Topics is %s (%s)', async (topicsHeader) => {
853
- const postSpy = jest.spyOn(instance.app, 'post')
854
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
855
- callback()
856
- return {} as any
857
- })
858
- const consoleError = jest.spyOn(console, 'error').mockImplementation(() => {})
859
- await instance.start()
860
-
861
- const route = postSpy.mock.calls.find(call => call[0] === '/submit')
862
- const handler: any = route === undefined ? undefined : route[route.length - 1]
863
- const res: any = {
864
- status: jest.fn().mockReturnThis(),
865
- json: jest.fn().mockReturnThis()
866
- }
867
- handler?.({
868
- headers: { 'x-topics': topicsHeader },
869
- body: Buffer.from([1, 2, 3])
870
- }, res)
871
- await new Promise(resolve => setImmediate(resolve))
872
-
873
- expect(res.status).toHaveBeenCalledWith(400)
874
- expect(res.json).toHaveBeenCalledWith({
875
- status: 'error',
876
- message: 'Invalid x-topics header: expected a comma-separated list or JSON string array'
877
- })
878
- expect(mockEngine.submit).not.toHaveBeenCalled()
879
- consoleError.mockRestore()
880
- })
881
-
882
- it('returns a clean 400 when /admin/health-check has no body', async () => {
883
- const postSpy = jest.spyOn(instance.app, 'post')
884
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
885
- callback()
886
- return {} as any
887
- })
888
- await instance.start()
889
-
890
- const route = postSpy.mock.calls.find(call => call[0] === '/admin/health-check')
891
- const handler: any = route === undefined ? undefined : route[route.length - 1]
892
- const res: any = {
893
- status: jest.fn().mockReturnThis(),
894
- json: jest.fn().mockReturnThis()
895
- }
896
- handler?.({ body: undefined }, res)
897
- await new Promise(resolve => setImmediate(resolve))
898
-
899
- expect(res.status).toHaveBeenCalledWith(400)
900
- expect(res.json).toHaveBeenCalledWith({
901
- status: 'error',
902
- message: 'url is required'
903
- })
904
- })
905
-
906
- it('should set up CORS middleware', async () => {
907
- const useSpy = jest.spyOn(instance.app, 'use')
908
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
909
- callback()
910
- return {} as any
911
- })
912
-
913
- await instance.start()
914
-
915
- // Find CORS middleware call
916
- const corsMiddleware = useSpy.mock.calls.find((call: any) => {
917
- const fn = call[0]
918
- return typeof fn === 'function' && fn.length === 3
919
- })
920
- expect(corsMiddleware).toBeDefined()
921
- })
922
-
923
- it('should register health check routes', async () => {
924
- const getSpy = jest.spyOn(instance.app, 'get')
925
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
926
- callback()
927
- return {} as any
928
- })
929
-
930
- await instance.start()
931
-
932
- expect(getSpy.mock.calls.find(call => call[0] === '/health')).toBeDefined()
933
- expect(getSpy.mock.calls.find(call => call[0] === '/health/live')).toBeDefined()
934
- expect(getSpy.mock.calls.find(call => call[0] === '/health/ready')).toBeDefined()
935
- })
936
-
937
- it('should return detailed readiness health', async () => {
938
- const getSpy = jest.spyOn(instance.app, 'get')
939
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
940
- callback()
941
- return {} as any
942
- })
943
-
944
- await instance.start()
945
-
946
- const readyRoute = getSpy.mock.calls.find(call => call[0] === '/health/ready')
947
- const res = {
948
- status: jest.fn().mockReturnThis(),
949
- json: jest.fn()
950
- }
951
-
952
- readyRoute?.[1]({} as any, res as any)
953
- await new Promise(resolve => setImmediate(resolve))
954
-
955
- expect(res.status).toHaveBeenCalledWith(200)
956
- expect(res.json).toHaveBeenCalledWith(expect.objectContaining({
957
- status: 'ok',
958
- ready: true,
959
- service: expect.objectContaining({
960
- name: 'TestServer'
961
- }),
962
- checks: expect.arrayContaining([
963
- expect.objectContaining({ name: 'engine', status: 'ok' }),
964
- expect.objectContaining({ name: 'knex', status: 'ok' }),
965
- expect.objectContaining({ name: 'mongo', status: 'ok' })
966
- ])
967
- }))
968
- })
969
-
970
- it('should register admin routes', async () => {
971
- const postSpy = jest.spyOn(instance.app, 'post')
972
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
973
- callback()
974
- return {} as any
975
- })
976
-
977
- await instance.start()
978
-
979
- expect(postSpy.mock.calls.some(call => call[0] === '/admin/syncAdvertisements')).toBe(true)
980
- expect(postSpy.mock.calls.some(call => call[0] === '/admin/startGASPSync')).toBe(true)
981
- expect(postSpy.mock.calls.some(call => call[0] === '/admin/evictOutpoint')).toBe(true)
982
- expect(postSpy.mock.calls.some(call => call[0] === '/admin/janitor')).toBe(true)
983
- })
984
-
985
- it('should register GASP sync routes when enabled', async () => {
986
- instance.configureEnableGASPSync(true)
987
- const postSpy = jest.spyOn(instance.app, 'post')
988
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
989
- callback()
990
- return {} as any
991
- })
992
-
993
- await instance.start()
994
-
995
- expect(postSpy.mock.calls.some(call => call[0] === '/requestSyncResponse')).toBe(true)
996
- expect(postSpy.mock.calls.some(call => call[0] === '/requestForeignGASPNode')).toBe(true)
997
- })
998
-
999
- it('should not register GASP sync routes when disabled', async () => {
1000
- instance.configureEnableGASPSync(false)
1001
- const postSpy = jest.spyOn(instance.app, 'post')
1002
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1003
- callback()
1004
- return {} as any
1005
- })
1006
-
1007
- await instance.start()
1008
-
1009
- expect(postSpy.mock.calls.some(call => call[0] === '/requestSyncResponse')).toBe(false)
1010
- expect(postSpy.mock.calls.some(call => call[0] === '/requestForeignGASPNode')).toBe(false)
1011
- })
1012
-
1013
- it('should register ARC ingest route when API key is configured', async () => {
1014
- instance.configureArcApiKey('test-arc-key')
1015
- const postSpy = jest.spyOn(instance.app, 'post')
1016
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1017
- callback()
1018
- return {} as any
1019
- })
1020
-
1021
- await instance.start()
1022
-
1023
- expect(postSpy.mock.calls.some(call => call[0] === '/arc-ingest')).toBe(true)
1024
- })
1025
-
1026
- it('should not register ARC ingest route when API key is not configured', async () => {
1027
- const postSpy = jest.spyOn(instance.app, 'post')
1028
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1029
- callback()
1030
- return {} as any
1031
- })
1032
-
1033
- await instance.start()
1034
-
1035
- expect(postSpy.mock.calls.some(call => call[0] === '/arc-ingest')).toBe(false)
1036
- })
1037
-
1038
- describe('ARC ingest callback token', () => {
1039
- const mockRes = (): any => {
1040
- const res: any = {}
1041
- res.status = jest.fn<any>().mockReturnValue(res)
1042
- res.json = jest.fn<any>().mockReturnValue(res)
1043
- return res
1044
- }
1045
- // Flush the async IIFE inside the /arc-ingest handler.
1046
- const flush = async (): Promise<void> => { await new Promise(resolve => setImmediate(resolve)) }
1047
- const proofCallbackBody = {
1048
- txid: '11'.repeat(32),
1049
- merklePath: '00',
1050
- blockHeight: 800000
1051
- }
1052
-
1053
- const captureArcIngestHandler = async (): Promise<any> => {
1054
- const postSpy = jest.spyOn(instance.app, 'post')
1055
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1056
- callback()
1057
- return {} as any
1058
- })
1059
- await instance.start()
1060
- const handler = postSpy.mock.calls.find(call => call[0] === '/arc-ingest')?.[1]
1061
- expect(handler).toBeDefined()
1062
- return handler
1063
- }
1064
-
1065
- it('rejects a callback with no token when a token is configured', async () => {
1066
- instance.configureArcApiKey('test-arc-key')
1067
- instance.configureArcCallbackToken('secret-token')
1068
- const handler = await captureArcIngestHandler()
1069
- const res = mockRes()
1070
-
1071
- handler({ headers: {}, body: {} }, res)
1072
- await flush()
1073
-
1074
- expect(res.status).toHaveBeenCalledWith(401)
1075
- })
1076
-
1077
- it('rejects a callback with an invalid token', async () => {
1078
- instance.configureArcApiKey('test-arc-key')
1079
- instance.configureArcCallbackToken('secret-token')
1080
- const handler = await captureArcIngestHandler()
1081
- const res = mockRes()
1082
-
1083
- handler({ headers: { authorization: 'Bearer wrong-token' }, body: {} }, res)
1084
- await flush()
1085
-
1086
- expect(res.status).toHaveBeenCalledWith(401)
1087
- })
1088
-
1089
- it('accepts a callback with a valid Bearer token', async () => {
1090
- instance.configureArcApiKey('test-arc-key')
1091
- instance.configureArcCallbackToken('secret-token')
1092
- const handler = await captureArcIngestHandler()
1093
- const res = mockRes()
1094
-
1095
- handler({ headers: { authorization: 'Bearer secret-token' }, body: proofCallbackBody }, res)
1096
- await flush()
1097
-
1098
- expect(res.status).not.toHaveBeenCalledWith(401)
1099
- expect(mockEngine.handleNewMerkleProof).toHaveBeenCalled()
1100
- })
1101
-
1102
- it('accepts a callback with a valid x-callback-token header', async () => {
1103
- instance.configureArcApiKey('test-arc-key')
1104
- instance.configureArcCallbackToken('secret-token')
1105
- const handler = await captureArcIngestHandler()
1106
- const res = mockRes()
1107
-
1108
- handler({ headers: { 'x-callback-token': 'secret-token' }, body: proofCallbackBody }, res)
1109
- await flush()
1110
-
1111
- expect(res.status).not.toHaveBeenCalledWith(401)
1112
- expect(mockEngine.handleNewMerkleProof).toHaveBeenCalled()
1113
- })
1114
-
1115
- it('does not enforce a token when none is configured', async () => {
1116
- instance.configureArcApiKey('test-arc-key')
1117
- const handler = await captureArcIngestHandler()
1118
- const res = mockRes()
1119
-
1120
- handler({ headers: {}, body: proofCallbackBody }, res)
1121
- await flush()
1122
-
1123
- expect(res.status).not.toHaveBeenCalledWith(401)
1124
- expect(mockEngine.handleNewMerkleProof).toHaveBeenCalled()
1125
- })
1126
-
1127
- it('evicts a transaction when a provider reports a terminal double-spend status', async () => {
1128
- instance.configureArcApiKey('test-arc-key')
1129
- instance.configureArcCallbackToken('secret-token')
1130
- const handler = await captureArcIngestHandler()
1131
- const res = mockRes()
1132
-
1133
- handler({
1134
- headers: { authorization: 'Bearer secret-token' },
1135
- body: {
1136
- txid: '11'.repeat(32),
1137
- txStatus: 'DOUBLE_SPEND_ATTEMPTED',
1138
- competingTxs: ['22'.repeat(32)]
1139
- }
1140
- }, res)
1141
- await flush()
1142
-
1143
- expect(mockEngine.evictAppliedTransaction).toHaveBeenCalledWith('11'.repeat(32), {
1144
- topic: undefined,
1145
- reason: 'DOUBLE_SPEND_ATTEMPTED'
1146
- })
1147
- expect(mockEngine.handleNewMerkleProof).not.toHaveBeenCalled()
1148
- })
1149
- })
1150
-
1151
- it('should run knex migrations on start', async () => {
1152
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1153
- callback()
1154
- return {} as any
1155
- })
1156
-
1157
- await instance.start()
1158
-
1159
- expect(mockKnex.migrate.latest).toHaveBeenCalled()
1160
- })
1161
-
1162
- it('should call syncAdvertisements on start', async () => {
1163
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1164
- callback()
1165
- return {} as any
1166
- })
1167
-
1168
- await instance.start()
1169
-
1170
- expect(mockEngine.syncAdvertisements).toHaveBeenCalled()
1171
- })
1172
-
1173
- it('should start GASP sync when enabled', async () => {
1174
- instance.configureEnableGASPSync(true)
1175
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1176
- callback()
1177
- return {} as any
1178
- })
1179
-
1180
- await instance.start()
1181
-
1182
- expect(mockEngine.startGASPSync).toHaveBeenCalled()
1183
- })
1184
-
1185
- it('should not start GASP sync when disabled', async () => {
1186
- instance.configureEnableGASPSync(false)
1187
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1188
- callback()
1189
- return {} as any
1190
- })
1191
-
1192
- await instance.start()
1193
-
1194
- expect(mockEngine.startGASPSync).not.toHaveBeenCalled()
1195
- })
1196
-
1197
- it('should enable verbose request logging when configured', async () => {
1198
- instance.configureVerboseRequestLogging(true)
1199
- const useSpy = jest.spyOn(instance.app, 'use')
1200
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1201
- callback()
1202
- return {} as any
1203
- })
1204
-
1205
- await instance.start()
1206
-
1207
- // Verbose logging middleware should be registered
1208
- expect(useSpy).toHaveBeenCalled()
1209
- })
1210
-
1211
- it('should initialize advertiser if it is WalletAdvertiser', async () => {
1212
- const mockAdvertiser: any = {
1213
- // @ts-expect-error - Mock return value
1214
- init: jest.fn().mockResolvedValue(undefined),
1215
- createAdvertisements: jest.fn(),
1216
- findAllAdvertisements: jest.fn(),
1217
- revokeAdvertisements: jest.fn(),
1218
- parseAdvertisement: jest.fn()
1219
- }
1220
- if (instance.engine === undefined) throw new Error('improper test setup')
1221
- instance.engine.advertiser = mockAdvertiser
1222
-
1223
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1224
- callback()
1225
- return {} as any
1226
- })
1227
-
1228
- // Mock the instanceof check
1229
- // eslint-disable-next-line @typescript-eslint/no-var-requires
1230
- const DiscoveryServices = require('@bsv/overlay-discovery-services')
1231
- Object.defineProperty(mockAdvertiser, 'constructor', {
1232
- value: DiscoveryServices.WalletAdvertiser
1233
- })
1234
-
1235
- await instance.start()
1236
-
1237
- // The init method may or may not be called depending on instanceof check
1238
- // Just verify start completes without error
1239
- expect(instance.app.listen).toHaveBeenCalled()
1240
- })
1241
-
1242
- it('should handle syncAdvertisements errors gracefully', async () => {
1243
- mockEngine.syncAdvertisements.mockRejectedValueOnce(new Error('Sync failed'))
1244
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1245
- callback()
1246
- return {} as any
1247
- })
1248
-
1249
- // Should not throw, just log the error
1250
- await expect(instance.start()).resolves.not.toThrow()
1251
- })
1252
-
1253
- it('should handle startGASPSync errors gracefully', async () => {
1254
- instance.configureEnableGASPSync(true)
1255
- mockEngine.startGASPSync.mockRejectedValueOnce(new Error('GASP sync failed'))
1256
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1257
- callback()
1258
- return {} as any
1259
- })
1260
-
1261
- // Should not throw, just log the error
1262
- await expect(instance.start()).resolves.not.toThrow()
1263
- })
1264
-
1265
- it('should listen on configured port', async () => {
1266
- instance.configurePort(8080)
1267
- const listenSpy = jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1268
- callback()
1269
- return {} as any
1270
- })
1271
-
1272
- await instance.start()
1273
-
1274
- expect(listenSpy).toHaveBeenCalledWith(8080, expect.any(Function))
1275
- })
1276
-
1277
- it('should register 404 handler', async () => {
1278
- const useSpy = jest.spyOn(instance.app, 'use')
1279
- jest.spyOn(instance.app, 'listen').mockImplementation((port: any, callback: any) => {
1280
- callback()
1281
- return {} as any
1282
- })
1283
-
1284
- await instance.start()
1285
-
1286
- // 404 handler should be the last middleware
1287
- const lastUse = useSpy.mock.calls[useSpy.mock.calls.length - 1]
1288
- expect(lastUse).toBeDefined()
1289
- expect(typeof lastUse[0]).toBe('function')
1290
- })
1291
- })
1292
-
1293
- describe('InMemoryMigrationSource', () => {
1294
- it('should be tested via OverlayExpress start method', () => {
1295
- // InMemoryMigrationSource is an internal class used by start()
1296
- // It's covered by the start() tests above
1297
- expect(true).toBe(true)
1298
- })
1299
- })
1300
- })