Use Playwright to test demos

.github/workflows/ci.yaml

@@ -5,12 +5,6 @@ on:
   release:
     types: [published]
 
-env:
-  LOCAL-NOTARY: true
-  LOCAL-WS: false
-  HEADLESS: true
-  PUPPETEER_SKIP_DOWNLOAD: true
-
 jobs:
   build-and-test:
     name: Build and test
@@ -37,7 +31,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: 'npm'
 
       - name: Install stable nightly toolchain
@@ -61,27 +55,18 @@ jobs:
 
       - name: Build
         run: npm run build
-          
+
       - name: Lint
         run: npm run lint
-
-      - name: Install Chrome
-        uses: browser-actions/setup-chrome@v1
-        id: setup-chrome
-        with:
-          chrome-version: 121.0.6167.85
 
-      - name: Set CHROME_PATH environment variable
-        run: echo "CHROME_PATH=${{ steps.setup-chrome.outputs['chrome-path'] }}" >> $GITHUB_ENV
+      - name: install wstcp
+        run: cargo install wstcp
+
+      - name: Install Chromium (Playwright)
+        run: npx playwright install --with-deps chromium
 
       - name: Test
-        run: |
-          # Install wstcp and use it in the background
-          cargo install wstcp
-          wstcp --bind-addr 127.0.0.1:55688 raw.githubusercontent.com:443 &
-          WSTCP_PID=$!
-          trap "kill $WSTCP_PID" EXIT
-          npm run test
+        run: npm run test
 
       - name: Determine release type (dry-run or publish)
         run: |

.github/workflows/playwright.yml

@@ -0,0 +1,54 @@
+name: Tests demos
+on:
+  pull_request:
+jobs:
+  test:
+    timeout-minutes: 60
+    name: Tests demos
+    runs-on: ubuntu-latest
+    services:
+      notary-server:
+        image: ghcr.io/tlsnotary/tlsn/notary-server:v0.1.0-alpha.10
+        env:
+          NOTARY_SERVER__TLS__ENABLED: false
+        ports:
+          - 7047:7047
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: build tlsn-js
+      run: npm ci; npm run build
+    - name: install wstcp
+      run: cargo install wstcp
+    - name: Install Chromium (Playwright)
+      run: npx playwright install --with-deps chromium
+    - name: Test react demo
+      working-directory: demo/react-ts-webpack
+      continue-on-error: true
+      run: |
+        set -e
+        npm i
+        npm run test
+    - name: Test interactive verifier demo
+      continue-on-error: true
+      run: |
+        set -e
+        cd demo/interactive-demo/verifier-rs
+        cargo build --release
+        cd ../prover-ts
+        npm i
+        npm run test
+    - name: Test web-to-web p2p demo
+      working-directory: demo/react-ts-webpack
+      continue-on-error: true
+      run: |
+        set -e
+        npm run test
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report
+        path: '**/playwright-report/'
+        retention-days: 30

.gitignore

@@ -6,4 +6,10 @@ dev-build/
 test-build/
 ./demo/node_modules
 utils/tlsn
-.vscode
+.vscode
+
+# Playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

demo/interactive-demo/README.md

@@ -1,38 +1,59 @@
-# Test Rust Prover
-
-1. Start the verifier:
-```bash
-cd verifier-rs; cargo run --release
-```
-2. Run the prover:
-```bash
-cd prover-rs; cargo run --release
-```
-
-# Test Browser Prover
-1. Start the verifier:
-```bash
-cd verifier-rs; cargo run --release
-```
-2. Since a web browser doesn't have the ability to make TCP connection, we need to use a websocket proxy server to access <raw.githubusercontent.com>.
-```bash
-cargo install wstcp
-
-wstcp --bind-addr 127.0.0.1:55688 raw.githubusercontent.com:443
-```
-3. Run the prover
-    1. Build tlsn-js
+# Interactive Verifier Demo
+
+This demo shows how to use TLSNotary **without a notary**: a direct proof between a prover and a verifier, where the verifier checks both the TLS session and the revealed data.
+
+There are two prover implementations:
+- **Rust**
+- **TypeScript** (browser)
+The verifier is implemented in Rust.
+
+---
+
+## Interactive Verifier Demo with Rust Prover
+
+1. **Start the verifier:**
+    ```bash
+    cd verifier-rs
+    cargo run --release
+    ```
+2. **Run the prover:**
+    ```bash
+    cd prover-rs
+    cargo run --release
+    ```
+
+---
+
+## Interactive Verifier Demo with TypeScript Prover (Browser)
+
+1. **Start the verifier:**
+    ```bash
+    cd verifier-rs
+    cargo run --release
+    ```
+2. **Set up a websocket proxy for raw.githubusercontent.com**  
+   Browsers cannot make raw TCP connections, so a websocket proxy is required:
+    ```bash
+    cargo install wstcp
+    wstcp --bind-addr 127.0.0.1:55688 raw.githubusercontent.com:443
+    ```
+3. **Run the prover in the browser:**
+    1. **Build tlsn-js**
         ```bash
         cd ..
-        npm i
+        npm install
         npm run build
-        npm link
         ```
-    2. Build demo prover-ts
+    2. **Build and start the TypeScript prover demo**
         ```bash
         cd prover-ts
-        npm i
-        npm link
+        npm install
         npm run dev
         ```
-    3. Open <http://localhost:3456/> and click **Start Prover**
+    3. **Open the demo in your browser:**  
+       Go to [http://localhost:8080/](http://localhost:8080/) and click **Start Prover**.
+
+---
+
+**Tip:**  
+If you encounter issues, make sure all dependencies are installed and the websocket proxy is running before starting the browser demo.

demo/interactive-demo/prover-ts/.gitignore

@@ -1 +1,8 @@
 package-lock.json
+
+# Playwright
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

demo/interactive-demo/prover-ts/index.ejs

@@ -4,7 +4,7 @@
 <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>React/Typescript Example</title>
+    <title>TLSNotary React TypeScript Demo</title>
 </head>
 
 <body>

demo/interactive-demo/prover-ts/package.json

@@ -4,7 +4,9 @@
   "description": "",
   "main": "webpack.js",
   "scripts": {
-    "dev": "webpack-dev-server --config webpack.js"
+    "dev": "webpack-dev-server --config webpack.js",
+    "start": "webpack serve --config webpack.js",
+    "test": "npx playwright test"
   },
   "author": "",
   "license": "ISC",

demo/interactive-demo/prover-ts/playwright.config.ts

@@ -0,0 +1,90 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * 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://localhost:8080',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    // {
+    //   name: 'firefox',
+    //   use: { ...devices['Desktop Firefox'] },
+    // },
+
+    // {
+    //   name: 'webkit',
+    //   use: { ...devices['Desktop Safari'] },
+    // },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: [
+    {
+      command: 'npm run start',
+      url: 'http://localhost:8080',
+      reuseExistingServer: !process.env.CI,
+    },
+    {
+      command: 'wstcp --bind-addr 127.0.0.1:55688 raw.githubusercontent.com:443',
+      reuseExistingServer: true,
+    },
+    {
+      command: 'cargo run --release',
+      cwd: '../verifier-rs',
+      reuseExistingServer: true,
+    }
+  ]
+});

demo/interactive-demo/prover-ts/src/app.tsx

@@ -224,7 +224,7 @@ function App(): ReactElement {
           </div>
         ) : (
           <div className="bg-gray-100 border border-gray-300 p-4 rounded-lg mt-4">
-            <pre className="text-left text-sm text-gray-800 whitespace-pre-wrap overflow-auto">
+            <pre data-testid="proof-data" className="text-left text-sm text-gray-800 whitespace-pre-wrap overflow-auto">
               {JSON.stringify(result, null, 2)}
             </pre>
           </div>

demo/interactive-demo/prover-ts/tests/demo-flow.spec.ts

@@ -0,0 +1,16 @@
+import { test, expect } from '@playwright/test';
+
+test('has title', async ({ page }) => {
+  await page.goto('/');
+  await expect(page).toHaveTitle(/TLSNotary/)
+});
+
+test('run demo', async ({ page }) => {
+  await page.goto('/');
+
+  // Click the get started link.
+  await page.getByRole('button', { name: 'Start Prover' }).click();
+
+  await expect(page.getByTestId('proof-data')).toContainText('Unredacted data successfully revealed to Verifier', { timeout: 60000 });
+
+});

demo/react-ts-webpack/.gitignore

@@ -1 +1,8 @@
 package-lock.json
+
+# Playwright
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/