applications: matter_bridge: Migrate bridged device data to version 2

Migrate bridged device data from old scheme and new scheme version 1 to
version 2.

Signed-off-by: Adrian Gielniewski <[email protected]>

Author: adigie

samples/matter/common/src/bridge/bridge_storage_manager.cpp

@@ -6,6 +6,7 @@
 
 #include "bridge_storage_manager.h"
 #include "bridge_manager.h"
+#include "platform/ConfigurationManager.h"
 
 #include <zephyr/logging/log.h>
 
@@ -196,76 +197,150 @@ bool BridgeStorageManager::Init()
 	return MigrateData();
 }
 
-bool BridgeStorageManager::MigrateData()
+bool BridgeStorageManager::MigrateDataOldScheme(uint8_t bridgedDeviceIndex)
 {
-	uint8_t version;
-
-	/* Check if version key is present in settings to provide backward compatibility between post-2.6.0 releases and
-	 * the previous one. If the version key is present it means that the new keys structure is used (only version
-	 * equal to 1 is for now valid). Otherwise, the deprecated structure is used, so the migration has to be done.
-	 */
-	if (!LoadDataToObject(&mVersion, version)) {
-		uint8_t count;
-		uint8_t indexes[BridgeManager::kMaxBridgedDevices] = { 0 };
-		size_t indexesCount = 0;
-
-		if (LoadBridgedDevicesCount(count) &&
-		    LoadBridgedDevicesIndexes(indexes, BridgeManager::kMaxBridgedDevices, indexesCount)) {
-			/* Load all devices based on the read count number. */
-			for (size_t i = 0; i < indexesCount; i++) {
-				BridgedDevice device;
-				if (!LoadBridgedDeviceEndpointId(device.mEndpointId, i)) {
-					return false;
-				}
+	BridgedDevice device;
+	if (!LoadBridgedDeviceEndpointId(device.mEndpointId, bridgedDeviceIndex)) {
+		return false;
+	}
 
-				/* Ignore an error, as node label is optional, so it may not be found. */
-				if (!LoadBridgedDeviceNodeLabel(device.mNodeLabel, sizeof(device.mNodeLabel),
-								device.mNodeLabelLength, i)) {
-					device.mNodeLabelLength = 0;
-				}
+	/* Ignore an error, as node label is optional, so it may not be found. */
+	if (!LoadBridgedDeviceNodeLabel(device.mNodeLabel, sizeof(device.mNodeLabel), device.mNodeLabelLength,
+					bridgedDeviceIndex)) {
+		device.mNodeLabelLength = 0;
+	}
 
-				if (!LoadBridgedDeviceType(device.mDeviceType, i)) {
-					return false;
-				}
+	if (!LoadBridgedDeviceType(device.mDeviceType, bridgedDeviceIndex)) {
+		return false;
+	}
 
 #ifdef CONFIG_BRIDGED_DEVICE_BT
-				bt_addr_le_t btAddr;
+	bt_addr_le_t btAddr;
 
-				if (!LoadBtAddress(btAddr, i)) {
-					return false;
-				}
+	if (!LoadBtAddress(btAddr, bridgedDeviceIndex)) {
+		return false;
+	}
 
-				/* Insert Bluetooth LE address as a part of implementation specific user data. */
-				device.mUserDataSize = sizeof(btAddr);
-				device.mUserData = reinterpret_cast<uint8_t *>(&btAddr);
+	/* Insert Bluetooth LE address as a part of implementation specific user data. */
+	device.mUserDataSize = sizeof(btAddr);
+	device.mUserData = reinterpret_cast<uint8_t *>(&btAddr);
 #endif
 
-				/* Store all information using a new scheme. */
-				if (!StoreBridgedDevice(device, i)) {
-					return false;
-				}
+	/* Generate UniqueID */
+	CHIP_ERROR result =
+		chip::DeviceLayer::ConfigurationMgrImpl().GenerateUniqueId(device.mUniqueID, sizeof(device.mUniqueID));
+	if (result != CHIP_NO_ERROR) {
+		return false;
+	}
+	device.mUniqueIDLength = strlen(device.mUniqueID);
+
+	/* Store all information using a new scheme. */
+	if (!StoreBridgedDevice(device, bridgedDeviceIndex)) {
+		return false;
+	}
 
-				/* Remove all information described using an old scheme. */
-				RemoveBridgedDeviceEndpointId(i);
-				RemoveBridgedDeviceNodeLabel(i);
-				RemoveBridgedDeviceType(i);
+	/* Remove all information described using an old scheme. */
+	RemoveBridgedDeviceEndpointId(bridgedDeviceIndex);
+	RemoveBridgedDeviceNodeLabel(bridgedDeviceIndex);
+	RemoveBridgedDeviceType(bridgedDeviceIndex);
 
 #ifdef CONFIG_BRIDGED_DEVICE_BT
-				RemoveBtAddress(i);
+	RemoveBtAddress(bridgedDeviceIndex);
 #endif
-			}
-		}
 
-		version = 1;
-		Nrf::GetPersistentStorage().NonSecureStore(&mVersion, &version, sizeof(version));
+	return true;
+}
+
+bool BridgeStorageManager::MigrateDataVersion1(uint8_t bridgedDeviceIndex)
+{
+	BridgedDeviceV1 v1;
+	BridgedDevice device;
+
+#ifdef CONFIG_BRIDGED_DEVICE_BT
+	bt_addr_le_t btAddr;
 
-	} else if (version != 1) {
-		/* Currently only no-version or version equal to 1 is supported. */
+	/* Insert Bluetooth LE address as a part of implementation specific user data. */
+	v1.mUserDataSize = sizeof(btAddr);
+	v1.mUserData = reinterpret_cast<uint8_t *>(&btAddr);
+#endif
+
+	/* Load all information from old scheme */
+	if (!LoadBridgedDevice(v1, bridgedDeviceIndex)) {
+		return false;
+	}
+
+	/* Copy all information to new scheme */
+	device.mEndpointId = v1.mEndpointId;
+	device.mDeviceType = v1.mDeviceType;
+	device.mNodeLabelLength = v1.mNodeLabelLength;
+	memcpy(device.mNodeLabel, v1.mNodeLabel, v1.mNodeLabelLength);
+	device.mUserDataSize = v1.mUserDataSize;
+	device.mUserData = v1.mUserData;
+
+	/* Generate UniqueID */
+	CHIP_ERROR result =
+		chip::DeviceLayer::ConfigurationMgrImpl().GenerateUniqueId(device.mUniqueID, sizeof(device.mUniqueID));
+	if (result != CHIP_NO_ERROR) {
+		return false;
+	}
+	device.mUniqueIDLength = strlen(device.mUniqueID);
+
+	/* Store all information using new scheme */
+	if (!StoreBridgedDevice(device, bridgedDeviceIndex)) {
 		return false;
 	}
+
 	return true;
 }
 
+bool BridgeStorageManager::MigrateData()
+{
+	/* Check if migration is needed to provide backward compatibility between releases.
+	 * Perform migration in following cases:
+	 * 1) If the version key is missing - it means that the pre-2.7.0 release structure is used.
+	 * 2) If the version key is present but the version number does not match kCurrentVersion.
+	 */
+	uint8_t version;
+	const bool versionPresent = LoadDataToObject(&mVersion, version);
+	const bool migrationNeeded = !versionPresent || version != kCurrentVersion;
+
+	if (!migrationNeeded) {
+		/* No migration needed */
+		return true;
+	}
+
+	if (versionPresent && (version < 1 || version > kCurrentVersion)) {
+		/* Not supported version */
+		return false;
+	}
+
+	uint8_t count;
+	uint8_t indexes[BridgeManager::kMaxBridgedDevices] = { 0 };
+	size_t indexesCount = 0;
+
+	if (LoadBridgedDevicesCount(count) &&
+	    LoadBridgedDevicesIndexes(indexes, BridgeManager::kMaxBridgedDevices, indexesCount)) {
+		/* Migrate all devices */
+		for (size_t i = 0; i < indexesCount; i++) {
+			if (!versionPresent) {
+				if (!MigrateDataOldScheme(indexes[i])) {
+					return false;
+				}
+			} else if (version == 1) {
+				if (!MigrateDataVersion1(indexes[i])) {
+					return false;
+				}
+			}
+		}
+	}
+
+	/* Store current version */
+	version = kCurrentVersion;
+	const PSErrorCode status = Nrf::GetPersistentStorage().NonSecureStore(&mVersion, &version, sizeof(version));
+
+	return status == PSErrorCode::Success;
+}
+
 bool BridgeStorageManager::StoreBridgedDevicesCount(uint8_t count)
 {
 	return Nrf::GetPersistentStorage().NonSecureStore(&mBridgedDevicesCount, &count, sizeof(count));

samples/matter/common/src/bridge/bridge_storage_manager.h

@@ -55,6 +55,7 @@ class BridgeStorageManager {
 	};
 
 	using BridgedDevice = BridgedDeviceV2;
+	static constexpr uint8_t kCurrentVersion = 2;
 
 	static constexpr auto kMaxIndexLength = 3;
 
@@ -163,17 +164,38 @@ class BridgeStorageManager {
 	/**
 	 * @brief Provides backward compatibility between non-compatible data scheme versions.
 	 *
-	 * It checks the used data scheme version based on version key value.
-	 * If the version key is present it means that the new keys structure is used (only version
-	 * equal to 1 is for now valid and means post nRF Connect SDK 2.6.0).
-	 * Otherwise, the deprecated structure is used, so the migration has to be done. In such a case, method loads
-	 * the data using key names from an old scheme, removes the old data and stores again using the new key names.
+	 * It checks the used data scheme version based on version key value. If the version key is not present (it
+	 * means that the old scheme is used - pre nRF Connect SDK 2.7.0) or if the version is different than
+	 * kCurrentVersion, the migration has to be done.
 	 *
 	 * @return true if migration was successful
 	 * @return false an error occurred
 	 */
 	bool MigrateData();
 
+	/**
+	 * @brief Migrate bridged device data at given index.
+	 *
+	 * It migrates bridge device structure from pre nRF Connect SDK 2.7.0 scheme to current one. Method loads the
+	 * data using key names from an old scheme, removes the old data and stores again using the new key names.
+	 *
+	 * @param bridgedDeviceIndex index describing specific bridged device to be removed
+	 * @return true if migration was successful
+	 * @return false an error occurred
+	 */
+	bool MigrateDataOldScheme(uint8_t bridgedDeviceIndex);
+
+	/**
+	 * @brief Migrate bridged device data at given index.
+	 *
+	 * It migrates bridge device structure from version 1 to current one.
+	 *
+	 * @param bridgedDeviceIndex index describing specific bridged device to be removed
+	 * @return true if migration was successful
+	 * @return false an error occurred
+	 */
+	bool MigrateDataVersion1(uint8_t bridgedDeviceIndex);
+
 	/* The below methods are deprecated and used only for the migration purposes between the older scheme versions.
 	 */