Use one object as we are increasing the number of parameters

This commit is contained in:
Franck Royer 2021-05-07 16:10:58 +10:00
parent d1ef76f7f9
commit 4b6fe84392
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
6 changed files with 59 additions and 32 deletions

View File

@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] ## [Unreleased]
### Added
- `callback` argument to `WakuStore.queryHistory()`, called as messages are retrieved
; Messages are retrieved using pagination, and it may take some time to retrieve all messages,
with the `callback` function, messages are processed as soon as they are received.
### Changed ### Changed
- Testing: Upgrade nim-waku node to v0.3. - Testing: Upgrade nim-waku node to v0.3.

View File

@ -76,9 +76,10 @@ export default async function startChat(): Promise<void> {
console.log( console.log(
`Retrieving archived messages from ${peerId.toB58String()}` `Retrieving archived messages from ${peerId.toB58String()}`
); );
const messages = await waku.store.queryHistory(peerId, [ const messages = await waku.store.queryHistory({
ChatContentTopic, peerId,
]); contentTopics: [ChatContentTopic],
});
messages?.map((msg) => { messages?.map((msg) => {
if (msg.payload) { if (msg.payload) {
const chatMsg = ChatMessage.decode(msg.payload); const chatMsg = ChatMessage.decode(msg.payload);

View File

@ -68,9 +68,10 @@ export default function App() {
if (protocols.includes(StoreCodec)) { if (protocols.includes(StoreCodec)) {
console.log(`${peerId.toB58String()}: retrieving archived messages}`); console.log(`${peerId.toB58String()}: retrieving archived messages}`);
try { try {
const response = await waku.store.queryHistory(peerId, [ const response = await waku.store.queryHistory({
ChatContentTopic, peerId,
]); contentTopics: [ChatContentTopic],
});
console.log(`${peerId.toB58String()}: messages retrieved:`, response); console.log(`${peerId.toB58String()}: messages retrieved:`, response);
if (response) { if (response) {
const messages = response const messages = response

View File

@ -2,31 +2,34 @@ import { Reader } from 'protobufjs/minimal';
import { v4 as uuid } from 'uuid'; import { v4 as uuid } from 'uuid';
import * as proto from '../../proto/waku/v2/store'; import * as proto from '../../proto/waku/v2/store';
import { DefaultContentTopic } from '../waku_message';
import { DefaultPubsubTopic } from '../waku_relay'; export interface Options {
contentTopics: string[];
cursor?: proto.Index;
pubsubTopic: string;
}
export class HistoryRPC { export class HistoryRPC {
public constructor(public proto: proto.HistoryRPC) {} public constructor(public proto: proto.HistoryRPC) {}
static createQuery( /**
contentTopics: string[] = [DefaultContentTopic], * Create History Query.
cursor?: proto.Index, */
pubsubTopic: string = DefaultPubsubTopic static createQuery(options: Options): HistoryRPC {
): HistoryRPC {
const pagingInfo = { const pagingInfo = {
pageSize: 10, pageSize: 10,
cursor, cursor: options.cursor,
direction: proto.PagingInfo_Direction.DIRECTION_FORWARD, direction: proto.PagingInfo_Direction.DIRECTION_FORWARD,
}; };
const contentFilters = contentTopics.map((contentTopic) => { const contentFilters = options.contentTopics.map((contentTopic) => {
return { contentTopic }; return { contentTopic };
}); });
return new HistoryRPC({ return new HistoryRPC({
requestId: uuid(), requestId: uuid(),
query: { query: {
pubsubTopic, pubsubTopic: options.pubsubTopic,
contentFilters, contentFilters,
pagingInfo, pagingInfo,
startTime: undefined, startTime: undefined,

View File

@ -3,7 +3,7 @@ import TCP from 'libp2p-tcp';
import { makeLogFileName, NimWaku, NOISE_KEY_1 } from '../../test_utils'; import { makeLogFileName, NimWaku, NOISE_KEY_1 } from '../../test_utils';
import { Waku } from '../waku'; import { Waku } from '../waku';
import { WakuMessage } from '../waku_message'; import { DefaultContentTopic, WakuMessage } from '../waku_message';
describe('Waku Store', () => { describe('Waku Store', () => {
let waku: Waku; let waku: Waku;
@ -39,7 +39,10 @@ describe('Waku Store', () => {
const nimPeerId = await nimWaku.getPeerId(); const nimPeerId = await nimWaku.getPeerId();
const messages = await waku.store.queryHistory(nimPeerId); const messages = await waku.store.queryHistory({
peerId: nimPeerId,
contentTopics: [],
});
expect(messages?.length).eq(2); expect(messages?.length).eq(2);
const result = messages?.findIndex((msg) => { const result = messages?.findIndex((msg) => {
@ -73,7 +76,10 @@ describe('Waku Store', () => {
const nimPeerId = await nimWaku.getPeerId(); const nimPeerId = await nimWaku.getPeerId();
const messages = await waku.store.queryHistory(nimPeerId); const messages = await waku.store.queryHistory({
peerId: nimPeerId,
contentTopics: [DefaultContentTopic],
});
expect(messages?.length).eq(15); expect(messages?.length).eq(15);
for (let index = 0; index < 2; index++) { for (let index = 0; index < 2; index++) {

View File

@ -5,11 +5,18 @@ import Libp2p from 'libp2p';
import PeerId from 'peer-id'; import PeerId from 'peer-id';
import { WakuMessage } from '../waku_message'; import { WakuMessage } from '../waku_message';
import { DefaultPubsubTopic } from '../waku_relay';
import { HistoryRPC } from './history_rpc'; import { HistoryRPC } from './history_rpc';
export const StoreCodec = '/vac/waku/store/2.0.0-beta3'; export const StoreCodec = '/vac/waku/store/2.0.0-beta3';
export interface Options {
peerId: PeerId;
contentTopics: string[];
pubsubTopic?: string;
}
/** /**
* Implements the [Waku v2 Store protocol](https://rfc.vac.dev/spec/13/). * Implements the [Waku v2 Store protocol](https://rfc.vac.dev/spec/13/).
*/ */
@ -19,19 +26,23 @@ export class WakuStore {
/** /**
* Query given peer using Waku Store. * Query given peer using Waku Store.
* *
* @param peerId The peer to query. * @param options
* @param contentTopics The content topics to retrieve, leave empty to * @param options.peerId The peer to query.
* @param options.contentTopics The content topics to retrieve, leave empty to
* retrieve all messages. * retrieve all messages.
* @param pubsubTopic The pubsub topic to retrieve. Currently, all waku nodes * @param options.pubsubTopic The pubsub topic to retrieve. Currently, all waku nodes
* use the same pubsub topic. This is reserved for future applications. * use the same pubsub topic. This is reserved for future applications.
* @throws If not able to reach the peer to query. * @throws If not able to reach the peer to query.
*/ */
async queryHistory( async queryHistory(options: Options): Promise<WakuMessage[] | null> {
peerId: PeerId, const opts = Object.assign(
contentTopics?: string[], {
pubsubTopic?: string pubsubTopic: DefaultPubsubTopic,
): Promise<WakuMessage[] | null> { },
const peer = this.libp2p.peerStore.get(peerId); options
);
const peer = this.libp2p.peerStore.get(opts.peerId);
if (!peer) throw 'Peer is unknown'; if (!peer) throw 'Peer is unknown';
if (!peer.protocols.includes(StoreCodec)) if (!peer.protocols.includes(StoreCodec))
throw 'Peer does not register waku store protocol'; throw 'Peer does not register waku store protocol';
@ -44,11 +55,11 @@ export class WakuStore {
try { try {
const { stream } = await connection.newStream(StoreCodec); const { stream } = await connection.newStream(StoreCodec);
try { try {
const historyRpcQuery = HistoryRPC.createQuery( const historyRpcQuery = HistoryRPC.createQuery({
contentTopics, contentTopics: opts.contentTopics,
cursor, cursor,
pubsubTopic pubsubTopic: opts.pubsubTopic,
); });
const res = await pipe( const res = await pipe(
[historyRpcQuery.encode()], [historyRpcQuery.encode()],
lp.encode(), lp.encode(),