/
index.js
321 lines (246 loc) · 10.2 KB
/
index.js
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
import { parse as parseUrl } from 'url';
import Promise from 'pinkie';
import parseCapabilities from 'desired-capabilities';
import { Local as BrowserstackConnector } from 'browserstack-local';
import jimp from 'jimp';
import OS from 'os-family';
import nodeUrl from 'url';
import apiRequest from './api-request';
import BrowserProxy from './browser-proxy';
import delay from './utils/delay';
const TESTS_TIMEOUT = process.env['BROWSERSTACK_TEST_TIMEOUT'] || 1800;
const BROWSERSTACK_CONNECTOR_DELAY = 10000;
const MINIMAL_WORKER_TIME = 30000;
const TESTCAFE_CLOSING_TIMEOUT = 10000;
const TOO_SMALL_TIME_FOR_WAITING = MINIMAL_WORKER_TIME - TESTCAFE_CLOSING_TIMEOUT;
const ANDROID_PROXY_RESPONSE_DELAY = 500;
const PROXY_AUTH_RE = /^([^:]*)(?::(.*))?$/;
const BROWSERSTACK_API_PATHS = {
browserList: {
url: 'https://api.browserstack.com/4/browsers?flat=true'
},
newWorker: {
url: 'https://api.browserstack.com/4/worker',
method: 'POST'
},
deleteWorker: id => ({
url: `https://api.browserstack.com/4/worker/${id}`,
method: 'DELETE'
}),
screenshot: id => ({
url: `https://api.browserstack.com/4/worker/${id}/screenshot.png`,
binaryStream: true
})
};
const identity = x => x;
const capitalize = str => str[0].toUpperCase() + str.slice(1);
function copyOptions (source, destination, transfromFunc = identity) {
Object
.keys(source)
.forEach(key => source[key] && (destination[transfromFunc(key)] = source[key]));
}
function getProxyOptions (proxyConfig) {
try {
var { hostname, port, auth } = nodeUrl.parse('http://' + proxyConfig);
var parsedAuth = auth && auth.match(PROXY_AUTH_RE);
return {
host: hostname === 'undefined' ? null : hostname,
port: port,
user: parsedAuth && parsedAuth[1],
pass: parsedAuth && parsedAuth[2]
};
}
catch (e) {
return {};
}
}
function createBrowserStackConnector (accessKey) {
return new Promise((resolve, reject) => {
var connector = new BrowserstackConnector();
var parallelRuns = process.env['BROWSERSTACK_PARALLEL_RUNS'];
var opts = {
key: accessKey,
logfile: OS.win ? 'NUL' : '/dev/null',
forceLocal: !!process.env['BROWSERSTACK_FORCE_LOCAL'],
forceProxy: !!process.env['BROWSERSTACK_FORCE_PROXY'],
localIdentifier: Date.now(),
...parallelRuns ? { parallelRuns } : {},
//NOTE: additional args use different format
'enable-logging-for-api': true
};
var proxyOptions = getProxyOptions(process.env['BROWSERSTACK_PROXY']);
var localProxyOptions = getProxyOptions(process.env['BROWSERSTACK_LOCAL_PROXY']);
copyOptions(proxyOptions, opts, key => 'proxy' + capitalize(key));
copyOptions(localProxyOptions, opts, key => 'local-proxy-' + key);
connector.start(opts, err => {
if (err) {
reject(err);
return;
}
setTimeout(() => resolve(connector), BROWSERSTACK_CONNECTOR_DELAY);
});
});
}
function destroyBrowserStackConnector (connector) {
return new Promise((resolve, reject) => {
connector.stop(err => {
if (err) {
reject(err);
return;
}
resolve(connector);
});
});
}
export default {
// Multiple browsers support
isMultiBrowser: true,
connectorPromise: Promise.resolve(null),
browserProxyPromise: Promise.resolve(null),
workers: {},
platformsInfo: [],
browserNames: [],
_getConnector () {
this.connectorPromise = this.connectorPromise
.then(async connector => {
if (!connector)
connector = await createBrowserStackConnector(process.env['BROWSERSTACK_ACCESS_KEY']);
return connector;
});
return this.connectorPromise;
},
_disposeConnector () {
this.connectorPromise = this.connectorPromise
.then(async connector => {
if (connector)
await destroyBrowserStackConnector(connector);
return null;
});
return this.connectorPromise;
},
_getBrowserProxy (host, port) {
this.browserProxyPromise = this.browserProxyPromise
.then(async browserProxy => {
if (!browserProxy) {
browserProxy = new BrowserProxy(host, port, { responseDelay: ANDROID_PROXY_RESPONSE_DELAY });
await browserProxy.init();
}
return browserProxy;
});
return this.browserProxyPromise;
},
_disposeBrowserProxy () {
this.browserProxyPromise = this.browserProxyPromise
.then(async browserProxy => {
if (browserProxy)
await browserProxy.dispose();
return null;
});
return this.browserProxyPromise;
},
async _getDeviceList () {
this.platformsInfo = await apiRequest(BROWSERSTACK_API_PATHS.browserList);
this.platformsInfo.reverse();
},
_createQuery (capabilities) {
var { browserName, browserVersion, platform } = parseCapabilities(capabilities)[0];
browserName = browserName.toLowerCase();
if (browserName === 'internet explorer')
browserName = 'ie';
return {
name: browserName,
version: browserVersion.toLowerCase(),
platform: platform.toLowerCase()
};
},
_generateCapabilities (browserName) {
return this._filterPlatformInfo(this._createQuery(browserName))[0];
},
_filterPlatformInfo (query) {
return this.platformsInfo
.filter(info => {
var browserNameMatched = info['browser'] && info['browser'].toLowerCase() === query.name;
var deviceNameMatched = info['device'] && info['device'].toLowerCase() === query.name;
var browserVersionMatched = info['browser_version'] && Number(info['browser_version']) === Number(query.version);
var platformVersionMatched = info['os_version'] && Number(info['os_version']) === Number(query.version);
var platformNameMatched = info['os'].toLowerCase() === query.platform ||
`${info['os'].toLowerCase()} ${info['os_version'].toLowerCase()}` === query.platform;
var isAnyVersion = query.version === 'any';
var isAnyPlatform = query.platform === 'any';
var desktopBrowserMatched = browserNameMatched &&
(browserVersionMatched || isAnyVersion) &&
(platformNameMatched || isAnyPlatform);
var mobileBrowserMatched = deviceNameMatched &&
(platformVersionMatched || isAnyVersion);
return desktopBrowserMatched || mobileBrowserMatched;
});
},
_generateBrowserNames () {
this.browserNames = this.platformsInfo
.map(info => {
var isDesktop = !info['device'];
var name = isDesktop ? info['browser'] : info['device'];
var version = isDesktop ? info['browser_version'] : info['os_version'];
var platform = isDesktop ? `${info['os']} ${info['os_version']}` : '';
return `${name}@${version}${platform ? ':' + platform : ''}`;
});
},
// Required - must be implemented
// Browser control
async openBrowser (id, pageUrl, browserName) {
var capabilities = this._generateCapabilities(browserName);
var connector = await this._getConnector();
if (capabilities.os.toLowerCase() === 'android') {
const parsedPageUrl = parseUrl(pageUrl);
const browserProxy = await this._getBrowserProxy(parsedPageUrl.hostname, parsedPageUrl.port);
pageUrl = 'http://' + browserProxy.targetHost + ':' + browserProxy.proxyPort + parsedPageUrl.path;
}
capabilities.timeout = TESTS_TIMEOUT;
capabilities.url = pageUrl;
capabilities.name = `TestCafe test run ${id}`;
capabilities.localIdentifier = connector.localIdentifierFlag;
capabilities['browserstack.local'] = true;
this.workers[id] = await apiRequest(BROWSERSTACK_API_PATHS.newWorker, capabilities);
this.workers[id].started = Date.now();
},
async closeBrowser (id) {
var workerTime = Date.now() - this.workers[id].started;
var workerId = this.workers[id].id;
if (workerTime < MINIMAL_WORKER_TIME) {
if (workerTime < TOO_SMALL_TIME_FOR_WAITING)
await apiRequest(BROWSERSTACK_API_PATHS.deleteWorker(workerId));
await delay(MINIMAL_WORKER_TIME - workerTime);
}
await apiRequest(BROWSERSTACK_API_PATHS.deleteWorker(workerId));
},
// Optional - implement methods you need, remove other methods
// Initialization
async init () {
await this._getDeviceList();
this._generateBrowserNames();
},
async dispose () {
await this._disposeConnector();
await this._disposeBrowserProxy();
},
// Browser names handling
async getBrowserList () {
return this.browserNames;
},
async isValidBrowserName (browserName) {
return parseCapabilities(browserName).length === 1 && !!this._filterPlatformInfo(this._createQuery(browserName)).length;
},
// Extra methods
async resizeWindow (/* id, width, height, currentWidth, currentHeight */) {
this.reportWarning('The window resize functionality is not supported by the "browserstack" browser provider.');
},
async takeScreenshot (id, screenshotPath) {
return new Promise(async (resolve, reject) => {
var buffer = await apiRequest(BROWSERSTACK_API_PATHS.screenshot(this.workers[id].id));
jimp
.read(buffer)
.then(image => image.write(screenshotPath, resolve))
.catch(reject);
});
}
};