Class KeyValueFileSystemEntry

packages/memory-storage/src/fs/key-value-store/fs.ts:15–95

import type { CreateStorageImplementationOptions } from '.';

export class KeyValueFileSystemEntry implements StorageImplementation<InternalKeyRecord> {
    private storeDirectory: string;
    private writeMetadata: boolean;

    private filePath!: string;
    private fileMetadataPath!: string;
    private rawRecord!: Omit<InternalKeyRecord, 'value'>;
    private fsQueue = new AsyncQueue();

    constructor(options: CreateStorageImplementationOptions) {
        this.storeDirectory = options.storeDirectory;
        this.writeMetadata = options.writeMetadata;
    }

    async get(): Promise<InternalKeyRecord> {
        await this.fsQueue.wait();
        let file: Buffer | string;

        try {
            file = await readFile(this.filePath);
        } catch {
            try {
                // Try without extension
                file = await readFile(resolve(this.storeDirectory, this.rawRecord.key));
                memoryStorageLog.warning(
                    [
                        `Key-value entry "${this.rawRecord.key}" for store ${basename(
                            this.storeDirectory,
                        )} does not have a file extension, assuming it as text.`,
                        'If you want to have correct interpretation of the file, you should add a file extension to the entry.',
                    ].join('\n'),
                );
                file = file.toString('utf-8');
            } catch {
                // This is impossible to happen, but just in case
                throw new Error(`Could not find file at ${this.filePath}`);
            }
        } finally {
            this.fsQueue.shift();
        }

        return {
            ...this.rawRecord,
            value: file,
        };
    }

    async update(data: InternalKeyRecord) {
        await this.fsQueue.wait();
        const contentType = mime.contentType(data.key);
        const fileName =
            // the content type might include charset, e.g. `text/html; charset=utf-8`, so we check via `startsWith` instead of `===`
            contentType && data.contentType && contentType.startsWith(data.contentType)
                ? data.key
                : `${data.key}.${data.extension}`;

        this.filePath ??= resolve(this.storeDirectory, fileName);
        this.fileMetadataPath ??= resolve(this.storeDirectory, `${data.key}.__metadata__.json`);