@63pokupki/nodejs-common/src/System/ErrorSys.ts

common nodejs functionality

import MainRequest from './MainRequest';

/**
 * Системный сервис обработки ошибок
 */
export class ErrorSys
{
	private ok:boolean; // Глобальный статус выполнения
	private env:string; // тип окружения
	private ifDevMode:boolean; // Флаг режима разработки
	private errorList:any; // Ошибки
	private errorDeclareList:any; // список декларированных ошибок
	private devWarningList:any; // Пердупреждения пользователю
	private warningList:any; // Пердупреждения пользователю
	private devNoticeList:any; // Уведомления для разработки и тестирования
	private noticeList:any; // Уведомления для пользователя
	private devLogList:any; // Массив для логирования тестовой информации
	private bMute:boolean; // Режим тишины
	private errorCount: number = 0;
	
	constructor(req:MainRequest){

		this.ok = true;
		this.env = req.conf.common.env;

		this.bMute = false;
		this.bMute = req.conf.common.errorMute;

		if( this.env == 'local' || this.env == 'dev' || this.env == 'test' ){
			this.ifDevMode = true;
		} else {
			this.ifDevMode = false;
		}
		this.errorList = {};
		this.errorDeclareList = {};
		this.devWarningList = {};
		this.warningList = {};
		this.devNoticeList = {};
		this.noticeList = {};
		this.devLogList = [];

	}

	/**
	 * очистка стека
	 */
	public clear(): void {
		this.ok = true;
		this.errorList = {};
		this.devWarningList = {};
		this.warningList = {};
		this.devNoticeList = {};
		this.noticeList = {};
		this.devLogList = [];
		this.errorCount = 0;

	}

	/**
	 * Получить глобальный статус выполнения
	 *
	 * @return boolean
	 */
	public isOk(): boolean{
		return this.ok;
	}

	/**
	 * Получить режим окружения
	 *
	 * @return boolean
	 */
	public isDev(): boolean{
		return this.ifDevMode;
	}

	/**
	 *	Декларировать одну возможную ошибку
	 *
	 * @param keyError
	 */
	public decl(keyError:string, infoError:string = null){
		this.errorDeclareList[keyError] = infoError;
	}

	/**
	 *	Декларация возможных ошибок
	 *
	 * @param keyErrorList
	 */
	public declare(keyErrorList:string[]){
		for(let i = 0; i < keyErrorList.length; i++){
			this.errorDeclareList[keyErrorList[i]] = null;
		}
	}

	/**
	 *	Декларация возможных ошибок
	 *
	 * @param keyErrorList
	 */
	public declareEx(keyErrorList:{[key:string]:string}){

		Object.assign(this.errorDeclareList, keyErrorList);
	}

	/**
	 * Добавляет ошибку в стек
	 *
	 * @param string kError - ключ ошибки
	 * @param string sError - сообщение
	 * @return void
	 */
	public error(kError:string, sError:string ): void{
		if(!this.bMute){
			this.ok = false; // При любой одной ошибке приложение отдает отрицательный ответ
			this.errorList[kError] = sError;

			if( this.ifDevMode ){
				this.devLogList.push('E:['+kError+'] - '+sError);
				console.log('E:['+kError+'] - '+sError);

				// Проверка на декларацию ошибок
				if( !(kError in this.errorDeclareList) ){
					this.devWarning(kError, 'Отсутствует декларация ошибки');
				}
			}
		}
	}

	/**
	 * Сокращенный вариант
	 * Добавляет ошибку в стек (используя в качестве сообщения значение из декларации)
	 *
	 * @param string kError - ключ ошибки
	 * @return void
	 */
	public err( kError:string ): void{
		if(!this.bMute){
			if( this.errorDeclareList[kError] ){
				this.error(kError, this.errorDeclareList[kError]);
			} else {
				this.error(kError, 'Неизвестная ошибка');
				this.devWarning(kError, 'Отсутствует декларация ошибки');
			}
		}

	}

	/**
	 * Добавляет ошибку в стек,
	 * В dev режиме выводит catch(e) ошибки в консоль
	 *
	 * @param e // Error exeption
	 * @param kError // Ключ ошибки - для тестирования
	 * @param sError // Сообщение об ошибке
	 */
	public errorEx(e:any, kError:string, sError:string ): void{
		if(!this.bMute){
			this.ok = false; // При любой одной ошибке приложение отдает отрицательный ответ
			this.errorList[kError] = sError;

			if( this.ifDevMode ){
				this.devLogList.push('E:['+kError+'] - '+sError);
				console.log('E:['+kError+'] - '+sError);
				console.log('Ошибка - ' + e.name , e.message, e.stack);

				// Проверка на декларацию ошибок
				if( !(kError in this.errorDeclareList) ){
					this.devWarning(kError, 'Отсутствует декларация ошибки');
				}
			}
		}
	}

	/**
	 * Добавляет уведомление в стек
	 *
	 * @param string kNotice - ключ ошибки
	 * @param string sNotice - сообщение
	 * @return void
	 */
	public notice( kNotice:string, sNotice:string): void{
		this.noticeList[kNotice] = sNotice;
	}

	/**
	 * Добавляет уведомление для разработки в стек
	 *
	 * @param string kNotice - ключ ошибки
	 * @param string sNotice - сообщение
	 * @return void
	 */
	public devNotice(kNotice:string,  sNotice:string): void{
		if( this.ifDevMode ){
			this.devNoticeList[kNotice] = sNotice;
			this.devLogList.push('N:['+kNotice+'] - '+sNotice);
			console.log('N:['+kNotice+'] - '+sNotice);
		}
	}

	/**
	 * Добавляет предупреждение в стек
	 *
	 * @param string kWarning - ключ ошибки
	 * @param string sWarning - сообщение
	 * @return void
	 */
	public warning( kWarning:string, sWarning:string): void{
		this.warningList[kWarning] = sWarning;
	}

	/**
	 * Добавляет предупреждение для разработки в стек
	 * Добавляется информация только в тестовом режиме
	 *
	 * @param string kWarning - ключ ошибки
	 * @param string sWarning - сообщение
	 * @return void
	 */
	public devWarning( kWarning:string, sWarning:string): void{
		if( this.ifDevMode ){
			this.devWarningList[kWarning] = sWarning;
			this.devLogList.push('W:['+kWarning+'] - '+sWarning);
			console.log('W:['+kWarning+'] - '+sWarning);
		}
	}

	// ==============================================================

	/**
	 * Получить все ошибки
	 *
	 * @return array|null - возвращаются ошибки (key, val)
	 */
	public getErrors(): {}{
		return this.errorList;
	}

	/**
	 * Получить все декларации для DEV режима
	 */
	public getDevDeclare(): {}{
		for( let k in this.errorDeclareList ){
			if( this.errorList[k] && !this.errorDeclareList[k] ){
				this.errorDeclareList[k] = this.errorList[k];
			}
		}

		return this.errorDeclareList;
	}

	/**
	 * Получить все предупреждения для разработки
	 *
	 * @return array|null - возвращаются предупреждения (key, val)
	 */
	public getDevWarning(): {}{
		return this.devWarningList;
	}

	/**
	 * Получить все предупреждения для пользователя
	 *
	 * @return array|null - возвращаются предупреждения (key, val)
	 */
	public getWarning(): {}{

		return this.warningList;
	}

	/**
	 * Получить все уведомления для разработки
	 *
	 * @return array|null - возвращаются уведомления (key, val)
	 */
	public getDevNotice(): {}{

		return this.devNoticeList;
	}

	/**
	 * Получить все уведомления для пользователя
	 *
	 * @return array|null - возвращаются уведомления (key, val)
	 */
	public getNotice(): {}{
		return this.noticeList;
	}

	/**
	 * Получить все логи для разработки
	 *
	 * @return array|null - возвращаются уведомления (key, val)
	 */
	public getDevLog(): string[]{
		return this.devLogList;
	}

}