test(e2e/sveltekit): Unflake client error test by waiting for hydration (getsentry#11469)

Attempt to fix the Kit test flakiness by awaiting the initial
pageload and hydration, meaning we await
- going to the specified route
- a custom hydration flag being set
- the pageload transaction being sent

Author: Lms24

dev-packages/e2e-tests/test-applications/sveltekit-2/test/errors.client.test.ts

@@ -4,7 +4,7 @@ import { waitForInitialPageload } from './utils';
 
 test.describe('client-side errors', () => {
   test('captures error thrown on click', async ({ page }) => {
-    await page.goto('/client-error');
+    await waitForInitialPageload(page, { route: '/client-error' });
 
     const errorEventPromise = waitForError('sveltekit-2', errorEvent => {
       return errorEvent?.exception?.values?.[0]?.value === 'Click Error';

dev-packages/e2e-tests/test-applications/sveltekit-2/test/utils.ts

@@ -18,7 +18,7 @@ import { waitForTransaction } from '@sentry-internal/event-proxy-server';
  */
 export async function waitForInitialPageload(
   page: Page,
-  opts?: { route?: string; parameterizedRoute?: string; debug: boolean },
+  opts?: { route?: string; parameterizedRoute?: string; debug?: boolean },
 ) {
   const route = opts?.route ?? '/';
   const txnName = opts?.parameterizedRoute ?? route;

dev-packages/e2e-tests/test-applications/sveltekit/test/errors.client.test.ts

@@ -4,7 +4,7 @@ import { waitForInitialPageload } from '../utils';
 
 test.describe('client-side errors', () => {
   test('captures error thrown on click', async ({ page }) => {
-    await page.goto('/client-error');
+    await waitForInitialPageload(page, { route: '/client-error' });
 
     const errorEventPromise = waitForError('sveltekit', errorEvent => {
       return errorEvent?.exception?.values?.[0]?.value === 'Click Error';

dev-packages/e2e-tests/test-applications/sveltekit/utils.ts

@@ -18,7 +18,7 @@ import { waitForTransaction } from '@sentry-internal/event-proxy-server';
  */
 export async function waitForInitialPageload(
   page: Page,
-  opts?: { route?: string; parameterizedRoute?: string; debug: boolean },
+  opts?: { route?: string; parameterizedRoute?: string; debug?: boolean },
 ) {
   const route = opts?.route ?? '/';
   const txnName = opts?.parameterizedRoute ?? route;