feat(saas): Phase 4 端到端完善 — 设备注册、离线支持、配置迁移、集成测试

- 后端: devices 表 + register/heartbeat/list 端点 (UPSERT 语义)
- 桌面端: 设备 ID 持久化 + 5 分钟心跳 + 离线状态指示
- saas-client: 重试逻辑 (2 次指数退避) + isServerReachable 跟踪
- ConfigMigrationWizard: 3 步向导 (方向选择→冲突解决→结果)
- SaaSSettings: 修改密码折叠面板 + 迁移向导入口
- 集成测试: 21 个测试全部通过 (含设备注册/UPSERT/心跳、密码修改、E2E 生命周期)
- 修复 ConfigMigrationWizard merge 分支变量遮蔽 bug
This commit is contained in:
iven
2026-03-27 15:07:03 +08:00
parent 8cce2283f7
commit bc12f6899a
9 changed files with 1007 additions and 39 deletions

View File

@@ -0,0 +1,339 @@
import { useState, useEffect } from 'react';
import { saasClient, type SaaSConfigItem } from '../../lib/saas-client';
import { ArrowLeft, ArrowRight, Upload, Check, Loader2, RefreshCw } from 'lucide-react';
interface LocalModel {
id: string;
name: string;
provider: string;
[key: string]: unknown;
}
type SyncDirection = 'local-to-saas' | 'saas-to-local' | 'merge';
interface SyncConflict {
key: string;
localValue: string | null;
saasValue: string | null;
}
export function ConfigMigrationWizard({ onDone }: { onDone: () => void }) {
const [step, setStep] = useState<1 | 2 | 3>(1);
const [direction, setDirection] = useState<SyncDirection>('local-to-saas');
const [isSyncing, setIsSyncing] = useState(false);
const [syncResult, setSyncResult] = useState<'success' | 'partial' | null>(null);
const [error, setError] = useState<string | null>(null);
// Data
const [localModels, setLocalModels] = useState<LocalModel[]>([]);
const [saasConfigs, setSaasConfigs] = useState<SaaSConfigItem[]>([]);
const [conflicts, setConflicts] = useState<SyncConflict[]>([]);
const [selectedKeys, setSelectedKeys] = useState<Set<string>>(new Set());
// Step 1: Load data
useEffect(() => {
if (step !== 1) return;
// Load local models from localStorage
try {
const raw = localStorage.getItem('zclaw-custom-models');
if (raw) {
const parsed = JSON.parse(raw) as LocalModel[];
setLocalModels(Array.isArray(parsed) ? parsed : []);
}
} catch {
setLocalModels([]);
}
// Load SaaS config items
saasClient.listConfig().then(setSaasConfigs).catch(() => setSaasConfigs([]));
}, [step]);
const localCount = localModels.length;
const saasCount = saasConfigs.length;
// Step 2: Compute conflicts based on direction
useEffect(() => {
if (step !== 2) return;
const found: SyncConflict[] = [];
if (direction === 'local-to-saas' || direction === 'merge') {
// Check which local models already exist in SaaS
for (const model of localModels) {
const exists = saasConfigs.some((c) => c.key_path === `models.${model.id}`);
if (exists) {
found.push({
key: model.id,
localValue: JSON.stringify({ name: model.name, provider: model.provider }),
saasValue: '已存在',
});
}
}
}
if (direction === 'saas-to-local' || direction === 'merge') {
// SaaS configs that have values not in local
for (const config of saasConfigs) {
if (!config.current_value) continue;
const localRaw = localStorage.getItem('zclaw-custom-models');
const localModels: LocalModel[] = localRaw ? JSON.parse(localRaw) : [];
const isLocal = localModels.some((m) => m.id === config.key_path.replace('models.', ''));
if (!isLocal && config.category === 'model') {
found.push({
key: config.key_path,
localValue: null,
saasValue: config.current_value,
});
}
}
}
setConflicts(found);
setSelectedKeys(new Set(found.map((c) => c.key)));
}, [step, direction, localModels, saasConfigs]);
// Step 3: Execute sync
async function executeSync() {
setIsSyncing(true);
setError(null);
try {
if (direction === 'local-to-saas' && localModels.length > 0) {
// Push local models as config items
for (const model of localModels) {
const exists = saasConfigs.some((c) => c.key_path === `models.${model.id}`);
if (exists && !selectedKeys.has(model.id)) continue;
const body = {
category: 'model',
key_path: `models.${model.id}`,
value_type: 'json',
current_value: JSON.stringify({ name: model.name, provider: model.provider }),
source: 'desktop',
description: `从桌面端同步: ${model.name}`,
};
if (exists) {
await saasClient.request<unknown>('PUT', `/api/v1/config/items/${exists}`, body);
} else {
await saasClient.request<unknown>('POST', '/api/v1/config/items', body);
}
}
} else if (direction === 'saas-to-local' && saasConfigs.length > 0) {
// Pull SaaS models to local
const syncedModels = localModels.filter((m) => !selectedKeys.has(m.id));
const saasModels = saasConfigs
.filter((c) => c.category === 'model' && c.current_value)
.map((c) => {
try {
return JSON.parse(c.current_value!) as LocalModel;
} catch {
return null;
}
})
.filter((m): m is LocalModel => m !== null);
const merged = [...syncedModels, ...saasModels];
localStorage.setItem('zclaw-custom-models', JSON.stringify(merged));
} else if (direction === 'merge') {
// Merge: local wins for conflicts
const kept = localModels.filter((m) => !selectedKeys.has(m.id));
const saasOnly = saasConfigs
.filter((c) => c.category === 'model' && c.current_value)
.map((c) => {
try {
return JSON.parse(c.current_value!) as LocalModel;
} catch {
return null;
}
})
.filter((m): m is LocalModel => m !== null)
.filter((m) => !localModels.some((lm) => lm.id === m.id));
const merged = [...kept, ...saasOnly];
localStorage.setItem('zclaw-custom-models', JSON.stringify(merged));
}
setSyncResult(conflicts.length > 0 && conflicts.length === selectedKeys.size ? 'partial' : 'success');
} catch (err: unknown) {
setError(err instanceof Error ? err.message : '同步失败');
} finally {
setIsSyncing(false);
}
}
// Reset
function reset() {
setStep(1);
setDirection('local-to-saas');
setSyncResult(null);
setError(null);
setSelectedKeys(new Set());
}
return (
<div className="bg-white rounded-xl border border-gray-200 p-5 shadow-sm">
{/* Header */}
<div className="flex items-center justify-between mb-4">
<div className="flex items-center gap-2">
<Upload className="w-4 h-4 text-gray-500" />
<span className="text-sm font-medium text-gray-700"></span>
</div>
{step > 1 && (
<button onClick={() => setStep((step - 1) as 1 | 2)} className="text-xs text-gray-500 hover:text-gray-700 cursor-pointer">
<ArrowLeft className="w-3.5 h-3.5 inline" />
</button>
)}
</div>
{/* Step 1: Direction & Preview */}
{step === 1 && (
<div className="space-y-4">
<p className="text-sm text-gray-500">
SaaS
</p>
<div className="space-y-2">
<DirectionOption
label="本地 → SaaS"
description={`${localCount} 个本地模型推送到 SaaS 平台`}
selected={direction === 'local-to-saas'}
onClick={() => setDirection('local-to-saas')}
/>
<DirectionOption
label="SaaS → 本地"
description={`从 SaaS 平台拉取 ${saasCount} 项配置到本地`}
selected={direction === 'saas-to-local'}
onClick={() => setDirection('saas-to-local')}
/>
<DirectionOption
label="双向合并"
description="合并两边配置,冲突时保留本地版本"
selected={direction === 'merge'}
onClick={() => setDirection('merge')}
/>
</div>
<button
onClick={() => setStep(2)}
disabled={localCount === 0 && saasCount === 0}
className="w-full py-2 text-sm font-medium text-white bg-emerald-600 rounded-lg hover:bg-emerald-700 disabled:opacity-50 transition-colors"
>
<ArrowRight className="w-4 h-4 inline" />
</button>
</div>
)}
{/* Step 2: Resolve conflicts */}
{step === 2 && (
<div className="space-y-4">
{conflicts.length > 0 ? (
<>
<p className="text-sm text-amber-600">
{conflicts.length} {direction === 'local-to-saas' ? '本地' : 'SaaS'}
</p>
<div className="space-y-1.5">
{conflicts.map((c) => (
<label key={c.key} className="flex items-center gap-2 p-2 rounded-lg bg-gray-50 cursor-pointer text-sm">
<input
type="checkbox"
checked={selectedKeys.has(c.key)}
onChange={(e) => {
setSelectedKeys((prev) => {
const next = new Set(prev);
if (e.target.checked) next.add(c.key);
else next.delete(c.key);
return next;
});
}}
className="rounded"
/>
<span className="font-medium text-gray-800">{c.key}</span>
<span className="text-xs text-gray-400 truncate">
({direction === 'local-to-saas' ? '本地' : 'SaaS'}: {c.saasValue})
</span>
</label>
))}
</div>
</>
) : (
<div className="flex items-center gap-2 text-sm text-emerald-600">
<Check className="w-4 h-4" />
<span></span>
</div>
)}
<button
onClick={() => { setStep(3); executeSync(); }}
className="w-full py-2 text-sm font-medium text-white bg-emerald-600 rounded-lg hover:bg-emerald-700 transition-colors"
>
{isSyncing ? (
<><Loader2 className="w-4 h-4 inline animate-spin" /> ...</>
) : (
<><ArrowRight className="w-4 h-4 inline" /> </>
)}
</button>
</div>
)}
{/* Step 3: Result */}
{step === 3 && (
<div className="space-y-4">
{syncResult === 'success' ? (
<div className="flex items-center gap-2 text-sm text-emerald-600">
<Check className="w-5 h-5" />
<span></span>
</div>
) : syncResult === 'partial' ? (
<div className="flex items-center gap-2 text-amber-600">
<Check className="w-5 h-5" />
<span>{conflicts.length} </span>
</div>
) : error ? (
<div className="text-sm text-red-500">{error}</div>
) : null}
<div className="flex gap-2">
<button
onClick={reset}
className="flex-1 py-2 text-sm text-gray-600 border border-gray-300 rounded-lg hover:bg-gray-50 transition-colors cursor-pointer"
>
<RefreshCw className="w-3.5 h-3.5 inline" />
</button>
<button
onClick={onDone}
className="flex-1 py-2 text-sm font-medium text-white bg-emerald-600 rounded-lg hover:bg-emerald-700 transition-colors"
>
</button>
</div>
</div>
)}
</div>
);
}
function DirectionOption({
label,
description,
selected,
onClick,
}: {
label: string;
description: string;
selected: boolean;
onClick: () => void;
}) {
return (
<button
onClick={onClick}
className={`w-full text-left p-3 rounded-lg border transition-colors cursor-pointer ${
selected ? 'border-emerald-500 bg-emerald-50' : 'border-gray-200 hover:border-gray-300'
}`}
>
<div className="text-sm font-medium text-gray-800">{label}</div>
<div className="text-xs text-gray-500">{description}</div>
</button>
);
}

View File

@@ -2,6 +2,7 @@ import { useState } from 'react';
import { useSaaSStore } from '../../store/saasStore';
import { SaaSLogin } from './SaaSLogin';
import { SaaSStatus } from './SaaSStatus';
import { ConfigMigrationWizard } from './ConfigMigrationWizard';
import { Cloud, Info, KeyRound } from 'lucide-react';
import { saasClient } from '../../lib/saas-client';
@@ -129,6 +130,16 @@ export function SaaSSettings() {
{/* Password change section */}
{isLoggedIn && !showLogin && <ChangePasswordSection />}
{/* Config migration wizard */}
{isLoggedIn && !showLogin && (
<div className="mt-6">
<h2 className="text-sm font-medium text-gray-500 uppercase tracking-wide mb-3">
</h2>
<ConfigMigrationWizard onDone={() => {/* no-op: wizard self-contained */}} />
</div>
)}
</div>
);
}

View File

@@ -14,6 +14,7 @@ interface SaaSStatusProps {
export function SaaSStatus({ isLoggedIn, account, saasUrl, onLogout, onLogin }: SaaSStatusProps) {
const availableModels = useSaaSStore((s) => s.availableModels);
const fetchAvailableModels = useSaaSStore((s) => s.fetchAvailableModels);
const [serverReachable, setServerReachable] = useState<boolean>(true);
const [checkingHealth, setCheckingHealth] = useState(false);
const [healthOk, setHealthOk] = useState<boolean | null>(null);
@@ -25,6 +26,18 @@ export function SaaSStatus({ isLoggedIn, account, saasUrl, onLogout, onLogin }:
}
}, [isLoggedIn, fetchAvailableModels]);
// Poll server reachability every 30s
useEffect(() => {
if (!isLoggedIn) return;
const check = () => {
setServerReachable(saasClient.isServerReachable());
};
check();
const timer = setInterval(check, 30000);
return () => clearInterval(timer);
}, [isLoggedIn]);
async function checkHealth() {
setCheckingHealth(true);
setHealthOk(null);
@@ -61,10 +74,17 @@ export function SaaSStatus({ isLoggedIn, account, saasUrl, onLogout, onLogin }:
</div>
</div>
<div className="flex items-center gap-2 flex-shrink-0">
<div className="flex items-center gap-1.5 text-emerald-600 text-xs">
<Cloud className="w-3.5 h-3.5" />
<span></span>
</div>
{serverReachable ? (
<div className="flex items-center gap-1.5 text-emerald-600 text-xs">
<Cloud className="w-3.5 h-3.5" />
<span></span>
</div>
) : (
<div className="flex items-center gap-1.5 text-amber-500 text-xs">
<CloudOff className="w-3.5 h-3.5" />
<span>线</span>
</div>
)}
<button
onClick={() => setShowDetails(!showDetails)}
className="px-2 py-1.5 text-xs text-gray-600 border border-gray-300 rounded-lg hover:bg-gray-100 transition-colors cursor-pointer"

View File

@@ -72,6 +72,17 @@ interface SaaSRefreshResponse {
token: string;
}
/** Device info stored on the SaaS backend */
export interface DeviceInfo {
id: string;
device_id: string;
device_name: string | null;
platform: string | null;
app_version: string | null;
last_seen_at: string;
created_at: string;
}
// === Error Class ===
export class SaaSApiError extends Error {
@@ -186,8 +197,17 @@ export class SaaSClient {
// --- Core HTTP ---
/** Track whether the server appears reachable */
private _serverReachable: boolean = true;
/** Check if the SaaS server was last known to be reachable */
isServerReachable(): boolean {
return this._serverReachable;
}
/**
* Make an authenticated request and parse the JSON response.
* Make an authenticated request with automatic retry on transient failures.
* Retries up to 2 times with exponential backoff (1s, 2s).
* Throws SaaSApiError on non-ok responses.
*/
private async request<T>(
@@ -196,40 +216,66 @@ export class SaaSClient {
body?: unknown,
timeoutMs = 15000,
): Promise<T> {
const headers: Record<string, string> = {
'Content-Type': 'application/json',
};
if (this.token) {
headers['Authorization'] = `Bearer ${this.token}`;
const maxRetries = 2;
const baseDelay = 1000;
for (let attempt = 0; attempt <= maxRetries; attempt++) {
const headers: Record<string, string> = {
'Content-Type': 'application/json',
};
if (this.token) {
headers['Authorization'] = `Bearer ${this.token}`;
}
try {
const response = await fetch(`${this.baseUrl}${path}`, {
method,
headers,
body: body !== undefined ? JSON.stringify(body) : undefined,
signal: AbortSignal.timeout(timeoutMs),
});
this._serverReachable = true;
// Handle 401 specially - caller may want to trigger re-auth
if (response.status === 401) {
throw new SaaSApiError(401, 'UNAUTHORIZED', '认证已过期,请重新登录');
}
if (!response.ok) {
const errorBody = (await response.json().catch(() => null)) as SaaSErrorResponse | null;
throw new SaaSApiError(
response.status,
errorBody?.error || 'UNKNOWN',
errorBody?.message || `请求失败 (${response.status})`,
);
}
// 204 No Content
if (response.status === 204) {
return undefined as T;
}
return response.json() as Promise<T>;
} catch (err: unknown) {
const isNetworkError = err instanceof TypeError
&& (err.message.includes('Failed to fetch') || err.message.includes('NetworkError'));
if (isNetworkError && attempt < maxRetries) {
this._serverReachable = false;
const delay = baseDelay * Math.pow(2, attempt);
await new Promise((r) => setTimeout(r, delay));
continue;
}
this._serverReachable = false;
if (err instanceof SaaSApiError) throw err;
throw new SaaSApiError(0, 'NETWORK_ERROR', `网络错误: ${err instanceof Error ? err.message : String(err)}`);
}
}
const response = await fetch(`${this.baseUrl}${path}`, {
method,
headers,
body: body !== undefined ? JSON.stringify(body) : undefined,
signal: AbortSignal.timeout(timeoutMs),
});
// Handle 401 specially - caller may want to trigger re-auth
if (response.status === 401) {
throw new SaaSApiError(401, 'UNAUTHORIZED', '认证已过期,请重新登录');
}
if (!response.ok) {
const errorBody = (await response.json().catch(() => null)) as SaaSErrorResponse | null;
throw new SaaSApiError(
response.status,
errorBody?.error || 'UNKNOWN',
errorBody?.message || `请求失败 (${response.status})`,
);
}
// 204 No Content
if (response.status === 204) {
return undefined as T;
}
return response.json() as Promise<T>;
// Unreachable, but TypeScript needs it
throw new SaaSApiError(0, 'UNKNOWN', '请求失败');
}
// --- Health ---
@@ -304,6 +350,37 @@ export class SaaSClient {
});
}
// --- Device Endpoints ---
/**
* Register or update this device with the SaaS backend.
* Uses UPSERT semantics — same (account, device_id) updates last_seen_at.
*/
async registerDevice(params: {
device_id: string;
device_name?: string;
platform?: string;
app_version?: string;
}): Promise<void> {
await this.request<unknown>('POST', '/api/v1/devices/register', params);
}
/**
* Send a heartbeat to indicate the device is still active.
*/
async deviceHeartbeat(deviceId: string): Promise<void> {
await this.request<unknown>('POST', '/api/v1/devices/heartbeat', {
device_id: deviceId,
});
}
/**
* List devices registered for the current account.
*/
async listDevices(): Promise<DeviceInfo[]> {
return this.request<DeviceInfo[]>('GET', '/api/v1/devices');
}
// --- Model Endpoints ---
/**

View File

@@ -28,6 +28,20 @@ import { createLogger } from '../lib/logger';
const log = createLogger('SaaSStore');
// === Device ID ===
/** Generate or load a persistent device ID for this browser instance */
function getOrCreateDeviceId(): string {
const KEY = 'zclaw-device-id';
const existing = localStorage.getItem(KEY);
if (existing) return existing;
const newId = crypto.randomUUID();
localStorage.setItem(KEY, newId);
return newId;
}
const DEVICE_ID = getOrCreateDeviceId();
// === Types ===
export type ConnectionMode = 'tauri' | 'gateway' | 'saas';
@@ -49,6 +63,7 @@ export interface SaaSActionsSlice {
logout: () => void;
setConnectionMode: (mode: ConnectionMode) => void;
fetchAvailableModels: () => Promise<void>;
registerCurrentDevice: () => Promise<void>;
clearError: () => void;
restoreSession: () => void;
}
@@ -138,6 +153,11 @@ export const useSaaSStore = create<SaaSStore>((set, get) => {
error: null,
});
// Register device and start heartbeat in background
get().registerCurrentDevice().catch((err: unknown) => {
log.warn('Failed to register device:', err);
});
// Fetch available models in background (non-blocking)
get().fetchAvailableModels().catch((err: unknown) => {
log.warn('Failed to fetch models after login:', err);
@@ -209,6 +229,10 @@ export const useSaaSStore = create<SaaSStore>((set, get) => {
error: null,
});
get().registerCurrentDevice().catch((err: unknown) => {
log.warn('Failed to register device after register:', err);
});
get().fetchAvailableModels().catch((err: unknown) => {
log.warn('Failed to fetch models after register:', err);
});
@@ -271,6 +295,41 @@ export const useSaaSStore = create<SaaSStore>((set, get) => {
}
},
registerCurrentDevice: async () => {
const { isLoggedIn, authToken, saasUrl } = get();
if (!isLoggedIn || !authToken) {
return;
}
try {
saasClient.setBaseUrl(saasUrl);
saasClient.setToken(authToken);
await saasClient.registerDevice({
device_id: DEVICE_ID,
device_name: `${navigator.userAgent.split(' ').slice(0, 3).join(' ')}`,
platform: navigator.platform,
app_version: __APP_VERSION__ || 'unknown',
});
log.info('Device registered successfully');
// Start periodic heartbeat (every 5 minutes)
if (typeof window !== 'undefined' && !get()._heartbeatTimer) {
const timer = window.setInterval(() => {
const state = get();
if (state.isLoggedIn && state.authToken) {
saasClient.deviceHeartbeat(DEVICE_ID).catch(() => {});
} else {
window.clearInterval(timer);
}
}, 5 * 60 * 1000);
set({ _heartbeatTimer: timer } as unknown as Partial<SaaSStore>);
}
} catch (err: unknown) {
log.warn('Failed to register device:', err);
}
},
clearError: () => {
set({ error: null });
},