forked from nightwatchjs/nightwatch
/
index.js
501 lines (392 loc) · 12.9 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
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
const ora = require('ora');
const {Builder, Browser, error} = require('selenium-webdriver');
const Actions = require('./actions.js');
const SeleniumCapabilities = require('./options.js');
const {Logger, isObject, IosSessionNotCreatedError, AndroidConnectionError} = require('../../utils');
const httpClient = require('./httpclient.js');
const Session = require('./session.js');
const BaseTransport = require('../');
const {colors} = Logger;
const {isErrorResponse, checkLegacyResponse, throwDecodedError, WebDriverError} = error;
let _driverService = null;
let _driver = null;
class Transport extends BaseTransport {
/**
* @param {Builder} builder
* @param {Capabilities} options
*/
static setBuilderOptions({builder, options}) {
switch (options.getBrowserName()) {
case Browser.CHROME:
builder.setChromeOptions(options);
break;
case Browser.FIREFOX:
builder.setFirefoxOptions(options);
break;
case Browser.SAFARI:
builder.setSafariOptions(options);
break;
case Browser.EDGE:
builder.setEdgeOptions(options);
break;
case Browser.OPERA:
// TODO: implement
break;
case Browser.INTERNET_EXPLORER:
builder.setIeOptions(options);
break;
}
}
static get driver() {
return _driver;
}
static set driver(value) {
_driver = value;
}
static get driverService() {
return _driverService;
}
static set driverService(value) {
_driverService = value;
}
/**
* @override
*/
get ServiceBuilder() {
return null;
}
get defaultPort() {
return this.ServiceBuilder ? this.ServiceBuilder.defaultPort : 4444;
}
get Actions() {
return this.actionsInstance.actions;
}
get reporter() {
return this.nightwatchInstance.reporter;
}
get api() {
return this.nightwatchInstance.api;
}
get settings() {
return this.nightwatchInstance.settings;
}
get desiredCapabilities() {
return this.settings.desiredCapabilities;
}
get defaultPathPrefix() {
return '';
}
get outputEnabled() {
return this.settings.output;
}
get usingSeleniumServer() {
return this.settings.selenium && this.settings.selenium.start_process;
}
get shouldStartDriverService() {
return this.settings.webdriver.start_process;
}
get serviceName() {
return this.ServiceBuilder.serviceName;
}
get elementKey() {
return this.__elementKey || Session.WEB_ELEMENT_ID;
}
get initialCapabilities() {
return this.seleniumCapabilities.initialCapabilities;
}
get parallelMode() {
return this.settings.testWorkersEnabled;
}
constructor(nightwatchInstance, {isSelenium = false, browserName} = {}) {
super(nightwatchInstance);
this.nightwatchInstance = nightwatchInstance;
this.browserName = browserName;
this.seleniumCapabilities = new SeleniumCapabilities({
settings: this.settings,
browserName
});
this.createHttpClient();
this.createActions();
}
/**
* @override
*/
setBuilderOptions({options, builder}) {
Transport.setBuilderOptions({options, builder});
}
createActions() {
this.actionsInstance = new Actions(this);
this.actionsInstance.loadActions();
}
createHttpClient() {
const http = require('selenium-webdriver/http');
http.HttpClient = httpClient(this.settings, http.Response);
}
getServerUrl() {
if (this.shouldStartDriverService) {
return this.defaultServerUrl;
}
return this.settings.webdriver.url;
}
////////////////////////////////////////////////////////////////////
// Session related
////////////////////////////////////////////////////////////////////
async closeDriver() {
if (this.driverService) {
try {
await this.driverService.stop();
this.driverService = null;
this.stopped = true;
} catch (err) {
Logger.error(err);
err.displayed = true;
throw err;
}
}
}
async sessionFinished(reason) {
this.emit('session:finished', reason);
await this.closeDriver();
}
async createDriverService({options, moduleKey, reuseBrowser = false}) {
try {
moduleKey = this.settings.webdriver.log_file_name || moduleKey || '';
if (!this.shouldReuseDriverService(reuseBrowser)) {
Transport.driverService = new this.ServiceBuilder(this.settings);
await Transport.driverService.setOutputFile(reuseBrowser ? 'test' : moduleKey).init(options);
}
this.driverService = Transport.driverService;
} catch (err) {
this.showConnectSpinner(colors.red(`Failed to start ${this.serviceName}.`), 'warn');
throw err;
}
}
shouldReuseDriverService(reuseBrowser) {
return (Transport.driverService && !Transport.driverService.stopped && reuseBrowser);
}
async getDriver({options, reuseBrowser = false}) {
const value = await this.shouldReuseDriver(reuseBrowser);
if (value) {
return Transport.driver;
}
Transport.driver = await this.createDriver({options});
return Transport.driver;
}
async shouldReuseDriver(reuseBrowser) {
if (!reuseBrowser || !Transport.driver) {
return false;
}
try {
await Transport.driver.getSession();
return true;
} catch (err) {
return false;
}
}
/**
* @param {Capabilities} options
* @returns {Builder}
*/
createSessionBuilder(options) {
const builder = new Builder();
builder.disableEnvironmentOverrides();
this.setBuilderOptions({builder, options});
return builder;
}
createSessionOptions(argv) {
return this.seleniumCapabilities.create(argv);
}
createDriver({options}) {
const builder = this.createSessionBuilder(options);
this.builder = builder;
return builder.build();
}
async createSession({argv, moduleKey, reuseBrowser = false}) {
const startTime = new Date();
const {host, port, start_process} = this.settings.webdriver;
const portStr = port ? `port ${port}` : 'auto-generated port';
const options = await this.createSessionOptions(argv);
if (start_process) {
if (this.usingSeleniumServer) {
options.showSpinner = (msg) => {
this.showConnectSpinner(msg);
};
} else {
this.showConnectSpinner(`Starting ${this.serviceName} on ${portStr}...\n`);
}
await this.createDriverService({options, moduleKey, reuseBrowser});
} else {
this.showConnectSpinner(`Connecting to ${host} on ${portStr}...\n`);
}
try {
this.driver = await this.getDriver({options, reuseBrowser});
const session = new Session(this.driver);
const sessionExports = await session.exported();
const {sessionInfo, sessionId, capabilities, elementKey} = sessionExports;
this.__elementKey = elementKey;
await this.showConnectInfo({startTime, host, port, start_process, sessionInfo});
return {
sessionId,
capabilities
};
} catch (err) {
const error = this.handleConnectError(err);
this.showConnectSpinner(colors.red(`Failed to connect to ${this.serviceName} on ${host} with ${colors.stack_trace(portStr)}.`), 'warn');
throw error;
}
}
////////////////////////////////////////////////////////////////////
// Output related
////////////////////////////////////////////////////////////////////
async showConnectInfo({startTime, port, host, start_process, sessionInfo}) {
if (!this.parallelMode) {
this.showConnectSpinner(`Connected to ${colors.stack_trace(start_process ? this.serviceName : host)} on port ${colors.stack_trace(port)} ${colors.stack_trace('(' + (new Date() - startTime) + 'ms)')}.`);
}
if (this.outputEnabled) {
const {platform, browserVersion, platformVersion, browserName} = sessionInfo;
// eslint-disable-next-line no-console
console.info(` Using: ${colors.light_blue(browserName)} ${colors.brown('(' + (browserVersion) + ')')} on ${colors.cyan(platform.toUpperCase() + (platformVersion ? (' (' + platformVersion + ')') : ''))}.\n`);
}
}
showConnectSpinner(msg, method = 'info') {
if (!this.outputEnabled || this.parallelMode) {
return;
}
if (this.connectSpinner) {
this.connectSpinner[method](msg);
} else {
this.connectSpinner = ora(msg).start();
}
}
////////////////////////////////////////////////////////////////////
// Elements related
////////////////////////////////////////////////////////////////////
getElementId(resultValue) {
return resultValue[this.elementKey];
}
toElement(resultValue) {
return {[this.elementKey]: resultValue};
}
mapWebElementIds(value) {
if (Array.isArray(value)) {
return value.reduce((prev, item) => {
prev.push(this.getElementId(item));
return prev;
}, []);
}
return value;
}
/**
* Helper method
*
* @param {String} protocolAction
* @param {Object} executeArgs
* @return {Promise}
*/
executeProtocolAction(protocolAction, executeArgs) {
if (isObject(protocolAction) && protocolAction.actionName) {
const {actionName, args, sessionId = this.nightwatchInstance.sessionId} = protocolAction;
return this.Actions.session[actionName]({
args,
sessionId,
sessionRequired: true
});
}
return this.Actions.session[protocolAction]({
args: executeArgs,
sessionId: this.nightwatchInstance.sessionId,
sessionRequired: true
});
}
////////////////////////////////////////////////////////////////////
// Error handling
////////////////////////////////////////////////////////////////////
handleErrorResponse(result) {
if (isErrorResponse(result)) {
// will throw error if w3c response
throwDecodedError(result);
// will throw error if legacy response
checkLegacyResponse(result);
}
}
registerLastError(err, retryCount = 0) {
this.lastError = err;
this.retriesCount = retryCount;
}
getErrorMessage(result) {
if (result instanceof Error) {
return result.message;
}
return result.value && result.value.message;
}
handleConnectError(err) {
const errMsg = `An error occurred while creating a new ${this.serviceName} session:`;
switch (err.code) {
case 'ECONNREFUSED':
err.sessionCreate = true;
err.message = `${errMsg} ${err.message.replace('ECONNREFUSED connect ECONNREFUSED', 'Connection refused to')}. If the Webdriver/Selenium service is managed by Nightwatch, check if "start_process" is set to "true".`;
break;
default:
err.message = `${errMsg} [${err.name}] ${err.message}`;
}
if (!err.detailedErr && this.driverService) {
const logPath = this.driverService.getOutputFilePath();
err.detailedErr = ` Verify if ${this.serviceName} is configured correctly; using:\n ${this.driverService.getSettingsFormatted()}\n`;
err.extraDetail = (logPath ? `\n More info might be available in the log file: ${logPath}` : `\n Set webdriver.log_path in your Nightwatch config to retrieve more logs from ${this.serviceName}.`);
if (err.message.includes('Failed to run adb command') || err.message.includes('no devices online')) {
return new AndroidConnectionError(err);
}
if (err.name === 'SessionNotCreatedError' && this.api.isSafari() && this.api.isIOS()) {
return new IosSessionNotCreatedError(err, this.desiredCapabilities);
}
}
err.showTrace = false;
err.reportShown = true;
return err;
}
isResultSuccess(result = {}) {
return !(
(result instanceof Error) ||
(result.error instanceof Error) ||
result.status === -1
);
}
getOutputFilePath() {
return this.driverService.getOutputFilePath();
}
getErrorResponse(result) {
return result instanceof Error ? result : result.error;
}
staleElementReference(result) {
return result instanceof error.StaleElementReferenceError;
}
elementClickInterceptedError(result) {
return result instanceof error.ElementClickInterceptedError;
}
invalidElementStateError(result) {
return result instanceof error.InvalidElementStateError;
}
elementNotInteractableError(result) {
return result instanceof error.ElementNotInteractableError;
}
invalidWindowReference(result) {
return result instanceof error.NoSuchWindowError;
}
invalidSessionError(result) {
return result instanceof error.NoSuchSessionError;
}
isRetryableElementError(result) {
const errorResponse = this.getErrorResponse(result);
if (errorResponse instanceof WebDriverError && errorResponse.name === 'WebDriverError') {
const errors = this.getRetryableErrorMessages();
return errors.some(item => errorResponse.message.includes(item));
}
return (
this.staleElementReference(errorResponse) ||
this.elementClickInterceptedError(errorResponse) ||
this.invalidElementStateError(errorResponse) ||
this.elementNotInteractableError(errorResponse)
);
}
}
module.exports = Transport;