425 lines
21 KiB
JavaScript
425 lines
21 KiB
JavaScript
|
|
const path = require('path')
|
|
|
|
exports.newFileStorage = function newFileStorage(logger) {
|
|
|
|
const MODULE_NAME = 'FileStorage'
|
|
const MAX_RETRY = 30
|
|
const FAST_RETRY_TIME_IN_MILISECONDS = 500
|
|
const SLOW_RETRY_TIME_IN_MILISECONDS = 2000
|
|
|
|
if (logger === undefined) { // Dummy logger
|
|
logger = {}
|
|
function write() {
|
|
|
|
}
|
|
logger.write = write
|
|
}
|
|
|
|
let thisObject = {
|
|
getTextFile: getTextFile,
|
|
createTextFile: createTextFile,
|
|
deleteTextFile: deleteTextFile
|
|
}
|
|
|
|
return thisObject
|
|
|
|
function getTextFile(filePath, callBackFunction, noRetry, canUsePrevious) {
|
|
|
|
let currentRetryGetTextFile = 0
|
|
|
|
recursiveGetTextFile(filePath, callBackFunction, noRetry, canUsePrevious)
|
|
|
|
function recursiveGetTextFile(filePath, callBackFunction, noRetry, canUsePrevious) {
|
|
|
|
logger.write(MODULE_NAME, '[INFO] FileStorage -> getTextFile -> Entering Function.')
|
|
|
|
let fileDoesNotExist = false
|
|
|
|
/* Choose path for either bots or data */
|
|
let fileLocation
|
|
let mustBeJason
|
|
if (filePath.indexOf("/bots/") > 0) {
|
|
fileLocation = process.env.BOTS_PATH + '/' + filePath
|
|
mustBeJason = false
|
|
} else {
|
|
fileLocation = process.env.STORAGE_PATH + '/' + filePath
|
|
mustBeJason = true
|
|
}
|
|
|
|
try {
|
|
|
|
logger.write(MODULE_NAME, '[INFO] FileStorage -> getTextFile -> fileLocation: ' + fileLocation)
|
|
|
|
/* Here we actually write the file. */
|
|
const fs = require('fs')
|
|
fs.readFile(fileLocation, onFileRead)
|
|
|
|
function onFileRead(err, text) {
|
|
let retryTimeToUse = FAST_RETRY_TIME_IN_MILISECONDS
|
|
if (currentRetryGetTextFile > MAX_RETRY - 2) {
|
|
retryTimeToUse = SLOW_RETRY_TIME_IN_MILISECONDS
|
|
}
|
|
if (err) {
|
|
|
|
if (err.code === 'ENOENT') { // since files are deleted before being replaced, it can happen that it does not exist and after a retry it does.
|
|
if (noRetry === true) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> File does not exist. Not Retrying. ')
|
|
let customResponse = {
|
|
result: global.CUSTOM_FAIL_RESPONSE.result,
|
|
message: 'File does not exist.'
|
|
}
|
|
callBackFunction(customResponse)
|
|
return
|
|
}
|
|
|
|
fileDoesNotExist = true
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> File does not exist. Retrying. ')
|
|
setTimeout(retry, retryTimeToUse)
|
|
return
|
|
}
|
|
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> Error reading file -> err = ' + err.stack)
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> Error reading file -> filePath = ' + filePath)
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> Error reading file -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
return
|
|
}
|
|
|
|
/*
|
|
It might happen that we try to read a file just at the moment it is being written by another process. It that case we might get
|
|
an empty file. If we are not allowed to use the Previous version of the file in this case, then we will retry to read it again
|
|
a little bit later.
|
|
*/
|
|
if (text.toString() === "" && canUsePrevious !== true) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> Read and Empty File -> filePath = ' + filePath)
|
|
setTimeout(retry, retryTimeToUse)
|
|
return
|
|
}
|
|
|
|
if (mustBeJason === false) {
|
|
/* In this case there is nothing else to check. */
|
|
callBackFunction(global.DEFAULT_OK_RESPONSE, text.toString())
|
|
return
|
|
}
|
|
|
|
/*
|
|
We are going to check if the file is a valir JSON object
|
|
*/
|
|
try {
|
|
let jsonCheck = JSON.parse(text.toString())
|
|
|
|
/* The file was correctly read and could be parsed. */
|
|
callBackFunction(global.DEFAULT_OK_RESPONSE, text.toString())
|
|
return
|
|
|
|
} catch (err) {
|
|
|
|
if (canUsePrevious === true) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> Could read the file, but could not parse it as it is not a valid JSON. Will try to read the PREVIOUS version instead. -> file = ' + fileLocation)
|
|
|
|
fs.readFile(fileLocation + '.Previous.json', onPreviousFileRead)
|
|
|
|
function onPreviousFileRead(err, text) {
|
|
|
|
if (err) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> canUsePrevious -> Could not read the Previous file either. Giving up.')
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> canUsePrevious -> err = ' + err.stack)
|
|
callBackFunction(global.DEFAULT_FAIL_RESPONSE)
|
|
return
|
|
}
|
|
|
|
/* Returning the previous file */
|
|
callBackFunction(global.DEFAULT_OK_RESPONSE, text.toString())
|
|
return
|
|
}
|
|
} else {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> Could read the file, but could not parse it as it is not a valid JSON.')
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> onFileRead -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
} catch (err) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> Error writing file -> file = ' + fileLocation)
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> Error writing file -> err = ' + err.stack)
|
|
retry()
|
|
}
|
|
|
|
function retry() {
|
|
//console.log(new Date(), ' Retry #: ' + currentRetryGetTextFile, fileLocation )
|
|
if (currentRetryGetTextFile < MAX_RETRY) {
|
|
currentRetryGetTextFile++
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> retry -> Will try to read the file again -> Retry #: ' + currentRetryGetTextFile)
|
|
recursiveGetTextFile(filePath, callBackFunction, noRetry, canUsePrevious)
|
|
} else {
|
|
currentRetryGetTextFile = 0
|
|
|
|
if (fileDoesNotExist === true) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> getTextFile -> retry -> Max retries reached reading a file. File Not Found.')
|
|
let customResponse = {
|
|
result: global.CUSTOM_FAIL_RESPONSE.result,
|
|
message: 'File does not exist.'
|
|
}
|
|
callBackFunction(customResponse)
|
|
return
|
|
} else {
|
|
|
|
logger.write(MODULE_NAME, '[ERROR] FileStorage -> getTextFile -> retry -> Max retries reached reading a file. Giving up.')
|
|
logger.write(MODULE_NAME, '[ERROR] FileStorage -> getTextFile -> retry -> file = ' + fileLocation)
|
|
callBackFunction(global.DEFAULT_FAIL_RESPONSE)
|
|
return
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function createTextFile(filePath, fileContent, callBackFunction, keepPrevious) {
|
|
|
|
let currentRetryWriteTextFile = 0
|
|
|
|
recursiveCreateTextFile(filePath, fileContent, callBackFunction, keepPrevious)
|
|
|
|
function recursiveCreateTextFile(filePath, fileContent, callBackFunction, keepPrevious) {
|
|
|
|
logger.write(MODULE_NAME, '[INFO] FileStorage -> createTextFile -> Entering Function.')
|
|
|
|
/* Choose path for either logs or data */
|
|
let fileLocation
|
|
if (filePath.indexOf("/Logs/") > 0) {
|
|
fileLocation = process.env.LOG_PATH + '/' + filePath
|
|
} else {
|
|
fileLocation = process.env.STORAGE_PATH + '/' + filePath
|
|
}
|
|
|
|
try {
|
|
|
|
logger.write(MODULE_NAME, '[INFO] FileStorage -> createTextFile -> fileLocation: ' + fileLocation)
|
|
|
|
/* If necesary a folder or folders are created before writing the file to disk. */
|
|
let directoryPath = fileLocation.substring(0, fileLocation.lastIndexOf('/') + 1);
|
|
mkDirByPathSync(directoryPath)
|
|
|
|
/*
|
|
Here we write the file with a temporary name so as to avoid dirty read from other processes.
|
|
Then we delete the original file, if exists, and finally we rename the temporary into the original name.
|
|
*/
|
|
const fs = require('fs')
|
|
fs.writeFile(fileLocation + '.tmp', fileContent, onFileWritenn)
|
|
|
|
function onFileWritenn(err) {
|
|
let retryTimeToUse = FAST_RETRY_TIME_IN_MILISECONDS
|
|
if (currentRetryWriteTextFile > MAX_RETRY - 2) {
|
|
retryTimeToUse = SLOW_RETRY_TIME_IN_MILISECONDS
|
|
}
|
|
if (err) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> Error writing file -> file = ' + fileLocation + '.tmp')
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> Error writing file -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
} else {
|
|
|
|
if (keepPrevious === true) {
|
|
/*
|
|
In some cases, we are going to keep a copy of the previous version of the file being written. This will be usefull to recover from crashes
|
|
when the file written gets corrupted for any reason.
|
|
*/
|
|
fs.unlink(fileLocation + '.Previous.json', onUnlinked)
|
|
|
|
function onUnlinked(err) {
|
|
let code = ''
|
|
if (err) {
|
|
code = err.code
|
|
}
|
|
if (code !== '' && code !== 'ENOENT') {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> Error deleting file -> file = ' + fileLocation + '.Previous.json')
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> Error deleting file -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
return
|
|
}
|
|
|
|
/* Rename de Original into Previous */
|
|
fs.rename(fileLocation, fileLocation + '.Previous.json', onOriginalRenamed)
|
|
|
|
function onOriginalRenamed(err) {
|
|
let code = ''
|
|
if (err) {
|
|
code = err.code
|
|
}
|
|
if (code !== '' && code !== 'ENOENT') { // Unless the file does not exists we do this...
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> onOriginalRenamed -> Error renaming original file -> file = ' + fileLocation)
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> onOriginalRenamed -> Error renaming original file -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
return
|
|
}
|
|
|
|
/* Rename de Temp into Original */
|
|
fs.rename(fileLocation + '.tmp', fileLocation, onTempRenamed)
|
|
|
|
function onTempRenamed(err) {
|
|
if (err) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> onOriginalRenamed -> onTempRenamed -> Error renaming temp file -> file = ' + fileLocation + '.tmp')
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> onOriginalRenamed -> onTempRenamed -> Error renaming temp file -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
} else {
|
|
|
|
callBackFunction(global.DEFAULT_OK_RESPONSE)
|
|
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
|
|
/* In this case, there is no need to keep a copy of the file being replaced, so we just delete and that's it. */
|
|
fs.unlink(fileLocation , onUnlinked)
|
|
|
|
function onUnlinked(err) {
|
|
let code = ''
|
|
if (err) {
|
|
code = err.code
|
|
}
|
|
if (code !== '' && code !== 'ENOENT') {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> Error deleting file -> file = ' + fileLocation )
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> Error deleting file -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
return
|
|
}
|
|
|
|
/* Rename de Temp into Original */
|
|
fs.rename(fileLocation + '.tmp', fileLocation, onTempRenamed)
|
|
|
|
function onTempRenamed(err) {
|
|
if (err) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> onOriginalRenamed -> onTempRenamed -> Error renaming temp file -> file = ' + fileLocation + '.tmp')
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> onFileWriten -> onUnlinked -> onOriginalRenamed -> onTempRenamed -> Error renaming temp file -> err = ' + err.stack)
|
|
setTimeout(retry, retryTimeToUse)
|
|
} else {
|
|
|
|
callBackFunction(global.DEFAULT_OK_RESPONSE)
|
|
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
} catch (err) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> Error writing file -> file = ' + fileLocation)
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> Error writing file -> err = ' + err.stack)
|
|
retry()
|
|
}
|
|
|
|
function retry() {
|
|
if (currentRetryWriteTextFile < MAX_RETRY) {
|
|
currentRetryWriteTextFile++
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> createTextFile -> retry -> Will try to write the file again -> Retry #: ' + currentRetryWriteTextFile)
|
|
recursiveCreateTextFile(filePath, fileContent, callBackFunction, keepPrevious)
|
|
} else {
|
|
currentRetryWriteTextFile = 0
|
|
logger.write(MODULE_NAME, '[ERROR] FileStorage -> createTextFile -> retry -> Max retries reached writting a file. Giving up.')
|
|
logger.write(MODULE_NAME, '[ERROR] FileStorage -> createTextFile -> retry -> file = ' + fileLocation)
|
|
callBackFunction(global.DEFAULT_FAIL_RESPONSE)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function deleteTextFile(filePath, callBackFunction) {
|
|
|
|
let currentRetryDeleteTextFile = 0
|
|
|
|
recursiveDeleteTextFile(filePath, callBackFunction)
|
|
|
|
function recursiveDeleteTextFile(filePath, callBackFunction) {
|
|
logger.write(MODULE_NAME, '[INFO] FileStorage -> deleteTextFile -> Entering Function.')
|
|
|
|
/* Choose path for either logs or data */
|
|
let fileLocation
|
|
if (filePath.indexOf("/Logs/") > 0) {
|
|
fileLocation = process.env.LOG_PATH + '/' + filePath
|
|
} else {
|
|
fileLocation = process.env.STORAGE_PATH + '/' + filePath
|
|
}
|
|
|
|
try {
|
|
|
|
logger.write(MODULE_NAME, '[INFO] FileStorage -> deleteTextFile -> fileLocation: ' + fileLocation)
|
|
|
|
const fs = require('fs')
|
|
fs.unlink(fileLocation, onUnlinked)
|
|
|
|
function onUnlinked(err) {
|
|
let retryTimeToUse = FAST_RETRY_TIME_IN_MILISECONDS
|
|
if (currentRetryDeleteTextFile > MAX_RETRY - 2) {
|
|
retryTimeToUse = SLOW_RETRY_TIME_IN_MILISECONDS
|
|
}
|
|
if (err) {
|
|
if (callBackFunction !== undefined) {
|
|
callBackFunction(global.DEFAULT_FAIL_RESPONSE)
|
|
}
|
|
} else {
|
|
setTimeout(retry, retryTimeToUse)
|
|
}
|
|
}
|
|
} catch (err) {
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> deleteTextFile -> Error writing file -> file = ' + fileLocation)
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> deleteTextFile -> Error writing file -> err = ' + err.stack)
|
|
if (callBackFunction !== undefined) {
|
|
callBackFunction(global.DEFAULT_FAIL_RESPONSE)
|
|
}
|
|
}
|
|
|
|
function retry() {
|
|
if (currentRetryDeleteTextFile < MAX_RETRY) {
|
|
currentRetryDeleteTextFile++
|
|
logger.write(MODULE_NAME, '[WARN] FileStorage -> deleteTextFile -> retry -> Will try to delete the file again -> Retry #: ' + currentRetryDeleteTextFile)
|
|
recursiveDeleteTextFile(filePath, callBackFunction)
|
|
} else {
|
|
currentRetryDeleteTextFile = 0
|
|
logger.write(MODULE_NAME, '[ERROR] FileStorage -> deleteTextFile -> retry -> Max retries reached deleting a file. Giving up.')
|
|
logger.write(MODULE_NAME, '[ERROR] FileStorage -> deleteTextFile -> retry -> file = ' + fileLocation)
|
|
if (callBackFunction !== undefined) {
|
|
callBackFunction(global.DEFAULT_OK_RESPONSE)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Function to create folders of missing folders at any path. */
|
|
|
|
function mkDirByPathSync(targetDir, { isRelativeToScript = false } = {}) {
|
|
const sep = '/';
|
|
const initDir = path.isAbsolute(targetDir) ? sep : '';
|
|
const baseDir = isRelativeToScript ? __dirname : '.';
|
|
|
|
return targetDir.split(sep).reduce((parentDir, childDir) => {
|
|
const curDir = path.resolve(baseDir, parentDir, childDir);
|
|
try {
|
|
const fs = require('fs')
|
|
fs.mkdirSync(curDir);
|
|
} catch (err) {
|
|
if (err.code === 'EEXIST') { // curDir already exists!
|
|
return curDir;
|
|
}
|
|
|
|
// To avoid `EISDIR` error on Mac and `EACCES`-->`ENOENT` and `EPERM` on Windows.
|
|
if (err.code === 'ENOENT') { // Throw the original parentDir error on curDir `ENOENT` failure.
|
|
throw new Error(`EACCES: permission denied, mkdir '${parentDir}'`);
|
|
}
|
|
|
|
const caughtErr = ['EACCES', 'EPERM', 'EISDIR'].indexOf(err.code) > -1;
|
|
if (!caughtErr || caughtErr && curDir === path.resolve(targetDir)) {
|
|
throw err; // Throw if it's just the last created dir.
|
|
}
|
|
}
|
|
|
|
return curDir;
|
|
}, initDir);
|
|
}
|
|
}
|