pear-runtime-updater 3.0.8 → 3.0.10

package/README.md

@@ -41,6 +41,7 @@ const updater = new PearRuntimeUpdater({
 
 await updater.ready()
 
+updater.on('update-scheduled', (delay) => console.log('Update will start in', delay))
 updater.on('updating', () => console.log('Update downloading…'))
 updater.on('updated', async () => {
   console.log('Update ready')
@@ -71,6 +72,7 @@ goodbye(async () => {
 - 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)
+- Default random update delay to avoid seeder overload on new releases
 
 ## API
 
@@ -84,6 +86,11 @@ goodbye(async () => {
 - `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`.
 - `opts.updates` – (optional) Set to false to opt out of updates.
+- `opts.delay` – (optional) Upper bound (in ms) for the randomized update mirror delay. Defaults to 3_600_000 (60 minutes).
+
+#### `updater.on('update-scheduled')`
+
+Emitted when a new upgrade drive length is detected and the update has been scheduled with a random delay.
 
 #### `updater.on('updating')`
 

package/index.js

@@ -40,6 +40,12 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
     this.updating = false
     this.updated = false
 
+    this._defaultDelay = 3_600_000 // defaults to 1h
+    this._delay = Math.floor(
+      Math.random() * (Number.isInteger(opts.delay) ? opts.delay : this._defaultDelay)
+    )
+    this._scheduledUpdate = null
+
     this._debouncedUpdate = debounceify(this._update.bind(this))
 
     this.ready().catch(noop)
@@ -56,9 +62,13 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
       })
 
       this._debouncedUpdate().catch((err) => this.emit('error', err))
-      this.drive.core.on('append', () =>
-        this._debouncedUpdate().catch((err) => this.emit('error', err))
-      )
+      this.drive.core.on('append', () => {
+        if (this._scheduledUpdate !== null) clearTimeout(this._scheduledUpdate) // cancel old pending updates before scheduling new one
+        this._scheduledUpdate = setTimeout(() => {
+          this._debouncedUpdate().catch((err) => this.emit('error', err))
+        }, this._delay)
+        this.emit('update-scheduled', this._delay)
+      })
     }
   }
 
@@ -67,6 +77,7 @@ module.exports = class PearRuntimeUpdater extends ReadyResource {
 
     if (!this.updates) return
     if (this.checkout !== null) await this.checkout.close()
+    if (this._scheduledUpdate) clearTimeout(this._scheduledUpdate)
   }
 
   async applyUpdate() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pear-runtime-updater",
-  "version": "3.0.8",
+  "version": "3.0.10",
   "description": "Listens for OTA Pear App updates",
   "license": "Apache-2.0",
   "author": "Holepunch Inc",
@@ -69,5 +69,19 @@
     "prettier": "^3.8.1",
     "prettier-config-holepunch": "^2.0.0",
     "test-tmp": "^1.4.0"
-  }
+  },
+  "directories": {
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/holepunchto/pear-runtime-updater.git"
+  },
+  "keywords": [],
+  "type": "commonjs",
+  "types": "./index.d.ts",
+  "bugs": {
+    "url": "https://github.com/holepunchto/pear-runtime-updater/issues"
+  },
+  "homepage": "https://github.com/holepunchto/pear-runtime-updater#readme"
 }