2024-01-01 14:58:21 -05:00
|
|
|
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
2024-02-07 11:51:28 -05:00
|
|
|
import * as path from "@test_util/std/path/mod.ts";
|
2023-06-08 10:47:12 -04:00
|
|
|
import { Buffer } from "node:buffer";
|
2023-06-08 08:37:19 -04:00
|
|
|
import * as fs from "node:fs/promises";
|
2024-02-07 11:51:28 -05:00
|
|
|
import { assert, assertEquals } from "@test_util/std/assert/mod.ts";
|
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 10:28:05 -04:00
|
|
|
|
|
|
|
const moduleDir = path.dirname(path.fromFileUrl(import.meta.url));
|
|
|
|
const testData = path.resolve(moduleDir, "testdata", "hello.txt");
|
2023-06-08 10:47:12 -04:00
|
|
|
const decoder = new TextDecoder();
|
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 10:28:05 -04:00
|
|
|
|
|
|
|
Deno.test("readFileSuccess", async function () {
|
|
|
|
const fileHandle = await fs.open(testData);
|
|
|
|
const data = await fileHandle.readFile();
|
|
|
|
|
|
|
|
assert(data instanceof Uint8Array);
|
2023-06-08 10:47:12 -04:00
|
|
|
assertEquals(decoder.decode(data as Uint8Array), "hello world");
|
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 10:28:05 -04:00
|
|
|
|
2023-06-05 08:43:04 -04:00
|
|
|
await fileHandle.close();
|
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 10:28:05 -04:00
|
|
|
});
|
2023-06-08 08:37:19 -04:00
|
|
|
|
|
|
|
Deno.test("read", async function () {
|
|
|
|
const fileHandle = await fs.open(testData);
|
|
|
|
const byteLength = "hello world".length;
|
|
|
|
|
|
|
|
const buf = new Buffer(byteLength);
|
|
|
|
await fileHandle.read(buf, 0, byteLength, 0);
|
|
|
|
|
2023-06-08 10:47:12 -04:00
|
|
|
assertEquals(decoder.decode(buf as Uint8Array), "hello world");
|
2023-06-08 08:37:19 -04:00
|
|
|
|
|
|
|
await fileHandle.close();
|
|
|
|
});
|
|
|
|
|
|
|
|
Deno.test("read specify opt", async function () {
|
|
|
|
const fileHandle = await fs.open(testData);
|
|
|
|
const byteLength = "hello world".length;
|
|
|
|
|
|
|
|
const opt = {
|
|
|
|
buffer: new Buffer(byteLength),
|
|
|
|
offset: 6,
|
|
|
|
length: 5,
|
|
|
|
};
|
|
|
|
let res = await fileHandle.read(opt);
|
|
|
|
|
|
|
|
assertEquals(res.bytesRead, byteLength);
|
|
|
|
assertEquals(new TextDecoder().decode(res.buffer as Uint8Array), "world");
|
|
|
|
|
|
|
|
const opt2 = {
|
|
|
|
buffer: new Buffer(byteLength),
|
|
|
|
length: 5,
|
|
|
|
position: 0,
|
|
|
|
};
|
|
|
|
res = await fileHandle.read(opt2);
|
|
|
|
|
|
|
|
assertEquals(res.bytesRead, byteLength);
|
2023-06-08 10:47:12 -04:00
|
|
|
assertEquals(decoder.decode(res.buffer as Uint8Array), "hello");
|
|
|
|
|
|
|
|
await fileHandle.close();
|
|
|
|
});
|
|
|
|
|
|
|
|
Deno.test("[node/fs filehandle.write] Write from Buffer", async function () {
|
|
|
|
const tempFile: string = await Deno.makeTempFile();
|
|
|
|
const fileHandle = await fs.open(tempFile, "a+");
|
|
|
|
|
|
|
|
const buffer = Buffer.from("hello world");
|
|
|
|
const res = await fileHandle.write(buffer, 0, 5, 0);
|
2023-06-08 08:37:19 -04:00
|
|
|
|
2023-06-08 10:47:12 -04:00
|
|
|
const data = Deno.readFileSync(tempFile);
|
|
|
|
await Deno.remove(tempFile);
|
2023-06-08 08:37:19 -04:00
|
|
|
await fileHandle.close();
|
2023-06-08 10:47:12 -04:00
|
|
|
|
|
|
|
assertEquals(res.bytesWritten, 5);
|
|
|
|
assertEquals(decoder.decode(data), "hello");
|
|
|
|
});
|
|
|
|
|
|
|
|
Deno.test("[node/fs filehandle.write] Write from string", async function () {
|
|
|
|
const tempFile: string = await Deno.makeTempFile();
|
|
|
|
const fileHandle = await fs.open(tempFile, "a+");
|
|
|
|
|
|
|
|
const str = "hello world";
|
|
|
|
const res = await fileHandle.write(str);
|
|
|
|
|
|
|
|
const data = Deno.readFileSync(tempFile);
|
|
|
|
await Deno.remove(tempFile);
|
|
|
|
await fileHandle.close();
|
|
|
|
|
|
|
|
assertEquals(res.bytesWritten, 11);
|
|
|
|
assertEquals(decoder.decode(data), "hello world");
|
2023-06-08 08:37:19 -04:00
|
|
|
});
|