Skip to content

Commit

Permalink
feat: add mock stream pair (#2069)
Browse files Browse the repository at this point in the history
Adds a `streamPair` convenience function to the interface mocks that
returns two `Stream` objects where the duplex streams read/write
to/from the other.
  • Loading branch information
achingbrain committed Sep 26, 2023
1 parent 72319fe commit e3ab192
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
31 changes: 29 additions & 2 deletions packages/interface-compliance-tests/src/mocks/connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,13 @@ export function mockConnection (maConn: MultiaddrConnection, opts: MockConnectio
return connection
}

export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>>): Stream {
export interface StreamInit {
direction?: Direction
protocol?: string
id?: string
}

export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>>, init: StreamInit = {}): Stream {
return {
...stream,
close: async () => {},
Expand All @@ -186,10 +192,31 @@ export function mockStream (stream: Duplex<AsyncGenerator<Uint8ArrayList>, Sourc
id: `stream-${Date.now()}`,
status: 'open',
readStatus: 'ready',
writeStatus: 'ready'
writeStatus: 'ready',
...init
}
}

export interface StreamPairInit {
duplex: Duplex<AsyncGenerator<Uint8ArrayList>, Source<Uint8ArrayList | Uint8Array>, Promise<void>>
init?: StreamInit
}

export function streamPair (a: StreamPairInit, b: StreamPairInit, init: StreamInit = {}): [Stream, Stream] {
return [
mockStream(a.duplex, {
direction: 'outbound',
...init,
...(a.init ?? {})
}),
mockStream(b.duplex, {
direction: 'inbound',
...init,
...(b.init ?? {})
})
]
}

export interface Peer {
peerId: PeerId
registrar: Registrar
Expand Down
2 changes: 1 addition & 1 deletion packages/interface-compliance-tests/src/mocks/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export { mockConnectionEncrypter } from './connection-encrypter.js'
export { mockConnectionGater } from './connection-gater.js'
export { mockConnectionManager, mockNetwork } from './connection-manager.js'
export { mockConnection, mockStream, connectionPair } from './connection.js'
export { mockConnection, mockStream, streamPair, connectionPair } from './connection.js'
export { mockMultiaddrConnection, mockMultiaddrConnPair } from './multiaddr-connection.js'
export { mockMuxer } from './muxer.js'
export { mockRegistrar } from './registrar.js'
Expand Down

0 comments on commit e3ab192

Please sign in to comment.