2022-08-13 12:18:38 +00:00
|
|
|
//Loguix - Système de log simplifié
|
|
|
|
//Concu par Raphael PICOT - Raphix
|
2023-09-23 08:53:38 +00:00
|
|
|
//GIT : https://git.raphix.fr/lib/loguix
|
2022-08-13 12:18:38 +00:00
|
|
|
|
|
|
|
const fs = require("fs")
|
2023-09-23 08:53:38 +00:00
|
|
|
const path = require("path")
|
|
|
|
const basic = require("./basics")
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
var isSetup = false
|
|
|
|
var logInstance = new Map()
|
|
|
|
var logStream = null
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2023-10-21 14:59:42 +00:00
|
|
|
/**
|
2024-01-13 15:09:29 +00:00
|
|
|
* Configuration du module
|
|
|
|
* @param {string} logsDir
|
|
|
|
* @param {string} packageJsonPath
|
2023-10-21 14:59:42 +00:00
|
|
|
*/
|
2024-01-13 15:09:29 +00:00
|
|
|
module.exports.setup = function(logsDir, packageJsonPath) {
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
if(!isSetup) {
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
if(!logsDir) {
|
|
|
|
return new Error("[Loguix] - Error in Setup : MISS_LOGS_DIR")
|
|
|
|
|
|
|
|
}
|
|
|
|
if(!fs.existsSync(logsDir + path.sep)) {
|
|
|
|
fs.mkdir(logsDir, (err) => {
|
|
|
|
if(!err) {
|
|
|
|
|
|
|
|
|
|
|
|
console.log("[Logs] - Dossier de logs crée ! !")
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
|
|
|
console.log("[Logs] - Erreur d'écriture par manque de permission ")
|
|
|
|
console.log(err)
|
|
|
|
}
|
|
|
|
|
|
|
|
})
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
logStream = fs.createWriteStream(logsDir + path.sep + basic.getDate(true) + ".log", {
|
|
|
|
flags: 'a'
|
|
|
|
});
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
var nameOfPackage = "Unknown"
|
|
|
|
var versionOfPackage = "-.-.-"
|
|
|
|
|
|
|
|
try {
|
|
|
|
const packageJson = fs.readFileSync(packageJsonPath)
|
|
|
|
const packageJsonParsed = JSON.parse(packageJson)
|
|
|
|
nameOfPackage = packageJsonParsed.name
|
|
|
|
versionOfPackage = packageJsonParsed.version
|
|
|
|
} catch (error) {
|
|
|
|
console.log("[Loguix] - Error in Setup : INVALID_PACKAGE_JSON")
|
|
|
|
console.log(error)
|
|
|
|
}
|
2022-08-13 17:05:19 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
const packageJson = fs.readFileSync(packageJsonPath)
|
|
|
|
|
|
|
|
logStream.write("[" + nameOfPackage + "@"+ versionOfPackage + "] - [" + basic.getDate(true) + "]" + "\n")
|
|
|
|
logStream.write("----------------------------------------------------------------" + "\n")
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
process.on('uncaughtException', (err) => {
|
|
|
|
console.error("["+ "FATAL" + "] - The application has encountered an error ! Please Restart ! #E = " + err + "\n")
|
|
|
|
console.error(err)
|
|
|
|
logStream.write("[" + basic.getDate() + "] - ["+ "FATAL" + "] - The application has encountered an error ! Please Restart ! #E = " + err + "\n")
|
|
|
|
logStream.end( "["+ "UNCAUGHT_EXCEPTION" + "]" + " - [END OF LOGS] - [" + basic.getDate() + ']')
|
|
|
|
logStream.close()
|
|
|
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
|
|
process.on('beforeExit', (err) => {
|
|
|
|
logStream.end( "["+ "BEFORE_EXIT" + "]" + " - [END OF LOGS] - [" + basic.getDate(true) + ']')
|
|
|
|
logStream.close()
|
|
|
|
|
|
|
|
});
|
2022-08-13 17:05:19 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
isSetup = true
|
2023-09-23 08:53:38 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
} else {
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2024-01-13 15:09:29 +00:00
|
|
|
console.log("Loguix is already configure")
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
|
|
|
|
|
2022-08-13 12:18:38 +00:00
|
|
|
}
|
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
/**
|
2023-10-21 15:23:33 +00:00
|
|
|
* Déclare une nouvelle section
|
|
|
|
* @param {string} typeName Nom de la section associé
|
2023-09-23 08:53:38 +00:00
|
|
|
*/
|
|
|
|
module.exports.LogType = class {
|
|
|
|
|
|
|
|
constructor(typeName) {
|
|
|
|
this.type = typeName;
|
|
|
|
this.steps = new Map()
|
|
|
|
this.step = this.initializeStep()
|
|
|
|
logInstance.set(typeName, this)
|
|
|
|
}
|
2022-08-13 17:05:19 +00:00
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
log(txt) {
|
2022-08-13 17:05:19 +00:00
|
|
|
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2022-08-13 17:05:19 +00:00
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
var logtext = "[" + this.type + "] - [INFO] - " + txt
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
|
|
|
|
|
|
|
|
2022-08-13 17:05:19 +00:00
|
|
|
}
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
warn(txt) {
|
|
|
|
|
|
|
|
var logtext = "[" + this.type + "] - [WARN] - " + txt
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
|
|
|
|
|
|
|
}
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
error(txt) {
|
2022-08-13 12:18:38 +00:00
|
|
|
|
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
var logtext = "[" + this.type + "] - [ERROR] - " + txt
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
}
|
2022-08-13 12:18:38 +00:00
|
|
|
|
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
initializeStep() {
|
|
|
|
const parent = this;
|
|
|
|
return {
|
|
|
|
init: function(id, desc) {
|
|
|
|
parent.steps.set(id, desc)
|
|
|
|
var logtext = "[" + parent.type + "] - [INFO] - [STEP] - " + desc + " - En cours ..."
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
|
|
|
|
|
|
|
},
|
|
|
|
end: function(id) {
|
|
|
|
|
|
|
|
if(parent.steps.has(id)) {
|
|
|
|
|
|
|
|
var logtext = "[" + parent.type + "] - [INFO] - [STEP] - " + parent.steps.get(id) + " - Terminé !"
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
|
|
|
parent.steps.delete(id)
|
|
|
|
} else {
|
|
|
|
|
|
|
|
var logtext = "[" + parent.type + "] - [WARN] - [STEP] - '" + id + "' n'est pas enregistré en tant qu'étape !"
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
},
|
|
|
|
error: function(id, errorDesc) {
|
|
|
|
|
|
|
|
if(parent.steps.has(id)) {
|
|
|
|
|
|
|
|
var logtext = "[" + parent.type + "] - [ERROR] - [STEP] - " + parent.steps.get(id) + " - Une erreur a été rencontré dans l'étape ! : #E = " + errorDesc
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
|
|
|
parent.steps.delete(id)
|
|
|
|
} else {
|
|
|
|
|
|
|
|
var logtext = "[" + parent.type + "] - [WARN] - [STEP] - '" + id + "' n'est pas enregistré en tant qu'étape !"
|
2024-01-13 15:09:29 +00:00
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
2023-09-23 08:53:38 +00:00
|
|
|
console.log(logtext)
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|
2022-08-13 12:18:38 +00:00
|
|
|
|
2023-09-23 08:53:38 +00:00
|
|
|
}
|
2024-01-13 15:09:29 +00:00
|
|
|
|
|
|
|
module.exports.getInstance = function (name) {
|
|
|
|
|
|
|
|
if(logInstance.has(name)) {
|
|
|
|
|
|
|
|
return logInstance.get(name)
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
|
|
|
var logtext = "[Logs] - [ERROR] - '" + name + "' n'est pas enregistré en tant qu'instance de log !"
|
|
|
|
logStream.write("[" + basic.getDate() + "] - " + logtext + "\n")
|
|
|
|
console.error(logtext)
|
|
|
|
|
|
|
|
return null
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|