@bsv/overlay-express 2.4.1 → 2.4.9

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