Merge branch 'master' into playback-priority

# Conflicts:
#	src/renderer/controllers/playback-controller.js
#	src/renderer/controllers/torrent-list-controller.js
#	src/renderer/main.js

src/renderer/lib/capture-video-frame.js

@@ -1,30 +0,0 @@
-module.exports = captureVideoFrame
-
-function captureVideoFrame (video, format) {
-  if (typeof video === 'string') {
-    video = document.querySelector(video)
-  }
-
-  if (video == null || video.nodeName !== 'VIDEO') {
-    throw new Error('First argument must be a <video> element or selector')
-  }
-
-  if (format == null) {
-    format = 'png'
-  }
-
-  if (format !== 'png' && format !== 'jpg' && format !== 'webp') {
-    throw new Error('Second argument must be one of "png", "jpg", or "webp"')
-  }
-
-  var canvas = document.createElement('canvas')
-  canvas.width = video.videoWidth
-  canvas.height = video.videoHeight
-
-  canvas.getContext('2d').drawImage(video, 0, 0)
-
-  var dataUri = canvas.toDataURL('image/' + format)
-  var data = dataUri.split(',')[1]
-
-  return new Buffer(data, 'base64')
-}

src/renderer/lib/cast.js

@@ -13,25 +13,35 @@ module.exports = {
   setRate
 }
 
-// Lazy load these for a ~300ms improvement in startup time
-var airplayer, chromecasts, dlnacasts
+const config = require('../../config')
+const {CastingError} = require('./errors')
 
-var config = require('../../config')
+// Lazy load these for a ~300ms improvement in startup time
+let airplayer, chromecasts, dlnacasts
 
 // App state. Cast modifies state.playing and state.errors in response to events
-var state
+let state
 
 // Callback to notify module users when state has changed
-var update
+let update
 
 // setInterval() for updating cast status
-var statusInterval = null
+let statusInterval = null
 
 // Start looking for cast devices on the local network
 function init (appState, callback) {
   state = appState
   update = callback
 
+  // Don't actually cast during integration tests
+  // (Otherwise you'd need a physical Chromecast + AppleTV + DLNA TV to run them.)
+  if (config.IS_TEST) {
+    state.devices.chromecast = testPlayer('chromecast')
+    state.devices.airplay = testPlayer('airplay')
+    state.devices.dlna = testPlayer('dlna')
+    return
+  }
+
   // Load modules, scan the network for devices
   airplayer = require('airplayer')()
   chromecasts = require('chromecasts')()
@@ -57,9 +67,35 @@ function init (appState, callback) {
   })
 }
 
+// integration test player implementation
+function testPlayer (type) {
+  return {
+    getDevices,
+    open,
+    play,
+    pause,
+    stop,
+    status,
+    seek,
+    volume
+  }
+
+  function getDevices () {
+    return [{name: type + '-1'}, {name: type + '-2'}]
+  }
+
+  function open () {}
+  function play () {}
+  function pause () {}
+  function stop () {}
+  function status () {}
+  function seek () {}
+  function volume () {}
+}
+
 // chromecast player implementation
 function chromecastPlayer () {
-  var ret = {
+  const ret = {
     device: null,
     addDevice,
     getDevices,
@@ -95,8 +131,8 @@ function chromecastPlayer () {
   }
 
   function open () {
-    var torrentSummary = state.saved.torrents.find((x) => x.infoHash === state.playing.infoHash)
-    ret.device.play(state.server.networkURL, {
+    const torrentSummary = state.saved.torrents.find((x) => x.infoHash === state.playing.infoHash)
+    ret.device.play(state.server.networkURL + '/' + state.playing.fileIndex, {
       type: 'video/mp4',
       title: config.APP_NAME + ' - ' + torrentSummary.name
     }, function (err) {
@@ -126,13 +162,7 @@ function chromecastPlayer () {
   }
 
   function status () {
-    ret.device.status(function (err, status) {
-      if (err) return console.log('error getting %s status: %o', state.playing.location, err)
-      state.playing.isPaused = status.playerState === 'PAUSED'
-      state.playing.currentTime = status.currentTime
-      state.playing.volume = status.volume.muted ? 0 : status.volume.level
-      update()
-    })
+    ret.device.status(handleStatus)
   }
 
   function seek (time, callback) {
@@ -146,7 +176,7 @@ function chromecastPlayer () {
 
 // airplay player implementation
 function airplayPlayer () {
-  var ret = {
+  const ret = {
     device: null,
     addDevice,
     getDevices,
@@ -183,7 +213,7 @@ function airplayPlayer () {
   }
 
   function open () {
-    ret.device.play(state.server.networkURL, function (err, res) {
+    ret.device.play(state.server.networkURL + '/' + state.playing.fileIndex, function (err, res) {
       if (err) {
         state.playing.location = 'local'
         state.errors.push({
@@ -238,7 +268,7 @@ function airplayPlayer () {
 
 // DLNA player implementation
 function dlnaPlayer (player) {
-  var ret = {
+  const ret = {
     device: null,
     addDevice,
     getDevices,
@@ -274,8 +304,8 @@ function dlnaPlayer (player) {
   }
 
   function open () {
-    var torrentSummary = state.saved.torrents.find((x) => x.infoHash === state.playing.infoHash)
-    ret.device.play(state.server.networkURL, {
+    const torrentSummary = state.saved.torrents.find((x) => x.infoHash === state.playing.infoHash)
+    ret.device.play(state.server.networkURL + '/' + state.playing.fileIndex, {
       type: 'video/mp4',
       title: config.APP_NAME + ' - ' + torrentSummary.name,
       seek: state.playing.currentTime > 10 ? state.playing.currentTime : 0
@@ -306,13 +336,7 @@ function dlnaPlayer (player) {
   }
 
   function status () {
-    ret.device.status(function (err, status) {
-      if (err) return console.log('error getting %s status: %o', state.playing.location, err)
-      state.playing.isPaused = status.playerState === 'PAUSED'
-      state.playing.currentTime = status.currentTime
-      state.playing.volume = status.volume.level
-      update()
-    })
+    ret.device.status(handleStatus)
   }
 
   function seek (time, callback) {
@@ -328,10 +352,22 @@ function dlnaPlayer (player) {
   }
 }
 
+function handleStatus (err, status) {
+  if (err || !status) {
+    return console.log('error getting %s status: %o',
+      state.playing.location,
+      err || 'missing response')
+  }
+  state.playing.isPaused = status.playerState === 'PAUSED'
+  state.playing.currentTime = status.currentTime
+  state.playing.volume = status.volume.muted ? 0 : status.volume.level
+  update()
+}
+
 // Start polling cast device state, whenever we're connected
 function startStatusInterval () {
   statusInterval = setInterval(function () {
-    var player = getPlayer()
+    const player = getPlayer()
     if (player) player.status()
   }, 1000)
 }
@@ -350,23 +386,27 @@ function toggleMenu (location) {
 
   // Never cast to two devices at the same time
   if (state.playing.location !== 'local') {
-    throw new Error('You can\'t connect to ' + location + ' when already connected to another device')
+    throw new CastingError(
+      `You can't connect to ${location} when already connected to another device`
+    )
   }
 
   // Find all cast devices of the given type
-  var player = getPlayer(location)
-  var devices = player ? player.getDevices() : []
-  if (devices.length === 0) throw new Error('No ' + location + ' devices available')
+  const player = getPlayer(location)
+  const devices = player ? player.getDevices() : []
+  if (devices.length === 0) {
+    throw new CastingError(`No ${location} devices available`)
+  }
 
   // Show a menu
   state.devices.castMenu = {location, devices}
 }
 
 function selectDevice (index) {
-  var {location, devices} = state.devices.castMenu
+  const {location, devices} = state.devices.castMenu
 
   // Start casting
-  var player = getPlayer(location)
+  const player = getPlayer(location)
   player.device = devices[index]
   player.open()
 
@@ -382,7 +422,7 @@ function selectDevice (index) {
 
 // Stops casting, move video back to local screen
 function stop () {
-  var player = getPlayer()
+  const player = getPlayer()
   if (player) {
     player.stop(function () {
       player.device = null
@@ -417,18 +457,18 @@ function getPlayer (location) {
 }
 
 function play () {
-  var player = getPlayer()
+  const player = getPlayer()
   if (player) player.play(castCallback)
 }
 
 function pause () {
-  var player = getPlayer()
+  const player = getPlayer()
   if (player) player.pause(castCallback)
 }
 
 function setRate (rate) {
-  var player
-  var result = true
+  let player
+  let result = true
   if (state.playing.location === 'chromecast') {
     // TODO find how to control playback rate on chromecast
     castCallback()
@@ -443,12 +483,12 @@ function setRate (rate) {
 }
 
 function seek (time) {
-  var player = getPlayer()
+  const player = getPlayer()
   if (player) player.seek(time, castCallback)
 }
 
 function setVolume (volume) {
-  var player = getPlayer()
+  const player = getPlayer()
   if (player) player.volume(volume, castCallback)
 }
 

src/renderer/lib/dispatcher.js

@@ -4,8 +4,8 @@ module.exports = {
   setDispatch
 }
 
-var dispatchers = {}
-var _dispatch = function () {}
+const dispatchers = {}
+let _dispatch = function () {}
 
 function setDispatch (dispatch) {
   _dispatch = dispatch
@@ -20,8 +20,8 @@ function dispatch (...args) {
 // function. This prevents React from updating the listener functions on
 // each update().
 function dispatcher (...args) {
-  var str = JSON.stringify(args)
-  var handler = dispatchers[str]
+  const str = JSON.stringify(args)
+  let handler = dispatchers[str]
   if (!handler) {
     handler = dispatchers[str] = function (e) {
       // Do not propagate click to elements below the button

src/renderer/lib/errors.js

@@ -1,8 +1,41 @@
-module.exports = {
-  UnplayableError
+const ExtendableError = require('es6-error')
+
+/* Generic errors */
+
+class CastingError extends ExtendableError {}
+class PlaybackError extends ExtendableError {}
+class SoundError extends ExtendableError {}
+class TorrentError extends ExtendableError {}
+
+/* Playback */
+
+class UnplayableTorrentError extends PlaybackError {
+  constructor () { super('Can\'t play any files in torrent') }
 }
 
-function UnplayableError () {
-  this.message = 'Can\'t play any files in torrent'
+class UnplayableFileError extends PlaybackError {
+  constructor () { super('Can\'t play that file') }
+}
+
+/* Sound */
+
+class InvalidSoundNameError extends SoundError {
+  constructor (name) { super(`Invalid sound name: ${name}`) }
+}
+
+/* Torrent */
+
+class TorrentKeyNotFoundError extends TorrentError {
+  constructor (torrentKey) { super(`Can't resolve torrent key ${torrentKey}`) }
+}
+
+module.exports = {
+  CastingError,
+  PlaybackError,
+  SoundError,
+  TorrentError,
+  UnplayableTorrentError,
+  UnplayableFileError,
+  InvalidSoundNameError,
+  TorrentKeyNotFoundError
 }
-UnplayableError.prototype = Error

src/renderer/lib/migrations.js

@@ -4,10 +4,11 @@ module.exports = {
   run
 }
 
-const semver = require('semver')
-const config = require('../../config')
-const TorrentSummary = require('./torrent-summary')
 const fs = require('fs')
+const path = require('path')
+const semver = require('semver')
+
+const config = require('../../config')
 
 // Change `state.saved` (which will be saved back to config.json on exit) as
 // needed, for example to deal with config.json format changes across versions
@@ -17,34 +18,27 @@ function run (state) {
     state.saved.version = '0.0.0' // Pre-0.7.0 version, so run all migrations
   }
 
-  var version = state.saved.version
+  const version = state.saved.version
+  const saved = state.saved
 
-  if (semver.lt(version, '0.7.0')) {
-    migrate_0_7_0(state.saved)
-  }
-
-  if (semver.lt(version, '0.7.2')) {
-    migrate_0_7_2(state.saved)
-  }
-
-  if (semver.lt(version, '0.11.0')) {
-    migrate_0_11_0(state.saved)
-  }
-
-  if (semver.lt(version, '0.12.0')) {
-    migrate_0_12_0(state.saved)
-  }
+  if (semver.lt(version, '0.7.0')) migrate_0_7_0(saved)
+  if (semver.lt(version, '0.7.2')) migrate_0_7_2(saved)
+  if (semver.lt(version, '0.11.0')) migrate_0_11_0(saved)
+  if (semver.lt(version, '0.12.0')) migrate_0_12_0(saved)
+  if (semver.lt(version, '0.14.0')) migrate_0_14_0(saved)
+  if (semver.lt(version, '0.17.0')) migrate_0_17_0(saved)
+  if (semver.lt(version, '0.17.2')) migrate_0_17_2(saved)
 
   // Config is now on the new version
   state.saved.version = config.APP_VERSION
 }
 
 function migrate_0_7_0 (saved) {
-  var fs = require('fs-extra')
-  var path = require('path')
+  const cpFile = require('cp-file')
+  const path = require('path')
 
   saved.torrents.forEach(function (ts) {
-    var infoHash = ts.infoHash
+    const infoHash = ts.infoHash
 
     // Replace torrentPath with torrentFileName
     // There are a number of cases to handle here:
@@ -52,7 +46,7 @@ function migrate_0_7_0 (saved) {
     // * Then, relative paths for the default torrents, eg '../static/sintel.torrent'
     // * Then, paths computed at runtime for default torrents, eg 'sintel.torrent'
     // * Finally, now we're getting rid of torrentPath altogether
-    var src, dst
+    let src, dst
     if (ts.torrentPath) {
       if (path.isAbsolute(ts.torrentPath) || ts.torrentPath.startsWith('..')) {
         src = ts.torrentPath
@@ -62,7 +56,7 @@ function migrate_0_7_0 (saved) {
       dst = path.join(config.TORRENT_PATH, infoHash + '.torrent')
       // Synchronous FS calls aren't ideal, but probably OK in a migration
       // that only runs once
-      if (src !== dst) fs.copySync(src, dst)
+      if (src !== dst) cpFile.sync(src, dst)
 
       delete ts.torrentPath
       ts.torrentFileName = infoHash + '.torrent'
@@ -70,14 +64,14 @@ function migrate_0_7_0 (saved) {
 
     // Replace posterURL with posterFileName
     if (ts.posterURL) {
-      var extension = path.extname(ts.posterURL)
+      const extension = path.extname(ts.posterURL)
       src = path.isAbsolute(ts.posterURL)
         ? ts.posterURL
         : path.join(config.STATIC_PATH, ts.posterURL)
       dst = path.join(config.POSTER_PATH, infoHash + extension)
       // Synchronous FS calls aren't ideal, but probably OK in a migration
       // that only runs once
-      if (src !== dst) fs.copySync(src, dst)
+      if (src !== dst) cpFile.sync(src, dst)
 
       delete ts.posterURL
       ts.posterFileName = infoHash + extension
@@ -108,6 +102,8 @@ function migrate_0_11_0 (saved) {
 }
 
 function migrate_0_12_0 (saved) {
+  const TorrentSummary = require('./torrent-summary')
+
   if (saved.prefs.openExternalPlayer == null && saved.prefs.playInVlc != null) {
     saved.prefs.openExternalPlayer = saved.prefs.playInVlc
   }
@@ -116,7 +112,7 @@ function migrate_0_12_0 (saved) {
   // Undo a terrible bug where clicking Play on a default torrent on a fresh
   // install results in a "path missing" error
   // See https://github.com/feross/webtorrent-desktop/pull/806
-  var defaultTorrentFiles = [
+  const defaultTorrentFiles = [
     '6a9759bffd5c0af65319979fb7832189f4f3c35d.torrent',
     '88594aaacbde40ef3e2510c47374ec0aa396c08e.torrent',
     '6a02592d2bbc069628cd5ed8a54f88ee06ac0ba5.torrent',
@@ -125,13 +121,88 @@ function migrate_0_12_0 (saved) {
   ]
   saved.torrents.forEach(function (torrentSummary) {
     if (!defaultTorrentFiles.includes(torrentSummary.torrentFileName)) return
-    var fileOrFolder = TorrentSummary.getFileOrFolder(torrentSummary)
+    const fileOrFolder = TorrentSummary.getFileOrFolder(torrentSummary)
     if (!fileOrFolder) return
     try {
       fs.statSync(fileOrFolder)
-    } catch (e) {
+    } catch (err) {
       // Default torrent with "missing path" error. Clear path.
       delete torrentSummary.path
     }
   })
 }
+
+function migrate_0_14_0 (saved) {
+  saved.torrents.forEach(function (ts) {
+    delete ts.defaultPlayFileIndex
+  })
+}
+
+function migrate_0_17_0 (saved) {
+  // Fix a sad, sad bug that resulted in 100MB+ config.json files
+  saved.torrents.forEach(function (ts) {
+    if (!ts.files) return
+    ts.files.forEach(function (file) {
+      if (!file.audioInfo || !file.audioInfo.picture) return
+      // This contained a Buffer, which 30x'd in size when serialized to JSON
+      delete file.audioInfo.picture
+    })
+  })
+}
+
+function migrate_0_17_2 (saved) {
+  // Remove the trailing dot (.) from the Wired CD torrent name, since
+  // folders/files that end in a trailing dot (.) or space are not deletable from
+  // Windows Explorer. See: https://github.com/feross/webtorrent-desktop/issues/905
+
+  const cpFile = require('cp-file')
+  const rimraf = require('rimraf')
+
+  const OLD_NAME = 'The WIRED CD - Rip. Sample. Mash. Share.'
+  const NEW_NAME = 'The WIRED CD - Rip. Sample. Mash. Share'
+
+  const OLD_HASH = '3ba219a8634bf7bae3d848192b2da75ae995589d'
+  const NEW_HASH = 'a88fda5954e89178c372716a6a78b8180ed4dad3'
+
+  const ts = saved.torrents.find((ts) => {
+    return ts.infoHash === OLD_HASH
+  })
+
+  if (!ts) return // Wired CD torrent does not exist
+
+  // New versions of WebTorrent ship with a fixed torrent file. Let's fix up the
+  // name in existing versions of WebTorrent.
+  ts.name = ts.displayName = NEW_NAME
+  ts.files.forEach((file) => {
+    file.path = file.path.replace(OLD_NAME, NEW_NAME)
+  })
+
+  // Changing the torrent name causes the info hash to change
+  ts.infoHash = NEW_HASH
+  ts.magnetURI = ts.magnetURI.replace(OLD_HASH, NEW_HASH)
+
+  try {
+    fs.renameSync(
+      path.join(config.POSTER_PATH, ts.posterFileName),
+      path.join(config.POSTER_PATH, NEW_HASH + '.jpg')
+    )
+  } catch (err) {}
+  ts.posterFileName = NEW_HASH + '.jpg'
+
+  rimraf.sync(path.join(config.TORRENT_PATH, ts.torrentFileName))
+  cpFile.sync(
+    path.join(config.STATIC_PATH, 'wiredCd.torrent'),
+    path.join(config.TORRENT_PATH, NEW_HASH + '.torrent')
+  )
+  ts.torrentFileName = NEW_HASH + '.torrent'
+
+  if (ts.path) {
+    // If torrent folder already exists on disk, try to rename it
+    try {
+      fs.renameSync(
+        path.join(ts.path, OLD_NAME),
+        path.join(ts.path, NEW_NAME)
+      )
+    } catch (err) {}
+  }
+}

src/renderer/lib/playlist.js

@@ -0,0 +1,87 @@
+module.exports = {
+  hasNext,
+  getNextIndex,
+  hasPrevious,
+  getPreviousIndex,
+  getCurrentLocalURL
+}
+
+const TorrentSummary = require('./torrent-summary')
+const TorrentPlayer = require('./torrent-player')
+
+const cache = {
+  infoHash: null,
+  previousIndex: null,
+  currentIndex: null,
+  nextIndex: null
+}
+
+function hasNext (state) {
+  updateCache(state)
+  return cache.nextIndex !== null
+}
+
+function getNextIndex (state) {
+  updateCache(state)
+  return cache.nextIndex
+}
+
+function hasPrevious (state) {
+  updateCache(state)
+  return cache.previousIndex !== null
+}
+
+function getPreviousIndex (state) {
+  updateCache(state)
+  return cache.previousIndex
+}
+
+function getCurrentLocalURL (state) {
+  return state.server
+    ? state.server.localURL + '/' + state.playing.fileIndex
+    : ''
+}
+
+function updateCache (state) {
+  const infoHash = state.playing.infoHash
+  const fileIndex = state.playing.fileIndex
+
+  if (infoHash === cache.infoHash) {
+    switch (fileIndex) {
+      case cache.currentIndex:
+        return
+      case cache.nextIndex:
+        cache.previousIndex = cache.currentIndex
+        cache.currentIndex = fileIndex
+        cache.nextIndex = findNextIndex(state)
+        return
+      case cache.previousIndex:
+        cache.previousIndex = findPreviousIndex(state)
+        cache.nextIndex = cache.currentIndex
+        cache.currentIndex = fileIndex
+        return
+    }
+  } else {
+    cache.infoHash = infoHash
+  }
+
+  cache.previousIndex = findPreviousIndex(state)
+  cache.currentIndex = fileIndex
+  cache.nextIndex = findNextIndex(state)
+}
+
+function findPreviousIndex (state) {
+  const files = TorrentSummary.getByKey(state, state.playing.infoHash).files
+  for (let i = state.playing.fileIndex - 1; i >= 0; i--) {
+    if (TorrentPlayer.isPlayable(files[i])) return i
+  }
+  return null
+}
+
+function findNextIndex (state) {
+  const files = TorrentSummary.getByKey(state, state.playing.infoHash).files
+  for (let i = state.playing.fileIndex + 1; i < files.length; i++) {
+    if (TorrentPlayer.isPlayable(files[i])) return i
+  }
+  return null
+}

src/renderer/lib/sound.js

@@ -1,28 +1,28 @@
 module.exports = {
-  preload,
   play
 }
 
-var config = require('../../config')
-var path = require('path')
+const config = require('../../config')
+const {InvalidSoundNameError} = require('./errors')
+const path = require('path')
 
-var VOLUME = 0.15
+const VOLUME = 0.25
 
 /* Cache of Audio elements, for instant playback */
-var cache = {}
+const cache = {}
 
-var sounds = {
+const sounds = {
   ADD: {
     url: 'file://' + path.join(config.STATIC_PATH, 'sound', 'add.wav'),
     volume: VOLUME
   },
   DELETE: {
     url: 'file://' + path.join(config.STATIC_PATH, 'sound', 'delete.wav'),
-    volume: VOLUME
+    volume: VOLUME * 0.5
   },
   DISABLE: {
     url: 'file://' + path.join(config.STATIC_PATH, 'sound', 'disable.wav'),
-    volume: VOLUME
+    volume: VOLUME * 0.5
   },
   DONE: {
     url: 'file://' + path.join(config.STATIC_PATH, 'sound', 'done.wav'),
@@ -30,7 +30,7 @@ var sounds = {
   },
   ENABLE: {
     url: 'file://' + path.join(config.STATIC_PATH, 'sound', 'enable.wav'),
-    volume: VOLUME
+    volume: VOLUME * 0.5
   },
   ERROR: {
     url: 'file://' + path.join(config.STATIC_PATH, 'sound', 'error.wav'),
@@ -42,27 +42,16 @@ var sounds = {
   },
   STARTUP: {
     url: 'file://' + path.join(config.STATIC_PATH, 'sound', 'startup.wav'),
-    volume: VOLUME * 2
-  }
-}
-
-function preload () {
-  for (var name in sounds) {
-    if (!cache[name]) {
-      var sound = sounds[name]
-      var audio = cache[name] = new window.Audio()
-      audio.volume = sound.volume
-      audio.src = sound.url
-    }
+    volume: VOLUME
   }
 }
 
 function play (name) {
-  var audio = cache[name]
+  let audio = cache[name]
   if (!audio) {
-    var sound = sounds[name]
+    const sound = sounds[name]
     if (!sound) {
-      throw new Error('Invalid sound name')
+      throw new InvalidSoundNameError(name)
     }
     audio = cache[name] = new window.Audio()
     audio.volume = sound.volume

src/renderer/lib/state.js

@@ -1,21 +1,30 @@
-var appConfig = require('application-config')('WebTorrent')
-var path = require('path')
-var {EventEmitter} = require('events')
+const appConfig = require('application-config')('WebTorrent')
+const path = require('path')
+const {EventEmitter} = require('events')
 
-var config = require('../../config')
-var migrations = require('./migrations')
+const config = require('../../config')
 
-var State = module.exports = Object.assign(new EventEmitter(), {
-  getDefaultPlayState,
-  load,
-  save,
-  saveThrottled
-})
+const SAVE_DEBOUNCE_INTERVAL = 1000
 
 appConfig.filePath = path.join(config.CONFIG_PATH, 'config.json')
 
+const State = module.exports = Object.assign(new EventEmitter(), {
+  getDefaultPlayState,
+  load,
+  // state.save() calls are rate-limited. Use state.saveImmediate() to skip limit.
+  save: function () {
+    // Perf optimization: Lazy-require debounce (and it's dependencies)
+    const debounce = require('debounce')
+    // After first State.save() invokation, future calls go straight to the
+    // debounced function
+    State.save = debounce(saveImmediate, SAVE_DEBOUNCE_INTERVAL)
+    State.save(...arguments)
+  },
+  saveImmediate
+})
+
 function getDefaultState () {
-  var LocationHistory = require('location-history')
+  const LocationHistory = require('location-history')
 
   return {
     /*
@@ -68,7 +77,9 @@ function getDefaultState () {
      * Getters, for convenience
      */
     getPlayingTorrentSummary,
-    getPlayingFileSummary
+    getPlayingFileSummary,
+    getExternalPlayerName,
+    shouldHidePlayerControls
   }
 }
 
@@ -81,6 +92,7 @@ function getDefaultPlayState () {
     type: null, /* 'audio' or 'video', could be 'other' if ever support eg streaming to VLC */
     currentTime: 0, /* seconds */
     duration: 1, /* seconds */
+    isReady: false,
     isPaused: true,
     isStalled: false,
     lastTimeUpdate: 0, /* Unix time in ms */
@@ -97,39 +109,40 @@ function getDefaultPlayState () {
 }
 
 /* If the saved state file doesn't exist yet, here's what we use instead */
-function setupSavedState (cb) {
-  var fs = require('fs-extra')
-  var parseTorrent = require('parse-torrent')
-  var parallel = require('run-parallel')
+function setupStateSaved (cb) {
+  const cpFile = require('cp-file')
+  const fs = require('fs')
+  const parseTorrent = require('parse-torrent')
+  const parallel = require('run-parallel')
 
-  var saved = {
+  const saved = {
     prefs: {
       downloadPath: config.DEFAULT_DOWNLOAD_PATH,
       isFileHandler: false,
       openExternalPlayer: false,
-      externalPlayerPath: null
+      externalPlayerPath: null,
+      startup: false
     },
     torrents: config.DEFAULT_TORRENTS.map(createTorrentObject),
+    torrentsToResume: [],
     version: config.APP_VERSION /* make sure we can upgrade gracefully later */
   }
 
-  var tasks = []
+  const tasks = []
 
   config.DEFAULT_TORRENTS.map(function (t, i) {
-    var infoHash = saved.torrents[i].infoHash
+    const infoHash = saved.torrents[i].infoHash
     tasks.push(function (cb) {
-      fs.copy(
+      cpFile(
         path.join(config.STATIC_PATH, t.posterFileName),
-        path.join(config.POSTER_PATH, infoHash + path.extname(t.posterFileName)),
-        cb
-      )
+        path.join(config.POSTER_PATH, infoHash + path.extname(t.posterFileName))
+      ).then(cb).catch(cb)
     })
     tasks.push(function (cb) {
-      fs.copy(
+      cpFile(
         path.join(config.STATIC_PATH, t.torrentFileName),
-        path.join(config.TORRENT_PATH, infoHash + '.torrent'),
-        cb
-      )
+        path.join(config.TORRENT_PATH, infoHash + '.torrent')
+      ).then(cb).catch(cb)
     })
   })
 
@@ -139,8 +152,9 @@ function setupSavedState (cb) {
   })
 
   function createTorrentObject (t) {
-    var torrent = fs.readFileSync(path.join(config.STATIC_PATH, t.torrentFileName))
-    var parsedTorrent = parseTorrent(torrent)
+    // TODO: Doing several fs.readFileSync calls during first startup is not ideal
+    const torrent = fs.readFileSync(path.join(config.STATIC_PATH, t.torrentFileName))
+    const parsedTorrent = parseTorrent(torrent)
 
     return {
       status: 'paused',
@@ -151,62 +165,80 @@ function setupSavedState (cb) {
       torrentFileName: parsedTorrent.infoHash + '.torrent',
       magnetURI: parseTorrent.toMagnetURI(parsedTorrent),
       files: parsedTorrent.files,
-      selections: parsedTorrent.files.map((x) => true)
+      selections: parsedTorrent.files.map((x) => true),
+      testID: t.testID
     }
   }
 }
 
 function getPlayingTorrentSummary () {
-  var infoHash = this.playing.infoHash
+  const infoHash = this.playing.infoHash
   return this.saved.torrents.find((x) => x.infoHash === infoHash)
 }
 
 function getPlayingFileSummary () {
-  var torrentSummary = this.getPlayingTorrentSummary()
+  const torrentSummary = this.getPlayingTorrentSummary()
   if (!torrentSummary) return null
   return torrentSummary.files[this.playing.fileIndex]
 }
 
-function load (cb) {
-  var state = getDefaultState()
+function getExternalPlayerName () {
+  const playerPath = this.saved.prefs.externalPlayerPath
+  if (!playerPath) return 'VLC'
+  return path.basename(playerPath).split('.')[0]
+}
 
+function shouldHidePlayerControls () {
+  return this.location.url() === 'player' &&
+    this.playing.mouseStationarySince !== 0 &&
+    new Date().getTime() - this.playing.mouseStationarySince > 2000 &&
+    !this.playing.mouseInControls &&
+    !this.playing.isPaused &&
+    this.playing.location === 'local' &&
+    this.playing.playbackRate === 1
+}
+
+function load (cb) {
   appConfig.read(function (err, saved) {
     if (err || !saved.version) {
       console.log('Missing config file: Creating new one')
-      setupSavedState(onSaved)
+      setupStateSaved(onSavedState)
     } else {
-      onSaved(null, saved)
+      onSavedState(null, saved)
     }
   })
 
-  function onSaved (err, saved) {
+  function onSavedState (err, saved) {
     if (err) return cb(err)
+    const state = getDefaultState()
     state.saved = saved
-    migrations.run(state)
+
+    if (process.type === 'renderer') {
+      // Perf optimization: Save require() calls in the main process
+      const migrations = require('./migrations')
+      migrations.run(state)
+    }
+
     cb(null, state)
   }
 }
 
 // Write state.saved to the JSON state file
-function save (state, cb) {
+function saveImmediate (state, cb) {
   console.log('Saving state to ' + appConfig.filePath)
-  delete state.saveStateTimeout
 
   // Clean up, so that we're not saving any pending state
-  var copy = Object.assign({}, state.saved)
+  const copy = Object.assign({}, state.saved)
   // Remove torrents pending addition to the list, where we haven't finished
   // reading the torrent file or file(s) to seed & don't have an infohash
   copy.torrents = copy.torrents
     .filter((x) => x.infoHash)
     .map(function (x) {
-      var torrent = {}
-      for (var key in x) {
+      const torrent = {}
+      for (let key in x) {
         if (key === 'progress' || key === 'torrentKey') {
           continue // Don't save progress info or key for the webtorrent process
         }
-        if (key === 'playStatus') {
-          continue // Don't save whether a torrent is playing / pending
-        }
         if (key === 'error') {
           continue // Don't save error states
         }
@@ -217,15 +249,6 @@ function save (state, cb) {
 
   appConfig.write(copy, (err) => {
     if (err) console.error(err)
-    else State.emit('savedState')
+    else State.emit('stateSaved')
   })
 }
-
-// Write, but no more than once a second
-function saveThrottled (state) {
-  if (state.saveStateTimeout) return
-  state.saveStateTimeout = setTimeout(function () {
-    if (!state.saveStateTimeout) return
-    save(state)
-  }, 1000)
-}

src/renderer/lib/telemetry.js

@@ -2,44 +2,62 @@
 // Reports back so that we can improve WebTorrent Desktop
 module.exports = {
   init,
+  send,
   logUncaughtError,
   logPlayAttempt
 }
 
-const crypto = require('crypto')
 const electron = require('electron')
-const https = require('https')
-const os = require('os')
-const url = require('url')
 
 const config = require('../../config')
 
-var telemetry
+let telemetry
 
 function init (state) {
   telemetry = state.saved.telemetry
+
+  // First app run
   if (!telemetry) {
-    telemetry = state.saved.telemetry = createSummary()
+    const crypto = require('crypto')
+    telemetry = state.saved.telemetry = {
+      userID: crypto.randomBytes(32).toString('hex') // 256-bit random ID
+    }
     reset()
   }
+}
 
-  var now = new Date()
+function send (state) {
+  const now = new Date()
   telemetry.version = config.APP_VERSION
   telemetry.timestamp = now.toISOString()
   telemetry.localTime = now.toTimeString()
   telemetry.screens = getScreenInfo()
   telemetry.system = getSystemInfo()
-  telemetry.approxNumTorrents = getApproxNumTorrents(state)
+  telemetry.torrentStats = getTorrentStats(state)
+  telemetry.approxNumTorrents = telemetry.torrentStats.approxCount
 
-  if (config.IS_PRODUCTION) {
-    postToServer()
-    // If the user keeps WebTorrent running for a long time, post every 12h
-    setInterval(postToServer, 12 * 3600 * 1000)
-  } else {
+  if (!config.IS_PRODUCTION) {
     // Development: telemetry used only for local debugging
     // Empty uncaught errors, etc at the start of every run
-    reset()
+    return reset()
   }
+
+  const get = require('simple-get')
+
+  const opts = {
+    url: config.TELEMETRY_URL,
+    body: telemetry,
+    json: true
+  }
+
+  get.post(opts, function (err, res) {
+    if (err) return console.error('Error sending telemetry', err)
+    if (res.statusCode !== 200) {
+      return console.error(`Error sending telemetry, status code: ${res.statusCode}`)
+    }
+    console.log('Sent telemetry')
+    reset()
+  })
 }
 
 function reset () {
@@ -48,47 +66,12 @@ function reset () {
     minVersion: config.APP_VERSION,
     total: 0,
     success: 0,
-    timeout: 0,
     error: 0,
+    external: 0,
     abandoned: 0
   }
 }
 
-function postToServer () {
-  // Serialize the telemetry summary
-  var payload = new Buffer(JSON.stringify(telemetry), 'utf8')
-
-  // POST to our server
-  var options = url.parse(config.TELEMETRY_URL)
-  options.method = 'POST'
-  options.headers = {
-    'Content-Type': 'application/json',
-    'Content-Length': payload.length
-  }
-
-  var req = https.request(options, function (res) {
-    if (res.statusCode === 200) {
-      console.log('Successfully posted telemetry summary')
-      reset()
-    } else {
-      console.error('Couldn\'t post telemetry summary, got HTTP ' + res.statusCode)
-    }
-  })
-  req.on('error', function (e) {
-    console.error('Couldn\'t post telemetry summary', e)
-  })
-  req.write(payload)
-  req.end()
-}
-
-// Creates a new telemetry summary. Gives the user a unique ID,
-// collects screen resolution, etc
-function createSummary () {
-  // Make a 256-bit random unique ID
-  var userID = crypto.randomBytes(32).toString('hex')
-  return { userID }
-}
-
 // Track screen resolution
 function getScreenInfo () {
   return electron.screen.getAllDisplays().map((screen) => ({
@@ -100,22 +83,69 @@ function getScreenInfo () {
 
 // Track basic system info like OS version and amount of RAM
 function getSystemInfo () {
+  const os = require('os')
   return {
     osPlatform: process.platform,
     osRelease: os.type() + ' ' + os.release(),
     architecture: os.arch(),
-    totalMemoryMB: os.totalmem() / (1 << 20),
+    systemArchitecture: config.OS_SYSARCH,
+    totalMemoryMB: roundPow2(os.totalmem() / (1 << 20)),
     numCores: os.cpus().length
   }
 }
 
-// Get the number of torrents, rounded to the nearest power of two
-function getApproxNumTorrents (state) {
-  var exactNum = state.saved.torrents.length
-  if (exactNum === 0) return 0
+// Get stats like the # of torrents currently active, # in list, total size
+function getTorrentStats (state) {
+  const count = state.saved.torrents.length
+  let sizeMB = 0
+  let byStatus = {
+    new: { count: 0, sizeMB: 0 },
+    downloading: { count: 0, sizeMB: 0 },
+    seeding: { count: 0, sizeMB: 0 },
+    paused: { count: 0, sizeMB: 0 }
+  }
+
+  // First, count torrents & total file size
+  for (let i = 0; i < count; i++) {
+    const t = state.saved.torrents[i]
+    const stat = byStatus[t.status]
+    if (!t || !t.files || !stat) continue
+    stat.count++
+    for (let j = 0; j < t.files.length; j++) {
+      const f = t.files[j]
+      if (!f || !f.length) continue
+      const fileSizeMB = f.length / (1 << 20)
+      sizeMB += fileSizeMB
+      stat.sizeMB += fileSizeMB
+    }
+  }
+
+  // Then, round all the counts and sums to the nearest power of 2
+  const ret = roundTorrentStats({count, sizeMB})
+  ret.byStatus = {
+    new: roundTorrentStats(byStatus.new),
+    downloading: roundTorrentStats(byStatus.downloading),
+    seeding: roundTorrentStats(byStatus.seeding),
+    paused: roundTorrentStats(byStatus.paused)
+  }
+  return ret
+}
+
+function roundTorrentStats (stats) {
+  return {
+    approxCount: roundPow2(stats.count),
+    approxSizeMB: roundPow2(stats.sizeMB)
+  }
+}
+
+// Rounds to the nearest power of 2, for privacy and easy bucketing.
+// Rounds 35 to 32, 70 to 64, 5 to 4, 1 to 1, 0 to 0.
+// Supports nonnegative numbers only.
+function roundPow2 (n) {
+  if (n <= 0) return 0
   // Otherwise, return 1, 2, 4, 8, etc by rounding in log space
-  var log2 = Math.log(exactNum) / Math.log(2)
-  return 1 << Math.round(log2)
+  const log2 = Math.log(n) / Math.log(2)
+  return Math.pow(2, Math.round(log2))
 }
 
 // An uncaught error happened in the main process or in one of the windows
@@ -124,12 +154,10 @@ function logUncaughtError (procName, e) {
   // Hopefully uncaught errors immediately on startup are fixed in dev
   if (!telemetry) return
 
-  var message
-  var stack = ''
-  if (e.message) {
-    // err is either an Error or a plain object {message, stack}
-    message = e.message
-    stack = e.stack
+  let message
+  let stack = ''
+  if (e == null) {
+    message = 'Unexpected undefined error'
   } else if (e.error) {
     // Uncaught Javascript errors (window.onerror), err is an ErrorEvent
     if (!e.error.message) {
@@ -138,6 +166,10 @@ function logUncaughtError (procName, e) {
       message = e.error.message
       stack = e.error.stack
     }
+  } else if (e.message) {
+    // err is either an Error or a plain object {message, stack}
+    message = e.message
+    stack = e.stack
   } else {
     // Resource errors (captured element.onerror), err is an Event
     if (!e.target) {
@@ -149,11 +181,14 @@ function logUncaughtError (procName, e) {
     }
   }
 
+  if (typeof stack !== 'string') stack = 'Unexpected stack: ' + stack
+  if (typeof message !== 'string') message = 'Unexpected message: ' + message
+
   // Remove the first part of each file path in the stack trace.
   // - Privacy: remove personal info like C:\Users\<full name>
   // - Aggregation: this lets us find which stacktraces occur often
-  if (stack && typeof stack === 'string') stack = stack.replace(/\(.*app.asar/g, '(...')
-  else if (stack) stack = 'Unexpected stack: ' + stack
+  stack = stack.replace(/\(.*app.asar/g, '(...')
+  stack = stack.replace(/at .*app.asar/g, 'at ...')
 
   // We need to POST the telemetry object, make sure it stays < 100kb
   if (telemetry.uncaughtErrors.length > 20) return
@@ -161,28 +196,28 @@ function logUncaughtError (procName, e) {
   if (stack.length > 1000) stack = stack.substring(0, 1000)
 
   // Log the app version *at the time of the error*
-  var version = config.APP_VERSION
+  const version = config.APP_VERSION
 
   telemetry.uncaughtErrors.push({process: procName, message, stack, version})
 }
 
 // Turns a DOM element into a string, eg "DIV.my-class.visible"
 function getElemString (elem) {
-  var ret = elem.tagName
+  let ret = elem.tagName
   try {
     ret += '.' + Array.from(elem.classList).join('.')
-  } catch (e) {}
+  } catch (err) {}
   return ret
 }
 
-// The user pressed play. It either worked, timed out, or showed the
-// 'Play in VLC' codec error
+// The user pressed play. Did it work, display an error,
+// open an external player or did user abandon the attempt?
 function logPlayAttempt (result) {
-  if (!['success', 'timeout', 'error', 'abandoned'].includes(result)) {
+  if (!['success', 'error', 'external', 'abandoned'].includes(result)) {
     return console.error('Unknown play attempt result', result)
   }
 
-  var attempts = telemetry.playAttempts
+  const attempts = telemetry.playAttempts
   attempts.total = (attempts.total || 0) + 1
   attempts[result] = (attempts[result] || 0) + 1
 }

src/renderer/lib/torrent-player.js

@@ -3,11 +3,10 @@ module.exports = {
   isVideo,
   isAudio,
   isTorrent,
-  isPlayableTorrentSummary,
-  pickFileToPlay
+  isPlayableTorrentSummary
 }
 
-var path = require('path')
+const path = require('path')
 
 // Checks whether a fileSummary or file path is audio/video that we can play,
 // based on the file extension
@@ -38,6 +37,7 @@ function isAudio (file) {
     '.mp3',
     '.ogg',
     '.wav',
+    '.flac',
     '.m4a'
   ].includes(getFileExtension(file))
 }
@@ -47,38 +47,16 @@ function isAudio (file) {
 // - a file object where obj.name is ends in .torrent
 // - a string that's a magnet link (magnet://...)
 function isTorrent (file) {
-  var isTorrentFile = getFileExtension(file) === '.torrent'
-  var isMagnet = typeof file === 'string' && /^(stream-)?magnet:/.test(file)
+  const isTorrentFile = getFileExtension(file) === '.torrent'
+  const isMagnet = typeof file === 'string' && /^(stream-)?magnet:/.test(file)
   return isTorrentFile || isMagnet
 }
 
 function getFileExtension (file) {
-  var name = typeof file === 'string' ? file : file.name
+  const name = typeof file === 'string' ? file : file.name
   return path.extname(name).toLowerCase()
 }
 
 function isPlayableTorrentSummary (torrentSummary) {
   return torrentSummary.files && torrentSummary.files.some(isPlayable)
 }
-
-// Picks the default file to play from a list of torrent or torrentSummary files
-// Returns an index or undefined, if no files are playable
-function pickFileToPlay (files) {
-  // first, try to find the biggest video file
-  var videoFiles = files.filter(isVideo)
-  if (videoFiles.length > 0) {
-    var largestVideoFile = videoFiles.reduce(function (a, b) {
-      return a.length > b.length ? a : b
-    })
-    return files.indexOf(largestVideoFile)
-  }
-
-  // if there are no videos, play the first audio file
-  var audioFiles = files.filter(isAudio)
-  if (audioFiles.length > 0) {
-    return files.indexOf(audioFiles[0])
-  }
-
-  // no video or audio means nothing is playable
-  return undefined
-}

src/renderer/lib/torrent-poster.js

@@ -1,22 +1,22 @@
 module.exports = torrentPoster
 
-var captureVideoFrame = require('./capture-video-frame')
-var path = require('path')
+const captureFrame = require('capture-frame')
+const path = require('path')
 
 function torrentPoster (torrent, cb) {
   // First, try to use a poster image if available
-  var posterFile = torrent.files.filter(function (file) {
+  const posterFile = torrent.files.filter(function (file) {
     return /^poster\.(jpg|png|gif)$/.test(file.name)
   })[0]
   if (posterFile) return torrentPosterFromImage(posterFile, torrent, cb)
 
   // Second, try to use the largest video file
   // Filter out file formats that the <video> tag definitely can't play
-  var videoFile = getLargestFileByExtension(torrent, ['.mp4', '.m4v', '.webm', '.mov', '.mkv'])
+  const videoFile = getLargestFileByExtension(torrent, ['.mp4', '.m4v', '.webm', '.mov', '.mkv'])
   if (videoFile) return torrentPosterFromVideo(videoFile, torrent, cb)
 
   // Third, try to use the largest image file
-  var imgFile = getLargestFileByExtension(torrent, ['.gif', '.jpg', '.jpeg', '.png'])
+  const imgFile = getLargestFileByExtension(torrent, ['.gif', '.jpg', '.jpeg', '.png'])
   if (imgFile) return torrentPosterFromImage(imgFile, torrent, cb)
 
   // TODO: generate a waveform from the largest sound file
@@ -25,8 +25,8 @@ function torrentPoster (torrent, cb) {
 }
 
 function getLargestFileByExtension (torrent, extensions) {
-  var files = torrent.files.filter(function (file) {
-    var extname = path.extname(file.name).toLowerCase()
+  const files = torrent.files.filter(function (file) {
+    const extname = path.extname(file.name).toLowerCase()
     return extensions.indexOf(extname) !== -1
   })
   if (files.length === 0) return undefined
@@ -36,15 +36,15 @@ function getLargestFileByExtension (torrent, extensions) {
 }
 
 function torrentPosterFromVideo (file, torrent, cb) {
-  var index = torrent.files.indexOf(file)
+  const index = torrent.files.indexOf(file)
 
-  var server = torrent.createServer(0)
+  const server = torrent.createServer(0)
   server.listen(0, onListening)
 
   function onListening () {
-    var port = server.address().port
-    var url = 'http://localhost:' + port + '/' + index
-    var video = document.createElement('video')
+    const port = server.address().port
+    const url = 'http://localhost:' + port + '/' + index
+    const video = document.createElement('video')
     video.addEventListener('canplay', onCanPlay)
 
     video.volume = 0
@@ -61,7 +61,7 @@ function torrentPosterFromVideo (file, torrent, cb) {
     function onSeeked () {
       video.removeEventListener('seeked', onSeeked)
 
-      var buf = captureVideoFrame(video)
+      const buf = captureFrame(video)
 
       // unload video element
       video.pause()
@@ -78,6 +78,6 @@ function torrentPosterFromVideo (file, torrent, cb) {
 }
 
 function torrentPosterFromImage (file, torrent, cb) {
-  var extname = path.extname(file.name)
+  const extname = path.extname(file.name)
   file.getBuffer((err, buf) => cb(err, buf, extname))
 }

src/renderer/lib/torrent-summary.js

@@ -2,12 +2,12 @@ module.exports = {
   getPosterPath,
   getTorrentPath,
   getByKey,
-  getTorrentID,
+  getTorrentId,
   getFileOrFolder
 }
 
-var path = require('path')
-var config = require('../../config')
+const path = require('path')
+const config = require('../../config')
 
 // Expects a torrentSummary
 // Returns an absolute path to the torrent file, or null if unavailable
@@ -20,7 +20,7 @@ function getTorrentPath (torrentSummary) {
 // Returns an absolute path to the poster image, or null if unavailable
 function getPosterPath (torrentSummary) {
   if (!torrentSummary || !torrentSummary.posterFileName) return null
-  var posterPath = path.join(config.POSTER_PATH, torrentSummary.posterFileName)
+  const posterPath = path.join(config.POSTER_PATH, torrentSummary.posterFileName)
   // Work around a Chrome bug (reproduced in vanilla Chrome, not just Electron):
   // Backslashes in URLS in CSS cause bizarre string encoding issues
   return posterPath.replace(/\\/g, '/')
@@ -28,8 +28,8 @@ function getPosterPath (torrentSummary) {
 
 // Expects a torrentSummary
 // Returns a torrentID: filename, magnet URI, or infohash
-function getTorrentID (torrentSummary) {
-  var s = torrentSummary
+function getTorrentId (torrentSummary) {
+  const s = torrentSummary
   if (s.torrentFileName) { // Load torrent file from disk
     return getTorrentPath(s)
   } else { // Load torrent from DHT
@@ -51,7 +51,8 @@ function getByKey (state, torrentKey) {
 // TODO: make this assumption explicit, enforce it in the `create-torrent`
 // module. Store root folder explicitly to avoid hacky path processing below.
 function getFileOrFolder (torrentSummary) {
-  var ts = torrentSummary
+  const ts = torrentSummary
   if (!ts.path || !ts.files || ts.files.length === 0) return null
-  return path.join(ts.path, ts.files[0].path.split('/')[0])
+  const dirname = ts.files[0].path.split(path.sep)[0]
+  return path.join(ts.path, dirname)
 }