From 0fc19df30ab2e72c0084a494ff570cdbd5a07dd3 Mon Sep 17 00:00:00 2001 From: nasa Date: Thu, 8 Jun 2023 21:37:19 +0900 Subject: [PATCH] feat(node_compat): Add a read method to the FileHandle class (#19359) ref: #19165 The FileHandle class has many missing methods compared to node. --- cli/tests/unit_node/_fs/_fs_handle_test.ts | 42 +++++++++++++++++++- ext/node/polyfills/_fs/_fs_common.ts | 7 ++++ ext/node/polyfills/_fs/_fs_read.ts | 14 ++----- ext/node/polyfills/internal/fs/handle.ts | 46 +++++++++++++++++++++- 4 files changed, 97 insertions(+), 12 deletions(-) diff --git a/cli/tests/unit_node/_fs/_fs_handle_test.ts b/cli/tests/unit_node/_fs/_fs_handle_test.ts index 165608e1ce..2865fc785b 100644 --- a/cli/tests/unit_node/_fs/_fs_handle_test.ts +++ b/cli/tests/unit_node/_fs/_fs_handle_test.ts @@ -1,15 +1,16 @@ // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. import * as path from "../../../../test_util/std/path/mod.ts"; +import * as fs from "node:fs/promises"; import { assert, assertEquals, } from "../../../../test_util/std/testing/asserts.ts"; +import { Buffer } from "node:buffer"; const moduleDir = path.dirname(path.fromFileUrl(import.meta.url)); const testData = path.resolve(moduleDir, "testdata", "hello.txt"); Deno.test("readFileSuccess", async function () { - const fs = await import("node:fs/promises"); const fileHandle = await fs.open(testData); const data = await fileHandle.readFile(); @@ -18,3 +19,42 @@ Deno.test("readFileSuccess", async function () { await fileHandle.close(); }); + +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); + + assertEquals(new TextDecoder().decode(buf as Uint8Array), "hello world"); + + 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); + assertEquals(new TextDecoder().decode(res.buffer as Uint8Array), "hello"); + + await fileHandle.close(); +}); diff --git a/ext/node/polyfills/_fs/_fs_common.ts b/ext/node/polyfills/_fs/_fs_common.ts index 19f0d7d176..4e8bfc2858 100644 --- a/ext/node/polyfills/_fs/_fs_common.ts +++ b/ext/node/polyfills/_fs/_fs_common.ts @@ -33,6 +33,13 @@ export type BinaryOptionsArgument = | ({ encoding: BinaryEncodings } & FileOptions); export type FileOptionsArgument = Encodings | FileOptions; +export type ReadOptions = { + buffer: Buffer | Uint8Array; + offset: number; + length: number; + position: number | null; +}; + export interface WriteFileOptions extends FileOptions { mode?: number; } diff --git a/ext/node/polyfills/_fs/_fs_read.ts b/ext/node/polyfills/_fs/_fs_read.ts index bce7d334f4..2c840f07cd 100644 --- a/ext/node/polyfills/_fs/_fs_read.ts +++ b/ext/node/polyfills/_fs/_fs_read.ts @@ -3,6 +3,7 @@ import { Buffer } from "ext:deno_node/buffer.ts"; import { ERR_INVALID_ARG_TYPE } from "ext:deno_node/internal/errors.ts"; import * as io from "ext:deno_io/12_io.js"; import * as fs from "ext:deno_fs/30_fs.js"; +import { ReadOptions } from "ext:deno_node/_fs/_fs_common.ts"; import { validateOffsetLengthRead, validatePosition, @@ -12,13 +13,6 @@ import { validateInteger, } from "ext:deno_node/internal/validators.mjs"; -type readOptions = { - buffer: Buffer | Uint8Array; - offset: number; - length: number; - position: number | null; -}; - type readSyncOptions = { offset: number; length: number; @@ -35,7 +29,7 @@ type Callback = BinaryCallback; export function read(fd: number, callback: Callback): void; export function read( fd: number, - options: readOptions, + options: ReadOptions, callback: Callback, ): void; export function read( @@ -48,7 +42,7 @@ export function read( ): void; export function read( fd: number, - optOrBufferOrCb?: Buffer | Uint8Array | readOptions | Callback, + optOrBufferOrCb?: Buffer | Uint8Array | ReadOptions | Callback, offsetOrCallback?: number | Callback, length?: number, position?: number | null, @@ -86,7 +80,7 @@ export function read( length = buffer.byteLength; position = null; } else { - const opt = optOrBufferOrCb as readOptions; + const opt = optOrBufferOrCb as ReadOptions; if ( !(opt.buffer instanceof Buffer) && !(opt.buffer instanceof Uint8Array) ) { diff --git a/ext/node/polyfills/internal/fs/handle.ts b/ext/node/polyfills/internal/fs/handle.ts index a1ee263ead..1994577873 100644 --- a/ext/node/polyfills/internal/fs/handle.ts +++ b/ext/node/polyfills/internal/fs/handle.ts @@ -1,13 +1,20 @@ // Copyright 2018-2023 the Deno authors. All rights reserved. MIT license. import { EventEmitter } from "ext:deno_node/events.ts"; import { Buffer } from "ext:deno_node/buffer.ts"; -import { promises } from "ext:deno_node/fs.ts"; +import { promises, read } from "ext:deno_node/fs.ts"; +import type { Buffer } from "ext:deno_node/buffer.ts"; import { BinaryOptionsArgument, FileOptionsArgument, + ReadOptions, TextOptionsArgument, } from "ext:deno_node/_fs/_fs_common.ts"; +interface ReadResult { + bytesRead: number; + buffer: Buffer; +} + export class FileHandle extends EventEmitter { #rid: number; constructor(rid: number) { @@ -19,6 +26,43 @@ export class FileHandle extends EventEmitter { return this.rid; } + read( + buffer: Buffer, + offset?: number, + length?: number, + position?: number | null, + ): Promise; + read(options?: ReadOptions): Promise; + read( + bufferOrOpt: Buffer | ReadOptions, + offset?: number, + length?: number, + position?: number | null, + ): Promise { + if (bufferOrOpt instanceof Buffer) { + return new Promise((resolve, reject) => { + read( + this.fd, + bufferOrOpt, + offset, + length, + position, + (err, bytesRead, buffer) => { + if (err) reject(err); + else resolve({ buffer: buffer, bytesRead: bytesRead }); + }, + ); + }); + } else { + return new Promise((resolve, reject) => { + read(this.fd, bufferOrOpt, (err, bytesRead, buffer) => { + if (err) reject(err); + else resolve({ buffer: buffer, bytesRead: bytesRead }); + }); + }); + } + } + readFile( opt?: TextOptionsArgument | BinaryOptionsArgument | FileOptionsArgument, ): Promise {