From f84d36588a1096f349d68752db43247346163e82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marin=20Petruni=C4=87?= Date: Tue, 11 Oct 2022 11:51:09 -0500 Subject: [PATCH] fix: update interface-pubsub and adjust topicValidator implementation (#102) Co-authored-by: achingbrain --- package.json | 4 ++-- src/errors.ts | 7 ++++++- src/index.ts | 16 ++++++++-------- test/message.spec.ts | 16 ++++++++-------- test/pubsub.spec.ts | 2 +- test/topic-validators.spec.ts | 8 ++++---- 6 files changed, 29 insertions(+), 24 deletions(-) diff --git a/package.json b/package.json index f43f388776..82eaf9d33a 100644 --- a/package.json +++ b/package.json @@ -176,11 +176,11 @@ "release": "aegir release" }, "dependencies": { - "@libp2p/components": "^3.0.0", + "@libp2p/components": "^3.1.1", "@libp2p/crypto": "^1.0.0", "@libp2p/interface-connection": "^3.0.1", "@libp2p/interface-peer-id": "^1.0.2", - "@libp2p/interface-pubsub": "^2.0.0", + "@libp2p/interface-pubsub": "^3.0.0", "@libp2p/interface-registrar": "^2.0.0", "@libp2p/interfaces": "^3.0.2", "@libp2p/logger": "^2.0.0", diff --git a/src/errors.ts b/src/errors.ts index cbdeb51da5..9ea6ed559a 100644 --- a/src/errors.ts +++ b/src/errors.ts @@ -49,5 +49,10 @@ export const codes = { /** * Message expected to not have a `seqno`, but does */ - ERR_UNEXPECTED_SEQNO: 'ERR_UNEXPECTED_SEQNO' + ERR_UNEXPECTED_SEQNO: 'ERR_UNEXPECTED_SEQNO', + + /** + * Message failed topic validator + */ + ERR_TOPIC_VALIDATOR_REJECT: 'ERR_TOPIC_VALIDATOR_REJECT' } diff --git a/src/index.ts b/src/index.ts index c11ba06332..a05f726b7d 100644 --- a/src/index.ts +++ b/src/index.ts @@ -14,15 +14,13 @@ import { import type { PeerId } from '@libp2p/interface-peer-id' import type { IncomingStreamData } from '@libp2p/interface-registrar' import type { Connection } from '@libp2p/interface-connection' -import type { PubSub, Message, StrictNoSign, StrictSign, PubSubInit, PubSubEvents, PeerStreams, PubSubRPCMessage, PubSubRPC, PubSubRPCSubscription, SubscriptionChangeData, PublishResult } from '@libp2p/interface-pubsub' +import { PubSub, Message, StrictNoSign, StrictSign, PubSubInit, PubSubEvents, PeerStreams, PubSubRPCMessage, PubSubRPC, PubSubRPCSubscription, SubscriptionChangeData, PublishResult, TopicValidatorFn, TopicValidatorResult } from '@libp2p/interface-pubsub' import { PeerMap, PeerSet } from '@libp2p/peer-collections' import { Components, Initializable } from '@libp2p/components' import type { Uint8ArrayList } from 'uint8arraylist' const log = logger('libp2p:pubsub') -export interface TopicValidator { (topic: string, message: Message): Promise } - /** * PubSubBaseProtocol handles the peers and connections logic for pubsub routers * and specifies the API that pubsub routers should have. @@ -59,7 +57,7 @@ export abstract class PubSubBaseProtocol + public topicValidators: Map public queue: Queue public multicodecs: string[] public components: Components = new Components() @@ -420,7 +418,7 @@ export abstract class PubSubBaseProtocol { const signedMessage = await pubsub.buildMessage(message) - await expect(pubsub.validate(signedMessage)).to.eventually.not.be.rejected() + await expect(pubsub.validate(peerId, signedMessage)).to.eventually.not.be.rejected() }) it('validate with StrictNoSign will reject a message with from, signature, key, seqno present', async () => { @@ -61,19 +61,19 @@ describe('pubsub base messages', () => { } sinon.stub(pubsub, 'globalSignaturePolicy').value('StrictNoSign') - await expect(pubsub.validate(signedMessage)).to.eventually.be.rejected() + await expect(pubsub.validate(peerId, signedMessage)).to.eventually.be.rejected() // @ts-expect-error this field is not optional delete signedMessage.from - await expect(pubsub.validate(signedMessage)).to.eventually.be.rejected() + await expect(pubsub.validate(peerId, signedMessage)).to.eventually.be.rejected() // @ts-expect-error this field is not optional delete signedMessage.signature - await expect(pubsub.validate(signedMessage)).to.eventually.be.rejected() + await expect(pubsub.validate(peerId, signedMessage)).to.eventually.be.rejected() // @ts-expect-error this field is not optional delete signedMessage.key - await expect(pubsub.validate(signedMessage)).to.eventually.be.rejected() + await expect(pubsub.validate(peerId, signedMessage)).to.eventually.be.rejected() // @ts-expect-error this field is not optional delete signedMessage.sequenceNumber - await expect(pubsub.validate(signedMessage)).to.eventually.not.be.rejected() + await expect(pubsub.validate(peerId, signedMessage)).to.eventually.not.be.rejected() }) it('validate with StrictNoSign will validate a message without a signature, key, and seqno', async () => { @@ -87,7 +87,7 @@ describe('pubsub base messages', () => { sinon.stub(pubsub, 'globalSignaturePolicy').value('StrictNoSign') const signedMessage = await pubsub.buildMessage(message) - await expect(pubsub.validate(signedMessage)).to.eventually.not.be.rejected() + await expect(pubsub.validate(peerId, signedMessage)).to.eventually.not.be.rejected() }) it('validate with StrictSign requires a signature', async () => { @@ -98,6 +98,6 @@ describe('pubsub base messages', () => { topic: 'test-topic' } - await expect(pubsub.validate(message)).to.be.rejectedWith(Error, 'Signing required and no signature was present') + await expect(pubsub.validate(peerId, message)).to.be.rejectedWith(Error, 'Signing required and no signature was present') }) }) diff --git a/test/pubsub.spec.ts b/test/pubsub.spec.ts index 411f50b79e..63f9e59105 100644 --- a/test/pubsub.spec.ts +++ b/test/pubsub.spec.ts @@ -72,7 +72,7 @@ describe('pubsub base implementation', () => { // Get the first message sent to _publish, and validate it const signedMessage: Message = publishMessageSpy.getCall(0).lastArg - await expect(pubsub.validate(signedMessage)).to.eventually.be.undefined() + await expect(pubsub.validate(pubsub.components.getPeerId(), signedMessage)).to.eventually.be.undefined() }) it('calls publishes messages twice', async () => { diff --git a/test/topic-validators.spec.ts b/test/topic-validators.spec.ts index b78bb8f831..6896300ab6 100644 --- a/test/topic-validators.spec.ts +++ b/test/topic-validators.spec.ts @@ -1,7 +1,6 @@ import { expect } from 'aegir/chai' import sinon from 'sinon' import pWaitFor from 'p-wait-for' -import errCode from 'err-code' import { createEd25519PeerId } from '@libp2p/peer-id-factory' import { equals as uint8ArrayEquals } from 'uint8arrays/equals' import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string' @@ -11,7 +10,7 @@ import { PubsubImplementation } from './utils/index.js' import type { PeerId } from '@libp2p/interface-peer-id' -import type { PubSubRPC } from '@libp2p/interface-pubsub' +import { PubSubRPC, TopicValidatorResult } from '@libp2p/interface-pubsub' import { Components } from '@libp2p/components' const protocol = '/pubsub/1.0.0' @@ -50,10 +49,11 @@ describe('topic validators', () => { const peer = new PeerStreams({ id: otherPeerId, protocol: 'a-protocol' }) // Set a trivial topic validator - pubsub.topicValidators.set(filteredTopic, async (topic, message) => { + pubsub.topicValidators.set(filteredTopic, async (_otherPeerId, message) => { if (!uint8ArrayEquals(message.data, uint8ArrayFromString('a message'))) { - throw errCode(new Error(), 'ERR_TOPIC_VALIDATOR_REJECT') + return TopicValidatorResult.Reject } + return TopicValidatorResult.Accept }) // valid case