A continuation of HomeBox the inventory and organization system built for the Home User
feat: frontend preference sync settings
tonyaellie523a69f5261f
diff --git a/backend/app/api/handlers/v1/controller.go b/backend/app/api/handlers/v1/controller.goindex 844ed8e4..606c5f86 100644--- a/backend/app/api/handlers/v1/controller.go+++ b/backend/app/api/handlers/v1/controller.go@@ -225,6 +225,7 @@ func (ctrl *V1Controller) HandleCacheWS() errchain.HandlerFunc {ctrl.bus.Subscribe(eventbus.EventLabelMutation, factory("label.mutation"))ctrl.bus.Subscribe(eventbus.EventLocationMutation, factory("location.mutation"))ctrl.bus.Subscribe(eventbus.EventItemMutation, factory("item.mutation"))+ ctrl.bus.Subscribe(eventbus.EventUserMutation, factory("user.mutation"))// Persistent asynchronous ticker that keeps all websocket connections alive with periodic pings.go func() {diff --git a/backend/app/api/handlers/v1/v1_ctrl_user.go b/backend/app/api/handlers/v1/v1_ctrl_user.goindex 6a5f70ef..d161bdcd 100644--- a/backend/app/api/handlers/v1/v1_ctrl_user.go+++ b/backend/app/api/handlers/v1/v1_ctrl_user.go@@ -9,6 +9,7 @@ import ("github.com/hay-kot/httpkit/server""github.com/rs/zerolog/log""github.com/sysadminsmedia/homebox/backend/internal/core/services"+ "github.com/sysadminsmedia/homebox/backend/internal/core/services/reporting/eventbus""github.com/sysadminsmedia/homebox/backend/internal/data/repo""github.com/sysadminsmedia/homebox/backend/internal/sys/validate")@@ -166,6 +167,8 @@ func (ctrl *V1Controller) HandleUserSelfSettingsUpdate() errchain.HandlerFunc {return validate.NewRequestError(err, http.StatusInternalServerError)}+ ctrl.bus.Publish(eventbus.EventUserMutation, eventbus.GroupMutationEvent{GID: actor.GroupID})+newSettings, err := ctrl.svc.User.GetSettings(r.Context(), actor.ID)if err != nil {return validate.NewRequestError(err, http.StatusInternalServerError)diff --git a/backend/internal/core/services/reporting/eventbus/eventbus.go b/backend/internal/core/services/reporting/eventbus/eventbus.goindex 581bc38b..44aa6a72 100644--- a/backend/internal/core/services/reporting/eventbus/eventbus.go+++ b/backend/internal/core/services/reporting/eventbus/eventbus.go@@ -14,6 +14,7 @@ const (EventLabelMutation Event = "label.mutation"EventLocationMutation Event = "location.mutation"EventItemMutation Event = "item.mutation"+ EventUserMutation Event = "user.mutation")type GroupMutationEvent struct {@@ -40,6 +41,7 @@ func New() *EventBus {EventLabelMutation: {},EventLocationMutation: {},EventItemMutation: {},+ EventUserMutation: {},},}}diff --git a/frontend/app.vue b/frontend/app.vueindex 71428a16..50e8c3ff 100644--- a/frontend/app.vue+++ b/frontend/app.vue@@ -24,4 +24,6 @@const { theme } = useTheme();const { locale } = useI18n();++ useViewPreferencesSync();</script>diff --git a/frontend/composables/use-preferences.ts b/frontend/composables/use-preferences.tsindex 97cad2a4..78342b4a 100644--- a/frontend/composables/use-preferences.ts+++ b/frontend/composables/use-preferences.ts@@ -24,8 +24,8 @@ export type LocationViewPreferences = {}[];displayLegacyHeader: boolean;legacyImageFit: boolean;- language?: string;- overrideFormatLocale?: string;+ language?: string | null;+ overrideFormatLocale?: string | null;duplicateSettings: DuplicateSettings;shownMultiTabWarning: boolean;quickActions: {@@ -33,38 +33,210 @@ export type LocationViewPreferences = {};};+export type PreferenceSyncConfig = Partial<Record<keyof LocationViewPreferences, boolean>>;++const DEFAULT_PREFERENCES: LocationViewPreferences = {+ showDetails: true,+ showEmpty: true,+ editorAdvancedView: false,+ itemDisplayView: "card",+ theme: "homebox",+ itemsPerTablePage: 10,+ displayLegacyHeader: false,+ legacyImageFit: false,+ language: null,+ overrideFormatLocale: null,+ duplicateSettings: {+ copyMaintenance: false,+ copyAttachments: true,+ copyCustomFields: true,+ copyPrefixOverride: null,+ },+ shownMultiTabWarning: false,+ quickActions: {+ enabled: true,+ },+};++let syncConfig: PreferenceSyncConfig = {+ itemDisplayView: false,+ shownMultiTabWarning: false,+};++let syncInitialized = false;++const preferenceKeys = Object.keys(DEFAULT_PREFERENCES) as (keyof LocationViewPreferences)[];++const results = useLocalStorage("homebox/preferences/location", DEFAULT_PREFERENCES, { mergeDefaults: true });++function forEachSyncedPreference(callback: (key: keyof LocationViewPreferences) => void) {+ for (const key of preferenceKeys) {+ if (syncConfig[key] !== false) {+ callback(key);+ }+ }+}++function buildSyncedSettings(preferences: LocationViewPreferences): Record<string, unknown> {+ const payload: Record<string, unknown> = {};+ forEachSyncedPreference(key => {+ payload[key] = preferences[key];+ });+ return payload;+}++function mergeSyncedSettings(+ settings: Record<string, unknown>,+ preferences: LocationViewPreferences+): LocationViewPreferences {+ const nextPreferences = { ...preferences };++ forEachSyncedPreference(key => {+ if (key in settings) {+ nextPreferences[key] = settings[key] as never;+ }+ });++ return nextPreferences;+}++export function configureViewPreferenceSync(config: PreferenceSyncConfig) {+ syncConfig = {+ ...syncConfig,+ ...config,+ };+}++async function refreshViewPreferencesFromServer(preferences: Ref<LocationViewPreferences>) {+ const auth = useAuthContext();+ if (!auth.isAuthorized()) {+ return;+ }++ const api = useUserApi();+ const { data, error } = await api.user.getSettings();+ if (error || !data?.item) {+ return;+ }++ preferences.value = mergeSyncedSettings(data.item, preferences.value);+}++export function useViewPreferencesSync() {+ if (syncInitialized || !import.meta.client) {+ return;+ }++ syncInitialized = true;++ const auth = useAuthContext();+ const preferences = results as unknown as Ref<LocationViewPreferences>;+ let pauseServerSaves = true;+ let applyingServerSnapshot = false;+ let saveInFlight = false;+ let localRevision = 0;+ let syncedRevision = 0;+ let retryTimer: ReturnType<typeof setTimeout> | null = null;++ const scheduleRetry = () => {+ if (retryTimer !== null) {+ return;+ }++ retryTimer = setTimeout(() => {+ retryTimer = null;+ void saveToServer();+ }, 1000);+ };++ const markDirty = () => {+ localRevision += 1;+ queueSaveToServer();+ };++ const saveToServer = async () => {+ if (saveInFlight || pauseServerSaves || !auth.isAuthorized()) {+ return;+ }++ saveInFlight = true;++ const api = useUserApi();+ try {+ while (syncedRevision < localRevision && !pauseServerSaves && auth.isAuthorized()) {+ const targetRevision = localRevision;+ const { error } = await api.user.setSettings(buildSyncedSettings(preferences.value));+ if (error) {+ scheduleRetry();+ return;+ }++ syncedRevision = targetRevision;+ }+ } finally {+ saveInFlight = false;++ if (syncedRevision < localRevision && !pauseServerSaves) {+ void saveToServer();+ }+ }+ };++ const queueSaveToServer = useDebounceFn(() => {+ void saveToServer();+ }, 400);++ const refreshFromServer = async () => {+ pauseServerSaves = true;+ applyingServerSnapshot = true;+ try {+ await refreshViewPreferencesFromServer(preferences);+ } finally {+ applyingServerSnapshot = false;+ }+ pauseServerSaves = false;++ if (syncedRevision < localRevision) {+ void saveToServer();+ }+ };++ watch(+ preferences,+ () => {+ if (applyingServerSnapshot) {+ return;+ }++ markDirty();+ },+ { deep: true }+ );++ watch(+ () => auth.token,+ token => {+ if (!token) {+ pauseServerSaves = true;+ syncedRevision = localRevision;+ return;+ }++ void refreshFromServer();+ },+ { immediate: true }+ );++ onServerEvent(ServerEvent.UserMutation, () => {+ void refreshFromServer();+ });+}+/*** useViewPreferences loads the view preferences from local storage and hydrates* them. These are reactive and will update the local storage when changed.*/export function useViewPreferences(): Ref<LocationViewPreferences> {- const results = useLocalStorage(- "homebox/preferences/location",- {- showDetails: true,- showEmpty: true,- editorAdvancedView: false,- itemDisplayView: "card",- theme: "homebox",- itemsPerTablePage: 10,- displayLegacyHeader: false,- legacyImageFit: false,- language: null,- overrideFormatLocale: null,- duplicateSettings: {- copyMaintenance: false,- copyAttachments: true,- copyCustomFields: true,- copyPrefixOverride: null,- },- shownMultiTabWarning: false,- quickActions: {- enabled: true,- },- },- { mergeDefaults: true }- );-// casting is required because the type returned is removable, however since we// use `mergeDefaults` the result _should_ always be present.return results as unknown as Ref<LocationViewPreferences>;diff --git a/frontend/composables/use-server-events.ts b/frontend/composables/use-server-events.tsindex 356fa59d..4397f65c 100644--- a/frontend/composables/use-server-events.ts+++ b/frontend/composables/use-server-events.ts@@ -2,6 +2,7 @@ export enum ServerEvent {LocationMutation = "location.mutation",ItemMutation = "item.mutation",LabelMutation = "label.mutation",+ UserMutation = "user.mutation",}export type EventMessage = {@@ -44,6 +45,7 @@ function connect(onmessage: (m: EventMessage) => void) {thorttled.set(ServerEvent.LocationMutation, useThrottleFn(onmessage, 1000));thorttled.set(ServerEvent.ItemMutation, useThrottleFn(onmessage, 1000));thorttled.set(ServerEvent.LabelMutation, useThrottleFn(onmessage, 1000));+ thorttled.set(ServerEvent.UserMutation, useThrottleFn(onmessage, 1000));ws.onmessage = msg => {const pm = JSON.parse(msg.data);diff --git a/frontend/composables/use-theme.ts b/frontend/composables/use-theme.tsindex 23eed223..1949ab4a 100644--- a/frontend/composables/use-theme.ts+++ b/frontend/composables/use-theme.ts@@ -6,37 +6,38 @@ export interface UseTheme {setTheme: (theme: DaisyTheme) => void;}-const themeRef = ref<DaisyTheme>("garden");-export function useTheme(): UseTheme {const preferences = useViewPreferences();- themeRef.value = preferences.value.theme;+ const theme = computed(() => preferences.value.theme);+ const htmlEl = ref<HTMLElement | null>(null);- const setTheme = (newTheme: DaisyTheme) => {- preferences.value.theme = newTheme;+ const applyThemeToDom = (newTheme: DaisyTheme) => {+ if (!htmlEl.value) {+ return;+ }++ htmlEl.value.setAttribute("data-theme", newTheme);- if (htmlEl) {- htmlEl.value?.setAttribute("data-theme", newTheme);- // FIXME: this is a hack to remove the theme class from the html element- htmlEl.value?.classList.remove(...themes);- htmlEl.value?.classList.add("theme-" + newTheme);+ const prefixedThemeClasses = Array.from(htmlEl.value.classList).filter(className => className.startsWith("theme-"));+ if (prefixedThemeClasses.length > 0) {+ htmlEl.value.classList.remove(...prefixedThemeClasses);}- themeRef.value = newTheme;+ htmlEl.value.classList.remove(...themes);+ htmlEl.value.classList.add("theme-" + newTheme);};- const htmlEl = ref<HTMLElement | null>();+ const setTheme = (newTheme: DaisyTheme) => {+ preferences.value.theme = newTheme;+ };onMounted(() => {- if (htmlEl.value) {- return;- }-htmlEl.value = document.querySelector("html");+ applyThemeToDom(theme.value);});- const theme = computed(() => {- return themeRef.value;+ watch(theme, newTheme => {+ applyThemeToDom(newTheme);});return { theme, setTheme };diff --git a/frontend/lib/api/classes/users.ts b/frontend/lib/api/classes/users.tsindex 292fa7ef..a4cfba26 100644--- a/frontend/lib/api/classes/users.ts+++ b/frontend/lib/api/classes/users.ts@@ -24,4 +24,17 @@ export class UserApi extends BaseAPI {},});}++ public getSettings() {+ return this.http.get<Result<Record<string, unknown>>>({+ url: route("/users/self/settings"),+ });+ }++ public setSettings(settings: Record<string, unknown>) {+ return this.http.put<Record<string, unknown>, Result<Record<string, unknown>>>({+ url: route("/users/self/settings"),+ body: settings,+ });+ }}diff --git a/frontend/plugins/i18n.ts b/frontend/plugins/i18n.tsindex d82d4554..e6babb0b 100644--- a/frontend/plugins/i18n.ts+++ b/frontend/plugins/i18n.ts@@ -32,6 +32,17 @@ export default defineNuxtPlugin(({ vueApp }) => {});vueApp.use(i18n);+ watch(+ () => preferences.value.language,+ language => {+ if (!language) {+ return;+ }++ i18n.global.locale.value = language;+ }+ );+return {provide: {i18nGlobal: i18n.global,