feat: node fs module

[Puellaquae]

• LFX Workspace: Node API support for WasmEdge QuickJS WasmEdge/WasmEdge#1834

• FileHandle
• fsPromises.access
• fsPromises.appendFile
• fsPromises.chmod Unsupported
• fsPromises.chown Unsupported
• fsPromises.copyFile
• fsPromises.cp
• fsPromises.lchmod Unsupported
• fsPromises.lchown Unsupported
• fsPromises.lutimes
• fsPromises.link
• fsPromises.lstat
• fsPromises.mkdir
• fsPromises.mkdtemp
• fsPromises.open
• fsPromises.opendir
• fsPromises.readdir
• fsPromises.readFile
• fsPromises.readlink
• fsPromises.realpath
• fsPromises.rename
• fsPromises.rmdir
• fsPromises.rm
• fsPromises.stat
• fsPromises.symlink
• fsPromises.truncate
• fsPromises.unlink
• fsPromises.utimes
• fsPromises.watch
• fsPromises.writeFile
• fsPromises.constants
• fs.access
• fs.accessSync
• fs.appendFile
• fs.appendFileSync
• fs.chmod Unsupported
• fs.chmodSync Unsupported
• fs.chown Unsupported
• fs.chownSync Unsupported
• fs.close
• fs.closeSync
• fs.copyFile
• fs.copyFileSync
• fs.cp
• fs.cpSync
• fs.createReadStream
• fs.createWriteStream
• fs.exists
• fs.existsSync
• fs.fchmod Unsupported
• fs.fchmodSync Unsupported
• fs.fchown Unsupported
• fs.fchownSync Unsupported
• fs.fdatasync
• fs.fdatasyncSync
• fs.fstat
• fs.fstatSync
• fs.fsync
• fs.fsyncSync
• fs.ftruncate
• fs.ftruncateSync
• fs.futimes
• fs.futimesSync
• fs.lchmod Unsupported
• fs.lchmodSync Unsupported
• fs.lchown Unsupported
• fs.lchownSync Unsupported
• fs.link
• fs.linkSync
• fs.lstat
• fs.lstatSync
• fs.lutimes
• fs.lutimesSync
• fs.mkdir
• fs.mkdirSync
• fs.mkdtemp
• fs.mkdtempSync
• fs.open
• fs.openSync
• fs.opendir
• fs.opendirSync
• fs.read
• fs.readSync
• fs.readdir
• fs.readdirSync
• fs.readFile
• fs.readFileSync
• fs.readlink
• fs.readlinkSync
• fs.readv
• fs.readvSync
• fs.realpath
• fs.realpathSync
• fs.rename
• fs.renameSync
• fs.rmdir
• fs.rmdirSync
• fs.rm
• fs.rmSync
• fs.stat
• fs.statSync
• fs.symlink
• fs.symlinkSync
• fs.truncate
• fs.truncateSync
• fs.unlink
• fs.unlinkSync
• fs.unwatchFile Unsupported
• fs.utimes
• fs.utimesSync
• fs.watch Unsupported
• fs.watchFile Unsupported
• fs.write
• fs.writeSync
• fs.writeFile
• fs.writeFileSync
• fs.writev
• fs.writevSync
• fs.Dir
• fs.Dirent
• fs.FSWatcher Unsupported
• fs.StatWatcher Unsupported
• fs.ReadStream
• fs.Stats
• fs.WriteStream
• fs.constants

[juntao]

@Puellaquae Does nodejs have a CI test suite we can run to validate those API implementations? Thanks!

[Puellaquae]

@Puellaquae Does nodejs have a CI test suite we can run to validate those API implementations? Thanks!

There seems no test suite for node lib api in nodejs, while deno has some test suite for its node api implementations.

[juntao]

Is it possible for us to run the deno tests then? Thanks.

[Puellaquae]

It need some works before running.

[Puellaquae]

@L-jasmine poll fd write will cause a infinite loop in ubuntu, while in WSL1 it won't happen.

fn main() -> Result<(), wasi::Errno> {
    unsafe {
        let fd = wasi::path_open(
            3,
            0,
            "test.txt",
            0,
            wasi::RIGHTS_FD_WRITE | wasi::RIGHTS_POLL_FD_READWRITE,
            0,
            wasi::FDFLAGS_NONBLOCK,
        )?;
        println!("{}", fd);
        let subs = vec![wasi::Subscription {
            userdata: 0,
            u: wasi::SubscriptionU {
                tag: 2,
                u: wasi::SubscriptionUU {
                    fd_write: wasi::SubscriptionFdReadwrite {
                        file_descriptor: fd as u32,
                    },
                },
            },
        }];
        let mut events = vec![wasi::Event {
            userdata: 0,
            error: wasi::ERRNO_SUCCESS,
            type_: wasi::EVENTTYPE_FD_WRITE,
            fd_readwrite: wasi::EventFdReadwrite {
                nbytes: 0,
                flags: 0,
            },
        }];
        let n = wasi::poll_oneoff(subs.as_ptr(), events.as_mut_ptr(), subs.len())?;
        println!("{}", n);
    };
    Ok(())
}

@hydai

poll fd read also has same problem.

[Puellaquae]

path_readlink is not work well

fn main() -> Result<(), wasi::Errno> {
    unsafe {
        wasi::path_symlink("./test.txt", 3, "./test-link.txt")?;
        let stat = wasi::path_filestat_get(3, 0, "./test-link.txt")?;
        println!("{:?}", stat);
        let mut buf = [0;1024];
        let len = wasi::path_readlink(3, "./test-link.txt", buf.as_mut_ptr(), buf.len())?;
        println!("{:?}", String::from_utf8_lossy(&buf[0..len]));
    };
    Ok(())
}

It will return error: Error: Errno { code: 28, name: "INVAL", message: "Invalid argument." }
If the link file is under a folder like:

fn main() -> Result<(), wasi::Errno> {
    unsafe {
        wasi::path_symlink("./test.txt", 3, "./test/test-link.txt")?;
        let stat = wasi::path_filestat_get(3, 0, "./test/test-link.txt")?;
        println!("{:?}", stat);
        let mut buf = [0;1024];
        let len = wasi::path_readlink(3, "./test/test-link.txt", buf.as_mut_ptr(), buf.len())?;
        println!("{:?}", String::from_utf8_lossy(&buf[0..len]));
    };
    Ok(())
}

It will return error: Error: Errno { code: 44, name: "NOENT", message: "No such file or directory." }
@hydai

[hydai]

We are focusing on some high-priority issues. If you encounter any bugs, please raise issues on the WasmEdge project with the detailed reproduction steps and the environment information. Thanks.

[L-jasmine]

path_readlink is not work well

fn main() -> Result<(), wasi::Errno> {
    unsafe {
        wasi::path_symlink("./test.txt", 3, "./test-link.txt")?;
        let stat = wasi::path_filestat_get(3, 0, "./test-link.txt")?;
        println!("{:?}", stat);
        let mut buf = [0;1024];
        let len = wasi::path_readlink(3, "./test-link.txt", buf.as_mut_ptr(), buf.len())?;
        println!("{:?}", String::from_utf8_lossy(&buf[0..len]));
    };
    Ok(())
}

It will return error: Error: Errno { code: 28, name: "INVAL", message: "Invalid argument." } If the link file is under a folder like:

fn main() -> Result<(), wasi::Errno> {
    unsafe {
        wasi::path_symlink("./test.txt", 3, "./test/test-link.txt")?;
        let stat = wasi::path_filestat_get(3, 0, "./test/test-link.txt")?;
        println!("{:?}", stat);
        let mut buf = [0;1024];
        let len = wasi::path_readlink(3, "./test/test-link.txt", buf.as_mut_ptr(), buf.len())?;
        println!("{:?}", String::from_utf8_lossy(&buf[0..len]));
    };
    Ok(())
}

It will return error: Error: Errno { code: 44, name: "NOENT", message: "No such file or directory." } @hydai

I think symlink is not very important.

[L-jasmine]

@L-jasmine poll fd write will cause a infinite loop in ubuntu, while in WSL1 it won't happen.

fn main() -> Result<(), wasi::Errno> {
    unsafe {
        let fd = wasi::path_open(
            3,
            0,
            "test.txt",
            0,
            wasi::RIGHTS_FD_WRITE | wasi::RIGHTS_POLL_FD_READWRITE,
            0,
            wasi::FDFLAGS_NONBLOCK,
        )?;
        println!("{}", fd);
        let subs = vec![wasi::Subscription {
            userdata: 0,
            u: wasi::SubscriptionU {
                tag: 2,
                u: wasi::SubscriptionUU {
                    fd_write: wasi::SubscriptionFdReadwrite {
                        file_descriptor: fd as u32,
                    },
                },
            },
        }];
        let mut events = vec![wasi::Event {
            userdata: 0,
            error: wasi::ERRNO_SUCCESS,
            type_: wasi::EVENTTYPE_FD_WRITE,
            fd_readwrite: wasi::EventFdReadwrite {
                nbytes: 0,
                flags: 0,
            },
        }];
        let n = wasi::poll_oneoff(subs.as_ptr(), events.as_mut_ptr(), subs.len())?;
        println!("{}", n);
    };
    Ok(())
}

@hydai

poll fd read also has same problem.

in linux, epoll a normal file will get a Operation not permitted.
normal file read & write not need wait.
so, we can skip poll a file, just think it is ready to read or write.

[L-jasmine]

@Puellaquae if you think this pr is time to merge, please @ me. Thinks.

[Puellaquae]

@L-jasmine Most of fs api is implemented and passed nodejs's tests. ReadStream and WriteStream only has basic function. chmod, chown and watch is unsupported. And symlink on dir, readlink and realpath is not work well now.