Fix stack traces handling when calling user.* methods

.changeset/two-dingos-develop.md

@@ -0,0 +1,5 @@
+---
+'pleasantest': patch
+---
+
+Fix stack frames handling when calling user.\* methods

src/user.ts

@@ -40,8 +40,14 @@ const wrapWithForgotAwait = (
   for (const key of Object.keys(user) as (keyof PleasantestUser)[]) {
     const original = user[key];
     // eslint-disable-next-line @cloudfour/unicorn/consistent-function-scoping
-    const wrapper = (...args: any[]) =>
-      asyncHookTracker.addHook<any>(() => (original as any)(...args), wrapper);
+    const wrapper = async (...args: any[]) =>
+      // The await is necessary so `wrapper` is in the stack trace,
+      // so captureStackTrace works correctly
+      // eslint-disable-next-line no-return-await
+      await asyncHookTracker.addHook<any>(
+        () => (original as any)(...args),
+        wrapper,
+      );
 
     user[key] = wrapper;
   }

tests/user/general.test.ts

@@ -0,0 +1,22 @@
+import { withBrowser } from 'pleasantest';
+import { printErrorFrames } from '../test-utils';
+
+test(
+  'Stack frames are correct',
+  withBrowser(async ({ user, utils, screen }) => {
+    await utils.injectHTML('<button style="visibility:hidden">Hi</button>');
+    const button = await screen.getByText(/hi/i);
+    const error = await user.click(button).catch((error) => error);
+    expect(await printErrorFrames(error)).toMatchInlineSnapshot(`
+      "Error: Cannot perform action on element that is not visible (it has visibility:hidden):
+      <button style=\\"visibility:hidden\\">Hi</button>
+      -------------------------------------------------------
+      tests/user/general.test.ts
+
+          const error = await user.click(button).catch((error) => error);
+                        ^
+      -------------------------------------------------------
+      dist/cjs/index.cjs"
+    `);
+  }),
+);