Made E2E tests that depend on Tinybird optional outside of CI

refs https://linear.app/ghost/issue/BER-3077/improve-e2e-testing-integration

The yarn dev:forward command won't start Tinybird by default since it's
expensive to run. These changes mean that we automatically skip tests that
depend on Tinybird when running locally and that service isn't available.

Author: jonatansberg

e2e/helpers/environment/service-availability.ts

@@ -42,3 +42,30 @@ export async function isTinybirdAvailable(): Promise<boolean> {
     }
 }
 
+/**
+ * Check if we're running in CI environment.
+ */
+export function isCI(): boolean {
+    return process.env.CI === 'true';
+}
+
+/**
+ * Determine if analytics tests should be skipped.
+ * Returns true if Tinybird is not available AND we're not in CI.
+ * In CI, we want tests to fail if Tinybird isn't available.
+ */
+export async function shouldSkipAnalyticsTests(): Promise<boolean> {
+    if (isCI()) {
+        // In CI, never skip - let tests fail if Tinybird isn't available
+        return false;
+    }
+
+    const available = await isTinybirdAvailable();
+    if (!available) {
+        debug('Skipping analytics tests: Tinybird not available (non-CI)');
+        return true;
+    }
+
+    return false;
+}
+

e2e/helpers/pages/public/public-page.ts

@@ -1,3 +1,4 @@
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
 import {BasePage, pageGotoOptions} from '@/helpers/pages';
 import {Locator, Page, Response} from '@playwright/test';
 
@@ -86,13 +87,17 @@ export class PublicPage extends BasePage {
 
     async goto(url?: string, options?: pageGotoOptions): Promise<void> {
         await this.enableAnalyticsRequests();
-        const pageHitPromise = this.pageHitRequestPromise();
+        const pageHitPromise = this.waitForPageHitRequest();
         await super.goto(url, options);
         await pageHitPromise;
     }
-
-    pageHitRequestPromise(): Promise<Response> {
-        return this.page.waitForResponse((response) => {
+    
+    async waitForPageHitRequest(): Promise<void> {
+        if (await shouldSkipAnalyticsTests()) {
+            return;
+        }
+    
+        await this.page.waitForResponse((response) => {
             return response
                 .url()
                 .includes('/.ghost/analytics/api/v1/page_hit') && response.request().method() === 'POST';

e2e/tests/admin/analytics/growth.test.ts

@@ -1,5 +1,8 @@
 import {AnalyticsGrowthPage} from '@/admin-pages';
 import {expect, test} from '@/helpers/playwright';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
+
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
 
 test.describe('Ghost Admin - Growth', () => {
     let growthPage: AnalyticsGrowthPage;

e2e/tests/admin/analytics/location.test.ts

@@ -1,5 +1,8 @@
 import {AnalyticsLocationsPage} from '@/admin-pages';
 import {expect, test} from '@/helpers/playwright';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
+
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
 
 test.describe('Ghost Admin - Locations', () => {
     test('empty sources card', async ({page}) => {

e2e/tests/admin/analytics/newsletters.test.ts

@@ -1,7 +1,10 @@
 import {AnalyticsNewslettersPage} from '@/admin-pages';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
 import {MembersImportService} from '@/helpers/services/members-import';
 import {expect, test} from '@/helpers/playwright';
 
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
+
 function getDateDaysAgo(days: number): string {
     const date = new Date();
     date.setDate(date.getDate() - days);

e2e/tests/admin/analytics/overview.test.ts

@@ -5,6 +5,9 @@ import {
 } from '@/admin-pages';
 import {HomePage} from '@/public-pages';
 import {expect, test, withIsolatedPage} from '@/helpers/playwright';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
+
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
 
 test.describe('Ghost Admin - Analytics Overview', () => {
     test('records visitor when homepage is visited', async ({page, browser, baseURL}) => {

e2e/tests/admin/analytics/post-analytics/growth.test.ts

@@ -5,6 +5,9 @@ import {
     PostAnalyticsPage
 } from '@/admin-pages';
 import {expect, test} from '@/helpers/playwright';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
+
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
 
 test.describe('Ghost Admin - Post Analytics - Growth', () => {
     test.beforeEach(async ({page}) => {

e2e/tests/admin/analytics/post-analytics/overview.test.ts

@@ -5,6 +5,9 @@ import {
     PostAnalyticsWebTrafficPage
 } from '@/admin-pages';
 import {expect, test} from '@/helpers/playwright';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
+
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
 
 test.describe('Ghost Admin - Post Analytics - Overview', () => {
     test.beforeEach(async ({page}) => {

e2e/tests/admin/analytics/utm-tracking.test.ts

@@ -1,6 +1,9 @@
 import {AnalyticsWebTrafficPage} from '@/admin-pages';
 import {HomePage} from '@/public-pages';
 import {expect, test, withIsolatedPage} from '@/helpers/playwright';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
+
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
 
 test.describe('Ghost Admin - Analytics UTM Tracking', () => {
     test.describe('utmTracking flag disabled', () => {

e2e/tests/admin/analytics/web-traffic.test.ts

@@ -1,6 +1,9 @@
 import {AnalyticsWebTrafficPage} from '@/admin-pages';
+import { shouldSkipAnalyticsTests } from '@/helpers/environment/service-availability';
 import {expect, test} from '@/helpers/playwright';
 
+test.skip(await shouldSkipAnalyticsTests(), 'Tinybird not available');
+
 test.describe('Ghost Admin - Analytics Web Traffic', () => {
     let analyticsWebTrafficPage: AnalyticsWebTrafficPage;