Add field to trigger config shadow persistance updates

Author: Ubuntu

source/config/Config.cpp

@@ -1883,6 +1883,8 @@ void PlainConfig::SampleShadow::SerializeToObject(Crt::JsonObject &object) const
 
 constexpr char PlainConfig::ConfigShadow::JSON_ENABLE_CONFIG_SHADOW[];
 constexpr char PlainConfig::ConfigShadow::CLI_ENABLE_CONFIG_SHADOW[];
+constexpr char PlainConfig::ConfigShadow::JSON_CONFIG_SHADOW_PERSISTENT_UPDATE[];
+
 
 bool PlainConfig::ConfigShadow::LoadFromJson(const Crt::JsonView &json)
 {
@@ -1892,6 +1894,12 @@ bool PlainConfig::ConfigShadow::LoadFromJson(const Crt::JsonView &json)
         enabled = json.GetBool(jsonKey);
     }
 
+    jsonKey = JSON_CONFIG_SHADOW_PERSISTENT_UPDATE;
+    if (json.ValueExists(jsonKey))
+    {
+        persistentUpdate = json.GetBool(jsonKey);
+    }
+
     return true;
 }
 
@@ -1913,6 +1921,7 @@ bool PlainConfig::ConfigShadow::Validate() const
 void PlainConfig::ConfigShadow::SerializeToObject(Crt::JsonObject &object) const
 {
     object.WithBool(JSON_ENABLE_CONFIG_SHADOW, enabled);
+    object.WithBool(JSON_CONFIG_SHADOW_PERSISTENT_UPDATE, persistentUpdate);
 }
 
 constexpr char PlainConfig::SecureElement::CLI_ENABLE_SECURE_ELEMENT[];
@@ -3139,6 +3148,7 @@ bool Config::ExportDefaultSetting(const string &file)
         PlainConfig::SampleShadow::JSON_SAMPLE_SHADOW_OUTPUT_FILE,
         PlainConfig::JSON_KEY_CONFIG_SHADOW,
         PlainConfig::ConfigShadow::JSON_ENABLE_CONFIG_SHADOW,
+        PlainConfig::ConfigShadow::JSON_CONFIG_SHADOW_PERSISTENT_UPDATE,
         PlainConfig::JSON_KEY_SECURE_ELEMENT,
         PlainConfig::SecureElement::JSON_ENABLE_SECURE_ELEMENT,
         PlainConfig::SecureElement::JSON_PKCS11_LIB,

source/config/Config.h

@@ -372,8 +372,10 @@ namespace Aws
 
                     static constexpr char CLI_ENABLE_CONFIG_SHADOW[] = "--enable-config-shadow";
                     static constexpr char JSON_ENABLE_CONFIG_SHADOW[] = "enabled";
+                    static constexpr char JSON_CONFIG_SHADOW_PERSISTENT_UPDATE[] = "persistent-update";
 
                     bool enabled{false};
+                    bool persistentUpdate{false};
                 };
                 ConfigShadow configShadow;
 

source/shadow/ConfigShadow.cpp

@@ -374,16 +374,37 @@ void ConfigShadow::resetClientConfigWithJSON(
         }
     }
 
-    // Save the updated configuration to a local file for persistence
-    JsonObject jsonObj;
-    config.SerializeToObject(jsonObj);  
-
-    const char* jsonStr = jsonObj.View().WriteReadable().c_str();
-    LOGM_INFO(TAG, "Updating device configuration files with the following: %s", jsonStr);
+        if (desiredJsonView.ValueExists(PlainConfig::JSON_KEY_CONFIG_SHADOW) &&
+        deltaJsonView.ValueExists(PlainConfig::JSON_KEY_CONFIG_SHADOW))
+    {
+        PlainConfig::ConfigShadow configShadow;
+        configShadow.LoadFromJson(desiredJsonView.GetJsonObject(PlainConfig::JSON_KEY_CONFIG_SHADOW));
+        if (configShadow.Validate())
+        {
+            config.configShadow = configShadow;
+        }
+        else
+        {
+            LOGM_WARN(
+                TAG,
+                "Config shadow contains invalid configurations in %s feature, aborting this feature's configuration "
+                "update now. Please check the error logs for more information",
+                PlainConfig::JSON_KEY_CONFIG_SHADOW);
+        }
+    }
 
-    string userConfig = FileUtils::ExtractExpandedPath(Config::DEFAULT_CONFIG_FILE);
-    updateLocalConfigFile(config, userConfig.c_str());
-    updateLocalConfigFile(config, Config::DEFAULT_ROOT_CONFIG_FILE);
+    // Save the updated configuration to a local file for persistence if required
+    if(config.configShadow.persistentUpdate)
+    {
+        JsonObject jsonObj;
+        config.SerializeToObject(jsonObj);  
+        const char* jsonStr = jsonObj.View().WriteReadable().c_str();
+        LOGM_INFO(TAG, "Updating device configuration files with the following config shadow update: %s", jsonStr);
+        
+        string userConfig = FileUtils::ExtractExpandedPath(Config::DEFAULT_CONFIG_FILE);
+        updateLocalConfigFile(config, userConfig.c_str());
+        updateLocalConfigFile(config, Config::DEFAULT_ROOT_CONFIG_FILE);
+    }
 }
 
 void ConfigShadow::updateShadowWithLocalConfig(Iotshadow::IotShadowClient iotShadowClient, PlainConfig &config)