Configurable caching

Signed-off-by: Simone Orru <simone.orru@secomind.com>
astarte-platform · Dec 7, 2023 · 3d83046 · 3d83046
1 parent 76493fd
commit 3d83046
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 1 deletion.
diff --git a/Kconfig b/Kconfig
@@ -67,4 +67,18 @@ config ASTARTE_HWID_UUID_NAMESPACE
     help
         This option controls the UUID namespace that will be fed to the UUIDv5 algorithm when generating the hardware ID (if the "Use UUIDv5 to derive the hardware ID" is enabled).
 
+config ASTARTE_USE_PROPERTY_PERSISTENCY
+    bool "Enable NVS caching of properties"
+    default n
+    help
+        This option enables caching for the status of both server and device owned properties.
+        It uses the ESP NVS as storage.
+
+config ASTARTE_PROPERTY_PERSISTENCY_NVS_PARTITION_LABEL
+    string "NVS partition label to use for caching properties"
+    default "nvs"
+    depends on ASTARTE_USE_PROPERTY_PERSISTENCY
+    help
+        Use this option to specify a custom NVS partition for caching the received properties.
+
 endmenu
diff --git a/examples/properties/sdkconfig.defaults b/examples/properties/sdkconfig.defaults
@@ -30,6 +30,7 @@ CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
 #
 CONFIG_ASTARTE_HWID_ENABLE_UUID=n
 CONFIG_ASTARTE_HWID_UUID_NAMESPACE=""
+CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY=y
 # end of Astarte SDK
 
 #

diff --git a/src/astarte_device.c b/src/astarte_device.c
@@ -76,25 +76,31 @@ static astarte_err_t publish_data(astarte_device_handle_t device, const char *in
 static void setup_subscriptions(astarte_device_handle_t device);
 static void send_introspection(astarte_device_handle_t device);
 static void send_emptycache(astarte_device_handle_t device);
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
 static void send_device_owned_properties(astarte_device_handle_t device);
 static void send_purge_device_properties(
     astarte_device_handle_t device, astarte_linked_list_handle_t *list_handle);
+#endif
 static void on_connected(astarte_device_handle_t device, int session_present);
 static void on_disconnected(astarte_device_handle_t device);
 static void on_incoming(
     astarte_device_handle_t device, char *topic, int topic_len, char *data, int data_len);
 static void on_control_message(
     astarte_device_handle_t device, char *control_topic, char *data, int data_len);
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
 static void on_purge_properties(astarte_device_handle_t device, char *data, int data_len);
 static astarte_err_t uncompress_purge_properties(
     char *data, int data_len, char **output, uLongf *output_len);
+#endif
 static void on_certificate_error(astarte_device_handle_t device);
 static void mqtt_event_handler(
     void *handler_args, esp_event_base_t base, int32_t event_id, void *event_data);
 static int has_connectivity();
 static void maybe_append_timestamp(astarte_bson_serializer_handle_t bson, uint64_t ts_epoch_millis);
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
 static astarte_interface_t *get_interface_from_introspection(
     astarte_device_handle_t device, const char *name);
+#endif
 
 astarte_device_handle_t astarte_device_init(astarte_device_config_t *cfg)
 {
@@ -574,6 +580,7 @@ static astarte_err_t publish_bson(astarte_device_handle_t device, const char *in
         ESP_LOGE(TAG, "Interface: %s, path: %s", interface_name, path);
         return ASTARTE_ERR;
     }
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
     astarte_interface_t *interface = get_interface_from_introspection(device, interface_name);
     if (interface && (interface->type == TYPE_PROPERTIES)) {
         // Open storage
@@ -609,6 +616,7 @@ static astarte_err_t publish_bson(astarte_device_handle_t device, const char *in
         // Close storage
         astarte_storage_close(storage_handle);
     }
+#endif
 
     return publish_data(device, interface_name, path, data, len, qos);
 }
@@ -917,6 +925,7 @@ astarte_err_t astarte_device_set_datetime_property(
 astarte_err_t astarte_device_unset_path(
     astarte_device_handle_t device, const char *interface_name, const char *path)
 {
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
     astarte_interface_t *interface = get_interface_from_introspection(device, interface_name);
     if (interface && (interface->type == TYPE_PROPERTIES)) {
         // Open storage
@@ -942,6 +951,7 @@ astarte_err_t astarte_device_unset_path(
         // Close storage
         astarte_storage_close(storage_handle);
     }
+#endif
     return publish_data(device, interface_name, path, "", 0, 2);
 }
 
@@ -1151,6 +1161,7 @@ static void send_emptycache(astarte_device_handle_t device)
     esp_mqtt_client_publish(mqtt, topic, "1", 1, 2, 0);
 }
 
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
 static void send_device_owned_properties(astarte_device_handle_t device)
 {
     if (check_device(device) != ASTARTE_OK) {
@@ -1382,6 +1393,7 @@ static void send_purge_device_properties(
     free(properties_list);
     free(payload);
 }
+#endif
 
 static void on_connected(astarte_device_handle_t device, int session_present)
 {
@@ -1404,7 +1416,9 @@ static void on_connected(astarte_device_handle_t device, int session_present)
     setup_subscriptions(device);
     send_introspection(device);
     send_emptycache(device);
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
     send_device_owned_properties(device);
+#endif
 }
 
 static void on_disconnected(astarte_device_handle_t device)
@@ -1490,6 +1504,7 @@ static void on_incoming(
     }
 
     if (!data && data_len == 0) {
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
         astarte_interface_t *interface = get_interface_from_introspection(device, interface_name);
         if (interface && (interface->type == TYPE_PROPERTIES)) {
             // Open storage
@@ -1511,6 +1526,7 @@ static void on_incoming(
                 return;
             }
         }
+#endif
         if (device->unset_event_callback) {
             astarte_device_unset_event_t event = {
                 .device = device,
@@ -1531,6 +1547,7 @@ static void on_incoming(
         return;
     }
 
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
     astarte_interface_t *interface = get_interface_from_introspection(device, interface_name);
     if (interface && (interface->type == TYPE_PROPERTIES)) {
         // Open storage
@@ -1569,6 +1586,7 @@ static void on_incoming(
         // Close storage
         astarte_storage_close(storage_handle);
     }
+#endif
 
     // Keep old deserializer for compatibility
 #pragma GCC diagnostic push
@@ -1602,16 +1620,21 @@ static void on_incoming(
     device->data_event_callback(&event);
 }
 
+// NOLINTBEGIN(misc-unused-parameters)
 static void on_control_message(
     astarte_device_handle_t device, char *control_topic, char *data, int data_len)
+// NOLINTEND(misc-unused-parameters)
 {
     if (strcmp(control_topic, "/consumer/properties") == 0) {
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
         on_purge_properties(device, data, data_len);
+#endif
     } else {
         ESP_LOGE(TAG, "Received unrecognized control message: %s.", control_topic);
     }
 }
 
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
 static void on_purge_properties(astarte_device_handle_t device, char *data, int data_len)
 {
     char *uncompressed = NULL;
@@ -1813,6 +1836,7 @@ static astarte_err_t uncompress_purge_properties(
     *output_len = uncompressed_len;
     return ASTARTE_OK;
 }
+#endif
 
 static int has_connectivity()
 {
@@ -1898,6 +1922,7 @@ static void mqtt_event_handler(
     }
 }
 
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
 static astarte_interface_t *get_interface_from_introspection(
     astarte_device_handle_t device, const char *name)
 {
@@ -1913,3 +1938,4 @@ static astarte_interface_t *get_interface_from_introspection(
     }
     return NULL;
 }
+#endif
diff --git a/src/astarte_storage.c b/src/astarte_storage.c
@@ -23,12 +23,17 @@
  *         Global functions definitions         *
  ***********************************************/
 
+// NOLINTNEXTLINE(misc-unused-parameters)
 astarte_err_t astarte_storage_open(astarte_storage_handle_t *handle)
 {
-    esp_err_t esp_err = nvs_open(NVS_NAMESPACE, NVS_READWRITE, &handle->nvs_handle);
+#ifdef CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY
+    esp_err_t esp_err
+        = nvs_open_from_partition(CONFIG_ASTARTE_PROPERTY_PERSISTENCY_NVS_PARTITION_LABEL,
+            NVS_NAMESPACE, NVS_READWRITE, &handle->nvs_handle);
     if (esp_err != ESP_OK) {
         return ASTARTE_ERR;
     }
+#endif
     return ASTARTE_OK;
 }
 

diff --git a/tests/target_app/sdkconfig.defaults b/tests/target_app/sdkconfig.defaults
@@ -22,3 +22,9 @@
 CONFIG_UNITY_ENABLE_COLOR=y
 CONFIG_UNITY_ENABLE_IDF_TEST_RUNNER=n
 CONFIG_UNITY_ENABLE_64BIT=y
+
+#
+# Astarte SDK
+#
+CONFIG_ASTARTE_USE_PROPERTY_PERSISTENCY=y
+# end of Astarte SDK