protractor-sync-options-plugin
Version:
Protractor plugin to ignore specific async calls in angular application
499 lines (463 loc) • 23.9 kB
JavaScript
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('protractor')) :
typeof define === 'function' && define.amd ? define('protractor-sync-options-plugin', ['exports', 'protractor'], factory) :
(global = global || self, factory(global['protractor-sync-options-plugin'] = {}, global.protractor));
}(this, (function (exports, protractor) { 'use strict';
/*! *****************************************************************************
Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at http://www.apache.org/licenses/LICENSE-2.0
THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
MERCHANTABLITY OR NON-INFRINGEMENT.
See the Apache Version 2.0 License for specific language governing permissions
and limitations under the License.
***************************************************************************** */
/* global Reflect, Promise */
var extendStatics = function(d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
function __extends(d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
}
var __assign = function() {
__assign = Object.assign || function __assign(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
function __rest(s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
}
function __decorate(decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
}
function __param(paramIndex, decorator) {
return function (target, key) { decorator(target, key, paramIndex); }
}
function __metadata(metadataKey, metadataValue) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(metadataKey, metadataValue);
}
function __awaiter(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());
});
}
function __generator(thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
}
function __exportStar(m, exports) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
function __values(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m) return m.call(o);
if (o && typeof o.length === "number") return {
next: function () {
if (o && i >= o.length) o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
}
function __read(o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
}
function __spread() {
for (var ar = [], i = 0; i < arguments.length; i++)
ar = ar.concat(__read(arguments[i]));
return ar;
}
function __spreadArrays() {
for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;
for (var r = Array(s), k = 0, i = 0; i < il; i++)
for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)
r[k] = a[j];
return r;
};
function __await(v) {
return this instanceof __await ? (this.v = v, this) : new __await(v);
}
function __asyncGenerator(thisArg, _arguments, generator) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var g = generator.apply(thisArg, _arguments || []), i, q = [];
return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
function fulfill(value) { resume("next", value); }
function reject(value) { resume("throw", value); }
function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
}
function __asyncDelegator(o) {
var i, p;
return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === "return" } : f ? f(v) : v; } : f; }
}
function __asyncValues(o) {
if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
var m = o[Symbol.asyncIterator], i;
return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
}
function __makeTemplateObject(cooked, raw) {
if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
return cooked;
};
function __importStar(mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
result.default = mod;
return result;
}
function __importDefault(mod) {
return (mod && mod.__esModule) ? mod : { default: mod };
}
function __classPrivateFieldGet(receiver, privateMap) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to get private field on non-instance");
}
return privateMap.get(receiver);
}
function __classPrivateFieldSet(receiver, privateMap, value) {
if (!privateMap.has(receiver)) {
throw new TypeError("attempted to set private field on non-instance");
}
privateMap.set(receiver, value);
return value;
}
/**
* set of functions, that can be executed by client/frontend.
* every function must be "all inclusive" without any references to outside,
* because they are transferred as text to client by selenium.
*/
var patchTestability_1 = patchTestability;
var restoreTestability_1 = restoreTestability;
/**
* (monkey)patches, if not already patched, angular.testability#whenStable, to be able to ignore some async tasks
* @param {IgnoreTask[]} ignoreTasks ignore filter tasks definitions
*/
function patchTestability(ignoreTasks) {
if (!window.getAllAngularTestabilities) {
throw Error('Testability not found. Not an angular app?');
}
var testability = window.getAllAngularTestabilities()[0]; // TODO all apps
var Testability = testability.constructor;
var isStableOrig = Testability.prototype.isStable;
if (!!isStableOrig.originalFn) {
throw Error('Testability already patched');
}
var newIsStable = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
var isStable = isStableOrig.apply(this, args);
var isStableWithoutFiltered = hasOnlyFilteredTasks(testability);
return isStable || isStableWithoutFiltered;
};
newIsStable.originalFn = isStableOrig;
Testability.prototype.isStable = newIsStable;
// -----------------------------------------------------
// helpers
// -----------------------------------------------------
function matchesSource(/** PendingMacrotask */ task, /** IgnoreTask */ ignoreTask) {
return task.source === ignoreTask.source;
}
function isSourceDefined(/** IgnoreTask */ ignoreTask) {
var source = ignoreTask.source;
return (typeof source === 'string') || (source instanceof RegExp);
}
function matchesLocation(/** PendingMacrotask */ task, /** IgnoreTask */ ignoreTask) {
var locationFilter = ignoreTask.creationLocation;
var callLocations = getCallLocations(task);
return callLocations.some(function (callLocation) {
if (locationFilter instanceof RegExp) {
return callLocation.match(locationFilter);
}
if (typeof locationFilter === 'string') {
return callLocation.includes(locationFilter);
}
});
}
function isLocationDefined(/** IgnoreTask */ ignoreTask) {
var loc = ignoreTask.creationLocation;
return (typeof loc === 'string') || (loc instanceof RegExp);
}
/**
* @param {PendingMacrotask} task task to check
* @param {IgnoreTask} ignoreTask matching conditions
* @return {boolean} true if all defined condition properties of `ignoreTask` matches (conjunction)
*/
function areMatching(task, ignoreTask) {
var result = true;
if (isSourceDefined(ignoreTask)) {
result &= matchesSource(task, ignoreTask);
}
if (isLocationDefined(ignoreTask)) {
result &= matchesLocation(task, ignoreTask);
}
return result;
}
function getCallLocations(/** PendingMacrotask */ task) {
return task.creationLocation.stack.split(' at ');
}
function shouldIgnore(/** PendingMacrotask */ t) {
return ignoreTasks.some(function (it) { return (areMatching(t, it)); });
}
function hasOnlyFilteredTasks(testability) {
var trZone = testability['taskTrackingZone']; // private prop TODO use any api?
var tasks = trZone.macroTasks;
return tasks.every(shouldIgnore);
}
}
/**
* restores patched whenStable function to original, if patched.
*/
function restoreTestability() {
if (!window.getAllAngularTestabilities) {
throw Error('Testability not found. Not an angular app?');
}
var testability = window.getAllAngularTestabilities()[0]; // TODO all apps
var Testability = testability.constructor;
var isStableFn = Testability.prototype.isStable;
if (!isStableFn.originalFn) {
throw Error('Cant restore, Testability.whenStable is not patched');
}
Testability.prototype.isStable = isStableFn.originalFn;
}
var clientScripts = {
patchTestability: patchTestability_1,
restoreTestability: restoreTestability_1
};
/**
* makes monkey-patching for protractor and frontend angular.testability
* @TODO find a way to use some api instead of monkey-patching
*/
var Patcher = /** @class */ (function () {
function Patcher(browser) {
this.browser = browser;
}
/**
*
* @param config config to use
* @returns `true` in success case, `false` otherwise (e.g. already patched)
*/
Patcher.prototype.patchClientTestability = function (config) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.browser.executeScript(patchTestability_1, config.ignoreTasks || [])];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* restores patched with {@link this#patchClientTestability} client
*/
Patcher.prototype.restoreClientTestability = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, this.browser.executeScript(restoreTestability_1)];
});
});
};
/**
* patches {@link browser#waitForAngular}
* @returns `true` in success case, `false` otherwise (e.g. already patched)
*/
Patcher.prototype.patchWaitForAngularEnabled = function (config) {
return __awaiter(this, void 0, void 0, function () {
var origFn, thisPlugin, newFn;
return __generator(this, function (_a) {
if (this.isWaitForAngularPatched()) {
throw Error('browser.waitForAngularEnabled is already patched');
}
origFn = this.browser.constructor.prototype.waitForAngularEnabled;
thisPlugin = this;
newFn = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!(args[0] === true)) return [3 /*break*/, 2];
return [4 /*yield*/, thisPlugin.patchClientTestability(config).catch(function (e) {
console.warn('patched waitForAngularEnabled => patchClientTestability error:', e); // TODO logger
})];
case 1:
_a.sent();
_a.label = 2;
case 2: return [2 /*return*/, origFn.apply(this, args)];
}
});
});
};
newFn.orignalFn = origFn;
this.browser.constructor.prototype.waitForAngularEnabled = newFn;
return [2 /*return*/];
});
});
};
Patcher.prototype.restoreWaitForAngularEnabled = function () {
return __awaiter(this, void 0, void 0, function () {
var proto;
return __generator(this, function (_a) {
if (!this.isWaitForAngularPatched()) {
throw Error('Cant restore. this.browser.constructor.prototype.waitForAngularEnabled is not patched');
}
proto = this.browser.constructor.prototype;
proto.waitForAngularEnabled = proto.waitForAngularEnabled.originalFn;
return [2 /*return*/];
});
});
};
Patcher.prototype.isWaitForAngularPatched = function () {
return !!this.browser.constructor.prototype.waitForAngularEnabled.originalFn; // better check?
};
return Patcher;
}());
var SyncOptionsPlugin = /** @class */ (function () {
function SyncOptionsPlugin() {
this.name = 'Protractor Sync Options Plugin';
this.patcher = new Patcher(protractor.browser);
}
SyncOptionsPlugin.prototype.onPageLoad = function (currBrowser) {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.trySafe(function () { return _this.patcher.patchClientTestability(_this.config); })];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
SyncOptionsPlugin.prototype.setup = function () {
return __awaiter(this, void 0, void 0, function () {
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
this.patcher.browser = protractor.browser;
return [4 /*yield*/, this.trySafe(function () { return _this.patcher.patchWaitForAngularEnabled(_this.config); })];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
/**
* safe function call
* shows only warning in function error case
* @returns `false` if `funcToCall` throws an error, `true` otherwise
*/
SyncOptionsPlugin.prototype.trySafe = function (funcToCall) {
return __awaiter(this, void 0, void 0, function () {
var e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, funcToCall()];
case 1:
_a.sent();
return [2 /*return*/, true];
case 2:
e_1 = _a.sent();
console.warn('function call failed', e_1); // TODO logger;
return [2 /*return*/, false];
case 3: return [2 /*return*/];
}
});
});
};
return SyncOptionsPlugin;
}());
// workaround to export the plugin instance from package require
var initializedPlugin = new SyncOptionsPlugin();
Object.assign(exports, initializedPlugin);
exports.setup = initializedPlugin.setup;
exports.onPageLoad = initializedPlugin.onPageLoad;
exports.trySafe = initializedPlugin.trySafe;
var plugin = exports; // need to usual 'import' initialized plugin
exports.Patcher = Patcher;
exports.SyncOptionsPlugin = SyncOptionsPlugin;
exports.plugin = plugin;
Object.defineProperty(exports, '__esModule', { value: true });
})));
//# sourceMappingURL=protractor-sync-options-plugin.umd.js.map