Skip to content

Commit

Permalink
fix: forward timeout waitForFileChooser
Browse files Browse the repository at this point in the history
  • Loading branch information
jrandolf committed Aug 30, 2022
1 parent e2d9858 commit 58eee09
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 74 deletions.
14 changes: 7 additions & 7 deletions src/common/FrameManager.ts
Expand Up @@ -17,7 +17,7 @@
import {Protocol} from 'devtools-protocol';
import {assert} from '../util/assert.js';
import {
createDebuggableDeferredPromise,
createDeferredPromise,
DeferredPromise,
} from '../util/DeferredPromise.js';
import {isErrorLike} from '../util/ErrorLike.js';
Expand Down Expand Up @@ -150,9 +150,9 @@ export class FrameManager extends EventEmitter {
if (!this.#framesPendingTargetInit.has(targetId)) {
this.#framesPendingTargetInit.set(
targetId,
createDebuggableDeferredPromise(
`Waiting for target frame ${targetId} failed`
)
createDeferredPromise({
message: `Waiting for target frame ${targetId} failed`,
})
);
}
const result = await Promise.all([
Expand Down Expand Up @@ -318,9 +318,9 @@ export class FrameManager extends EventEmitter {
if (!this.#framesPendingAttachment.has(frameId)) {
this.#framesPendingAttachment.set(
frameId,
createDebuggableDeferredPromise(
`Waiting for frame ${frameId} to attach failed`
)
createDeferredPromise({
message: `Waiting for frame ${frameId} to attach failed`,
})
);
}
frame.then(() => {
Expand Down
8 changes: 4 additions & 4 deletions src/common/NetworkManager.ts
Expand Up @@ -24,7 +24,7 @@ import {HTTPResponse} from './HTTPResponse.js';
import {FetchRequestId, NetworkEventManager} from './NetworkEventManager.js';
import {debugError, isString} from './util.js';
import {
createDebuggableDeferredPromise,
createDeferredPromise,
DeferredPromise,
} from '../util/DeferredPromise.js';

Expand Down Expand Up @@ -144,9 +144,9 @@ export class NetworkManager extends EventEmitter {
if (this.#deferredInitPromise) {
return this.#deferredInitPromise;
}
this.#deferredInitPromise = createDebuggableDeferredPromise<void>(
'NetworkManager initialization timed out'
);
this.#deferredInitPromise = createDeferredPromise<void>({
message: 'NetworkManager initialization timed out',
});
const init = Promise.all([
this.#ignoreHTTPSErrors
? this.#client.send('Security.setIgnoreCertificateErrors', {
Expand Down
9 changes: 5 additions & 4 deletions src/common/Page.ts
Expand Up @@ -69,7 +69,7 @@ import {
} from './util.js';
import {isErrorLike} from '../util/ErrorLike.js';
import {
createDeferredPromiseWithTimer,
createDeferredPromise,
DeferredPromise,
} from '../util/DeferredPromise.js';
import {WebWorker} from './WebWorker.js';
Expand Down Expand Up @@ -769,9 +769,10 @@ export class Page extends EventEmitter {
}

const {timeout = this.#timeoutSettings.timeout()} = options;
const promise = createDeferredPromiseWithTimer<FileChooser>(
`Waiting for \`FileChooser\` failed: ${timeout}ms exceeded`
);
const promise = createDeferredPromise<FileChooser>({
message: `Waiting for \`FileChooser\` failed: ${timeout}ms exceeded`,
timeout,
});
this.#fileChooserPromises.add(promise);
return promise.catch(error => {
this.#fileChooserPromises.delete(promise);
Expand Down
2 changes: 1 addition & 1 deletion src/environment.ts
Expand Up @@ -22,7 +22,7 @@ export const isNode = !!(typeof process !== 'undefined' && process.version);
/**
* @internal
*/
export const deferredPromiseDebugTimeout =
export const DEFERRED_PROMISE_DEBUG_TIMEOUT =
typeof process !== 'undefined' &&
typeof process.env['PUPPETEER_DEFERRED_PROMISE_DEBUG_TIMEOUT'] !== 'undefined'
? Number(process.env['PUPPETEER_DEFERRED_PROMISE_DEBUG_TIMEOUT'])
Expand Down
83 changes: 25 additions & 58 deletions src/util/DeferredPromise.ts
@@ -1,5 +1,5 @@
import {TimeoutError} from '../common/Errors.js';
import {deferredPromiseDebugTimeout} from '../environment.js';
import {DEFERRED_PROMISE_DEBUG_TIMEOUT} from '../environment.js';

/**
* @internal
Expand All @@ -11,18 +11,27 @@ export interface DeferredPromise<T> extends Promise<T> {
reject: (_: Error) => void;
}

interface DeferredPromiseOptions {
message?: string;
timeout?: number;
isDebug?: boolean;
}

/**
* Creates an returns a promise along with the resolve/reject functions.
*
* If the promise has not been resolved/rejected withing the `timeout` period,
* If the promise has not been resolved/rejected within the `timeout` period,
* the promise gets rejected with a timeout error.
*
* @internal
*/
export function createDeferredPromiseWithTimer<T>(
timeoutMessage: string,
timeout = 5000
): DeferredPromise<T> {
export function createDeferredPromise<T>({
message = '',
timeout = 5000,
}: DeferredPromiseOptions = {}): DeferredPromise<T> {
if (DEFERRED_PROMISE_DEBUG_TIMEOUT > 0 && !timeout) {
timeout = DEFERRED_PROMISE_DEBUG_TIMEOUT;
}
let isResolved = false;
let isRejected = false;
let resolver = (_: T): void => {};
Expand All @@ -31,10 +40,13 @@ export function createDeferredPromiseWithTimer<T>(
resolver = resolve;
rejector = reject;
});
const timeoutId = setTimeout(() => {
isRejected = true;
rejector(new TimeoutError(timeoutMessage));
}, timeout);
const timeoutId =
timeout > 0
? setTimeout(() => {
isRejected = true;
rejector(new TimeoutError(message));
}, timeout)
: undefined;
return Object.assign(taskPromise, {
resolved: () => {
return isResolved;
Expand All @@ -43,7 +55,9 @@ export function createDeferredPromiseWithTimer<T>(
return isResolved || isRejected;
},
resolve: (value: T) => {
clearTimeout(timeoutId);
if (timeoutId) {
clearTimeout(timeoutId);
}
isResolved = true;
resolver(value);
},
Expand All @@ -54,50 +68,3 @@ export function createDeferredPromiseWithTimer<T>(
},
});
}

/**
* Creates an returns a promise along with the resolve/reject functions.
*
* @internal
*/
export function createDeferredPromise<T>(): DeferredPromise<T> {
let isResolved = false;
let isRejected = false;
let resolver = (_: T): void => {};
let rejector = (_: Error) => {};
const taskPromise = new Promise<T>((resolve, reject) => {
resolver = resolve;
rejector = reject;
});
return Object.assign(taskPromise, {
resolved: () => {
return isResolved;
},
finished: () => {
return isResolved || isRejected;
},
resolve: (value: T) => {
isResolved = true;
resolver(value);
},
reject: (err: Error) => {
isRejected = true;
rejector(err);
},
});
}

/**
* @internal
*/
export function createDebuggableDeferredPromise<T>(
timeoutMessage: string
): DeferredPromise<T> {
if (deferredPromiseDebugTimeout > 0) {
return createDeferredPromiseWithTimer(
timeoutMessage,
deferredPromiseDebugTimeout
);
}
return createDeferredPromise();
}

0 comments on commit 58eee09

Please sign in to comment.