fix: remove pricing policy id from update farm (#502)

Author: DylanVerstraete

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

@@ -0,0 +1,88 @@
+use super::Config;
+use super::*;
+use frame_support::{traits::Get, weights::Weight};
+use log::{debug, info};
+
+#[cfg(feature = "try-runtime")]
+use frame_support::traits::OnRuntimeUpgradeHelpersExt;
+#[cfg(feature = "try-runtime")]
+use sp_runtime::SaturatedConversion;
+
+pub mod v10 {
+    use super::*;
+    use crate::Config;
+
+    use frame_support::{pallet_prelude::Weight, traits::OnRuntimeUpgrade};
+    use sp_std::marker::PhantomData;
+    pub struct FixFarmingPolicy<T: Config>(PhantomData<T>);
+
+    impl<T: Config> OnRuntimeUpgrade for FixFarmingPolicy<T> {
+        #[cfg(feature = "try-runtime")]
+        fn pre_upgrade() -> Result<(), &'static str> {
+            assert!(PalletVersion::<T>::get() <= types::StorageVersion::V10Struct);
+
+            // Store number of farms in temp storage
+            let farms_count: u64 = Farms::<T>::iter_keys().count().saturated_into();
+            Self::set_temp_storage(farms_count, "pre_farms_count");
+            log::info!(
+                "🔎 FixFarmingPolicy pre migration: Number of existing farms {:?}",
+                farms_count
+            );
+
+            info!("👥  TFGrid pallet to V11 passes PRE migrate checks ✅",);
+            Ok(())
+        }
+
+        fn on_runtime_upgrade() -> Weight {
+            if PalletVersion::<T>::get() == types::StorageVersion::V10Struct {
+                fix_farming_policy_migration_::<T>()
+            } else {
+                info!(" >>> Unused migration");
+                return 0;
+            }
+        }
+
+        #[cfg(feature = "try-runtime")]
+        fn post_upgrade() -> Result<(), &'static str> {
+            assert!(PalletVersion::<T>::get() >= types::StorageVersion::V11Struct);
+
+            // Check number of farms against pre-check result
+            let pre_farms_count = Self::get_temp_storage("pre_farms_count").unwrap_or(0u64);
+            assert_eq!(
+                Farms::<T>::iter().count().saturated_into::<u64>(),
+                pre_farms_count,
+                "Number of farms migrated does not match"
+            );
+
+            info!(
+                "👥  TFGrid pallet migration to {:?} passes POST migrate checks ✅",
+                Pallet::<T>::pallet_version()
+            );
+
+            Ok(())
+        }
+    }
+}
+
+pub fn fix_farming_policy_migration_<T: Config>() -> frame_support::weights::Weight {
+    info!(" >>> Migrating farm storage...");
+
+    let mut read_writes = 0;
+
+    Farms::<T>::translate::<super::FarmInfoOf<T>, _>(|k, f| {
+        let mut new_farm = f;
+
+        new_farm.pricing_policy_id = 1;
+        debug!("migrated farm: {:?}", k);
+
+        read_writes += 1;
+        Some(new_farm)
+    });
+
+    // Update pallet storage version
+    PalletVersion::<T>::set(types::StorageVersion::V11Struct);
+    info!(" <<< Storage version upgraded");
+
+    // Return the weight consumed by the migration.
+    T::DbWeight::get().reads_writes(read_writes as Weight, read_writes as Weight)
+}

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

@@ -32,6 +32,7 @@ pub mod weights;
 pub mod types;
 
 pub mod farm;
+pub mod farm_migration;
 pub mod interface;
 pub mod nodes_migration;
 pub mod pub_config;
@@ -766,7 +767,6 @@ pub mod pallet {
             origin: OriginFor<T>,
             id: u32,
             name: FarmNameInput<T>,
-            pricing_policy_id: u32,
         ) -> DispatchResultWithPostInfo {
             let address = ensure_signed(origin)?;
 
@@ -795,7 +795,6 @@ pub mod pallet {
             FarmIdByName::<T>::remove(name.clone());
 
             stored_farm.name = new_farm_name;
-            stored_farm.pricing_policy_id = pricing_policy_id;
 
             Farms::<T>::insert(id, &stored_farm);
             FarmIdByName::<T>::insert(name, stored_farm.id);

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

@@ -1,10 +1,15 @@
 use super::Config;
 use super::*;
 use frame_support::{traits::Get, weights::Weight};
-use log::info;
+use log::{debug, info};
 use sp_std::collections::btree_map::BTreeMap;
 
-pub mod v9patch {
+#[cfg(feature = "try-runtime")]
+use frame_support::traits::OnRuntimeUpgradeHelpersExt;
+#[cfg(feature = "try-runtime")]
+use sp_runtime::SaturatedConversion;
+
+pub mod v9 {
     use super::*;
     use crate::Config;
 
@@ -17,6 +22,14 @@ pub mod v9patch {
         fn pre_upgrade() -> Result<(), &'static str> {
             assert!(PalletVersion::<T>::get() == types::StorageVersion::V9Struct);
 
+            // Store number of nodes in temp storage
+            let nodes_count: u64 = Nodes::<T>::iter_keys().count().saturated_into();
+            Self::set_temp_storage(nodes_count, "pre_nodes_count");
+            log::info!(
+                "🔎 FixFarmingPolicy pre migration: Number of existing nodes {:?}",
+                nodes_count
+            );
+
             info!("👥  TFGrid pallet to V10 passes PRE migrate checks ✅",);
             Ok(())
         }
@@ -32,7 +45,15 @@ pub mod v9patch {
 
         #[cfg(feature = "try-runtime")]
         fn post_upgrade() -> Result<(), &'static str> {
-            assert!(PalletVersion::<T>::get() == types::StorageVersion::V10Struct);
+            assert!(PalletVersion::<T>::get() >= types::StorageVersion::V10Struct);
+
+            // Check number of nodes against pre-check result
+            let pre_nodes_count = Self::get_temp_storage("pre_nodes_count").unwrap_or(0u64);
+            assert_eq!(
+                Nodes::<T>::iter().count().saturated_into::<u64>(),
+                pre_nodes_count,
+                "Number of nodes migrated does not match"
+            );
 
             info!(
                 "👥  TFGrid pallet migration to {:?} passes POST migrate checks ✅",
@@ -64,7 +85,7 @@ pub fn add_farm_nodes_index<T: Config>() -> frame_support::weights::Weight {
     }
 
     for (farm_id, nodes) in farms_with_nodes.iter() {
-        info!(
+        debug!(
             "inserting nodes: {:?} with farm id: {:?}",
             nodes.clone(),
             farm_id

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

@@ -351,7 +351,6 @@ fn test_update_farm_name_works() {
             Origin::signed(bob()),
             2,
             farm_name.0.clone(),
-            1
         ));
     });
 }
@@ -379,7 +378,7 @@ fn test_update_farm_existing_name_fails() {
 
         let farm_name = get_farm_name(b"alice_farm");
         assert_noop!(
-            TfgridModule::update_farm(Origin::signed(bob()), 2, farm_name.0.clone(), 1),
+            TfgridModule::update_farm(Origin::signed(bob()), 2, farm_name.0.clone()),
             Error::<TestRuntime>::InvalidFarmName
         );
     });

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

@@ -5,7 +5,7 @@ use sp_std::vec::Vec;
 use tfchain_support::types::{FarmCertification, NodeCertification};
 
 /// Utility type for managing upgrades/migrations.
-#[derive(Encode, Decode, Clone, Debug, PartialEq, TypeInfo)]
+#[derive(Encode, Decode, Clone, Debug, PartialEq, PartialOrd, TypeInfo)]
 pub enum StorageVersion {
     V1Struct,
     V2Struct,
@@ -17,11 +17,12 @@ pub enum StorageVersion {
     V8Struct,
     V9Struct,
     V10Struct,
+    V11Struct,
 }
 
 impl Default for StorageVersion {
     fn default() -> StorageVersion {
-        StorageVersion::V9Struct
+        StorageVersion::V11Struct
     }
 }
 

substrate-node/runtime/src/lib.rs

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