use stream to batch create users

Author: dabblingwithcode

docs/model_relations/school_data_hub_server.svg

@@ -0,0 +1,93 @@
+/* AUTOMATICALLY GENERATED CODE DO NOT MODIFY */
+/*   To generate run: "serverpod generate"    */
+
+// ignore_for_file: implementation_imports
+// ignore_for_file: library_private_types_in_public_api
+// ignore_for_file: non_constant_identifier_names
+// ignore_for_file: public_member_api_docs
+// ignore_for_file: type_literal_in_constant_pattern
+// ignore_for_file: use_super_parameters
+
+// ignore_for_file: no_leading_underscores_for_library_prefixes
+import 'package:serverpod_client/serverpod_client.dart' as _i1;
+import '../../../_features/admin/models/created_user_credential.dart' as _i2;
+import '../../../_features/admin/models/batch_create_user_error.dart' as _i3;
+
+abstract class BatchCreateUserEvent implements _i1.SerializableModel {
+  BatchCreateUserEvent._({
+    this.credential,
+    this.error,
+  });
+
+  factory BatchCreateUserEvent({
+    _i2.CreatedUserCredential? credential,
+    _i3.BatchCreateUserError? error,
+  }) = _BatchCreateUserEventImpl;
+
+  factory BatchCreateUserEvent.fromJson(
+      Map<String, dynamic> jsonSerialization) {
+    return BatchCreateUserEvent(
+      credential: jsonSerialization['credential'] == null
+          ? null
+          : _i2.CreatedUserCredential.fromJson(
+              (jsonSerialization['credential'] as Map<String, dynamic>)),
+      error: jsonSerialization['error'] == null
+          ? null
+          : _i3.BatchCreateUserError.fromJson(
+              (jsonSerialization['error'] as Map<String, dynamic>)),
+    );
+  }
+
+  _i2.CreatedUserCredential? credential;
+
+  _i3.BatchCreateUserError? error;
+
+  /// Returns a shallow copy of this [BatchCreateUserEvent]
+  /// with some or all fields replaced by the given arguments.
+  @_i1.useResult
+  BatchCreateUserEvent copyWith({
+    _i2.CreatedUserCredential? credential,
+    _i3.BatchCreateUserError? error,
+  });
+  @override
+  Map<String, dynamic> toJson() {
+    return {
+      if (credential != null) 'credential': credential?.toJson(),
+      if (error != null) 'error': error?.toJson(),
+    };
+  }
+
+  @override
+  String toString() {
+    return _i1.SerializationManager.encode(this);
+  }
+}
+
+class _Undefined {}
+
+class _BatchCreateUserEventImpl extends BatchCreateUserEvent {
+  _BatchCreateUserEventImpl({
+    _i2.CreatedUserCredential? credential,
+    _i3.BatchCreateUserError? error,
+  }) : super._(
+          credential: credential,
+          error: error,
+        );
+
+  /// Returns a shallow copy of this [BatchCreateUserEvent]
+  /// with some or all fields replaced by the given arguments.
+  @_i1.useResult
+  @override
+  BatchCreateUserEvent copyWith({
+    Object? credential = _Undefined,
+    Object? error = _Undefined,
+  }) {
+    return BatchCreateUserEvent(
+      credential: credential is _i2.CreatedUserCredential?
+          ? credential
+          : this.credential?.copyWith(),
+      error:
+          error is _i3.BatchCreateUserError? ? error : this.error?.copyWith(),
+    );
+  }
+}

school_data_hub_client/lib/src/protocol/_features/admin/models/batch_create_user_event.dart

@@ -39,7 +39,18 @@ class SessionLogCard extends StatelessWidget {
       Clipboard.setData(
         ClipboardData(
           text:
-              '${info.sessionLogEntry.endpoint}/n${info.sessionLogEntry.error}',
+              '''
+Error: ${info.sessionLogEntry.error}
+Endpoint: ${info.sessionLogEntry.endpoint}
+Method: ${info.sessionLogEntry.method}
+Num Queries: ${info.sessionLogEntry.numQueries}
+Duration: ${info.sessionLogEntry.duration} ms
+Time: ${info.sessionLogEntry.time}
+Authenticated User ID: ${info.sessionLogEntry.authenticatedUserId}
+Is Open: ${info.sessionLogEntry.isOpen}
+Stack Trace:
+${info.sessionLogEntry.stackTrace ?? 'none set'}
+              ''',
         ),
       );
       ScaffoldMessenger.of(context).showSnackBar(

school_data_hub_client/lib/src/protocol/client.dart

@@ -150,4 +150,11 @@ class UserApiService {
       errorMessage: 'Benutzer-Stapelimport',
     );
   }
+
+  /// Streams batch create results one-by-one (avoids HTTP timeout). No wrapper so caller can listen and handle errors.
+  Stream<BatchCreateUserEvent> batchCreateUsersStream(
+    List<CreateUserRequest> requests,
+  ) {
+    return _client.adminUser.batchCreateUsersStream(requests);
+  }
 }

school_data_hub_client/lib/src/protocol/protocol.dart

@@ -242,12 +242,11 @@ class UserManager {
     );
   }
 
-  /// Batch-creates users from import rows. Passwords are generated on the client;
-  /// server validates and skips duplicate userName/email. Refreshes user list at the end.
-  Future<BatchCreateResult> batchCreateUsersFromImportRows(
+  /// Builds [CreateUserRequest] list from import rows (shared by batch and stream).
+  List<CreateUserRequest> buildCreateUserRequestsFromImportRows(
     List<StaffImportRow> rows, {
     String Function(StaffImportRow)? generatePassword,
-  }) async {
+  }) {
     final gen = generatePassword ?? (_) => generateRandomStaffPassword();
     final requests = <CreateUserRequest>[];
     for (final row in rows) {
@@ -273,6 +272,32 @@ class UserManager {
         ),
       );
     }
+    return requests;
+  }
+
+  /// Streams batch create results one-by-one (avoids HTTP timeout). Caller listens and accumulates.
+  Stream<BatchCreateUserEvent> batchCreateUsersStreamFromImportRows(
+    List<StaffImportRow> rows, {
+    String Function(StaffImportRow)? generatePassword,
+  }) {
+    final requests = buildCreateUserRequestsFromImportRows(
+      rows,
+      generatePassword: generatePassword,
+    );
+    return _apiService.batchCreateUsersStream(requests);
+  }
+
+  /// Batch-creates users from import rows. Passwords are generated on the client;
+  /// server validates and skips duplicate userName/email. Refreshes user list at the end.
+  /// Prefer [batchCreateUsersStreamFromImportRows] for large batches to avoid timeout.
+  Future<BatchCreateResult> batchCreateUsersFromImportRows(
+    List<StaffImportRow> rows, {
+    String Function(StaffImportRow)? generatePassword,
+  }) async {
+    final requests = buildCreateUserRequestsFromImportRows(
+      rows,
+      generatePassword: generatePassword,
+    );
     final response = await _apiService.batchCreateUsers(requests);
     if (response == null) {
       throw Exception('Benutzer-Stapelimport fehlgeschlagen.');

school_data_hub_flutter/assets/school_data_hub_server.svg

@@ -1,3 +1,4 @@
+import 'dart:async';
 import 'dart:typed_data';
 
 import 'package:flutter/material.dart';
@@ -7,8 +8,10 @@ import 'package:printing/printing.dart';
 import 'package:school_data_hub_flutter/app_utils/pdf_viewer_page.dart';
 import 'package:school_data_hub_flutter/common/theme/app_colors.dart';
 import 'package:school_data_hub_flutter/common/theme/styles.dart';
+import 'package:school_data_hub_flutter/common/widgets/bottom_nav_bar/generic_bottom_nav_bar.dart';
 import 'package:school_data_hub_flutter/common/widgets/generic_components/generic_app_bar.dart';
 import 'package:school_data_hub_flutter/features/user/data/staff_excel_import_parser.dart';
+import 'package:school_data_hub_client/school_data_hub_client.dart';
 import 'package:school_data_hub_flutter/features/user/domain/batch_create_result.dart';
 import 'package:school_data_hub_flutter/features/user/domain/user_manager.dart';
 import 'package:school_data_hub_flutter/features/user/presentation/batch_import_users/staff_credentials_pdf_service.dart';
@@ -24,6 +27,15 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
   StaffImportParseResult? _parseResult;
   BatchCreateResult? _batchResult;
   bool _isCreating = false;
+  int _progressCreated = 0;
+  int _progressErrors = 0;
+  StreamSubscription<BatchCreateUserEvent>? _streamSubscription;
+
+  @override
+  void dispose() {
+    _streamSubscription?.cancel();
+    super.dispose();
+  }
 
   Future<void> _pickFile() async {
     final result = await StaffExcelImportParser.pickAndParse();
@@ -38,16 +50,63 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
   Future<void> _createUsers() async {
     final rows = _parseResult?.rows ?? [];
     if (rows.isEmpty) return;
-    setState(() => _isCreating = true);
+    setState(() {
+      _isCreating = true;
+      _batchResult = null;
+      _progressCreated = 0;
+      _progressErrors = 0;
+    });
+    final userManager = di<UserManager>();
+    final credentials = <StaffCredentialEntry>[];
+    final errors = <BatchCreateError>[];
+
     try {
-      final userManager = di<UserManager>();
-      final result = await userManager.batchCreateUsersFromImportRows(rows);
-      if (mounted) {
-        setState(() {
-          _batchResult = result;
-          _isCreating = false;
-        });
-      }
+      final stream = userManager.batchCreateUsersStreamFromImportRows(rows);
+      _streamSubscription = stream.listen(
+        (event) {
+          if (!mounted) return;
+          if (event.credential != null) {
+            final c = event.credential!;
+            credentials.add(StaffCredentialEntry(
+              userName: c.userName,
+              fullName: c.fullName,
+              email: c.email,
+              password: c.password,
+            ));
+            setState(() => _progressCreated = credentials.length);
+          } else if (event.error != null) {
+            final e = event.error!;
+            errors.add(BatchCreateError(
+              rowIndex: e.rowIndex,
+              userNameOrKurzel: e.userNameOrKurzel,
+              message: e.message,
+            ));
+            setState(() => _progressErrors = errors.length);
+          }
+        },
+        onError: (Object e) {
+          if (mounted) {
+            setState(() => _isCreating = false);
+            ScaffoldMessenger.of(context).showSnackBar(
+              SnackBar(content: Text('Fehler: $e')),
+            );
+          }
+        },
+        onDone: () async {
+          if (!mounted) return;
+          await userManager.fetchUsersCommand.runAsync();
+          setState(() {
+            _batchResult = BatchCreateResult(
+              credentials: credentials,
+              errors: errors,
+            );
+            _isCreating = false;
+            _progressCreated = 0;
+            _progressErrors = 0;
+          });
+        },
+        cancelOnError: false,
+      );
     } catch (e) {
       if (mounted) {
         setState(() => _isCreating = false);
@@ -61,7 +120,9 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
   Future<void> _printCredentials() async {
     final credentials = _batchResult?.credentials ?? [];
     if (credentials.isEmpty) return;
-    final bytes = await StaffCredentialsPdfService.generatePdfBytes(credentials);
+    final bytes = await StaffCredentialsPdfService.generatePdfBytes(
+      credentials,
+    );
     if (bytes.isEmpty || !mounted) return;
     await Printing.layoutPdf(
       onLayout: (_) async => Uint8List.fromList(bytes),
@@ -75,9 +136,7 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
     final file = await StaffCredentialsPdfService.generatePdfFile(credentials);
     if (file == null || !mounted) return;
     await Navigator.of(context).push<void>(
-      MaterialPageRoute(
-        builder: (context) => PdfViewerPage(pdfFile: file),
-      ),
+      MaterialPageRoute(builder: (context) => PdfViewerPage(pdfFile: file)),
     );
   }
 
@@ -98,10 +157,7 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
               crossAxisAlignment: CrossAxisAlignment.stretch,
               children: [
                 // Step 1: Pick file
-                const Text(
-                  '1. Datei auswählen',
-                  style: AppStyles.subtitle,
-                ),
+                const Text('1. Datei auswählen', style: AppStyles.subtitle),
                 const Gap(8),
                 ElevatedButton.icon(
                   style: AppStyles.actionButtonStyle,
@@ -119,7 +175,12 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
                         child: Column(
                           crossAxisAlignment: CrossAxisAlignment.start,
                           children: _parseResult!.errors
-                              .map((e) => Text(e, style: const TextStyle(fontSize: 12)))
+                              .map(
+                                (e) => Text(
+                                  e,
+                                  style: const TextStyle(fontSize: 12),
+                                ),
+                              )
                               .toList(),
                         ),
                       ),
@@ -135,7 +196,9 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
                       scrollDirection: Axis.horizontal,
                       child: SingleChildScrollView(
                         child: DataTable(
-                          headingRowColor: WidgetStateProperty.all(Colors.grey.shade300),
+                          headingRowColor: WidgetStateProperty.all(
+                            Colors.grey.shade300,
+                          ),
                           columns: const [
                             DataColumn(label: Text('Vorname')),
                             DataColumn(label: Text('Nachname')),
@@ -165,7 +228,10 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
                     ),
                     const Gap(16),
                     // Step 2: Create users
-                    const Text('2. Benutzer anlegen', style: AppStyles.subtitle),
+                    const Text(
+                      '2. Benutzer anlegen',
+                      style: AppStyles.subtitle,
+                    ),
                     const Gap(8),
                     ElevatedButton.icon(
                       style: AppStyles.actionButtonStyle,
@@ -177,7 +243,11 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
                               child: CircularProgressIndicator(strokeWidth: 2),
                             )
                           : const Icon(Icons.person_add),
-                      label: Text(_isCreating ? 'Wird erstellt…' : 'Benutzer anlegen'),
+                      label: Text(
+                        _isCreating
+                            ? 'Wird erstellt… ($_progressCreated / ${_parseResult!.rows.length}, $_progressErrors Fehler)'
+                            : 'Benutzer anlegen',
+                      ),
                     ),
                   ],
                 ],
@@ -196,14 +266,20 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
                         padding: const EdgeInsets.only(bottom: 4),
                         child: Text(
                           'Zeile ${e.rowIndex} (${e.userNameOrKurzel}): ${e.message}',
-                          style: TextStyle(fontSize: 12, color: Colors.red.shade800),
+                          style: TextStyle(
+                            fontSize: 12,
+                            color: Colors.red.shade800,
+                          ),
                         ),
                       ),
                     ),
                   ],
                   if (_batchResult!.credentials.isNotEmpty) ...[
                     const Gap(16),
-                    const Text('3. Zugangsdaten drucken', style: AppStyles.subtitle),
+                    const Text(
+                      '3. Zugangsdaten drucken',
+                      style: AppStyles.subtitle,
+                    ),
                     const Gap(8),
                     Row(
                       children: [
@@ -228,6 +304,7 @@ class _BatchImportUsersPageState extends State<BatchImportUsersPage> {
           ),
         ),
       ),
+      bottomNavigationBar: const GenericBottomNavBar(),
     );
   }
 }