Wyatt-FOSS/wyatt-packages
6
2
Fork 0
Code Issues 20 Pull Requests 4 Actions Packages Projects Releases Activity

feat(crud): add streaming usecase (closes #180)
continuous-integration/drone/pr Build is failing
Details

Browse Source
This commit is contained in:
hugo
2023-11-14 14:04:57 +01:00
parent ff0f76d910
commit 3a7b7dfd1d
11 changed files with 349 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/wyatt_crud_bloc/lib/src/data/data_sources/crud_data_source_in_memory_impl.dart
+4 -3
View File
@@ -16,6 +16,7 @@
import 'dart:async';
import 'package:rxdart/subjects.dart';
import 'package:wyatt_crud_bloc/src/core/enums/operation_type.dart';
import 'package:wyatt_crud_bloc/src/core/enums/where_query_type.dart';
import 'package:wyatt_crud_bloc/src/data/data_sources/crud_data_source.dart';
@@ -58,8 +59,8 @@ class CrudDataSourceInMemoryImpl extends CrudDataSource {
}) : _data = data ?? {};
final Map<String, Map<String, dynamic>> _data;
final StreamController<List<Map<String, dynamic>?>> _streamData =
StreamController();
final BehaviorSubject<List<Map<String, dynamic>?>> _streamData =
BehaviorSubject<List<Map<String, dynamic>?>>.seeded([]);
@override
Future<void> create(Map<String, dynamic> object, {String? id}) async {
@@ -142,7 +143,7 @@ class CrudDataSourceInMemoryImpl extends CrudDataSource {
}
return res;
}).asBroadcastStream();
});
@override
Future<void> update(
packages/wyatt_crud_bloc/lib/src/domain/usecases/stream.dart → packages/wyatt_crud_bloc/lib/src/domain/usecases/streaming.dart
+4 -4
View File
@@ -20,14 +20,14 @@ import 'package:wyatt_crud_bloc/src/domain/repositories/crud_repository.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/usecases.dart';
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
/// {@template stream}
/// {@template streaming}
/// A use case that streams the object models.
/// {@endtemplate}
class Stream<Model>
class Streaming<Model>
extends Usecase<StreamParameters, StreamResult<List<Model?>>>
with ReadOperation<StreamParameters, StreamResult<List<Model?>>> {
/// {@macro stream}
const Stream(this.crudRepository);
/// {@macro streaming}
const Streaming(this.crudRepository);
final CrudRepository<Model> crudRepository;
packages/wyatt_crud_bloc/lib/src/domain/usecases/usecases.dart
+1
View File
@@ -26,6 +26,7 @@ export 'get.dart';
export 'get_all.dart';
export 'params/params.dart';
export 'search.dart';
export 'streaming.dart';
export 'update.dart';
export 'update_all.dart';
packages/wyatt_crud_bloc/lib/src/features/crud/blocs/crud_advanced_cubit.dart
+58
View File
@@ -16,6 +16,7 @@
import 'dart:async';
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_crud_bloc/src/core/enums/where_query_type.dart';
import 'package:wyatt_crud_bloc/src/core/model_identifier.dart';
import 'package:wyatt_crud_bloc/src/domain/entities/query.dart';
@@ -24,11 +25,14 @@ import 'package:wyatt_crud_bloc/src/domain/usecases/delete.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/delete_all.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/get.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/get_all.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/params/stream_parameters.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/params/update_parameters.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/search.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/streaming.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/update.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/update_all.dart';
import 'package:wyatt_crud_bloc/src/features/crud/blocs/crud_base_cubit/crud_base_cubit.dart';
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
/// {@template crud_cubit_advanced}
/// Cubit that handles CRUD operations with more granularity.
@@ -43,6 +47,7 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
GetAll<Model>? get crudGetAll;
Get<Model>? get crudGet;
Search<Model>? get crudSearch;
Streaming<Model>? get crudStreaming;
UpdateAll<Model>? get crudUpdateAll;
Update<Model>? get crudUpdate;
@@ -50,6 +55,8 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
/// Used to identify a model.
ModelIdentifier<Model> get modelIdentifier;
StreamSubscription<Result<List<Model?>, AppException>>? _streamSubscription;
FutureOr<void> create(Model model) async {
final crud = crudCreate;
if (crud == null) {
@@ -59,6 +66,10 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudCreating());
final result = await crud.call(model);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
result.fold(
(_) {
@@ -97,6 +108,10 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudDeleting());
final result = await crud.call(id);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
result.fold(
(_) {
@@ -139,6 +154,10 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudDeleting());
final result = await crud.call(null);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
result.fold(
(_) {
@@ -202,6 +221,31 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
);
}
FutureOr<void> streaming({
String? id,
List<Query>? conditions,
}) async {
final crud = crudStreaming;
if (crud == null) {
return;
}
final result = await crud.call(
StreamParameters(
id: id,
conditions: conditions,
),
);
_streamSubscription = result.ok?.listen((event) {
emit(
event.fold(
CrudListLoaded<Model?>.new,
(error) => CrudError(error.toString()),
),
);
});
}
FutureOr<void> update(UpdateParameters<Model> param) async {
final crud = crudUpdate;
if (crud == null) {
@@ -211,6 +255,10 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudUpdating());
final result = await crud.call(param);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
await result.foldAsync(
(_) async {
@@ -284,6 +332,10 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudUpdating());
final result = await crud.call(param);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
await result.foldAsync(
(_) async {
@@ -334,4 +386,10 @@ abstract class CrudAdvancedCubit<Model> extends CrudBaseCubit {
),
);
}
@override
Future<void> close() async {
await _streamSubscription?.cancel();
return super.close();
}
}
packages/wyatt_crud_bloc/lib/src/features/crud/blocs/crud_cubit.dart
+67 -3
View File
@@ -16,6 +16,7 @@
import 'dart:async';
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_crud_bloc/src/core/enums/where_query_type.dart';
import 'package:wyatt_crud_bloc/src/core/mixins/operation.dart';
import 'package:wyatt_crud_bloc/src/core/model_identifier.dart';
@@ -25,11 +26,14 @@ import 'package:wyatt_crud_bloc/src/domain/usecases/delete.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/delete_all.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/get.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/get_all.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/params/stream_parameters.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/params/update_parameters.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/search.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/streaming.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/update.dart';
import 'package:wyatt_crud_bloc/src/domain/usecases/update_all.dart';
import 'package:wyatt_crud_bloc/src/features/crud/blocs/crud_base_cubit/crud_base_cubit.dart';
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
typedef DefaultCreate<Model> = CreateOperation<Model, void>;
typedef DefaultRead = ReadOperation<dynamic, dynamic>;
@@ -63,6 +67,8 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
/// Used to identify a model.
ModelIdentifier<Model> get modelIdentifier;
StreamSubscription<Result<List<Model?>, AppException>>? _streamSubscription;
Expected? _checkOperation<Expected>(dynamic operation) {
if (operation == null) {
return null;
@@ -90,9 +96,11 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
conditions != null) {
return _search(conditions);
}
if (_checkOperation<Stream<Model>>(readOperation) != null &&
conditions == null) {
return _getAll();
if (_checkOperation<Streaming<Model>>(readOperation) != null) {
return _streaming(
id: id,
conditions: conditions,
);
}
}
@@ -129,6 +137,11 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudCreating());
final result = await crud.call(model);
final crudStreaming = _checkOperation<Streaming<Model>>(readOperation);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
result.fold(
(_) {
@@ -167,6 +180,11 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudDeleting());
final result = await crud.call(id);
final crudStreaming = _checkOperation<Streaming<Model>>(readOperation);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
result.fold(
(_) {
@@ -209,6 +227,11 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudDeleting());
final result = await crud.call(null);
final crudStreaming = _checkOperation<Streaming<Model>>(readOperation);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
result.fold(
(_) {
@@ -256,6 +279,31 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
);
}
FutureOr<void> _streaming({
String? id,
List<Query>? conditions,
}) async {
final crud = _checkOperation<Streaming<Model>>(readOperation);
if (crud == null) {
return;
}
final result = await crud.call(
StreamParameters(
id: id,
conditions: conditions,
),
);
_streamSubscription = result.ok?.listen((event) {
emit(
event.fold(
CrudListLoaded<Model?>.new,
(error) => CrudError(error.toString()),
),
);
});
}
FutureOr<void> _search(List<Query> conditions) async {
final crud = _checkOperation<Search<Model>>(readOperation);
if (crud == null) {
@@ -281,6 +329,11 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudUpdating());
final result = await crud.call(param);
final crudStreaming = _checkOperation<Streaming<Model>>(readOperation);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
await result.foldAsync(
(_) async {
@@ -360,6 +413,11 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
final stateCopy = state;
emit(const CrudUpdating());
final result = await crud.call(param);
final crudStreaming = _checkOperation<Streaming<Model>>(readOperation);
if (crudStreaming != null && _streamSubscription != null && result.isOk) {
// If streaming is available, we don't need to update stateCopy.
return;
}
emit(
await result.foldAsync(
(_) async {
@@ -410,4 +468,10 @@ abstract class CrudCubit<Model> extends CrudBaseCubit {
),
);
}
@override
Future<void> close() async {
await _streamSubscription?.cancel();
return super.close();
}
}