????
Your IP : 18.191.147.142
import { PlatformTools } from "../platform/PlatformTools";
export class AbstractLogger {
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
constructor(options) {
this.options = options;
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Logs query and parameters used in it.
*/
logQuery(query, parameters, queryRunner) {
if (!this.isLogEnabledFor("query")) {
return;
}
this.writeLog("query", {
type: "query",
prefix: "query",
message: query,
format: "sql",
parameters,
}, queryRunner);
}
/**
* Logs query that is failed.
*/
logQueryError(error, query, parameters, queryRunner) {
if (!this.isLogEnabledFor("query-error")) {
return;
}
this.writeLog("warn", [
{
type: "query-error",
prefix: "query failed",
message: query,
format: "sql",
parameters,
},
{
type: "query-error",
prefix: "error",
message: error,
},
], queryRunner);
}
/**
* Logs query that is slow.
*/
logQuerySlow(time, query, parameters, queryRunner) {
if (!this.isLogEnabledFor("query-slow")) {
return;
}
this.writeLog("warn", [
{
type: "query-slow",
prefix: "query is slow",
message: query,
format: "sql",
parameters,
additionalInfo: {
time,
},
},
{
type: "query-slow",
prefix: "execution time",
message: time,
},
], queryRunner);
}
/**
* Logs events from the schema build process.
*/
logSchemaBuild(message, queryRunner) {
if (!this.isLogEnabledFor("schema-build")) {
return;
}
this.writeLog("schema", {
type: "schema-build",
message,
}, queryRunner);
}
/**
* Logs events from the migration run process.
*/
logMigration(message, queryRunner) {
if (!this.isLogEnabledFor("migration")) {
return;
}
this.writeLog("log", {
type: "migration",
message,
}, queryRunner);
}
/**
* Perform logging using given logger, or by default to the console.
* Log has its own level and message.
*/
log(level, message, queryRunner) {
switch (level) {
case "log":
if (!this.isLogEnabledFor("log")) {
return;
}
this.writeLog("log", {
type: "log",
message,
}, queryRunner);
break;
case "info":
if (!this.isLogEnabledFor("info")) {
return;
}
this.writeLog("info", {
type: "info",
prefix: "info",
message,
}, queryRunner);
break;
case "warn":
if (!this.isLogEnabledFor("warn")) {
return;
}
this.writeLog("warn", {
type: "warn",
message,
}, queryRunner);
break;
}
}
// -------------------------------------------------------------------------
// Protected Methods
// -------------------------------------------------------------------------
/**
* Check is logging for level or message type is enabled.
*/
isLogEnabledFor(type) {
switch (type) {
case "query":
return (this.options === "all" ||
this.options === true ||
(Array.isArray(this.options) &&
this.options.indexOf("query") !== -1));
case "error":
case "query-error":
return (this.options === "all" ||
this.options === true ||
(Array.isArray(this.options) &&
this.options.indexOf("error") !== -1));
case "query-slow":
return true;
case "schema":
case "schema-build":
return (this.options === "all" ||
(Array.isArray(this.options) &&
this.options.indexOf("schema") !== -1));
case "migration":
return true;
case "log":
return (this.options === "all" ||
(Array.isArray(this.options) &&
this.options.indexOf("log") !== -1));
case "info":
return (this.options === "all" ||
(Array.isArray(this.options) &&
this.options.indexOf("info") !== -1));
case "warn":
return (this.options === "all" ||
(Array.isArray(this.options) &&
this.options.indexOf("warn") !== -1));
default:
return false;
}
}
/**
* Prepare and format log messages
*/
prepareLogMessages(logMessage, options) {
options = {
...{
addColonToPrefix: true,
appendParameterAsComment: true,
highlightSql: true,
},
...options,
};
const messages = Array.isArray(logMessage) ? logMessage : [logMessage];
for (let message of messages) {
if (typeof message !== "object") {
message = {
message,
};
}
if (message.format === "sql") {
let sql = String(message.message);
if (options.appendParameterAsComment &&
message.parameters &&
message.parameters.length) {
sql += ` -- PARAMETERS: ${this.stringifyParams(message.parameters)}`;
}
if (options.highlightSql) {
sql = PlatformTools.highlightSql(sql);
}
message.message = sql;
}
if (options.addColonToPrefix && message.prefix) {
message.prefix += ":";
}
}
return messages;
}
/**
* Converts parameters to a string.
* Sometimes parameters can have circular objects and therefor we are handle this case too.
*/
stringifyParams(parameters) {
try {
return JSON.stringify(parameters);
}
catch (error) {
// most probably circular objects in parameters
return parameters;
}
}
}
//# sourceMappingURL=AbstractLogger.js.map