chore: review docs and binary

.aegir.js

@@ -8,7 +8,6 @@ const WebSockets = require('libp2p-websockets')
 const Muxer = require('libp2p-mplex')
 const { NOISE: Crypto } = require('libp2p-noise')
 
-const { isNode } = require('ipfs-utils/src/env')
 const delay = require('delay')
 const execa = require('execa')
 const pWaitFor = require('p-wait-for')
@@ -44,8 +43,10 @@ const before = async () => {
 
   await libp2p.start()
 
-  // CI runs datastore service
-  if (isCI || !isNode) {
+  // TODO: if not running test suite in Node, can also stop here
+  // https://github.com/ipfs/aegir/issues/707
+  // CI runs own datastore service
+  if (isCI) {
     return
   }
 
@@ -64,14 +65,14 @@ const before = async () => {
   }, {
     interval: 5000
   })
-  // Some more time waiting
+  // Some more time waiting to guarantee the container is really ready
   await delay(12e3)
 }
 
 const after = async () => {
   await libp2p.stop()
 
-  if (isCI || !isNode) {
+  if (isCI) {
     return
   }
 
@@ -80,7 +81,7 @@ const after = async () => {
 }
 
 module.exports = {
-  bundlesize: { maxSize: '100kB' },
+  bundlesize: { maxSize: '80kB' },
   hooks: {
     pre: before,
     post: after

Dockerfile

@@ -1,7 +1,7 @@
-FROM node:lts-buster
+FROM node:lts-alpine
 
 # Install deps
-RUN apt-get update && apt-get install -y
+RUN apk add --update git build-base python3
 
 # Get dumb-init to allow quit running interactively
 RUN wget -O /usr/local/bin/dumb-init https://github.com/Yelp/dumb-init/releases/download/v1.2.0/dumb-init_1.2.0_amd64 && chmod +x /usr/local/bin/dumb-init
@@ -21,14 +21,8 @@ RUN npm install --production
 COPY --chown=node:node ./src ./src
 COPY --chown=node:node ./README.md ./
 
-# rendezvous defaults to 15002
-EXPOSE 15002
-
-# metrics defaults to 8003
-EXPOSE 8003
+ENV DEBUG libp2p*
 
 # Available overrides (defaults shown):
-#   --disableMetrics=false
-# Server logging can be enabled via the DEBUG environment variable:
-#   DEBUG=libp2p:rendezvous:*
+# Server logging can be enabled via the DEBUG environment variable
 CMD [ "/usr/local/bin/dumb-init", "node", "src/server/bin.js"]

LIBP2P.md

@@ -13,14 +13,15 @@ const Libp2p = require('libp2p')
 
 const node = await Libp2p.create({
   rendezvous: {
-    enabled: true
+    enabled: true,
+    rendezvousPoints: ['/dnsaddr/rendezvous.libp2p.io/p2p/QmNnooDu7bfjPFoTZYxMNLWUQJyrVwtbZg5gBMjTezGAJP']
   }
 })
 ```
 
 ## Libp2p Flow
 
-When a libp2p node with the rendezvous protocol enabled starts, it should start by connecting to a rendezvous server. The rendezvous server can be added to the bootstrap nodes or manually dialed. When a rendezvous server is connected, the node can ask for nodes in given namespaces. An example of a namespace could be a relay namespace, so that undialable nodes can register themselves as reachable through that relay.
+When a libp2p node with the rendezvous protocol enabled starts, it should start by connecting to the given rendezvous servers. When a rendezvous server is connected, the node can ask for nodes in given namespaces. An example of a namespace could be a relay namespace, so that undialable nodes can register themselves as reachable through that relay.
 
 When a libp2p node running the rendezvous protocol is stopping, it will unregister from all the namespaces previously registered.
 
@@ -34,16 +35,17 @@ This API allows users to register new rendezvous namespaces, unregister from pre
 |------|------|-------------|
 | options | `object` | rendezvous parameters |
 | options.enabled | `boolean` | is rendezvous enabled |
+| options.rendezvousPoints | `Multiaddr[]` | list of multiaddrs of running rendezvous servers |
 
 ### rendezvous.start
 
-Register the rendezvous protocol topology into libp2p.
+Start the rendezvous client in the libp2p node.
 
 `rendezvous.start()`
 
 ### rendezvous.stop
 
-Unregister the rendezvous protocol and the streams with other peers will be closed.
+Clear the rendezvous state and unregister from namespaces.
 
 `rendezvous.stop()`
 
@@ -117,7 +119,7 @@ Discovers peers registered under a given namespace.
 
 | Type | Description |
 |------|-------------|
-| `AsyncIterable<{ signedPeerRecord: Envelope, ns: string, ttl: number }>` | Async Iterable registrations |
+| `AsyncIterable<{ signedPeerRecord: Uint8Array, ns: string, ttl: number }>` | Async Iterable registrations |
 
 #### Example
 
@@ -128,4 +130,10 @@ await rendezvous.register(namespace)
 for await (const reg of rendezvous.discover(namespace)) {
   console.log(reg.signedPeerRecord, reg.ns, reg.ttl)
 }
-```
+```
+
+## Future Work
+
+- Libp2p can handle re-registers when properly configured
+- Rendezvous client should be able to register namespaces given in configuration on startup
+  - Not supported at the moment, as we would need to deal with re-register over time

README.md

@@ -18,8 +18,10 @@
 - [Overview](#overview)
 - [Usage](#usage)
   - [Install](#install)
+  - [Testing](#testing)
   - [CLI](#cli)
   - [Docker Setup](#docker-setup)
+- [Garbage Collector](#garbage-collector)
 - [Contribute](#contribute)
 - [License](#license)
 
@@ -37,7 +39,7 @@ See the [SPEC](https://github.com/libp2p/specs/tree/master/rendezvous) for more
 > npm install --global libp2p-rendezvous
 ```
 
-Now you can use the cli command `libp2p-rendezvous-server` to spawn a libp2p rendezvous server. Bear in mind that a MySQL database is required to run the rendezvous server.
+Now you can use the cli command `libp2p-rendezvous-server` to spawn a libp2p rendezvous server. Bear in mind that a MySQL database is required to run the rendezvous server. You can also use this module as a library and implement your own datastore to use a different database. A datastore `interface` is provided in this repository.
 
 ### Testing
 
@@ -67,7 +69,7 @@ Once a MySQL database is running, you can run the rendezvous server by providing
 libp2p-rendezvous-server --datastoreHost 'localhost' --datastoreUser 'root' --datastorePassword 'your-secret-pw' --datastoreDatabase 'libp2p_rendezvous_db'
 ```
 
-⚠️ For testing purposes you can skip using MySQL and use a memory datastore. This must not be used in production! For this you just need to provide the `--enableMemoryDatabase` option.
+⚠️ For testing purposes you can skip using MySQL and use a memory datastore. **This must not be used in production!**. For this you just need to provide the `--enableMemoryDatabase` option.
 
 #### PeerId
 
@@ -106,6 +108,8 @@ libp2p-rendezvous-server --disableMetrics
 
 ### Docker Setup
 
+TODO: Finish docker setup
+
 ```yml
 version: '3.1'
 services:
@@ -124,11 +128,18 @@ volumes:
   mysql-db:
 ```
 
-## Library
+### Library
+
+TODO: How to use this module as a library
+- Datastores
+
+## Garbage Collector
+
+The rendezvous server has a built in garbage collector (GC) that removes persisted data over time, as it is expired.
 
-TODO
+The GC job has two different triggers. It will run over time according to the configurable `gcBootDelay` and `gcInterval` options, and it will run if it reaches a configurable `gcMaxRegistrations` threshold.
 
-Datastores
+Taking into account the GC performance, two other factors are considered before the GC interacts with the Datastore. If a configurable number of minimum registrations `gcMinRegistrations` are not stored, the GC job will not act in this GC cycle. Moreover, to avoid multiple attempts of GC when the max threshold is reached, but no records are yet expired, a minimum interval between each job can also be configured with `gcMinInterval`.
 
 ## Contribute
 

mysql/docker-compose.yml → mysql-test/docker-compose.yml

@@ -11,10 +11,6 @@ services:
       MYSQL_USER: libp2p
       MYSQL_PASSWORD: my-secret-pw
       MYSQL_DATABASE: libp2p_rendezvous_db
-      # MYSQL_DATABASE: ${DATABASE}
-      # MYSQL_ROOT_PASSWORD: ${ROOT_PASSWORD}
-      # MYSQL_USER: ${USER}
-      # MYSQL_PASSWORD: ${PASSWORD}
     ports:
       - "3306:3306"
 volumes:

package.json

@@ -1,9 +1,18 @@
 {
   "name": "libp2p-rendezvous",
   "version": "0.0.0",
-  "description": "Javascript implementation of the rendezvous protocol for libp2p",
+  "description": "Javascript implementation of the rendezvous protocol server for libp2p",
   "leadMaintainer": "Vasco Santos <[email protected]>",
   "main": "src/index.js",
+  "types": "dist/src/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "src/*": [
+        "dist/src/*",
+        "dist/src/*/index"
+      ]
+    }
+  },
   "bin": {
     "libp2p-rendezvous-server": "src/server/bin.js"
   },

src/index.js

@@ -59,7 +59,7 @@ class Rendezvous {
   }
 
   /**
-   * Register the rendezvous protocol in the libp2p node.
+   * Start the rendezvous client in the libp2p node.
    *
    * @returns {void}
    */
@@ -73,7 +73,7 @@ class Rendezvous {
   }
 
   /**
-   * Clear the rendezvous state and remove listeners.
+   * Clear the rendezvous state and unregister from namespaces.
    *
    * @returns {void}
    */
@@ -85,6 +85,8 @@ class Rendezvous {
     this._isStarted = false
     this._cookies.clear()
     log('stopped')
+
+    // TODO: should unregister from the namespaces registered
   }
 
   /**
@@ -156,7 +158,7 @@ class Rendezvous {
     }
 
     // Return first ttl
-    // TODO: consider pAny
+    // TODO: consider pAny instead of Promise.all?
     const [returnTtl] = await Promise.all(registerTasks)
 
     return returnTtl
@@ -225,6 +227,9 @@ class Rendezvous {
    * @returns {AsyncIterable<{ signedPeerRecord: Uint8Array, ns: string, ttl: number }>}
    */
   async * discover (ns, limit = MAX_DISCOVER_LIMIT) {
+    // TODO: consider opening the envelope in the dicover
+    // This would store the addresses in the AddressBook
+
     // Are there available rendezvous servers?
     if (!this._rendezvousPoints || !this._rendezvousPoints.length) {
       throw errCode(new Error('no rendezvous servers connected'), errCodes.NO_CONNECTED_RENDEZVOUS_SERVERS)

src/server/bin.js

@@ -2,7 +2,8 @@
 
 'use strict'
 
-// Usage: $0 [--peerId <jsonFilePath>] [--listenMultiaddrs <ma> ... <ma>] [--announceMultiaddrs <ma> ... <ma>] [--metricsPort <port>] [--disableMetrics]
+// Usage: $0 [--datastoreHost <hostname>] [--datastoreUser <username>] [datastorePassword <password>] [datastoreDatabase <name>] [--enableMemoryDatabase]
+//            [--peerId <jsonFilePath>] [--listenMultiaddrs <ma> ... <ma>] [--announceMultiaddrs <ma> ... <ma>] [--metricsPort <port>] [--disableMetrics]
 
 /* eslint-disable no-console */
 
@@ -23,9 +24,17 @@ const PeerId = require('peer-id')
 
 const RendezvousServer = require('./index')
 const Datastore = require('./datastores/mysql')
+const DatastoreMemory = require('./datastores/memory')
 const { getAnnounceAddresses, getListenAddresses } = require('./utils')
 
 async function main () {
+  // Datastore
+  const memoryDatabase = (argv.enableMemoryDatabase || argv.emd || process.env.DISABLE_METRICS)
+  const host = argv.datastoreHost || argv.dh || process.env.DATASTORE_HOST || 'localhost'
+  const user = argv.datastoreUser || argv.du || process.env.DATASTORE_USER || 'root'
+  const password = argv.datastorePassword || argv.dp || process.env.DATASTORE_PASSWORD || 'test-secret-pw'
+  const database = argv.datastoreDatabase || argv.dd || process.env.DATASTORE_DATABASE || 'libp2p_rendezvous_db'
+
   // Metrics
   let metricsServer
   const metrics = !(argv.disableMetrics || process.env.DISABLE_METRICS)
@@ -46,11 +55,11 @@ async function main () {
     log('If you want to keep the same address for the server you should provide a peerId with --peerId <jsonFilePath>')
   }
 
-  const datastore = new Datastore({
-    host: 'localhost',
-    user: 'root',
-    password: 'test-secret-pw',
-    database: 'libp2p_rendezvous_db'
+  const datastore = memoryDatabase ? new DatastoreMemory() : new Datastore({
+    host,
+    user,
+    password,
+    database
   })
 
   // Create Rendezvous server

src/server/datastores/mysql.js

@@ -329,10 +329,8 @@ class Mysql {
           namespace varchar(255),
           reg_id INT UNSIGNED,
           peer_id varchar(255) NOT NULL,
-          created_at datetime DEFAULT CURRENT_TIMESTAMP,
           PRIMARY KEY (id, namespace, reg_id),
-          FOREIGN KEY (reg_id) REFERENCES registration(id) ON DELETE CASCADE,
-          INDEX (created_at)
+          FOREIGN KEY (reg_id) REFERENCES registration(id) ON DELETE CASCADE
         );
       `, (err) => {
         if (err) {

src/server/index.js

@@ -31,17 +31,11 @@ const { fallbackNullish } = require('./utils')
 /**
  * @typedef {import('./datastores/interface').Datastore} Datastore
  * @typedef {import('./datastores/interface').Registration} Registration
- *
- * @typedef {Object} NamespaceRegistration
- * @property {string} id random generated id to map cookies
- * @property {number} expiration
  */
 
 /**
  * @typedef {Object} RendezvousServerOptions
  * @property {Datastore} datastore
- * @property {number} [gcDelay = 3e5] garbage collector delay (default: 5 minutes)
- * @property {number} [gcInterval = 7.2e6] garbage collector interval (default: 2 hours)
  * @property {number} [minTtl = MIN_TTL] minimum acceptable ttl to store a registration
  * @property {number} [maxTtl = MAX_TTL] maxium acceptable ttl to store a registration
  * @property {number} [maxNsLength = MAX_NS_LENGTH] maxium acceptable namespace length