chore(chrome-extension): CI sync, smoke tests, background worker

itsardalan007-afk · cursoragent · itsardalan007-afk · commit d0be6093b3be · 2026-05-13T16:36:04.000+03:30
Adds Code.gs sync check workflow, release gate, Playwright AUTH_KEY smoke test, empty MV3 service worker for test discovery, and extension assets.

Co-authored-by: Cursor &lt;cursoragent@cursor.com&gt;
diff --git a/.github/workflows/chrome-extension.yml b/.github/workflows/chrome-extension.yml
@@ -0,0 +1,61 @@
+name: chrome-extension
+
+on:
+  pull_request:
+    paths:
+      - 'assets/apps_script/Code.gs'
+      - 'chrome-extension/**'
+      - '.github/workflows/chrome-extension.yml'
+  push:
+    branches:
+      - main
+    paths:
+      - 'assets/apps_script/Code.gs'
+      - 'chrome-extension/**'
+      - '.github/workflows/chrome-extension.yml'
+
+permissions:
+  contents: read
+
+jobs:
+  bundled-code-sync:
+    name: bundled Code.gs stays in sync
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Compare Apps Script source with extension fallback
+        run: |
+          if ! cmp -s assets/apps_script/Code.gs chrome-extension/Code.gs; then
+            echo "::error file=chrome-extension/Code.gs::chrome-extension/Code.gs must match assets/apps_script/Code.gs. Update the bundled fallback whenever the canonical Apps Script changes."
+            diff -u assets/apps_script/Code.gs chrome-extension/Code.gs || true
+            exit 1
+          fi
+
+  auth-key-smoke-test:
+    name: auth key smoke test
+    runs-on: ubuntu-latest
+    needs: bundled-code-sync
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install test dependencies
+        working-directory: chrome-extension
+        run: npm install
+
+      - name: Install Playwright browser
+        working-directory: chrome-extension
+        run: npx playwright install --with-deps chromium
+
+      - name: Run extension smoke tests
+        working-directory: chrome-extension
+        run: xvfb-run npm run test:smoke
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -46,7 +46,23 @@ permissions:
 # and more importantly keeps target/ warm via the rust-cache action.
 
 jobs:
+  verify-chrome-extension-codegs-sync:
+    name: verify chrome-extension Code.gs sync
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Compare Apps Script source with extension fallback
+        run: |
+          if ! cmp -s assets/apps_script/Code.gs chrome-extension/Code.gs; then
+            echo "::error file=chrome-extension/Code.gs::chrome-extension/Code.gs must match assets/apps_script/Code.gs. Update the bundled fallback whenever the canonical Apps Script changes."
+            diff -u assets/apps_script/Code.gs chrome-extension/Code.gs || true
+            exit 1
+          fi
+
   build:
+    needs: verify-chrome-extension-codegs-sync
     strategy:
       fail-fast: false
       matrix:
diff --git a/chrome-extension/.gitignore b/chrome-extension/.gitignore
@@ -0,0 +1,29 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+*.codex
+node_modules
+test-results
+playwright-report
+dist
+dist-ssr
+*.local
+*.env
+*.env.*.local
+!.env.example
+!.env.*.example
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/chrome-extension/assets/logo.webp b/chrome-extension/assets/logo.webp
diff --git a/chrome-extension/background.js b/chrome-extension/background.js
@@ -0,0 +1,2 @@
+// Intentionally empty service worker.
+// Keeps extension runtime discoverable for automated smoke tests.
diff --git a/chrome-extension/manifest.json b/chrome-extension/manifest.json
@@ -8,6 +8,9 @@
     "default_title": "__MSG_extName__",
     "default_popup": "popup.html"
   },
+  "background": {
+    "service_worker": "background.js"
+  },
   "permissions": ["storage", "clipboardWrite"],
   "host_permissions": ["https://script.google.com/*", "https://raw.githubusercontent.com/*", "https://api.github.com/*"]
 }
diff --git a/chrome-extension/messages.json b/chrome-extension/messages.json
@@ -16,6 +16,7 @@
     "downloadScript": "Download Code.gs",
     "openScript": "Open Apps Script",
     "scriptNotice": "The script is loaded from the extension package and includes the same relay protocol used by mhrv-rs.",
+    "checkScriptVersion": "Check latest Code.gs",
     "step3Title": "Step 3: Create config",
     "step3Desc": "Paste your Deployment ID and the auth key into your local config.",
     "deploymentIdLabel": "Deployment ID",
@@ -36,6 +37,11 @@
     "generateKeyFirst": "Generate an auth key first.",
     "copyError": "Could not copy {item}.",
     "fetchError": "Failed to load Code.gs at all."
+    ,
+    "scriptUpToDate": "Your bundled Code.gs matches the latest upstream version.",
+    "scriptOutdated": "Update available: your bundled Code.gs differs from upstream.",
+    "scriptCheckFailed": "Could not verify Code.gs version.",
+    "scriptCheckNetworkBlocked": "Could not reach upstream to check Code.gs (network blocked/offline)."
   },
   "fa": {
     "appName": "کمک‌کننده اسکریپت اپس mhrv-rs",
@@ -54,6 +60,7 @@
     "downloadScript": "دانلود Code.gs",
     "openScript": "باز کردن Apps Script",
     "scriptNotice": "اسکریپت از بسته افزونه بارگذاری می‌شود و شامل همان پروتکل رله استفاده شده توسط mhrv-rs است.",
+    "checkScriptVersion": "بررسی آخرین نسخه Code.gs",
     "step3Title": "مرحله ۳: ایجاد پیکربندی",
     "step3Desc": "شناسه استقرار و کلید احراز هویت را در پیکربندی محلی خود جای‌گذاری کنید.",
     "deploymentIdLabel": "شناسه استقرار",
@@ -74,5 +81,10 @@
     "generateKeyFirst": "ابتدا یک کلید احراز هویت تولید کنید.",
     "copyError": "کپی {item} امکان‌پذیر نبود.",
     "fetchError": "بارگذاری Code.gs به طور کامل ناموفق بود."
+    ,
+    "scriptUpToDate": "Code.gs داخلی افزونه با آخرین نسخه upstream یکسان است.",
+    "scriptOutdated": "به‌روزرسانی موجود است: Code.gs داخلی افزونه با upstream متفاوت است.",
+    "scriptCheckFailed": "امکان بررسی نسخه Code.gs وجود ندارد.",
+    "scriptCheckNetworkBlocked": "امکان دسترسی به upstream برای بررسی Code.gs نبود (اینترنت/شبکه مسدود یا آفلاین)."
   }
 }
diff --git a/chrome-extension/package-lock.json b/chrome-extension/package-lock.json
diff --git a/chrome-extension/package.json b/chrome-extension/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "mhrv-helper-extension-tests",
+  "private": true,
+  "scripts": {
+    "test:smoke": "playwright test --config=playwright.config.js"
+  },
+  "devDependencies": {
+    "@playwright/test": "latest"
+  }
+}
diff --git a/chrome-extension/playwright.config.js b/chrome-extension/playwright.config.js
@@ -0,0 +1,27 @@
+const { defineConfig } = require('@playwright/test');
+const path = require('path');
+
+module.exports = defineConfig({
+  testDir: './tests',
+  timeout: 60_000,
+  fullyParallel: false,
+  retries: 0,
+  reporter: 'list',
+  use: {
+    headless: false,
+  },
+  projects: [
+    {
+      name: 'chromium-extension',
+      use: {
+        channel: 'chromium',
+        launchOptions: {
+          args: [
+            `--disable-extensions-except=${path.resolve(__dirname)}`,
+            `--load-extension=${path.resolve(__dirname)}`,
+          ],
+        },
+      },
+    },
+  ],
+});
diff --git a/chrome-extension/popup.css b/chrome-extension/popup.css
@@ -172,6 +172,10 @@ button#open-releases::before {
   background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke='currentColor'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M10 6H6a2 2 0 00-2 2v10a2 2 0 002 2h10a2 2 0 002-2v-4M14 4h6m0 0v6m0-6L10 14'/%3E%3C/svg%3E");
 }
 
+button#check-script-version::before {
+  background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 24 24' stroke='currentColor'%3E%3Cpath stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z'/%3E%3C/svg%3E");
+}
+
 button.secondary {
   background: var(--bg-secondary);
   color: var(--secondary);
diff --git a/chrome-extension/popup.html b/chrome-extension/popup.html
@@ -44,6 +44,7 @@ <h2 data-i18n="step2Title">Step 2: Build your Apps Script</h2>
       <div class="row">
         <button id="copy-script" data-i18n="copyScript">Copy Code.gs</button>
         <button id="download-script" class="secondary" data-i18n="downloadScript">Download Code.gs</button>
+        <button id="check-script-version" class="secondary" data-i18n="checkScriptVersion">Check latest Code.gs</button>
         <button id="open-script" class="secondary" data-i18n="openScript">Open Apps Script</button>
       </div>
       <div class="progress" id="script-progress"></div>
diff --git a/chrome-extension/popup.js b/chrome-extension/popup.js
@@ -14,6 +14,7 @@ const elements = {
   copyKey: document.getElementById('copy-key'),
   copyScript: document.getElementById('copy-script'),
   downloadScript: document.getElementById('download-script'),
+  checkScriptVersion: document.getElementById('check-script-version'),
   openScript: document.getElementById('open-script'),
   copyConfig: document.getElementById('copy-config'),
   openReadme: document.getElementById('open-readme'),
@@ -23,6 +24,18 @@ const elements = {
   scriptProgress: document.getElementById('script-progress'),
 };
 
+function toHex(bytes) {
+  return Array.from(bytes)
+    .map((b) => b.toString(16).padStart(2, '0'))
+    .join('');
+}
+
+async function sha256(text) {
+  const data = new TextEncoder().encode(text);
+  const digest = await crypto.subtle.digest('SHA-256', data);
+  return toHex(new Uint8Array(digest));
+}
+
 async function loadMessages() {
   try {
     const response = await fetch(chrome.runtime.getURL('messages.json'));
@@ -177,6 +190,45 @@ function copyText(text, label) {
   );
 }
 
+async function checkScriptVersion() {
+  elements.scriptProgress.style.display = 'block';
+  try {
+    const [remoteResp, localResp] = await Promise.all([
+      fetch(CODE_FILE_URL, { cache: 'no-store' }),
+      fetch(chrome.runtime.getURL(CODE_FILE)),
+    ]);
+
+    if (!localResp.ok) {
+      showMessage(getMessage('scriptCheckFailed'), true);
+      return;
+    }
+
+    const localText = await localResp.text();
+    const localHash = await sha256(localText);
+
+    if (!remoteResp.ok) {
+      // Network / censorship realities: just report we couldn't check.
+      showMessage(getMessage('scriptCheckNetworkBlocked'), true);
+      return;
+    }
+
+    const remoteText = await remoteResp.text();
+    const remoteHash = await sha256(remoteText);
+
+    if (remoteHash === localHash) {
+      showMessage(getMessage('scriptUpToDate'));
+      return;
+    }
+
+    showMessage(getMessage('scriptOutdated'), true);
+  } catch (err) {
+    console.error(err);
+    showMessage(getMessage('scriptCheckFailed'), true);
+  } finally {
+    elements.scriptProgress.style.display = 'none';
+  }
+}
+
 async function downloadLatestRust() {
   try {
     const response = await fetch('https://api.github.com/repos/therealaleph/MasterHttpRelayVPN-RUST/releases/latest');
@@ -272,6 +324,8 @@ function initListeners() {
     window.open('https://github.com/therealaleph/MasterHttpRelayVPN-RUST/blob/main/docs/guide.md', '_blank');
   });
 
+  elements.checkScriptVersion.addEventListener('click', () => checkScriptVersion());
+
   elements.downloadRust.addEventListener('click', () => downloadLatestRust());
   elements.openReleases.addEventListener('click', () => window.open('https://github.com/therealaleph/MasterHttpRelayVPN-RUST/releases', '_blank'));
 
diff --git a/chrome-extension/tests/auth-key-smoke.spec.js b/chrome-extension/tests/auth-key-smoke.spec.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Intentionally empty service worker.`
	`2`	`+// Keeps extension runtime discoverable for automated smoke tests.`