@libp2p/interface-compliance-tests 3.0.7-05abd49f → 3.0.7-06f4901a

package/dist/src/pubsub/two-nodes.js

@@ -0,0 +1,217 @@
+/* eslint max-nested-callbacks: ["error", 6] */
+import { TopicValidatorResult } from '@libp2p/interface/pubsub';
+import { start, stop } from '@libp2p/interface/startable';
+import { expect } from 'aegir/chai';
+import pDefer from 'p-defer';
+import pWaitFor from 'p-wait-for';
+import sinon from 'sinon';
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string';
+import { mockNetwork } from '../mocks/index.js';
+import { createComponents, waitForSubscriptionUpdate } from './utils.js';
+const topic = 'foo';
+function shouldNotHappen() {
+    expect.fail();
+}
+export default (common) => {
+    describe('pubsub with two nodes', () => {
+        let psA;
+        let psB;
+        let componentsA;
+        let componentsB;
+        // Create pubsub nodes and connect them
+        beforeEach(async () => {
+            mockNetwork.reset();
+            componentsA = await createComponents();
+            componentsB = await createComponents();
+            psA = componentsA.pubsub = await common.setup({
+                components: componentsA,
+                init: {
+                    emitSelf: true
+                }
+            });
+            psB = componentsB.pubsub = await common.setup({
+                components: componentsB,
+                init: {
+                    emitSelf: false
+                }
+            });
+            // Start pubsub and connect nodes
+            await start(...Object.values(componentsA), ...Object.values(componentsB));
+            expect(psA.getPeers()).to.be.empty();
+            expect(psB.getPeers()).to.be.empty();
+            await componentsA.connectionManager.openConnection(componentsB.peerId);
+            // Wait for peers to be ready in pubsub
+            await pWaitFor(() => psA.getPeers().length === 1 && psB.getPeers().length === 1);
+        });
+        afterEach(async () => {
+            sinon.restore();
+            await stop(...Object.values(componentsA), ...Object.values(componentsB));
+            await common.teardown();
+            mockNetwork.reset();
+        });
+        it('Subscribe to a topic in nodeA', async () => {
+            const defer = pDefer();
+            psB.addEventListener('subscription-change', (evt) => {
+                const { peerId: changedPeerId, subscriptions: changedSubs } = evt.detail;
+                expect(psA.getTopics()).to.deep.equal([topic]);
+                expect(psB.getPeers()).to.have.lengthOf(1);
+                expect(psB.getSubscribers(topic).map(p => p.toString())).to.deep.equal([componentsA.peerId.toString()]);
+                expect(changedPeerId).to.deep.equal(psB.getPeers()[0]);
+                expect(changedSubs).to.have.lengthOf(1);
+                expect(changedSubs[0].topic).to.equal(topic);
+                expect(changedSubs[0].subscribe).to.equal(true);
+                defer.resolve();
+            }, {
+                once: true
+            });
+            psA.subscribe(topic);
+            return defer.promise;
+        });
+        it('Publish to a topic in nodeA', async () => {
+            const defer = pDefer();
+            psA.addEventListener('message', (evt) => {
+                if (evt.detail.topic === topic) {
+                    const msg = evt.detail;
+                    expect(uint8ArrayToString(msg.data)).to.equal('hey');
+                    psB.removeEventListener('message', shouldNotHappen);
+                    defer.resolve();
+                }
+            }, {
+                once: true
+            });
+            psA.subscribe(topic);
+            psB.subscribe(topic);
+            await Promise.all([
+                waitForSubscriptionUpdate(psA, componentsB.peerId),
+                waitForSubscriptionUpdate(psB, componentsA.peerId)
+            ]);
+            await psA.publish(topic, uint8ArrayFromString('hey'));
+            return defer.promise;
+        });
+        it('Publish to a topic in nodeB', async () => {
+            const defer = pDefer();
+            psA.addEventListener('message', (evt) => {
+                if (evt.detail.topic !== topic) {
+                    return;
+                }
+                const msg = evt.detail;
+                psA.addEventListener('message', (evt) => {
+                    if (evt.detail.topic === topic) {
+                        shouldNotHappen();
+                    }
+                }, {
+                    once: true
+                });
+                expect(uint8ArrayToString(msg.data)).to.equal('banana');
+                setTimeout(() => {
+                    psA.removeEventListener('message');
+                    psB.removeEventListener('message');
+                    defer.resolve();
+                }, 100);
+            }, {
+                once: true
+            });
+            psB.addEventListener('message', shouldNotHappen);
+            psA.subscribe(topic);
+            psB.subscribe(topic);
+            await Promise.all([
+                waitForSubscriptionUpdate(psA, componentsB.peerId),
+                waitForSubscriptionUpdate(psB, componentsA.peerId)
+            ]);
+            await psB.publish(topic, uint8ArrayFromString('banana'));
+            return defer.promise;
+        });
+        it('validate topic message', async () => {
+            const defer = pDefer();
+            psA.subscribe(topic);
+            psB.topicValidators.set(topic, (peer, message) => {
+                if (!peer.equals(componentsA.peerId)) {
+                    defer.reject(new Error('Invalid peer id in topic validator fn'));
+                    return TopicValidatorResult.Reject;
+                }
+                if (uint8ArrayToString(message.data) !== 'hey') {
+                    defer.reject(new Error('Invalid message in topic validator fn'));
+                    return TopicValidatorResult.Reject;
+                }
+                defer.resolve();
+                return TopicValidatorResult.Accept;
+            });
+            psB.subscribe(topic);
+            await Promise.all([
+                waitForSubscriptionUpdate(psA, componentsB.peerId),
+                waitForSubscriptionUpdate(psB, componentsA.peerId)
+            ]);
+            await psA.publish(topic, uint8ArrayFromString('hey'));
+            return defer.promise;
+        });
+        it('Publish 10 msg to a topic in nodeB', async () => {
+            const defer = pDefer();
+            let counter = 0;
+            psB.addEventListener('message', shouldNotHappen);
+            psA.addEventListener('message', receivedMsg);
+            function receivedMsg(evt) {
+                const msg = evt.detail;
+                if (msg.type === 'unsigned') {
+                    expect(uint8ArrayToString(msg.data)).to.equal('banana');
+                    expect(msg.topic).to.be.equal(topic);
+                }
+                else {
+                    expect(uint8ArrayToString(msg.data)).to.equal('banana');
+                    expect(msg.from.toString()).to.equal(componentsB.peerId.toString());
+                    expect(msg.sequenceNumber).to.be.a('BigInt');
+                    expect(msg.topic).to.be.equal(topic);
+                }
+                if (++counter === 10) {
+                    psA.removeEventListener('message', receivedMsg);
+                    psB.removeEventListener('message', shouldNotHappen);
+                    defer.resolve();
+                }
+            }
+            psA.subscribe(topic);
+            psB.subscribe(topic);
+            await Promise.all([
+                waitForSubscriptionUpdate(psA, componentsB.peerId),
+                waitForSubscriptionUpdate(psB, componentsA.peerId)
+            ]);
+            await Promise.all(Array.from({ length: 10 }, async (_, i) => {
+                await psB.publish(topic, uint8ArrayFromString('banana'));
+            }));
+            return defer.promise;
+        });
+        it('Unsubscribe from topic in nodeA', async () => {
+            const defer = pDefer();
+            let callCount = 0;
+            psB.addEventListener('subscription-change', (evt) => {
+                callCount++;
+                if (callCount === 1) {
+                    // notice subscribe
+                    const { peerId: changedPeerId, subscriptions: changedSubs } = evt.detail;
+                    expect(psB.getPeers()).to.have.lengthOf(1);
+                    expect(psB.getTopics()).to.be.empty();
+                    expect(changedPeerId).to.deep.equal(psB.getPeers()[0]);
+                    expect(changedSubs).to.have.lengthOf(1);
+                    expect(changedSubs[0].topic).to.equal(topic);
+                    expect(changedSubs[0].subscribe).to.equal(true);
+                }
+                else {
+                    // notice unsubscribe
+                    const { peerId: changedPeerId, subscriptions: changedSubs } = evt.detail;
+                    expect(psB.getPeers()).to.have.lengthOf(1);
+                    expect(psB.getTopics()).to.be.empty();
+                    expect(changedPeerId).to.deep.equal(psB.getPeers()[0]);
+                    expect(changedSubs).to.have.lengthOf(1);
+                    expect(changedSubs[0].topic).to.equal(topic);
+                    expect(changedSubs[0].subscribe).to.equal(false);
+                    defer.resolve();
+                }
+            });
+            psA.subscribe(topic);
+            expect(psA.getTopics()).to.not.be.empty();
+            psA.unsubscribe(topic);
+            expect(psA.getTopics()).to.be.empty();
+            return defer.promise;
+        });
+    });
+};
+//# sourceMappingURL=two-nodes.js.map

package/dist/src/pubsub/two-nodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"two-nodes.js","sourceRoot":"","sources":["../../../src/pubsub/two-nodes.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACnC,OAAO,MAAM,MAAM,SAAS,CAAA;AAC5B,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAE,QAAQ,IAAI,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAA;AAKxE,MAAM,KAAK,GAAG,KAAK,CAAA;AAEnB,SAAS,eAAe;IACtB,MAAM,CAAC,IAAI,EAAE,CAAA;AACf,CAAC;AAED,eAAe,CAAC,MAAqC,EAAQ,EAAE;IAC7D,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,IAAI,GAAW,CAAA;QACf,IAAI,GAAW,CAAA;QACf,IAAI,WAA6B,CAAA;QACjC,IAAI,WAA6B,CAAA;QAEjC,uCAAuC;QACvC,UAAU,CAAC,KAAK,IAAI,EAAE;YACpB,WAAW,CAAC,KAAK,EAAE,CAAA;YAEnB,WAAW,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACtC,WAAW,GAAG,MAAM,gBAAgB,EAAE,CAAA;YAEtC,GAAG,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC;gBAC5C,UAAU,EAAE,WAAW;gBACvB,IAAI,EAAE;oBACJ,QAAQ,EAAE,IAAI;iBACf;aACF,CAAC,CAAA;YACF,GAAG,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC;gBAC5C,UAAU,EAAE,WAAW;gBACvB,IAAI,EAAE;oBACJ,QAAQ,EAAE,KAAK;iBAChB;aACF,CAAC,CAAA;YAEF,iCAAiC;YACjC,MAAM,KAAK,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAA;YAEzE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;YACpC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;YAEpC,MAAM,WAAW,CAAC,iBAAiB,CAAC,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;YAEtE,uCAAuC;YACvC,MAAM,QAAQ,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC,CAAA;QAClF,CAAC,CAAC,CAAA;QAEF,SAAS,CAAC,KAAK,IAAI,EAAE;YACnB,KAAK,CAAC,OAAO,EAAE,CAAA;YACf,MAAM,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAA;YACxE,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAA;YACvB,WAAW,CAAC,KAAK,EAAE,CAAA;QACrB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;YAC7C,MAAM,KAAK,GAAG,MAAM,EAAE,CAAA;YAEtB,GAAG,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,CAAC,GAAG,EAAE,EAAE;gBAClD,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC,MAAM,CAAA;gBACxE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;gBAC9C,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBAC1C,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;gBACvG,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;gBACtD,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;gBACvC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;gBAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAC/C,KAAK,CAAC,OAAO,EAAE,CAAA;YACjB,CAAC,EAAE;gBACD,IAAI,EAAE,IAAI;aACX,CAAC,CAAA;YACF,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAEpB,OAAO,KAAK,CAAC,OAAO,CAAA;QACtB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YAC3C,MAAM,KAAK,GAAG,MAAM,EAAE,CAAA;YAEtB,GAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;gBACtC,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,EAAE;oBAC9B,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAA;oBACtB,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBACpD,GAAG,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAA;oBACnD,KAAK,CAAC,OAAO,EAAE,CAAA;iBAChB;YACH,CAAC,EAAE;gBACD,IAAI,EAAE,IAAI;aACX,CAAC,CAAA;YAEF,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YACpB,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAEpB,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;gBAClD,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;aACnD,CAAC,CAAA;YAEF,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YAErD,OAAO,KAAK,CAAC,OAAO,CAAA;QACtB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;YAC3C,MAAM,KAAK,GAAG,MAAM,EAAE,CAAA;YAEtB,GAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;gBACtC,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,EAAE;oBAC9B,OAAM;iBACP;gBAED,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAA;gBACtB,GAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;oBACtC,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,EAAE;wBAC9B,eAAe,EAAE,CAAA;qBAClB;gBACH,CAAC,EAAE;oBACD,IAAI,EAAE,IAAI;iBACX,CAAC,CAAA;gBACF,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;gBAEvD,UAAU,CAAC,GAAG,EAAE;oBACd,GAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAA;oBAClC,GAAG,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAA;oBAElC,KAAK,CAAC,OAAO,EAAE,CAAA;gBACjB,CAAC,EAAE,GAAG,CAAC,CAAA;YACT,CAAC,EAAE;gBACD,IAAI,EAAE,IAAI;aACX,CAAC,CAAA;YAEF,GAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAA;YAEhD,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YACpB,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAEpB,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;gBAClD,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;aACnD,CAAC,CAAA;YAEF,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAA;YAExD,OAAO,KAAK,CAAC,OAAO,CAAA;QACtB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;YACtC,MAAM,KAAK,GAAG,MAAM,EAAE,CAAA;YAEtB,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAEpB,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;gBAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE;oBACpC,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC,CAAA;oBAChE,OAAO,oBAAoB,CAAC,MAAM,CAAA;iBACnC;gBAED,IAAI,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,EAAE;oBAC9C,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC,CAAA;oBAChE,OAAO,oBAAoB,CAAC,MAAM,CAAA;iBACnC;gBAED,KAAK,CAAC,OAAO,EAAE,CAAA;gBACf,OAAO,oBAAoB,CAAC,MAAM,CAAA;YACpC,CAAC,CAAC,CAAA;YACF,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAEpB,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;gBAClD,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;aACnD,CAAC,CAAA;YAEF,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YAErD,OAAO,KAAK,CAAC,OAAO,CAAA;QACtB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,KAAK,GAAG,MAAM,EAAE,CAAA;YACtB,IAAI,OAAO,GAAG,CAAC,CAAA;YAEf,GAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAA;YAChD,GAAG,CAAC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;YAE5C,SAAS,WAAW,CAAE,GAAyB;gBAC7C,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAA;gBACtB,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;oBAC3B,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;oBACvD,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;iBACrC;qBAAM;oBACL,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;oBACvD,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;oBACnE,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAA;oBAC5C,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;iBACrC;gBAED,IAAI,EAAE,OAAO,KAAK,EAAE,EAAE;oBACpB,GAAG,CAAC,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAA;oBAC/C,GAAG,CAAC,mBAAmB,CAAC,SAAS,EAAE,eAAe,CAAC,CAAA;oBAEnD,KAAK,CAAC,OAAO,EAAE,CAAA;iBAChB;YACH,CAAC;YAED,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YACpB,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YAEpB,MAAM,OAAO,CAAC,GAAG,CAAC;gBAChB,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;gBAClD,yBAAyB,CAAC,GAAG,EAAE,WAAW,CAAC,MAAM,CAAC;aACnD,CAAC,CAAA;YAEF,MAAM,OAAO,CAAC,GAAG,CACf,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;gBACxC,MAAM,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAA;YAC1D,CAAC,CAAC,CACH,CAAA;YAED,OAAO,KAAK,CAAC,OAAO,CAAA;QACtB,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;YAC/C,MAAM,KAAK,GAAG,MAAM,EAAE,CAAA;YACtB,IAAI,SAAS,GAAG,CAAC,CAAA;YAEjB,GAAG,CAAC,gBAAgB,CAAC,qBAAqB,EAAE,CAAC,GAAG,EAAE,EAAE;gBAClD,SAAS,EAAE,CAAA;gBAEX,IAAI,SAAS,KAAK,CAAC,EAAE;oBACnB,mBAAmB;oBACnB,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC,MAAM,CAAA;oBACxE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;oBAC1C,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;oBACrC,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;oBACtD,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;oBACvC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;iBAChD;qBAAM;oBACL,qBAAqB;oBACrB,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,GAAG,CAAC,MAAM,CAAA;oBACxE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;oBAC1C,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;oBACrC,MAAM,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;oBACtD,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;oBACvC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBAEhD,KAAK,CAAC,OAAO,EAAE,CAAA;iBAChB;YACH,CAAC,CAAC,CAAA;YAEF,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YACpB,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;YAEzC,GAAG,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;YACtB,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;YAErC,OAAO,KAAK,CAAC,OAAO,CAAA;QACtB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/src/pubsub/utils.d.ts

@@ -0,0 +1,6 @@
+import type { MockNetworkComponents } from '../mocks/index.js';
+import type { PeerId } from '@libp2p/interface/peer-id';
+import type { PubSub } from '@libp2p/interface/pubsub';
+export declare function waitForSubscriptionUpdate(a: PubSub, b: PeerId): Promise<void>;
+export declare function createComponents(): Promise<MockNetworkComponents>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/pubsub/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/pubsub/utils.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAA0B,MAAM,0BAA0B,CAAA;AAE9E,wBAAsB,yBAAyB,CAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMpF;AAED,wBAAsB,gBAAgB,IAAK,OAAO,CAAC,qBAAqB,CAAC,CAWxE"}

package/dist/src/pubsub/utils.js

@@ -0,0 +1,22 @@
+import { EventEmitter } from '@libp2p/interface/events';
+import { createEd25519PeerId } from '@libp2p/peer-id-factory';
+import { pEvent } from 'p-event';
+import pWaitFor from 'p-wait-for';
+import { mockConnectionManager, mockRegistrar, mockNetwork } from '../mocks/index.js';
+export async function waitForSubscriptionUpdate(a, b) {
+    await pWaitFor(async () => {
+        const event = await pEvent(a, 'subscription-change');
+        return event.detail.peerId.equals(b);
+    });
+}
+export async function createComponents() {
+    const components = {
+        peerId: await createEd25519PeerId(),
+        registrar: mockRegistrar(),
+        events: new EventEmitter()
+    };
+    components.connectionManager = mockConnectionManager(components);
+    mockNetwork.addNode(components);
+    return components;
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/pubsub/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/pubsub/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAChC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAKrF,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAE,CAAS,EAAE,CAAS;IACnE,MAAM,QAAQ,CAAC,KAAK,IAAI,EAAE;QACxB,MAAM,KAAK,GAAG,MAAM,MAAM,CAA6D,CAAC,EAAE,qBAAqB,CAAC,CAAA;QAEhH,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IACtC,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB;IACpC,MAAM,UAAU,GAAQ;QACtB,MAAM,EAAE,MAAM,mBAAmB,EAAE;QACnC,SAAS,EAAE,aAAa,EAAE;QAC1B,MAAM,EAAE,IAAI,YAAY,EAAE;KAC3B,CAAA;IACD,UAAU,CAAC,iBAAiB,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAA;IAEhE,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;IAE/B,OAAO,UAAU,CAAA;AACnB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/interface-compliance-tests",
-  "version": "3.0.7-05abd49f",
+  "version": "3.0.7-06f4901a",
   "description": "Compliance tests for JS libp2p interfaces",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/interface-compliance-tests#readme",
@@ -68,6 +68,10 @@
       "types": "./dist/src/peers.d.ts",
       "import": "./dist/src/peers.js"
     },
+    "./pubsub": {
+      "types": "./dist/src/pubsub/index.d.ts",
+      "import": "./dist/src/pubsub/index.js"
+    },
     "./stream-muxer": {
       "types": "./dist/src/stream-muxer/index.d.ts",
       "import": "./dist/src/stream-muxer/index.js"
@@ -97,13 +101,13 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
-    "@libp2p/interface": "0.0.1-05abd49f",
-    "@libp2p/interface-internal": "0.0.1-05abd49f",
-    "@libp2p/logger": "2.1.1-05abd49f",
-    "@libp2p/multistream-select": "3.1.9-05abd49f",
-    "@libp2p/peer-collections": "3.0.2-05abd49f",
-    "@libp2p/peer-id": "2.0.3-05abd49f",
-    "@libp2p/peer-id-factory": "2.0.3-05abd49f",
+    "@libp2p/interface": "0.0.1-06f4901a",
+    "@libp2p/interface-internal": "0.0.1-06f4901a",
+    "@libp2p/logger": "2.1.1-06f4901a",
+    "@libp2p/multistream-select": "3.1.9-06f4901a",
+    "@libp2p/peer-collections": "3.0.2-06f4901a",
+    "@libp2p/peer-id": "2.0.3-06f4901a",
+    "@libp2p/peer-id-factory": "2.0.3-06f4901a",
     "@multiformats/multiaddr": "^12.1.3",
     "abortable-iterator": "^5.0.1",
     "any-signal": "^4.1.1",
@@ -119,6 +123,7 @@
     "it-stream-types": "^2.0.1",
     "merge-options": "^3.0.4",
     "p-defer": "^4.0.0",
+    "p-event": "^6.0.0",
     "p-limit": "^4.0.0",
     "p-wait-for": "^5.0.2",
     "sinon": "^15.1.2",

package/src/mocks/connection-manager.ts

@@ -7,6 +7,7 @@ import { connectionPair } from './connection.js'
 import type { Libp2pEvents } from '@libp2p/interface'
 import type { Connection } from '@libp2p/interface/connection'
 import type { EventEmitter } from '@libp2p/interface/events'
+import type { PubSub } from '@libp2p/interface/pubsub'
 import type { Startable } from '@libp2p/interface/startable'
 import type { ConnectionManager, PendingDial } from '@libp2p/interface-internal/connection-manager'
 import type { Registrar } from '@libp2p/interface-internal/registrar'
@@ -16,6 +17,7 @@ export interface MockNetworkComponents {
   registrar: Registrar
   connectionManager: ConnectionManager
   events: EventEmitter<Libp2pEvents>
+  pubsub?: PubSub
 }
 
 class MockNetwork {

package/src/pubsub/api.ts

@@ -0,0 +1,114 @@
+import { isStartable, start, stop } from '@libp2p/interface/startable'
+import { expect } from 'aegir/chai'
+import delay from 'delay'
+import pDefer from 'p-defer'
+import pWaitFor from 'p-wait-for'
+import sinon from 'sinon'
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
+import { mockNetwork } from '../mocks/index.js'
+import { createComponents } from './utils.js'
+import type { PubSubArgs, PubSubComponents } from './index.js'
+import type { TestSetup } from '../index.js'
+import type { PubSub } from '@libp2p/interface/pubsub'
+
+const topic = 'foo'
+const data = uint8ArrayFromString('bar')
+
+export default (common: TestSetup<PubSub, PubSubArgs>): void => {
+  describe('pubsub api', () => {
+    let pubsub: PubSub
+    let components: PubSubComponents
+
+    // Create pubsub router
+    beforeEach(async () => {
+      mockNetwork.reset()
+      components = await createComponents()
+
+      pubsub = components.pubsub = await common.setup({
+        components,
+        init: {
+          emitSelf: true
+        }
+      })
+    })
+
+    afterEach(async () => {
+      sinon.restore()
+      await stop(...Object.values(components))
+      await common.teardown()
+      mockNetwork.reset()
+    })
+
+    it('can start correctly', async () => {
+      if (!isStartable(pubsub)) {
+        return
+      }
+
+      sinon.spy(components.registrar, 'register')
+
+      await start(...Object.values(components))
+
+      expect(pubsub.isStarted()).to.equal(true)
+      expect(components.registrar.register).to.have.property('callCount', 1)
+    })
+
+    it('can stop correctly', async () => {
+      if (!isStartable(pubsub)) {
+        return
+      }
+
+      sinon.spy(components.registrar, 'unregister')
+
+      await start(...Object.values(components))
+      await stop(...Object.values(components))
+
+      expect(pubsub.isStarted()).to.equal(false)
+      expect(components.registrar.unregister).to.have.property('callCount', 1)
+    })
+
+    it('can subscribe and unsubscribe correctly', async () => {
+      const handler = (): void => {
+        throw new Error('a message should not be received')
+      }
+
+      await start(...Object.values(components))
+      pubsub.subscribe(topic)
+      pubsub.addEventListener('message', handler)
+
+      await pWaitFor(() => {
+        const topics = pubsub.getTopics()
+        return topics.length === 1 && topics[0] === topic
+      })
+
+      pubsub.removeEventListener('message', handler)
+      pubsub.unsubscribe(topic)
+
+      await pWaitFor(() => pubsub.getTopics().length === 0)
+
+      // Publish to guarantee the handler is not called
+      await pubsub.publish(topic, data)
+
+      // handlers are called async
+      await delay(100)
+
+      await stop(...Object.values(components))
+    })
+
+    it('can subscribe and publish correctly', async () => {
+      const defer = pDefer()
+
+      await start(...Object.values(components))
+
+      pubsub.subscribe(topic)
+      pubsub.addEventListener('message', (evt) => {
+        expect(evt).to.have.nested.property('detail.topic', topic)
+        expect(evt).to.have.deep.nested.property('detail.data', data)
+        defer.resolve()
+      })
+      await pubsub.publish(topic, data)
+      await defer.promise
+
+      await stop(...Object.values(components))
+    })
+  })
+}