feat(user-preferences): implement user preferences management with backend support

Added functionality for managing user preferences, including the ability to update preferences via a new API endpoint. The preferences are now stored server-side, allowing for synchronization across devices. Updated relevant components to handle user preferences, including the UserMenu and settings views. Enhanced internationalization support for error messages related to preference updates.
This commit is contained in:
wizardchen
2026-05-18 11:21:55 +08:00
committed by lyingbug
parent 3226cb97ff
commit 68ac7fb973
20 changed files with 301 additions and 24 deletions
+1
View File
@@ -54,6 +54,7 @@ const syncOIDCUserContext = async () => {
avatar: user.avatar,
tenant_id: String(user.tenant_id || tenant?.id || ''),
can_access_all_tenants: user.can_access_all_tenants || false,
preferences: user.preferences,
created_at: user.created_at || new Date().toISOString(),
updated_at: user.updated_at || new Date().toISOString()
})
+26
View File
@@ -77,6 +77,13 @@ export interface RegisterResponse {
}
}
// 用户偏好(与后端 types.UserPreferences 对齐,字段可选 = 没显式设置过)。
// 新加 key 时记得:后端 service.UpdateUserPreferences 也要在 merge 分支里
// 处理;前端调用方按需读 / 默认值降级。
export interface UserPreferences {
enable_memory?: boolean
}
// 用户信息接口
export interface UserInfo {
id: string
@@ -85,6 +92,7 @@ export interface UserInfo {
avatar?: string
tenant_id: string
can_access_all_tenants?: boolean
preferences?: UserPreferences
created_at: string
updated_at: string
}
@@ -263,6 +271,24 @@ export async function getCurrentUser(): Promise<{ success: boolean; data?: { use
}
}
/**
* 更新当前用户的偏好设置(PATCH 语义:只发要改的字段,后端只覆盖发了的 key,
* 其它 key 保持不变)。后端会返回更新后的完整 preferences 对象。
*/
export async function updateMyPreferences(
patch: Partial<UserPreferences>,
): Promise<{ success: boolean; data?: UserPreferences; message?: string }> {
try {
const response = await put('/api/v1/auth/me/preferences', patch)
return response as unknown as { success: boolean; data?: UserPreferences; message?: string }
} catch (error: any) {
return {
success: false,
message: error.message || t('error.auth.updatePreferencesFailed'),
}
}
}
/**
* 获取当前租户信息
*/
+1
View File
@@ -628,6 +628,7 @@ const loadUserInfo = async () => {
avatar: user.avatar,
tenant_id: user.tenant_id,
can_access_all_tenants: user.can_access_all_tenants || false,
preferences: user.preferences,
created_at: user.created_at,
updated_at: user.updated_at
})
+1
View File
@@ -2561,6 +2561,7 @@ export default {
registerFailed: 'Registration failed',
getUserFailed: 'Failed to get user info',
getTenantFailed: 'Failed to get tenant info',
updatePreferencesFailed: 'Failed to update preferences',
refreshTokenFailed: 'Token refresh failed',
logoutFailed: 'Logout failed',
validateTokenFailed: 'Token validation failed',
+1
View File
@@ -1811,6 +1811,7 @@ export default {
registerFailed: '회원가입 실패',
getUserFailed: '사용자 정보 조회 실패',
getTenantFailed: '테넌트 정보 조회 실패',
updatePreferencesFailed: '개인 설정 업데이트 실패',
refreshTokenFailed: '토큰 갱신 실패',
logoutFailed: '로그아웃 실패',
validateTokenFailed: '토큰 검증 실패',
+1
View File
@@ -1607,6 +1607,7 @@ export default {
registerFailed: 'Ошибка регистрации',
getUserFailed: 'Не удалось получить информацию о пользователе',
getTenantFailed: 'Не удалось получить информацию о тенанте',
updatePreferencesFailed: 'Не удалось обновить настройки',
refreshTokenFailed: 'Не удалось обновить токен',
logoutFailed: 'Ошибка выхода',
validateTokenFailed: 'Ошибка проверки токена'
+1
View File
@@ -1790,6 +1790,7 @@ export default {
registerFailed: "注册失败",
getUserFailed: "获取用户信息失败",
getTenantFailed: "获取空间信息失败",
updatePreferencesFailed: "更新个性化设置失败",
refreshTokenFailed: "刷新Token失败",
logoutFailed: "登出失败",
validateTokenFailed: "Token验证失败",
+2
View File
@@ -162,6 +162,7 @@ function persistLoginResponse(authStore: ReturnType<typeof useAuthStore>, respon
avatar: response.user.avatar,
tenant_id: String(response.tenant.id) || '',
can_access_all_tenants: response.user.can_access_all_tenants || false,
preferences: response.user.preferences,
created_at: response.user.created_at || new Date().toISOString(),
updated_at: response.user.updated_at || new Date().toISOString()
})
@@ -207,6 +208,7 @@ async function hydrateSessionFromToken(authStore: ReturnType<typeof useAuthStore
avatar: user.avatar,
tenant_id: String(user.tenant_id || response.data?.tenant?.id || ''),
can_access_all_tenants: user.can_access_all_tenants || false,
preferences: user.preferences,
created_at: user.created_at || new Date().toISOString(),
updated_at: user.updated_at || new Date().toISOString(),
})
+12
View File
@@ -150,6 +150,17 @@ export const useAuthStore = defineStore('auth', () => {
if (previousId !== userData.id) {
reloadUserPreferences()
}
// 把后端持久化的 user 偏好(记忆开关等)同步到 settings store。
// 用 import 而不是顶部 import 避免 stores 间的循环依赖:auth ↔ settings。
// settings store 只把它当作"本地状态 + localStorage"更新,不会再原路 PUT 回去。
if (userData.preferences) {
import('@/stores/settings').then(({ useSettingsStore }) => {
useSettingsStore().hydrateFromUserPreferences(userData.preferences)
}).catch(() => {
// 加载 settings store 失败不影响 setUser 主流程;下次 setUser
// 触发时还会再次尝试同步。
})
}
}
const setTenant = (tenantData: TenantInfo) => {
@@ -294,6 +305,7 @@ export const useAuthStore = defineStore('auth', () => {
avatar: u.avatar,
tenant_id: String(u.tenant_id || response.data?.tenant?.id || ''),
can_access_all_tenants: u.can_access_all_tenants || false,
preferences: u.preferences,
created_at: u.created_at || new Date().toISOString(),
updated_at: u.updated_at || new Date().toISOString(),
})
+38 -2
View File
@@ -1,6 +1,7 @@
import { defineStore } from "pinia";
import { BUILTIN_QUICK_ANSWER_ID, BUILTIN_SMART_REASONING_ID } from "@/api/agent";
import { getApiBaseUrl } from "@/utils/api-base";
import { updateMyPreferences, type UserPreferences } from "@/api/auth";
// 定义设置接口
interface Settings {
@@ -307,10 +308,45 @@ export const useSettingsStore = defineStore("settings", {
localStorage.setItem("WeKnora_settings", JSON.stringify(this.settings));
},
// 启用/禁用记忆功能
toggleMemory(enabled: boolean) {
// 启用/禁用记忆功能。
// 现在是"真用户级"开关:
// - 本地缓存 (localStorage) 用作 UI 首屏 / 离线兜底;
// - PUT /auth/me/preferences 是真正的持久化,跨设备/浏览器同步。
//
// 乐观更新:先翻本地状态让 UI 立刻响应,再异步写后端;失败则回滚 + throw
// 让调用方(GeneralSettings.vue 的 t-switch)可以提示并把开关复位。
async toggleMemory(enabled: boolean): Promise<void> {
const previous = !!this.settings.enableMemory;
this.settings.enableMemory = enabled;
localStorage.setItem("WeKnora_settings", JSON.stringify(this.settings));
try {
const resp = await updateMyPreferences({ enable_memory: enabled });
if (!resp.success) {
throw new Error(resp.message || "update failed");
}
} catch (err) {
// 回滚本地状态,让 UI 复位到旧值。
this.settings.enableMemory = previous;
localStorage.setItem("WeKnora_settings", JSON.stringify(this.settings));
throw err;
}
},
// 从 /auth/me 或 /auth/login 返回的 user.preferences 同步到本地 settings。
// 调用方:authStore.setUser(每次登录 / 刷新 user / 切租户后都会触发)。
// 不写后端,纯本地状态 + localStorage 写入,避免把后端的值再原路 PUT 回去。
hydrateFromUserPreferences(prefs: UserPreferences | undefined | null) {
if (!prefs) return;
let changed = false;
if (typeof prefs.enable_memory === "boolean" &&
this.settings.enableMemory !== prefs.enable_memory) {
this.settings.enableMemory = prefs.enable_memory;
changed = true;
}
if (changed) {
localStorage.setItem("WeKnora_settings", JSON.stringify(this.settings));
}
},
// 启用/禁用自动检查更新
+1
View File
@@ -560,6 +560,7 @@ const persistLoginResponse = async (response: any) => {
avatar: response.user.avatar,
tenant_id: String(activeTenant.id) || '',
can_access_all_tenants: response.user.can_access_all_tenants || false,
preferences: response.user.preferences,
created_at: response.user.created_at || new Date().toISOString(),
updated_at: response.user.updated_at || new Date().toISOString()
})
+22 -13
View File
@@ -129,8 +129,9 @@
</div>
<div class="setting-control">
<t-switch
v-model="isMemoryEnabled"
:disabled="!isNeo4jAvailable"
:value="isMemoryEnabled"
:disabled="!isNeo4jAvailable || memorySaving"
:loading="memorySaving"
@change="handleMemoryChange"
/>
</div>
@@ -238,11 +239,10 @@ const isNeo4jAvailable = computed(() => {
return systemInfo.value?.graph_database_engine && systemInfo.value.graph_database_engine !== '未启用'
})
// 记忆功能状态
const isMemoryEnabled = computed({
get: () => settingsStore.isMemoryEnabled,
set: (val) => settingsStore.toggleMemory(val)
})
// 记忆功能状态:只读 computed(toggleMemory 现在是 async + 后端持久化,
// 触发路径统一走 @change → handleMemoryChange,避免 v-model setter 二次调用)。
const isMemoryEnabled = computed(() => settingsStore.isMemoryEnabled)
const memorySaving = ref(false)
// 自动检查更新状态
const isAutoCheckUpdateEnabled = computed({
@@ -275,7 +275,8 @@ onMounted(async () => {
const response = await getSystemInfo()
systemInfo.value = response.data
if (!isNeo4jAvailable.value && settingsStore.isMemoryEnabled) {
settingsStore.toggleMemory(false)
// Neo4j 不可用 → 兜底关掉。后端写入失败不打断主流程(页面级 best-effort)。
void settingsStore.toggleMemory(false).catch(() => {})
}
} catch (error) {
console.error('Failed to load system info:', error)
@@ -289,15 +290,23 @@ const handleLanguageChange = () => {
MessagePlugin.success(t('language.languageSaved'))
}
// 处理记忆功能变化
const handleMemoryChange = (val: boolean) => {
// 处理记忆功能变化。
// toggleMemory 是 async:先乐观写本地、再 PUT 后端;失败会回滚并 throw。
// UI 在 saving 期间禁用开关 + 显示 loading,避免用户在请求未完成时反复点。
const handleMemoryChange = async (val: boolean) => {
if (val && !isNeo4jAvailable.value) {
MessagePlugin.warning(t('settings.memoryRequiresNeo4j'))
settingsStore.toggleMemory(false)
return
}
settingsStore.toggleMemory(val)
MessagePlugin.success(t('common.success'))
memorySaving.value = true
try {
await settingsStore.toggleMemory(val)
MessagePlugin.success(t('common.success'))
} catch (err: any) {
MessagePlugin.error(err?.message || t('error.auth.updatePreferencesFailed'))
} finally {
memorySaving.value = false
}
}
// 处理主题变化