hypercore-fetch 8.4.0 → 8.6.1

package/.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Testing
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    continue-on-error: true
+    strategy:
+      matrix:
+        node: [ '16' ]
+        os: [ubuntu-latest, windows-latest, macOS-latest]
+    runs-on: ${{ matrix.os }}
+    name: Node ${{ matrix.node }}-${{matrix.os}} tests
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+      - run: npm install
+      - run: npm run lint
+      - run: npm test

package/README.md

@@ -130,6 +130,15 @@ The `body` can be either a `String`, an `ArrayBuffer`, a `Blob`, a WHATWG `Reada
 
 Your `NAME` will likely be a `name` in most cases to ensure you have a writeable archive.
 
+### `fetch('hyper://NAME/folder/', {method: 'PUT', body: new FormData()})`
+
+You can add multiple files to a folder using the `PUT` method with a [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData) body.
+
+You can [append](https://developer.mozilla.org/en-US/docs/Web/API/FormData) to a FormData with `formData.append(fieldname, content, 'filename.txt')` where `fieldname` gets ignored (use something like `file`?) the `content` can either be a String, Blob, or some sort of stream.
+The `filename` will be the filename within the directory that gets created.
+
+`NAME` can either be the 64 character hex key for an archive, a domain to parse with [dat-dns](https://www.npmjs.com/package/dat-dns), or a name for an archive which allows you to write to it.
+
 ### `fetch('hyper://NAME/example.txt', {method: 'DELETE'})`
 
 You can delete a file in an archive by using the `DELETE` method.

package/index.js

@@ -7,6 +7,8 @@ const makeDir = require('make-dir')
 const { Readable } = require('streamx')
 const makeFetch = require('make-fetch')
 const { EventIterator } = require('event-iterator')
+const Busboy = require('busboy')
+const posixPath = require('path').posix
 
 const DEFAULT_TIMEOUT = 5000
 
@@ -380,9 +382,56 @@ module.exports = function makeHyperFetch (opts = {}) {
 
       if (method === 'PUT') {
         checkWritable(archive)
+        const contentType = headers.get('Content-Type') || headers.get('content-type')
+        const isFormData = contentType && contentType.includes('multipart/form-data')
+
         if (path.endsWith('/')) {
           await makeDir(path, { fs: archive })
+          const busboy = new Busboy({ headers: rawHeaders })
+
+          const toUpload = new EventIterator(({ push, stop, fail }) => {
+            busboy.once('error', fail)
+            busboy.once('finish', stop)
+
+            busboy.on('file', async (fieldName, fileData, fileName) => {
+              const finalPath = posixPath.join(path, fileName)
+
+              const source = Readable.from(fileData)
+              const destination = archive.createWriteStream(finalPath)
+
+              source.pipe(destination)
+              try {
+                Promise.race([
+                  once(source, 'error').then((e) => { throw e }),
+                  once(destination, 'error').then((e) => { throw e }),
+                  once(source, 'end')
+                ])
+              } catch (e) {
+                fail(e)
+              }
+            })
+
+            // TODO: Does busboy need to be GC'd?
+            return () => {}
+          })
+
+          Readable.from(body).pipe(busboy)
+
+          await Promise.all(await collect(toUpload))
+
+          return {
+            statusCode: 200,
+            headers: responseHeaders,
+            data: intoAsyncIterable(canonical)
+          }
         } else {
+          if (isFormData) {
+            return {
+              statusCode: 400,
+              headers: responseHeaders,
+              data: intoAsyncIterable('FormData only supported for folders (ending with a /)')
+            }
+          }
           const parentDir = path.split('/').slice(0, -1).join('/')
           if (parentDir) {
             await makeDir(parentDir, { fs: archive })
@@ -405,7 +454,7 @@ module.exports = function makeHyperFetch (opts = {}) {
         return {
           statusCode: 200,
           headers: responseHeaders,
-          data: intoAsyncIterable('')
+          data: intoAsyncIterable(canonical)
         }
       } else if (method === 'DELETE') {
         if (headers.get('x-clear') === 'cache') {

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "hypercore-fetch",
-  "version": "8.4.0",
+  "version": "8.6.1",
   "description": "Implementation of Fetch that uses the Dat SDK for loading p2p content",
   "bin": {
     "hypercore-fetch": "bin.js"
   },
   "main": "index.js",
   "scripts": {
-    "test": "node test"
+    "test": "node test",
+    "lint": "standard --fix"
   },
   "repository": {
     "type": "git",
@@ -24,12 +25,13 @@
   },
   "homepage": "https://github.com/RangerMauve/hypercore-fetch#readme",
   "dependencies": {
+    "busboy": "^0.3.1",
     "event-iterator": "^2.0.0",
     "fetch-headers": "^2.0.0",
     "hyper-dns": "^0.12.0",
     "hyper-sdk": "^3.0.9",
     "make-dir": "^3.1.0",
-    "make-fetch": "^2.2.1",
+    "make-fetch": "^2.3.3",
     "mime": "^2.4.4",
     "range-parser": "^1.2.1",
     "resolve-dat-path": "^2.0.0",
@@ -37,7 +39,9 @@
     "streamx": "^2.10.0"
   },
   "devDependencies": {
+    "form-data": "^4.0.0",
     "random-access-memory": "^3.1.1",
+    "standard": "^17.0.0",
     "tape": "^5.2.2"
   }
 }

package/test.js

@@ -1,5 +1,6 @@
 const SDK = require('hyper-sdk')
 const test = require('tape')
+const FormData = require('form-data')
 
 runTests()
 
@@ -84,10 +85,30 @@ async function runTests () {
     t.equal(await response2.text(), SAMPLE_CONTENT, 'Read back written data')
   })
 
-  test('PUT directory', async (t) => {
-    const response1 = await fetch('hyper://example/foo/bar/', { method: 'PUT' })
+  test('PUT FormData to directory', async (t) => {
+    const form = new FormData()
 
-    t.equal(response1.status, 200, 'Got OK response on directory creation')
+    form.append('file', SAMPLE_CONTENT, {
+      filename: 'example.txt'
+    })
+    const body = form.getBuffer()
+    const headers = form.getHeaders()
+
+    const response1 = await fetch('hyper://example/foo/bar/', {
+      method: 'PUT',
+      headers,
+      body
+    })
+
+    t.equal(response1.status, 200, 'Got OK response on directory upload')
+
+    console.log(await response1.text())
+
+    const response2 = await fetch('hyper://example/foo/bar/example.txt')
+
+    t.equal(response2.status, 200, 'Got OK response on read')
+
+    t.equal(await response2.text(), SAMPLE_CONTENT, 'Read back written data')
   })
 
   test('PUT file in new directory', async (t) => {