All files / blong-gogo/src error.ts

68.14% Statements 154/226
65.9% Branches 29/44
66.66% Functions 8/12
68.14% Lines 154/226

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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 2271x 1x 1x 1x 1x 1x 14x 4x 4x 14x 1x 12x 12x 12x 12x 12x 12x 12x 11x 11x 11x                                 11x 11x 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 317x 317x 317x 317x 18x 18x 18x 18x 18x 22x 17x 17x 18x 18x 18x 317x 14x 14x 4x 4x 4x 4x 4x 4x 4x 12x 584x 584x 584x 584x 584x 584x 584x 584x     584x 584x 12x                             12x                           12x 12x 12x 12x 306x 306x 12x                 12x                 12x 56x 56x 56x 56x 949x           949x 949x 849x 100x   100x 949x 949x 949x 244x         244x 244x 244x 244x 244x 705x 705x 949x 705x 705x 14x 14x 14x 14x 14x   14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 705x 705x 949x 705x 705x 949x 949x 949x 949x 949x 949x 949x 949x 949x 56x 56x 12x 12x 12x  
import type {IApi, IErrorFactory, ILog, IMeta, ITypedError} from '@feasibleone/blong/types';
 
const typeRegex: RegExp = /^[$a-z]\w*(\.!?\w+)*$/;
const paramsRegex: RegExp = /\{([^}]*)\}/g;
 
const interpolate = (string: string, params: Record<string, string> = {}): string => {
    return string.replace(paramsRegex, (placeholder, label) => {
        return typeof params[label] === 'undefined' ? `?${label}?` : params[label];
    });
};
const getWarnHandler = ({
    logFactory,
    logLevel,
}: {
    logFactory?: IApi;
    logLevel: Parameters<ILog['logger']>[0];
}): ((msg: string | undefined, context: {method: string; args: unknown}) => void) => {
    if (logFactory) {
        const log = logFactory.createLog(logLevel, {name: 'utError', context: 'utError'});
        if (log.warn) {
            return (msg, context) => {
                const e = new Error();
                log.warn?.(
                    {
                        $meta: {
                            mtid: 'deprecation',
                            method: context.method,
                        },
                        args: context.args,
                        error: {
                            type: 'utError.deprecation',
                            stack: e.stack?.split('\n').splice(3).join('\n'),
                        },
                    },
                    msg,
                );
            };
        }
    }
    return () => {};
};
 
export default ({
    logFactory,
    logLevel,
    errorPrint,
}: {
    logFactory?: IApi;
    logLevel: Parameters<ILog['logger']>[0];
    errorPrint?: string | boolean;
}): IErrorFactory => {
    const warn = getWarnHandler({logFactory, logLevel});
    const errors: Record<string | symbol, {message: string; print?: string} | string> = {
        source: '',
    };
    // Mapping from lowercase no-dot keys to original error keys for case-insensitive lookup
    const errorLookup: Record<string, string> = {};
 
    // Create the proxy once upfront for reuse
    const errorsProxy = new Proxy(errors, {
        get(target, prop: string | symbol) {
            if (typeof prop === 'symbol') return target[prop];
 
            // First try direct access (backwards compatibility with dot notation)
            if (prop in target) return target[prop];
 
            // Convert property to lowercase without dots for lookup
            let lookupKey = prop.toLowerCase();
 
            // Remove 'error' prefix if present (e.g., errorReleaseJobTrigger -> releasjobtrigger)
            if (lookupKey.startsWith('error')) {
                lookupKey = lookupKey.substring(5);
            }
 
            // Try to find matching error
            const originalKey = errorLookup[lookupKey];
            if (originalKey && target[originalKey]) {
                return target[originalKey];
            }
 
            // Throw error for non-existent properties to catch typos during destructuring
            const availableErrors = Object.keys(target).sort().join(', ');
            throw new Error(
                `Error '${String(prop)}' not found. Available errors: ${availableErrors}`,
            );
        },
        has(target, prop: string | symbol) {
            if (typeof prop === 'symbol') return prop in target;
 
            // Check direct access first
            if (prop in target) return true;
 
            // Check via lookup
            let lookupKey = prop.toLowerCase();
            if (lookupKey.startsWith('error')) {
                lookupKey = lookupKey.substring(5);
            }
            return lookupKey in errorLookup;
        },
        ownKeys(target) {
            // Return all original keys plus generated error* keys
            const keys = Object.keys(target);
            const additionalKeys = keys.map(key => {
                // Convert 'release.jobTrigger' to 'errorReleaseJobTrigger'
                const parts = key.split('.');
                const camelCased = parts
                    .map((part, idx) =>
                        idx === 0 ? part : part.charAt(0).toUpperCase() + part.slice(1),
                    )
                    .join('');
                return 'error' + camelCased.charAt(0).toUpperCase() + camelCased.slice(1);
            });
            return [...keys, ...additionalKeys];
        },
        getOwnPropertyDescriptor(target, prop: string | symbol) {
            if (typeof prop === 'symbol') {
                return Object.getOwnPropertyDescriptor(target, prop);
            }

            // Check both direct and via lookup
            if (prop in target || this.has!(target, prop)) {
                return {
                    enumerable: true,
                    configurable: true,
                };
            }
            return undefined;
        },
    });
 
    const api = {
        get(type: string) {
            return type ? errors[type] : errorsProxy;
        },
        fetch(type: string) {
            const result = {} as Record<string, string | {message: string; print?: string}>;
            Object.keys(errors).forEach(key => {
                if (key.startsWith(type)) {
                    result[key] = errors[key];
                }
            });
            return result;
        },
        define(id: string, superType: string | {type: string}, message: string) {
            const type = [
                superType ? (typeof superType === 'string' ? superType : superType.type) : null,
                id,
            ]
                .filter(x => x)
                .join('.');
            return api.register({[type]: message})[type];
        },
        register<T extends Record<string, string | {message: string; print?: string}>>(
            errorsMap: T,
        ): Record<keyof T, (params?: unknown, $meta?: IMeta) => ITypedError> {
            const result = {} as Record<keyof T, (params?: unknown, $meta?: IMeta) => ITypedError>;
            Object.entries(errorsMap).forEach(([type, message]) => {
                if (!typeRegex.test(type)) {
                    warn?.(`Invalid error type format: '${type}'!`, {
                        args: {type, expectedFormat: typeRegex.toString()},
                        method: 'utError.register',
                    });
                }
                const props: {message: string; print?: string} =
                    typeof message === 'string'
                        ? {message, print: undefined}
                        : Array.isArray(message)
                          ? {message: message[0], print: message[1]}
                          : message;
                if (!props.message) throw new Error(`Missing message for error '${type}'`);
                const error = errors[type] as {message?: string; print?: string} | undefined;
                if (error) {
                    if (error.message !== props.message) {
                        throw new Error(
                            `Error '${type}' is already defined with different message!`,
                        );
                    }
                    (result as Record<string, (params?: unknown, $meta?: IMeta) => ITypedError>)[
                        type
                    ] = error as unknown as (params?: unknown, $meta?: IMeta) => ITypedError;
                    return;
                }
 
                if (!props.print && errorPrint)
                    props.print = typeof errorPrint === 'string' ? errorPrint : props.message;
 
                const handler = (
                    params = {params: undefined},
                    $meta: unknown,
                ): ITypedError | ITypedError[] => {
                    const error = new Error() as ITypedError;
                    if (params instanceof Error) {
                        error.cause = params;
                    } else {
                        Object.assign(error, params);
                    }
                    Object.assign(error, props);
                    Object.defineProperty(error, 'name', {
                        value: type,
                        configurable: true,
                        enumerable: false,
                    });
                    error.type = type;
                    if (props.print) error.print = props.print;
                    error.message = interpolate(props.message, params.params);
                    return $meta ? [error] : error; // to do - fix once bus.register allows to configure unpack
                };
                handler.type = type;
                handler.message = props.message;
                if (props.print) handler.print = props.print;
                handler.params = handler.message
                    .match(paramsRegex)
                    ?.map(param => param.substring(1, param.length - 1));
                (result as Record<string, unknown>)[type] = (errors as Record<string, unknown>)[
                    type
                ] = handler;
 
                // Add to lookup map (lowercase, no dots)
                const lookupKey = type.toLowerCase().replace(/\./g, '');
                errorLookup[lookupKey] = type;
            });
            return result;
        },
    };
    return api as IErrorFactory;
};