feat(auth2): Add hook for when user is migrated in serverpod_auth_migration (serverpod#3728)

Author: tp

modules/new_serverpod_auth/serverpod_auth_migration/serverpod_auth_migration_server/lib/serverpod_auth_migration_server.dart

@@ -1,4 +1,4 @@
+export 'src/business/auth_migration_config.dart';
 export 'src/business/auth_migration_email.dart';
-export 'src/business/auth_migration_email_config.dart';
 export 'src/generated/endpoints.dart';
 export 'src/generated/protocol.dart';

modules/new_serverpod_auth/serverpod_auth_migration/serverpod_auth_migration_server/lib/src/business/auth_migration_config.dart

@@ -0,0 +1,35 @@
+import 'package:serverpod/serverpod.dart';
+
+/// Configuration options for the account migration.
+class AuthMigrationConfig {
+  /// Whether to import the `serverpod_auth` `UserInfo` into a
+  /// `serverpod_auth_profile` `UserProfile`.
+  ///
+  /// Defaults to `true`.
+  final bool importProfile;
+
+  /// Callback to be invoked if a user has been migrated.
+  ///
+  /// If one does any further migratations for this user in the database, one
+  /// should ensure to use the passed `transaction`, such that a failure rolls
+  /// back the entire, partial write.
+  final UserMigrationHook? userMigrationHook;
+
+  /// Create a new email account migration configuration.
+  AuthMigrationConfig({
+    this.importProfile = true,
+    this.userMigrationHook,
+  });
+}
+
+/// Callback to be invoked when a `serverpod_auth` `UserInfo` has been migrated
+/// to a `serverpod_auth_user` `AuthUser`.
+///
+/// This is called only once, even if multiple authentications are migrated for
+/// the user successively.
+typedef UserMigrationHook = Future<void> Function(
+  Session session, {
+  required int oldUserId,
+  required UuidValue newAuthUserId,
+  Transaction? transaction,
+});

modules/new_serverpod_auth/serverpod_auth_migration/serverpod_auth_migration_server/lib/src/business/auth_migration_email.dart

@@ -13,7 +13,7 @@ import 'package:serverpod_auth_user_server/serverpod_auth_user_server.dart'
 /// `serverpod_auth_email_account`.
 abstract final class AuthMigrationEmail {
   /// The current configuration for the email authentication migration.
-  static AuthMigrationEmailConfig config = AuthMigrationEmailConfig();
+  static AuthMigrationConfig config = AuthMigrationConfig();
 
   /// Attempts to migrate the user and their email authentication to the new
   /// auth module.
@@ -92,7 +92,7 @@ abstract final class AuthMigrationEmail {
       session.db,
       transaction,
       (final transaction) async {
-        final migratedUser = await _migrateUserIfNeeded(
+        final (migratedUser, didCreate) = await _migrateUserIfNeeded(
           session,
           userInfo,
           transaction: transaction,
@@ -105,6 +105,15 @@ abstract final class AuthMigrationEmail {
           password: password,
           transaction: transaction,
         );
+
+        if (didCreate) {
+          await config.userMigrationHook?.call(
+            session,
+            oldUserId: migratedUser.oldUserId,
+            newAuthUserId: migratedUser.newAuthUserId,
+            transaction: transaction,
+          );
+        }
       },
     );
   }
@@ -160,7 +169,7 @@ abstract final class AuthMigrationEmail {
       session.db,
       transaction,
       (final transaction) async {
-        final migratedUser = await _migrateUserIfNeeded(
+        final (migratedUser, didCreate) = await _migrateUserIfNeeded(
           session,
           userInfo,
           transaction: transaction,
@@ -173,11 +182,21 @@ abstract final class AuthMigrationEmail {
           password: null,
           transaction: transaction,
         );
+
+        if (didCreate) {
+          await config.userMigrationHook?.call(
+            session,
+            oldUserId: migratedUser.oldUserId,
+            newAuthUserId: migratedUser.newAuthUserId,
+            transaction: transaction,
+          );
+        }
       },
     );
   }
 
-  static Future<MigratedUser> _migrateUserIfNeeded(
+  static Future<(MigratedUser migratedUser, bool didCreate)>
+      _migrateUserIfNeeded(
     final Session session,
     final legacy_auth.UserInfo userInfo, {
     required final Transaction transaction,
@@ -189,7 +208,7 @@ abstract final class AuthMigrationEmail {
     );
 
     if (migratedUser != null) {
-      return migratedUser;
+      return (migratedUser, false);
     }
 
     final authUser = await new_auth_user.AuthUsers.create(
@@ -208,10 +227,13 @@ abstract final class AuthMigrationEmail {
       );
     }
 
-    return MigratedUser.db.insertRow(
-      session,
-      MigratedUser(oldUserId: userInfo.id!, newAuthUserId: authUser.id),
-      transaction: transaction,
+    return (
+      await MigratedUser.db.insertRow(
+        session,
+        MigratedUser(oldUserId: userInfo.id!, newAuthUserId: authUser.id),
+        transaction: transaction,
+      ),
+      true,
     );
   }