GH-43: credentials: Fix User post-interview discovery

This patch will :
- Not delete all user database en Unify startup
- Allow the user to re-initiate an interview with the device and discover again all users

Bug-SiliconLabs: UIC-3222
Bug-GitHub: #43
Signed-off-by: Philippe Coval <[email protected]>

Author: silabs-borisl

applications/zpc/components/zwave_command_classes/src/zwave_command_class_user_credential.cpp

@@ -2317,9 +2317,29 @@ static sl_status_t zwave_command_class_user_credential_user_get(
   sl_status_t status
     = attribute_store_get_desired(node, &user_id, sizeof(user_id));
 
+  // If we enter this state it means that something went badly wrong or 
+  // user initiate the interview process again. 
+  // In both cases we want to invalidate the user database so that the device
+  // can send us the correct user database.
   if (status != SL_STATUS_OK) {
-    sl_log_error(LOG_TAG,
-                 "Can't get user unique id value. Not sending USER_GET.");
+    sl_log_warning(LOG_TAG,
+                 "Can't get user unique id value. Reset user database.");
+    attribute_store_node_t endpoint_node
+      = attribute_store_get_node_parent(node);
+    // Get User node count 
+    auto user_count = attribute_store_get_node_child_count_by_type(
+          endpoint_node,
+          ATTRIBUTE(USER_UNIQUE_ID));
+
+    for (size_t j = 0; j < user_count; j++) {
+      // Delete the first attribute we find until we have no more left
+      attribute_store_node_t user_node
+        = attribute_store_get_node_child_by_type(endpoint_node,
+                                                  ATTRIBUTE(USER_UNIQUE_ID),
+                                                  0);
+      attribute_store_delete_node(user_node);
+    }
+    // NOTE : In the case of user re-interviewing the device, it will be interviewed again when the node goes ONLINE.
     return SL_STATUS_NOT_SUPPORTED;
   }
 
@@ -2549,23 +2569,14 @@ void zwave_network_status_changed(attribute_store_node_t updated_node,
         auto user_count = attribute_store_get_node_child_count_by_type(
           endpoint_node,
           ATTRIBUTE(USER_UNIQUE_ID));
-        sl_log_debug(LOG_TAG,
-                     "Endpoint %d supports User Credential. Removing all "
-                     "existing user nodes (%d)...",
-                     i,
-                     user_count);
-        for (size_t j = 0; j < user_count; j++) {
-          // Delete the first attribute we find until we have no more left
-          attribute_store_node_t user_node
-            = attribute_store_get_node_child_by_type(endpoint_node,
-                                                     ATTRIBUTE(USER_UNIQUE_ID),
-                                                     0);
-          attribute_store_delete_node(user_node);
+        sl_log_debug(LOG_TAG, "Endpoint %d supports User Credential.", endpoint_id);
+        if (user_count == 0) {
+          sl_log_debug(LOG_TAG, "No user found. Starting User and Credential interview");
+          // Start the interview process with user ID = 0
+          trigger_get_user(endpoint_node, 0);
+        } else {
+          sl_log_debug(LOG_TAG, "Users already discovered. No actions needed.");
         }
-
-        sl_log_debug(LOG_TAG, "Starting User and Credential interview");
-        // Start the interview process with user ID = 0
-        trigger_get_user(endpoint_node, 0);
       }
     }
   }

applications/zpc/components/zwave_command_classes/test/zwave_command_class_user_credential_test.cpp

@@ -2100,18 +2100,6 @@ void test_post_interview_discovery()
   // Display current store log for debug purpose
   attribute_store_log();
 
-  // Set two random user id to see if discovery remove it
-  user_credential_user_unique_id_t user_id = 12;
-  attribute_store_emplace(endpoint_id_node,
-                          ATTRIBUTE(USER_UNIQUE_ID),
-                          &user_id,
-                          sizeof(user_id));
-  user_id = 1222;
-  attribute_store_emplace(endpoint_id_node,
-                          ATTRIBUTE(USER_UNIQUE_ID),
-                          &user_id,
-                          sizeof(user_id));
-
   // Set the network status to online
   network_status = ZCL_NODE_STATE_NETWORK_STATUS_ONLINE_FUNCTIONAL;
   attribute_store_set_reported(network_status_node,
@@ -2122,13 +2110,41 @@ void test_post_interview_discovery()
   auto user_id_node
     = attribute_store_get_first_child_by_type(endpoint_id_node,
                                               ATTRIBUTE(USER_UNIQUE_ID));
-
+  user_credential_user_unique_id_t user_id = 0;
   attribute_store_get_desired(user_id_node, &user_id, sizeof(user_id));
   TEST_ASSERT_NOT_EQUAL_MESSAGE(ATTRIBUTE_STORE_INVALID_NODE,
                                 user_id_node,
                                 "User id node should exists");
   TEST_ASSERT_EQUAL_MESSAGE(0, user_id, "User ID desired value should be 0");
   count_user_node(1);
+
+  // Simulate user found
+  user_id = 12;
+  attribute_store_set_reported(user_id_node, &user_id, sizeof(user_id));
+
+  // Go back to Interview state
+  network_status = ZCL_NODE_STATE_NETWORK_STATUS_ONLINE_INTERVIEWING;
+  attribute_store_set_reported(network_status_node,
+                               &network_status,
+                               sizeof(network_status));
+
+  // Then back in Online Functional
+  network_status = ZCL_NODE_STATE_NETWORK_STATUS_ONLINE_FUNCTIONAL;
+  attribute_store_set_reported(network_status_node,
+                               &network_status,
+                               sizeof(network_status));
+  // User should still be there
+  count_user_node(1);
+  // With right value
+  user_credential_user_unique_id_t reported_user_id = 0;
+  user_id_node = attribute_store_get_first_child_by_type(endpoint_id_node,
+                                                         ATTRIBUTE(USER_UNIQUE_ID));
+  attribute_store_get_reported(user_id_node,
+                               &reported_user_id,
+                               sizeof(reported_user_id));
+  TEST_ASSERT_EQUAL_MESSAGE(user_id,
+                            reported_user_id,
+                            "User ID reported value should be 12.");
 }
 
 void test_user_credential_notification_empty_parameters()