diff options
Diffstat (limited to 'client/src/assets/player/webtorrent/peertube-chunk-store.ts')
-rw-r--r-- | client/src/assets/player/webtorrent/peertube-chunk-store.ts | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/client/src/assets/player/webtorrent/peertube-chunk-store.ts b/client/src/assets/player/webtorrent/peertube-chunk-store.ts new file mode 100644 index 000000000..54cc0ea64 --- /dev/null +++ b/client/src/assets/player/webtorrent/peertube-chunk-store.ts | |||
@@ -0,0 +1,231 @@ | |||
1 | // From https://github.com/MinEduTDF/idb-chunk-store | ||
2 | // We use temporary IndexDB (all data are removed on destroy) to avoid RAM issues | ||
3 | // Thanks @santiagogil and @Feross | ||
4 | |||
5 | import { EventEmitter } from 'events' | ||
6 | import Dexie from 'dexie' | ||
7 | |||
8 | class ChunkDatabase extends Dexie { | ||
9 | chunks: Dexie.Table<{ id: number, buf: Buffer }, number> | ||
10 | |||
11 | constructor (dbname: string) { | ||
12 | super(dbname) | ||
13 | |||
14 | this.version(1).stores({ | ||
15 | chunks: 'id' | ||
16 | }) | ||
17 | } | ||
18 | } | ||
19 | |||
20 | class ExpirationDatabase extends Dexie { | ||
21 | databases: Dexie.Table<{ name: string, expiration: number }, number> | ||
22 | |||
23 | constructor () { | ||
24 | super('webtorrent-expiration') | ||
25 | |||
26 | this.version(1).stores({ | ||
27 | databases: 'name,expiration' | ||
28 | }) | ||
29 | } | ||
30 | } | ||
31 | |||
32 | export class PeertubeChunkStore extends EventEmitter { | ||
33 | private static readonly BUFFERING_PUT_MS = 1000 | ||
34 | private static readonly CLEANER_INTERVAL_MS = 1000 * 60 // 1 minute | ||
35 | private static readonly CLEANER_EXPIRATION_MS = 1000 * 60 * 5 // 5 minutes | ||
36 | |||
37 | chunkLength: number | ||
38 | |||
39 | private pendingPut: { id: number, buf: Buffer, cb: Function }[] = [] | ||
40 | // If the store is full | ||
41 | private memoryChunks: { [ id: number ]: Buffer | true } = {} | ||
42 | private databaseName: string | ||
43 | private putBulkTimeout: any | ||
44 | private cleanerInterval: any | ||
45 | private db: ChunkDatabase | ||
46 | private expirationDB: ExpirationDatabase | ||
47 | private readonly length: number | ||
48 | private readonly lastChunkLength: number | ||
49 | private readonly lastChunkIndex: number | ||
50 | |||
51 | constructor (chunkLength: number, opts: any) { | ||
52 | super() | ||
53 | |||
54 | this.databaseName = 'webtorrent-chunks-' | ||
55 | |||
56 | if (!opts) opts = {} | ||
57 | if (opts.torrent && opts.torrent.infoHash) this.databaseName += opts.torrent.infoHash | ||
58 | else this.databaseName += '-default' | ||
59 | |||
60 | this.setMaxListeners(100) | ||
61 | |||
62 | this.chunkLength = Number(chunkLength) | ||
63 | if (!this.chunkLength) throw new Error('First argument must be a chunk length') | ||
64 | |||
65 | this.length = Number(opts.length) || Infinity | ||
66 | |||
67 | if (this.length !== Infinity) { | ||
68 | this.lastChunkLength = (this.length % this.chunkLength) || this.chunkLength | ||
69 | this.lastChunkIndex = Math.ceil(this.length / this.chunkLength) - 1 | ||
70 | } | ||
71 | |||
72 | this.db = new ChunkDatabase(this.databaseName) | ||
73 | // Track databases that expired | ||
74 | this.expirationDB = new ExpirationDatabase() | ||
75 | |||
76 | this.runCleaner() | ||
77 | } | ||
78 | |||
79 | put (index: number, buf: Buffer, cb: (err?: Error) => void) { | ||
80 | const isLastChunk = (index === this.lastChunkIndex) | ||
81 | if (isLastChunk && buf.length !== this.lastChunkLength) { | ||
82 | return this.nextTick(cb, new Error('Last chunk length must be ' + this.lastChunkLength)) | ||
83 | } | ||
84 | if (!isLastChunk && buf.length !== this.chunkLength) { | ||
85 | return this.nextTick(cb, new Error('Chunk length must be ' + this.chunkLength)) | ||
86 | } | ||
87 | |||
88 | // Specify we have this chunk | ||
89 | this.memoryChunks[index] = true | ||
90 | |||
91 | // Add it to the pending put | ||
92 | this.pendingPut.push({ id: index, buf, cb }) | ||
93 | // If it's already planned, return | ||
94 | if (this.putBulkTimeout) return | ||
95 | |||
96 | // Plan a future bulk insert | ||
97 | this.putBulkTimeout = setTimeout(async () => { | ||
98 | const processing = this.pendingPut | ||
99 | this.pendingPut = [] | ||
100 | this.putBulkTimeout = undefined | ||
101 | |||
102 | try { | ||
103 | await this.db.transaction('rw', this.db.chunks, () => { | ||
104 | return this.db.chunks.bulkPut(processing.map(p => ({ id: p.id, buf: p.buf }))) | ||
105 | }) | ||
106 | } catch (err) { | ||
107 | console.log('Cannot bulk insert chunks. Store them in memory.', { err }) | ||
108 | |||
109 | processing.forEach(p => this.memoryChunks[ p.id ] = p.buf) | ||
110 | } finally { | ||
111 | processing.forEach(p => p.cb()) | ||
112 | } | ||
113 | }, PeertubeChunkStore.BUFFERING_PUT_MS) | ||
114 | } | ||
115 | |||
116 | get (index: number, opts: any, cb: (err?: Error, buf?: Buffer) => void): void { | ||
117 | if (typeof opts === 'function') return this.get(index, null, opts) | ||
118 | |||
119 | // IndexDB could be slow, use our memory index first | ||
120 | const memoryChunk = this.memoryChunks[index] | ||
121 | if (memoryChunk === undefined) { | ||
122 | const err = new Error('Chunk not found') as any | ||
123 | err['notFound'] = true | ||
124 | |||
125 | return process.nextTick(() => cb(err)) | ||
126 | } | ||
127 | |||
128 | // Chunk in memory | ||
129 | if (memoryChunk !== true) return cb(null, memoryChunk) | ||
130 | |||
131 | // Chunk in store | ||
132 | this.db.transaction('r', this.db.chunks, async () => { | ||
133 | const result = await this.db.chunks.get({ id: index }) | ||
134 | if (result === undefined) return cb(null, new Buffer(0)) | ||
135 | |||
136 | const buf = result.buf | ||
137 | if (!opts) return this.nextTick(cb, null, buf) | ||
138 | |||
139 | const offset = opts.offset || 0 | ||
140 | const len = opts.length || (buf.length - offset) | ||
141 | return cb(null, buf.slice(offset, len + offset)) | ||
142 | }) | ||
143 | .catch(err => { | ||
144 | console.error(err) | ||
145 | return cb(err) | ||
146 | }) | ||
147 | } | ||
148 | |||
149 | close (cb: (err?: Error) => void) { | ||
150 | return this.destroy(cb) | ||
151 | } | ||
152 | |||
153 | async destroy (cb: (err?: Error) => void) { | ||
154 | try { | ||
155 | if (this.pendingPut) { | ||
156 | clearTimeout(this.putBulkTimeout) | ||
157 | this.pendingPut = null | ||
158 | } | ||
159 | if (this.cleanerInterval) { | ||
160 | clearInterval(this.cleanerInterval) | ||
161 | this.cleanerInterval = null | ||
162 | } | ||
163 | |||
164 | if (this.db) { | ||
165 | await this.db.close() | ||
166 | |||
167 | await this.dropDatabase(this.databaseName) | ||
168 | } | ||
169 | |||
170 | if (this.expirationDB) { | ||
171 | await this.expirationDB.close() | ||
172 | this.expirationDB = null | ||
173 | } | ||
174 | |||
175 | return cb() | ||
176 | } catch (err) { | ||
177 | console.error('Cannot destroy peertube chunk store.', err) | ||
178 | return cb(err) | ||
179 | } | ||
180 | } | ||
181 | |||
182 | private runCleaner () { | ||
183 | this.checkExpiration() | ||
184 | |||
185 | this.cleanerInterval = setInterval(async () => { | ||
186 | this.checkExpiration() | ||
187 | }, PeertubeChunkStore.CLEANER_INTERVAL_MS) | ||
188 | } | ||
189 | |||
190 | private async checkExpiration () { | ||
191 | let databasesToDeleteInfo: { name: string }[] = [] | ||
192 | |||
193 | try { | ||
194 | await this.expirationDB.transaction('rw', this.expirationDB.databases, async () => { | ||
195 | // Update our database expiration since we are alive | ||
196 | await this.expirationDB.databases.put({ | ||
197 | name: this.databaseName, | ||
198 | expiration: new Date().getTime() + PeertubeChunkStore.CLEANER_EXPIRATION_MS | ||
199 | }) | ||
200 | |||
201 | const now = new Date().getTime() | ||
202 | databasesToDeleteInfo = await this.expirationDB.databases.where('expiration').below(now).toArray() | ||
203 | }) | ||
204 | } catch (err) { | ||
205 | console.error('Cannot update expiration of fetch expired databases.', err) | ||
206 | } | ||
207 | |||
208 | for (const databaseToDeleteInfo of databasesToDeleteInfo) { | ||
209 | await this.dropDatabase(databaseToDeleteInfo.name) | ||
210 | } | ||
211 | } | ||
212 | |||
213 | private async dropDatabase (databaseName: string) { | ||
214 | const dbToDelete = new ChunkDatabase(databaseName) | ||
215 | console.log('Destroying IndexDB database %s.', databaseName) | ||
216 | |||
217 | try { | ||
218 | await dbToDelete.delete() | ||
219 | |||
220 | await this.expirationDB.transaction('rw', this.expirationDB.databases, () => { | ||
221 | return this.expirationDB.databases.where({ name: databaseName }).delete() | ||
222 | }) | ||
223 | } catch (err) { | ||
224 | console.error('Cannot delete %s.', databaseName, err) | ||
225 | } | ||
226 | } | ||
227 | |||
228 | private nextTick <T> (cb: (err?: Error, val?: T) => void, err: Error, val?: T) { | ||
229 | process.nextTick(() => cb(err, val), undefined) | ||
230 | } | ||
231 | } | ||