This repository has been archived by the owner on Aug 30, 2023. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
eventBuffer.ts
201 lines (165 loc) · 4.91 KB
/
eventBuffer.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
import { captureException } from '@sentry/core';
import { logger } from './util/logger';
import workerString from './worker/worker.js';
import { RecordingEvent, WorkerRequest, WorkerResponse } from './types';
interface CreateEventBufferParams {
useCompression: boolean;
}
export function createEventBuffer({ useCompression }: CreateEventBufferParams) {
if (useCompression && window.Worker) {
const workerBlob = new Blob([workerString]);
const workerUrl = URL.createObjectURL(workerBlob);
try {
logger.log('Using compression worker');
const worker = new Worker(workerUrl);
if (worker) {
return new EventBufferCompressionWorker(worker);
} else {
captureException(new Error('Unable to create compression worker'));
}
} catch {
// catch and ignore, fallback to simple event buffer
}
logger.log('Falling back to simple event buffer');
}
logger.log('Using simple buffer');
return new EventBufferArray();
}
export interface IEventBuffer {
get length(): number;
destroy(): void;
addEvent(event: RecordingEvent, isCheckout?: boolean): void;
finish(): Promise<string | Uint8Array>;
}
class EventBufferArray implements IEventBuffer {
events: RecordingEvent[];
constructor() {
this.events = [];
}
destroy() {
this.events = [];
}
get length() {
return this.events.length;
}
addEvent(event: RecordingEvent, isCheckout?: boolean) {
if (isCheckout) {
this.events = [event];
return;
}
this.events.push(event);
}
finish() {
return new Promise<string>((resolve) => {
// Make a copy of the events array reference and immediately clear the
// events member so that we do not lose new events while uploading
// attachment.
const eventsRet = this.events;
this.events = [];
resolve(JSON.stringify(eventsRet));
});
}
}
// exporting for testing
export class EventBufferCompressionWorker implements IEventBuffer {
private worker: null | Worker;
private eventBufferItemLength = 0;
private _id = 0;
constructor(worker: Worker) {
this.worker = worker;
}
/**
* Read-only incrementing counter
*/
get id() {
return this._id++;
}
/**
* Post message to worker and wait for response before resolving promise.
*/
postMessage({
id,
method,
args,
}: WorkerRequest): Promise<WorkerResponse['response']> {
return new Promise((resolve, reject) => {
const listener = ({ data }: MessageEvent<WorkerResponse>) => {
if (data.method !== method) {
return;
}
// There can be multiple listeners for a single method, the id ensures
// that the response matches the caller.
if (data.id !== id) {
return;
}
// At this point, we'll always want to remove listener regardless of result status
this.worker?.removeEventListener('message', listener);
if (!data.success) {
// TODO: Do some error handling, not sure what
logger.error(data.response);
reject(new Error('Error in compression worker'));
return;
}
resolve(data.response);
};
let stringifiedArgs;
try {
stringifiedArgs = JSON.stringify(args);
} catch (err) {
console.error(err);
stringifiedArgs = '[]';
}
// Note: we can't use `once` option because it's possible it needs to
// listen to multiple messages
this.worker?.addEventListener('message', listener);
this.worker?.postMessage({ id, method, args: stringifiedArgs });
});
}
init() {
this.postMessage({ id: this.id, method: 'init', args: [] });
logger.log('Initialized compression worker');
}
destroy() {
logger.log('Destroying compression worker');
this.worker?.terminate();
this.worker = null;
}
/**
* Note that this may not reflect what is actually in the event buffer. This
* is only a local count of the buffer size since `addEvent` is async.
*/
get length() {
return this.eventBufferItemLength;
}
async addEvent(event: RecordingEvent, isCheckout?: boolean) {
if (isCheckout) {
// This event is a checkout, make sure worker buffer is cleared before
// proceeding.
await this.postMessage({
id: this.id,
method: 'init',
args: [],
});
}
return this.sendEventToWorker(event);
}
sendEventToWorker = (event: RecordingEvent) => {
const promise = this.postMessage({
id: this.id,
method: 'addEvent',
args: [event],
});
// XXX: See note in `get length()`
this.eventBufferItemLength++;
return promise;
};
finishRequest = async (id: number) => {
const promise = this.postMessage({ id, method: 'finish', args: [] });
// XXX: See note in `get length()`
this.eventBufferItemLength = 0;
return promise as Promise<Uint8Array>;
};
finish() {
return this.finishRequest(this.id);
}
}