pear-runtime-updater 2.0.2 → 3.0.0

package/README.md

@@ -14,11 +14,18 @@ This boilerplate is MVP and Experimental.
 
 ## Usage
 
+Example in node.js:
+
 ```js
 const PearRuntimeUpdater = require('pear-runtime-updater')
 const path = require('path')
+const Corestore = require('corestore')
+const Hyperswarm = require('hyperswarm')
+const goodbye = require('graceful-goodbye')
 const { version, upgrade } = require('./package.json')
 
+const store = new Corestore('./my-app/corestore')
+
 function getApp() {
   return path.join(process.resourcesPath, '../..')
 }
@@ -27,8 +34,9 @@ const updater = new PearRuntimeUpdater({
   dir: path.join(app.getPath('userData')),
   upgrade,
   version,
-  app: getApp() // path to .app / .AppImage
-  name: 'name.ext' // <name>.app, <name>.AppImage, <name>.msix
+  app: getApp(), // path to .app / .AppImage
+  name: 'name.ext', // <name>.app, <name>.AppImage, <name>.msix
+  store
 })
 
 await updater.ready()
@@ -41,13 +49,26 @@ updater.on('updated', async () => {
   app.exit(0)
 })
 
-process.on('beforeExit', () => updater.close())
+const keyPair = await store.createKeyPair('pear-runtime')
+const swarm = new Hyperswarm({ keyPair })
+swarm.on('connection', (connection) => store.replicate(connection))
+swarm.join(updater.drive.core.discoveryKey, {
+  client: true,
+  server: false
+})
+
+// handle teardown
+goodbye(async () => {
+  await swarm.destroy()
+  await updater.close()
+  await store.close()
+})
 ```
 
 ## Features
 
 - Peer-to-peer over-the-air (P2P OTA) update listening
-- Replicates update content via [Hyperdrive](https://github.com/holepunchto/hyperdrive) / [Hyperswarm](https://github.com/holepunchto/hyperswarm)
+- Appends update content via [Hyperdrive](https://github.com/holepunchto/hyperdrive)
 - Emits when an update is in progress, update diffs and when it’s ready
 - `applyUpdate()` to atomic swap the new build (bundled apps; macOS/Linux)
 
@@ -58,6 +79,7 @@ process.on('beforeExit', () => updater.close())
 - `opts.dir` – (required) Directory to store data (e.g. app data dir).
 - `opts.upgrade` – (required) Pear upgrade link (e.g. from `package.json` `upgrade` field).
 - `opts.name` – (required) Application name with extension.
+- `opts.store` - (required) Pass a [Corestore](https://github.com/holepunchto/corestore) to be used for updates.
 - `opts.version` – (optional) Current app version; used to decide if an update should be stored.
 - `opts.app` – (optional) Path to the app bundle (for bundled apps; used with `applyUpdate()`).
 - `opts.bundled` – (optional) Whether the app is bundled. Defaults to `!!opts.app`.

package/index.js

@@ -1,7 +1,5 @@
-const Hyperswarm = require('hyperswarm')
 const Hyperdrive = require('hyperdrive')
 const Localdrive = require('localdrive')
-const Corestore = require('corestore')
 const path = require('path')
 const fs = require('fs')
 const fsx = require('fs-native-extensions')
@@ -18,12 +16,13 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
     if (!opts.dir) throw new Error('dir required')
     if (!opts.upgrade) throw new Error('upgrade link required')
     if (!opts.name) throw new Error('name required')
+    if (!opts.store) throw new Error('store required')
 
     this.dir = opts.dir
+    this.store = opts.store
     this.version = opts.version || 0
     this.app = opts.app
     this.name = opts.name
-    this.bootstrap = opts.bootstrap
     this.bundled = opts.bundled || !!this.app
     this.win32RestartAfterUpdate = opts.win32 && opts.win32.restart
 
@@ -33,7 +32,6 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
       this.length = upgrade.length || 0
       this.fork = upgrade.fork || 0
       this.link = link.serialize({ drive: { fork: this.fork, length: this.length, key: this.key } })
-      this.store = new Corestore(path.join(this.dir, 'pear-runtime/corestore'))
       this.drive = new Hyperdrive(this.store, this.key)
     } else {
       this.key = null
@@ -44,7 +42,6 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
       this.drive = null
     }
 
-    this.swarm = null
     this.next = null
     this.checkout = null
     this.updating = false
@@ -63,17 +60,6 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
         force: true
       })
 
-      if (!this.swarm) {
-        const keyPair = await this.store.createKeyPair('pear-container')
-        this.swarm = new Hyperswarm({ keyPair, bootstrap: this.bootstrap })
-      }
-
-      this.swarm.on('connection', (connection) => this.store.replicate(connection))
-      this.swarm.join(this.drive.core.discoveryKey, {
-        client: true,
-        server: false
-      })
-
       this._updateBackground()
       this.drive.core.on('append', () => this._updateBackground())
     }
@@ -84,8 +70,6 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
 
     await this.drive.close()
     if (this.checkout !== null) await this.checkout.close()
-    await this.store.close()
-    if (this.swarm) await this.swarm.destroy()
   }
 
   async applyUpdate() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pear-runtime-updater",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "Listens for OTA Pear App updates",
   "license": "Apache-2.0",
   "author": "Holepunch Inc",
@@ -45,11 +45,9 @@
   "dependencies": {
     "bare-fs": "^4.5.3",
     "bare-path": "^3.0.0",
-    "corestore": "^7.8.0",
     "fs-native-extensions": "^1.4.5",
     "hypercore-id-encoding": "^1.3.0",
     "hyperdrive": "^13.2.1",
-    "hyperswarm": "^4.16.0",
     "localdrive": "^2.2.0",
     "msix-manager": "^0.2.1",
     "pear-link": "^4.2.1",
@@ -62,6 +60,8 @@
     "bare-os": "^3.7.0",
     "bare-subprocess": "^5.2.2",
     "brittle": "^3.19.1",
+    "corestore": "^7.9.1",
+    "hyperswarm": "^4.17.0",
     "lunte": "^1.6.0",
     "pear-build": "^0.2.0",
     "prettier": "^3.8.1",