-
Notifications
You must be signed in to change notification settings - Fork 48
/
DatabaseBuilder.ts
531 lines (448 loc) · 20.4 KB
/
DatabaseBuilder.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
import { Env } from "@pipeline/Env";
import { Language, LanguageCodes } from "@pipeline/Languages";
import { Day, genTimeKeys } from "@pipeline/Time";
import { Config, Index } from "@pipeline/Types";
import { createParser } from "@pipeline/parse";
import { FileInput } from "@pipeline/parse/File";
import { Parser } from "@pipeline/parse/Parser";
import { PAuthor, PCall, PChannel, PGuild, PMessage, RawID } from "@pipeline/parse/Types";
import { BigMap } from "@pipeline/process/BigMap";
import { ChannelMessages } from "@pipeline/process/ChannelMessages";
import { IndexCountsBuilder } from "@pipeline/process/IndexCounts";
import { IndexedMap } from "@pipeline/process/IndexedMap";
import { MessageProcessor } from "@pipeline/process/MessageProcessor";
import { Author, Call, Channel, Database, Emoji, Guild, Message } from "@pipeline/process/Types";
import { rank, remap } from "@pipeline/process/Util";
import { Stopwords } from "@pipeline/process/nlp/Stopwords";
import { BitAddress } from "@pipeline/serialization/BitStream";
import { MessageBitConfig } from "@pipeline/serialization/MessageSerialization";
import { MessagesArray } from "@pipeline/serialization/MessagesArray";
/**
* Builds the Database object from input files.
*
* ⚠️ You probably want to use `generateDatabase` instead of manually creating a DatabaseBuilder.
*/
export class DatabaseBuilder {
parser: Parser;
// data stores
guilds = new IndexedMap<RawID, PGuild>();
channels = new IndexedMap<RawID, PChannel>();
authors = new IndexedMap<RawID, PAuthor>();
calls = new IndexedMap<RawID, PCall>();
words = new IndexedMap<string, string>();
emojis = new IndexedMap<string, Emoji>();
mentions = new IndexedMap<string, string>();
domains = new IndexedMap<string, string>();
replyIds: RawID[] = [];
/** Each channel has its own ChannelMessages instance */
messagesInChannel = new Map<RawID, ChannelMessages>();
/** Global messages processor */
messageProcessor = new MessageProcessor(this);
get numChannels() { return this.channels.size; } // prettier-ignore
get numAuthors() { return this.authors.size; } // prettier-ignore
get numMessages() { return [...this.messagesInChannel.values()].reduce((acc, mc) => acc + mc.numMessages, 0); } // prettier-ignore
constructor(private readonly config: Config, private readonly env: Env) {
this.parser = createParser(config.platform);
this.parser.on("guild", (guild, at) => this.guilds.set(guild.id, guild, at));
this.parser.on("channel", (channel, at) => this.channels.set(channel.id, channel, at));
this.parser.on("author", (author, at) => this.authors.set(author.id, author, at));
this.parser.on("message", (message, at) => {
// NOTE: `at` is not supported for messages
let channelMessages = this.messagesInChannel.get(message.channelId);
if (channelMessages === undefined) {
// new channel found
channelMessages = new ChannelMessages();
this.messagesInChannel.set(message.channelId, channelMessages);
}
channelMessages.addMessage(message);
});
this.parser.on("call", (call, at) => {
this.calls.set(call.id, call, at);
// update min/max date
const day = Day.fromDate(new Date(call.timestampEnd));
if (Day.lt(day, this.minDate)) this.minDate = day;
if (Day.gt(day, this.maxDate)) this.maxDate = day;
});
this.parser.on("out-of-order", () => this.markEOF());
}
// static data
private stopwords?: Stopwords;
/** Initialize static data. Must be called before `processFiles` */
async init() {
await this.messageProcessor.init(this.env);
this.stopwords = await Stopwords.load(this.env);
}
/** Process the provided files */
async processFiles(files: FileInput[]) {
let filesProcessed = 0;
this.env.progress?.stat("total_files", files.length);
for (const file of files) {
this.env.progress?.new("Processing", file.name);
await this.processFile(file);
this.env.progress?.success();
this.env.progress?.stat("processed_files", ++filesProcessed);
}
}
/** Process the provided file. Throws in case of error. */
private async processFile(file: FileInput) {
try {
for await (const _ of this.parser.parse(file, this.env.progress)) this.processPendingMessages();
} catch (err) {
if (err instanceof Error) {
const newErr = new Error(`Error parsing file "${file.name}":\n\n${err.message}`);
newErr.stack = err.stack;
throw newErr;
}
// hopefully handled by WorkerApp.ts
throw err;
}
this.markEOF();
this.processPendingMessages();
}
/** Goes through all ChannelMessage and process all the messages that remain pending */
private processPendingMessages() {
for (const chMsgs of this.messagesInChannel.values()) {
chMsgs.process((group) => {
const processed = this.messageProcessor.processGroupToIntermediate(group);
for (let i = 0; i < processed.length; i++) {
this.postProcessMessage(group[i], processed[i]);
}
return processed;
});
}
// update stats
this.env.progress?.stat("channels", this.numChannels);
this.env.progress?.stat("authors", this.numAuthors);
this.env.progress?.stat("messages", this.numMessages);
}
/** Singnals EOF to all ChannelMessages. MUST be called */
private markEOF() {
for (const chMsgs of this.messagesInChannel.values()) {
chMsgs.markEOF();
}
}
/////////////////////////////////////////////////////
// //
// Counting, reindexing, making final objects //
// //
/////////////////////////////////////////////////////
minDate = Day.HIGHEST;
maxDate = Day.LOWEST;
guildCounts: number[] = [];
channelCounts: number[] = [];
authorCounts: number[] = [];
wordsCounts: number[] = [];
langCounts: number[] = [];
guildsRank: Index[] = [];
channelsRank: Index[] = [];
authorsRank: Index[] = [];
wordsRank: Index[] = [];
/** We want to store participants for DM chats to later override the channel name with "Alice & Bob" */
dmParticipants = new Map<RawID, Index[]>();
private postProcessMessage(pmsg: PMessage, msg: Message) {
const channelIndex = this.channels.getIndex(pmsg.channelId)!;
const channel = this.channels.getByIndex(channelIndex)!;
const guildIndex = this.guilds.getIndex(channel.guildId)!;
// count stuff
this.guildCounts[guildIndex] = (this.guildCounts[guildIndex] || 0) + 1;
this.channelCounts[channelIndex] = (this.channelCounts[channelIndex] || 0) + 1;
this.authorCounts[msg.authorIndex] = (this.authorCounts[msg.authorIndex] || 0) + 1;
if (msg.words) {
for (const [idx, count] of msg.words) {
this.wordsCounts[idx] = (this.wordsCounts[idx] || 0) + count;
}
}
if (msg.langIndex !== undefined) {
this.langCounts[msg.langIndex] = (this.langCounts[msg.langIndex] || 0) + 1;
}
// if this channel is a DM, store participants
if (channel.type === "dm") {
if (!this.dmParticipants.has(channel.id)) {
this.dmParticipants.set(channel.id, []);
}
const participants = this.dmParticipants.get(channel.id)!;
if (!participants.includes(msg.authorIndex)) {
participants.push(msg.authorIndex);
}
}
// update min/max date
const day = Day.fromBinary(msg.dayIndex);
if (Day.lt(day, this.minDate)) this.minDate = day;
if (Day.gt(day, this.maxDate)) this.maxDate = day;
}
/** Detects languages that appear more than a threshold */
private detectLanguages(): Language[] {
// we determine which languages we have to correctly filter stopwords
const totalWithLang = this.langCounts.reduce((a, b) => a + b, 0);
return (
this.langCounts
.map((count, index) => ({ code: LanguageCodes[index], ratio: count / totalWithLang }))
// we need AT LEAST 3% to consider reliable
.filter((l) => l.ratio >= 0.03)
// sort most used
.sort((a, b) => b.ratio - a.ratio)
// only keep the code
.map((l) => l.code)
);
}
/** Filter words. Skip unfrequent words and stopwords. */
private filterWords(langs: Language[]) {
this.env.progress?.new("Filtering words...");
const numWords = this.wordsCounts.length;
for (let oldIndex = 0; oldIndex < numWords; oldIndex++) {
let skip = false;
// only keep words if they've been used more than once, IF there are too many (more than 100k words)
if (this.wordsCounts[oldIndex] <= 1 && numWords > 100000) skip = true;
// only keep words if they are not stopwords
if (this.stopwords!.isStopword(this.words.getByIndex(oldIndex)!, langs)) skip = true;
// set the count to -1 so that it gets filtered out
if (skip) this.wordsCounts[oldIndex] = -1;
this.env.progress?.progress("number", oldIndex, numWords);
}
this.env.progress?.success();
}
/**
* [+] Why indexing?
* While we process messages it is more efficient to store an index to the actual author/word/whatever
* than storing a full RawID that may potentially be a large string.
* [+] Why the burden of reindexing?
* We want to sort authors, channels and such by the number of messages they have, so it doesn't need to
* be done in the UI (also all indexes end up being nice :) )
* [+] How?
* During processing we use the index that IndexedMap provides. After all processing is done we use the
* counts to generate a mapping between the old index and the "final" ones with `rank`.
*/
private countAndReindex() {
this.env.progress?.new("Computing new indexes...");
this.guildsRank = rank(this.guildCounts);
this.channelsRank = rank(this.channelCounts);
this.authorsRank = rank(this.authorCounts);
this.wordsRank = rank(this.wordsCounts);
this.env.progress?.success();
}
/** Makes final objects for Guilds, Channels and Authors */
private makeFinalObjects() {
this.env.progress?.new("Building final objects...");
// prettier-ignore
const guilds = remap<PGuild, Guild>(
this.makeFinalGuild.bind(this),
this.guilds.values,
this.guildsRank,
this.env.progress
);
const channels = remap<PChannel, Channel>(
this.makeFinalChannel.bind(this),
this.channels.values,
this.channelsRank,
this.env.progress
);
const authors = remap<PAuthor, Author>(
this.makeFinalAuthor.bind(this),
this.authors.values,
this.authorsRank,
this.env.progress
);
// prettier-ignore
const words = remap<string, string>(
(w) => w,
this.words.values,
this.wordsRank,
this.env.progress
);
this.env.progress?.success();
return { guilds, channels, authors, words };
}
/** Transforms a parser PGuild into a final Guild */
private makeFinalGuild(guild: PGuild): Guild {
return {
// (just skips the id)
name: guild.name,
avatar: guild.avatar,
};
}
/** Transforms a parser PChannel into a final Channel */
private makeFinalChannel(channel: PChannel): Channel {
const participants = this.dmParticipants.get(channel.id) || [];
// I really don't want to do this here, but I don't
// like the alternatives right now
const formatParticipantName = (i: Index) => {
const name = this.authors.getByIndex(i)!.name;
if (name.split("#").pop()?.length === 4)
// skip Discord discriminator
return name.slice(0, -5);
return name;
};
return {
name:
channel.type !== "dm"
? // non DMs preserve the name
channel.name
: // DMs use the names of the participants "Alice & Bob"
participants.map(formatParticipantName).join(" & "),
type: channel.type,
avatar: channel.avatar,
guildIndex: this.guildsRank[this.guilds.getIndex(channel.guildId)!],
participants:
participants.length > 0
? participants.map((oldAuthorIndex) => this.authorsRank[oldAuthorIndex])
: undefined,
// the following are set making the final messages
msgAddr: undefined,
msgCount: undefined,
};
}
/** Transforms a parser PAuthor into a final Author */
private makeFinalAuthor(author: PAuthor, oldIndex: number): Author {
return {
n: author.name,
b: author.bot ? true : undefined,
// only keep avatars if the author is in the top 1000 authors
a: this.authorsRank[oldIndex] < 1000 ? author.avatar : undefined,
};
}
private compactMessagesData(channels: Channel[], dateKeys: string[]) {
this.env.progress?.new("Compacting messages data");
/** Return the minimum amount of bits needed to store a given number */
const numBitsFor = (n: number) => Math.max(1, n === 0 ? 1 : 32 - Math.clz32(n));
const bitConfig: MessageBitConfig = {
dayBits: numBitsFor(dateKeys.length),
authorIdxBits: numBitsFor(this.authors.size),
wordIdxBits: numBitsFor(this.words.size),
emojiIdxBits: numBitsFor(this.emojis.size),
mentionsIdxBits: numBitsFor(this.mentions.size),
domainsIdxBits: numBitsFor(this.domains.size),
};
const finalMessages = new MessagesArray(bitConfig);
const messageAddresses = new BigMap<RawID, BitAddress>();
const totalMessages = this.numMessages;
let alreadyCounted = 0;
for (const [id, mc] of this.messagesInChannel) {
const channelIndex = this.channelsRank[this.channels.getIndex(id)!];
const channel = channels[channelIndex];
channel.msgAddr = finalMessages.byteLength;
channel.msgCount = mc.numMessages;
for (const { id, msg } of mc.processedMessages()) {
// reindex day and author
msg.dayIndex = dateKeys.indexOf(Day.fromBinary(msg.dayIndex).dateKey);
msg.authorIndex = this.authorsRank[msg.authorIndex];
// reindex and skip words
if (msg.words) {
const newWords = new IndexCountsBuilder();
for (const [oldWordIdx, count] of msg.words) {
const newWordIndex = this.wordsRank[oldWordIdx];
// if the index is -1, the word was filtered out
if (newWordIndex >= 0) newWords.incr(newWordIndex, count);
}
msg.words = newWords.toArray();
if (msg.words.length === 0) delete msg.words;
}
// store the address of the message
messageAddresses.set(id, finalMessages.byteLength);
if (msg.replyOffset !== undefined) {
// this is a reply, lookup the original ID
const replyID = this.replyIds[msg.replyOffset];
const replyAddress = messageAddresses.get(replyID);
if (replyID !== undefined && replyAddress !== undefined) {
// the original message was found, store the address
msg.replyOffset = replyAddress;
}
}
finalMessages.push(msg);
this.env.progress?.progress("number", ++alreadyCounted, totalMessages);
}
}
this.env.progress?.success();
return { finalMessages };
}
private processCalls(dateKeys: string[]) {
const finalCalls: Call[] = [];
// copy to sort
const sourceCalls = [...this.calls.values];
sourceCalls.sort((a, b) => a.timestampStart - b.timestampStart);
for (const call of sourceCalls) {
const authorIndex = this.authorsRank[this.authors.getIndex(call.authorId)!];
const channelIndex = this.channelsRank[this.channels.getIndex(call.channelId)!];
const startDate = new Date(call.timestampStart);
const endDate = new Date(call.timestampEnd);
const startDay = Day.fromDate(startDate);
const endDay = Day.fromDate(endDate);
const duration = Math.ceil((endDate.getTime() - startDate.getTime()) / 1000);
if (startDate > endDate) {
// TODO: check why this happens
console.error("Call start date is after end date");
continue;
}
if (duration < 1) continue; // skip call
finalCalls.push({
authorIndex,
channelIndex,
start: {
dayIndex: dateKeys.indexOf(startDay.dateKey),
secondOfDay: startDate.getSeconds() + 60 * (startDate.getMinutes() + 60 * startDate.getHours()),
},
end: {
dayIndex: dateKeys.indexOf(endDay.dateKey),
secondOfDay: endDate.getSeconds() + 60 * (endDate.getMinutes() + 60 * endDate.getHours()),
},
duration,
});
}
return { finalCalls };
}
build(): Database {
if (this.numMessages === 0)
throw new Error("No messages found. Are you sure you are using the right platform?");
const langs = this.detectLanguages();
this.filterWords(langs);
this.countAndReindex();
const { guilds, channels, authors, words } = this.makeFinalObjects();
const { dateKeys, monthKeys, yearKeys } = genTimeKeys(this.minDate, this.maxDate);
const { finalMessages } = this.compactMessagesData(channels, dateKeys);
const { finalCalls } = this.processCalls(dateKeys);
return {
config: this.config,
generatedAt: new Date().toISOString(),
title: this.buildTitle(guilds, channels),
langs,
time: {
minDate: this.minDate.dateKey,
maxDate: this.maxDate.dateKey,
numDays: dateKeys.length,
numMonths: monthKeys.length,
numYears: yearKeys.length,
},
guilds,
channels,
authors,
calls: finalCalls,
words,
emojis: this.emojis.values,
mentions: this.mentions.values,
domains: this.domains.values,
messages: finalMessages.stream.buffer8,
numMessages: finalMessages.length,
bitConfig: finalMessages.bitConfig,
};
}
/** Builds the final report title. Do we want to have this here? */
private buildTitle(guilds: Guild[], channels: Channel[]): string {
// See report/components/Title.tsx
if (this.config.platform !== "discord") {
// We assume there is always only one guild.
if (channels.length === 1) return channels[0].name;
return guilds[0].name;
}
if (guilds.length > 1) {
if (guilds.some((g) => g.name === "Direct Messages")) {
return "Discord Servers and DMs";
}
return "Discord Servers";
}
const guild = guilds[0];
if (guild.name !== "Direct Messages") return guild.name;
if (channels.length === 1) return channels[0].name;
if (channels.every((c) => c.type === "dm")) return "Discord DMs";
if (channels.every((c) => c.type === "group")) return "Discord Groups";
return "Discord Chats";
}
}