From c6763dd8e1063d6f5d95f075573bbd701d95fadd Mon Sep 17 00:00:00 2001
From: Adam Gastineau <adam@agg.im>
Date: Tue, 18 Feb 2025 11:07:48 -0800
Subject: [PATCH] Tests for await warnings

---
 tests/playwright-test/warnings.spec.ts | 161 +++++++++++++++++++++++++
 1 file changed, 161 insertions(+)
 create mode 100644 tests/playwright-test/warnings.spec.ts

diff --git a/tests/playwright-test/warnings.spec.ts b/tests/playwright-test/warnings.spec.ts
new file mode 100644
index 0000000000..db1152ee91
--- /dev/null
+++ b/tests/playwright-test/warnings.spec.ts
@@ -0,0 +1,161 @@
+/**
+ * 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-fixtures';
+
+const warningSnippet = 'Some async calls were not awaited';
+
+test.describe.configure({ mode: 'parallel' });
+
+test.describe('await', () => {
+  test('should not care about non-API promises', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test } from '@playwright/test';
+        test('test', () => {
+          new Promise(() => {});
+        });
+      `
+    });
+    expect(exitCode).toBe(0);
+    expect(stdout).not.toContain(warningSnippet);
+  });
+
+  test('should warn about missing await on expects when failing', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          expect(page.locator('div')).toHaveText('A', { timeout: 100 });
+        });
+      `
+    });
+    expect(exitCode).toBe(1);
+    expect(stdout).toContain(warningSnippet);
+  });
+
+  test('should warn about missing await on expects when passing', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          await page.setContent('data:text/html,<div>A</div>');
+          expect(page.locator('div')).toHaveText('A');
+        });
+      `
+    });
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain(warningSnippet);
+  });
+
+  test('should not warn when not missing await on expects when failing', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          await expect(page.locator('div')).toHaveText('A', { timeout: 100 });
+        });
+      `
+    });
+    expect(exitCode).toBe(1);
+    expect(stdout).not.toContain(warningSnippet);
+  });
+
+  test('should not warn when not missing await on expects when passing', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          await page.setContent('data:text/html,<div>A</div>');
+          await expect(page.locator('div')).toHaveText('A');
+        });
+      `
+    });
+    expect(exitCode).toBe(0);
+    expect(stdout).not.toContain(warningSnippet);
+  });
+
+  test('should warn about missing await on reject', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          expect(Promise.reject(new Error('foo'))).rejects.toThrow('foo');
+        });
+      `
+    });
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain(warningSnippet);
+  });
+
+  test('should warn about missing await on reject.not', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          expect(Promise.reject(new Error('foo'))).rejects.not.toThrow('foo');
+        });
+      `
+    });
+    expect(exitCode).toBe(1);
+    expect(stdout).toContain(warningSnippet);
+  });
+
+  test('should warn about missing await on test.step', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          await page.setContent('data:text/html,<div>A</div>');
+          test.step('step', () => {});
+          await expect(page.locator('div')).toHaveText('A');
+        });
+      `
+    });
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain(warningSnippet);
+  });
+
+  test('should not warn when not missing await on test.step', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          await page.setContent('data:text/html,<div>A</div>');
+          await test.step('step', () => {});
+          await expect(page.locator('div')).toHaveText('A');
+        });
+      `
+    });
+    expect(exitCode).toBe(0);
+    expect(stdout).not.toContain(warningSnippet);
+  });
+
+  test('should warn about missing await on test.step.skip', async ({ runInlineTest }) => {
+    const { exitCode, stdout } = await runInlineTest({
+      'a.test.ts': `
+        import { test, expect } from '@playwright/test';
+        test('test', async ({ page }) => {
+          await page.setContent('data:text/html,<div>A</div>');
+          test.step.skip('step', () => {});
+          await expect(page.locator('div')).toHaveText('A');
+        });
+      `
+    });
+    expect(exitCode).toBe(0);
+    expect(stdout).toContain(warningSnippet);
+  });
+});