WebTorrent: Fix stats remain stuck after download finishes

Fixes: brave/brave-browser#5352

- Always update stats at least once every 5 seconds, even when no torrent events fire
- remove stray console logs
- Listen for 'wire' (new peer) events
- Listen for 'done' event

Author: feross

components/brave_webtorrent/extension/background/events/torrentEvents.ts

@@ -13,11 +13,9 @@ export const addTorrentEvents = (torrent: Torrent) => {
     webtorrentActions.progressUpdated(torrent)
   })
   torrent.on('infoHash', () => {
-    console.log('infoHash event')
     webtorrentActions.infoUpdated(torrent)
   })
   torrent.on('metadata', () => {
-    console.log('metadata event')
     webtorrentActions.infoUpdated(torrent)
   })
   torrent.on('download', throttle((bytes: number) => {
@@ -26,8 +24,13 @@ export const addTorrentEvents = (torrent: Torrent) => {
   torrent.on('upload', throttle((bytes: number) => {
     webtorrentActions.progressUpdated(torrent)
   }, 1000))
+  torrent.on('done', () => {
+    webtorrentActions.progressUpdated(torrent)
+  })
+  torrent.on('wire', () => {
+    webtorrentActions.progressUpdated(torrent)
+  })
   torrent.on('ready', () => {
-    console.log('ready', torrent)
     createServer(torrent, (serverURL: string) => {
       webtorrentActions.serverUpdated(torrent, serverURL)
     })

components/brave_webtorrent/extension/background/events/webtorrentEvents.ts

@@ -3,9 +3,24 @@
  * You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Instance } from 'webtorrent'
+import webtorrentActions from '../actions/webtorrentActions'
+
+let interval: number
 
 export const addWebtorrentEvents = (webtorrent: Instance) => {
   webtorrent.on('error', (e: Error | string) => {
     console.log('WebTorrent error: ', e)
   })
+
+  // Always update stats at least once every 5 seconds, even when no torrent
+  // events fire
+  interval = setInterval(() => {
+    webtorrent.torrents.forEach(torrent => {
+      webtorrentActions.progressUpdated(torrent)
+    })
+  }, 5000)
+}
+
+export const removeWebTorrentEvents = (webtorrent: Instance) => {
+  clearInterval(interval)
 }

components/brave_webtorrent/extension/background/webtorrent.ts

@@ -4,7 +4,7 @@
 
 import * as WebTorrent from 'webtorrent'
 import { addTorrentEvents } from './events/torrentEvents'
-import { addWebtorrentEvents } from './events/webtorrentEvents'
+import { addWebtorrentEvents, removeWebTorrentEvents } from './events/webtorrentEvents'
 import { AddressInfo } from 'net'
 import { Instance } from 'parse-torrent'
 
@@ -61,6 +61,7 @@ export const findTorrent = (infoHash: string) => {
 
 const maybeDestroyWebTorrent = () => {
   if (!webTorrent || webTorrent.torrents.length !== 0) return
+  removeWebTorrentEvents(webTorrent)
   webTorrent.destroy()
   webTorrent = undefined
 }

components/test/brave_webtorrent/background/reducers/index_test.ts

@@ -5,8 +5,9 @@
 import reducers from '../../../../brave_webtorrent/extension/background/reducers/index'
 import { applicationState } from '../../testData'
 
-// this import seems to trigger createStore and get an undefined reducer
+// these imports seems to trigger createStore and get an undefined reducer
 jest.mock('../../../../brave_webtorrent/extension/background/events/torrentEvents')
+jest.mock('../../../../brave_webtorrent/extension/background/events/webtorrentEvents')
 
 describe('webtorrent reducers test', () => {
   it('reducers are a combined reducer function', () => {