NodeAddress: changing 'ip' field to 'host'

joshuakarp · joshuakarp · commit 491bcd8c5724 · 2021-11-15T15:42:36.000+11:00
diff --git a/src/agent/agentService.ts b/src/agent/agentService.ts
@@ -197,7 +197,7 @@ function createAgentService({
         );
         for (const node of closestNodes) {
           const addressMessage = new nodesPB.Address();
-          addressMessage.setHost(node.address.ip);
+          addressMessage.setHost(node.address.host);
           addressMessage.setPort(node.address.port);
           // Add the node to the response's map (mapping of node ID -> node address)
           response.getNodeTableMap().set(node.id, addressMessage);
diff --git a/src/client/rpcNodes.ts b/src/client/rpcNodes.ts
@@ -50,7 +50,7 @@ const createNodesRPC = ({
           throw new nodesErrors.ErrorInvalidHost();
         }
         await nodeManager.setNode(nodesUtils.makeNodeId(call.request.getNodeId()), {
-          ip: call.request.getAddress()!.getHost(),
+          host: call.request.getAddress()!.getHost(),
           port: call.request.getAddress()!.getPort(),
         } as NodeAddress);
       } catch (err) {
@@ -141,7 +141,7 @@ const createNodesRPC = ({
         response
           .setNodeId(nodeId)
           .setAddress(
-            new nodesPB.Address().setHost(address.ip).setPort(address.port),
+            new nodesPB.Address().setHost(address.host).setPort(address.port),
           );
       } catch (err) {
         callback(grpcUtils.fromError(err), response);
diff --git a/src/nodes/NodeConnection.ts b/src/nodes/NodeConnection.ts
@@ -269,7 +269,7 @@ class NodeConnection {
       nodes.push({
         id: nodeId as NodeId,
         address: {
-          ip: address.getHost() as Host,
+          host: address.getHost() as Host,
           port: address.getPort() as Port,
         },
         distance: nodesUtils.calculateDistance(targetNodeId, nodeId as NodeId),
diff --git a/src/nodes/NodeGraph.ts b/src/nodes/NodeGraph.ts
@@ -1,5 +1,5 @@
 import type { NodeId, NodeAddress, NodeBucket, NodeData } from './types';
-import type { Host, Port } from '../network/types';
+import type { Host, Hostname, Port } from '../network/types';
 import type { DB, DBLevel, DBOp } from '@matrixai/db';
 import type { NodeConnection } from '../nodes';
 
@@ -181,7 +181,7 @@ class NodeGraph {
       );
       // Cast the non-primitive types correctly (ensures type safety when using them)
       for (const nodeId in bucket) {
-        bucket[nodeId].address.ip = bucket[nodeId].address.ip as Host;
+        bucket[nodeId].address.host = bucket[nodeId].address.host as (Host | Hostname);
         bucket[nodeId].address.port = bucket[nodeId].address.port as Port;
         bucket[nodeId].lastUpdated = new Date(bucket[nodeId].lastUpdated);
       }
diff --git a/src/nodes/NodeManager.ts b/src/nodes/NodeManager.ts
@@ -224,7 +224,7 @@ class NodeManager {
       // i.e. no NodeConnection object created (no need for GRPCClient)
       await this.fwdProxy.openConnection(
         targetNodeId,
-        await networkUtils.resolveHost(targetAddress.ip),
+        await networkUtils.resolveHost(targetAddress.host),
         targetAddress.port,
       );
     } catch (e) {
diff --git a/src/nodes/types.ts b/src/nodes/types.ts
@@ -9,7 +9,7 @@ import { IdString } from '../GenericIdTypes';
 type NodeId = Opaque<'NodeId', IdString>;
 
 type NodeAddress = {
-  ip: Host | Hostname;
+  host: Host | Hostname;
   port: Port;
 };
 
diff --git a/tests/agent/GRPCClientAgent.test.ts b/tests/agent/GRPCClientAgent.test.ts
@@ -283,7 +283,7 @@ describe('GRPC agent', () => {
         lock: new Mutex(),
       });
       await nodeManager.setNode(nodeIdY, {
-        ip: 'unnecessary' as Host,
+        host: 'unnecessary' as Host,
         port: 0 as Port,
       } as NodeAddress);
     });
diff --git a/tests/bin/nodes.test.ts b/tests/bin/nodes.test.ts
@@ -119,7 +119,7 @@ describe('CLI Nodes', () => {
   describe('commandClaimNode', () => {
     beforeAll(async () => {
       await remoteOnline.nodes.setNode(keynodeId, {
-        ip: polykeyAgent.revProxy.getIngressHost(),
+        host: polykeyAgent.revProxy.getIngressHost(),
         port: polykeyAgent.revProxy.getIngressPort(),
       } as NodeAddress);
       await polykeyAgent.acl.setNodePerm(remoteOnlineNodeId, {
@@ -365,7 +365,7 @@ describe('CLI Nodes', () => {
       //Checking if node was added.
       const res = await polykeyAgent.nodes.getNode(validNodeId);
       expect(res).toBeTruthy();
-      expect(res!.ip).toEqual(validHost);
+      expect(res!.host).toEqual(validHost);
       expect(res!.port).toEqual(port);
     });
     test(
diff --git a/tests/bin/notifications.test.ts b/tests/bin/notifications.test.ts
@@ -80,7 +80,7 @@ describe('CLI Notifications', () => {
     senderNodeId = senderPolykeyAgent.nodes.getNodeId();
     receiverNodeId = receiverPolykeyAgent.nodes.getNodeId();
     await senderPolykeyAgent.nodes.setNode(receiverNodeId, {
-      ip: receiverPolykeyAgent.revProxy.getIngressHost(),
+      host: receiverPolykeyAgent.revProxy.getIngressHost(),
       port: receiverPolykeyAgent.revProxy.getIngressPort(),
     } as NodeAddress);
 
diff --git a/tests/client/clientService.test.ts b/tests/client/clientService.test.ts
@@ -2006,7 +2006,7 @@ describe('Client service', () => {
       if (!nodeAddress) {
         fail('Node address undefined');
       }
-      expect(nodeAddress.ip).toBe(host);
+      expect(nodeAddress.host).toBe(host);
       expect(nodeAddress.port).toBe(port);
     });
     test(
@@ -2051,7 +2051,7 @@ describe('Client service', () => {
       // Case 1: node already exists in the local node graph (no contact required)
       const nodeId = nodeId3;
       const nodeAddress: NodeAddress = {
-        ip: '127.0.0.1' as Host,
+        host: '127.0.0.1' as Host,
         port: 11111 as Port,
       };
       await nodeManager.setNode(nodeId, nodeAddress);
@@ -2060,7 +2060,7 @@ describe('Client service', () => {
       nodeMessage.setNodeId(nodeId);
       const res = await nodesFind(nodeMessage, callCredentials);
       expect(res.getNodeId()).toEqual(nodeId);
-      expect(res.getAddress()?.getHost()).toEqual(nodeAddress.ip);
+      expect(res.getAddress()?.getHost()).toEqual(nodeAddress.host);
       expect(res.getAddress()?.getPort()).toEqual(nodeAddress.port);
     });
     // FIXME: this operation seems to be pretty slow.
@@ -2071,7 +2071,7 @@ describe('Client service', () => {
         // Case 2: node can be found on the remote node
         const nodeId = nodeId1;
         const nodeAddress: NodeAddress = {
-          ip: '127.0.0.1' as Host,
+          host: '127.0.0.1' as Host,
           port: 11111 as Port,
         };
         // Setting the information on a remote node.
@@ -2084,7 +2084,7 @@ describe('Client service', () => {
         nodeMessage.setNodeId(nodeId);
         const res = await nodesFind(nodeMessage, callCredentials);
         expect(res.getNodeId()).toEqual(nodeId);
-        expect(res.getAddress()?.getHost()).toEqual(nodeAddress.ip);
+        expect(res.getAddress()?.getHost()).toEqual(nodeAddress.host);
         expect(res.getAddress()?.getPort()).toEqual(nodeAddress.port);
       },
       global.failedConnectionTimeout * 2,
@@ -2098,7 +2098,7 @@ describe('Client service', () => {
         // Server will not be able to connect to this node (the only node in its
         // database), and will therefore not be able to locate the node.
         await server.nodes.setNode(dummyNode, {
-          ip: '127.0.0.2' as Host,
+          host: '127.0.0.2' as Host,
           port: 22222 as Port,
         } as NodeAddress);
         const nodesFind = grpcUtils.promisifyUnaryCall<nodesPB.Address>(
@@ -2126,7 +2126,7 @@ describe('Client service', () => {
       remoteGestaltNode.id = remoteGestalt.nodes.getNodeId();
       await testKeynodeUtils.addRemoteDetails(polykeyAgent, remoteGestalt);
       await remoteGestalt.nodes.setNode(nodeManager.getNodeId(), {
-        ip: polykeyAgent.revProxy.getIngressHost(),
+        host: polykeyAgent.revProxy.getIngressHost(),
         port: polykeyAgent.revProxy.getIngressPort(),
       } as NodeAddress);
       await polykeyAgent.acl.setNodePerm(remoteGestaltNode.id, {
@@ -2216,7 +2216,7 @@ describe('Client service', () => {
       sender = await testKeynodeUtils.setupRemoteKeynode({ logger });
 
       await sender.nodes.setNode(node1.id, {
-        ip: polykeyAgent.revProxy.getIngressHost(),
+        host: polykeyAgent.revProxy.getIngressHost(),
         port: polykeyAgent.revProxy.getIngressPort(),
       } as NodeAddress);
       await receiver.acl.setNodePerm(node1.id, {
diff --git a/tests/nodes/NodeConnection.test.ts b/tests/nodes/NodeConnection.test.ts
@@ -320,7 +320,7 @@ describe('NodeConnection', () => {
         i,
       );
       const nodeAddress = {
-        ip: (i + '.' + i + '.' + i + '.' + i) as Host,
+        host: (i + '.' + i + '.' + i + '.' + i) as Host,
         port: i as Port,
       };
       await serverNodeManager.setNode(closeNodeId, nodeAddress);
@@ -334,7 +334,7 @@ describe('NodeConnection', () => {
     for (let i = 1; i <= 10; i++) {
       const farNodeId = nodeIdGenerator(i);
       const nodeAddress = {
-        ip: (i + '.' + i + '.' + i + '.' + i) as Host,
+        host: (i + '.' + i + '.' + i + '.' + i) as Host,
         port: i as Port,
       };
       await serverNodeManager.setNode(farNodeId, nodeAddress);
diff --git a/tests/nodes/NodeGraph.test.ts b/tests/nodes/NodeGraph.test.ts
diff --git a/tests/notifications/NotificationsManager.test.ts b/tests/notifications/NotificationsManager.test.ts
diff --git a/tests/utils.ts b/tests/utils.ts
diff --git a/tests/vaults/VaultManager.test.ts b/tests/vaults/VaultManager.test.ts
