@waku/core 0.0.33-aeb05cd.0 → 0.0.33-b93134a.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,90 +1,107 @@
1
1
  import { Logger } from "@waku/utils";
2
- import { selectConnection } from "./utils.js";
3
- const CONNECTION_TIMEOUT = 5_000;
4
- const RETRY_BACKOFF_BASE = 1_000;
5
- const MAX_RETRIES = 3;
2
+ import { selectOpenConnection } from "./utils.js";
6
3
  export class StreamManager {
7
4
  multicodec;
8
5
  getConnections;
9
6
  addEventListener;
10
- streamPool;
11
7
  log;
8
+ ongoingCreation = new Set();
9
+ streamPool = new Map();
12
10
  constructor(multicodec, getConnections, addEventListener) {
13
11
  this.multicodec = multicodec;
14
12
  this.getConnections = getConnections;
15
13
  this.addEventListener = addEventListener;
16
14
  this.log = new Logger(`stream-manager:${multicodec}`);
17
- this.streamPool = new Map();
18
15
  this.addEventListener("peer:update", this.handlePeerUpdateStreamPool);
19
16
  }
20
17
  async getStream(peer) {
21
- const peerIdStr = peer.id.toString();
22
- const streamPromise = this.streamPool.get(peerIdStr);
23
- if (!streamPromise) {
24
- return this.createStream(peer);
18
+ const peerId = peer.id.toString();
19
+ const scheduledStream = this.streamPool.get(peerId);
20
+ if (scheduledStream) {
21
+ this.streamPool.delete(peerId);
22
+ await scheduledStream;
25
23
  }
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");
24
+ const stream = this.getOpenStreamForCodec(peer.id);
25
+ if (stream) {
26
+ this.log.info(`Found existing stream peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
27
+ return stream;
37
28
  }
38
29
  return this.createStream(peer);
39
30
  }
40
31
  async createStream(peer, retries = 0) {
41
32
  const connections = this.getConnections(peer.id);
42
- const connection = selectConnection(connections);
33
+ const connection = selectOpenConnection(connections);
43
34
  if (!connection) {
44
- throw new Error("Failed to get a connection to the peer");
35
+ throw new Error(`Failed to get a connection to the peer peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
36
+ }
37
+ let lastError;
38
+ let stream;
39
+ for (let i = 0; i < retries + 1; i++) {
40
+ try {
41
+ this.log.info(`Attempting to create a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
42
+ stream = await connection.newStream(this.multicodec);
43
+ this.log.info(`Created stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
44
+ break;
45
+ }
46
+ catch (error) {
47
+ lastError = error;
48
+ }
49
+ }
50
+ if (!stream) {
51
+ throw new Error(`Failed to create a new stream for ${peer.id.toString()} -- ` +
52
+ lastError);
53
+ }
54
+ return stream;
55
+ }
56
+ async createStreamWithLock(peer) {
57
+ const peerId = peer.id.toString();
58
+ if (this.ongoingCreation.has(peerId)) {
59
+ this.log.info(`Skipping creation of a stream due to lock for peerId=${peerId} multicodec=${this.multicodec}`);
60
+ return;
45
61
  }
46
62
  try {
47
- return await connection.newStream(this.multicodec);
63
+ this.ongoingCreation.add(peerId);
64
+ await this.createStream(peer);
48
65
  }
49
66
  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);
67
+ this.log.error(`Failed to createStreamWithLock:`, error);
56
68
  }
57
- }
58
- prepareStream(peer) {
59
- const timeoutPromise = new Promise((resolve) => setTimeout(resolve, CONNECTION_TIMEOUT));
60
- const streamPromise = Promise.race([
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
- });
68
- this.streamPool.set(peer.id.toString(), streamPromise);
69
+ finally {
70
+ this.ongoingCreation.delete(peerId);
71
+ }
72
+ return;
69
73
  }
70
74
  handlePeerUpdateStreamPool = (evt) => {
71
75
  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
- }
76
+ if (!peer.protocols.includes(this.multicodec)) {
77
+ return;
78
+ }
79
+ const stream = this.getOpenStreamForCodec(peer.id);
80
+ if (stream) {
81
+ return;
83
82
  }
83
+ this.scheduleNewStream(peer);
84
84
  };
85
- isConnectedTo(peerId) {
85
+ scheduleNewStream(peer) {
86
+ this.log.info(`Scheduling creation of a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`);
87
+ // abandon previous attempt
88
+ if (this.streamPool.has(peer.id.toString())) {
89
+ this.streamPool.delete(peer.id.toString());
90
+ }
91
+ this.streamPool.set(peer.id.toString(), this.createStreamWithLock(peer));
92
+ }
93
+ getOpenStreamForCodec(peerId) {
86
94
  const connections = this.getConnections(peerId);
87
- return connections.some((connection) => connection.status === "open");
95
+ const connection = selectOpenConnection(connections);
96
+ if (!connection) {
97
+ return;
98
+ }
99
+ const stream = connection.streams.find((s) => s.protocol === this.multicodec);
100
+ const isStreamUnusable = ["done", "closed", "closing"].includes(stream?.writeStatus || "");
101
+ if (isStreamUnusable) {
102
+ return;
103
+ }
104
+ return stream;
88
105
  }
89
106
  }
90
107
  //# 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":"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"}
1
+ {"version":3,"file":"stream_manager.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/stream_manager.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAElD,MAAM,OAAO,aAAa;IAOd;IACA;IACA;IARO,GAAG,CAAS;IAErB,eAAe,GAAgB,IAAI,GAAG,EAAE,CAAC;IACzC,UAAU,GAA+B,IAAI,GAAG,EAAE,CAAC;IAE3D,YACU,UAAkB,EAClB,cAAwC,EACxC,gBAA4C;QAF5C,eAAU,GAAV,UAAU,CAAQ;QAClB,mBAAc,GAAd,cAAc,CAA0B;QACxC,qBAAgB,GAAhB,gBAAgB,CAA4B;QAEpD,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;QAEpD,IAAI,eAAe,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC/B,MAAM,eAAe,CAAC;QACxB,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEnD,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,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAErD,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;gBACF,MAAM;YACR,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;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;QAED,OAAO;IACT,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,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEnD,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,2BAA2B;QAC3B,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEO,qBAAqB,CAAC,MAAc;QAC1C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAErD,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,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,QAAQ,CAC7D,MAAM,EAAE,WAAW,IAAI,EAAE,CAC1B,CAAC;QACF,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO;QACT,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
@@ -1,2 +1,2 @@
1
1
  import type { Connection } from "@libp2p/interface";
2
- export declare function selectConnection(connections: Connection[]): Connection | undefined;
2
+ export declare function selectOpenConnection(connections: Connection[]): Connection | undefined;
@@ -1,19 +1,7 @@
1
- export function selectConnection(connections) {
2
- if (!connections.length)
3
- return;
4
- if (connections.length === 1)
5
- return connections[0];
6
- let latestConnection;
7
- connections.forEach((connection) => {
8
- if (connection.status === "open") {
9
- if (!latestConnection) {
10
- latestConnection = connection;
11
- }
12
- else if (connection.timeline.open > latestConnection.timeline.open) {
13
- latestConnection = connection;
14
- }
15
- }
16
- });
17
- return latestConnection;
1
+ export function selectOpenConnection(connections) {
2
+ return connections
3
+ .filter((c) => c.status === "open")
4
+ .sort((left, right) => right.timeline.open - left.timeline.open)
5
+ .at(0);
18
6
  }
19
7
  //# sourceMappingURL=utils.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,gBAAgB,CAC9B,WAAyB;IAEzB,IAAI,CAAC,WAAW,CAAC,MAAM;QAAE,OAAO;IAChC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC;IAEpD,IAAI,gBAAwC,CAAC;IAE7C,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACjC,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YACjC,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,gBAAgB,GAAG,UAAU,CAAC;YAChC,CAAC;iBAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,GAAG,gBAAgB,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACrE,gBAAgB,GAAG,UAAU,CAAC;YAChC,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC;AAC1B,CAAC"}
1
+ {"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/lib/stream_manager/utils.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,oBAAoB,CAClC,WAAyB;IAEzB,OAAO,WAAW;SACf,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC;SAClC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;SAC/D,EAAE,CAAC,CAAC,CAAC,CAAC;AACX,CAAC"}
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@waku/core","version":"0.0.33-aeb05cd.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-aeb05cd.0","@waku/interfaces":"0.0.28-aeb05cd.0","@waku/proto":"0.0.9-aeb05cd.0","@waku/utils":"0.0.21-aeb05cd.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-b93134a.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-b93134a.0","@waku/interfaces":"0.0.28-b93134a.0","@waku/proto":"0.0.9-b93134a.0","@waku/utils":"0.0.21-b93134a.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","sinon":"^18.0.0","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,5 +1,5 @@
1
1
  import type { Libp2p } from "@libp2p/interface";
2
- import type { Peer, Stream } from "@libp2p/interface";
2
+ import type { Peer, PeerStore, Stream } from "@libp2p/interface";
3
3
  import type {
4
4
  IBaseProtocolCore,
5
5
  Libp2pComponents,
@@ -26,7 +26,7 @@ export class BaseProtocol implements IBaseProtocolCore {
26
26
 
27
27
  protected constructor(
28
28
  public multicodec: string,
29
- protected components: Libp2pComponents,
29
+ private components: Libp2pComponents,
30
30
  private log: Logger,
31
31
  public readonly pubsubTopics: PubsubTopic[]
32
32
  ) {
@@ -50,24 +50,24 @@ export class BaseProtocol implements IBaseProtocolCore {
50
50
  return this.streamManager.getStream(peer);
51
51
  }
52
52
 
53
- //TODO: move to SDK
53
+ public get peerStore(): PeerStore {
54
+ return this.components.peerStore;
55
+ }
56
+
54
57
  /**
55
58
  * Returns known peers from the address book (`libp2p.peerStore`) that support
56
59
  * the class protocol. Waku may or may not be currently connected to these
57
60
  * peers.
58
61
  */
59
62
  public async allPeers(): Promise<Peer[]> {
60
- return getPeersForProtocol(this.components.peerStore, [this.multicodec]);
63
+ return getPeersForProtocol(this.peerStore, [this.multicodec]);
61
64
  }
62
65
 
63
66
  public async connectedPeers(): Promise<Peer[]> {
64
67
  const peers = await this.allPeers();
65
68
  return peers.filter((peer) => {
66
- const connections = this.components.connectionManager.getConnections(
67
- peer.id
68
- );
69
- return connections.some((c) =>
70
- c.streams.some((s) => s.protocol === this.multicodec)
69
+ return (
70
+ this.components.connectionManager.getConnections(peer.id).length > 0
71
71
  );
72
72
  });
73
73
  }
@@ -96,7 +96,7 @@ export class BaseProtocol implements IBaseProtocolCore {
96
96
  const connectedPeersForProtocolAndShard =
97
97
  await getConnectedPeersForProtocolAndShard(
98
98
  this.components.connectionManager.getConnections(),
99
- this.components.peerStore,
99
+ this.peerStore,
100
100
  [this.multicodec],
101
101
  pubsubTopicsToShardInfo(this.pubsubTopics)
102
102
  );
@@ -110,7 +110,7 @@ export class BaseProtocol implements IBaseProtocolCore {
110
110
 
111
111
  // Sort the peers by latency
112
112
  const sortedFilteredPeers = await sortPeersByLatency(
113
- this.components.peerStore,
113
+ this.peerStore,
114
114
  filteredPeers
115
115
  );
116
116
 
@@ -37,7 +37,6 @@ 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>,
41
40
  public readonly pubsubTopics: PubsubTopic[],
42
41
  libp2p: Libp2p
43
42
  ) {
@@ -302,18 +301,8 @@ export class FilterCore extends BaseProtocol implements IBaseProtocolCore {
302
301
  () => {
303
302
  log.info("Receiving pipe closed.");
304
303
  },
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);
304
+ (e) => {
305
+ log.error("Error with receiving pipe", e);
317
306
  }
318
307
  );
319
308
  } 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.libp2pComponents.peerStore.get(peerId);
48
+ const peer = await this.peerStore.get(peerId);
49
49
  if (!peer) {
50
50
  return {
51
51
  shardInfo: null,
@@ -1,47 +1,41 @@
1
- import type { PeerUpdate, Stream } from "@libp2p/interface";
2
- import type { Peer, PeerId } from "@libp2p/interface";
3
- import { Libp2p } from "@waku/interfaces";
1
+ import type { Peer, PeerId, PeerUpdate, Stream } from "@libp2p/interface";
2
+ import type { Libp2p } from "@waku/interfaces";
4
3
  import { Logger } from "@waku/utils";
5
4
 
6
- import { selectConnection } from "./utils.js";
7
-
8
- const CONNECTION_TIMEOUT = 5_000;
9
- const RETRY_BACKOFF_BASE = 1_000;
10
- const MAX_RETRIES = 3;
5
+ import { selectOpenConnection } from "./utils.js";
11
6
 
12
7
  export class StreamManager {
13
- private readonly streamPool: Map<string, Promise<Stream | void>>;
14
8
  private readonly log: Logger;
15
9
 
10
+ private ongoingCreation: Set<string> = new Set();
11
+ private streamPool: Map<string, Promise<void>> = new Map();
12
+
16
13
  public constructor(
17
- public multicodec: string,
18
- public getConnections: Libp2p["getConnections"],
19
- public addEventListener: Libp2p["addEventListener"]
14
+ private multicodec: string,
15
+ private getConnections: Libp2p["getConnections"],
16
+ private addEventListener: Libp2p["addEventListener"]
20
17
  ) {
21
18
  this.log = new Logger(`stream-manager:${multicodec}`);
22
- this.streamPool = new Map();
23
19
  this.addEventListener("peer:update", this.handlePeerUpdateStreamPool);
24
20
  }
25
21
 
26
22
  public async getStream(peer: Peer): Promise<Stream> {
27
- const peerIdStr = peer.id.toString();
28
- const streamPromise = this.streamPool.get(peerIdStr);
23
+ const peerId = peer.id.toString();
24
+
25
+ const scheduledStream = this.streamPool.get(peerId);
29
26
 
30
- if (!streamPromise) {
31
- return this.createStream(peer);
27
+ if (scheduledStream) {
28
+ this.streamPool.delete(peerId);
29
+ await scheduledStream;
32
30
  }
33
31
 
34
- this.streamPool.delete(peerIdStr);
35
- this.prepareStream(peer);
32
+ const stream = this.getOpenStreamForCodec(peer.id);
36
33
 
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");
34
+ if (stream) {
35
+ this.log.info(
36
+ `Found existing stream peerId=${peer.id.toString()} multicodec=${this.multicodec}`
37
+ );
38
+ return stream;
45
39
  }
46
40
 
47
41
  return this.createStream(peer);
@@ -49,67 +43,112 @@ export class StreamManager {
49
43
 
50
44
  private async createStream(peer: Peer, retries = 0): Promise<Stream> {
51
45
  const connections = this.getConnections(peer.id);
52
- const connection = selectConnection(connections);
46
+ const connection = selectOpenConnection(connections);
53
47
 
54
48
  if (!connection) {
55
- throw new Error("Failed to get a connection to the peer");
49
+ throw new Error(
50
+ `Failed to get a connection to the peer peerId=${peer.id.toString()} multicodec=${this.multicodec}`
51
+ );
56
52
  }
57
53
 
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);
54
+ let lastError: unknown;
55
+ let stream: Stream | undefined;
56
+
57
+ for (let i = 0; i < retries + 1; i++) {
58
+ try {
59
+ this.log.info(
60
+ `Attempting to create a stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
61
+ );
62
+ stream = await connection.newStream(this.multicodec);
63
+ this.log.info(
64
+ `Created stream for peerId=${peer.id.toString()} multicodec=${this.multicodec}`
65
+ );
66
+ break;
67
+ } catch (error) {
68
+ lastError = error;
65
69
  }
70
+ }
71
+
72
+ if (!stream) {
66
73
  throw new Error(
67
- `Failed to create a new stream for ${peer.id.toString()} -- ` + error
74
+ `Failed to create a new stream for ${peer.id.toString()} -- ` +
75
+ lastError
68
76
  );
69
77
  }
78
+
79
+ return stream;
70
80
  }
71
81
 
72
- private prepareStream(peer: Peer): void {
73
- const timeoutPromise = new Promise<void>((resolve) =>
74
- setTimeout(resolve, CONNECTION_TIMEOUT)
75
- );
82
+ private async createStreamWithLock(peer: Peer): Promise<void> {
83
+ const peerId = peer.id.toString();
76
84
 
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
85
+ if (this.ongoingCreation.has(peerId)) {
86
+ this.log.info(
87
+ `Skipping creation of a stream due to lock for peerId=${peerId} multicodec=${this.multicodec}`
86
88
  );
87
- });
89
+ return;
90
+ }
91
+
92
+ try {
93
+ this.ongoingCreation.add(peerId);
94
+ await this.createStream(peer);
95
+ } catch (error) {
96
+ this.log.error(`Failed to createStreamWithLock:`, error);
97
+ } finally {
98
+ this.ongoingCreation.delete(peerId);
99
+ }
88
100
 
89
- this.streamPool.set(peer.id.toString(), streamPromise);
101
+ return;
90
102
  }
91
103
 
92
104
  private handlePeerUpdateStreamPool = (evt: CustomEvent<PeerUpdate>): void => {
93
105
  const { peer } = evt.detail;
94
106
 
95
- if (peer.protocols.includes(this.multicodec)) {
96
- const isConnected = this.isConnectedTo(peer.id);
107
+ if (!peer.protocols.includes(this.multicodec)) {
108
+ return;
109
+ }
97
110
 
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
- }
111
+ const stream = this.getOpenStreamForCodec(peer.id);
112
+
113
+ if (stream) {
114
+ return;
108
115
  }
116
+
117
+ this.scheduleNewStream(peer);
109
118
  };
110
119
 
111
- private isConnectedTo(peerId: PeerId): boolean {
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
+ // abandon previous attempt
126
+ if (this.streamPool.has(peer.id.toString())) {
127
+ this.streamPool.delete(peer.id.toString());
128
+ }
129
+
130
+ this.streamPool.set(peer.id.toString(), this.createStreamWithLock(peer));
131
+ }
132
+
133
+ private getOpenStreamForCodec(peerId: PeerId): Stream | undefined {
112
134
  const connections = this.getConnections(peerId);
113
- return connections.some((connection) => connection.status === "open");
135
+ const connection = selectOpenConnection(connections);
136
+
137
+ if (!connection) {
138
+ return;
139
+ }
140
+
141
+ const stream = connection.streams.find(
142
+ (s) => s.protocol === this.multicodec
143
+ );
144
+
145
+ const isStreamUnusable = ["done", "closed", "closing"].includes(
146
+ stream?.writeStatus || ""
147
+ );
148
+ if (isStreamUnusable) {
149
+ return;
150
+ }
151
+
152
+ return stream;
114
153
  }
115
154
  }
@@ -1,22 +1,10 @@
1
1
  import type { Connection } from "@libp2p/interface";
2
2
 
3
- export function selectConnection(
3
+ export function selectOpenConnection(
4
4
  connections: Connection[]
5
5
  ): Connection | undefined {
6
- if (!connections.length) return;
7
- if (connections.length === 1) return connections[0];
8
-
9
- let latestConnection: Connection | undefined;
10
-
11
- connections.forEach((connection) => {
12
- if (connection.status === "open") {
13
- if (!latestConnection) {
14
- latestConnection = connection;
15
- } else if (connection.timeline.open > latestConnection.timeline.open) {
16
- latestConnection = connection;
17
- }
18
- }
19
- });
20
-
21
- return latestConnection;
6
+ return connections
7
+ .filter((c) => c.status === "open")
8
+ .sort((left, right) => right.timeline.open - left.timeline.open)
9
+ .at(0);
22
10
  }