botserver/packages/core.gbapp/services/GBLogEx.ts

/*****************************************************************************\
|  █████  █████ ██    █ █████ █████   ████  ██      ████   █████ █████  ███ ® |
| ██      █     ███   █ █     ██  ██ ██  ██ ██      ██  █ ██   ██  █   █      |
| ██  ███ ████  █ ██  █ ████  █████  ██████ ██      ████   █   █   █    ██    |
| ██   ██ █     █  ██ █ █     ██  ██ ██  ██ ██      ██  █ ██   ██  █      █   |
|  █████  █████ █   ███ █████ ██  ██ ██  ██ █████   ████   █████   █   ███    |
|                                                                             |
| General Bots Copyright (c) pragmatismo.cloud. All rights reserved.          |
| Licensed under the AGPL-3.0.                                                |
|                                                                             |
| According to our dual licensing model, this program can be used either      |
| under the terms of the GNU Affero General Public License, version 3,        |
| or under a proprietary license.                                             |
|                                                                             |
| The texts of the GNU Affero General Public License with an additional       |
| permission and of our proprietary license can be found at and               |
| in the LICENSE file you have received along with this program.              |
|                                                                             |
| This program is distributed in the hope that it will be useful,             |
| but WITHOUT ANY WARRANTY, without even the implied warranty of              |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                |
| GNU Affero General Public License for more details.                         |
|                                                                             |
| "General Bots" is a registered trademark of pragmatismo.cloud.              |
| The licensing of the program under the AGPLv3 does not imply a              |
| trademark license. Therefore any rights, title and interest in              |
| our trademarks remain entirely with us.                                     |
|                                                                             |
\*****************************************************************************/

/**
 * @fileoverview General Bots server core.
 */

'use strict';

import { GBLog, IGBInstance } from 'botlib';
import { GuaribasLog } from '../models/GBModel.js';
import { GBServer } from '../../../src/app.js';
import { GBConfigService } from './GBConfigService.js';

export class GBLogEx {
  private static async logWithLevel(
    level: 'error' | 'debug' | 'info' | 'verbose',
    minOrInstanceId: any,
    message: string
  ) {
    const instanceId = this.normalizeInstanceId(minOrInstanceId);
    GBLog[level](`${instanceId}: ${message}`);
    await this.log(instanceId, level.charAt(0), message);
  }

  private static normalizeInstanceId(minOrInstanceId: any): string | number {
    if (typeof minOrInstanceId === 'object') {
      return minOrInstanceId.instance ? minOrInstanceId.instance.botId : minOrInstanceId.botId;
    }
    return minOrInstanceId === 0 ? 'default' : minOrInstanceId;
  }

  public static async error(minOrInstanceId: any, message: string) {
    await this.logWithLevel('error', minOrInstanceId, message);
  }

  public static async debug(minOrInstanceId: any, message: string) {
    await this.logWithLevel('debug', minOrInstanceId, message);
  }

  public static async info(minOrInstanceId: any, message: string) {
    await this.logWithLevel('info', minOrInstanceId, message);
  }

  public static async verbose(minOrInstanceId: any, message: string) {
    await this.logWithLevel('verbose', minOrInstanceId, message);
  }

  /**
   * Finds and update user agent information to a next available person.
   */
  public static async log(instance, kind: string, message: string): Promise<GuaribasLog> {
    if (GBConfigService.get('LOG_ON_STORAGE')) {
      message = message ? message.substring(0, 1023) : null;

      return await GuaribasLog.create(<GuaribasLog>{
        instanceId: instance ? instance : 0,
        message: message,
        kind: kind
      });
    }
  }
}