169 lines
5.9 KiB
JavaScript
169 lines
5.9 KiB
JavaScript
"use strict";
|
|
var __defProp = Object.defineProperty;
|
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
var __export = (target, all) => {
|
|
for (var name in all)
|
|
__defProp(target, name, { get: all[name], enumerable: true });
|
|
};
|
|
var __copyProps = (to, from, except, desc) => {
|
|
if (from && typeof from === "object" || typeof from === "function") {
|
|
for (let key of __getOwnPropNames(from))
|
|
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
}
|
|
return to;
|
|
};
|
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
var progress_exports = {};
|
|
__export(progress_exports, {
|
|
ProgressController: () => ProgressController,
|
|
isAbortError: () => isAbortError
|
|
});
|
|
module.exports = __toCommonJS(progress_exports);
|
|
var import_errors = require("./errors");
|
|
var import_utils = require("../utils");
|
|
var import_manualPromise = require("../utils/isomorphic/manualPromise");
|
|
class ProgressController {
|
|
constructor(metadata, sdkObject) {
|
|
this._forceAbortPromise = new import_manualPromise.ManualPromise();
|
|
this._donePromise = new import_manualPromise.ManualPromise();
|
|
// Cleanups to be run only in the case of abort.
|
|
this._cleanups = [];
|
|
// Lenient mode races against the timeout. This guarantees that timeout is respected,
|
|
// but may have some work being done after the timeout due to parallel control flow.
|
|
//
|
|
// Strict mode aborts the progress and requires the code to react to it. This way,
|
|
// progress only finishes after the inner callback exits, guaranteeing no work after the timeout.
|
|
this._strictMode = false;
|
|
this._state = "before";
|
|
this._strictMode = !process.env.PLAYWRIGHT_LEGACY_TIMEOUTS;
|
|
this.metadata = metadata;
|
|
this.sdkObject = sdkObject;
|
|
this.instrumentation = sdkObject.instrumentation;
|
|
this._logName = sdkObject.logName || "api";
|
|
this._forceAbortPromise.catch((e) => null);
|
|
}
|
|
setLogName(logName) {
|
|
this._logName = logName;
|
|
}
|
|
async abort(error) {
|
|
if (this._state === "running") {
|
|
error[kAbortErrorSymbol] = true;
|
|
this._state = { error };
|
|
this._forceAbortPromise.reject(error);
|
|
}
|
|
if (this._strictMode)
|
|
await this._donePromise;
|
|
}
|
|
async run(task, timeout) {
|
|
(0, import_utils.assert)(this._state === "before");
|
|
this._state = "running";
|
|
let customErrorHandler;
|
|
const deadline = timeout ? Math.min((0, import_utils.monotonicTime)() + timeout, 2147483647) : 0;
|
|
const timeoutError = new import_errors.TimeoutError(`Timeout ${timeout}ms exceeded.`);
|
|
let timer;
|
|
const startTimer = () => {
|
|
if (!deadline)
|
|
return;
|
|
const onTimeout = () => {
|
|
if (this._state === "running") {
|
|
timeoutError[kAbortErrorSymbol] = true;
|
|
this._state = { error: timeoutError };
|
|
this._forceAbortPromise.reject(timeoutError);
|
|
}
|
|
};
|
|
const remaining = deadline - (0, import_utils.monotonicTime)();
|
|
if (remaining <= 0)
|
|
onTimeout();
|
|
else
|
|
timer = setTimeout(onTimeout, remaining);
|
|
};
|
|
const progress = {
|
|
log: (message) => {
|
|
if (this._state === "running")
|
|
this.metadata.log.push(message);
|
|
this.instrumentation.onCallLog(this.sdkObject, this.metadata, this._logName, message);
|
|
},
|
|
cleanupWhenAborted: (cleanup) => {
|
|
if (this._strictMode) {
|
|
if (this._state !== "running")
|
|
throw new Error("Internal error: cannot register cleanup after operation has finished.");
|
|
this._cleanups.push(cleanup);
|
|
return;
|
|
}
|
|
if (this._state === "running")
|
|
this._cleanups.push(cleanup);
|
|
else
|
|
runCleanup(typeof this._state === "object" ? this._state.error : void 0, cleanup);
|
|
},
|
|
metadata: this.metadata,
|
|
race: (promise) => {
|
|
const promises = Array.isArray(promise) ? promise : [promise];
|
|
return Promise.race([...promises, this._forceAbortPromise]);
|
|
},
|
|
raceWithCleanup: (promise, cleanup) => {
|
|
return progress.race(promise.then((result) => {
|
|
if (this._state !== "running")
|
|
cleanup(result);
|
|
else
|
|
this._cleanups.push(() => cleanup(result));
|
|
return result;
|
|
}));
|
|
},
|
|
wait: async (timeout2) => {
|
|
let timer2;
|
|
const promise = new Promise((f) => timer2 = setTimeout(f, timeout2));
|
|
return progress.race(promise).finally(() => clearTimeout(timer2));
|
|
},
|
|
legacyDisableTimeout: () => {
|
|
if (this._strictMode)
|
|
return;
|
|
clearTimeout(timer);
|
|
},
|
|
legacyEnableTimeout: () => {
|
|
if (this._strictMode)
|
|
return;
|
|
startTimer();
|
|
},
|
|
legacySetErrorHandler: (handler) => {
|
|
if (this._strictMode)
|
|
return;
|
|
customErrorHandler = handler;
|
|
}
|
|
};
|
|
startTimer();
|
|
try {
|
|
const promise = task(progress);
|
|
const result = this._strictMode ? await promise : await Promise.race([promise, this._forceAbortPromise]);
|
|
this._state = "finished";
|
|
return result;
|
|
} catch (error) {
|
|
this._state = { error };
|
|
await Promise.all(this._cleanups.splice(0).map((cleanup) => runCleanup(error, cleanup)));
|
|
if (customErrorHandler)
|
|
return customErrorHandler(error);
|
|
throw error;
|
|
} finally {
|
|
clearTimeout(timer);
|
|
this._donePromise.resolve();
|
|
}
|
|
}
|
|
}
|
|
async function runCleanup(error, cleanup) {
|
|
try {
|
|
await cleanup(error);
|
|
} catch (e) {
|
|
}
|
|
}
|
|
const kAbortErrorSymbol = Symbol("kAbortError");
|
|
function isAbortError(error) {
|
|
return !!error[kAbortErrorSymbol];
|
|
}
|
|
// Annotate the CommonJS export names for ESM import in node:
|
|
0 && (module.exports = {
|
|
ProgressController,
|
|
isAbortError
|
|
});
|