chore: add playwright test

Author: ddadaal

.github/workflows/build.yaml

@@ -0,0 +1,51 @@
+name: Build
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  build:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pnpm/[email protected]
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: pnpm i --frozen-lockfile
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+
+      - name: Build
+        run: pnpm build
+
+      - name: Run Playwright tests
+        working-directory: example
+        run: pnpm test
+
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: playwright-report
+          path: example/playwright-report/
+          retention-days: 30
+
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        if: github.ref == 'refs/heads/master'
+        with:
+          publish: pnpm run publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+

example/jest.config.mjs

@@ -7,7 +7,7 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "test": "jest"
+    "test": "playwright test"
   },
   "dependencies": {
     "@ddadaal/next-typed-api-routes-runtime": "workspace:*",
@@ -20,10 +20,6 @@
     "@next/bundle-analyzer": "^12.0.4",
     "@types/react": "18.0.12",
     "@babel/core": ">=7.0.0 <8.0.0",
-    "jest": "29.5.0",
-    "jest-environment-jsdom": "29.5.0",
-    "@testing-library/react": "14.0.0",
-    "@testing-library/jest-dom": "5.16.5",
-    "whatwg-fetch": "3.6.2"
+    "@playwright/test": "1.34.3"
   }
 }

example/package.json

@@ -0,0 +1,11 @@
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  // Run your local dev server before starting the tests
+  webServer: {
+    command: 'pnpm dev',
+    url: 'http://127.0.0.1:3000',
+    reuseExistingServer: !process.env.CI,
+    stdout: "pipe",
+  },
+});

example/playwright.config.ts

@@ -1,6 +1,7 @@
 import { api } from "../src/apis/api";
+import { test, expect } from '@playwright/test';
 
-it("should call zodRoute", async () => {
+test("should call zodRoute", async ({ page }) => {
   const resp = await api.zodRoute({ body: { info: "test" }, query: { test: "123" } });
 
   expect(resp.hello).toBe("test 123");

example/tests/apis.test.ts

@@ -1,9 +1,11 @@
 {
   "name": "@ddadaal/next-typed-api-routes",
   "version": "0.2.12",
+  "private": true,
   "description": "Make Next.js API Routes strongly typed with routes and clients type completion and auto-generated parameter validation",
   "scripts": {
-    "build": "pnpm --filter !example run build"
+    "build": "pnpm --filter !example run build",
+    "publish": "pnpm publish"
   },
   "homepage": "https://github.com/ddadaal/next-typed-api-routes#readme",
   "devDependencies": {