sati.n-api.index-file/lib/idx/writer.ts

// src/index-file/writer.ts
import * as fs from 'node:fs';
import { INDEX_HEADER_SIZE, INDEX_ENTRY_SIZE, FLAG_VALID } from './constants.js';
import { IndexProtocol } from './protocol.js';
import { IndexFileOptionsRequired } from './types.js';

export class IndexWriter {
    private fd: number | null = null;
    private headerBuf: Buffer | null = null;
    private entryBuf: Buffer | null = null;

    private writtenCnt = 0;
    private dataFileSize = 0n;
    private latestSequence = 0;

    private path: string | null = null;
    private fileSize: number = 0;

    // see IndexFileOptions
    private maxEntries: number = 0;
    private autoIncrementSequence: boolean = false;

    constructor(opt: IndexFileOptionsRequired) {
        // Empty constructor - maxEntries provided in open()
        this.maxEntries = opt.maxEntries;
        this.autoIncrementSequence = opt.autoIncrementSequence;
    }

    open(path: string, forceTruncate: boolean = false): number {
        this.path = path;

        const isNew = !fs.existsSync(this.path);

        if (isNew || forceTruncate) {
            // New file: use provided values
            this.fileSize = IndexProtocol.calcFileSize(this.maxEntries);
            this.writtenCnt = 0;
            this.dataFileSize = 0n;
            this.latestSequence = 0;

            this.fd = fs.openSync(this.path, 'w+');
            fs.ftruncateSync(this.fd, this.fileSize);

            // Allocate buffers for header and entry
            this.headerBuf = Buffer.alloc(INDEX_HEADER_SIZE);
            this.entryBuf = Buffer.alloc(INDEX_ENTRY_SIZE);

            const header = IndexProtocol.createHeader(this.maxEntries, this.autoIncrementSequence);
            header.copy(this.headerBuf, 0);

            // Write header to file
            fs.writeSync(this.fd, this.headerBuf, 0, INDEX_HEADER_SIZE, 0);
            fs.fsyncSync(this.fd);
        } else {
            // Existing file: read header first
            this.fd = fs.openSync(this.path, 'r+');

            try {
                this.headerBuf = Buffer.alloc(INDEX_HEADER_SIZE);
                this.entryBuf = Buffer.alloc(INDEX_ENTRY_SIZE);

                fs.readSync(this.fd, this.headerBuf, 0, INDEX_HEADER_SIZE, 0);
                const header = IndexProtocol.readHeader(this.headerBuf);

                if (this.maxEntries !== header.entryCount) {
                    throw new Error(
                        `maxEntries mismatch: provided ${this.maxEntries} but file has ${header.entryCount}`
                    );
                }
                if (this.autoIncrementSequence !== header.autoIncrementSequence) {
                    throw new Error(
                        `autoIncrementSequence mismatch: provided ${this.autoIncrementSequence} but file has ${header.autoIncrementSequence}`
                    );
                }

                const expectFileSize = IndexProtocol.calcFileSize(this.maxEntries);
                const calcedFileSize = IndexProtocol.calcFileSize(header.entryCount);
                if (expectFileSize !== calcedFileSize) {
                    // if (opt.version !== header.version) { 버전이 다른거니까 어떻게 처리 할지는 추후 고민 TODO }
                    throw new Error(
                        `Indexfile size calc is invalid : provided ${expectFileSize} but file has ${calcedFileSize}`
                    );
                }

                this.fileSize = calcedFileSize;
                this.writtenCnt = header.writtenCnt;
                this.dataFileSize = header.dataFileSize;
                this.latestSequence = header.latestSequence;
            } catch (error) {
                // Clean up resources on error
                if (this.fd !== null) {
                    fs.closeSync(this.fd);
                    this.fd = null;
                }
                this.headerBuf = null;
                this.entryBuf = null;
                throw error;
            }
        }

        return this.writtenCnt;
    }

    write(
        offset: bigint,
        length: number,
        sequence?: number,
        timestamp?: bigint
    ): boolean {
        if (!this.entryBuf || this.fd === null) throw new Error('Index file not opened');
        if (this.writtenCnt >= this.maxEntries) {
            throw new Error(`Data count exceed provide : ${this.writtenCnt + 1} - max : ${this.maxEntries}`);
        }

        // Calculate sequence
        let seq: number;
        if (!this.autoIncrementSequence) {
            if (sequence === undefined) {
                throw new Error('sequence is required when autoIncrementSequence is false');
            }
            seq = sequence;
        } else {
            seq = this.writtenCnt + 1;
        }

        const ts = timestamp ?? BigInt(Date.now()) * 1000000n;

        // Create a temporary buffer for this entry
        const tempBuf = Buffer.alloc(INDEX_HEADER_SIZE + (this.writtenCnt + 1) * INDEX_ENTRY_SIZE);

        // Write entry to temp buffer
        IndexProtocol.writeEntry(tempBuf, this.writtenCnt, {
            sequence: seq,
            timestamp: ts,
            offset,
            length,
            flags: FLAG_VALID,
        });

        // Calculate file offset for this entry
        const fileOffset = INDEX_HEADER_SIZE + this.writtenCnt * INDEX_ENTRY_SIZE;

        // Write entry to file
        fs.writeSync(this.fd, tempBuf, fileOffset, INDEX_ENTRY_SIZE, fileOffset);

        this.writtenCnt++;
        this.latestSequence = seq;

        const newDataEnd = offset + BigInt(length);
        if (newDataEnd > this.dataFileSize) {
            this.dataFileSize = newDataEnd;
        }

        return true;
    }

    getLatestSequence(): number {
        return this.latestSequence;
    }

    syncHeader(): void {
        if (!this.headerBuf || this.fd === null) return;

        // Update header counts
        IndexProtocol.updateHeaderCounts(
            this.headerBuf,
            this.writtenCnt,
            this.dataFileSize,
            this.latestSequence
        );

        // Write header to file
        fs.writeSync(this.fd, this.headerBuf, 0, INDEX_HEADER_SIZE, 0);
    }

    syncAll(): void {
        if (this.fd === null) return;

        // Sync header first
        this.syncHeader();

        // Sync all file changes to disk
        fs.fsyncSync(this.fd);
    }

    close(): void {
        if (this.fd === null) return;

        // 1. Sync all changes
        this.syncAll();

        // 2. Close file descriptor
        fs.closeSync(this.fd);
        this.fd = null;

        // 3. Clean up buffers
        this.headerBuf = null;
        this.entryBuf = null;
    }

    getStats() {
        return {
            path: this.path,
            writtenCnt: this.writtenCnt,
            dataFileSize: this.dataFileSize,
            latestSequence: this.latestSequence,
        };
    }
}