File size: 12,719 Bytes
f0743f4 | 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 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | import { createReadStream } from 'fs';
import { readFile, stat } from 'fs/promises';
import { Readable } from 'stream';
import { readFileAsString, readFileAsBuffer, readJsonFile } from '../files';
jest.mock('fs');
jest.mock('fs/promises');
describe('File utilities', () => {
const mockFilePath = '/test/file.txt';
const smallContent = 'Hello, World!';
const largeContent = 'x'.repeat(11 * 1024 * 1024); // 11MB of 'x'
beforeEach(() => {
jest.clearAllMocks();
});
describe('readFileAsString', () => {
it('should read small files directly without streaming', async () => {
const fileSize = Buffer.byteLength(smallContent);
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
(readFile as jest.Mock).mockResolvedValue(smallContent);
const result = await readFileAsString(mockFilePath);
expect(result).toEqual({
content: smallContent,
bytes: fileSize,
});
expect(stat).toHaveBeenCalledWith(mockFilePath);
expect(readFile).toHaveBeenCalledWith(mockFilePath, 'utf8');
expect(createReadStream).not.toHaveBeenCalled();
});
it('should use provided fileSize to avoid stat call', async () => {
const fileSize = Buffer.byteLength(smallContent);
(readFile as jest.Mock).mockResolvedValue(smallContent);
const result = await readFileAsString(mockFilePath, { fileSize });
expect(result).toEqual({
content: smallContent,
bytes: fileSize,
});
expect(stat).not.toHaveBeenCalled();
expect(readFile).toHaveBeenCalledWith(mockFilePath, 'utf8');
});
it('should stream large files', async () => {
const fileSize = Buffer.byteLength(largeContent);
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
// Create a mock readable stream
const chunks = [
largeContent.substring(0, 5000000),
largeContent.substring(5000000, 10000000),
largeContent.substring(10000000),
];
const mockStream = new Readable({
read() {
if (chunks.length > 0) {
this.push(chunks.shift());
} else {
this.push(null); // End stream
}
},
});
(createReadStream as jest.Mock).mockReturnValue(mockStream);
const result = await readFileAsString(mockFilePath);
expect(result).toEqual({
content: largeContent,
bytes: fileSize,
});
expect(stat).toHaveBeenCalledWith(mockFilePath);
expect(createReadStream).toHaveBeenCalledWith(mockFilePath, {
encoding: 'utf8',
highWaterMark: 64 * 1024,
});
expect(readFile).not.toHaveBeenCalled();
});
it('should use custom encoding', async () => {
const fileSize = 100;
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
(readFile as jest.Mock).mockResolvedValue(smallContent);
await readFileAsString(mockFilePath, { encoding: 'latin1' });
expect(readFile).toHaveBeenCalledWith(mockFilePath, 'latin1');
});
it('should respect custom stream threshold', async () => {
const customThreshold = 1024; // 1KB
const fileSize = 2048; // 2KB
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
const mockStream = new Readable({
read() {
this.push('test content');
this.push(null);
},
});
(createReadStream as jest.Mock).mockReturnValue(mockStream);
await readFileAsString(mockFilePath, { streamThreshold: customThreshold });
expect(createReadStream).toHaveBeenCalled();
expect(readFile).not.toHaveBeenCalled();
});
it('should handle empty files', async () => {
const fileSize = 0;
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
(readFile as jest.Mock).mockResolvedValue('');
const result = await readFileAsString(mockFilePath);
expect(result).toEqual({
content: '',
bytes: 0,
});
});
it('should propagate read errors', async () => {
const error = new Error('File not found');
(stat as jest.Mock).mockResolvedValue({ size: 100 });
(readFile as jest.Mock).mockRejectedValue(error);
await expect(readFileAsString(mockFilePath)).rejects.toThrow('File not found');
});
it('should propagate stat errors when fileSize not provided', async () => {
const error = new Error('Permission denied');
(stat as jest.Mock).mockRejectedValue(error);
await expect(readFileAsString(mockFilePath)).rejects.toThrow('Permission denied');
});
it('should propagate stream errors', async () => {
const fileSize = 11 * 1024 * 1024; // 11MB
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
const mockStream = new Readable({
read() {
this.emit('error', new Error('Stream error'));
},
});
(createReadStream as jest.Mock).mockReturnValue(mockStream);
await expect(readFileAsString(mockFilePath)).rejects.toThrow('Stream error');
});
});
describe('readFileAsBuffer', () => {
const smallBuffer = Buffer.from(smallContent);
const largeBuffer = Buffer.from(largeContent);
it('should read small files directly without streaming', async () => {
const fileSize = smallBuffer.length;
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
(readFile as jest.Mock).mockResolvedValue(smallBuffer);
const result = await readFileAsBuffer(mockFilePath);
expect(result).toEqual({
content: smallBuffer,
bytes: fileSize,
});
expect(stat).toHaveBeenCalledWith(mockFilePath);
expect(readFile).toHaveBeenCalledWith(mockFilePath);
expect(createReadStream).not.toHaveBeenCalled();
});
it('should use provided fileSize to avoid stat call', async () => {
const fileSize = smallBuffer.length;
(readFile as jest.Mock).mockResolvedValue(smallBuffer);
const result = await readFileAsBuffer(mockFilePath, { fileSize });
expect(result).toEqual({
content: smallBuffer,
bytes: fileSize,
});
expect(stat).not.toHaveBeenCalled();
});
it('should stream large files', async () => {
const fileSize = largeBuffer.length;
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
// Split large buffer into chunks
const chunk1 = largeBuffer.slice(0, 5000000);
const chunk2 = largeBuffer.slice(5000000, 10000000);
const chunk3 = largeBuffer.slice(10000000);
const chunks = [chunk1, chunk2, chunk3];
const mockStream = new Readable({
read() {
if (chunks.length > 0) {
this.push(chunks.shift());
} else {
this.push(null);
}
},
});
(createReadStream as jest.Mock).mockReturnValue(mockStream);
const result = await readFileAsBuffer(mockFilePath);
expect(result.bytes).toBe(fileSize);
expect(Buffer.compare(result.content, largeBuffer)).toBe(0);
expect(createReadStream).toHaveBeenCalledWith(mockFilePath, {
highWaterMark: 64 * 1024,
});
expect(readFile).not.toHaveBeenCalled();
});
it('should respect custom highWaterMark', async () => {
const fileSize = 11 * 1024 * 1024; // 11MB
const customHighWaterMark = 128 * 1024; // 128KB
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
const mockStream = new Readable({
read() {
this.push(Buffer.from('test'));
this.push(null);
},
});
(createReadStream as jest.Mock).mockReturnValue(mockStream);
await readFileAsBuffer(mockFilePath, { highWaterMark: customHighWaterMark });
expect(createReadStream).toHaveBeenCalledWith(mockFilePath, {
highWaterMark: customHighWaterMark,
});
});
it('should handle empty buffer files', async () => {
const emptyBuffer = Buffer.alloc(0);
(stat as jest.Mock).mockResolvedValue({ size: 0 });
(readFile as jest.Mock).mockResolvedValue(emptyBuffer);
const result = await readFileAsBuffer(mockFilePath);
expect(result).toEqual({
content: emptyBuffer,
bytes: 0,
});
});
it('should propagate errors', async () => {
const error = new Error('Access denied');
(stat as jest.Mock).mockResolvedValue({ size: 100 });
(readFile as jest.Mock).mockRejectedValue(error);
await expect(readFileAsBuffer(mockFilePath)).rejects.toThrow('Access denied');
});
});
describe('readJsonFile', () => {
const validJson = { name: 'test', value: 123, nested: { key: 'value' } };
const jsonString = JSON.stringify(validJson);
it('should parse valid JSON files', async () => {
(stat as jest.Mock).mockResolvedValue({ size: jsonString.length });
(readFile as jest.Mock).mockResolvedValue(jsonString);
const result = await readJsonFile(mockFilePath);
expect(result).toEqual(validJson);
expect(readFile).toHaveBeenCalledWith(mockFilePath, 'utf8');
});
it('should parse JSON with provided fileSize', async () => {
const fileSize = jsonString.length;
(readFile as jest.Mock).mockResolvedValue(jsonString);
const result = await readJsonFile(mockFilePath, { fileSize });
expect(result).toEqual(validJson);
expect(stat).not.toHaveBeenCalled();
});
it('should handle JSON arrays', async () => {
const jsonArray = [1, 2, 3, { key: 'value' }];
const arrayString = JSON.stringify(jsonArray);
(stat as jest.Mock).mockResolvedValue({ size: arrayString.length });
(readFile as jest.Mock).mockResolvedValue(arrayString);
const result = await readJsonFile(mockFilePath);
expect(result).toEqual(jsonArray);
});
it('should throw on invalid JSON', async () => {
const invalidJson = '{ invalid json }';
(stat as jest.Mock).mockResolvedValue({ size: invalidJson.length });
(readFile as jest.Mock).mockResolvedValue(invalidJson);
await expect(readJsonFile(mockFilePath)).rejects.toThrow();
});
it('should throw on empty file', async () => {
(stat as jest.Mock).mockResolvedValue({ size: 0 });
(readFile as jest.Mock).mockResolvedValue('');
await expect(readJsonFile(mockFilePath)).rejects.toThrow();
});
it('should handle large JSON files with streaming', async () => {
const largeJson = { data: 'x'.repeat(11 * 1024 * 1024) }; // >10MB
const largeJsonString = JSON.stringify(largeJson);
const fileSize = largeJsonString.length;
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
// Create chunks for streaming
const chunks: string[] = [];
let offset = 0;
const chunkSize = 5 * 1024 * 1024; // 5MB chunks
while (offset < largeJsonString.length) {
chunks.push(largeJsonString.slice(offset, offset + chunkSize));
offset += chunkSize;
}
const mockStream = new Readable({
read() {
if (chunks.length > 0) {
this.push(chunks.shift());
} else {
this.push(null);
}
},
});
(createReadStream as jest.Mock).mockReturnValue(mockStream);
const result = await readJsonFile(mockFilePath);
expect(result).toEqual(largeJson);
expect(createReadStream).toHaveBeenCalled();
expect(readFile).not.toHaveBeenCalled();
});
it('should use custom stream threshold', async () => {
const customThreshold = 100;
const json = { test: 'x'.repeat(200) };
const jsonStr = JSON.stringify(json);
const fileSize = jsonStr.length;
(stat as jest.Mock).mockResolvedValue({ size: fileSize });
const mockStream = new Readable({
read() {
this.push(jsonStr);
this.push(null);
},
});
(createReadStream as jest.Mock).mockReturnValue(mockStream);
await readJsonFile(mockFilePath, { streamThreshold: customThreshold });
expect(createReadStream).toHaveBeenCalled();
});
it('should preserve type with generics', async () => {
interface TestType {
id: number;
name: string;
}
const typedJson: TestType = { id: 1, name: 'test' };
const jsonString = JSON.stringify(typedJson);
(stat as jest.Mock).mockResolvedValue({ size: jsonString.length });
(readFile as jest.Mock).mockResolvedValue(jsonString);
const result = await readJsonFile<TestType>(mockFilePath);
expect(result).toEqual(typedJson);
expect(result.id).toBe(1);
expect(result.name).toBe('test');
});
});
});
|