fix: updated function name

[ci skip]

Author: tegefaulkes

src/nodes/NodeConnectionManager.ts

@@ -1425,7 +1425,8 @@ class NodeConnectionManager {
     const id = `${host}:${port}`;
     if (this.activeHolePunchPs.has(id)) return;
     // Checking for resource semaphore
-    let semaphore: Semaphore | undefined = this.activeHolePunchAddresses.get(host);
+    let semaphore: Semaphore | undefined =
+      this.activeHolePunchAddresses.get(host);
     if (semaphore == null) {
       semaphore = new Semaphore(3);
       this.activeHolePunchAddresses.set(host, semaphore);
@@ -1507,12 +1508,19 @@ class NodeConnectionManager {
   }
 
   /**
-   * This till ask a signalling node to signal a target node to hole punch back to this node.
+   * Will make a connection to the signalling node and make a nodesConnectionSignalInitial` request.
+   *
+   * If the signalling node does not have an existing connection to the target then this will throw.
+   * If verification of the request fails then this will throw, but this shouldn't happen.
+   * The request contains a signature generated from `<sourceNodeId><targetNodeId>`.
+   *
+   *
+   *
    * @param targetNodeId - NodeId of the node that needs to signal back.
    * @param signallingNodeId - NodeId of the signalling node.
    * @param ctx
    */
-  public holePunchSignalRequest(
+  public connectionSignalInitial(
     targetNodeId: NodeId,
     signallingNodeId: NodeId,
     ctx?: Partial<ContextTimedInput>,
@@ -1523,7 +1531,7 @@ class NodeConnectionManager {
     (nodeConnectionManager: NodeConnectionManager) =>
       nodeConnectionManager.connectionConnectTimeoutTime,
   )
-  public async holePunchSignalRequest(
+  public async connectionSignalInitial(
     targetNodeId: NodeId,
     signallingNodeId: NodeId,
     @context ctx: ContextTimed,
@@ -1709,6 +1717,9 @@ class NodeConnectionManager {
    *
    * This is pretty simple, it will contact all known seed nodes and get them to
    * relay a punch signal message.
+   *
+   * This doesn't care if the requests fail or succeed, so any errors or results are ignored.
+   *
    */
   protected initiateHolePunch(
     targetNodeIds: Array<NodeId>,
@@ -1726,7 +1737,7 @@ class NodeConnectionManager {
         // Ask seed nodes to signal hole punching for target
         const holePunchProms = seedNodes.map((seedNodeId) => {
           return (
-            this.holePunchSignalRequest(targetNodeId, seedNodeId, ctx)
+            this.connectionSignalInitial(targetNodeId, seedNodeId, ctx)
               // Ignore results
               .then(
                 () => {},

tests/nodes/NodeConnectionManager.general.test.ts

@@ -404,7 +404,7 @@ describe(`${NodeConnectionManager.name} general test`, () => {
     const relayNodeId = remotePolykeyAgentA.keyRing.getNodeId();
 
     await expect(
-      nodeConnectionManager.holePunchSignalRequest(targetNodeId, relayNodeId),
+      nodeConnectionManager.connectionSignalInitial(targetNodeId, relayNodeId),
     ).rejects.toThrow();
     await nodeConnectionManager.stop();
   });
@@ -448,7 +448,7 @@ describe(`${NodeConnectionManager.name} general test`, () => {
     const targetNodeId = remotePolykeyAgentB.keyRing.getNodeId();
     const relayNodeId = remotePolykeyAgentA.keyRing.getNodeId();
 
-    await nodeConnectionManager.holePunchSignalRequest(
+    await nodeConnectionManager.connectionSignalInitial(
       targetNodeId,
       relayNodeId,
     );
@@ -459,8 +459,9 @@ describe(`${NodeConnectionManager.name} general test`, () => {
     for (const p of signalMapA) {
       await p;
     }
-    // @ts-ignore: kidnap protected property
-    const punchMapB = remotePolykeyAgentB.nodeConnectionManager.activeHolePunchPs;
+    const punchMapB =
+      // @ts-ignore: kidnap protected property
+      remotePolykeyAgentB.nodeConnectionManager.activeHolePunchPs;
     for await (const [, p] of punchMapB) {
       await p;
     }
@@ -509,7 +510,7 @@ describe(`${NodeConnectionManager.name} general test`, () => {
     const relayNodeId = remotePolykeyAgentA.keyRing.getNodeId();
     // Creating 5 concurrent attempts
     const holePunchSignalRequests = [1, 2, 3, 4, 5].map(() =>
-      nodeConnectionManager.holePunchSignalRequest(targetNodeId, relayNodeId),
+      nodeConnectionManager.connectionSignalInitial(targetNodeId, relayNodeId),
     );
     // All should resolve immediately and not block
     await Promise.all(holePunchSignalRequests);
@@ -522,8 +523,9 @@ describe(`${NodeConnectionManager.name} general test`, () => {
       await p;
     }
     // Only one attempt is being made
-    // @ts-ignore: kidnap protected property
-    const punchMapB = remotePolykeyAgentB.nodeConnectionManager.activeHolePunchPs;
+    const punchMapB =
+      // @ts-ignore: kidnap protected property
+      remotePolykeyAgentB.nodeConnectionManager.activeHolePunchPs;
     expect(punchMapB.size).toBe(1);
     // Allow the attempt to complete
     waitResolveP();
@@ -649,8 +651,9 @@ describe(`${NodeConnectionManager.name} general test`, () => {
     for (const p of signalMapA.values()) {
       await p;
     }
-    // @ts-ignore: kidnap protected property
-    const punchMapB = remotePolykeyAgentB.nodeConnectionManager.activeHolePunchPs;
+    const punchMapB =
+      // @ts-ignore: kidnap protected property
+      remotePolykeyAgentB.nodeConnectionManager.activeHolePunchPs;
     for (const [, p] of punchMapB) {
       await p;
     }