syncguard/redis/errors.js

Functional TypeScript library for distributed locking across microservices. Prevents race conditions with Redis, PostgreSQL, Firestore, and custom backends. Features automatic lock management, timeout handling, and extensible architecture.

// SPDX-FileCopyrightText: 2025-present Kriasoft
// SPDX-License-Identifier: MIT
import { LockError } from "../common/backend.js";
/**
 * Checks if an AbortSignal has been aborted and throws LockError if so.
 * Redis backend uses pre-dispatch checking since ioredis does not accept AbortSignal parameters.
 *
 * @param signal - Optional AbortSignal to check
 * @throws LockError("Aborted") if signal is aborted
 */
export function checkAborted(signal) {
    if (signal?.aborted) {
        throw new LockError("Aborted", "Operation aborted by signal");
    }
}
/**
 * Maps Redis client errors to standardized LockError codes.
 *
 * @param error - Redis client error or string
 * @returns LockError with appropriate code and context
 * @see docs/specs/interface.md
 */
export function mapRedisError(error) {
    const errorMessage = error instanceof Error ? error.message : String(error);
    // Network timeout errors
    if (errorMessage.includes("timeout")) {
        return new LockError("NetworkTimeout", `Redis timeout: ${errorMessage}`, {
            cause: error,
        });
    }
    // Connection and network errors
    if (errorMessage.includes("ECONNRESET") ||
        errorMessage.includes("ENOTFOUND") ||
        errorMessage.includes("ECONNREFUSED")) {
        return new LockError("ServiceUnavailable", `Redis connection error: ${errorMessage}`, { cause: error });
    }
    // Authentication errors
    if (errorMessage.includes("NOAUTH") ||
        errorMessage.includes("WRONGPASS") ||
        errorMessage.includes("NOPERM")) {
        return new LockError("AuthFailed", `Redis authentication error: ${errorMessage}`, { cause: error });
    }
    // Command errors
    if (errorMessage.includes("WRONGTYPE") ||
        errorMessage.includes("SYNTAX") ||
        errorMessage.includes("INVALID")) {
        return new LockError("InvalidArgument", `Redis command error: ${errorMessage}`, { cause: error });
    }
    // Script errors
    if (errorMessage.includes("SCRIPT_ERROR")) {
        return new LockError("Internal", `Redis script error: ${errorMessage}`, {
            cause: error,
        });
    }
    // Default to Internal for unknown errors
    return new LockError("Internal", `Redis error: ${errorMessage}`, {
        cause: error,
    });
}