Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix(utils): clamp negative delay in raceAgainstDeadline (#42413)

Jonathan Warykowski339aa29bb79d
diff --git a/packages/isomorphic/timeoutRunner.ts b/packages/isomorphic/timeoutRunner.ts
index 4ffe5d86ae..7c737a2a49 100644
--- a/packages/isomorphic/timeoutRunner.ts
+++ b/packages/isomorphic/timeoutRunner.ts
@@ -32,7 +32,7 @@ export async function raceAgainstDeadline<T>(cb: () => Promise<T>, deadline: num
new Promise<{ timedOut: true }>(resolve => {
if (!deadline)
return;
- timer = setTimeout(() => resolve({ timedOut: true }), deadline - monotonicTime());
+ timer = setTimeout(() => resolve({ timedOut: true }), Math.max(0, deadline - monotonicTime()));
}),
]).finally(() => {
clearTimeout(timer);
diff --git a/tests/library/unit/timeout-runner.spec.ts b/tests/library/unit/timeout-runner.spec.ts
new file mode 100644
index 0000000000..36bf9a4152
--- /dev/null
+++ b/tests/library/unit/timeout-runner.spec.ts
@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * 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
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { test, expect } from '@playwright/test';
+import { raceAgainstDeadline } from '../../../packages/isomorphic/timeoutRunner';
+import { monotonicTime } from '../../../packages/isomorphic/time';
+
+test('raceAgainstDeadline should not emit TimeoutNegativeWarning for a passed deadline', async () => {
+ const warnings: string[] = [];
+ const onWarning = (w: Error) => warnings.push(w.name);
+ process.on('warning', onWarning);
+ try {
+ const result = await raceAgainstDeadline(() => new Promise<void>(() => {}), monotonicTime() - 1);
+ await new Promise(f => setImmediate(f));
+ expect(result.timedOut).toBe(true);
+ expect(warnings).not.toContain('TimeoutNegativeWarning');
+ } finally {
+ process.off('warning', onWarning);
+ }
+});