accessibility-checker
Version:
An automated testing tools for accessibility testing using Puppeteer, Selenium, or Zombie
304 lines • 16.1 kB
JavaScript
;
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 __generator = (this && this.__generator) || function (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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ACEngineManager = void 0;
var ACConfigManager_1 = require("./ACConfigManager");
var path = require("path");
var fs = require("fs");
var axios_1 = require("axios");
var ace;
var checker;
var ACEngineManager = /** @class */ (function () {
function ACEngineManager() {
}
ACEngineManager.loadEngine = function (content) {
return __awaiter(this, void 0, void 0, function () {
var config, page, browser, scriptStr, manage;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4 /*yield*/, ACConfigManager_1.ACConfigManager.getConfigUnsupported()];
case 1:
config = _b.sent();
if (!(ACEngineManager.isPuppeteer(content) || ACEngineManager.isPlaywright(content))) return [3 /*break*/, 3];
config.DEBUG && console.log("[INFO] aChecker.loadEngine detected Puppeteer/Playwright");
page = content;
return [4 /*yield*/, page.evaluate(function (scriptUrl) {
try {
var ace_backup_in_ibma;
if ('undefined' !== typeof (ace)) {
if (!ace || !ace.Checker)
ace_backup_in_ibma = ace;
ace = null;
}
if ('undefined' === typeof (ace) || ace === null) {
return new Promise(function (resolve, reject) {
var script = document.createElement('script');
script.setAttribute('type', 'text/javascript');
script.setAttribute('aChecker', 'ACE');
script.setAttribute('src', scriptUrl);
script.addEventListener('load', function () {
globalThis.ace_ibma = ace;
if ('undefined' !== typeof (ace)) {
ace = ace_backup_in_ibma;
}
resolve();
});
var heads = document.getElementsByTagName('head');
if (heads.length > 0) {
heads[0].appendChild(script);
}
else if (document.body) {
document.body.appendChild(script);
}
else {
Promise.reject("Invalid document");
}
});
}
}
catch (e) {
return Promise.reject(e);
}
}, "".concat(config.rulePack, "/ace.js"))];
case 2:
_b.sent();
return [2 /*return*/, ACEngineManager.loadEngineLocal()];
case 3:
if (ACEngineManager.isSelenium(content)) {
config.DEBUG && console.log("[INFO] aChecker.loadEngine detected Selenium");
try {
browser = content;
scriptStr = "let cb = arguments[arguments.length - 1];\ntry {\n var ace_backup_in_ibma;\n if ('undefined' !== typeof(ace)) {\n if (!ace || !ace.Checker) \n ace_backup_in_ibma = ace;\n ace = null; \n } \n if ('undefined' === typeof (ace) || ace === null) {\n let script = document.createElement('script');\n script.setAttribute('type', 'text/javascript');\n script.setAttribute('aChecker', 'ACE');\n script.setAttribute('src', '".concat(config.rulePack, "/ace.js');\n script.addEventListener('load', function() {\n globalThis.ace_ibma = ace;\n if ('undefined' !== typeof(ace)) {\n ace = ace_backup_in_ibma;\n } \n cb();\n });\n let heads = document.getElementsByTagName('head');\n if (heads.length > 0) { heads[0].appendChild(script); }\n else { document.body.appendChild(script); }\n } else {\n cb();\n }\n} catch (e) {\n cb(e);\n}\n");
manage = browser.manage();
if (manage.timeouts) {
manage.timeouts().setScriptTimeout(60000);
}
else if (manage.setTimeouts) {
manage.setTimeouts({
"script": 60000
});
}
return [2 /*return*/, browser.executeAsyncScript(scriptStr).then(function (return_success) {
return ACEngineManager.loadEngineLocal();
}).catch(function (err) {
console.log(err);
})];
}
catch (e) {
console.log(e);
}
}
else {
config.DEBUG && console.log("[INFO] aChecker.loadEngine detected local");
if (globalThis.ace_ibma) {
return [2 /*return*/, Promise.resolve()];
}
else {
return [2 /*return*/, ACEngineManager.loadEngineLocal()];
}
}
_b.label = 4;
case 4: return [2 /*return*/];
}
});
});
};
ACEngineManager.loadEngineLocal = function () {
return __awaiter(this, void 0, void 0, function () {
var config, response, data, engineDir;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (globalThis.ace_ibma) {
return [2 /*return*/, Promise.resolve()];
}
return [4 /*yield*/, ACConfigManager_1.ACConfigManager.getConfigUnsupported()];
case 1:
config = _b.sent();
return [4 /*yield*/, axios_1.default.get("".concat(config.rulePack, "/ace-node.js"))];
case 2:
response = _b.sent();
return [4 /*yield*/, response.data];
case 3:
data = _b.sent();
engineDir = path.join(config.cacheFolder, "engine");
if (!fs.existsSync(engineDir)) {
fs.mkdirSync(engineDir, { recursive: true });
}
return [4 /*yield*/, new Promise(function (resolve, reject) {
var nodePath = path.join(engineDir, "ace-node");
fs.writeFile(nodePath + ".js", data, function (err) {
try {
if (nodePath.charAt(0) !== '/') {
nodePath = "../../" + nodePath;
}
err && console.log(err);
var ace_ibma = require(nodePath);
checker = new ace_ibma.Checker();
}
catch (e) {
console.log(e);
return reject(e);
}
resolve();
});
})];
case 4:
_b.sent();
return [2 /*return*/];
}
});
});
};
ACEngineManager.isPuppeteer = function (content) {
if (content && content.constructor) {
return !!content.constructor.toString().match(/Function: Page/)
|| content.constructor.toString().includes("Puppeteer");
}
return false;
};
ACEngineManager.isPlaywright = function (content) {
if (content && content.constructor) {
return !!content.constructor.toString().match(/class Page /);
}
return false;
};
ACEngineManager.isSelenium = function (content) {
if (content && content.constructor) {
return content.constructor.toString().indexOf("Driver") !== -1 ||
// check required for selenium >= 3.0.1
(content.constructor.name && content.constructor.name.indexOf("Driver") !== -1);
}
return false;
};
/**
* This function is responsible for building the full help file URL using rule server.
*
* @param {String} helpFileName - Provide the help file name
*
* @return {String} helpFileName - The full help file URL
*
* PRIVATE METHOD
*
* @memberOf this
*/
ACEngineManager.getHelpURL = function (issue) {
var config = ACConfigManager_1.ACConfigManager.getConfigNow();
var helpUrl = checker.engine.getHelp(issue.ruleId, issue.reasonId, config.ruleArchive);
var minIssue = {
message: issue.message,
snippet: issue.snippet,
value: issue.value,
reasonId: issue.reasonId,
ruleId: issue.ruleId,
msgArgs: issue.msgArgs
};
return "".concat(helpUrl, "#").concat(encodeURIComponent(JSON.stringify(minIssue)));
};
;
ACEngineManager.getChecker = function () {
return checker;
};
var _a;
_a = ACEngineManager;
ACEngineManager.customRulesets = [];
ACEngineManager.addRuleset = function (ruleset) {
ACEngineManager.customRulesets.push(ruleset);
};
ACEngineManager.getRuleset = function (rsId) { return __awaiter(void 0, void 0, void 0, function () {
return __generator(_a, function (_b) {
switch (_b.label) {
case 0:
if (!!checker) return [3 /*break*/, 2];
return [4 /*yield*/, ACEngineManager.loadEngineLocal()];
case 1:
_b.sent();
_b.label = 2;
case 2: return [2 /*return*/, ACEngineManager.customRulesets.concat(checker.rulesets).filter((function (rs) { return rs.id === rsId; }))[0]];
}
});
}); };
ACEngineManager.getRulesets = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!!checker) return [3 /*break*/, 2];
return [4 /*yield*/, ACEngineManager.loadEngineLocal()];
case 1:
_b.sent();
_b.label = 2;
case 2: return [2 /*return*/, ACEngineManager.customRulesets.concat(checker.rulesets)];
}
});
});
};
ACEngineManager.getRules = function () {
return __awaiter(this, void 0, void 0, function () {
var retVal, ruleId;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!!checker) return [3 /*break*/, 2];
return [4 /*yield*/, ACEngineManager.loadEngineLocal()];
case 1:
_b.sent();
_b.label = 2;
case 2:
retVal = [];
for (ruleId in checker.engine.ruleMap) {
retVal.push(checker.engine.ruleMap[ruleId]);
}
return [2 /*return*/, retVal];
}
});
});
};
ACEngineManager.getRulesSync = function () {
if (!checker)
return null;
var retVal = [];
for (var ruleId in checker.engine.ruleMap) {
retVal.push(checker.engine.ruleMap[ruleId]);
}
return retVal;
};
return ACEngineManager;
}());
exports.ACEngineManager = ACEngineManager;
//# sourceMappingURL=ACEngineManager.js.map