Added write support for hypercore

RangerMauve · RangerMauve · commit e7b307ae4528 · 2020-07-30T11:26:41.000-04:00
diff --git a/README.md b/README.md
@@ -47,11 +47,11 @@ Download an installer from the [releases page](https://github.com/RangerMauve/ag
 - [x] `hyper://`
 	- Able to read from archives
 	- Able to resolve `dat-dns` domains
+	- Able to write create and modify archives
 - [x] `dat://`
 	- Able to read from archives
 	- Able to resovle `dat-dns` domains
-	- 😢 No `DatArchive` support.
-	- A bunch of websites are probably broken.
+	- No `DatArchive` support.
 - [ ] ipfs
 	- Working on reading from URLs
 
@@ -86,6 +86,53 @@ You can set these to whatever you want and it will override the defaults listed
 
 Check out `app/actions.js` for a full list of action names since some of them don't have keyboard shortcuts by default.
 
+## Fetch API for `hyper://`
+
+### `fetch('hyper://NAME/example.txt', {method: 'GET'})`
+
+This will attempt to load `example.txt` from the archive labeled by `NAME`.
+
+It will also load `index.html` files automatically for a folder.
+You can find the details about how resolution works in the [resolve-dat-path](https://github.com/RangerMauve/resolve-dat-path/blob/master/index.js#L3) module.
+
+`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/index.json', {method: 'GET'})`
+
+The `index.json` file is special in that it will be modified to contain some extra parameters in the JSON content.
+
+This extends from the [Index.json Manifest](https://docs.beakerbrowser.com/developers/index.json-manifest) spec in Beaker.
+
+`url` will get set to the `hyper://` URL of the archive. This will resolve the `NAME` to always be the 64 character hex key.
+
+### `fetch('hyper://NAME/example/', {method: 'GET'})`
+
+When doing a `GET` on a directory, you will get a directory listing.
+
+By default it will render out an HTML page with links to files within that directory.
+
+You can set the `Accept` header to `application/json` in order to have it return a JSON array with file names.
+
+`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: 'PUT', body: 'Hello World'})`
+
+You can add files to archives using a `PUT` method along with a `body`.
+
+The `body` can be either a `String`, an `ArrayBuffer`, a `Blob`, a WHATWG `ReadableStream`, a Node.js `Stream`, or electron's [UploadData](https://www.electronjs.org/docs/api/structures/upload-data) object (make sure to specify the `session` argument in the `makeFetch` function for electron support).
+
+`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.
+
+Your `NAME` will likely be a `name` in most cases to ensure you have a writeable archive.
+
+### `fetch('hyper://NAME/example.txt', {method: 'DELETE'})`
+
+You can delete a file in an archive by using the `DELETE` method.
+
+You cannot delete directories if they are not empty.
+
+`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.
+
 ## Contributing
 
 Feel free to open a Github issue if you wish to tackle one of the items on the roadmap, or message @RangerMauve directly on whatever platform you can find them on.
diff --git a/app/protocols/dat-protocol.js b/app/protocols/dat-protocol.js
@@ -15,10 +15,11 @@ module.exports = async function createHandler () {
   }
   const fetch = datFetch({
     Hyperdrive,
-    resolveName
+    resolveName,
+    // Even though we could make it mutable, lets keep the legacy code immutable
+    writable: false
   })
   return async function protocolHandler ({ url }, sendResponse) {
-    // console.log('Loading', url)
     const response = await fetch(url)
 
     const { status: statusCode, body: data, headers: responseHeaders } = response
diff --git a/app/protocols/hyper-protocol.js b/app/protocols/hyper-protocol.js
@@ -3,13 +3,19 @@ const SDK = require('dat-sdk')
 
 module.exports = async function createHandler () {
   const sdk = await SDK()
-  const fetch = datFetch(sdk)
+  const {Hyperdrive, resovleName} = sdk
+  const fetch = datFetch({Hyperdrive, resovleName, writable: true})
+
   return async function protocolHandler (req, sendResponse) {
-    const { url, headers: requestHeaders, method } = req
+    const { url, headers: requestHeaders, method, uploadData } = req
 
     console.log(req)
 
-    const response = await fetch(url, { headers: requestHeaders, method })
+    const body = uploadData ? (
+      uploadData.length > 1 ? uploadData : uploadData[0]
+    ) : null
+
+    const response = await fetch(url, { headers: requestHeaders, method, body })
 
     const { status: statusCode, body: data, headers: responseHeaders } = response
     const headers = {
diff --git a/app/ui/electron-browser-view.js b/app/ui/electron-browser-view.js
@@ -168,6 +168,10 @@ class BrowserViewElement extends HTMLElement {
     this.addEventListener('focus', () => {
       if (this.view) this.view.webContents.focus()
     })
+
+    window.addEventListener('beforeunload', () => {
+      if(this.view) this.view.destroy()
+    })
   }
 
   connectedCallback () {
diff --git a/package.json b/package.json
@@ -95,7 +95,7 @@
   },
   "dependencies": {
     "@geut/hyperdrive-promise": "^3.0.1",
-    "dat-fetch": "^2.3.0",
+    "dat-fetch": "^3.0.0",
     "dat-sdk": "^2.1.0",
     "dat-sdk-old": "^1.0.0",
     "electron-extensions": "^6.0.4",
diff --git a/yarn.lock b/yarn.lock
@@ -2195,18 +2195,17 @@ dat-encoding@^5.0.1:
   dependencies:
     safe-buffer "^5.0.1"
 
-dat-fetch@^2.3.0:
-  version "2.3.0"
-  resolved "https://registry.yarnpkg.com/dat-fetch/-/dat-fetch-2.3.0.tgz#49ba04e837cc16227b0f12de11ab0ea096a1060d"
-  integrity sha512-SKn2r6Jbg5fQ5E6Go70vrunvFV0yLBZro4pl/0/nKb8hF1fsI4NrICX2BW1Dsqnx3BAwNEf+tBUccmFbqVIVSQ==
+dat-fetch@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/dat-fetch/-/dat-fetch-3.0.0.tgz#ce257aaf60c0590bba36c084c83834f5fa1d65ec"
+  integrity sha512-qyT5B6YFAlN8LH7RH1Z/1nCdWgOLwwmUavo3GJp/9eYaJWcw3uexnpg13OflVkZkvnzkFek/NY0pPOe39aRGlA==
   dependencies:
     concat-stream "^2.0.0"
-    dat-node "^3.5.15"
-    dat-sdk "^2.0.0"
     end-of-stream-promise "^1.0.0"
     fetch-headers "^2.0.0"
+    fetch-request-body-to-stream "^1.0.0"
     mime "^2.4.4"
-    node-fetch "^2.6.0"
+    pump-promise "^1.0.0"
     range-parser "^1.2.1"
     resolve-dat-path "^1.2.0"
 
@@ -2227,7 +2226,7 @@ dat-link-resolve@^2.3.0:
     debug "^4.1.1"
     simple-get "^3.0.3"
 
-dat-node@^3.5.15, dat-node@^3.5.3:
+dat-node@^3.5.3:
   version "3.5.15"
   resolved "https://registry.yarnpkg.com/dat-node/-/dat-node-3.5.15.tgz#8dd07ef353003ab1b2214487ffce486bd286cc0e"
   integrity sha512-hL7JlZr17x25t+RHJN5saBEOn/fZFt6d8FyS2p+XxnVIQug9bGjnbAXdWbRVO9UJLfnZyKfB23wjvHND1015+g==
@@ -2280,7 +2279,7 @@ dat-sdk@^1.0.3:
     universal-prompt "^1.0.0"
     url-parse "^1.4.7"
 
-dat-sdk@^2.0.0, dat-sdk@^2.1.0:
+dat-sdk@^2.1.0:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/dat-sdk/-/dat-sdk-2.1.0.tgz#23af231f02b5f9d09f74d32977d14dec74326e2c"
   integrity sha512-AZDKfCjSQu2Exb3J1P4MK2zg+zordeMbOmSCexKdMpKnOafin/nAbHoPQ/74JKi+PXKs4f66+mEmcoqAYla0sw==
@@ -3604,6 +3603,11 @@ fetch-headers@^2.0.0:
   resolved "https://registry.yarnpkg.com/fetch-headers/-/fetch-headers-2.0.0.tgz#bab7531c39b3d72d21ac189f179756f08541cf55"
   integrity sha1-urdTHDmz1y0hrBifF5dW8IVBz1U=
 
+fetch-request-body-to-stream@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/fetch-request-body-to-stream/-/fetch-request-body-to-stream-1.0.0.tgz#9c65db075d909c9dec20d6f2cc041d61a795896b"
+  integrity sha512-CuB3VWmpgb5nRS4K6OJ7ybQJBUM79G6Q6cm3kj+U/UvPV3Jxl6gupdpIF9r3YfLe05BEFKnT0MtOhjGYNTZ3Nw==
+
 figures@^3.0.0:
   version "3.2.0"
   resolved "https://registry.yarnpkg.com/figures/-/figures-3.2.0.tgz#625c18bd293c604dc4a8ddb2febf0c88341746af"
@@ -8386,7 +8390,14 @@ public-encrypt@^4.0.0:
     randombytes "^2.0.1"
     safe-buffer "^5.1.2"
 
-pump@^1.0.2, pump@^1.0.3:
+pump-promise@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/pump-promise/-/pump-promise-1.0.0.tgz#1a10f3fcb9382fbdcddb21b3b52d5340a5f1f9f7"
+  integrity sha1-GhDz/Lk4L73N2yGztS1TQKXx+fc=
+  dependencies:
+    pump "^1.0.1"
+
+pump@^1.0.1, pump@^1.0.2, pump@^1.0.3:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/pump/-/pump-1.0.3.tgz#5dfe8311c33bbf6fc18261f9f34702c47c08a954"
   integrity sha512-8k0JupWme55+9tCVE+FS5ULT3K6AbgqrGa58lTT49RpyfwwcGedHqaC5LlQNdEAumn/wFsu6aPwkuPMioy8kqw==
