@waku/core 0.0.33-00c3261.0 → 0.0.33-09028e7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,17 +1,16 @@
1
- import type { Peer, Stream } from "@libp2p/interface";
2
- import type { Libp2p } from "@waku/interfaces";
1
+ import type { Stream } from "@libp2p/interface";
2
+ import type { Peer } from "@libp2p/interface";
3
+ import { Libp2p } from "@waku/interfaces";
3
4
  export declare class StreamManager {
4
5
  multicodec: string;
5
6
  getConnections: Libp2p["getConnections"];
6
7
  addEventListener: Libp2p["addEventListener"];
8
+ private readonly streamPool;
7
9
  private readonly log;
8
- private ongoingCreation;
9
- private streamPool;
10
10
  constructor(multicodec: string, getConnections: Libp2p["getConnections"], addEventListener: Libp2p["addEventListener"]);
11
11
  getStream(peer: Peer): Promise<Stream>;
12
12
  private createStream;
13
- private createStreamWithLock;
13
+ private prepareStream;
14
14
  private handlePeerUpdateStreamPool;
15
- private scheduleNewStream;
16
- private getStreamForCodec;
15
+ private isConnectedTo;
17
16
  }
@@ -1,29 +1,39 @@
1
1
  import { Logger } from "@waku/utils";
2
2
  import { selectConnection } from "./utils.js";
3
3
  const CONNECTION_TIMEOUT = 5_000;
4
+ const RETRY_BACKOFF_BASE = 1_000;
5
+ const MAX_RETRIES = 3;
4
6
  export class StreamManager {
5
7
  multicodec;
6
8
  getConnections;
7
9
  addEventListener;
10
+ streamPool;
8
11
  log;
9
- ongoingCreation = new Set();
10
- streamPool = new Map();
11
12
  constructor(multicodec, getConnections, addEventListener) {
12
13
  this.multicodec = multicodec;
13
14
  this.getConnections = getConnections;
14
15
  this.addEventListener = addEventListener;
15
16
  this.log = new Logger(`stream-manager:${multicodec}`);
17
+ this.streamPool = new Map();
16
18
  this.addEventListener("peer:update", this.handlePeerUpdateStreamPool);
17
19
  }
18
20
  async getStream(peer) {
19
- const peerId = peer.id.toString();
20
- const scheduledStream = this.streamPool.get(peerId);
21
- this.streamPool.delete(peerId);
22
- await scheduledStream;
23
- const stream = this.getStreamForCodec(peer.id);
24
- if (stream) {
25
- this.log.info(`Found existing stream peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
26
- return stream;
21
+ const peerIdStr = peer.id.toString();
22
+ const streamPromise = this.streamPool.get(peerIdStr);
23
+ if (!streamPromise) {
24
+ return this.createStream(peer);
25
+ }
26
+ this.streamPool.delete(peerIdStr);
27
+ this.prepareStream(peer);
28
+ try {
29
+ const stream = await streamPromise;
30
+ if (stream && stream.status !== "closed") {
31
+ return stream;
32
+ }
33
+ }
34
+ catch (error) {
35
+ this.log.warn(`Failed to get stream for ${peerIdStr} -- `, error);
36
+ this.log.warn("Attempting to create a new stream for the peer");
27
37
  }
28
38
  return this.createStream(peer);
29
39
  }
@@ -31,67 +41,50 @@ export class StreamManager {
31
41
  const connections = this.getConnections(peer.id);
32
42
  const connection = selectConnection(connections);
33
43
  if (!connection) {
34
- throw new Error(`Failed to get a connection to the peer peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
35
- }
36
- let lastError;
37
- let stream;
38
- for (let i = 0; i < retries + 1; i++) {
39
- try {
40
- this.log.info(`Attempting to create a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
41
- stream = await connection.newStream(this.multicodec);
42
- this.log.info(`Created stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
43
- }
44
- catch (error) {
45
- lastError = error;
46
- }
47
- }
48
- if (!stream) {
49
- throw new Error(`Failed to create a new stream for ${peer.id.toString()} -- ` +
50
- lastError);
51
- }
52
- return stream;
53
- }
54
- async createStreamWithLock(peer) {
55
- const peerId = peer.id.toString();
56
- if (this.ongoingCreation.has(peerId)) {
57
- this.log.info(`Skipping creation of a stream due to lock for peerId=${peerId} multicodec=${this.multicodec}`);
58
- return;
44
+ throw new Error("Failed to get a connection to the peer");
59
45
  }
60
46
  try {
61
- this.ongoingCreation.add(peerId);
62
- await this.createStream(peer);
47
+ return await connection.newStream(this.multicodec);
63
48
  }
64
- finally {
65
- this.ongoingCreation.delete(peerId);
49
+ catch (error) {
50
+ if (retries < MAX_RETRIES) {
51
+ const backoff = RETRY_BACKOFF_BASE * Math.pow(2, retries);
52
+ await new Promise((resolve) => setTimeout(resolve, backoff));
53
+ return this.createStream(peer, retries + 1);
54
+ }
55
+ throw new Error(`Failed to create a new stream for ${peer.id.toString()} -- ` + error);
66
56
  }
67
57
  }
68
- handlePeerUpdateStreamPool = (evt) => {
69
- const { peer } = evt.detail;
70
- if (!peer.protocols.includes(this.multicodec)) {
71
- return;
72
- }
73
- const stream = this.getStreamForCodec(peer.id);
74
- if (stream) {
75
- return;
76
- }
77
- this.scheduleNewStream(peer);
78
- };
79
- scheduleNewStream(peer) {
80
- this.log.info(`Scheduling creation of a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
81
- const timeoutPromise = new Promise((resolve) => setTimeout(() => resolve(undefined), CONNECTION_TIMEOUT));
58
+ prepareStream(peer) {
59
+ const timeoutPromise = new Promise((resolve) => setTimeout(resolve, CONNECTION_TIMEOUT));
82
60
  const streamPromise = Promise.race([
83
- this.createStreamWithLock(peer),
84
- timeoutPromise
85
- ]);
61
+ this.createStream(peer),
62
+ timeoutPromise.then(() => {
63
+ throw new Error("Connection timeout");
64
+ })
65
+ ]).catch((error) => {
66
+ this.log.error(`Failed to prepare a new stream for ${peer.id.toString()} -- `, error);
67
+ });
86
68
  this.streamPool.set(peer.id.toString(), streamPromise);
87
69
  }
88
- getStreamForCodec(peerId) {
89
- const connection = this.getConnections(peerId).find((c) => c.status === "open");
90
- if (!connection) {
91
- return;
70
+ handlePeerUpdateStreamPool = (evt) => {
71
+ const { peer } = evt.detail;
72
+ if (peer.protocols.includes(this.multicodec)) {
73
+ const isConnected = this.isConnectedTo(peer.id);
74
+ if (isConnected) {
75
+ this.log.info(`Preemptively opening a stream to ${peer.id.toString()}`);
76
+ this.prepareStream(peer);
77
+ }
78
+ else {
79
+ const peerIdStr = peer.id.toString();
80
+ this.streamPool.delete(peerIdStr);
81
+ this.log.info(`Removed pending stream for disconnected peer ${peerIdStr}`);
82
+ }
92
83
  }
93
- const stream = connection.streams.find((s) => s.protocol === this.multicodec);
94
- return stream;
84
+ };
85
+ isConnectedTo(peerId) {
86
+ const connections = this.getConnections(peerId);
87
+ return connections.some((connection) => connection.status === "open");
95
88
  }
96
89
  }
97
90
  //# sourceMappingURL=stream_manager.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"stream_manager.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/stream_manager.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAEjC,MAAM,OAAO,aAAa;IAOf;IACA;IACA;IARQ,GAAG,CAAS;IAErB,eAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;IACzC,UAAU,GAA+B,IAAI,GAAG,EAAE,CAAC;IAE3D,YACS,UAAkB,EAClB,cAAwC,EACxC,gBAA4C;QAF5C,eAAU,GAAV,UAAU,CAAQ;QAClB,mBAAc,GAAd,cAAc,CAA0B;QACxC,qBAAgB,GAAhB,gBAAgB,CAA4B;QAEnD,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;IACxE,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,IAAU;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;QAElC,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC/B,MAAM,eAAe,CAAC;QAEtB,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAE/C,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,gCAAgC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CACnF,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAU,EAAE,OAAO,GAAG,CAAC;QAChD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAEjD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CACb,iDAAiD,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CACpG,CAAC;QACJ,CAAC;QAED,IAAI,SAAkB,CAAC;QACvB,IAAI,MAA0B,CAAC;QAE/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,4CAA4C,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CAC/F,CAAC;gBACF,MAAM,GAAG,MAAM,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACrD,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,6BAA6B,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CAChF,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,SAAS,GAAG,KAAK,CAAC;YACpB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CACb,qCAAqC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM;gBAC3D,SAAS,CACZ,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,IAAU;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;QAElC,IAAI,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,wDAAwD,MAAM,eAAe,IAAI,CAAC,UAAU,EAAE,CAC/F,CAAC;YACF,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACjC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAEO,0BAA0B,GAAG,CAAC,GAA4B,EAAQ,EAAE;QAC1E,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;QAE5B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC9C,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAE/C,IAAI,MAAM,EAAE,CAAC;YACX,OAAO;QACT,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC;IAEM,iBAAiB,CAAC,IAAU;QAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,8CAA8C,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,eAAe,IAAI,CAAC,UAAU,EAAE,CACjG,CAAC;QAEF,MAAM,cAAc,GAAG,IAAI,OAAO,CAAY,CAAC,OAAO,EAAE,EAAE,CACxD,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC,CACzD,CAAC;QAEF,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;YAC/B,cAAc;SACf,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;IAEO,iBAAiB,CAAC,MAAc;QACtC,MAAM,UAAU,GAA2B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,IAAI,CACzE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAC3B,CAAC;QAEF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CACpC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,UAAU,CACtC,CAAC;QAEF,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
1
+ {"version":3,"file":"stream_manager.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/stream_manager.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,kBAAkB,GAAG,KAAK,CAAC;AACjC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AACjC,MAAM,WAAW,GAAG,CAAC,CAAC;AAEtB,MAAM,OAAO,aAAa;IAKf;IACA;IACA;IANQ,UAAU,CAAsC;IAChD,GAAG,CAAS;IAE7B,YACS,UAAkB,EAClB,cAAwC,EACxC,gBAA4C;QAF5C,eAAU,GAAV,UAAU,CAAQ;QAClB,mBAAc,GAAd,cAAc,CAA0B;QACxC,qBAAgB,GAAhB,gBAAgB,CAA4B;QAEnD,IAAI,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;IACxE,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,IAAU;QAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAErD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAEzB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YACnC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACzC,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,4BAA4B,SAAS,MAAM,EAAE,KAAK,CAAC,CAAC;YAClE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,IAAU,EAAE,OAAO,GAAG,CAAC;QAChD,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjD,MAAM,UAAU,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAEjD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC;YACH,OAAO,MAAM,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,GAAG,WAAW,EAAE,CAAC;gBAC1B,MAAM,OAAO,GAAG,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC1D,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;gBAC7D,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;YAC9C,CAAC;YACD,MAAM,IAAI,KAAK,CACb,qCAAqC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,GAAG,KAAK,CACtE,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,aAAa,CAAC,IAAU;QAC9B,MAAM,cAAc,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CACnD,UAAU,CAAC,OAAO,EAAE,kBAAkB,CAAC,CACxC,CAAC;QAEF,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;YACjC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YACvB,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACxC,CAAC,CAAC;SACH,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CACZ,sCAAsC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAC9D,KAAK,CACN,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;IACzD,CAAC;IAEO,0BAA0B,GAAG,CAAC,GAA4B,EAAQ,EAAE;QAC1E,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,MAAM,CAAC;QAE5B,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC7C,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAEhD,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,oCAAoC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACxE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC3B,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;gBACrC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAClC,IAAI,CAAC,GAAG,CAAC,IAAI,CACX,gDAAgD,SAAS,EAAE,CAC5D,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEM,aAAa,CAAC,MAAc;QAClC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAChD,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;IACxE,CAAC;CACF"}
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@waku/core","version":"0.0.33-00c3261.0","description":"TypeScript implementation of the Waku v2 protocol","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./lib/message/version_0":{"types":"./dist/lib/message/version_0.d.ts","import":"./dist/lib/message/version_0.js"},"./lib/base_protocol":{"types":"./dist/lib/base_protocol.d.ts","import":"./dist/lib/base_protocol.js"}},"typesVersions":{"*":{"lib/*":["dist/lib/*"],"constants/*":["dist/constants/*"]}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/core#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralised","communication","web3","ethereum","dapps"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint src *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:node":"NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"NODE_ENV=test karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"dependencies":{"@libp2p/ping":"^1.1.2","@waku/enr":"0.0.27-00c3261.0","@waku/interfaces":"0.0.28-00c3261.0","@waku/proto":"0.0.9-00c3261.0","@waku/utils":"0.0.21-00c3261.0","debug":"^4.3.4","it-all":"^3.0.4","it-length-prefixed":"^9.0.4","it-pipe":"^3.0.1","p-event":"^6.0.1","uint8arraylist":"^2.4.3","uuid":"^9.0.0"},"devDependencies":{"@multiformats/multiaddr":"^12.0.0","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.11","@types/debug":"^4.1.12","@types/mocha":"^10.0.6","@types/uuid":"^9.0.8","@waku/build-utils":"*","chai":"^4.3.10","cspell":"^8.6.1","fast-check":"^3.19.0","ignore-loader":"^0.1.2","isomorphic-fetch":"^3.0.0","mocha":"^10.3.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^4.12.0"},"peerDependencies":{"@multiformats/multiaddr":"^12.0.0","libp2p":"^1.8.1"},"peerDependenciesMeta":{"@multiformats/multiaddr":{"optional":true},"libp2p":{"optional":true}},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}
1
+ {"name":"@waku/core","version":"0.0.33-09028e7.0","description":"TypeScript implementation of the Waku v2 protocol","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./lib/message/version_0":{"types":"./dist/lib/message/version_0.d.ts","import":"./dist/lib/message/version_0.js"},"./lib/base_protocol":{"types":"./dist/lib/base_protocol.d.ts","import":"./dist/lib/base_protocol.js"}},"typesVersions":{"*":{"lib/*":["dist/lib/*"],"constants/*":["dist/constants/*"]}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/core#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralised","communication","web3","ethereum","dapps"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint src *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:node":"NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"NODE_ENV=test karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"dependencies":{"@libp2p/ping":"^1.1.2","@waku/enr":"0.0.27-09028e7.0","@waku/interfaces":"0.0.28-09028e7.0","@waku/proto":"0.0.9-09028e7.0","@waku/utils":"0.0.21-09028e7.0","debug":"^4.3.4","it-all":"^3.0.4","it-length-prefixed":"^9.0.4","it-pipe":"^3.0.1","p-event":"^6.0.1","uint8arraylist":"^2.4.3","uuid":"^9.0.0"},"devDependencies":{"@multiformats/multiaddr":"^12.0.0","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.11","@types/debug":"^4.1.12","@types/mocha":"^10.0.6","@types/uuid":"^9.0.8","@waku/build-utils":"*","chai":"^4.3.10","cspell":"^8.6.1","fast-check":"^3.19.0","ignore-loader":"^0.1.2","isomorphic-fetch":"^3.0.0","mocha":"^10.3.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^4.12.0"},"peerDependencies":{"@multiformats/multiaddr":"^12.0.0","libp2p":"^1.8.1"},"peerDependenciesMeta":{"@multiformats/multiaddr":{"optional":true},"libp2p":{"optional":true}},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}
@@ -1,16 +1,12 @@
1
1
  import type { Libp2p } from "@libp2p/interface";
2
- import type { Peer, PeerStore, Stream } from "@libp2p/interface";
2
+ import type { Peer, Stream } from "@libp2p/interface";
3
3
  import type {
4
4
  IBaseProtocolCore,
5
5
  Libp2pComponents,
6
6
  PubsubTopic
7
7
  } from "@waku/interfaces";
8
- import { Logger, pubsubTopicsToShardInfo } from "@waku/utils";
9
- import {
10
- getConnectedPeersForProtocolAndShard,
11
- getPeersForProtocol,
12
- sortPeersByLatency
13
- } from "@waku/utils/libp2p";
8
+ import { Logger } from "@waku/utils";
9
+ import { getPeersForProtocol, sortPeersByLatency } from "@waku/utils/libp2p";
14
10
 
15
11
  import { filterPeersByDiscovery } from "./filterPeers.js";
16
12
  import { StreamManager } from "./stream_manager/index.js";
@@ -26,7 +22,7 @@ export class BaseProtocol implements IBaseProtocolCore {
26
22
 
27
23
  protected constructor(
28
24
  public multicodec: string,
29
- private components: Libp2pComponents,
25
+ protected components: Libp2pComponents,
30
26
  private log: Logger,
31
27
  public readonly pubsubTopics: PubsubTopic[]
32
28
  ) {
@@ -50,25 +46,28 @@ export class BaseProtocol implements IBaseProtocolCore {
50
46
  return this.streamManager.getStream(peer);
51
47
  }
52
48
 
53
- public get peerStore(): PeerStore {
54
- return this.components.peerStore;
55
- }
56
-
49
+ //TODO: move to SDK
57
50
  /**
58
51
  * Returns known peers from the address book (`libp2p.peerStore`) that support
59
52
  * the class protocol. Waku may or may not be currently connected to these
60
53
  * peers.
61
54
  */
62
55
  public async allPeers(): Promise<Peer[]> {
63
- return getPeersForProtocol(this.peerStore, [this.multicodec]);
56
+ return getPeersForProtocol(this.components.peerStore, [this.multicodec]);
64
57
  }
65
58
 
66
- public async connectedPeers(): Promise<Peer[]> {
59
+ public async connectedPeers(withOpenStreams = false): Promise<Peer[]> {
67
60
  const peers = await this.allPeers();
68
61
  return peers.filter((peer) => {
69
- return (
70
- this.components.connectionManager.getConnections(peer.id).length > 0
62
+ const connections = this.components.connectionManager.getConnections(
63
+ peer.id
71
64
  );
65
+ if (withOpenStreams) {
66
+ return connections.some((c) =>
67
+ c.streams.some((s) => s.protocol === this.multicodec)
68
+ );
69
+ }
70
+ return connections.length > 0;
72
71
  });
73
72
  }
74
73
 
@@ -77,9 +76,8 @@ export class BaseProtocol implements IBaseProtocolCore {
77
76
  *
78
77
  * @param numPeers - The total number of peers to retrieve. If 0, all peers are returned.
79
78
  * @param maxBootstrapPeers - The maximum number of bootstrap peers to retrieve.
80
-
81
- * @returns A list of peers that support the protocol sorted by latency.
82
- */
79
+ * @returns A list of peers that support the protocol sorted by latency. By default, returns all peers available, including bootstrap.
80
+ */
83
81
  public async getPeers(
84
82
  {
85
83
  numPeers,
@@ -88,29 +86,23 @@ export class BaseProtocol implements IBaseProtocolCore {
88
86
  numPeers: number;
89
87
  maxBootstrapPeers: number;
90
88
  } = {
91
- maxBootstrapPeers: 1,
89
+ maxBootstrapPeers: 0,
92
90
  numPeers: 0
93
91
  }
94
92
  ): Promise<Peer[]> {
95
93
  // Retrieve all connected peers that support the protocol & shard (if configured)
96
- const connectedPeersForProtocolAndShard =
97
- await getConnectedPeersForProtocolAndShard(
98
- this.components.connectionManager.getConnections(),
99
- this.peerStore,
100
- [this.multicodec],
101
- pubsubTopicsToShardInfo(this.pubsubTopics)
102
- );
94
+ const allAvailableConnectedPeers = await this.connectedPeers();
103
95
 
104
96
  // Filter the peers based on discovery & number of peers requested
105
97
  const filteredPeers = filterPeersByDiscovery(
106
- connectedPeersForProtocolAndShard,
98
+ allAvailableConnectedPeers,
107
99
  numPeers,
108
100
  maxBootstrapPeers
109
101
  );
110
102
 
111
103
  // Sort the peers by latency
112
104
  const sortedFilteredPeers = await sortPeersByLatency(
113
- this.peerStore,
105
+ this.components.peerStore,
114
106
  filteredPeers
115
107
  );
116
108
 
@@ -37,6 +37,7 @@ export class FilterCore extends BaseProtocol implements IBaseProtocolCore {
37
37
  wakuMessage: WakuMessage,
38
38
  peerIdStr: string
39
39
  ) => Promise<void>,
40
+ private handleError: (error: Error) => Promise<void>,
40
41
  public readonly pubsubTopics: PubsubTopic[],
41
42
  libp2p: Libp2p
42
43
  ) {
@@ -301,8 +302,18 @@ export class FilterCore extends BaseProtocol implements IBaseProtocolCore {
301
302
  () => {
302
303
  log.info("Receiving pipe closed.");
303
304
  },
304
- (e) => {
305
- log.error("Error with receiving pipe", e);
305
+ async (e) => {
306
+ log.error(
307
+ "Error with receiving pipe",
308
+ e,
309
+ " -- ",
310
+ "on peer ",
311
+ connection.remotePeer.toString(),
312
+ " -- ",
313
+ "stream ",
314
+ stream
315
+ );
316
+ await this.handleError(e);
306
317
  }
307
318
  );
308
319
  } catch (e) {
@@ -45,7 +45,7 @@ class Metadata extends BaseProtocol implements IMetadata {
45
45
  pubsubTopicsToShardInfo(this.pubsubTopics)
46
46
  );
47
47
 
48
- const peer = await this.peerStore.get(peerId);
48
+ const peer = await this.libp2pComponents.peerStore.get(peerId);
49
49
  if (!peer) {
50
50
  return {
51
51
  shardInfo: null,
@@ -1,46 +1,47 @@
1
- import type {
2
- Connection,
3
- Peer,
4
- PeerId,
5
- PeerUpdate,
6
- Stream
7
- } from "@libp2p/interface";
8
- import type { Libp2p } from "@waku/interfaces";
1
+ import type { PeerUpdate, Stream } from "@libp2p/interface";
2
+ import type { Peer, PeerId } from "@libp2p/interface";
3
+ import { Libp2p } from "@waku/interfaces";
9
4
  import { Logger } from "@waku/utils";
10
5
 
11
6
  import { selectConnection } from "./utils.js";
12
7
 
13
8
  const CONNECTION_TIMEOUT = 5_000;
9
+ const RETRY_BACKOFF_BASE = 1_000;
10
+ const MAX_RETRIES = 3;
14
11
 
15
12
  export class StreamManager {
13
+ private readonly streamPool: Map<string, Promise<Stream | void>>;
16
14
  private readonly log: Logger;
17
15
 
18
- private ongoingCreation: Set<string> = new Set();
19
- private streamPool: Map<string, Promise<void>> = new Map();
20
-
21
16
  public constructor(
22
17
  public multicodec: string,
23
18
  public getConnections: Libp2p["getConnections"],
24
19
  public addEventListener: Libp2p["addEventListener"]
25
20
  ) {
26
21
  this.log = new Logger(`stream-manager:${multicodec}`);
22
+ this.streamPool = new Map();
27
23
  this.addEventListener("peer:update", this.handlePeerUpdateStreamPool);
28
24
  }
29
25
 
30
26
  public async getStream(peer: Peer): Promise<Stream> {
31
- const peerId = peer.id.toString();
27
+ const peerIdStr = peer.id.toString();
28
+ const streamPromise = this.streamPool.get(peerIdStr);
32
29
 
33
- const scheduledStream = this.streamPool.get(peerId);
34
- this.streamPool.delete(peerId);
35
- await scheduledStream;
30
+ if (!streamPromise) {
31
+ return this.createStream(peer);
32
+ }
36
33
 
37
- const stream = this.getStreamForCodec(peer.id);
34
+ this.streamPool.delete(peerIdStr);
35
+ this.prepareStream(peer);
38
36
 
39
- if (stream) {
40
- this.log.info(
41
- `Found existing stream peerId=${peer.id.toString()} multicodec=${this.multicodec}`
42
- );
43
- return stream;
37
+ try {
38
+ const stream = await streamPromise;
39
+ if (stream && stream.status !== "closed") {
40
+ return stream;
41
+ }
42
+ } catch (error) {
43
+ this.log.warn(`Failed to get stream for ${peerIdStr} -- `, error);
44
+ this.log.warn("Attempting to create a new stream for the peer");
44
45
  }
45
46
 
46
47
  return this.createStream(peer);
@@ -51,102 +52,64 @@ export class StreamManager {
51
52
  const connection = selectConnection(connections);
52
53
 
53
54
  if (!connection) {
54
- throw new Error(
55
- `Failed to get a connection to the peer peerId=${peer.id.toString()} multicodec=${this.multicodec}`
56
- );
55
+ throw new Error("Failed to get a connection to the peer");
57
56
  }
58
57
 
59
- let lastError: unknown;
60
- let stream: Stream | undefined;
61
-
62
- for (let i = 0; i < retries + 1; i++) {
63
- try {
64
- this.log.info(
65
- `Attempting to create a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
66
- );
67
- stream = await connection.newStream(this.multicodec);
68
- this.log.info(
69
- `Created stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
70
- );
71
- } catch (error) {
72
- lastError = error;
58
+ try {
59
+ return await connection.newStream(this.multicodec);
60
+ } catch (error) {
61
+ if (retries < MAX_RETRIES) {
62
+ const backoff = RETRY_BACKOFF_BASE * Math.pow(2, retries);
63
+ await new Promise((resolve) => setTimeout(resolve, backoff));
64
+ return this.createStream(peer, retries + 1);
73
65
  }
74
- }
75
-
76
- if (!stream) {
77
66
  throw new Error(
78
- `Failed to create a new stream for ${peer.id.toString()} -- ` +
79
- lastError
67
+ `Failed to create a new stream for ${peer.id.toString()} -- ` + error
80
68
  );
81
69
  }
82
-
83
- return stream;
84
70
  }
85
71
 
86
- private async createStreamWithLock(peer: Peer): Promise<void> {
87
- const peerId = peer.id.toString();
72
+ private prepareStream(peer: Peer): void {
73
+ const timeoutPromise = new Promise<void>((resolve) =>
74
+ setTimeout(resolve, CONNECTION_TIMEOUT)
75
+ );
88
76
 
89
- if (this.ongoingCreation.has(peerId)) {
90
- this.log.info(
91
- `Skipping creation of a stream due to lock for peerId=${peerId} multicodec=${this.multicodec}`
77
+ const streamPromise = Promise.race([
78
+ this.createStream(peer),
79
+ timeoutPromise.then(() => {
80
+ throw new Error("Connection timeout");
81
+ })
82
+ ]).catch((error) => {
83
+ this.log.error(
84
+ `Failed to prepare a new stream for ${peer.id.toString()} -- `,
85
+ error
92
86
  );
93
- return;
94
- }
87
+ });
95
88
 
96
- try {
97
- this.ongoingCreation.add(peerId);
98
- await this.createStream(peer);
99
- } finally {
100
- this.ongoingCreation.delete(peerId);
101
- }
89
+ this.streamPool.set(peer.id.toString(), streamPromise);
102
90
  }
103
91
 
104
92
  private handlePeerUpdateStreamPool = (evt: CustomEvent<PeerUpdate>): void => {
105
93
  const { peer } = evt.detail;
106
94
 
107
- if (!peer.protocols.includes(this.multicodec)) {
108
- return;
109
- }
110
-
111
- const stream = this.getStreamForCodec(peer.id);
95
+ if (peer.protocols.includes(this.multicodec)) {
96
+ const isConnected = this.isConnectedTo(peer.id);
112
97
 
113
- if (stream) {
114
- return;
98
+ if (isConnected) {
99
+ this.log.info(`Preemptively opening a stream to ${peer.id.toString()}`);
100
+ this.prepareStream(peer);
101
+ } else {
102
+ const peerIdStr = peer.id.toString();
103
+ this.streamPool.delete(peerIdStr);
104
+ this.log.info(
105
+ `Removed pending stream for disconnected peer ${peerIdStr}`
106
+ );
107
+ }
115
108
  }
116
-
117
- this.scheduleNewStream(peer);
118
109
  };
119
110
 
120
- private scheduleNewStream(peer: Peer): void {
121
- this.log.info(
122
- `Scheduling creation of a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
123
- );
124
-
125
- const timeoutPromise = new Promise<undefined>((resolve) =>
126
- setTimeout(() => resolve(undefined), CONNECTION_TIMEOUT)
127
- );
128
-
129
- const streamPromise = Promise.race([
130
- this.createStreamWithLock(peer),
131
- timeoutPromise
132
- ]);
133
-
134
- this.streamPool.set(peer.id.toString(), streamPromise);
135
- }
136
-
137
- private getStreamForCodec(peerId: PeerId): Stream | undefined {
138
- const connection: Connection | undefined = this.getConnections(peerId).find(
139
- (c) => c.status === "open"
140
- );
141
-
142
- if (!connection) {
143
- return;
144
- }
145
-
146
- const stream = connection.streams.find(
147
- (s) => s.protocol === this.multicodec
148
- );
149
-
150
- return stream;
111
+ private isConnectedTo(peerId: PeerId): boolean {
112
+ const connections = this.getConnections(peerId);
113
+ return connections.some((connection) => connection.status === "open");
151
114
  }
152
115
  }