Add originID to StateUpdateResult update (#110)

ewowi · theelims · web-flow · commit 2b04a9bb3dfc · 2025-11-30T14:35:44.000+01:00
* Add originID to StateUpdateResult update

(and add .DS_Store to gitignore)

This makes it consistent with other update functions and allow for checking on this in update()

* fix: string to variable

---------

Co-authored-by: elims &lt;elims@gmx.net&gt;
diff --git a/lib/framework/APSettingsService.h b/lib/framework/APSettingsService.h
@@ -111,7 +111,7 @@ class APSettings
         root["subnet_mask"] = settings.subnetMask.toString();
     }
 
-    static StateUpdateResult update(JsonObject &root, APSettings &settings)
+    static StateUpdateResult update(JsonObject &root, APSettings &settings, const String &originId)
     {
         APSettings newSettings = {};
         newSettings.provisionMode = root["provision_mode"] | FACTORY_AP_PROVISION_MODE;
diff --git a/lib/framework/FSPersistence.h b/lib/framework/FSPersistence.h
@@ -47,7 +47,7 @@ class FSPersistence
             if (error == DeserializationError::Ok && jsonDocument.is<JsonObject>())
             {
                 JsonObject jsonObject = jsonDocument.as<JsonObject>();
-                _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater);
+                _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater, _filePath);
                 settingsFile.close();
                 return;
             }
@@ -135,7 +135,7 @@ class FSPersistence
     {
         JsonDocument jsonDocument;
         JsonObject jsonObject = jsonDocument.as<JsonObject>();
-        _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater);
+        _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater, _filePath);
     }
 };
 
diff --git a/lib/framework/HttpEndpoint.h b/lib/framework/HttpEndpoint.h
@@ -84,7 +84,7 @@ class HttpEndpoint
                             }
 
                             JsonObject jsonObject = json.as<JsonObject>();
-                            StateUpdateResult outcome = _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater);
+                            StateUpdateResult outcome = _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater, _servicePath);
 
                             if (outcome == StateUpdateResult::ERROR)
                             {
diff --git a/lib/framework/MqttSettingsService.h b/lib/framework/MqttSettingsService.h
@@ -106,7 +106,7 @@ class MqttSettings
         root["message_interval_ms"] = settings.messageIntervalMs;
     }
 
-    static StateUpdateResult update(JsonObject &root, MqttSettings &settings)
+    static StateUpdateResult update(JsonObject &root, MqttSettings &settings, const String &originId)
     {
         settings.enabled = root["enabled"] | FACTORY_MQTT_ENABLED;
         settings.uri = root["uri"] | FACTORY_MQTT_URI;
diff --git a/lib/framework/NTPSettingsService.h b/lib/framework/NTPSettingsService.h
@@ -63,7 +63,7 @@ class NTPSettings
         root["tz_format"] = settings.tzFormat;
     }
 
-    static StateUpdateResult update(JsonObject &root, NTPSettings &settings)
+    static StateUpdateResult update(JsonObject &root, NTPSettings &settings, const String &originId)
     {
         settings.enabled = root["enabled"] | FACTORY_NTP_ENABLED;
         settings.server = root["server"] | FACTORY_NTP_SERVER;
diff --git a/lib/framework/SecuritySettingsService.h b/lib/framework/SecuritySettingsService.h
@@ -70,7 +70,7 @@ class SecuritySettings
         }
     }
 
-    static StateUpdateResult update(JsonObject &root, SecuritySettings &settings)
+    static StateUpdateResult update(JsonObject &root, SecuritySettings &settings, const String& originID)
     {
         // secret
         settings.jwtSecret = root["jwt_secret"] | SettingValue::format(FACTORY_JWT_SECRET);
diff --git a/lib/framework/StatefulService.h b/lib/framework/StatefulService.h
@@ -31,7 +31,7 @@ enum class StateUpdateResult
 };
 
 template <typename T>
-using JsonStateUpdater = std::function<StateUpdateResult(JsonObject &root, T &settings)>;
+using JsonStateUpdater = std::function<StateUpdateResult(JsonObject &root, T &settings, const String &originId)>;
 
 template <typename T>
 using JsonStateReader = std::function<void(T &settings, JsonObject &root)>;
@@ -133,7 +133,7 @@ class StatefulService
         return result;
     }
 
-    StateUpdateResult updateWithoutPropagation(std::function<StateUpdateResult(T &)> stateUpdater)
+    StateUpdateResult updateWithoutPropagation(std::function<StateUpdateResult(T &)> stateUpdater, const String &originId)
     {
         beginTransaction();
         StateUpdateResult result = stateUpdater(_state);
@@ -144,7 +144,7 @@ class StatefulService
     StateUpdateResult update(JsonObject &jsonObject, JsonStateUpdater<T> stateUpdater, const String &originId)
     {
         beginTransaction();
-        StateUpdateResult result = stateUpdater(jsonObject, _state);
+        StateUpdateResult result = stateUpdater(jsonObject, _state, originId);
         endTransaction();
         callHookHandlers(originId, result);
         if (result == StateUpdateResult::CHANGED)
@@ -154,10 +154,10 @@ class StatefulService
         return result;
     }
 
-    StateUpdateResult updateWithoutPropagation(JsonObject &jsonObject, JsonStateUpdater<T> stateUpdater)
+    StateUpdateResult updateWithoutPropagation(JsonObject &jsonObject, JsonStateUpdater<T> stateUpdater, const String &originId)
     {
         beginTransaction();
-        StateUpdateResult result = stateUpdater(jsonObject, _state);
+        StateUpdateResult result = stateUpdater(jsonObject, _state, originId);
         endTransaction();
         return result;
     }
diff --git a/lib/framework/WiFiSettingsService.h b/lib/framework/WiFiSettingsService.h
@@ -114,7 +114,7 @@ class WiFiSettings
         ESP_LOGV(SVK_TAG, "WiFi Settings read");
     }
 
-    static StateUpdateResult update(JsonObject &root, WiFiSettings &settings)
+    static StateUpdateResult update(JsonObject &root, WiFiSettings &settings, const String &originId)
     {
         settings.hostname = root["hostname"] | SettingValue::format(FACTORY_WIFI_HOSTNAME);
         settings.staConnectionMode = root["connection_mode"] | 1;
diff --git a/src/LightMqttSettingsService.h b/src/LightMqttSettingsService.h
@@ -46,7 +46,7 @@ class LightMqttSettings
         root["status_topic"] = settings.stateTopic;
     }
 
-    static StateUpdateResult update(JsonObject &root, LightMqttSettings &settings)
+    static StateUpdateResult update(JsonObject &root, LightMqttSettings &settings, const String& originID)
     {
         settings.mqttPath = root["mqtt_path"] | SettingValue::format("homeassistant/light/#{unique_id}");
         settings.name = root["name"] | SettingValue::format("light-#{unique_id}");
diff --git a/src/LightStateService.h b/src/LightStateService.h
@@ -42,7 +42,7 @@ class LightState
         root["led_on"] = settings.ledOn;
     }
 
-    static StateUpdateResult update(JsonObject &root, LightState &lightState)
+    static StateUpdateResult update(JsonObject &root, LightState &lightState, const String& originID)
     {
         boolean newState = root["led_on"] | DEFAULT_LED_STATE;
         if (lightState.ledOn != newState)
@@ -58,7 +58,7 @@ class LightState
         root["state"] = settings.ledOn ? ON_STATE : OFF_STATE;
     }
 
-    static StateUpdateResult homeAssistUpdate(JsonObject &root, LightState &lightState)
+    static StateUpdateResult homeAssistUpdate(JsonObject &root, LightState &lightState, const String& originID)
     {
         String state = root["state"];
         // parse new led state

Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ class APSettings`
`111`	`111`	`root["subnet_mask"] = settings.subnetMask.toString();`
`112`	`112`	`}`
`113`	`113`
`114`		`- static StateUpdateResult update(JsonObject &root, APSettings &settings)`
	`114`	`+ static StateUpdateResult update(JsonObject &root, APSettings &settings, const String &originId)`
`115`	`115`	`{`
`116`	`116`	`APSettings newSettings = {};`
`117`	`117`	`newSettings.provisionMode = root["provision_mode"] \| FACTORY_AP_PROVISION_MODE;`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ class FSPersistence`
`47`	`47`	`if (error == DeserializationError::Ok && jsonDocument.is<JsonObject>())`
`48`	`48`	`{`
`49`	`49`	`JsonObject jsonObject = jsonDocument.as<JsonObject>();`
`50`		`- _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater);`
	`50`	`+ _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater, _filePath);`
`51`	`51`	`settingsFile.close();`
`52`	`52`	`return;`
`53`	`53`	`}`
`@@ -135,7 +135,7 @@ class FSPersistence`
`135`	`135`	`{`
`136`	`136`	`JsonDocument jsonDocument;`
`137`	`137`	`JsonObject jsonObject = jsonDocument.as<JsonObject>();`
`138`		`- _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater);`
	`138`	`+ _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater, _filePath);`
`139`	`139`	`}`
`140`	`140`	`};`
`141`	`141`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ class HttpEndpoint`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`JsonObject jsonObject = json.as<JsonObject>();`
`87`		`- StateUpdateResult outcome = _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater);`
	`87`	`+ StateUpdateResult outcome = _statefulService->updateWithoutPropagation(jsonObject, _stateUpdater, _servicePath);`
`88`	`88`
`89`	`89`	`if (outcome == StateUpdateResult::ERROR)`
`90`	`90`	`{`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ class MqttSettings`
`106`	`106`	`root["message_interval_ms"] = settings.messageIntervalMs;`
`107`	`107`	`}`
`108`	`108`
`109`		`- static StateUpdateResult update(JsonObject &root, MqttSettings &settings)`
	`109`	`+ static StateUpdateResult update(JsonObject &root, MqttSettings &settings, const String &originId)`
`110`	`110`	`{`
`111`	`111`	`settings.enabled = root["enabled"] \| FACTORY_MQTT_ENABLED;`
`112`	`112`	`settings.uri = root["uri"] \| FACTORY_MQTT_URI;`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ class NTPSettings`
`63`	`63`	`root["tz_format"] = settings.tzFormat;`
`64`	`64`	`}`
`65`	`65`
`66`		`- static StateUpdateResult update(JsonObject &root, NTPSettings &settings)`
	`66`	`+ static StateUpdateResult update(JsonObject &root, NTPSettings &settings, const String &originId)`
`67`	`67`	`{`
`68`	`68`	`settings.enabled = root["enabled"] \| FACTORY_NTP_ENABLED;`
`69`	`69`	`settings.server = root["server"] \| FACTORY_NTP_SERVER;`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ class SecuritySettings`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`
`73`		`- static StateUpdateResult update(JsonObject &root, SecuritySettings &settings)`
	`73`	`+ static StateUpdateResult update(JsonObject &root, SecuritySettings &settings, const String& originID)`
`74`	`74`	`{`
`75`	`75`	`// secret`
`76`	`76`	`settings.jwtSecret = root["jwt_secret"] \| SettingValue::format(FACTORY_JWT_SECRET);`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ enum class StateUpdateResult`
`31`	`31`	`};`
`32`	`32`
`33`	`33`	`template <typename T>`
`34`		`-using JsonStateUpdater = std::function<StateUpdateResult(JsonObject &root, T &settings)>;`
	`34`	`+using JsonStateUpdater = std::function<StateUpdateResult(JsonObject &root, T &settings, const String &originId)>;`
`35`	`35`
`36`	`36`	`template <typename T>`
`37`	`37`	`using JsonStateReader = std::function<void(T &settings, JsonObject &root)>;`
`@@ -133,7 +133,7 @@ class StatefulService`
`133`	`133`	`return result;`
`134`	`134`	`}`
`135`	`135`
`136`		`- StateUpdateResult updateWithoutPropagation(std::function<StateUpdateResult(T &)> stateUpdater)`
	`136`	`+ StateUpdateResult updateWithoutPropagation(std::function<StateUpdateResult(T &)> stateUpdater, const String &originId)`
`137`	`137`	`{`
`138`	`138`	`beginTransaction();`
`139`	`139`	`StateUpdateResult result = stateUpdater(_state);`
`@@ -144,7 +144,7 @@ class StatefulService`
`144`	`144`	`StateUpdateResult update(JsonObject &jsonObject, JsonStateUpdater<T> stateUpdater, const String &originId)`
`145`	`145`	`{`
`146`	`146`	`beginTransaction();`
`147`		`- StateUpdateResult result = stateUpdater(jsonObject, _state);`
	`147`	`+ StateUpdateResult result = stateUpdater(jsonObject, _state, originId);`
`148`	`148`	`endTransaction();`
`149`	`149`	`callHookHandlers(originId, result);`
`150`	`150`	`if (result == StateUpdateResult::CHANGED)`
`@@ -154,10 +154,10 @@ class StatefulService`
`154`	`154`	`return result;`
`155`	`155`	`}`
`156`	`156`
`157`		`- StateUpdateResult updateWithoutPropagation(JsonObject &jsonObject, JsonStateUpdater<T> stateUpdater)`
	`157`	`+ StateUpdateResult updateWithoutPropagation(JsonObject &jsonObject, JsonStateUpdater<T> stateUpdater, const String &originId)`
`158`	`158`	`{`
`159`	`159`	`beginTransaction();`
`160`		`- StateUpdateResult result = stateUpdater(jsonObject, _state);`
	`160`	`+ StateUpdateResult result = stateUpdater(jsonObject, _state, originId);`
`161`	`161`	`endTransaction();`
`162`	`162`	`return result;`
`163`	`163`	`}`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ class WiFiSettings`
`114`	`114`	`ESP_LOGV(SVK_TAG, "WiFi Settings read");`
`115`	`115`	`}`
`116`	`116`
`117`		`- static StateUpdateResult update(JsonObject &root, WiFiSettings &settings)`
	`117`	`+ static StateUpdateResult update(JsonObject &root, WiFiSettings &settings, const String &originId)`
`118`	`118`	`{`
`119`	`119`	`settings.hostname = root["hostname"] \| SettingValue::format(FACTORY_WIFI_HOSTNAME);`
`120`	`120`	`settings.staConnectionMode = root["connection_mode"] \| 1;`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ class LightMqttSettings`
`46`	`46`	`root["status_topic"] = settings.stateTopic;`
`47`	`47`	`}`
`48`	`48`
`49`		`- static StateUpdateResult update(JsonObject &root, LightMqttSettings &settings)`
	`49`	`+ static StateUpdateResult update(JsonObject &root, LightMqttSettings &settings, const String& originID)`
`50`	`50`	`{`
`51`	`51`	`settings.mqttPath = root["mqtt_path"] \| SettingValue::format("homeassistant/light/#{unique_id}");`
`52`	`52`	`settings.name = root["name"] \| SettingValue::format("light-#{unique_id}");`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ class LightState`
`42`	`42`	`root["led_on"] = settings.ledOn;`
`43`	`43`	`}`
`44`	`44`
`45`		`- static StateUpdateResult update(JsonObject &root, LightState &lightState)`
	`45`	`+ static StateUpdateResult update(JsonObject &root, LightState &lightState, const String& originID)`
`46`	`46`	`{`
`47`	`47`	`boolean newState = root["led_on"] \| DEFAULT_LED_STATE;`
`48`	`48`	`if (lightState.ledOn != newState)`
`@@ -58,7 +58,7 @@ class LightState`
`58`	`58`	`root["state"] = settings.ledOn ? ON_STATE : OFF_STATE;`
`59`	`59`	`}`
`60`	`60`
`61`		`- static StateUpdateResult homeAssistUpdate(JsonObject &root, LightState &lightState)`
	`61`	`+ static StateUpdateResult homeAssistUpdate(JsonObject &root, LightState &lightState, const String& originID)`
`62`	`62`	`{`
`63`	`63`	`String state = root["state"];`
`64`	`64`	`// parse new led state`