webdriver-reuse-session
Version:
Manage Webdriver sessions and make sessions id's available for e.g. Protractor and other TDD and BBD tools
268 lines (267 loc) • 12.3 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.getChromeSessionId = exports.getSessionIdFromFileSync = void 0;
const axios_1 = __importDefault(require("axios"));
const wdBaseUrl = "http://localhost:4444";
const fs = __importStar(require("fs"));
/**
* This file must be moved to a separate repository,
* since it can be used across protractor projects.
*
* There will be very few changes in this file going forward
* The coding style also differs a lot.
*
* Improvements:
* 1) move to separate NPM project
* 2) stop the execution if the first is ok, don't iterate over all sessions.
*/
// tslint:disable: ter-arrow-body-style
axios_1.default.defaults.timeout = 250;
const wdUrl = (urlPath) => wdBaseUrl + urlPath;
const shouldBeHeadlessMode = false;
let logLevel = "INFO";
function levelStringToNumber(logLevelName) {
switch (logLevelName) {
case 'ERROR': return 0;
case 'WARN': return 1;
case 'INFO': return 2;
case 'DEBUG': return 3;
case 'VERBOSE': return 4;
default: throw new Error(`Unknown logLevelName '${logLevelName}' `);
}
}
const logOut = (level, ...args) => {
const logLevelId = levelStringToNumber(logLevel) + 1;
const requestedLogLevelId = levelStringToNumber(level);
// console.log(`Log levels ${logLevelId} and ${requestedLogLevelId} `)
if (requestedLogLevelId < logLevelId) {
// tslint:disable-next-line: no-console
console.log(`[${level}]`, ...args);
}
else {
// console.log("[Wont print]", level, ...args);
}
};
//const logInfo = (...args: {}[]) => console.log("INFO", ...args);
const logInfo = (...args) => logOut("INFO", ...args);
const logError = (...args) => logOut("ERROR", ...args);
const logWarning = (...args) => logOut("WARN", ...args);
const logDebug = (...args) => logOut("DEBUG", ...args);
const logVerbose = (...args) => logOut("VERBOSE", ...args);
const isArgumentFound = (argName) => process.argv.filter(arg => arg.includes(argName)).length > 0;
const directScript = process.argv.length > 1 && process.argv[1].includes('webdriver-reuse-session');
if (directScript) {
const verboseMode = isArgumentFound('verbose');
// const verbose = process.argv.filter(arg => arg.includes("verbose")).length;
if (verboseMode) {
logLevel = "VERBOSE";
logVerbose("OK - Mode is set to verbose");
logDebug("Direct Script", directScript);
}
logInfo("DirectScript is set to", directScript);
logDebug(`Process ${process.execPath} ${process.argv} `);
}
const sessionIdFileName = "./.seleniumSessionId.txt";
/** Returns the sessionId from the file, if defined
* If no file is found, or it is mallformed, it will return undefined
*/
function getSessionIdFromFileSync() {
try {
const sessionId = fs.readFileSync(sessionIdFileName, "utf8");
if (sessionId.length === 32) {
return sessionId;
}
else {
return undefined;
}
}
catch (error) {
return undefined;
}
}
exports.getSessionIdFromFileSync = getSessionIdFromFileSync;
function setSessionIdToFileSync(sessionId) {
logInfo(`Written session id '${sessionId}' to file: '${sessionIdFileName}' `);
return fs.writeFileSync(sessionIdFileName, sessionId);
}
function startChromeSessionAsync() {
return __awaiter(this, void 0, void 0, function* () {
logDebug("About to start a new chrome...");
const chromeOptions = {
w3c: false,
args: [
"--no-sandbox",
"--disable-infobars",
"--log-level=3",
"--disable-gpu",
"--window-size=1024,800",
].concat(shouldBeHeadlessMode ? ["--headless"] : []),
};
const createSessionBody = { desiredCapabilities: { browserName: "chrome", chromeOptions, w3c: false } };
const res = yield axios_1.default.post(wdUrl("/wd/hub/session"), createSessionBody, { timeout: 10000 });
logDebug("Result of starting chrome", res.data);
return res.data;
});
}
function isWebdriverRunningAsync() {
return __awaiter(this, void 0, void 0, function* () {
return new Promise((resolve) => __awaiter(this, void 0, void 0, function* () {
try {
const res = yield axios_1.default.get(wdUrl("/wd/hub/sessions"));
logDebug("Is WebDriver running response", res.statusText, res.data);
if (res.data.value) {
resolve(res.data);
}
resolve(res.data);
}
catch (error) {
logError("Error checking webdriver", error);
resolve({ status: -1, value: [] });
}
}));
});
}
function isTheChromeSessionAlive(sessionId) {
return __awaiter(this, void 0, void 0, function* () {
return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
if (sessionId.length !== 32) {
throw new Error("Chrome session id must be 32 chars " + sessionId);
}
try {
logInfo("About to call " + wdUrl(`/wd/hub/session/${sessionId}/url`));
const chromeResponse = yield axios_1.default.get(wdUrl(`/wd/hub/session/${sessionId}/url`));
logInfo("Chrome Responses session url ", chromeResponse.data);
if (chromeResponse.data.state === "success" || chromeResponse.data.status === 0) {
logDebug("Response from chrome session " + sessionId + "was" + chromeResponse.data);
resolve(true);
}
else {
logError("The chrome session did not reply success", chromeResponse.data);
resolve(false);
}
}
catch (err) {
const error = err;
logDebug(`Chrome alive check failed for session '${sessionId}' - ERROR: `, error.message);
resolve(false);
}
}));
});
}
function extractStatusFromChromeSessionsAsync(webDriverResponse) {
return __awaiter(this, void 0, void 0, function* () {
return Promise.all(webDriverResponse.value.map((session) => __awaiter(this, void 0, void 0, function* () {
const isAlive = yield isTheChromeSessionAlive(session.id);
logDebug(` - Is alive signal ${session.id} was ${isAlive} `);
return { alive: isAlive, id: session.id };
})));
});
}
function extractLivingChromeSessionsAsync(webDriverResponse) {
return __awaiter(this, void 0, void 0, function* () {
const chromeSessionStatus = yield extractStatusFromChromeSessionsAsync(webDriverResponse);
const livingChromeSessions = chromeSessionStatus.filter(session => session.alive);
return livingChromeSessions;
});
}
function killChromeSession(sessionId) {
return __awaiter(this, void 0, void 0, function* () {
logInfo("Killing session " + sessionId);
const res = axios_1.default.delete(wdUrl(`/wd/hub/session/${sessionId}`), { timeout: 30000 });
logDebug(" - done killing session " + sessionId);
return res;
});
}
function killDeadChromeSessionsAsync(webDriverResponse) {
return __awaiter(this, void 0, void 0, function* () {
const chromeSessionStatus = yield Promise.all(webDriverResponse.value.map((session) => __awaiter(this, void 0, void 0, function* () {
const isAlive = yield isTheChromeSessionAlive(session.id);
logInfo(` - Is alive signal ${session.id} was ${isAlive} `);
return { alive: isAlive, id: session.id };
})));
const livingChromeSessions = chromeSessionStatus.filter(session => !session.alive);
return livingChromeSessions;
});
}
function justTellMeTheChromeId() {
return __awaiter(this, void 0, void 0, function* () {
const webDriverResponse = yield isWebdriverRunningAsync();
if (webDriverResponse.status === -1) {
logError("Please start a webdriver-manager using webdriver-manager start");
process.exit();
}
logDebug("Wd Status", webDriverResponse.status);
if (webDriverResponse.value === undefined) {
logWarning("No WebDriver Sessions");
const res = yield startChromeSessionAsync();
logInfo("The response for starting a chrome session was", res);
return true;
}
if (webDriverResponse.value.length > 0) {
const livingChromeSessions = yield extractLivingChromeSessionsAsync(webDriverResponse);
if (livingChromeSessions && livingChromeSessions.length > 0) {
logInfo("We found the following chrome sessions ", livingChromeSessions.reduce((session) => session.id));
return livingChromeSessions[0].id;
}
}
logInfo("Ok - lets start a new chrome session");
const newSession = yield startChromeSessionAsync();
logDebug("Info - Chrome started", newSession);
const webDriverResponse_2nd = yield isWebdriverRunningAsync();
const chromeSessionStatus = yield extractStatusFromChromeSessionsAsync(webDriverResponse_2nd);
const livingChromeSessions2nd = chromeSessionStatus.filter(session => session.alive);
// const deadChromeSessions = chromeSessionStatus.filter(session => !session.alive);
// await deadChromeSessions.forEach(async session => await killChromeSession(session.id));
if (livingChromeSessions2nd.length > 0) {
return livingChromeSessions2nd[0].id;
}
else {
logError("No Chrome sessions are alive?", chromeSessionStatus);
}
});
}
if (directScript) {
const startTime = Date.now();
justTellMeTheChromeId()
.then(data => {
setSessionIdToFileSync(data);
logInfo("finally a chrome driver session id", data, "end time ", (Date.now() - startTime), "ms");
})
.catch(err => logError("Error", err));
}
exports.getChromeSessionId = justTellMeTheChromeId;