user_node_mapping: Better handling for user reset and mapping state

Even when an explicit user reset was triggered by the firmware,
the RMAKER_EVENT_USER_NODE_MAPPING_DONE event was getting generated,
which was misleading and causing issues while integrating other
frameworks. A new event RMAKER_EVENT_USER_NODE_MAPPING_RESET has
been added to distinguish this event.

The esp_rmaker_user_node_mapping_get_state() has also been exposed
for applications to use. Note that the CONFIG_ESP_RMAKER_USER_ID_CHECK
config option should be enabled to get correct state.

Author: shahpiyushv

Diff for: components/esp_rainmaker/include/esp_rmaker_core.h

@@ -49,6 +49,8 @@ typedef enum {
     RMAKER_EVENT_USER_NODE_MAPPING_DONE,
     /** Local control started. Associated data is the NULL terminated Service Name */
     RMAKER_EVENT_LOCAL_CTRL_STARTED,
+    /* User reset request successfully sent to ESP RainMaker Cloud */
+    RMAKER_EVENT_USER_NODE_MAPPING_RESET,
 } esp_rmaker_event_t;
 
 /** ESP RainMaker Node information */

Diff for: components/esp_rainmaker/include/esp_rmaker_user_mapping.h

@@ -19,6 +19,25 @@ extern "C"
 {
 #endif
 
+/** User-Node Mapping states */
+typedef enum {
+    /** Mapping does not exist or is not initialized */
+    ESP_RMAKER_USER_MAPPING_RESET = 0,
+    /** Mapping has started */
+    ESP_RMAKER_USER_MAPPING_STARTED,
+    /** Mapping is done */
+    ESP_RMAKER_USER_MAPPING_DONE,
+} esp_rmaker_user_mapping_state_t;
+
+/**
+ * Get User-Node mapping state
+ *
+ * This returns the current user-node mapping state.
+ *
+ * @return user mapping state
+ */
+esp_rmaker_user_mapping_state_t esp_rmaker_user_node_mapping_get_state(void);
+
 /**
  * Create User Mapping Endpoint
  *

Diff for: components/esp_rainmaker/src/core/esp_rmaker_core.c

@@ -134,9 +134,11 @@ static void esp_rmaker_event_handler(void* arg, esp_event_base_t event_base,
             /* Signal rmaker thread to continue execution */
             xEventGroupSetBits(wifi_event_group, WIFI_CONNECTED_EVENT);
         }
-    } else if (event_base == RMAKER_EVENT && event_id == RMAKER_EVENT_USER_NODE_MAPPING_DONE) {
+    } else if (event_base == RMAKER_EVENT &&
+            (event_id == RMAKER_EVENT_USER_NODE_MAPPING_DONE ||
+            event_id == RMAKER_EVENT_USER_NODE_MAPPING_RESET)) {
         esp_rmaker_params_mqtt_init();
-        esp_event_handler_unregister(RMAKER_EVENT, RMAKER_EVENT_USER_NODE_MAPPING_DONE, &esp_rmaker_event_handler);
+        esp_event_handler_unregister(RMAKER_EVENT, event_id, &esp_rmaker_event_handler);
     }
 }
 
@@ -331,15 +333,15 @@ static void esp_rmaker_task(void *data)
          * status.
          */
         if (esp_rmaker_user_node_mapping_get_state() != ESP_RMAKER_USER_MAPPING_STARTED) {
-            esp_rmaker_start_user_node_mapping("esp-rmaker", "failed");
+            esp_rmaker_reset_user_node_mapping();
+            /* Wait for user reset to finish. */
+            err = esp_event_handler_register(RMAKER_EVENT, RMAKER_EVENT_USER_NODE_MAPPING_RESET,
+                    &esp_rmaker_event_handler, NULL);
+        } else {
+            /* Wait for User Node mapping to finish. */
+            err = esp_event_handler_register(RMAKER_EVENT, RMAKER_EVENT_USER_NODE_MAPPING_DONE,
+                    &esp_rmaker_event_handler, NULL);
         }
-        /* Wait for User Node mapping to finish. This will also consider the above dummy user
-         * node mapping request as a successful  mapping, but that is still fine since the
-         * cloud would have reset the mappings. This allows other alternative user node mappings
-         * to be used after this point, which may be independent of provisioning.
-         */
-        err = esp_event_handler_register(RMAKER_EVENT, RMAKER_EVENT_USER_NODE_MAPPING_DONE,
-                &esp_rmaker_event_handler, NULL);
         if (err != ESP_OK) {
             ESP_LOGE(TAG, "Aborting!!!");
             goto rmaker_end;

Diff for: components/esp_rainmaker/src/core/esp_rmaker_internal.h

@@ -30,12 +30,6 @@ typedef enum {
     ESP_RMAKER_STATE_STOP_REQUESTED,
 } esp_rmaker_state_t;
 
-typedef enum {
-    ESP_RMAKER_USER_MAPPING_RESET = 0,
-    ESP_RMAKER_USER_MAPPING_STARTED,
-    ESP_RMAKER_USER_MAPPING_DONE,
-} esp_rmaker_user_mapping_state_t;
-
 typedef struct {
     esp_rmaker_param_val_t min;
     esp_rmaker_param_val_t max;
@@ -111,8 +105,8 @@ char *esp_rmaker_get_node_params(void);
 esp_err_t esp_rmaker_handle_set_params(char *data, size_t data_len, esp_rmaker_req_src_t src);
 esp_err_t esp_rmaker_user_mapping_prov_init(void);
 esp_err_t esp_rmaker_user_mapping_prov_deinit(void);
-esp_rmaker_user_mapping_state_t esp_rmaker_user_node_mapping_get_state(void);
 esp_err_t esp_rmaker_user_node_mapping_init(void);
+esp_err_t esp_rmaker_reset_user_node_mapping(void);
 esp_err_t esp_rmaker_init_local_ctrl_service(void);
 esp_err_t esp_rmaker_start_local_ctrl_service(const char *serv_name);
 static inline esp_err_t esp_rmaker_post_event(esp_rmaker_event_t event_id, void* data, size_t data_size)

Diff for: components/esp_rainmaker/src/core/esp_rmaker_user_mapping.c

@@ -32,6 +32,8 @@ static const char *TAG = "esp_rmaker_user_mapping";
 #define USER_MAPPING_ENDPOINT       "cloud_user_assoc"
 #define USER_MAPPING_NVS_NAMESPACE  "user_mapping"
 #define USER_ID_NVS_NAME            "user_id"
+#define USER_RESET_ID               "esp-rmaker"
+#define USER_RESET_KEY              "failed"
 
 typedef struct {
     char *user_id;
@@ -82,7 +84,15 @@ static void esp_rmaker_user_mapping_event_handler(void* arg, esp_event_base_t ev
         int msg_id = *((int *)event_data);
         if (msg_id == rmaker_user_mapping_data->mqtt_msg_id) {
             ESP_LOGI(TAG, "User Node association message published successfully.");
-            rmaker_user_mapping_state = ESP_RMAKER_USER_MAPPING_DONE;
+            esp_rmaker_user_mapping_data_t *data = (esp_rmaker_user_mapping_data_t *)arg;
+            if (data && (strcmp(data->user_id, USER_RESET_ID) == 0)) {
+                rmaker_user_mapping_state = ESP_RMAKER_USER_MAPPING_RESET;
+                esp_rmaker_post_event(RMAKER_EVENT_USER_NODE_MAPPING_RESET, NULL, 0);
+            } else {
+                rmaker_user_mapping_state = ESP_RMAKER_USER_MAPPING_DONE;
+                esp_rmaker_post_event(RMAKER_EVENT_USER_NODE_MAPPING_DONE, rmaker_user_mapping_data->user_id,
+                    strlen(rmaker_user_mapping_data->user_id) + 1);
+            }
 #ifdef CONFIG_ESP_RMAKER_USER_ID_CHECK
             /* Store User Id in NVS since acknowledgement of the user-node association message is received */
             nvs_handle handle;
@@ -92,8 +102,6 @@ static void esp_rmaker_user_mapping_event_handler(void* arg, esp_event_base_t ev
                 nvs_close(handle);
             }
 #endif
-            esp_rmaker_post_event(RMAKER_EVENT_USER_NODE_MAPPING_DONE, rmaker_user_mapping_data->user_id,
-                    strlen(rmaker_user_mapping_data->user_id) + 1);
             esp_rmaker_user_mapping_cleanup_data();
             esp_event_handler_unregister(RMAKER_COMMON_EVENT, RMAKER_MQTT_EVENT_PUBLISHED,
                     &esp_rmaker_user_mapping_event_handler);
@@ -108,7 +116,7 @@ static void esp_rmaker_user_mapping_cb(void *priv_data)
         return;
     }
     esp_event_handler_register(RMAKER_COMMON_EVENT, RMAKER_MQTT_EVENT_PUBLISHED,
-            &esp_rmaker_user_mapping_event_handler, NULL);
+            &esp_rmaker_user_mapping_event_handler, data);
     char publish_payload[200];
     json_gen_str_t jstr;
     json_gen_str_start(&jstr, publish_payload, sizeof(publish_payload), NULL, NULL);
@@ -200,6 +208,11 @@ esp_err_t esp_rmaker_start_user_node_mapping(char *user_id, char *secret_key)
     return ESP_FAIL;
 }
 
+esp_err_t esp_rmaker_reset_user_node_mapping(void)
+{
+    return esp_rmaker_start_user_node_mapping(USER_RESET_ID, USER_RESET_KEY);
+}
+
 int esp_rmaker_user_mapping_handler(uint32_t session_id, const uint8_t *inbuf, ssize_t inlen, uint8_t **outbuf, ssize_t *outlen, void *priv_data)
 {
     Rainmaker__RMakerConfigPayload *data;