-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
FileHandle.ts
369 lines (319 loc) Β· 10.1 KB
/
FileHandle.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
import type {BigIntStats, ReadStream, StatOptions, Stats, WriteStream, WriteVResult} from 'fs';
import {createInterface} from 'readline';
import type {CreateReadStreamOptions, CreateWriteStreamOptions, FakeFS} from '../FakeFS';
import type {Path} from '../path';
// Types copied from https://github.com/DefinitelyTyped/DefinitelyTyped/blob/9e2e5af93f9cc2cf434a96e3249a573100e87351/types/node/v16
// Implementation based on https://github.com/nodejs/node/blob/10493b48c7edb227c13a493d0a2c75efe878d7e9/lib/internal/fs/promises.js#L124-L336
interface ObjectEncodingOptions {
encoding?: BufferEncoding | null | undefined;
}
interface FlagAndOpenMode {
mode?: Mode | undefined;
flag?: OpenMode | undefined;
}
type OpenMode = number | string;
type Mode = number | string;
interface FileReadResult<T extends ArrayBufferView> {
bytesRead: number;
buffer: T;
}
interface FileReadOptions<T extends ArrayBufferView = Buffer> {
buffer?: T;
offset?: number | null;
length?: number | null;
position?: number | null;
}
interface ReadVResult {
bytesRead: number;
buffers: Array<NodeJS.ArrayBufferView>;
}
interface AbortSignal {
readonly aborted: boolean;
}
interface Abortable {
signal?: AbortSignal | undefined;
}
type WriteArgsBuffer<TBuffer extends Uint8Array> = [
buffer: TBuffer,
offset?: number | null,
length?: number | null,
position?: number | null,
];
type WriteArgsString = [
data: string,
position?: number | null,
encoding?: BufferEncoding | null,
];
const kBaseFs = Symbol(`kBaseFs`);
const kFd = Symbol(`kFd`);
const kClosePromise = Symbol(`kClosePromise`);
const kCloseResolve = Symbol(`kCloseResolve`);
const kCloseReject = Symbol(`kCloseReject`);
const kRefs = Symbol(`kRefs`);
const kRef = Symbol(`kRef`);
const kUnref = Symbol(`kUnref`);
export class FileHandle<P extends Path> {
[kBaseFs]: FakeFS<P>;
[kFd]: number;
[kRefs] = 1;
[kClosePromise]: Promise<void> | undefined = undefined;
[kCloseResolve]: (() => void) | undefined = undefined;
[kCloseReject]: (() => void) | undefined = undefined;
constructor(fd: number, baseFs: FakeFS<P>) {
this[kBaseFs] = baseFs;
this[kFd] = fd;
}
get fd() {
return this[kFd];
}
async appendFile(
data: string | Uint8Array,
options?: (ObjectEncodingOptions & FlagAndOpenMode) | BufferEncoding | null,
): Promise<void> {
try {
this[kRef](this.appendFile);
const encoding = (typeof options === `string` ? options : options?.encoding) ?? undefined;
return await this[kBaseFs].appendFilePromise(this.fd, data, encoding ? {encoding} : undefined);
} finally {
this[kUnref]();
}
}
async chown(uid: number, gid: number): Promise<void> {
try {
this[kRef](this.chown);
return await this[kBaseFs].fchownPromise(this.fd, uid, gid);
} finally {
this[kUnref]();
}
}
async chmod(mode: number): Promise<void> {
try {
this[kRef](this.chmod);
return await this[kBaseFs].fchmodPromise(this.fd, mode);
} finally {
this[kUnref]();
}
}
createReadStream(options?: CreateReadStreamOptions): ReadStream {
return this[kBaseFs].createReadStream(null, {...options, fd: this.fd});
}
createWriteStream(options?: CreateWriteStreamOptions): WriteStream {
return this[kBaseFs].createWriteStream(null, {...options, fd: this.fd});
}
// FIXME: Missing FakeFS version
datasync(): Promise<void> {
throw new Error(`Method not implemented.`);
}
// FIXME: Missing FakeFS version
sync(): Promise<void> {
throw new Error(`Method not implemented.`);
}
async read(options?: FileReadOptions<Buffer>): Promise<FileReadResult<Buffer>>;
async read(
buffer: Buffer,
offset?: number | null,
length?: number | null,
position?: number | null
): Promise<FileReadResult<Buffer>>;
async read(
bufferOrOptions?: Buffer | FileReadOptions<Buffer>,
offset?: number | null,
length?: number | null,
position?: number | null,
): Promise<FileReadResult<Buffer>> {
try {
this[kRef](this.read);
let buffer: Buffer;
if (!Buffer.isBuffer(bufferOrOptions)) {
bufferOrOptions ??= {};
buffer = bufferOrOptions.buffer ?? Buffer.alloc(16384);
offset = bufferOrOptions.offset || 0;
length = bufferOrOptions.length ?? buffer.byteLength;
position = bufferOrOptions.position ?? null;
} else {
buffer = bufferOrOptions;
}
offset ??= 0;
length ??= 0;
if (length === 0) {
return {
bytesRead: length,
buffer,
};
}
const bytesRead = await this[kBaseFs].readPromise(this.fd, buffer, offset, length, position);
return {
bytesRead,
buffer,
};
} finally {
this[kUnref]();
}
}
readFile(
options?: {
encoding?: null | undefined;
flag?: OpenMode | undefined;
} | null
): Promise<Buffer>;
readFile(
options:
| {
encoding: BufferEncoding;
flag?: OpenMode | undefined;
}
| BufferEncoding
): Promise<string>;
async readFile(
options?:
| (ObjectEncodingOptions & {
flag?: OpenMode | undefined;
})
| BufferEncoding
| null,
): Promise<string | Buffer> {
try {
this[kRef](this.readFile);
const encoding = (typeof options === `string` ? options : options?.encoding) ?? undefined;
return await this[kBaseFs].readFilePromise(this.fd, encoding);
} finally {
this[kUnref]();
}
}
readLines(options?: CreateReadStreamOptions) {
return createInterface({
input: this.createReadStream(options),
crlfDelay: Infinity,
});
}
stat(
opts?: StatOptions & {
bigint?: false | undefined;
}
): Promise<Stats>;
stat(
opts: StatOptions & {
bigint: true;
}
): Promise<BigIntStats>;
async stat(opts?: StatOptions): Promise<Stats | BigIntStats> {
try {
this[kRef](this.stat);
return await this[kBaseFs].fstatPromise(this.fd, opts);
} finally {
this[kUnref]();
}
}
async truncate(len?: number): Promise<void> {
try {
this[kRef](this.truncate);
return await this[kBaseFs].ftruncatePromise(this.fd, len);
} finally {
this[kUnref]();
}
}
// FIXME: Missing FakeFS version
utimes(atime: string | number | Date, mtime: string | number | Date): Promise<void> {
throw new Error(`Method not implemented.`);
}
async writeFile(
data: string | Uint8Array,
options?: (ObjectEncodingOptions & FlagAndOpenMode & Abortable) | BufferEncoding | null,
): Promise<void> {
try {
this[kRef](this.writeFile);
const encoding = (typeof options === `string` ? options : options?.encoding) ?? undefined;
await this[kBaseFs].writeFilePromise(this.fd, data, encoding);
} finally {
this[kUnref]();
}
}
async write(...args: WriteArgsString): Promise<{ bytesWritten: number, buffer: string }>
async write<TBuffer extends Uint8Array>(...args: WriteArgsBuffer<TBuffer>): Promise<{ bytesWritten: number, buffer: TBuffer }>;
async write<TBuffer extends Uint8Array>(...args: WriteArgsBuffer<TBuffer> | WriteArgsString): Promise<{ bytesWritten: number, buffer: string | TBuffer }> {
try {
this[kRef](this.write);
if (ArrayBuffer.isView(args[0])) {
const [buffer, offset, length, position] = args as WriteArgsBuffer<TBuffer>;
const bytesWritten = await this[kBaseFs].writePromise(this.fd, buffer as unknown as Buffer, offset ?? undefined, length ?? undefined, position ?? undefined);
return {bytesWritten, buffer};
} else {
const [data, position, encoding] = args as WriteArgsString;
// @ts-expect-error - FIXME: Types/implementation need to be updated in FakeFS
const bytesWritten = await this[kBaseFs].writePromise(this.fd, data, position, encoding);
return {bytesWritten, buffer: data};
}
} finally {
this[kUnref]();
}
}
// TODO: Use writev from FakeFS when that is implemented
async writev(buffers: Array<NodeJS.ArrayBufferView>, position?: number): Promise<WriteVResult> {
try {
this[kRef](this.writev);
let bytesWritten = 0;
if (typeof position !== `undefined`) {
for (const buffer of buffers) {
const writeResult = await this.write(buffer as unknown as Buffer, undefined, undefined, position);
bytesWritten += writeResult.bytesWritten;
position += writeResult.bytesWritten;
}
} else {
for (const buffer of buffers) {
const writeResult = await this.write(buffer as unknown as Buffer);
bytesWritten += writeResult.bytesWritten;
}
}
return {
buffers,
bytesWritten,
};
} finally {
this[kUnref]();
}
}
// FIXME: Missing FakeFS version
readv(buffers: ReadonlyArray<NodeJS.ArrayBufferView>, position?: number): Promise<ReadVResult> {
throw new Error(`Method not implemented.`);
}
close(): Promise<void> {
if (this[kFd] === -1) return Promise.resolve();
if (this[kClosePromise]) return this[kClosePromise];
this[kRefs]--;
if (this[kRefs] === 0) {
const fd = this[kFd];
this[kFd] = -1;
this[kClosePromise] = this[kBaseFs].closePromise(fd).finally(() => {
this[kClosePromise] = undefined;
});
} else {
this[kClosePromise] =
new Promise<void>((resolve, reject) => {
this[kCloseResolve] = resolve;
this[kCloseReject] = reject;
}).finally(() => {
this[kClosePromise] = undefined;
this[kCloseReject] = undefined;
this[kCloseResolve] = undefined;
});
}
return this[kClosePromise];
}
[kRef](caller: Function) {
if (this[kFd] === -1) {
const err = new Error(`file closed`);
(err as any).code = `EBADF`;
(err as any).syscall = caller.name;
throw err;
}
this[kRefs]++;
}
[kUnref]() {
this[kRefs]--;
if (this[kRefs] === 0) {
const fd = this[kFd];
this[kFd] = -1;
this[kBaseFs].closePromise(fd).then(this[kCloseResolve], this[kCloseReject]);
}
}
}