Merge branch 'master' into dpaez/drive-import-export

Author: dpaez

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected Behavior**
+What did you expect to happen?
+
+** OS **
+
+** Node version **
+
+** Was the daemon installed from NPM or bundled with Beaker? **
+
+Add any other context about the problem here.
+
+__Important Note__: Daemon errors are likely to be found in `~/.hyperdrive/log.json` or `~/.hyperdrive/output.log` (the latter is for unexpected, non-JSON output). These files might contain sensitive drive keys, so don't upload the whole thing -- just extract any stack traces or odd error messages!

README.md

@@ -25,7 +25,9 @@ The client exposes a gRPC interface for a) creating and interacting with remote
 Check out the [daemon tests](https://github.com/andrewosh/hyperdrive-daemon/blob/hyperdrive-api/test/hyperdrive.js) for more example usage.
 
 ### Hyperdrive
-The client's Hyperdrive API is designed to mirror the methods in Hyperdrive as closely as possible. 
+The client's Hyperdrive API is designed to mirror the methods in Hyperdrive as closely as possible.
+
+All drive commands can be found through the `client.drives` object.
 
 #### General Operations
 Operations to manage sessions or get more general information about the state of the daemon.
@@ -101,7 +103,9 @@ Method arguments take the same form as those in Hyperdrive. The following method
 20. `drive.checkout(version)` // Returns a new `RemoteHyperdrive` instance for the checkout.
 
 ### FUSE
-The client library also provides programmatic access to the daemon's FUSE interface. You can mount/unmount your root drive, or mount and share subdrives:
+The client library also provides programmatic access to the daemon's FUSE interface.
+
+All FUSE commands can be found on the `client.fuse` object.
 
 ##### `client.fuse.mount(mnt, opts, cb)`
 Mount either the root drive (if `/mnt` is not specified), or a subdirectory within the root drive.
@@ -112,10 +116,66 @@ Mount either the root drive (if `/mnt` is not specified), or a subdirectory with
 Unmounts either a subdrive, or the root drive if `mnt` is not specified.
 
 ##### `client.fuse.publish(path, cb)`
-Advertise the drive mounted at `path` to the network.
+Advertise the drive mounted at `path` to the swarm.
 
 ##### `client.fuse.unpublish(path, cb)`
-Stop advertisingthe drive mounted at `path` to the network.
+Stop advertising the drive mounted at `path` to the swarm.
+
+### Peersockets
+`client.peersockets` lets your directly exchange messages with connected peers. You can discover all peers swarming a given discovery key using the peers API (`client.peers`) described below.
+
+Peers are all identified by aliases in order to reduce bandwidth consumtion, as the alternative is to attach NOISE keys to every message. Aliases can be mapped to/from NOISE keys through the `client.peers` API.
+
+##### `const topicHandle = client.peersockets.join(topicName, { onmessage })`
+- `topicName`: A String
+- `onmessage`: A function of the form `(alias, msg) => { ... }`
+Create a TopicHandle for sending/receiving messages on topic `topicName`.
+
+##### `topicHandle.send(alias, msg)`
+- `alias`: A numeric peer alias
+- `msg`: A Buffer
+
+Attempt to send a message on the handle's topic to the given peer. 
+
+This message will be delivered with best-effort, but if the remote peer is not subscribed to the topic the message will silently be discarded.
+
+##### `topicHandle.on('close', ...)`
+Emitted when the topic stream has closed.
+
+You can check out the internals in the [peersockets repo](https://github.com/andrewosh/peersockets).
+
+### Peers
+`client.peers` allows you to get information about currently-connected peers.
+
+##### `const peerList = await client.peers.listPeers([discoveryKey])`
+- `discoveryKey`: A Buffer
+
+Get the list of connected peers either globally or swarming a specific discovery key.
+
+`peerList` has the form:
+```js
+[
+  {
+    noiseKey: 0x123...
+    address: '10.21...`,
+    type: 'utp'|'tcp'
+  },
+  ...
+]
+```
+
+##### `const destroy = client.peers.watchPeers([discoveryKey], { onjoin, onleave })`
+- `discoveryKey`: A Buffer
+
+Watch for peers joining or leaving either globally or for a specific discovery key.
+
+`onjoin` and `onleave` both take a single `peer` argument with `{ noiseKey, address, type }` fields.
+
+##### `const alias = await client.peers.getAlias(key)`
+Gets or creates a numeric alias for the given NOISE `key`.
+
+##### `const key = await client.peers.getKey(alias)`
+Returns the NOISE `key` for a previously-assigned `alias`.
 
 ## License
 MIT

bin/commands/import.js

@@ -43,6 +43,7 @@ class ImportCommand extends DaemonCommand {
 
     if (!key) key = await loadKeyFromFile()
     const drive = await this.client.drive.get({ key })
+    await drive.configureNetwork({ lookup: true, announce: true, remember: true })
     if (!drive.writable) {
       console.error('The target drive is not writable!')
       return process.exit(1)

lib/clients/drive.js

@@ -506,7 +506,14 @@ class RemoteHyperdrive {
 
     return maybe(cb, new Promise((resolve, reject) => {
       this._client.mkdir(req, toMetadata({ token: this.token }), (err, rsp) => {
-        if (err) return reject(err)
+        if (err) {
+          // TODO: Found this bug late, and it hightlights the need for more structured errors from gRPC.
+          // This is the most straightforward way to fix the import command, but the API should be updated to handle this.
+          if (err.details && err.details.indexOf('Path already')) {
+            err.code = 'EEXIST'
+          }
+          return reject(err)
+        }
         return resolve()
       })
     }))

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hyperdrive-daemon-client",
-  "version": "1.14.1",
+  "version": "1.14.7",
   "description": "A client library and CLI tool for interacting with the Hyperdrive daemon.",
   "main": "index.js",
   "bin": {
@@ -35,28 +35,28 @@
     "@grpc/grpc-js": "^0.5.1",
     "@oclif/command": "^1.5.19",
     "@oclif/config": "^1.14.0",
+    "@oclif/errors": "^1.2.2",
     "@oclif/plugin-autocomplete": "^0.1.5",
     "@oclif/plugin-help": "^2.2.3",
     "call-me-maybe": "^1.0.1",
     "cli-progress": "^3.4.0",
     "codecs": "^2.0.0",
     "dat-encoding": "^5.0.1",
-    "fs-extended-attributes": "^1.0.1",
-    "fs-extra": "^8.0.1",
     "globby": "^11.0.0",
     "google-protobuf": "^3.8.0",
-    "hyperdrive-schemas": "beta",
+    "hyperdrive-schemas": "^1.9.0",
     "last-one-wins": "^1.0.4",
     "mirror-folder": "^3.0.1",
     "ora": "^4.0.3",
+    "protocol-buffers-encodings": "^1.1.0",
+    "pump": "^3.0.0",
     "pumpify": "^2.0.0",
     "stream-collector": "^1.0.1",
     "streamx": "^2.6.0",
     "through2-map": "^3.0.0"
   },
   "devDependencies": {
-    "grpc-tools": "^1.7.3",
-    "protocol-buffers-encodings": "^1.1.0"
+    "grpc-tools": "^1.7.3"
   },
   "oclif": {
     "commands": "./bin/commands",