Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: migrate to it-length-prefixed 8.0.2 #312

Merged
merged 1 commit into from
Aug 3, 2022
Merged

chore: migrate to it-length-prefixed 8.0.2 #312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,12 @@
"abortable-iterator": "^4.0.2",
"denque": "^1.5.0",
"err-code": "^3.0.1",
"it-length-prefixed": "^7.0.1",
"it-length-prefixed": "^8.0.2",
"it-pipe": "^2.0.3",
"it-pushable": "^3.0.0",
"multiformats": "^9.6.4",
"protobufjs": "^6.11.2",
"uint8arraylist": "^2.0.0",
"uint8arrays": "^3.0.0"
},
"devDependencies": {
Expand Down
18 changes: 3 additions & 15 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,7 @@ import type { IncomingStreamData } from '@libp2p/interface-registrar'
import { removeFirstNItemsFromSet, removeItemsFromSet } from './utils/set.js'
import { pushable } from 'it-pushable'
import { InboundStream, OutboundStream } from './stream.js'

// From 'bl' library
interface BufferList {
slice: () => Buffer
}
import { Uint8ArrayList } from 'uint8arraylist'

type ConnectionDirection = 'inbound' | 'outbound'

Expand Down Expand Up @@ -866,21 +862,13 @@ export class GossipSub extends EventEmitter<GossipsubEvents> implements Initiali
/**
* Responsible for processing each RPC message received by other peers.
*/
private async pipePeerReadStream(peerId: PeerId, stream: AsyncIterable<Uint8Array | BufferList>): Promise<void> {
private async pipePeerReadStream(peerId: PeerId, stream: AsyncIterable<Uint8ArrayList>): Promise<void> {
try {
await pipe(stream, async (source) => {
for await (const data of source) {
try {
// TODO: Check max gossip message size, before decodeRpc()

// Note: `stream` maybe a BufferList which requires calling .slice to concat all the chunks into
// a single Buffer instance that protobuf js can deal with.
// Otherwise it will throw:
// ```
// Error: illegal buffer
// at create_typed_array (js-libp2p-gossipsub/node_modules/protobufjs/src/reader.js:47:15)
const rpcBytes = data instanceof Uint8Array ? data : data.slice()

const rpcBytes = data.subarray()
// Note: This function may throw, it must be wrapped in a try {} catch {} to prevent closing the stream.
// TODO: What should we do if the entire RPC is invalid?
const rpc = RPC.decode(rpcBytes)
Expand Down
3 changes: 2 additions & 1 deletion src/stream.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { abortableSource } from 'abortable-iterator'
import { pipe } from 'it-pipe'
import { pushable, Pushable } from 'it-pushable'
import { encode, decode } from 'it-length-prefixed'
import { Uint8ArrayList } from 'uint8arraylist'

export class OutboundStream {
private readonly rawStream: Stream
Expand Down Expand Up @@ -37,7 +38,7 @@ export class OutboundStream {
}

export class InboundStream {
public readonly source: AsyncIterable<Uint8Array>
public readonly source: AsyncIterable<Uint8ArrayList>

private readonly rawStream: Stream
private readonly closeController: AbortController
Expand Down