@yz-social/kdht 0.1.5 → 0.1.7

package/dht/kbucket.js

@@ -36,7 +36,7 @@ export class KBucket {
   }
   async refresh() { // Refresh specified bucket using LocateNodes for a random key in the specified bucket's range.
     if (this.node.isStopped() || !this.contacts.length) return false; // fixme skip isStopped?
-    this.node.log('refresh bucket', this.index);
+    this.node.ilog('refresh bucket', this.index);
     const targetKey = this.randomTarget;
     await this.node.locateNodes(targetKey); // Side-effect is to update this bucket.
     return true;

package/dht/node.js

@@ -106,7 +106,7 @@ export class Node extends NodeProbe {
     return k - remaining;
   }
   async join(contact) {
-    this.log('joining', contact.sname);
+    this.ilog('joining', contact.sname);
     contact = this.ensureContact(contact);
     await contact.connect();
     await this.addToRoutingTable(contact);
@@ -126,7 +126,7 @@ export class Node extends NodeProbe {
     //   if (!started) started = true;
     //   else if (!bucket?.contacts.length) await this.ensureBucket(index).refresh();
     // }
-    this.log('joined', contact.sname);
+    this.ilog('joined', contact.sname);
     return this.contact; // Answering this node's home contact is handy for chaining or keeping track of contacts being made and joined.
   }
 }

package/dht/nodeProbe.js

@@ -86,7 +86,7 @@ export class NodeProbe extends NodeMessages {
     let iterationFinished = false;
 
     let resolveIteration;
-    const iterationPromise = new Promise((resolve) => resolveIteration = (...args) => { iterationFinished = true; resolve(...args) }); // to be resolved with a value result, or undefined
+    const iterationPromise = new Promise((resolve) => resolveIteration = (...args) => { iterationFinished = true; resolve(...args); }); // to be resolved with a value result, or undefined
 
     // Check if termination condition is met:
     // We're complete when we've found k 'responded' nodes with no unresolved nodes
@@ -166,7 +166,7 @@ export class NodeProbe extends NodeMessages {
 
         // Result is array of Helpers (may be empty if node had no new contacts)
         // Merge new helpers into allNodesSeen and track progress
-        if (result.length > 0) {
+        if (result?.length > 0) {
           allNodesSeen.push(...result);
           allNodesSeen.sort(Helper.compare); // Keep sorted by distance (best-first).
           responsesWithoutNewNodes = 0; // reset counter

package/dht/nodeStorage.js

@@ -12,7 +12,10 @@ export class NodeStorage extends NodeRefresh {
     }
     // TODO: The paper says this can be optimized.
     // Claude.ai suggests just writing to the next in line, but that doesn't work.
-    this.schedule(key, 'storage', () => this.storeValue(key, value));
+    this.schedule(key, 'storage', () => {
+      this.ilog('refresh value', value, 'at key', key);
+      this.storeValue(key, value);
+    });
   }
   retrieveLocally(key) {     // Retrieve from memory.
     return this.storage.get(key);

package/dht/nodeUtilities.js

@@ -12,11 +12,13 @@ export class NodeUtilities {
   }
   
   debug = false;
+  info = true;
   get sname() { // The home contact sname, or just name if no contact
     return this.contact?.sname || this.name;
   }
-  log(...rest) { if (this.debug) console.log(new Date(), this.sname, ...rest); }
-  xlog(...rest) { console.log(new Date(), this.sname, ...rest); }
+  log(...rest) { if (this.debug) this.xlog(new Date(), this.sname, ...rest); }
+  ilog(...rest) { if (this.info || this.debug) this.xlog(...rest); }
+  xlog(...rest) { console.log(new Date().toISOString(), this.sname, ...rest); }
   static assert(ok, ...rest) { // If !ok, log rests and exit.
     if (ok) return;
     console.error(...rest, new Error("Assert failure").stack); // Not throwing error, because we want to exit. But we are grabbing stack.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yz-social/kdht",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Pure Kademlia base, for testing variations.",
   "exports": {
     ".": "./index.js",
@@ -9,7 +9,7 @@
   },
   "type": "module",
   "scripts": {
-    "start": "node spec/portal.js --externalBaseURL https://yz.social/kdht",
+    "start": "node spec/portal.js --externalBaseURL https://ki1r0y.com/kdht",
     "stop": "pkill kdht",
     "background": "npm stop; (npm start 1>server.log 2>&1 &); sleep 1",
     "bots": "node spec/bots.js",

package/portals/node.js

@@ -28,7 +28,6 @@ export async function setup({baseURL, externalBaseURL = '', verbose, fixedSpacin
   const bootstrap = joinURL && await contact.ensureRemoteContact(bootstrapName, joinURL);
   process.send(contact.sname); // Report in to server as available for others to bootstrap through.
   if (bootstrap) await contact.join(bootstrap);
-  contact.host.xlog('joined');
   process.on('SIGINT', async () => {
     console.log(process.title, 'Shutdown for Ctrl+C');
     await contact.disconnect();

package/spec/bots.js

@@ -45,8 +45,10 @@ const argv = yargs(hideBin(process.argv))
       .parse();
 
 const host = uuidv4();
+process.title = 'kdht-bot-' + host;
 
 if (cluster.isPrimary) {
+  console.log(`${cpus()[0].model}, ${logicalCores} logical cores. Starting ${argv.nBots} over ${Node.refreshTimeIntervalMS/1000} seconds.`);
   for (let i = 1; i < argv.nBots; i++) { // The cluster primary becomes bot 0.
     cluster.fork();
   }
@@ -56,7 +58,6 @@ if (cluster.isPrimary) {
     launchWriteRead(argv.nWrites, argv.baseURL, Node.refreshTimeIntervalMS, argv.verbose);
   }
 }
-process.title = 'kdht-bot-' + host;
 
 await Node.delay(Node.randomInteger(Node.refreshTimeIntervalMS));
 console.log(cluster.worker?.id || 0, host);
@@ -64,19 +65,17 @@ let contact = await WebContact.create({name: host, debug: argv.verbose});
 let bootstrapName = await contact.fetchBootstrap(argv.baseURL);
 let bootstrapContact = await contact.ensureRemoteContact(bootstrapName, argv.baseURL);
 await contact.join(bootstrapContact);
-contact.host.xlog('joined');
 
-// process.on('SIGINT', async () => {
-//   console.log(process.title, 'Shutdown for Ctrl+C');
-//   await contact.disconnect();
-//   process.exit(0);
-// });
+process.on('SIGINT', async () => {
+  console.log(process.title, 'Shutdown for Ctrl+C');
+  await contact.disconnect();
+  process.exit(0);
+});
 
 while (argv.thrash) {
   await Node.delay(contact.host.fuzzyInterval(Node.refreshTimeIntervalMS));
   const old = contact;
   const next = uuidv4();
-  contact.host.xlog('disconnecting');
   await contact.disconnect();
   await Node.delay(1e3); // TODO: remove?
 
@@ -84,6 +83,5 @@ while (argv.thrash) {
   bootstrapName = await contact.fetchBootstrap(argv.baseURL);
   bootstrapContact = await contact.ensureRemoteContact(bootstrapName, argv.baseURL);
   await contact.join(bootstrapContact);
-  old.host.xlog('rejoined as', next);  
 }
 

package/spec/dhtImplementation.js

@@ -16,7 +16,7 @@ export { Node, Contact };
 
 
 export async function start1(name, bootstrapContact, refreshTimeIntervalMS, isServerNode = false) {
-  const contact = await Contact.create({name, refreshTimeIntervalMS, isServerNode});
+  const contact = await Contact.create({name, refreshTimeIntervalMS, isServerNode, info: false});
   if (bootstrapContact) await contact.join(bootstrapContact);
   return contact;
 }

package/spec/portal.js

@@ -79,6 +79,7 @@ const argv = yargs(hideBin(process.argv))
 if (cluster.isPrimary) { // Parent process with portal webserver through which clienta can bootstrap
   // Our job is to launch some kdht nodes to which clients can connect by signaling through
   // a little web server operated here.
+  console.log(`${cpus()[0].model}, ${logicalCores} logical cores.`);
   process.title = 'kdht-portal-server';
   const __filename = fileURLToPath(import.meta.url);
   const __dirname = path.dirname(__filename);

package/transports/contact.js

@@ -83,7 +83,7 @@ export class Contact {
     this.host.removeLooseTransport(this.key); // If any.
   }
   bye() { // The sender is disconnecting from the network
-    this.host.log('removing disconnected contact', this.sname);
+    this.host.ilog('removing disconnected contact', this.sname);
     this.host.removeContact(this).then(bucket => bucket?.resetRefresh('now')); // Accelerate the bucket refresh
   }
   distance(key) { return this.host.constructor.distance(this.key, key); }
@@ -158,7 +158,6 @@ export class Contact {
       const deserialized = await this.deserializeRequest(...data);
       let response = await this.host.receiveRPC(...deserialized);
       response = this.serializeResponse(response);
-      //if (messageTag.startsWith('X')) this.host.xlog(this.counter, 'responding', messageTag, response, 'to', this.sname);
       await this.send([messageTag, response]);
     }
   }

package/transports/webrtc.js

@@ -76,7 +76,7 @@ export class WebContact extends Contact { // Our wrapper for the means of contac
     return `@${this.host.contact.sname} ==> ${this.sname}`;
   }
 
-  ensureWebRTC(initiate = false, timeoutMS = this.host.timeoutMS || 10e3) { // Ensure we are connected, if possible.
+  ensureWebRTC(initiate = false, timeoutMS = this.host.timeoutMS || 30e3) { // Ensure we are connected, if possible.
     // If not already configured, sets up contact to have properties:
     // - connection - a promise for an open webrtc data channel:
     //   this.send(string) puts data on the channel
@@ -118,7 +118,7 @@ export class WebContact extends Contact { // Our wrapper for the means of contac
       clearTimeout(timeout);
       dataChannel.addEventListener('close', onclose);
       dataChannel.addEventListener('message', event => this.receiveWebRTC(event.data));
-      if  (this.host.debug) await webrtc.reportConnection(true); // TODO: make this asymchronous?
+      await webrtc.reportConnection(true);
       if (webrtc.statsElapsed > 500) this.host.xlog(`** slow connection to ${this.sname} took ${webrtc.statsElapsed.toLocaleString()} ms. **`);
       this.unsafeData = dataChannel;
       return dataChannel;
@@ -130,7 +130,7 @@ export class WebContact extends Contact { // Our wrapper for the means of contac
     const timerPromise = new Promise(expired => {
       timeout = setTimeout(async () => {
 	const now = Date.now();
-	this.host.xlog('Unable to connect to', this.sname);
+	this.host.ilog('Unable to connect to', this.sname);
 	// this.host.xlog('**** connection timeout', this.sname, now - start,
 	// 	       'status:', webrtc.pc.connectionState, 'signaling:', webrtc.pc.signalingState,
 	// 	       'last signal:', now - webrtc.lastOutboundSignal,
@@ -161,7 +161,7 @@ export class WebContact extends Contact { // Our wrapper for the means of contac
   async send(message) { // Promise to send through previously opened connection promise.
     let channel = await this.connection;
     if (channel?.readyState === 'open') channel.send(JSON.stringify(message));
-    else this.host.xlog('Unable to open channel');
+    else this.host.xlog('Tried to send on unopen channel on', this.sname, message);
   }
   synchronousSend(message) { // this.send awaits channel open promise. This is if we know it has been opened.
     if (this.unsafeData?.readyState !== 'open') return; // But it may have since been closed.
@@ -232,12 +232,6 @@ export class WebContact extends Contact { // Our wrapper for the means of contac
     // The message could the start of an RPC sent from the peer, or it could be a response to an RPC that we made.
     // As we do the latter, we generate and note (in transmitRPC) a message tag included in the message.
     // If we find that in our messageResolvers tags, then the message is a response.
-    if (dataString === '"bye"') { // Special messsage that the other side is disconnecting, so we can clean up early.
-      this.webrtc.close();
-      this.host.xlog('removing disconnected contact', this.sname);
-      await this.host.removeContact(this);  // TODO: Make sure we're not invoking this in maxTransports cases.
-      return;
-    }
     const [messageTag, ...data] = JSON.parse(dataString);
     await this.receiveRPC(messageTag, ...data);
   }