569369f927Add mount/unmount lifecycle on `VirtualFileSystem`, a handler registry that fs.js and fs/promises.js consult via `vfsState.handlers`, and a router that maps absolute paths to the VFS that owns them. When a VFS is mounted, the public `fs.*` and `fs/promises` APIs (including streams, `fs.watch`, and `opendir`) dispatch to the provider for paths under the mount point, and fall through to the real filesystem otherwise. Includes per-method dispatch tests, error-path coverage, multi-mount routing tests, and router unit tests. Ref: https://github.com/nodejs/node/pull/63115 Signed-off-by: Matteo Collina <hello@matteocollina.com> PR-URL: https://github.com/nodejs/node/pull/63537 Refs: https://github.com/nodejs/node/pull/63115 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Paolo Insogna <paolo@cowtech.it>
59 lines
1.9 KiB
JavaScript
59 lines
1.9 KiB
JavaScript
// Flags: --experimental-vfs
|
|
'use strict';
|
|
|
|
// fs.createReadStream dispatches through VFS, including the emitted 'open'
|
|
// event with the bitmask-encoded virtual fd.
|
|
|
|
const common = require('../common');
|
|
const assert = require('assert');
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const vfs = require('node:vfs');
|
|
|
|
const baseMountPoint = path.resolve('/tmp/vfs-createReadStream-' + process.pid);
|
|
let counter = 0;
|
|
function mounted() {
|
|
const mountPoint = baseMountPoint + '-' + (counter++);
|
|
const myVfs = vfs.create();
|
|
myVfs.mkdirSync('/src', { recursive: true });
|
|
myVfs.writeFileSync('/src/hello.txt', 'hello world');
|
|
myVfs.mount(mountPoint);
|
|
return { myVfs, mountPoint };
|
|
}
|
|
|
|
// Whole-file read
|
|
{
|
|
const { myVfs, mountPoint } = mounted();
|
|
const chunks = [];
|
|
const stream = fs.createReadStream(path.join(mountPoint, 'src/hello.txt'));
|
|
stream.on('data', (chunk) => chunks.push(chunk));
|
|
stream.on('end', common.mustCall(() => {
|
|
assert.strictEqual(Buffer.concat(chunks).toString(), 'hello world');
|
|
myVfs.unmount();
|
|
}));
|
|
}
|
|
|
|
// Slice with start + end (inclusive)
|
|
{
|
|
const { myVfs, mountPoint } = mounted();
|
|
const chunks = [];
|
|
const stream = fs.createReadStream(path.join(mountPoint, 'src/hello.txt'),
|
|
{ start: 0, end: 4 });
|
|
assert.strictEqual(stream.path, path.join(mountPoint, 'src/hello.txt'));
|
|
stream.on('data', (chunk) => chunks.push(chunk));
|
|
stream.on('end', common.mustCall(() => {
|
|
assert.strictEqual(Buffer.concat(chunks).toString(), 'hello');
|
|
myVfs.unmount();
|
|
}));
|
|
}
|
|
|
|
// 'open' event fires with a VFS fd
|
|
{
|
|
const { myVfs, mountPoint } = mounted();
|
|
const stream = fs.createReadStream(path.join(mountPoint, 'src/hello.txt'));
|
|
stream.on('open', common.mustCall((fd) => {
|
|
assert.notStrictEqual(fd & 0x40000000, 0);
|
|
}));
|
|
stream.on('end', common.mustCall(() => myVfs.unmount()));
|
|
stream.resume();
|
|
}
|