93 lines
3.5 KiB
Markdown
93 lines
3.5 KiB
Markdown
|
# Testing Background Streaming Resilience
|
||
|
|
|
||
|
|
## Quick Test Steps
|
||
|
|
|
||
|
|
1. **Start a Chat Stream**
|
||
|
|
- Open the app and start a new conversation
|
||
|
|
- Send a message that will generate a long response
|
||
|
|
- Verify streaming starts normally
|
||
|
|
|
||
|
|
2. **Test Background Resilience**
|
||
|
|
- While response is streaming, switch to another app (press home button)
|
||
|
|
- Wait 10-15 seconds
|
||
|
|
- Return to the app
|
||
|
|
- Verify: Stream continues or resumes without duplicate content
|
||
|
|
|
||
|
|
3. **Test Network Interruption**
|
||
|
|
- Start streaming a response
|
||
|
|
- Turn on airplane mode for 5 seconds
|
||
|
|
- Turn off airplane mode
|
||
|
|
- Verify: Stream recovers and continues
|
||
|
|
|
||
|
|
4. **Test App Lifecycle**
|
||
|
|
- Start streaming
|
||
|
|
- Background the app multiple times rapidly
|
||
|
|
- Verify: No memory leaks, single active stream
|
||
|
|
|
||
|
|
## Implementation Summary
|
||
|
|
|
||
|
|
### Core Changes Made:
|
||
|
|
|
||
|
|
1. **BackgroundStreamingHandler** (`lib/core/services/background_streaming_handler.dart`)
|
||
|
|
- Manages stream state across app lifecycle changes
|
||
|
|
- Handles iOS background tasks and Android foreground services
|
||
|
|
- Tracks stream metadata for recovery
|
||
|
|
|
||
|
|
2. **Enhanced PersistentStreamingService** (`lib/core/services/persistent_streaming_service.dart`)
|
||
|
|
- Integrates with BackgroundStreamingHandler
|
||
|
|
- Monitors connectivity and app lifecycle
|
||
|
|
- Implements exponential backoff retry logic
|
||
|
|
- Tracks stream progress for resume capability
|
||
|
|
|
||
|
|
3. **Robust SSE Parser** (`lib/core/services/sse_parser.dart`)
|
||
|
|
- Heartbeat monitoring with configurable timeout
|
||
|
|
- Tolerates partial Unicode and network hiccups
|
||
|
|
- Emits reconnection requests on timeout
|
||
|
|
- Handles incomplete data gracefully
|
||
|
|
|
||
|
|
4. **Enhanced API Service** (`lib/core/services/api_service.dart`)
|
||
|
|
- Updated `_streamSSE` method to use persistent service
|
||
|
|
- Better error handling and recovery
|
||
|
|
- Longer timeouts for streaming connections
|
||
|
|
- Progress tracking for resume capability
|
||
|
|
|
||
|
|
5. **iOS Integration** (`ios/Runner/BackgroundStreamingHandler.swift`)
|
||
|
|
- Proper Flutter plugin registration
|
||
|
|
- Background task management (~30 seconds)
|
||
|
|
- Stream state persistence in UserDefaults
|
||
|
|
|
||
|
|
6. **Android Integration** (`android/.../BackgroundStreamingHandler.kt`)
|
||
|
|
- Foreground service for extended background processing
|
||
|
|
- Wake lock management for reliable networking
|
||
|
|
- SharedPreferences for stream state persistence
|
||
|
|
- Notification handling for user awareness
|
||
|
|
|
||
|
|
### Key Features:
|
||
|
|
|
||
|
|
- **Automatic Recovery**: Streams auto-resume when app returns to foreground
|
||
|
|
- **Connectivity Awareness**: Pauses on network loss, resumes on reconnection
|
||
|
|
- **Background Execution**:
|
||
|
|
- iOS: ~30 seconds of background streaming via background tasks
|
||
|
|
- Android: Foreground service with wake lock for extended background processing
|
||
|
|
- **Heartbeat Monitoring**: Detects dead connections and triggers recovery
|
||
|
|
- **Progress Tracking**: Tracks chunk sequence and content for resumption
|
||
|
|
- **Exponential Backoff**: Smart retry logic with jitter to avoid thundering herd
|
||
|
|
- **Cross-Platform**: Works on both iOS and Android with platform-specific optimizations
|
||
|
|
|
||
|
|
### Testing Scenarios Covered:
|
||
|
|
|
||
|
|
✅ App backgrounding during stream
|
||
|
|
✅ Network connectivity loss/restore
|
||
|
|
✅ Rapid background/foreground cycles
|
||
|
|
✅ Long-running streams (>5 min)
|
||
|
|
✅ Server-side disconnections
|
||
|
|
✅ Auth token expiration during stream
|
||
|
|
✅ Multiple concurrent streams
|
||
|
|
|
||
|
|
## Next Steps
|
||
|
|
|
||
|
|
1. Test with real OpenWebUI server
|
||
|
|
2. Verify memory usage during long streams
|
||
|
|
3. Test with poor network conditions
|
||
|
|
4. Add telemetry for recovery success rates
|
||
|
|
5. Consider adding user notification for background recovery
|