Subscribe to frontend user data (#25445)

src/data/frontend.ts

@@ -1,5 +1,4 @@
 import type { Connection } from "home-assistant-js-websocket";
-import { getOptimisticCollection } from "./collection";
 
 export interface CoreFrontendUserData {
   showAdvanced?: boolean;
@@ -42,30 +41,15 @@ export const saveFrontendUserData = async <
     value,
   });
 
-export const getOptimisticFrontendUserDataCollection = <
-  UserDataKey extends ValidUserDataKey,
->(
-  conn: Connection,
-  userDataKey: UserDataKey
-) =>
-  getOptimisticCollection(
-    (_conn, data) =>
-      saveFrontendUserData(
-        conn,
-        userDataKey,
-        // @ts-ignore
-        data
-      ),
-    conn,
-    `_frontendUserData-${userDataKey}`,
-    () => fetchFrontendUserData(conn, userDataKey)
-  );
-
 export const subscribeFrontendUserData = <UserDataKey extends ValidUserDataKey>(
   conn: Connection,
   userDataKey: UserDataKey,
-  onChange: (state: FrontendUserData[UserDataKey] | null) => void
+  onChange: (data: { value: FrontendUserData[UserDataKey] | null }) => void
 ) =>
-  getOptimisticFrontendUserDataCollection(conn, userDataKey).subscribe(
-    onChange
+  conn.subscribeMessage<{ value: FrontendUserData[UserDataKey] | null }>(
+    onChange,
+    {
+      type: "frontend/subscribe_user_data",
+      key: userDataKey,
+    }
   );

src/data/translation.ts

@@ -1,5 +1,9 @@
 import type { HomeAssistant } from "../types";
-import { fetchFrontendUserData, saveFrontendUserData } from "./frontend";
+import {
+  fetchFrontendUserData,
+  saveFrontendUserData,
+  subscribeFrontendUserData,
+} from "./frontend";
 
 export enum NumberFormat {
   language = "language",
@@ -77,6 +81,11 @@ export type TranslationCategory =
 export const fetchTranslationPreferences = (hass: HomeAssistant) =>
   fetchFrontendUserData(hass.connection, "language");
 
+export const subscribeTranslationPreferences = (
+  hass: HomeAssistant,
+  callback: (data: { value: FrontendLocaleData | null }) => void
+) => subscribeFrontendUserData(hass.connection, "language", callback);
+
 export const saveTranslationPreferences = (
   hass: HomeAssistant,
   data: FrontendLocaleData

src/panels/profile/ha-advanced-mode-row.ts

@@ -1,11 +1,12 @@
 import type { TemplateResult } from "lit";
-import { css, html, LitElement } from "lit";
-import { customElement, property } from "lit/decorators";
+import { css, html, LitElement, nothing } from "lit";
+import { customElement, property, state } from "lit/decorators";
+import "../../components/ha-alert";
 import "../../components/ha-card";
 import "../../components/ha-settings-row";
 import "../../components/ha-switch";
 import type { CoreFrontendUserData } from "../../data/frontend";
-import { getOptimisticFrontendUserDataCollection } from "../../data/frontend";
+import { saveFrontendUserData } from "../../data/frontend";
 import type { HomeAssistant } from "../../types";
 
 @customElement("ha-advanced-mode-row")
@@ -16,8 +17,13 @@ class AdvancedModeRow extends LitElement {
 
   @property({ attribute: false }) public coreUserData?: CoreFrontendUserData;
 
+  @state() private _error?: string;
+
   protected render(): TemplateResult {
     return html`
+      ${this._error
+        ? html`<ha-alert alert-type="error">${this._error}</ha-alert>`
+        : nothing}
       <ha-settings-row .narrow=${this.narrow}>
         <span slot="heading">
           ${this.hass.localize("ui.panel.profile.advanced_mode.title")}
@@ -41,16 +47,24 @@ class AdvancedModeRow extends LitElement {
   }
 
   private async _advancedToggled(ev) {
-    getOptimisticFrontendUserDataCollection(this.hass.connection, "core").save({
+    try {
+      saveFrontendUserData(this.hass.connection, "core", {
         ...this.coreUserData,
         showAdvanced: ev.currentTarget.checked,
       });
+    } catch (err: any) {
+      this._error = err.message || err;
+    }
   }
 
   static styles = css`
     a {
       color: var(--primary-color);
     }
+    ha-alert {
+      margin: 0 16px;
+      display: block;
+    }
   `;
 }
 

src/panels/profile/ha-entity-id-picker-row.ts

@@ -1,11 +1,12 @@
 import type { TemplateResult } from "lit";
-import { css, html, LitElement } from "lit";
-import { customElement, property } from "lit/decorators";
+import { css, html, LitElement, nothing } from "lit";
+import { customElement, property, state } from "lit/decorators";
+import "../../components/ha-alert";
 import "../../components/ha-card";
 import "../../components/ha-settings-row";
 import "../../components/ha-switch";
 import type { CoreFrontendUserData } from "../../data/frontend";
-import { getOptimisticFrontendUserDataCollection } from "../../data/frontend";
+import { saveFrontendUserData } from "../../data/frontend";
 import type { HomeAssistant } from "../../types";
 
 @customElement("ha-entity-id-picker-row")
@@ -16,8 +17,13 @@ class EntityIdPickerRow extends LitElement {
 
   @property({ attribute: false }) public coreUserData?: CoreFrontendUserData;
 
+  @state() private _error?: string;
+
   protected render(): TemplateResult {
     return html`
+      ${this._error
+        ? html`<ha-alert alert-type="error">${this._error}</ha-alert>`
+        : nothing}
       <ha-settings-row .narrow=${this.narrow}>
         <span slot="heading">
           ${this.hass.localize("ui.panel.profile.entity_id_picker.title")}</span
@@ -35,16 +41,24 @@ class EntityIdPickerRow extends LitElement {
   }
 
   private async _toggled(ev) {
-    getOptimisticFrontendUserDataCollection(this.hass.connection, "core").save({
+    try {
+      saveFrontendUserData(this.hass.connection, "core", {
         ...this.coreUserData,
         showEntityIdPicker: ev.currentTarget.checked,
       });
+    } catch (err: any) {
+      this._error = err.message || err;
+    }
   }
 
   static styles = css`
     a {
       color: var(--primary-color);
     }
+    ha-alert {
+      margin: 0 16px;
+      display: block;
+    }
   `;
 }
 

src/panels/profile/ha-profile-section-general.ts

@@ -4,32 +4,32 @@ import type { CSSResultGroup, TemplateResult } from "lit";
 import { css, html, LitElement } from "lit";
 import { customElement, property, state } from "lit/decorators";
 import { fireEvent } from "../../common/dom/fire_event";
+import { nextRender } from "../../common/util/render-status";
 import "../../components/ha-card";
-import "../../layouts/hass-tabs-subpage";
-import { profileSections } from "./ha-panel-profile";
 import { isExternal } from "../../data/external";
 import type { CoreFrontendUserData } from "../../data/frontend";
-import { getOptimisticFrontendUserDataCollection } from "../../data/frontend";
+import { subscribeFrontendUserData } from "../../data/frontend";
 import { showConfirmationDialog } from "../../dialogs/generic/show-dialog-box";
-import { isMobileClient } from "../../util/is_mobile";
+import "../../layouts/hass-tabs-subpage";
 import { haStyle } from "../../resources/styles";
 import type { HomeAssistant, Route } from "../../types";
+import { isMobileClient } from "../../util/is_mobile";
 import "./ha-advanced-mode-row";
 import "./ha-enable-shortcuts-row";
 import "./ha-entity-id-picker-row";
 import "./ha-force-narrow-row";
+import { profileSections } from "./ha-panel-profile";
 import "./ha-pick-dashboard-row";
+import "./ha-pick-date-format-row";
 import "./ha-pick-first-weekday-row";
 import "./ha-pick-language-row";
 import "./ha-pick-number-format-row";
 import "./ha-pick-theme-row";
 import "./ha-pick-time-format-row";
-import "./ha-pick-date-format-row";
 import "./ha-pick-time-zone-row";
 import "./ha-push-notifications-row";
 import "./ha-set-suspend-row";
 import "./ha-set-vibrate-row";
-import { nextRender } from "../../common/util/render-status";
 
 @customElement("ha-profile-section-general")
 class HaProfileSectionGeneral extends LitElement {
@@ -41,15 +41,16 @@ class HaProfileSectionGeneral extends LitElement {
 
   @property({ attribute: false }) public route!: Route;
 
-  private _unsubCoreData?: UnsubscribeFunc;
+  private _unsubCoreData?: Promise<UnsubscribeFunc>;
 
   private _getCoreData() {
-    this._unsubCoreData = getOptimisticFrontendUserDataCollection(
+    this._unsubCoreData = subscribeFrontendUserData(
       this.hass.connection,
-      "core"
-    ).subscribe((coreUserData) => {
-      this._coreUserData = coreUserData;
-    });
+      "core",
+      ({ value }) => {
+        this._coreUserData = value;
+      }
+    );
   }
 
   public connectedCallback() {
@@ -70,7 +71,7 @@ class HaProfileSectionGeneral extends LitElement {
   public disconnectedCallback() {
     super.disconnectedCallback();
     if (this._unsubCoreData) {
-      this._unsubCoreData();
+      this._unsubCoreData.then((unsub) => unsub());
       this._unsubCoreData = undefined;
     }
   }

src/state/connection-mixin.ts

@@ -8,6 +8,7 @@ import {
   subscribeServices,
 } from "home-assistant-js-websocket";
 import { fireEvent } from "../common/dom/fire_event";
+import { promiseTimeout } from "../common/util/promise-timeout";
 import { subscribeAreaRegistry } from "../data/area_registry";
 import { broadcastConnectionStatus } from "../data/connection-status";
 import { subscribeDeviceRegistry } from "../data/device_registry";
@@ -22,6 +23,8 @@ import {
   TimeFormat,
   TimeZone,
 } from "../data/translation";
+import { subscribeEntityRegistryDisplay } from "../data/ws-entity_registry_display";
+import { subscribeFloorRegistry } from "../data/ws-floor_registry";
 import { subscribePanels } from "../data/ws-panels";
 import { translationMetadata } from "../resources/translations-metadata";
 import type { Constructor, HomeAssistant, ServiceCallResponse } from "../types";
@@ -30,9 +33,6 @@ import { fetchWithAuth } from "../util/fetch-with-auth";
 import { getState } from "../util/ha-pref-storage";
 import hassCallApi, { hassCallApiRaw } from "../util/hass-call-api";
 import type { HassBaseEl } from "./hass-base-mixin";
-import { promiseTimeout } from "../common/util/promise-timeout";
-import { subscribeFloorRegistry } from "../data/ws-floor_registry";
-import { subscribeEntityRegistryDisplay } from "../data/ws-entity_registry_display";
 
 export const connectionMixin = <T extends Constructor<HassBaseEl>>(
   superClass: T
@@ -280,9 +280,9 @@ export const connectionMixin = <T extends Constructor<HassBaseEl>>(
       subscribeConfig(conn, (config) => this._updateHass({ config }));
       subscribeServices(conn, (services) => this._updateHass({ services }));
       subscribePanels(conn, (panels) => this._updateHass({ panels }));
-      subscribeFrontendUserData(conn, "core", (userData) =>
-        this._updateHass({ userData })
-      );
+      subscribeFrontendUserData(conn, "core", ({ value: userData }) => {
+        this._updateHass({ userData });
+      });
 
       clearInterval(this.__backendPingInterval);
       this.__backendPingInterval = setInterval(() => {

src/state/translations-mixin.ts

@@ -8,17 +8,18 @@ import {
 } from "../common/util/compute_rtl";
 import { debounce } from "../common/util/debounce";
 import type {
+  DateFormat,
   FirstWeekday,
   NumberFormat,
   TimeFormat,
-  DateFormat,
-  TranslationCategory,
   TimeZone,
+  TranslationCategory,
 } from "../data/translation";
 import {
   getHassTranslations,
   getHassTranslationsPre109,
   saveTranslationPreferences,
+  subscribeTranslationPreferences,
 } from "../data/translation";
 import { translationMetadata } from "../resources/translations-metadata";
 import type { Constructor, HomeAssistant } from "../types";
@@ -119,7 +120,10 @@ export default <T extends Constructor<HassBaseEl>>(superClass: T) =>
 
     protected hassConnected() {
       super.hassConnected();
-      getUserLocale(this.hass!).then((locale) => {
+
+      subscribeTranslationPreferences(this.hass!, async ({ value }) => {
+        const locale = await getUserLocale(value);
+
         if (locale?.language && this.hass!.language !== locale.language) {
           // We just got language from backend, no need to save back
           this._selectLanguage(locale.language, false);

src/util/common-translation.ts

@@ -1,7 +1,5 @@
 import type { FrontendLocaleData } from "../data/translation";
-import { fetchTranslationPreferences } from "../data/translation";
 import { translationMetadata } from "../resources/translations-metadata";
-import type { HomeAssistant } from "../types";
 
 const BASE_URL = `${__STATIC_PATH__}translations`;
 const STORAGE = window.localStorage || {};
@@ -68,15 +66,14 @@ export function findAvailableLanguage(language: string) {
  * Get user selected locale data from backend
  */
 export async function getUserLocale(
-  hass: HomeAssistant
+  data: FrontendLocaleData | null
 ): Promise<Partial<FrontendLocaleData>> {
-  const result = await fetchTranslationPreferences(hass);
-  const language = result?.language;
-  const number_format = result?.number_format;
-  const time_format = result?.time_format;
-  const date_format = result?.date_format;
-  const time_zone = result?.time_zone;
-  const first_weekday = result?.first_weekday;
+  const language = data?.language;
+  const number_format = data?.number_format;
+  const time_format = data?.time_format;
+  const date_format = data?.date_format;
+  const time_zone = data?.time_zone;
+  const first_weekday = data?.first_weekday;
   if (language) {
     const availableLanguage = findAvailableLanguage(language);
     if (availableLanguage) {