backfill/lib/audit.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const chokidar = require("chokidar");
const findUp = require("find-up");
const path = require("path");
const anymatch_1 = require("anymatch");
const backfill_logger_1 = require("backfill-logger");
const backfill_config_1 = require("backfill-config");
let changedFilesOutsideScope = [];
let changedFilesInsideScope = [];
let watcher;
function getGitRepositoryRoot(packageRoot) {
    const nearestGitFolder = findUp.sync(".git", {
        cwd: packageRoot,
        type: "directory"
    });
    if (nearestGitFolder) {
        // Return the parent folder of some/path/.git
        return path.join(nearestGitFolder, "..");
    }
    return packageRoot;
}
function addGlobstars(globPatterns) {
    const folders = globPatterns.map(p => path.posix.join("**", p, "**", "*"));
    const files = globPatterns.map(p => path.posix.join("**", p));
    return [...folders, ...files];
}
function initializeWatcher(packageRoot, internalCacheFolder, logFolder, outputFolder, hashGlobs) {
    // Trying to find the git root and using it as an approximation of code boundary
    const repositoryRoot = getGitRepositoryRoot(packageRoot);
    // Empty the arrays
    changedFilesOutsideScope = [];
    changedFilesInsideScope = [];
    backfill_logger_1.logger.info("Running in AUDIT mode");
    backfill_logger_1.logger.info(`[audit] Watching file changes in: ${repositoryRoot}`);
    backfill_logger_1.logger.info(`[audit] Backfill will cache folder: ${outputFolder}`);
    // Define globs
    const ignoreGlobs = addGlobstars([
        ".git",
        ".cache",
        logFolder,
        internalCacheFolder
    ]);
    const cacheFolderGlob = backfill_config_1.outputFolderAsArray(outputFolder).map(folder => path.posix.join("**", folder, "**"));
    watcher = chokidar
        .watch(hashGlobs, {
        ignored: ignoreGlobs,
        cwd: repositoryRoot,
        persistent: true,
        ignoreInitial: true,
        followSymlinks: false,
        usePolling: true
    })
        .on("all", (event, filePath) => {
        const logLine = `${filePath} (${event})`;
        backfill_logger_1.logger.silly(`[audit] File change: ${logLine}`);
        if (!anymatch_1.default(cacheFolderGlob, filePath)) {
            changedFilesOutsideScope.push(logLine);
        }
        else {
            changedFilesInsideScope.push(logLine);
        }
    });
}
exports.initializeWatcher = initializeWatcher;
exports.sideEffectWarningString = "[audit] The following files got changed outside of the scope of the folder to be cached:";
exports.sideEffectCallToActionString = "[audit] You should make sure that these changes are non-essential, as they would not be brought back on a cache-hit.";
exports.noSideEffectString = "[audit] All observed file changes were within the scope of the folder to be cached.";
async function delay(time) {
    return new Promise(resolve => {
        setTimeout(resolve, time);
    });
}
async function closeWatcher() {
    // Wait for one second before closing, giving time for file changes to propagate
    await delay(1000);
    if (changedFilesOutsideScope.length > 0) {
        backfill_logger_1.logger.warn(exports.sideEffectWarningString);
        changedFilesOutsideScope.forEach(file => backfill_logger_1.logger.warn(`- ${file}`));
        backfill_logger_1.logger.warn(exports.sideEffectCallToActionString);
    }
    else {
        backfill_logger_1.logger.info(exports.noSideEffectString);
    }
    watcher.close();
}
exports.closeWatcher = closeWatcher;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXVkaXQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYXVkaXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxxQ0FBcUM7QUFDckMsa0NBQWtDO0FBQ2xDLDZCQUE2QjtBQUM3Qix1Q0FBZ0M7QUFDaEMscURBQXlDO0FBQ3pDLHFEQUFzRDtBQUV0RCxJQUFJLHdCQUF3QixHQUFhLEVBQUUsQ0FBQztBQUM1QyxJQUFJLHVCQUF1QixHQUFhLEVBQUUsQ0FBQztBQUUzQyxJQUFJLE9BQTJCLENBQUM7QUFFaEMsU0FBUyxvQkFBb0IsQ0FBQyxXQUFtQjtJQUMvQyxNQUFNLGdCQUFnQixHQUFHLE1BQU0sQ0FBQyxJQUFJLENBQUMsTUFBTSxFQUFFO1FBQzNDLEdBQUcsRUFBRSxXQUFXO1FBQ2hCLElBQUksRUFBRSxXQUFXO0tBQ2xCLENBQUMsQ0FBQztJQUVILElBQUksZ0JBQWdCLEVBQUU7UUFDcEIsNkNBQTZDO1FBQzdDLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsRUFBRSxJQUFJLENBQUMsQ0FBQztLQUMxQztJQUVELE9BQU8sV0FBVyxDQUFDO0FBQ3JCLENBQUM7QUFFRCxTQUFTLFlBQVksQ0FBQyxZQUFzQjtJQUMxQyxNQUFNLE9BQU8sR0FBRyxZQUFZLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUMsRUFBRSxJQUFJLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUMzRSxNQUFNLEtBQUssR0FBRyxZQUFZLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFFOUQsT0FBTyxDQUFDLEdBQUcsT0FBTyxFQUFFLEdBQUcsS0FBSyxDQUFDLENBQUM7QUFDaEMsQ0FBQztBQUVELFNBQWdCLGlCQUFpQixDQUMvQixXQUFtQixFQUNuQixtQkFBMkIsRUFDM0IsU0FBaUIsRUFDakIsWUFBK0IsRUFDL0IsU0FBbUI7SUFFbkIsZ0ZBQWdGO0lBQ2hGLE1BQU0sY0FBYyxHQUFHLG9CQUFvQixDQUFDLFdBQVcsQ0FBQyxDQUFDO0lBRXpELG1CQUFtQjtJQUNuQix3QkFBd0IsR0FBRyxFQUFFLENBQUM7SUFDOUIsdUJBQXVCLEdBQUcsRUFBRSxDQUFDO0lBRTdCLHdCQUFNLENBQUMsSUFBSSxDQUFDLHVCQUF1QixDQUFDLENBQUM7SUFDckMsd0JBQU0sQ0FBQyxJQUFJLENBQUMscUNBQXFDLGNBQWMsRUFBRSxDQUFDLENBQUM7SUFDbkUsd0JBQU0sQ0FBQyxJQUFJLENBQUMsdUNBQXVDLFlBQVksRUFBRSxDQUFDLENBQUM7SUFFbkUsZUFBZTtJQUNmLE1BQU0sV0FBVyxHQUFHLFlBQVksQ0FBQztRQUMvQixNQUFNO1FBQ04sUUFBUTtRQUNSLFNBQVM7UUFDVCxtQkFBbUI7S0FDcEIsQ0FBQyxDQUFDO0lBRUgsTUFBTSxlQUFlLEdBQUcscUNBQW1CLENBQUMsWUFBWSxDQUFDLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxFQUFFLENBQ3JFLElBQUksQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQ3BDLENBQUM7SUFFRixPQUFPLEdBQUcsUUFBUTtTQUNmLEtBQUssQ0FBQyxTQUFTLEVBQUU7UUFDaEIsT0FBTyxFQUFFLFdBQVc7UUFDcEIsR0FBRyxFQUFFLGNBQWM7UUFDbkIsVUFBVSxFQUFFLElBQUk7UUFDaEIsYUFBYSxFQUFFLElBQUk7UUFDbkIsY0FBYyxFQUFFLEtBQUs7UUFDckIsVUFBVSxFQUFFLElBQUk7S0FDakIsQ0FBQztTQUNELEVBQUUsQ0FBQyxLQUFLLEVBQUUsQ0FBQyxLQUFLLEVBQUUsUUFBUSxFQUFFLEVBQUU7UUFDN0IsTUFBTSxPQUFPLEdBQUcsR0FBRyxRQUFRLEtBQUssS0FBSyxHQUFHLENBQUM7UUFDekMsd0JBQU0sQ0FBQyxLQUFLLENBQUMsd0JBQXdCLE9BQU8sRUFBRSxDQUFDLENBQUM7UUFFaEQsSUFBSSxDQUFDLGtCQUFRLENBQUMsZUFBZSxFQUFFLFFBQVEsQ0FBQyxFQUFFO1lBQ3hDLHdCQUF3QixDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztTQUN4QzthQUFNO1lBQ0wsdUJBQXVCLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1NBQ3ZDO0lBQ0gsQ0FBQyxDQUFDLENBQUM7QUFDUCxDQUFDO0FBakRELDhDQWlEQztBQUVZLFFBQUEsdUJBQXVCLEdBQ2xDLDBGQUEwRixDQUFDO0FBQ2hGLFFBQUEsNEJBQTRCLEdBQ3ZDLHNIQUFzSCxDQUFDO0FBQzVHLFFBQUEsa0JBQWtCLEdBQzdCLHFGQUFxRixDQUFDO0FBRXhGLEtBQUssVUFBVSxLQUFLLENBQUMsSUFBWTtJQUMvQixPQUFPLElBQUksT0FBTyxDQUFDLE9BQU8sQ0FBQyxFQUFFO1FBQzNCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDNUIsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDO0FBRU0sS0FBSyxVQUFVLFlBQVk7SUFDaEMsZ0ZBQWdGO0lBQ2hGLE1BQU0sS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRWxCLElBQUksd0JBQXdCLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtRQUN2Qyx3QkFBTSxDQUFDLElBQUksQ0FBQywrQkFBdUIsQ0FBQyxDQUFDO1FBQ3JDLHdCQUF3QixDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsRUFBRSxDQUFDLHdCQUFNLENBQUMsSUFBSSxDQUFDLEtBQUssSUFBSSxFQUFFLENBQUMsQ0FBQyxDQUFDO1FBQ25FLHdCQUFNLENBQUMsSUFBSSxDQUFDLG9DQUE0QixDQUFDLENBQUM7S0FDM0M7U0FBTTtRQUNMLHdCQUFNLENBQUMsSUFBSSxDQUFDLDBCQUFrQixDQUFDLENBQUM7S0FDakM7SUFFRCxPQUFPLENBQUMsS0FBSyxFQUFFLENBQUM7QUFDbEIsQ0FBQztBQWJELG9DQWFDIn0=