mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-25 05:59:55 +00:00
feat: implement comprehensive circular dependency detection system
- Add two-level circular dependency detection (local and global) - Implement CycleDetector for local scope cycle detection - Implement GlobalCycleDetector for cross-scope cycle detection - Add CircularDependencyException with detailed dependency chain info - Integrate cycle detection into Scope class with unique scope IDs - Extend CherryPick helper with cycle detection management API - Add safe scope creation methods with automatic detection - Support both synchronous and asynchronous dependency resolution - Include comprehensive test coverage (72+ tests) - Add bilingual documentation (English and Russian) - Provide usage examples and architectural best practices - Add performance recommendations and debug tools BREAKING CHANGE: Scope constructor now generates unique IDs for global detection fix: remove tmp files update examples update examples
This commit is contained in:
Sergey Penkovsky
227
cherrypick/example/cherrypick_helper_example.dart
Normal file
227
cherrypick/example/cherrypick_helper_example.dart
Normal file
@@ -0,0 +1,227 @@
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
// Пример сервисов для демонстрации
|
||||
class DatabaseService {
|
||||
void connect() => print('🔌 Connecting to database');
|
||||
}
|
||||
|
||||
class ApiService {
|
||||
final DatabaseService database;
|
||||
ApiService(this.database);
|
||||
|
||||
void fetchData() {
|
||||
database.connect();
|
||||
print('📡 Fetching data via API');
|
||||
}
|
||||
}
|
||||
|
||||
class UserService {
|
||||
final ApiService apiService;
|
||||
UserService(this.apiService);
|
||||
|
||||
void getUser(String id) {
|
||||
apiService.fetchData();
|
||||
print('👤 Fetching user: $id');
|
||||
}
|
||||
}
|
||||
|
||||
// Модули для различных feature
|
||||
class DatabaseModule extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<DatabaseService>().singleton().toProvide(() => DatabaseService());
|
||||
}
|
||||
}
|
||||
|
||||
class ApiModule extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<ApiService>().toProvide(() => ApiService(
|
||||
currentScope.resolve<DatabaseService>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
class UserModule extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<UserService>().toProvide(() => UserService(
|
||||
currentScope.resolve<ApiService>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
// Пример циклических зависимостей для демонстрации обнаружения
|
||||
class CircularServiceA {
|
||||
final CircularServiceB serviceB;
|
||||
CircularServiceA(this.serviceB);
|
||||
}
|
||||
|
||||
class CircularServiceB {
|
||||
final CircularServiceA serviceA;
|
||||
CircularServiceB(this.serviceA);
|
||||
}
|
||||
|
||||
class CircularModuleA extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<CircularServiceA>().toProvide(() => CircularServiceA(
|
||||
currentScope.resolve<CircularServiceB>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
class CircularModuleB extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<CircularServiceB>().toProvide(() => CircularServiceB(
|
||||
currentScope.resolve<CircularServiceA>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
void main() {
|
||||
print('=== Improved CherryPick Helper Demonstration ===\n');
|
||||
|
||||
// Example 1: Global enabling of cycle detection
|
||||
print('1. Globally enable cycle detection:');
|
||||
|
||||
CherryPick.enableGlobalCycleDetection();
|
||||
print('✅ Global cycle detection enabled: ${CherryPick.isGlobalCycleDetectionEnabled}');
|
||||
|
||||
// All new scopes will automatically have cycle detection enabled
|
||||
final globalScope = CherryPick.openRootScope();
|
||||
print('✅ Root scope has cycle detection enabled: ${globalScope.isCycleDetectionEnabled}');
|
||||
|
||||
// Install modules without circular dependencies
|
||||
globalScope.installModules([
|
||||
DatabaseModule(),
|
||||
ApiModule(),
|
||||
UserModule(),
|
||||
]);
|
||||
|
||||
final userService = globalScope.resolve<UserService>();
|
||||
userService.getUser('user123');
|
||||
print('');
|
||||
|
||||
// Example 2: Safe scope creation
|
||||
print('2. Creating safe scopes:');
|
||||
|
||||
CherryPick.closeRootScope(); // Закрываем предыдущий скоуп
|
||||
CherryPick.disableGlobalCycleDetection(); // Отключаем глобальную настройку
|
||||
|
||||
// Создаем безопасный скоуп (с автоматически включенным обнаружением)
|
||||
final safeScope = CherryPick.openSafeRootScope();
|
||||
print('✅ Safe scope created with cycle detection: ${safeScope.isCycleDetectionEnabled}');
|
||||
|
||||
safeScope.installModules([
|
||||
DatabaseModule(),
|
||||
ApiModule(),
|
||||
UserModule(),
|
||||
]);
|
||||
|
||||
final safeUserService = safeScope.resolve<UserService>();
|
||||
safeUserService.getUser('safe_user456');
|
||||
print('');
|
||||
|
||||
// Example 3: Detecting cycles
|
||||
print('3. Detecting circular dependencies:');
|
||||
|
||||
final cyclicScope = CherryPick.openSafeRootScope();
|
||||
cyclicScope.installModules([
|
||||
CircularModuleA(),
|
||||
CircularModuleB(),
|
||||
]);
|
||||
|
||||
try {
|
||||
cyclicScope.resolve<CircularServiceA>();
|
||||
print('❌ This should not be executed');
|
||||
} catch (e) {
|
||||
if (e is CircularDependencyException) {
|
||||
print('❌ Circular dependency detected!');
|
||||
print(' Message: ${e.message}');
|
||||
print(' Chain: ${e.dependencyChain.join(' -> ')}');
|
||||
}
|
||||
}
|
||||
print('');
|
||||
|
||||
// Example 4: Managing detection for specific scopes
|
||||
print('4. Managing detection for specific scopes:');
|
||||
|
||||
CherryPick.closeRootScope();
|
||||
|
||||
// Создаем скоуп без обнаружения
|
||||
final specificScope = CherryPick.openRootScope();
|
||||
print(' Detection in root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
|
||||
|
||||
// Включаем обнаружение для конкретного скоупа
|
||||
CherryPick.enableCycleDetectionForScope();
|
||||
print('✅ Detection enabled for root scope: ${CherryPick.isCycleDetectionEnabledForScope()}');
|
||||
|
||||
// Создаем дочерний скоуп
|
||||
final featureScope = CherryPick.openScope(scopeName: 'feature.auth');
|
||||
print(' Detection in feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
|
||||
|
||||
// Включаем обнаружение для дочернего скоупа
|
||||
CherryPick.enableCycleDetectionForScope(scopeName: 'feature.auth');
|
||||
print('✅ Detection enabled for feature.auth scope: ${CherryPick.isCycleDetectionEnabledForScope(scopeName: 'feature.auth')}');
|
||||
print('');
|
||||
|
||||
// Example 5: Creating safe child scopes
|
||||
print('5. Creating safe child scopes:');
|
||||
|
||||
final safeFeatureScope = CherryPick.openSafeScope(scopeName: 'feature.payments');
|
||||
print('✅ Safe feature scope created: ${safeFeatureScope.isCycleDetectionEnabled}');
|
||||
|
||||
// You can create a complex hierarchy of scopes
|
||||
final complexScope = CherryPick.openSafeScope(scopeName: 'app.feature.auth.login');
|
||||
print('✅ Complex scope created: ${complexScope.isCycleDetectionEnabled}');
|
||||
print('');
|
||||
|
||||
// Example 6: Tracking resolution chains
|
||||
print('6. Tracking dependency resolution chains:');
|
||||
|
||||
final trackingScope = CherryPick.openSafeRootScope();
|
||||
trackingScope.installModules([
|
||||
DatabaseModule(),
|
||||
ApiModule(),
|
||||
UserModule(),
|
||||
]);
|
||||
|
||||
print(' Chain before resolve: ${CherryPick.getCurrentResolutionChain()}');
|
||||
|
||||
// The chain is populated during resolution, but cleared after completion
|
||||
final trackedUserService = trackingScope.resolve<UserService>();
|
||||
print(' Chain after resolve: ${CherryPick.getCurrentResolutionChain()}');
|
||||
print('');
|
||||
|
||||
// Example 7: Usage recommendations
|
||||
print('7. Recommended usage:');
|
||||
print('');
|
||||
|
||||
print('🔧 Development mode:');
|
||||
print(' CherryPick.enableGlobalCycleDetection(); // Enable globally');
|
||||
print(' or');
|
||||
print(' final scope = CherryPick.openSafeRootScope(); // Safe scope');
|
||||
print('');
|
||||
|
||||
print('🚀 Production mode:');
|
||||
print(' CherryPick.disableGlobalCycleDetection(); // Disable for performance');
|
||||
print(' final scope = CherryPick.openRootScope(); // Regular scope');
|
||||
print('');
|
||||
|
||||
print('🧪 Testing:');
|
||||
print(' setUp(() => CherryPick.enableGlobalCycleDetection());');
|
||||
print(' tearDown(() => CherryPick.closeRootScope());');
|
||||
print('');
|
||||
|
||||
print('🎯 Feature-specific:');
|
||||
print(' CherryPick.enableCycleDetectionForScope(scopeName: "feature.critical");');
|
||||
print(' // Enable only for critical features');
|
||||
|
||||
// Cleanup
|
||||
CherryPick.closeRootScope();
|
||||
CherryPick.disableGlobalCycleDetection();
|
||||
|
||||
print('\n=== Demonstration complete ===');
|
||||
}
|
||||
197
cherrypick/example/cycle_detection_example.dart
Normal file
197
cherrypick/example/cycle_detection_example.dart
Normal file
@@ -0,0 +1,197 @@
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
// Пример сервисов с циклической зависимостью
|
||||
class UserService {
|
||||
final OrderService orderService;
|
||||
|
||||
UserService(this.orderService);
|
||||
|
||||
void createUser(String name) {
|
||||
print('Creating user: $name');
|
||||
// Пытаемся получить заказы пользователя, что создает циклическую зависимость
|
||||
orderService.getOrdersForUser(name);
|
||||
}
|
||||
}
|
||||
|
||||
class OrderService {
|
||||
final UserService userService;
|
||||
|
||||
OrderService(this.userService);
|
||||
|
||||
void getOrdersForUser(String userName) {
|
||||
print('Getting orders for user: $userName');
|
||||
// Пытаемся получить информацию о пользователе, что создает циклическую зависимость
|
||||
userService.createUser(userName);
|
||||
}
|
||||
}
|
||||
|
||||
// Модули с циклическими зависимостями
|
||||
class UserModule extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<UserService>().toProvide(() => UserService(
|
||||
currentScope.resolve<OrderService>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
class OrderModule extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<OrderService>().toProvide(() => OrderService(
|
||||
currentScope.resolve<UserService>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
// Правильная реализация без циклических зависимостей
|
||||
class UserRepository {
|
||||
void createUser(String name) {
|
||||
print('Creating user in repository: $name');
|
||||
}
|
||||
|
||||
String getUserInfo(String name) {
|
||||
return 'User info for: $name';
|
||||
}
|
||||
}
|
||||
|
||||
class OrderRepository {
|
||||
void createOrder(String orderId, String userName) {
|
||||
print('Creating order $orderId for user: $userName');
|
||||
}
|
||||
|
||||
List<String> getOrdersForUser(String userName) {
|
||||
return ['order1', 'order2', 'order3'];
|
||||
}
|
||||
}
|
||||
|
||||
class ImprovedUserService {
|
||||
final UserRepository userRepository;
|
||||
|
||||
ImprovedUserService(this.userRepository);
|
||||
|
||||
void createUser(String name) {
|
||||
userRepository.createUser(name);
|
||||
}
|
||||
|
||||
String getUserInfo(String name) {
|
||||
return userRepository.getUserInfo(name);
|
||||
}
|
||||
}
|
||||
|
||||
class ImprovedOrderService {
|
||||
final OrderRepository orderRepository;
|
||||
final ImprovedUserService userService;
|
||||
|
||||
ImprovedOrderService(this.orderRepository, this.userService);
|
||||
|
||||
void createOrder(String orderId, String userName) {
|
||||
// Проверяем, что пользователь существует
|
||||
final userInfo = userService.getUserInfo(userName);
|
||||
print('User exists: $userInfo');
|
||||
|
||||
orderRepository.createOrder(orderId, userName);
|
||||
}
|
||||
|
||||
List<String> getOrdersForUser(String userName) {
|
||||
return orderRepository.getOrdersForUser(userName);
|
||||
}
|
||||
}
|
||||
|
||||
// Правильные модули без циклических зависимостей
|
||||
class ImprovedUserModule extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<UserRepository>().singleton().toProvide(() => UserRepository());
|
||||
bind<ImprovedUserService>().toProvide(() => ImprovedUserService(
|
||||
currentScope.resolve<UserRepository>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
class ImprovedOrderModule extends Module {
|
||||
@override
|
||||
void builder(Scope currentScope) {
|
||||
bind<OrderRepository>().singleton().toProvide(() => OrderRepository());
|
||||
bind<ImprovedOrderService>().toProvide(() => ImprovedOrderService(
|
||||
currentScope.resolve<OrderRepository>(),
|
||||
currentScope.resolve<ImprovedUserService>()
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
void main() {
|
||||
print('=== Circular Dependency Detection Example ===\n');
|
||||
|
||||
// Example 1: Demonstrate circular dependency
|
||||
print('1. Attempt to create a scope with circular dependencies:');
|
||||
try {
|
||||
final scope = Scope(null);
|
||||
scope.enableCycleDetection(); // Включаем обнаружение циклических зависимостей
|
||||
|
||||
scope.installModules([
|
||||
UserModule(),
|
||||
OrderModule(),
|
||||
]);
|
||||
|
||||
// Это должно выбросить CircularDependencyException
|
||||
final userService = scope.resolve<UserService>();
|
||||
print('UserService created: $userService');
|
||||
} catch (e) {
|
||||
print('❌ Circular dependency detected: $e\n');
|
||||
}
|
||||
|
||||
// Example 2: Without circular dependency detection (dangerous!)
|
||||
print('2. Same code without circular dependency detection:');
|
||||
try {
|
||||
final scope = Scope(null);
|
||||
// НЕ включаем обнаружение циклических зависимостей
|
||||
|
||||
scope.installModules([
|
||||
UserModule(),
|
||||
OrderModule(),
|
||||
]);
|
||||
|
||||
// Это приведет к StackOverflowError при попытке использования
|
||||
final userService = scope.resolve<UserService>();
|
||||
print('UserService создан: $userService');
|
||||
|
||||
// Попытка использовать сервис приведет к бесконечной рекурсии
|
||||
// userService.createUser('John'); // Раскомментируйте для демонстрации StackOverflow
|
||||
print('⚠️ UserService created, but using it will cause StackOverflow\n');
|
||||
} catch (e) {
|
||||
print('❌ Error: $e\n');
|
||||
}
|
||||
|
||||
// Example 3: Correct architecture without circular dependencies
|
||||
print('3. Correct architecture without circular dependencies:');
|
||||
try {
|
||||
final scope = Scope(null);
|
||||
scope.enableCycleDetection(); // Включаем для безопасности
|
||||
|
||||
scope.installModules([
|
||||
ImprovedUserModule(),
|
||||
ImprovedOrderModule(),
|
||||
]);
|
||||
|
||||
final userService = scope.resolve<ImprovedUserService>();
|
||||
final orderService = scope.resolve<ImprovedOrderService>();
|
||||
|
||||
print('✅ Services created successfully');
|
||||
|
||||
// Демонстрация работы
|
||||
userService.createUser('John');
|
||||
orderService.createOrder('ORD-001', 'John');
|
||||
final orders = orderService.getOrdersForUser('John');
|
||||
print('✅ Orders for user John: $orders');
|
||||
|
||||
} catch (e) {
|
||||
print('❌ Error: $e');
|
||||
}
|
||||
|
||||
print('\n=== Recommendations ===');
|
||||
print('1. Always enable circular dependency detection in development mode.');
|
||||
print('2. Use repositories and services to separate concerns.');
|
||||
print('3. Avoid mutual dependencies between services at the same level.');
|
||||
print('4. Use events or mediators to decouple components.');
|
||||
}
|
||||
Reference in New Issue
Block a user