Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | 32x 32x 8x 3x 5x 1x 4x 1x 1x 3x 4x 32x 7x 32x 13x 13x 32x 8x 8x 32x | import { useState, useCallback } from 'react';
import logger from '../utils/logger';
/**
* State interface for widget error management
*/
export interface WidgetErrorState {
/**
* The current error, if any
*/
error: Error | null;
/**
* Whether an error is currently present
*/
hasError: boolean;
/**
* Clear the current error state
*/
clearError: () => void;
/**
* Set a specific error
*/
setError: (error: Error) => void;
/**
* Handle an unknown error (automatically converts to Error type)
*/
handleError: (error: unknown) => void;
}
/**
* Custom hook for consistent widget error handling
*
* ## Business Perspective
*
* Provides standardized error management across all widgets, ensuring
* consistent user experience and reliable error reporting for operational
* monitoring and debugging. 🛡️
*
* ## Technical Perspective
*
* Encapsulates error state management with automatic logging and type-safe
* error handling. Provides a consistent API for setting, clearing, and
* handling errors across all widget components.
*
* @param widgetName - Name of the widget for logging and error context
* @returns Error state management interface
*
* @example
* ```tsx
* const MyWidget: React.FC<Props> = ({ data }) => {
* const { error, hasError, handleError, clearError } = useWidgetError('MyWidget');
* const [isLoading, setIsLoading] = useState(false);
*
* const loadData = async () => {
* setIsLoading(true);
* clearError();
*
* try {
* const result = await fetchData();
* // Process result...
* } catch (err) {
* handleError(err);
* } finally {
* setIsLoading(false);
* }
* };
*
* if (hasError) {
* return <ErrorMessage message={error?.message} retry={loadData} />;
* }
*
* return <div>Widget content</div>;
* };
* ```
*/
export function useWidgetError(widgetName: string): WidgetErrorState {
const [error, setErrorState] = useState<Error | null>(null);
/**
* Normalize unknown error types to Error objects
* Centralizes error conversion logic for consistency
*/
const normalizeError = useCallback((err: unknown): Error => {
if (err instanceof Error) {
return err;
} else if (typeof err === 'string') {
return new Error(err);
} else {
// Attempt to preserve error details for debugging
let errorDetails: string;
if (typeof err === 'object' && err !== null) {
try {
errorDetails = JSON.stringify(err, null, 2);
} catch {
errorDetails = '[Unserializable error object]';
}
} else {
errorDetails = String(err);
}
return new Error(`${widgetName}: Unknown error occurred - ${errorDetails}`);
}
}, [widgetName]);
/**
* Clear the current error state
*/
const clearError = useCallback(() => {
setErrorState(null);
}, []);
/**
* Set a specific error and log it
*/
const setError = useCallback((err: Error) => {
logger.error(`${widgetName}: ${err.message}`, err);
setErrorState(err);
}, [widgetName]);
/**
* Handle an unknown error by converting it to Error type and logging
*/
const handleError = useCallback((err: unknown) => {
const normalizedError = normalizeError(err);
setError(normalizedError);
}, [normalizeError, setError]);
return {
error,
hasError: error !== null,
clearError,
setError,
handleError,
};
}
export default useWidgetError;
|