node-red/packages/node_modules/@node-red/runtime/lib/storage/localfilesystem/util.js

/**
 * Copyright JS Foundation and other contributors, http://js.foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 **/

const fs = require('fs-extra');
const fspath = require('path');

const log = require("@node-red/util").log;

function parseJSON(data) {
    if (data.charCodeAt(0) === 0xFEFF) {
        data = data.slice(1)
    }
    return JSON.parse(data);
}
function readFile(path,backupPath,emptyResponse,type) {
    return new Promise(function(resolve) {
        fs.readFile(path,'utf8',function(err,data) {
            if (!err) {
                if (data.length === 0) {
                    log.warn(log._("storage.localfilesystem.empty",{type:type}));
                    try {
                        var backupStat = fs.statSync(backupPath);
                        if (backupStat.size === 0) {
                            // Empty flows, empty backup - return empty flow
                            return resolve(emptyResponse);
                        }
                        // Empty flows, restore backup
                        log.warn(log._("storage.localfilesystem.restore",{path:backupPath,type:type}));
                        fs.copy(backupPath,path,function(backupCopyErr) {
                            if (backupCopyErr) {
                                // Restore backup failed
                                log.warn(log._("storage.localfilesystem.restore-fail",{message:backupCopyErr.toString(),type:type}));
                                resolve([]);
                            } else {
                                // Loop back in to load the restored backup
                                resolve(readFile(path,backupPath,emptyResponse,type));
                            }
                        });
                        return;
                    } catch(backupStatErr) {
                        // Empty flow file, no back-up file
                        return resolve(emptyResponse);
                    }
                }
                try {
                    return resolve(parseJSON(data));
                } catch(parseErr) {
                    log.warn(log._("storage.localfilesystem.invalid",{type:type}));
                    return resolve(emptyResponse);
                }
            } else {
                if (type === 'flow') {
                    log.info(log._("storage.localfilesystem.create",{type:type}));
                }
                resolve(emptyResponse);
            }
        });
    });
}

const writeFileLocks = {}

module.exports = {
    /**
    * Write content to a file using UTF8 encoding.
    * This forces a fsync before completing to ensure
    * the write hits disk.
    */
    writeFile: async function(path,content,backupPath) {
        if (!writeFileLocks[path]) {
            writeFileLocks[path] = Promise.resolve()
        }
        const result = writeFileLocks[path].then(async () => {
            var backupPromise;
            if (backupPath && fs.existsSync(path)) {
                await fs.copy(path,backupPath);
                log.trace(`utils.writeFile - copied ${path} TO ${backupPath}`)
            }

            const dirname = fspath.dirname(path);
            const tempFile = `${path}.$$$`;
            await fs.ensureDir(dirname)

            await new Promise(function(resolve,reject) {
                var stream = fs.createWriteStream(tempFile);
                stream.on('open',function(fd) {
                    stream.write(content,'utf8',function() {
                        fs.fsync(fd,function(err) {
                            if (err) {
                                log.warn(log._("storage.localfilesystem.fsync-fail",{path: tempFile, message: err.toString()}));
                            }
                            stream.end(resolve);
                        });
                    });
                });
                stream.on('error',function(err) {
                    log.warn(log._("storage.localfilesystem.fsync-fail",{path: tempFile, message: err.toString()}));
                    reject(err);
                });
            })
            
            log.trace(`utils.writeFile - written content to ${tempFile}`)
            
            await new Promise(function(resolve,reject) {
                fs.rename(tempFile,path,err => {
                    if (err) {
                        log.warn(log._("storage.localfilesystem.fsync-fail",{path: path, message: err.toString()}));
                        return reject(err);
                    }
                    log.trace(`utils.writeFile - renamed ${tempFile} to ${path}`)
                    resolve();
                })
            })
        })
        writeFileLocks[path] = result.catch(() => {})
        return result
    },
    readFile: readFile,

    parseJSON: parseJSON
}