Merge pull request #255 from playwright-community/valid-expect-in-pro…

…mise

Valid expect in promise

docs/rules/valid-expect-in-promise.md

@@ -0,0 +1,72 @@
+# Require promises that have expectations in their chain to be valid (`valid-expect-in-promise`)
+
+Ensure promises that include expectations are returned or awaited.
+
+## Rule details
+
+This rule flags any promises within the body of a test that include expectations
+that have either not been returned or awaited.
+
+The following patterns are considered warnings:
+
+```js
+test('promises a person', () => {
+  api.getPersonByName('bob').then((person) => {
+    expect(person).toHaveProperty('name', 'Bob');
+  });
+});
+
+test('promises a counted person', () => {
+  const promise = api.getPersonByName('bob').then((person) => {
+    expect(person).toHaveProperty('name', 'Bob');
+  });
+
+  promise.then(() => {
+    expect(analytics.gottenPeopleCount).toBe(1);
+  });
+});
+
+test('promises multiple people', () => {
+  const firstPromise = api.getPersonByName('bob').then((person) => {
+    expect(person).toHaveProperty('name', 'Bob');
+  });
+  const secondPromise = api.getPersonByName('alice').then((person) => {
+    expect(person).toHaveProperty('name', 'Alice');
+  });
+
+  return Promise.any([firstPromise, secondPromise]);
+});
+```
+
+The following pattern is not a warning:
+
+```js
+test('promises a person', async () => {
+  await api.getPersonByName('bob').then((person) => {
+    expect(person).toHaveProperty('name', 'Bob');
+  });
+});
+
+test('promises a counted person', () => {
+  let promise = api.getPersonByName('bob').then((person) => {
+    expect(person).toHaveProperty('name', 'Bob');
+  });
+
+  promise = promise.then(() => {
+    expect(analytics.gottenPeopleCount).toBe(1);
+  });
+
+  return promise;
+});
+
+test('promises multiple people', () => {
+  const firstPromise = api.getPersonByName('bob').then((person) => {
+    expect(person).toHaveProperty('name', 'Bob');
+  });
+  const secondPromise = api.getPersonByName('alice').then((person) => {
+    expect(person).toHaveProperty('name', 'Alice');
+  });
+
+  return Promise.allSettled([firstPromise, secondPromise]);
+});
+```

src/index.ts

@@ -42,6 +42,7 @@ import requireSoftAssertions from './rules/require-soft-assertions';
 import requireTopLevelDescribe from './rules/require-top-level-describe';
 import validDescribeCallback from './rules/valid-describe-callback';
 import validExpect from './rules/valid-expect';
+import validExpectInPromise from './rules/valid-expect-in-promise';
 import validTitle from './rules/valid-title';
 
 const index = {
@@ -90,6 +91,7 @@ const index = {
     'require-top-level-describe': requireTopLevelDescribe,
     'valid-describe-callback': validDescribeCallback,
     'valid-expect': validExpect,
+    'valid-expect-in-promise': validExpectInPromise,
     'valid-title': validTitle,
   },
 };
@@ -119,6 +121,7 @@ const sharedConfig = {
     'playwright/prefer-web-first-assertions': 'error',
     'playwright/valid-describe-callback': 'error',
     'playwright/valid-expect': 'error',
+    'playwright/valid-expect-in-promise': 'error',
     'playwright/valid-title': 'error',
   },
 };