hypercore-fetch 8.3.0 → 8.4.0

package/README.md

@@ -212,6 +212,10 @@ Using the `text/event-stream` content type in the `Accept` header will get back
 
 The `event` will be the name of the extension you got the data for, the `id` (accessible by `e.lastEventId` in EventSource) will be set to the ID of the peer that sent it.
 
+Only extension messages that have been queried before via a `GET` to the EXTENSION_NAME will be visible in this stream.
+
+There are also two special events: `peer-open` which gets emitted whena new peer has connected, and `peer-remove` which gets emitted when an existing peer disconnects.
+
 ### `fetch('hyper://NAME/$/extensions/EXTENSION_NAME', {method: 'POST', body: 'Example'})`
 
 You can broadcast an extension message to all peers that are replicating that extension type with a `POST` to the extension's URL.

package/index.js

@@ -24,6 +24,8 @@ const TAGS_FOLDER = SPECIAL_FOLDER + TAGS_FOLDER_NAME
 const EXTENSIONS_FOLDER_NAME = 'extensions/'
 const EXTENSIONS_FOLDER = SPECIAL_FOLDER + EXTENSIONS_FOLDER_NAME
 const EXTENSION_EVENT = 'extension-message'
+const PEER_OPEN = 'peer-open'
+const PEER_REMOVE = 'peer-remove'
 
 // TODO: Add caching support
 const { resolveURL: DEFAULT_RESOLVE_URL } = require('hyper-dns')
@@ -66,8 +68,13 @@ module.exports = function makeHyperFetch (opts = {}) {
     const allPeers = archive.peers
     return allPeers.filter((peer) => {
       const { remoteExtensions } = peer
+
+      if (!remoteExtensions) return false
+
       const { names } = remoteExtensions
 
+      if (!names) return false
+
       return names.includes(name)
     })
   }
@@ -270,11 +277,27 @@ module.exports = function makeHyperFetch (opts = {}) {
                 function onMessage (name, content, peer) {
                   const id = peer.remotePublicKey.toString('hex')
                   // TODO: Fancy verification on the `name`?
-                  push(`event:${name}\nid:${id}\ndata:${JSON.stringify(content)}\n\n`)
+                  // Send each line of content separately on a `data` line
+                  const data = content.split('\n').map((line) => `data:${line}\n`).join('')
+                  push(`id:${id}\nevent:${name}\n${data}\n`)
+                }
+                function onPeerOpen (peer) {
+                  const id = peer.remotePublicKey.toString('hex')
+                  push(`id:${id}\nevent:${PEER_OPEN}\n\n`)
+                }
+                function onPeerRemove (peer) {
+                  // Whatever, probably an uninitialized peer
+                  if (!peer.remotePublicKey) return
+                  const id = peer.remotePublicKey.toString('hex')
+                  push(`id:${id}\nevent:${PEER_REMOVE}\n\n`)
                 }
                 archive.on(EXTENSION_EVENT, onMessage)
+                archive.on(PEER_OPEN, onPeerOpen)
+                archive.on(PEER_REMOVE, onPeerRemove)
                 return () => {
-                  archive.removeListener('extension-message', onMessage)
+                  archive.removeListener(EXTENSION_EVENT, onMessage)
+                  archive.removeListener(PEER_OPEN, onPeerOpen)
+                  archive.removeListener(PEER_REMOVE, onPeerRemove)
                 }
               })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hypercore-fetch",
-  "version": "8.3.0",
+  "version": "8.4.0",
   "description": "Implementation of Fetch that uses the Dat SDK for loading p2p content",
   "bin": {
     "hypercore-fetch": "bin.js"
@@ -26,8 +26,8 @@
   "dependencies": {
     "event-iterator": "^2.0.0",
     "fetch-headers": "^2.0.0",
-    "hyper-dns": "^0.11.4",
-    "hyper-sdk": "^3.0.8",
+    "hyper-dns": "^0.12.0",
+    "hyper-sdk": "^3.0.9",
     "make-dir": "^3.1.0",
     "make-fetch": "^2.2.1",
     "mime": "^2.4.4",

package/test.js

@@ -248,7 +248,7 @@ async function runTests () {
 
     t.ok(data.value, 'Got eventsource data after writing')
     t.ok(data.value.includes('event:example\n'), 'EventSource data represents an example event')
-    t.ok(data.value.includes('value:Hello World\n'), 'EventSource data contains expected body')
+    t.ok(data.value.includes('data:Hello World\n'), 'EventSource data contains expected body')
     t.ok(data.value.includes('id:'), 'EventSource data contains an ID')
     t.ok(data.value.endsWith('\n\n'), 'Ends with two newlines')