1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-23 15:16:54 -05:00
denoland-deno/cli/tests/unit_node/_fs
nasa 25fdc7bf6c
feat(node_compat): Added base implementation of FileHandle (#19294)
<!--
Before submitting a PR, please read https://deno.com/manual/contributing

1. Give the PR a descriptive title.

  Examples of good title:
    - fix(std/http): Fix race condition in server
    - docs(console): Update docstrings
    - feat(doc): Handle nested reexports

  Examples of bad title:
    - fix #7123
    - update docs
    - fix bugs

2. Ensure there is a related issue and it is referenced in the PR text.
3. Ensure there are tests that cover the changes.
4. Ensure `cargo test` passes.
5. Ensure `./tools/format.js` passes without changing files.
6. Ensure `./tools/lint.js` passes.
7. Open as a draft PR if your work is still in progress. The CI won't
run
   all steps, but you can add '[ci]' to a commit message to force it to.
8. If you would like to run the benchmarks on the CI, add the 'ci-bench'
label.
-->


## WHY

ref: https://github.com/denoland/deno/issues/19165

Node's fs/promises includes a FileHandle class, but deno does not. The
open function in Node's fs/promises returns a FileHandle, which provides
an IO interface to the file. However, deno's open function returns a
resource id.


### deno 

```js
> const fs = await import("node:fs/promises");
undefined
> const file3 = await fs.open("./README.md");
undefined
> file3
3
> file3.read
undefined
Node:
```

### Node
```js
> const fs = await import("fs/promises");
undefined
>   const file3 = await fs.open("./tests/e2e_unit/testdata/file.txt");
undefined
> file3
FileHandle {
  _events: [Object: null prototype] {},
  _eventsCount: 0,
  _maxListeners: undefined,
  close: [Function: close],
  [Symbol(kCapture)]: false,
  [Symbol(kHandle)]: FileHandle {},
  [Symbol(kFd)]: 24,
  [Symbol(kRefs)]: 1,
  [Symbol(kClosePromise)]: null
}
> file3.read
[Function: read]
```


To be compatible with Node, deno's open function should also return a
FileHandle.

## WHAT

I have implemented the first step in adding a FileHandle.

- Changed the return value of the open function to a FileHandle object
- Implemented the readFile method in FileHandle
- Add test code


## What to do next
This PR is the first step in adding a FileHandle, and there are things
that should be done next.

- Add functionality equivalent to Node's FileHandle to FileHandle
(currently there is only readFile)

---------

Co-authored-by: Matt Mastracci <matthew@mastracci.com>
2023-06-02 08:28:05 -06:00
..
testdata test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_access_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_appendFile_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_chmod_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_chown_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_close_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_copy_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_dir_test.ts test(node/fs): add fs.Dir tests (#18463) 2023-03-28 23:58:40 +09:00
_fs_exists_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_fdatasync_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_fstat_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_fsync_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_ftruncate_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_futimes_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_handle_test.ts feat(node_compat): Added base implementation of FileHandle (#19294) 2023-06-02 08:28:05 -06:00
_fs_link_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_lstat_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_mkdir_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_mkdtemp_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_opendir_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_readdir_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_readFile_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_readlink_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_realpath_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_rename_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_rm_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_rmdir_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_stat_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_symlink_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_truncate_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_unlink_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_utimes_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00
_fs_watch_test.ts
_fs_write_test.ts test(ext/node): port _fs tests from std/node (#18262) 2023-03-20 01:10:39 +09:00