fix: migration for nodes by farm id storage (#483)

Author: DylanVerstraete

substrate-node/pallets/pallet-tfgrid/src/lib.rs

@@ -33,6 +33,7 @@ pub mod types;
 
 pub mod farm;
 pub mod interface;
+pub mod nodes_migration;
 pub mod pub_config;
 pub mod pub_ip;
 pub mod twin;

substrate-node/pallets/pallet-tfgrid/src/nodes_migration.rs

@@ -0,0 +1,82 @@
+use super::Config;
+use super::*;
+use frame_support::{traits::Get, weights::Weight};
+use log::info;
+use sp_std::collections::btree_map::BTreeMap;
+
+pub mod v9patch {
+    use super::*;
+    use crate::Config;
+
+    use frame_support::{pallet_prelude::Weight, traits::OnRuntimeUpgrade};
+    use sp_std::marker::PhantomData;
+    pub struct FixFarmNodeIndexMap<T: Config>(PhantomData<T>);
+
+    impl<T: Config> OnRuntimeUpgrade for FixFarmNodeIndexMap<T> {
+        #[cfg(feature = "try-runtime")]
+        fn pre_upgrade() -> Result<(), &'static str> {
+            assert!(PalletVersion::<T>::get() == types::StorageVersion::V9Struct);
+
+            info!("👥  TFGrid pallet to V10 passes PRE migrate checks ✅",);
+            Ok(())
+        }
+
+        fn on_runtime_upgrade() -> Weight {
+            if PalletVersion::<T>::get() == types::StorageVersion::V9Struct {
+                add_farm_nodes_index::<T>()
+            } else {
+                info!(" >>> Unused migration");
+                return 0;
+            }
+        }
+
+        #[cfg(feature = "try-runtime")]
+        fn post_upgrade() -> Result<(), &'static str> {
+            assert!(PalletVersion::<T>::get() == types::StorageVersion::V10Struct);
+
+            info!(
+                "👥  TFGrid pallet migration to {:?} passes POST migrate checks ✅",
+                Pallet::<T>::pallet_version()
+            );
+
+            Ok(())
+        }
+    }
+}
+
+pub fn add_farm_nodes_index<T: Config>() -> frame_support::weights::Weight {
+    info!(" >>> Migrating nodes storage...");
+
+    NodesByFarmID::<T>::remove_all(None);
+
+    let mut reads = 0;
+    let mut writes = 0;
+
+    let mut farms_with_nodes: BTreeMap<u32, Vec<u32>> = BTreeMap::new();
+    for (_, node) in Nodes::<T>::iter() {
+        // Add index of farm - list (nodes)
+        farms_with_nodes
+            .entry(node.farm_id)
+            .or_insert(vec![])
+            .push(node.id);
+
+        reads += 1;
+    }
+
+    for (farm_id, nodes) in farms_with_nodes.iter() {
+        info!(
+            "inserting nodes: {:?} with farm id: {:?}",
+            nodes.clone(),
+            farm_id
+        );
+        NodesByFarmID::<T>::insert(farm_id, nodes);
+        writes += 1;
+    }
+
+    // Update pallet storage version
+    PalletVersion::<T>::set(types::StorageVersion::V10Struct);
+    info!(" <<< Storage version upgraded");
+
+    // Return the weight consumed by the migration.
+    T::DbWeight::get().reads_writes(reads as Weight, writes as Weight)
+}

substrate-node/pallets/pallet-tfgrid/src/types.rs

@@ -16,11 +16,12 @@ pub enum StorageVersion {
     V7Struct,
     V8Struct,
     V9Struct,
+    V10Struct,
 }
 
 impl Default for StorageVersion {
     fn default() -> StorageVersion {
-        StorageVersion::V5Struct
+        StorageVersion::V9Struct
     }
 }
 

substrate-node/runtime/src/lib.rs

@@ -754,7 +754,7 @@ pub type Executive = frame_executive::Executive<
     frame_system::ChainContext<Runtime>,
     Runtime,
     AllPalletsWithSystem,
-    (),
+    pallet_tfgrid::nodes_migration::v9patch::FixFarmNodeIndexMap<Runtime>,
 >;
 
 impl_runtime_apis! {