Merge pull request #2 from PostHog/tests

tests?

Author: gewenyu99

.github/workflows/playwright.yml

@@ -0,0 +1,74 @@
+name: PostHog Examples - Playwright Tests
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    # Runs nightly at 12am PST (which is 8am UTC)
+    - cron: '0 8 * * *'
+
+jobs:
+  discover:
+    runs-on: ubuntu-latest
+    outputs:
+      examples: ${{ steps.set-examples.outputs.examples }}
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Discover examples with Playwright configs
+      id: set-examples
+      run: |
+        examples=$(find basics -maxdepth 2 -name "playwright.config.ts" -exec dirname {} \; | sed 's|^basics/||' | jq -R -s -c 'split("\n")[:-1]')
+        echo "examples=$examples" >> $GITHUB_OUTPUT
+        echo "Found examples: $examples"
+
+  test:
+    needs: discover
+    if: needs.discover.outputs.examples != '[]'
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        example: ${{ fromJson(needs.discover.outputs.examples) }}
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+
+    - uses: pnpm/action-setup@v4
+      with:
+        version: latest
+
+    - name: Install dependencies
+      run: |
+        cd basics/${{ matrix.example }}
+        pnpm install
+
+    - name: Install Playwright Browsers
+      run: |
+        cd basics/${{ matrix.example }}
+        pnpm exec playwright install chromium --with-deps
+
+    - name: Run Playwright tests
+      run: |
+        cd basics/${{ matrix.example }}
+        pnpm exec playwright test
+      env:
+        NEXT_PUBLIC_POSTHOG_KEY: ${{ vars.NEXT_PUBLIC_POSTHOG_KEY }}
+        NEXT_PUBLIC_POSTHOG_HOST: ${{ vars.NEXT_PUBLIC_POSTHOG_HOST }}
+
+    - uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: playwright-report-${{ matrix.example }}
+        path: basics/${{ matrix.example }}/playwright-report/
+        retention-days: 30
+
+# TODO: report to PostHog which will warn in channel for failure.

basics/next-app-router/.env.example

@@ -0,0 +1,5 @@
+# PostHog Configuration
+# Get your PostHog API key from: https://app.posthog.com/project/settings
+NEXT_PUBLIC_POSTHOG_KEY=your_posthog_project_api_key_here
+# NEXT_PUBLIC_POSTHOG_HOST=https://eu.i.posthog.com
+NEXT_PUBLIC_POSTHOG_HOST=https://us.i.posthog.com

basics/next-app-router/.gitignore

@@ -12,6 +12,10 @@
 
 # testing
 /coverage
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
 
 # next.js
 /.next/
@@ -31,7 +35,7 @@ yarn-error.log*
 .pnpm-debug.log*
 
 # env files (can opt-in for committing if needed)
-.env*
+.env
 
 # vercel
 .vercel

basics/next-app-router/instrumentation-client.ts

@@ -9,4 +9,9 @@ posthog.init(process.env.NEXT_PUBLIC_POSTHOG_KEY!, {
   capture_exceptions: true,
   // Turn on debug in development mode
   debug: process.env.NODE_ENV === "development",
+  // @ignoreBlockStart
+  // Disable request batching in test environment
+  request_batching: false,
+  opt_out_useragent_filter: true,  // This disables bot detection
+  // @ignoreBlockEnd
 });

basics/next-app-router/package.json

@@ -6,7 +6,11 @@
     "dev": "next dev --turbopack",
     "build": "next build --turbopack",
     "start": "next start",
-    "lint": "eslint"
+    "lint": "eslint",
+    "postinstall": "playwright install chromium",
+    "test": "playwright test",
+    "test:ui": "playwright test --ui",
+    "test:report": "playwright show-report"
   },
   "dependencies": {
     "next": "15.5.2",
@@ -17,9 +21,11 @@
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3",
+    "@playwright/test": "^1.56.1",
     "@types/node": "^20",
     "@types/react": "^19",
     "@types/react-dom": "^19",
+    "dotenv": "^17.2.3",
     "eslint": "^9",
     "eslint-config-next": "15.5.2",
     "typescript": "^5"

basics/next-app-router/playwright.config.ts

@@ -0,0 +1,56 @@
+// @ignoreFile
+import { defineConfig, devices } from '@playwright/test';
+import { config } from 'dotenv';
+
+// Load environment variables from .env file
+config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './tests',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: 'http://127.0.0.1:3333',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Global timeout settings */
+  timeout: 180000, // 3 minutes for individual tests
+  expect: {
+    timeout: 60000, // 1 minute for expect assertions
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+      snapshotPathTemplate: '{testDir}/{testFileName}-snapshots/{arg}{ext}',
+    },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: 'pnpm dev --port 3333',
+    url: 'http://127.0.0.1:3333',
+    reuseExistingServer: false, // Always start fresh
+  },
+});
+
+

basics/next-app-router/pnpm-lock.yaml

@@ -12,6 +12,7 @@ export function getPostHogClient() {
         flushInterval: 0
       }
     );
+    posthogClient.debug(true);
   }
   return posthogClient;
 }