fix: centralize desktop transport contract

Author: zouyonghe

scripts/prepare-resources/bridge-bootstrap-updater-contract.test.mjs

@@ -3,6 +3,10 @@ import assert from 'node:assert/strict';
 import { readFile } from 'node:fs/promises';
 
 const bootstrapPath = new URL('../../src-tauri/src/bridge_bootstrap.js', import.meta.url);
+const chatTransportContractPath = new URL(
+  '../../src-tauri/src/desktop_bridge_chat_transport_contract.json',
+  import.meta.url,
+);
 
 test('bridge bootstrap defines astrbotAppUpdater methods', async () => {
   const source = await readFile(bootstrapPath, 'utf8');
@@ -13,3 +17,17 @@ test('bridge bootstrap defines astrbotAppUpdater methods', async () => {
   assert.match(source, /checkForAppUpdate:\s*\(\)\s*=>/);
   assert.match(source, /installAppUpdate:\s*\(\)\s*=>/);
 });
+
+test('bridge bootstrap transport placeholders are backed by the shared contract', async () => {
+  const [source, rawContract] = await Promise.all([
+    readFile(bootstrapPath, 'utf8'),
+    readFile(chatTransportContractPath, 'utf8'),
+  ]);
+  const contract = JSON.parse(rawContract);
+
+  assert.equal(typeof contract.storageKey, 'string');
+  assert.equal(typeof contract.websocketValue, 'string');
+  assert.match(source, /if \(typeof window === 'undefined'\) return;/);
+  assert.match(source, /\{CHAT_TRANSPORT_MODE_STORAGE_KEY\}/);
+  assert.match(source, /\{CHAT_TRANSPORT_MODE_WEBSOCKET\}/);
+});

scripts/prepare-resources/desktop-bridge-expectations.mjs

@@ -1,7 +1,25 @@
+import { readFileSync } from 'node:fs';
+
 const escapeRegex = (value) => value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 
-const CHAT_TRANSPORT_MODE_STORAGE_KEY = 'chat.transportMode';
-const CHAT_TRANSPORT_MODE_WEBSOCKET = 'websocket';
+const chatTransportContractPath = new URL(
+  '../../src-tauri/src/desktop_bridge_chat_transport_contract.json',
+  import.meta.url,
+);
+const chatTransportContract = JSON.parse(readFileSync(chatTransportContractPath, 'utf8'));
+const CHAT_TRANSPORT_MODE_STORAGE_KEY = chatTransportContract.storageKey;
+const CHAT_TRANSPORT_MODE_WEBSOCKET = chatTransportContract.websocketValue;
+
+if (
+  typeof CHAT_TRANSPORT_MODE_STORAGE_KEY !== 'string' ||
+  !CHAT_TRANSPORT_MODE_STORAGE_KEY ||
+  typeof CHAT_TRANSPORT_MODE_WEBSOCKET !== 'string' ||
+  !CHAT_TRANSPORT_MODE_WEBSOCKET
+) {
+  throw new Error(
+    'desktop bridge chat transport contract must define non-empty string storageKey and websocketValue fields',
+  );
+}
 
 const CHAT_TRANSPORT_STORAGE_KEY_PATTERN = escapeRegex(CHAT_TRANSPORT_MODE_STORAGE_KEY);
 const CHAT_TRANSPORT_WEBSOCKET_PATTERN = escapeRegex(CHAT_TRANSPORT_MODE_WEBSOCKET);

src-tauri/src/bridge/desktop.rs

@@ -1,16 +1,39 @@
 use std::sync::OnceLock;
 
+use serde::Deserialize;
 use url::Url;
 
 use crate::bridge::origin_policy;
 
 static DESKTOP_BRIDGE_BOOTSTRAP_TEMPLATE: &str = include_str!("../bridge_bootstrap.js");
+static DESKTOP_BRIDGE_CHAT_TRANSPORT_CONTRACT_TEMPLATE: &str =
+    include_str!("../desktop_bridge_chat_transport_contract.json");
 static DESKTOP_BRIDGE_BOOTSTRAP_SCRIPT: OnceLock<String> = OnceLock::new();
+static DESKTOP_BRIDGE_CHAT_TRANSPORT_CONTRACT: OnceLock<DesktopBridgeChatTransportContract> =
+    OnceLock::new();
+
+#[derive(Deserialize)]
+#[serde(rename_all = "camelCase")]
+struct DesktopBridgeChatTransportContract {
+    storage_key: String,
+    websocket_value: String,
+}
+
+fn desktop_bridge_chat_transport_contract() -> &'static DesktopBridgeChatTransportContract {
+    DESKTOP_BRIDGE_CHAT_TRANSPORT_CONTRACT.get_or_init(|| {
+        serde_json::from_str(DESKTOP_BRIDGE_CHAT_TRANSPORT_CONTRACT_TEMPLATE)
+            .expect("desktop bridge chat transport contract must be valid JSON")
+    })
+}
 
 fn desktop_bridge_bootstrap_script(event_name: &str) -> &'static str {
     DESKTOP_BRIDGE_BOOTSTRAP_SCRIPT
         .get_or_init(|| {
-            DESKTOP_BRIDGE_BOOTSTRAP_TEMPLATE.replace("{TRAY_RESTART_BACKEND_EVENT}", event_name)
+            let contract = desktop_bridge_chat_transport_contract();
+            DESKTOP_BRIDGE_BOOTSTRAP_TEMPLATE
+                .replace("{TRAY_RESTART_BACKEND_EVENT}", event_name)
+                .replace("{CHAT_TRANSPORT_MODE_STORAGE_KEY}", &contract.storage_key)
+                .replace("{CHAT_TRANSPORT_MODE_WEBSOCKET}", &contract.websocket_value)
         })
         .as_str()
 }

src-tauri/src/bridge_bootstrap.js

@@ -1,4 +1,6 @@
 (() => {
+  if (typeof window === 'undefined') return;
+
   const existingTrayRestartState = window.__astrbotDesktopTrayRestartState;
   if (
     window.astrbotDesktop &&
@@ -148,11 +150,10 @@
 
   const TOKEN_STORAGE_KEY = 'token';
   const SHELL_LOCALE_STORAGE_KEY = 'astrbot-locale';
-  // Mirror AstrBot dashboard transport persistence. Resource preparation verifies
-  // the upstream ChatUI still recognizes this storage contract before packaging.
+  // Values are injected from the shared desktop bridge transport contract.
   const CHAT_TRANSPORT = Object.freeze({
-    STORAGE_KEY: 'chat.transportMode',
-    WEBSOCKET: 'websocket',
+    STORAGE_KEY: '{CHAT_TRANSPORT_MODE_STORAGE_KEY}',
+    WEBSOCKET: '{CHAT_TRANSPORT_MODE_WEBSOCKET}',
   });
   const STORAGE_SYNC_PATCHED_FLAG = '__astrbotDesktopStorageSyncPatched';
   const LEGACY_TOKEN_SYNC_PATCHED_FLAG = '__astrbotDesktopTokenSyncPatched';

src-tauri/src/desktop_bridge_chat_transport_contract.json

@@ -0,0 +1,4 @@
+{
+  "storageKey": "chat.transportMode",
+  "websocketValue": "websocket"
+}