wpt-api-client
Version:
Unofficial Node.js client for the WebPageTest REST API
126 lines • 6.84 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 (_) 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 };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.makeTestStatus = exports.Status = void 0;
var phin_1 = __importDefault(require("phin"));
var utils_1 = require("./utils");
var error_1 = require("./error");
var Status;
(function (Status) {
Status["COMPLETED"] = "COMPLETED";
Status["QUEUED"] = "QUEUED";
Status["STARTED"] = "STARTED";
})(Status = exports.Status || (exports.Status = {}));
/**
* Create function to call the /testStatus.php endpoint.
*
* https://docs.webpagetest.org/api/reference/#check-test-status
*/
var makeTestStatus = function (wptServer) {
var endpoint = utils_1.baseUrl(wptServer) + "/testStatus.php";
var testStatus = function (id) { return __awaiter(void 0, void 0, void 0, function () {
var url, body, d;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
url = endpoint + "?f=json&test=" + id;
return [4 /*yield*/, phin_1.default({
url: url,
parse: 'json'
})];
case 1:
body = (_a.sent()).body;
error_1.throwIfNotSuccess(body);
// The WebPageTest API returns some duplicate properties, and some
// fields are not in the most appropriate data type. So we cleanup a bit.
// https://docs.webpagetest.org/api/reference/#check-test-status
switch (body.statusCode) {
case 100: {
return [2 /*return*/, {
startTime: body.data.startTime,
status: Status.STARTED
}];
}
case 101: {
return [2 /*return*/, {
behindCount: body.data.behindCount,
status: Status.QUEUED
}];
}
case 200: {
d = body.data;
return [2 /*return*/, {
status: Status.COMPLETED,
browser: d.testInfo.browser,
bwDownloadKbps: d.testInfo.bwIn,
bwUploadKbps: d.testInfo.bwOut,
completeTime: d.completeTime,
connectivity: d.testInfo.connectivity,
firstViewOnly: d.fvonly ? true : false,
hasDevToolsTimeline: d.timeline ? true : false,
hasVideo: d.testInfo.video ? true : false,
ignoreSSL: d.testInfo.ignoreSSL ? true : false,
label: d.testInfo.label,
latencyMs: d.testInfo.latency,
location: d.location,
mobile: d.testInfo.mobile ? true : false,
netlog: d.testInfo.netlog ? true : false,
noscript: d.testInfo.noscript ? true : false,
packetLossRate: d.testInfo.plr,
runs: d.runs,
tcpdump: d.testInfo.tcpdump ? true : false,
trace: d.trace ? true : false,
url: d.testInfo.url
}];
}
case 400:
throw new Error("Test " + id + " not found");
default:
throw new Error("statusCode " + body.statusCode + " not handled");
}
return [2 /*return*/];
}
});
}); };
return testStatus;
};
exports.makeTestStatus = makeTestStatus;
//# sourceMappingURL=test-status.js.map