ci: init e2e test for browser env, tidy other tests

.github/workflows/test.yml

@@ -2,9 +2,9 @@ name: test
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
   test:
@@ -15,23 +15,24 @@ jobs:
         node-version: [20.x, 22.x]
 
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
 
-    - name: Build
-      run: |
-        rm package-lock.json
-        npm install -g npm@latest
-        npm install
-        npm run test
+      - name: Build
+        run: |
+          rm package-lock.json
+          npm install -g npm@latest
+          npm install
+          npm run test
 
   api-test:
+    name: backend (node env, api-test)
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 5
 
     strategy:
       matrix:
@@ -44,8 +45,98 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          
+
       - name: API Test
         run: |
-          pip install -r ./tools/api-tester/ci/requirements.txt
-          ./tools/api-tester/ci/run.py
+          pip install -r ./tests/ci/requirements.txt
+          ./tests/ci/api-test.py
+
+  playwright-test:
+    name: puterjs (browser env, playwright)
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install Dependencies
+        run: npm install
+        working-directory: ./tests/playwright
+
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+        working-directory: ./tests/playwright
+
+      - name: Playwright Test
+        run: |
+          pip install -r ./tests/ci/requirements.txt
+          ./tests/ci/playwright-test.py
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: server-logs
+          path: |
+            /tmp/backend.log
+            /tmp/fs-tree-manager.log
+          retention-days: 3
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+          name: config-files
+          path: |
+            ./volatile/config/config.json
+            ./src/fs_tree_manager/config.yaml
+            ./tests/client-config.yaml
+          retention-days: 3
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        id: playwright-report
+        with:
+          name: playwright-report
+          path: tests/playwright/playwright-report/
+          retention-days: 3
+
+      - name: Get Playwright artifact URL
+        run: |
+          ARTIFACT_URL=$(gh api repos/${{ github.repository }}/actions/runs/${{ github.run_id }}/artifacts \
+            --jq '.artifacts[] | select(.name=="playwright-report") | .archive_download_url')
+          echo "url=$ARTIFACT_URL" >> $GITHUB_OUTPUT
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Output artifact URL
+        run: echo 'Artifact URL is ${{ steps.playwright-report.outputs.artifact-url }}'
+
+  vitest:
+    name: puterjs (node env, vitest)
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Vitest Test
+        run: |
+          pip install -r ./tests/ci/requirements.txt
+          ./tests/ci/vitest.py

.gitignore

@@ -45,10 +45,22 @@ jsconfig.json
 # the exact tree installed in the node_modules folder
 package-lock.json
 
+# ======================================================================
+# playwright test (currently only test the file-system)
+# ======================================================================
+tests/client-config.yaml
+
+# ======================================================================
+# python
+# ======================================================================
+__pycache__/
+
+# ======================================================================
+# other
+# ======================================================================
 # AI STUFF
 AGENTS.md
 .roo
 
-
 # source maps
 *.map

doc/test/playwright-test.md

@@ -0,0 +1,54 @@
+## Summary
+
+Playwright test the puter-js API in browser environment.
+
+## Motivation
+
+Some features of the puter-js/puter-GUI only work in the browser environment:
+
+- file system
+    - naive-cache
+    - client-replica (WIP)
+    - wspush
+
+## Setup
+
+Install dependencies:
+
+```sh
+cd ./tests/playwright
+npm install
+npx playwright install --with-deps
+```
+
+Initialize the client config (working directory: `./tests/playwright`):
+
+1. `cp ../example-client-config.yaml ../client-config.yaml`
+2. Edit the `client-config.yaml` to set the `auth_token`
+
+## Run tests
+
+### CLI
+
+Working directory: `./tests/playwright`
+
+```sh
+# run all tests
+npx playwright test
+
+# run a test by name
+# e.g: npx playwright test -g "mkdir in root directory is prohibited"
+npx playwright test -g "mkdir in root directory is prohibited"
+
+# run the tests that failed in the last test run
+npx playwright test --last-failed
+
+# open the report of the last test run in the browser
+npx playwright show-report
+```
+
+### VSCode/Cursor
+
+1. Install the "Playwright Test for VSCode" extension.
+2. Go to "Testing" tab in the sidebar.
+3. Click buttons to run tests.

eslint.config.js

@@ -51,6 +51,7 @@ export default defineConfig([
     // TypeScript support block
     {
         files: ['**/*.ts'],
+        ignores: ['tests/**/*.ts'],
         languageOptions: {
             parser: tseslintParser,
             parserOptions: {
@@ -70,6 +71,28 @@ export default defineConfig([
             '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
         },
     },
+    // TypeScript support for tests
+    {
+        files: ['tests/**/*.ts'],
+        languageOptions: {
+            parser: tseslintParser,
+            parserOptions: {
+                ecmaVersion: 'latest',
+                sourceType: 'module',
+                project: './tests/tsconfig.json',
+            },
+        },
+        plugins: {
+            '@typescript-eslint': tseslintPlugin,
+        },
+        rules: {
+            // Recommended rules for TypeScript
+            '@typescript-eslint/no-explicit-any': 'warn',
+            '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+            '@typescript-eslint/ban-ts-comment': 'warn',
+            '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+        },
+    },
     {
         plugins: {
             js,