|
| 1 | +# SVMSeek Error Handling and Recovery System |
| 2 | + |
| 3 | +This document describes the comprehensive error handling mechanisms implemented in SVMSeek and how applications should consume error recovery events. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +SVMSeek implements a multi-layered error handling system designed to: |
| 8 | +1. **Prevent crashes** from third-party wallet extension conflicts |
| 9 | +2. **Recover gracefully** from null pointer access errors |
| 10 | +3. **Provide user-friendly feedback** for recoverable errors |
| 11 | +4. **Maintain application stability** in complex browser environments |
| 12 | + |
| 13 | +## Architecture |
| 14 | + |
| 15 | +### Global Error Handler (`src/utils/globalErrorHandler.ts`) |
| 16 | + |
| 17 | +The `GlobalErrorHandler` class provides comprehensive error catching and recovery: |
| 18 | + |
| 19 | +```typescript |
| 20 | +import { globalErrorHandler } from './utils/globalErrorHandler'; |
| 21 | + |
| 22 | +// The handler auto-initializes, but you can access error stats |
| 23 | +const errorStats = globalErrorHandler.getErrorStats(); |
| 24 | +console.log('Error statistics:', errorStats); |
| 25 | +``` |
| 26 | + |
| 27 | +### Error Types Handled |
| 28 | + |
| 29 | +#### 1. Wallet Extension Conflicts |
| 30 | +- **Problem**: Multiple wallet extensions try to define `window.ethereum` |
| 31 | +- **Solution**: Monkey-patch `Object.defineProperty` to detect and resolve conflicts |
| 32 | +- **Event**: `svmseek-wallet-conflict` |
| 33 | + |
| 34 | +#### 2. Null Property Access |
| 35 | +- **Problem**: Third-party code assumes `event.data` is always defined |
| 36 | +- **Solution**: Wrap event listeners with null-safe validation |
| 37 | +- **Event**: `svmseek-error-recovery` |
| 38 | + |
| 39 | +#### 3. Unhandled Promise Rejections |
| 40 | +- **Problem**: Async operations fail without proper error handling |
| 41 | +- **Solution**: Global promise rejection handler with recovery attempts |
| 42 | +- **Event**: `svmseek-error-recovery` |
| 43 | + |
| 44 | +## Event-Driven Error Recovery |
| 45 | + |
| 46 | +The error handling system dispatches custom events that your application can listen for: |
| 47 | + |
| 48 | +### 1. Error Recovery Events (`svmseek-error-recovery`) |
| 49 | + |
| 50 | +```typescript |
| 51 | +window.addEventListener('svmseek-error-recovery', (event) => { |
| 52 | + const { errorMessage, errorType, errorCount } = event.detail; |
| 53 | + |
| 54 | + // Show user-friendly error message |
| 55 | + showErrorToast(`Recovered from ${errorType}: ${errorMessage}`); |
| 56 | + |
| 57 | + // Track error for analytics |
| 58 | + analytics.track('error_recovered', { |
| 59 | + type: errorType, |
| 60 | + message: errorMessage, |
| 61 | + count: errorCount |
| 62 | + }); |
| 63 | + |
| 64 | + // Attempt specific recovery actions |
| 65 | + switch (errorType) { |
| 66 | + case 'promise_rejection': |
| 67 | + // Retry failed operation |
| 68 | + retryLastOperation(); |
| 69 | + break; |
| 70 | + case 'global_error': |
| 71 | + // Refresh component state |
| 72 | + refreshApplicationState(); |
| 73 | + break; |
| 74 | + } |
| 75 | +}); |
| 76 | +``` |
| 77 | + |
| 78 | +### 2. Wallet Conflict Events (`svmseek-wallet-conflict`) |
| 79 | + |
| 80 | +```typescript |
| 81 | +window.addEventListener('svmseek-wallet-conflict', (event) => { |
| 82 | + const { message, suggestion } = event.detail; |
| 83 | + |
| 84 | + // Show user guidance for wallet conflicts |
| 85 | + showWalletConflictDialog({ |
| 86 | + title: 'Multiple Wallets Detected', |
| 87 | + message: message, |
| 88 | + suggestion: suggestion, |
| 89 | + actions: [ |
| 90 | + { |
| 91 | + label: 'Learn More', |
| 92 | + action: () => openWalletCompatibilityGuide() |
| 93 | + }, |
| 94 | + { |
| 95 | + label: 'Continue Anyway', |
| 96 | + action: () => dismissWalletConflictDialog() |
| 97 | + } |
| 98 | + ] |
| 99 | + }); |
| 100 | +}); |
| 101 | +``` |
| 102 | + |
| 103 | +### 3. Custom SVMSeek Events (`svmseek-event`) |
| 104 | + |
| 105 | +```typescript |
| 106 | +window.addEventListener('svmseek-event', (event) => { |
| 107 | + const eventData = event.detail; |
| 108 | + |
| 109 | + // Handle application-specific events |
| 110 | + switch (eventData.type) { |
| 111 | + case 'wallet_injection_ready': |
| 112 | + console.log('Wallet providers injected successfully'); |
| 113 | + break; |
| 114 | + case 'security_violation': |
| 115 | + handleSecurityViolation(eventData); |
| 116 | + break; |
| 117 | + } |
| 118 | +}); |
| 119 | +``` |
| 120 | + |
| 121 | +## Implementation Guidelines |
| 122 | + |
| 123 | +### For Component Developers |
| 124 | + |
| 125 | +#### 1. Defensive Programming |
| 126 | +Always assume external data might be null or undefined: |
| 127 | + |
| 128 | +```typescript |
| 129 | +// ❌ Bad: Assumes event.data exists |
| 130 | +const handleMessage = (event: MessageEvent) => { |
| 131 | + const { type, payload } = event.data; |
| 132 | + // This will crash if event.data is null |
| 133 | +}; |
| 134 | + |
| 135 | +// ✅ Good: Defensive null checking |
| 136 | +const handleMessage = (event: MessageEvent) => { |
| 137 | + if (!event.data || typeof event.data !== 'object') { |
| 138 | + console.warn('Invalid message data received'); |
| 139 | + return; |
| 140 | + } |
| 141 | + |
| 142 | + const { type, payload } = event.data; |
| 143 | + // Safe to proceed |
| 144 | +}; |
| 145 | +``` |
| 146 | + |
| 147 | +#### 2. Error Boundary Integration |
| 148 | +Integrate with React Error Boundaries to catch component-level errors: |
| 149 | + |
| 150 | +```typescript |
| 151 | +// ErrorBoundary should listen for recovery events |
| 152 | +class ErrorBoundary extends React.Component { |
| 153 | + componentDidMount() { |
| 154 | + window.addEventListener('svmseek-error-recovery', this.handleErrorRecovery); |
| 155 | + } |
| 156 | + |
| 157 | + handleErrorRecovery = (event) => { |
| 158 | + // Attempt to recover component state |
| 159 | + this.setState({ hasError: false, error: null }); |
| 160 | + }; |
| 161 | +} |
| 162 | +``` |
| 163 | + |
| 164 | +### For API Integrations |
| 165 | + |
| 166 | +#### 1. Timeout Handling |
| 167 | +Use centralized timeout constants: |
| 168 | + |
| 169 | +```typescript |
| 170 | +import { TIMEOUT_CONSTANTS } from '../utils/constants'; |
| 171 | + |
| 172 | +const apiCall = async () => { |
| 173 | + const controller = new AbortController(); |
| 174 | + const timeoutId = setTimeout( |
| 175 | + () => controller.abort(), |
| 176 | + TIMEOUT_CONSTANTS.NETWORK_REQUEST |
| 177 | + ); |
| 178 | + |
| 179 | + try { |
| 180 | + const response = await fetch('/api/data', { |
| 181 | + signal: controller.signal |
| 182 | + }); |
| 183 | + return await response.json(); |
| 184 | + } finally { |
| 185 | + clearTimeout(timeoutId); |
| 186 | + } |
| 187 | +}; |
| 188 | +``` |
| 189 | + |
| 190 | +#### 2. Retry Logic |
| 191 | +Implement exponential backoff for failed requests: |
| 192 | + |
| 193 | +```typescript |
| 194 | +import { getRetryDelay, ERROR_CONSTANTS } from '../utils/constants'; |
| 195 | + |
| 196 | +const retryableApiCall = async (attempt = 0) => { |
| 197 | + try { |
| 198 | + return await apiCall(); |
| 199 | + } catch (error) { |
| 200 | + if (attempt < ERROR_CONSTANTS.MAX_RETRIES) { |
| 201 | + const delay = getRetryDelay(attempt); |
| 202 | + await new Promise(resolve => setTimeout(resolve, delay)); |
| 203 | + return retryableApiCall(attempt + 1); |
| 204 | + } |
| 205 | + throw error; |
| 206 | + } |
| 207 | +}; |
| 208 | +``` |
| 209 | + |
| 210 | +## Configuration |
| 211 | + |
| 212 | +### Error Handler Configuration |
| 213 | + |
| 214 | +```typescript |
| 215 | +import { GlobalErrorHandler } from './utils/globalErrorHandler'; |
| 216 | + |
| 217 | +// Custom configuration |
| 218 | +const errorHandler = new GlobalErrorHandler({ |
| 219 | + enableRecovery: true, // Enable automatic recovery attempts |
| 220 | + enableLogging: true, // Log errors to console |
| 221 | + enableUserNotification: true // Dispatch user-facing events |
| 222 | +}); |
| 223 | + |
| 224 | +errorHandler.initialize(); |
| 225 | +``` |
| 226 | + |
| 227 | +### Constants Configuration |
| 228 | + |
| 229 | +Modify timeout and error constants in `src/utils/constants.ts`: |
| 230 | + |
| 231 | +```typescript |
| 232 | +export const TIMEOUT_CONSTANTS = { |
| 233 | + NETWORK_REQUEST: 10000, // API request timeout |
| 234 | + IFRAME_LOAD: 10000, // Iframe loading timeout |
| 235 | + MESSAGE_RESPONSE: 30000, // Wallet message timeout |
| 236 | + // ... other timeouts |
| 237 | +} as const; |
| 238 | +``` |
| 239 | + |
| 240 | +## Testing Error Handling |
| 241 | + |
| 242 | +### Unit Tests |
| 243 | +Test error scenarios with mock failures: |
| 244 | + |
| 245 | +```typescript |
| 246 | +import { globalErrorHandler } from '../utils/globalErrorHandler'; |
| 247 | + |
| 248 | +describe('Error Recovery', () => { |
| 249 | + test('should recover from null data access', () => { |
| 250 | + const mockEvent = new CustomEvent('svmseek-error-recovery'); |
| 251 | + const handler = jest.fn(); |
| 252 | + |
| 253 | + window.addEventListener('svmseek-error-recovery', handler); |
| 254 | + |
| 255 | + // Simulate null data error |
| 256 | + window.dispatchEvent(mockEvent); |
| 257 | + |
| 258 | + expect(handler).toHaveBeenCalled(); |
| 259 | + }); |
| 260 | +}); |
| 261 | +``` |
| 262 | + |
| 263 | +### Integration Tests |
| 264 | +Test wallet extension conflicts: |
| 265 | + |
| 266 | +```typescript |
| 267 | +test('should handle wallet extension conflicts', () => { |
| 268 | + // Simulate MetaMask defining ethereum |
| 269 | + Object.defineProperty(window, 'ethereum', { |
| 270 | + value: { isMetaMask: true }, |
| 271 | + configurable: false |
| 272 | + }); |
| 273 | + |
| 274 | + // Attempt to redefine (simulating Phantom) |
| 275 | + try { |
| 276 | + Object.defineProperty(window, 'ethereum', { |
| 277 | + value: { isPhantom: true } |
| 278 | + }); |
| 279 | + } catch (error) { |
| 280 | + // Error should be caught and handled gracefully |
| 281 | + expect(error.message).toContain('Cannot redefine property'); |
| 282 | + } |
| 283 | +}); |
| 284 | +``` |
| 285 | + |
| 286 | +## Best Practices |
| 287 | + |
| 288 | +### 1. Event Listener Cleanup |
| 289 | +Always clean up event listeners to prevent memory leaks: |
| 290 | + |
| 291 | +```typescript |
| 292 | +useEffect(() => { |
| 293 | + const handleError = (event) => { |
| 294 | + // Handle error recovery |
| 295 | + }; |
| 296 | + |
| 297 | + window.addEventListener('svmseek-error-recovery', handleError); |
| 298 | + |
| 299 | + return () => { |
| 300 | + window.removeEventListener('svmseek-error-recovery', handleError); |
| 301 | + }; |
| 302 | +}, []); |
| 303 | +``` |
| 304 | + |
| 305 | +### 2. Error Analytics |
| 306 | +Track error patterns for improvement: |
| 307 | + |
| 308 | +```typescript |
| 309 | +window.addEventListener('svmseek-error-recovery', (event) => { |
| 310 | + // Send to analytics service |
| 311 | + analytics.track('error_recovery', { |
| 312 | + error_type: event.detail.errorType, |
| 313 | + error_message: event.detail.errorMessage, |
| 314 | + user_agent: navigator.userAgent, |
| 315 | + timestamp: new Date().toISOString() |
| 316 | + }); |
| 317 | +}); |
| 318 | +``` |
| 319 | + |
| 320 | +### 3. User Experience |
| 321 | +Provide clear, actionable error messages: |
| 322 | + |
| 323 | +```typescript |
| 324 | +const showUserFriendlyError = (errorType, errorMessage) => { |
| 325 | + const userMessages = { |
| 326 | + wallet_conflict: { |
| 327 | + title: 'Multiple Wallets Detected', |
| 328 | + message: 'You have multiple wallet extensions installed. This might cause conflicts.', |
| 329 | + action: 'Learn about wallet compatibility' |
| 330 | + }, |
| 331 | + null_access: { |
| 332 | + title: 'Temporary Issue', |
| 333 | + message: 'We encountered a temporary issue but recovered automatically.', |
| 334 | + action: 'No action needed' |
| 335 | + } |
| 336 | + }; |
| 337 | + |
| 338 | + const config = userMessages[errorType] || { |
| 339 | + title: 'Error Recovered', |
| 340 | + message: 'An error occurred but was handled automatically.', |
| 341 | + action: 'Continue using the app' |
| 342 | + }; |
| 343 | + |
| 344 | + showNotification(config); |
| 345 | +}; |
| 346 | +``` |
| 347 | + |
| 348 | +## Troubleshooting |
| 349 | + |
| 350 | +### Common Issues |
| 351 | + |
| 352 | +1. **Error Recovery Not Working** |
| 353 | + - Check that `globalErrorHandler.initialize()` is called |
| 354 | + - Verify event listeners are properly attached |
| 355 | + - Check browser console for initialization errors |
| 356 | + |
| 357 | +2. **Too Many Recovery Events** |
| 358 | + - Error handler limits recovery attempts per error type |
| 359 | + - Check if error patterns indicate a deeper issue |
| 360 | + - Review error statistics with `globalErrorHandler.getErrorStats()` |
| 361 | + |
| 362 | +3. **Wallet Extension Conflicts Persist** |
| 363 | + - Some extensions may override our protection |
| 364 | + - Consider showing user guidance to disable conflicting extensions |
| 365 | + - Report specific extension combinations that cause issues |
| 366 | + |
| 367 | +### Debug Mode |
| 368 | + |
| 369 | +Enable debug logging for troubleshooting: |
| 370 | + |
| 371 | +```typescript |
| 372 | +import { GlobalErrorHandler } from './utils/globalErrorHandler'; |
| 373 | + |
| 374 | +const debugErrorHandler = new GlobalErrorHandler({ |
| 375 | + enableLogging: true, |
| 376 | + enableRecovery: true, |
| 377 | + enableUserNotification: true |
| 378 | +}); |
| 379 | + |
| 380 | +// Monitor error patterns |
| 381 | +setInterval(() => { |
| 382 | + const stats = debugErrorHandler.getErrorStats(); |
| 383 | + if (Object.keys(stats).length > 0) { |
| 384 | + console.log('Error stats:', stats); |
| 385 | + } |
| 386 | +}, 30000); |
| 387 | +``` |
| 388 | + |
| 389 | +## Future Improvements |
| 390 | + |
| 391 | +1. **Machine Learning Error Prediction**: Analyze error patterns to predict and prevent common failures |
| 392 | +2. **A/B Testing Recovery Strategies**: Test different recovery approaches to optimize user experience |
| 393 | +3. **Real-time Error Monitoring**: Integrate with error tracking services for production monitoring |
| 394 | +4. **Custom Error Recovery Policies**: Allow applications to define custom recovery strategies per error type |
0 commit comments