Skip to content

Repository navigation

Commit 9e2bb46

Browse files
PriyanshubhartistmPriyanshubhartistm
committed
test(dvm): add tests for dvm job request ingestion
Signed-off-by: Priyanshubhartistm <bhartipriyanshustm@gmail.com>
1 parent c72a67e commit 9e2bb46

5 files changed

Lines changed: 210 additions & 8 deletions

File tree

‎test/unit/factories/event-strategy-factory.spec.ts‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
import { expect } from 'chai'
22

3-
import { IEventRepository, IInviteCodeRepository, IUserRepository } from '../../../src/@types/repositories'
3+
import {
4+
IDvmJobRepository,
5+
IEventRepository,
6+
IInviteCodeRepository,
7+
IUserRepository,
8+
} from '../../../src/@types/repositories'
49
import { DefaultEventStrategy } from '../../../src/handlers/event-strategies/default-event-strategy'
510
import { DeleteEventStrategy } from '../../../src/handlers/event-strategies/delete-event-strategy'
11+
import { DvmJobRequestEventStrategy } from '../../../src/handlers/event-strategies/dvm-job-request-event-strategy'
612
import { EphemeralEventStrategy } from '../../../src/handlers/event-strategies/ephemeral-event-strategy'
713
import { Event } from '../../../src/@types/event'
814
import { EventKinds } from '../../../src/constants/base'
@@ -24,6 +30,7 @@ describe('eventStrategyFactory', () => {
2430
let eventRepository: IEventRepository
2531
let userRepository: IUserRepository
2632
let inviteCodeRepository: IInviteCodeRepository
33+
let dvmJobRepository: IDvmJobRepository
2734
let cache: ICacheAdapter
2835
let settings: () => Settings
2936
let event: Event
@@ -34,12 +41,20 @@ describe('eventStrategyFactory', () => {
3441
eventRepository = {} as any
3542
userRepository = {} as any
3643
inviteCodeRepository = {} as any
44+
dvmJobRepository = {} as any
3745
cache = {} as any
38-
settings = () => ({ info: { relay_url: 'wss://test.relay' } } as any)
46+
settings = () => ({ info: { relay_url: 'wss://test.relay' } }) as any
3947
event = {} as any
4048
adapter = {} as any
4149

42-
factory = eventStrategyFactory(eventRepository, userRepository, inviteCodeRepository, cache, settings)
50+
factory = eventStrategyFactory(
51+
eventRepository,
52+
userRepository,
53+
inviteCodeRepository,
54+
dvmJobRepository,
55+
cache,
56+
settings,
57+
)
4358
})
4459

4560
it('returns ReplaceableEvent given a set_metadata event', () => {
@@ -136,4 +151,14 @@ describe('eventStrategyFactory', () => {
136151
event.kind = EventKinds.NIP43_LEAVE_REQUEST
137152
expect(factory([event, adapter])).to.be.an.instanceOf(LeaveRequestEventStrategy)
138153
})
154+
155+
it('returns DvmJobRequestEventStrategy given a DVM job request (kind 5000-5999)', () => {
156+
event.kind = EventKinds.DVM_JOB_REQUEST_FIRST
157+
expect(factory([event, adapter])).to.be.an.instanceOf(DvmJobRequestEventStrategy)
158+
})
159+
160+
it('returns DvmJobRequestEventStrategy given the last DVM job request kind (5999)', () => {
161+
event.kind = EventKinds.DVM_JOB_REQUEST_LAST
162+
expect(factory([event, adapter])).to.be.an.instanceOf(DvmJobRequestEventStrategy)
163+
})
139164
})

‎test/unit/factories/message-handler-factory.spec.ts‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
import { expect } from 'chai'
22

3-
import { IEventRepository, IInviteCodeRepository, INip05VerificationRepository, IUserRepository } from '../../../src/@types/repositories'
3+
import {
4+
IDvmJobRepository,
5+
IEventRepository,
6+
IInviteCodeRepository,
7+
INip05VerificationRepository,
8+
IUserRepository,
9+
} from '../../../src/@types/repositories'
410
import { IncomingMessage, MessageType } from '../../../src/@types/messages'
511
import { AuthMessageHandler } from '../../../src/handlers/auth-message-handler'
612
import { Event } from '../../../src/@types/event'
@@ -19,6 +25,7 @@ describe('messageHandlerFactory', () => {
1925
let userRepository: IUserRepository
2026
let nip05VerificationRepository: INip05VerificationRepository
2127
let inviteCodeRepository: IInviteCodeRepository
28+
let dvmJobRepository: IDvmJobRepository
2229
let message: IncomingMessage
2330
let adapter: IWebSocketAdapter
2431
let factory
@@ -42,11 +49,18 @@ describe('messageHandlerFactory', () => {
4249
userRepository = {} as any
4350
nip05VerificationRepository = {} as any
4451
inviteCodeRepository = {} as any
52+
dvmJobRepository = {} as any
4553
adapter = {} as any
4654
event = {
4755
tags: [],
4856
} as any
49-
factory = messageHandlerFactory(eventRepository, userRepository, nip05VerificationRepository, inviteCodeRepository)
57+
factory = messageHandlerFactory(
58+
eventRepository,
59+
userRepository,
60+
nip05VerificationRepository,
61+
inviteCodeRepository,
62+
dvmJobRepository,
63+
)
5064
})
5165

5266
afterEach(() => {
@@ -89,4 +103,3 @@ describe('messageHandlerFactory', () => {
89103
expect(() => factory([message, adapter])).to.throw(Error, 'Unknown message type: undefined')
90104
})
91105
})
92-

‎test/unit/factories/websocket-adapter-factory.spec.ts‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@ import { IncomingMessage } from 'http'
33
import Sinon from 'sinon'
44
import WebSocket from 'ws'
55

6-
import { IEventRepository, IInviteCodeRepository, INip05VerificationRepository, IUserRepository } from '../../../src/@types/repositories'
6+
import {
7+
IDvmJobRepository,
8+
IEventRepository,
9+
IInviteCodeRepository,
10+
INip05VerificationRepository,
11+
IUserRepository,
12+
} from '../../../src/@types/repositories'
713
import { IWebSocketServerAdapter } from '../../../src/@types/adapters'
814
import { SettingsStatic } from '../../../src/utils/settings'
915
import { WebSocketAdapter } from '../../../src/adapters/web-socket-adapter'
@@ -33,6 +39,7 @@ describe('webSocketAdapterFactory', () => {
3339
const userRepository: IUserRepository = {} as any
3440
const nip05VerificationRepository: INip05VerificationRepository = {} as any
3541
const inviteCodeRepository: IInviteCodeRepository = {} as any
42+
const dvmJobRepository: IDvmJobRepository = {} as any
3643

3744
const client: WebSocket = {
3845
on: onStub,
@@ -48,7 +55,13 @@ describe('webSocketAdapterFactory', () => {
4855
} as any
4956
const webSocketServerAdapter: IWebSocketServerAdapter = {} as any
5057

51-
const factory = webSocketAdapterFactory(eventRepository, userRepository, nip05VerificationRepository, inviteCodeRepository)
58+
const factory = webSocketAdapterFactory(
59+
eventRepository,
60+
userRepository,
61+
nip05VerificationRepository,
62+
inviteCodeRepository,
63+
dvmJobRepository,
64+
)
5265
expect(factory([client, request, webSocketServerAdapter])).to.be.an.instanceOf(WebSocketAdapter)
5366
})
5467
})

‎test/unit/handlers/event-strategies/dvm-job-request-event-strategy.spec.ts‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
import chai from 'chai'
2+
import chaiAsPromised from 'chai-as-promised'
3+
import Sinon from 'sinon'
4+
5+
chai.use(chaiAsPromised)
6+
7+
const { expect } = chai
8+
9+
import { DvmJobRequestEventStrategy } from '../../../../src/handlers/event-strategies/dvm-job-request-event-strategy'
10+
import { Event } from '../../../../src/@types/event'
11+
import { IDvmJobRepository, IEventRepository } from '../../../../src/@types/repositories'
12+
import { IEventStrategy } from '../../../../src/@types/message-handlers'
13+
import { IWebSocketAdapter } from '../../../../src/@types/adapters'
14+
import { MessageType } from '../../../../src/@types/messages'
15+
import { WebSocketAdapterEvent } from '../../../../src/constants/adapter'
16+
17+
describe('DvmJobRequestEventStrategy', () => {
18+
const event: Event = {
19+
id: 'event-id',
20+
pubkey: 'requester-pubkey',
21+
kind: 5000,
22+
} as any
23+
24+
let webSocket: IWebSocketAdapter
25+
let eventRepository: IEventRepository
26+
let dvmJobRepository: IDvmJobRepository
27+
28+
let webSocketEmitStub: Sinon.SinonStub
29+
let eventRepositoryCreateStub: Sinon.SinonStub
30+
let dvmJobRepositoryCreateStub: Sinon.SinonStub
31+
32+
let strategy: IEventStrategy<Event, Promise<void>>
33+
34+
let sandbox: Sinon.SinonSandbox
35+
36+
beforeEach(() => {
37+
sandbox = Sinon.createSandbox()
38+
39+
webSocketEmitStub = sandbox.stub()
40+
webSocket = {
41+
emit: webSocketEmitStub,
42+
} as any
43+
44+
eventRepositoryCreateStub = sandbox.stub()
45+
eventRepository = {
46+
create: eventRepositoryCreateStub,
47+
} as any
48+
49+
dvmJobRepositoryCreateStub = sandbox.stub()
50+
dvmJobRepository = {
51+
create: dvmJobRepositoryCreateStub,
52+
} as any
53+
54+
strategy = new DvmJobRequestEventStrategy(webSocket, eventRepository, dvmJobRepository)
55+
})
56+
57+
afterEach(() => {
58+
sandbox.restore()
59+
})
60+
61+
describe('execute', () => {
62+
it('creates the event', async () => {
63+
eventRepositoryCreateStub.resolves(1)
64+
dvmJobRepositoryCreateStub.resolves({})
65+
66+
await strategy.execute(event)
67+
68+
expect(eventRepositoryCreateStub).to.have.been.calledOnceWithExactly(event)
69+
})
70+
71+
it('records a dvm job when the event is newly created', async () => {
72+
eventRepositoryCreateStub.resolves(1)
73+
dvmJobRepositoryCreateStub.resolves({})
74+
75+
await strategy.execute(event)
76+
77+
expect(dvmJobRepositoryCreateStub).to.have.been.calledOnceWithExactly('event-id', 'requester-pubkey', 5000)
78+
})
79+
80+
it('broadcasts the event when newly created', async () => {
81+
eventRepositoryCreateStub.resolves(1)
82+
dvmJobRepositoryCreateStub.resolves({})
83+
84+
await strategy.execute(event)
85+
86+
expect(webSocketEmitStub).to.have.been.calledWithExactly(WebSocketAdapterEvent.Message, [
87+
MessageType.OK,
88+
'event-id',
89+
true,
90+
'',
91+
])
92+
expect(webSocketEmitStub).to.have.been.calledWithExactly(WebSocketAdapterEvent.Broadcast, event)
93+
})
94+
95+
it('does not broadcast or record a job when the event is a duplicate', async () => {
96+
eventRepositoryCreateStub.resolves(0)
97+
98+
await strategy.execute(event)
99+
100+
expect(webSocketEmitStub).to.have.been.calledOnceWithExactly(WebSocketAdapterEvent.Message, [
101+
MessageType.OK,
102+
'event-id',
103+
true,
104+
'duplicate:',
105+
])
106+
expect(dvmJobRepositoryCreateStub).not.to.have.been.called
107+
})
108+
109+
it('does not reject the event when job recording fails', async () => {
110+
eventRepositoryCreateStub.resolves(1)
111+
dvmJobRepositoryCreateStub.rejects(new Error('db unavailable'))
112+
113+
await expect(strategy.execute(event)).to.eventually.be.fulfilled
114+
115+
expect(webSocketEmitStub).to.have.been.calledWithExactly(WebSocketAdapterEvent.Message, [
116+
MessageType.OK,
117+
'event-id',
118+
true,
119+
'',
120+
])
121+
})
122+
123+
it('rejects if unable to create the event', async () => {
124+
const error = new Error('event creation failed')
125+
eventRepositoryCreateStub.rejects(error)
126+
127+
await expect(strategy.execute(event)).to.eventually.be.rejectedWith(error)
128+
129+
expect(dvmJobRepositoryCreateStub).not.to.have.been.called
130+
})
131+
})
132+
})

‎test/unit/utils/event.spec.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {
44
getEventExpiration,
55
isDeleteEvent,
66
isDirectMessageEvent,
7+
isDvmJobRequestEvent,
78
isEphemeralEvent,
89
isEventIdValid,
910
isEventMatchingFilter,
@@ -415,6 +416,24 @@ describe('NIP-16', () => {
415416
expect(isEphemeralEvent({ kind: 30000 } as any)).to.be.false
416417
})
417418
})
419+
420+
describe('isDvmJobRequestEvent', () => {
421+
it('returns true for the first kind in the DVM job request range (5000)', () => {
422+
expect(isDvmJobRequestEvent({ kind: 5000 } as any)).to.be.true
423+
})
424+
425+
it('returns true for the last kind in the DVM job request range (5999)', () => {
426+
expect(isDvmJobRequestEvent({ kind: 5999 } as any)).to.be.true
427+
})
428+
429+
it('returns false for a kind below the DVM job request range', () => {
430+
expect(isDvmJobRequestEvent({ kind: 4999 } as any)).to.be.false
431+
})
432+
433+
it('returns false for a kind above the DVM job request range', () => {
434+
expect(isDvmJobRequestEvent({ kind: 6000 } as any)).to.be.false
435+
})
436+
})
418437
})
419438

420439
describe('NIP-17', () => {

0 commit comments

Comments
 (0)