Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Disabled annotation output

Browse source
This commit is contained in:
Adam Gastineau 2025-02-27 12:04:34 -08:00
parent 52a23d3fbe
commit ee2748eb15
2 changed files with 253 additions and 252 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
packages/playwright/src/worker/workerMain.ts
View file

@ -328,7 +328,8 @@ export class WorkerMain extends ProcessRunner {
return; return;
if (!testInfo._floatingPromiseScope.hasFloatingPromises()) if (!testInfo._floatingPromiseScope.hasFloatingPromises())
return; return;
testInfo.annotations.push({ type: 'warning', description: `Some async calls were not awaited by the end of ${functionDescription}. This can cause flakiness.` }); // TODO: 1.52: Actually build annotations
// testInfo.annotations.push({ type: 'warning', description: `Some async calls were not awaited by the end of ${functionDescription}. This can cause flakiness.` });
testInfo._floatingPromiseScope.clear(); testInfo._floatingPromiseScope.clear();
}; };

502
tests/playwright-test/warnings.spec.ts
View file

@ -14,274 +14,274 @@
* limitations under the License. * limitations under the License.
*/ */
import { JSONReport } from 'packages/playwright-test/reporter'; // import { JSONReport } from 'packages/playwright-test/reporter';
import { test, expect } from './playwright-test-fixtures'; // import { test, expect } from './playwright-test-fixtures';
const warningSnippet = 'Some async calls were not awaited'; // const warningSnippet = 'Some async calls were not awaited';
test.describe.configure({ mode: 'parallel' }); // test.describe.configure({ mode: 'parallel' });
const getWarnings = (report: JSONReport) => report.suites.flatMap(s => s.specs).flatMap(s => s.tests).flatMap(t => t.annotations).filter(a => a.type === 'warning'); // const getWarnings = (report: JSONReport) => report.suites.flatMap(s => s.specs).flatMap(s => s.tests).flatMap(t => t.annotations).filter(a => a.type === 'warning');
test.describe('await', () => { // test.describe('await', () => {
test('should not care about non-API promises', async ({ runInlineTest }) => { // test('should not care about non-API promises', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test } from '@playwright/test'; // import { test } from '@playwright/test';
test('test', () => { // test('test', () => {
new Promise(() => {}); // new Promise(() => {});
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(0); // expect(warnings.length).toEqual(0);
}); // });
test('should warn about missing await on expects when failing', async ({ runInlineTest }) => { // test('should warn about missing await on expects when failing', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('custom test name', async ({ page }) => { // test('custom test name', async ({ page }) => {
expect(page.locator('div')).toHaveText('A', { timeout: 100 }); // expect(page.locator('div')).toHaveText('A', { timeout: 100 });
}); // });
` // `
}); // });
expect(exitCode).toBe(1); // expect(exitCode).toBe(1);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
expect(warnings[0].description).toContain('the test'); // expect(warnings[0].description).toContain('the test');
}); // });
test('should warn about missing await on expects when passing', async ({ runInlineTest }) => { // test('should warn about missing await on expects when passing', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
expect(page.locator('div')).toHaveText('A'); // expect(page.locator('div')).toHaveText('A');
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
}); // });
test('should not warn when not missing await on expects when failing', async ({ runInlineTest }) => { // test('should not warn when not missing await on expects when failing', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await expect(page.locator('div')).toHaveText('A', { timeout: 100 }); // await expect(page.locator('div')).toHaveText('A', { timeout: 100 });
}); // });
` // `
}); // });
expect(exitCode).toBe(1); // expect(exitCode).toBe(1);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(0); // expect(warnings.length).toEqual(0);
}); // });
test('should not warn when not missing await on expects when passing', async ({ runInlineTest }) => { // test('should not warn when not missing await on expects when passing', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
await expect(page.locator('div')).toHaveText('A'); // await expect(page.locator('div')).toHaveText('A');
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(0); // expect(warnings.length).toEqual(0);
}); // });
test('should not warn when using then on expects when passing', async ({ runInlineTest }) => { // test('should not warn when using then on expects when passing', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
expect(page.locator('div')).toHaveText('A').then(() => {}); // expect(page.locator('div')).toHaveText('A').then(() => {});
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(0); // expect(warnings.length).toEqual(0);
}); // });
test('should warn about missing await on reject', async ({ runInlineTest }) => { // test('should warn about missing await on reject', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
expect(Promise.reject(new Error('foo'))).rejects.toThrow('foo'); // expect(Promise.reject(new Error('foo'))).rejects.toThrow('foo');
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
}); // });
test('should warn about missing await on reject.not', async ({ runInlineTest }) => { // test('should warn about missing await on reject.not', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
expect(Promise.reject(new Error('foo'))).rejects.not.toThrow('foo'); // expect(Promise.reject(new Error('foo'))).rejects.not.toThrow('foo');
}); // });
` // `
}); // });
expect(exitCode).toBe(1); // expect(exitCode).toBe(1);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
}); // });
test('should warn about missing await on test.step', async ({ runInlineTest }) => { // test('should warn about missing await on test.step', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
test.step('step', () => {}); // test.step('step', () => {});
await expect(page.locator('div')).toHaveText('A'); // await expect(page.locator('div')).toHaveText('A');
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
}); // });
test('should not warn when not missing await on test.step', async ({ runInlineTest }) => { // test('should not warn when not missing await on test.step', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
await test.step('step', () => {}); // await test.step('step', () => {});
await expect(page.locator('div')).toHaveText('A'); // await expect(page.locator('div')).toHaveText('A');
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(0); // expect(warnings.length).toEqual(0);
}); // });
test('should warn about missing await on test.step.skip', async ({ runInlineTest }) => { // test('should warn about missing await on test.step.skip', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
test.step.skip('step', () => {}); // test.step.skip('step', () => {});
await expect(page.locator('div')).toHaveText('A'); // await expect(page.locator('div')).toHaveText('A');
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
}); // });
test('traced promise should be instanceof Promise', async ({ runInlineTest }) => { // test('traced promise should be instanceof Promise', async ({ runInlineTest }) => {
const { exitCode } = await runInlineTest({ // const { exitCode } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test('test', async ({ page }) => { // test('test', async ({ page }) => {
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
const expectPromise = expect(page.locator('div')).toHaveText('A'); // const expectPromise = expect(page.locator('div')).toHaveText('A');
expect(expectPromise instanceof Promise).toBeTruthy(); // expect(expectPromise instanceof Promise).toBeTruthy();
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
}); // });
test('should warn about missing await in before hooks', async ({ runInlineTest }) => { // test('should warn about missing await in before hooks', async ({ runInlineTest }) => {
const group = ['beforeAll', 'beforeEach']; // const group = ['beforeAll', 'beforeEach'];
for (const hook of group) { // for (const hook of group) {
await test.step(hook, async () => { // await test.step(hook, async () => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
let page; // let page;
test.${hook}(async ({ browser }) => { // test.${hook}(async ({ browser }) => {
page = await browser.newPage(); // page = await browser.newPage();
await page.setContent('<div>A</div>'); // await page.setContent('<div>A</div>');
expect(page.locator('div')).toHaveText('A'); // expect(page.locator('div')).toHaveText('A');
}); // });
test('test ${hook}', async () => { // test('test ${hook}', async () => {
await expect(page.locator('div')).toBeVisible(); // await expect(page.locator('div')).toBeVisible();
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
expect(warnings[0].description).toContain(`${group[0]}/${group[1]} hooks`); // expect(warnings[0].description).toContain(`${group[0]}/${group[1]} hooks`);
}); // });
} // }
}); // });
test.describe('should warn about missing await in after hooks', () => { // test.describe('should warn about missing await in after hooks', () => {
const group = ['afterAll', 'afterEach']; // const group = ['afterAll', 'afterEach'];
for (const hook of group) { // for (const hook of group) {
test(hook, async ({ runInlineTest }) => { // test(hook, async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
let page; // let page;
test('test ${hook}', async ({ browser }) => { // test('test ${hook}', async ({ browser }) => {
await expect(Promise.resolve()).resolves.toBe(undefined); // await expect(Promise.resolve()).resolves.toBe(undefined);
}); // });
test.${hook}(async () => { // test.${hook}(async () => {
expect(Promise.resolve()).resolves.toBe(undefined); // expect(Promise.resolve()).resolves.toBe(undefined);
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(1); // expect(warnings.length).toEqual(1);
expect(warnings[0].description).toContain(warningSnippet); // expect(warnings[0].description).toContain(warningSnippet);
expect(warnings[0].description).toContain(`${group[0]}/${group[1]} hooks`); // expect(warnings[0].description).toContain(`${group[0]}/${group[1]} hooks`);
}); // });
} // }
}); // });
test('should warn about missing await across hooks and test', async ({ runInlineTest }) => { // test('should warn about missing await across hooks and test', async ({ runInlineTest }) => {
const { exitCode, report } = await runInlineTest({ // const { exitCode, report } = await runInlineTest({
'a.test.ts': ` // 'a.test.ts': `
import { test, expect } from '@playwright/test'; // import { test, expect } from '@playwright/test';
test.beforeAll(async () => { // test.beforeAll(async () => {
expect(Promise.resolve()).resolves.toBe(undefined); // expect(Promise.resolve()).resolves.toBe(undefined);
}); // });
test('test', async () => { // test('test', async () => {
expect(Promise.resolve()).resolves.toBe(undefined); // expect(Promise.resolve()).resolves.toBe(undefined);
}); // });
test.afterEach(async () => { // test.afterEach(async () => {
expect(Promise.resolve()).resolves.toBe(undefined); // expect(Promise.resolve()).resolves.toBe(undefined);
}); // });
` // `
}); // });
expect(exitCode).toBe(0); // expect(exitCode).toBe(0);
const warnings = getWarnings(report); // const warnings = getWarnings(report);
expect(warnings.length).toEqual(3); // expect(warnings.length).toEqual(3);
expect(warnings[0].description).toContain(`${warningSnippet} by the end of beforeAll/beforeEach hooks.`); // expect(warnings[0].description).toContain(`${warningSnippet} by the end of beforeAll/beforeEach hooks.`);
expect(warnings[1].description).toContain(`${warningSnippet} by the end of the test.`); // expect(warnings[1].description).toContain(`${warningSnippet} by the end of the test.`);
expect(warnings[2].description).toContain(`${warningSnippet} by the end of afterAll/afterEach hooks.`); // expect(warnings[2].description).toContain(`${warningSnippet} by the end of afterAll/afterEach hooks.`);
}); // });
}); // });