cypress-terminal-report/src/outputProcessor/BaseOutputProcessor.js

Better terminal and file output for cypress test logs.

"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    var desc = Object.getOwnPropertyDescriptor(m, k);
    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
      desc = { enumerable: true, get: function() { return m[k]; } };
    }
    Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
    if (k2 === undefined) k2 = k;
    o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
    Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
    o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
    if (mod && mod.__esModule) return mod;
    var result = {};
    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
    __setModuleDefault(result, mod);
    return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const fs = __importStar(require("fs"));
const path = __importStar(require("path"));
const CtrError_1 = __importDefault(require("../CtrError"));
class BaseOutputProcessor {
    constructor(file, options) {
        this.file = file;
        this.options = options;
        this.atChunk = 0;
        this.chunkSeparator = '';
        this.initialContent = '';
        this.size = 0;
        this.specChunksWritten = {};
        this.writeSpendTime = 0;
    }
    getTarget() {
        return this.file;
    }
    getSpentTime() {
        return this.writeSpendTime;
    }
    initialize() {
        // Unlink file on initialize to start clean. Also, this is required for custom
        // output processors provided as config to be able to define custom initial
        // content.
        if (fs.existsSync(this.file)) {
            fs.unlinkSync(this.file);
        }
    }
    prepareForWrite() {
        this.atChunk = 0;
        this.specChunksWritten = {};
        this.size = this.initialContent.length;
        this.writeSpendTime = 0;
        const basePath = path.dirname(this.file);
        if (!fs.existsSync(basePath)) {
            fs.mkdirSync(basePath, { recursive: true });
        }
        fs.writeFileSync(this.file, this.initialContent);
    }
    /** @type { import('./BaseOutputProcessor')['writeSpecChunk']} */
    writeSpecChunk(spec, chunk, pos = null) {
        const startTime = new Date().getTime();
        if (typeof chunk !== 'string') {
            throw new CtrError_1.default(`cypress-terminal-report: Expected string for write chunk on log file.`);
        }
        if (!fs.existsSync(this.file)) {
            this.prepareForWrite();
        }
        if (this.hasSpecChunkWritten(spec)) {
            this.replaceSpecChunk(spec, chunk);
        }
        else {
            if (this.atChunk > 0) {
                this.appendSeparator(pos);
            }
            pos = this.getAbsolutePositionFromRelative(pos);
            let writtenLength = this.writeAtPosition(chunk, pos);
            this.specChunksWritten[spec] = [pos, pos + writtenLength];
            this.atChunk++;
        }
        this.writeSpendTime += new Date().getTime() - startTime;
    }
    replaceSpecChunk(spec, chunk) {
        let oldChunkStart = this.specChunksWritten[spec][0];
        let oldChunkEnd = this.specChunksWritten[spec][1];
        let fd = fs.openSync(this.file, 'r+');
        let buffer = Buffer.alloc(this.size - oldChunkEnd, undefined, 'utf-8');
        fs.readSync(fd, buffer, 0, buffer.length, oldChunkEnd);
        let chunkBuffer = Buffer.from(chunk, 'utf8');
        let finalBuffer = Buffer.concat([chunkBuffer, buffer]);
        fs.writeSync(fd, finalBuffer, 0, finalBuffer.length, oldChunkStart);
        fs.closeSync(fd);
        this.specChunksWritten[spec] = [oldChunkStart, oldChunkStart + chunkBuffer.length];
        let sizeDiff = chunkBuffer.length - (oldChunkEnd - oldChunkStart);
        this.size += sizeDiff;
        if (0 > sizeDiff) {
            fs.truncateSync(this.file, this.size);
        }
    }
    appendSeparator(pos) {
        this.writeAtPosition(this.chunkSeparator, pos);
    }
    writeAtPosition(data, pos) {
        let dataBuffer = new Buffer(data, 'utf-8');
        let finalBuffer = dataBuffer;
        let fd = fs.openSync(this.file, 'r+');
        pos = this.getAbsolutePositionFromRelative(pos);
        if (pos !== this.size) {
            let buffer = Buffer.alloc(this.size - pos);
            fs.readSync(fd, buffer, 0, buffer.length, pos);
            finalBuffer = Buffer.concat([dataBuffer, buffer]);
        }
        fs.writeSync(fd, finalBuffer, 0, finalBuffer.length, pos);
        fs.closeSync(fd);
        this.size += dataBuffer.length;
        return dataBuffer.length;
    }
    getAbsolutePositionFromRelative(pos) {
        if (pos === null) {
            return this.size;
        }
        else if (pos < 0) {
            return Math.min(this.size, Math.max(0, this.size + pos));
        }
        return Math.min(this.size, pos);
    }
    hasSpecChunkWritten(spec) {
        return !!this.specChunksWritten[spec];
    }
}
exports.default = BaseOutputProcessor;