@microsoft/omnichannel-chat-sdk/lib/utils/errorClassifier.js

Microsoft Omnichannel Chat SDK

"use strict";
/**
 * Classifies network/HTTP errors into standardized cancellation reason categories.
 * Pure function with no side effects - suitable for unit testing.
 *
 * ADO 6373382: Diagnostic telemetry for ChatConfigRetrievalFailure
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.classifyNetworkError = classifyNetworkError;
/**
 * Classifies an error object into a standardized cancellation reason category.
 *
 * @param error The error object to classify (typically from axios or fetch)
 * @param online Browser's online status (navigator.onLine) - optional
 * @returns A standardized cancellation reason string
 *
 * @example
 * ```typescript
 * const error = { code: 'ECONNABORTED' };
 * const reason = classifyNetworkError(error, true);
 * // Returns: 'timeout'
 * ```
 */
function classifyNetworkError(error, online) {
    var _a;
    // Handle null/undefined errors
    if (error === null || error === undefined || typeof error !== 'object') {
        return 'unknown';
    }
    // Type guard for error objects with common properties
    var err = error;
    var errorCode = err.code;
    var errorMessage = err.message || '';
    var httpStatus = (_a = err.response) === null || _a === void 0 ? void 0 : _a.status;
    // Priority order for classification:
    // 1. Explicit timeout (ECONNABORTED from axios)
    if (errorCode === 'ECONNABORTED') {
        return 'timeout';
    }
    // 2. Request cancelled by client
    if (errorCode === 'ERR_CANCELED' || errorCode === 'ECONNRESET') {
        return 'request_cancelled';
    }
    // 3. Browser offline (navigator.onLine === false)
    if (online === false) {
        return 'browser_offline';
    }
    // 4. DNS lookup failure
    if (errorCode === 'ENOTFOUND' || errorMessage.includes('getaddrinfo')) {
        return 'dns_lookup_failed';
    }
    // 5. Connection timeout (different from request timeout)
    if (errorCode === 'ETIMEDOUT') {
        return 'connection_timeout';
    }
    // 6. Connection refused
    if (errorCode === 'ECONNREFUSED') {
        return 'connection_refused';
    }
    // 7. Network error with no response (HTTP status 0)
    if (httpStatus === 0 && errorMessage.includes('Network Error')) {
        return 'network_error_no_response';
    }
    // 8. Server error (5xx) - category only, no specific status
    if (httpStatus && httpStatus >= 500) {
        return 'server_error';
    }
    // 9. Client error (4xx) - category only, no specific status
    if (httpStatus && httpStatus >= 400) {
        return 'client_error';
    }
    // 10. Unknown/unclassified error
    return 'unknown';
}
//# sourceMappingURL=errorClassifier.js.map