-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.ts
219 lines (192 loc) · 5.16 KB
/
index.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
import EventEmitter from "events";
import {Worker} from "worker_threads";
import path from "path";
export interface MLabSpeedTestServerDiscovery {
loadbalancer: URL;
}
export interface MLabSpeedTestServerInfo {
machine: string;
location: {
city: string;
country: string;
};
urls: {
[key: string]: string;
};
}
export interface MLabSpeedTestDownloadStart {
ClientStartTime: number
}
export type MLabSpeedTestMeasurement =
MLabSpeedTestMeasurementClient
| MLabSpeedTestMeasurementServer;
export interface MLabSpeedTestMeasurementClient {
Source: 'client';
Data: {
ElapsedTime: number;
NumBytes: number;
MeanClientMbps: number;
};
}
export interface MLabSpeedTestConnectionInfo {
Client: string;
Server: string;
UUID: string;
}
export interface MLabSpeedTestBBRInfo {
BW: number;
MinRTT: number;
PacingGain: number;
CwndGain: number;
ElapsedTime: number;
}
export interface MLabSpeedTestTCPInfo {
State: number;
CAState: number;
Retransmits: number;
Probes: number;
Backoff: number;
Options: number;
WScale: number;
AppLimited: number;
RTO: number;
ATO: number;
SndMSS: number;
RcvMSS: number;
Unacked: number;
Sacked: number;
Lost: number;
Retrans: number;
Fackets: number;
LastDataSent: number;
LastAckSent: number;
LastDataRecv: number;
LastAckRecv: number;
PMTU: number;
RcvSsThresh: number;
RTT: number;
RTTVar: number;
SndSsThresh: number;
SndCwnd: number;
AdvMSS: number;
Reordering: number;
RcvRTT: number;
RcvSpace: number;
TotalRetrans: number;
PacingRate: number;
MaxPacingRate: number;
BytesAcked: number;
BytesReceived: number;
SegsOut: number;
SegsIn: number;
NotsentBytes: number;
MinRTT: number;
DataSegsIn: number;
DataSegsOut: number;
DeliveryRate: number;
BusyTime: number;
RWndLimited: number;
SndBufLimited: number;
Delivered: number;
DeliveredCE: number;
BytesSent: number;
BytesRetrans: number;
DSackDups: number;
ReordSeen: number;
RcvOooPack: number;
SndWnd: number;
ElapsedTime: number;
}
export interface MLabSpeedTestMeasurementServer {
Source: 'server';
Data: {
ConnectionInfo: MLabSpeedTestConnectionInfo;
BBRInfo: MLabSpeedTestBBRInfo;
TCPInfo: MLabSpeedTestTCPInfo;
};
}
export interface MLabSpeedTestComplete {
LastClientMeasurement?: {
ElapsedTime: number;
NumBytes: number;
MeanClientMbps: number;
};
LastServerMeasurement?: {
ConnectionInfo: MLabSpeedTestConnectionInfo;
BBRInfo: MLabSpeedTestBBRInfo;
TCPInfo: MLabSpeedTestTCPInfo;
};
}
export interface MLabSpeedTestUploadStart {
StartTime: number;
ExpectedEndTime: number;
}
export declare interface MLabSpeedTest {
on(event: 'server-discovery', listener: (data: MLabSpeedTestServerDiscovery) => void): this;
on(event: 'server-chosen', listener: (serverInfo: MLabSpeedTestServerInfo) => void): this;
on(event: 'download-start', listener: (data: MLabSpeedTestDownloadStart) => void): this;
on(event: 'download-measurement', listener: (data: MLabSpeedTestMeasurement) => void): this;
on(event: 'download-complete', listener: (data: MLabSpeedTestComplete) => void): this;
on(event: 'upload-start', listener: (data: MLabSpeedTestUploadStart) => void): this;
on(event: 'upload-measurement', listener: (data: MLabSpeedTestMeasurement) => void): this;
on(event: 'upload-complete', listener: (data: MLabSpeedTestComplete) => void): this;
on(event: 'complete', listener: (exitCode?: number) => void): this;
on(event: 'error', listener: (err: Error) => void): this;
}
/**
* M-Lab's Speed Test command.
*/
export class MLabSpeedTest extends EventEmitter {
private _running = false;
private _worker?: Worker;
constructor() {
super();
}
/**
* Checks if M-Lab's Speed Test is running.
*/
get running() {
return this._running;
};
/**
* Starts the M-Lab's Speed Test.
*
* @return {number} Zero on success, non-zero error code on failure or `undefined` if the speed test is already running.
*/
async run(): Promise<number | undefined> {
if (this._running) return;
this._running = true;
// Because ndt7.test() returns a Promise<number> and it cannot be stopped,
// I wrap it in a Worker, so it could be stopped using the '.terminate()' Worker method.
this._worker = new Worker(
__dirname.endsWith('src') ? path.join(__dirname, '..', 'lib', 'worker.js') : path.join(__dirname, 'worker.js')
);
return new Promise<number | undefined>((resolve, _) => {
this._worker?.on('message', (values: [string, ...any]) => {
const event = values[0];
this.emit(event, ...values.slice(1));
if (event === 'complete') {
this._running = false;
resolve(values[1] as number);
return;
}
});
this._worker?.on('error', (err: Error) => {
this.emit('error', err);
});
this._worker?.on('exit', (code?: number) => {
this.emit('complete', code);
this._running = false;
resolve(code);
});
});
}
/**
* Stops the M-Lab's Speed Test.
*/
async stop() {
await this._worker?.terminate();
this._worker = undefined;
this._running = false;
}
}