pallet-uniques: Move migration over to VersionedMigration (#2687)

prdoc/pr_2687.prdoc

@@ -0,0 +1,18 @@
+title: "pallet-uniques: Move migration over to `VersionedMigration`"
+
+doc:
+  - audience: Runtime Dev
+    description: |
+      Moves the migration over to `VersionedMigration`. Thus, if you had
+      used `migrate_to_v1` before in a custom `OnRuntimeUpgrade` implementation
+      you can now directly use the `MigrateV0ToV1`.
+
+migrations:
+  runtime:
+    - reference: MigrateV0ToV1
+      description: |
+        Migrate the pallet storage from `0` to `1` by initializing
+        the `CollectionAccount` storage entry from all collections.
+
+crates:
+  - name: "pallet-uniques"

substrate/frame/uniques/src/migration.rs

@@ -17,38 +17,39 @@
 
 //! Various pieces of common functionality.
 use super::*;
-use frame_support::traits::{Get, GetStorageVersion, PalletInfoAccess, StorageVersion};
+use frame_support::traits::{Get, OnRuntimeUpgrade};
+use sp_std::marker::PhantomData;
 
-/// Migrate the pallet storage to v1.
+mod v1 {
-pub fn migrate_to_v1<T: Config<I>, I: 'static, P: GetStorageVersion + PalletInfoAccess>(
+	use super::*;
-) -> frame_support::weights::Weight {
-	let on_chain_storage_version = <P as GetStorageVersion>::on_chain_storage_version();
-	log::info!(
-		target: LOG_TARGET,
-		"Running migration storage v1 for uniques with storage version {:?}",
-		on_chain_storage_version,
-	);
 
-	if on_chain_storage_version < 1 {
+	/// Actual implementation of the storage migration.
-		let mut count = 0;
+	pub struct MigrateToV1Impl<T, I>(PhantomData<(T, I)>);
-		for (collection, detail) in Collection::<T, I>::iter() {
+
-			CollectionAccount::<T, I>::insert(&detail.owner, &collection, ());
+	impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for MigrateToV1Impl<T, I> {
-			count += 1;
+		fn on_runtime_upgrade() -> frame_support::weights::Weight {
+			let mut count = 0;
+			for (collection, detail) in Collection::<T, I>::iter() {
+				CollectionAccount::<T, I>::insert(&detail.owner, &collection, ());
+				count += 1;
+			}
+
+			log::info!(
+				target: LOG_TARGET,
+				"Storage migration v1 for uniques finished.",
+			);
+
+			// calculate and return migration weights
+			T::DbWeight::get().reads_writes(count as u64 + 1, count as u64 + 1)
 		}
-		StorageVersion::new(1).put::<P>();
-		log::info!(
-			target: LOG_TARGET,
-			"Running migration storage v1 for uniques with storage version {:?} was complete",
-			on_chain_storage_version,
-		);
-		// calculate and return migration weights
-		T::DbWeight::get().reads_writes(count as u64 + 1, count as u64 + 1)
-	} else {
-		log::warn!(
-			target: LOG_TARGET,
-			"Attempted to apply migration to v1 but failed because storage version is {:?}",
-			on_chain_storage_version,
-		);
-		T::DbWeight::get().reads(1)
 	}
 }
+
+/// Migrate the pallet storage from `0` to `1`.
+pub type MigrateV0ToV1<T, I> = frame_support::migrations::VersionedMigration<
+	0,
+	1,
+	v1::MigrateToV1Impl<T, I>,
+	Pallet<T, I>,
+	<T as frame_system::Config>::DbWeight,
+>;