Repository navigation
Expand file tree
/
Copy pathFile.spec.ts
More file actions
1151 lines (955 loc) · 44.7 KB
/
Copy pathFile.spec.ts
File metadata and controls
1151 lines (955 loc) · 44.7 KB
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* eslint-disable @typescript-eslint/no-explicit-any -- ok*/
import fs from 'fs';
import path from 'path';
import { Readable } from 'stream';
import { GetObjectCommand, GetObjectCommandOutput, S3Client } from '@aws-sdk/client-s3';
import { detectXml } from '@file-type/xml';
import { FileTypeResult, ReadableStreamWithFileType } from 'file-type/node';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import fetch from '@smooai/fetch';
import File, { FileSource } from '../src/File';
const {
setMockSteamFileTypeResult,
createMockTypedStream,
createMockReadStream,
resetMockSteamFileTypeResult,
mockWriteStream,
mockSteamFileTypeResult,
setMockStreamContent,
resetMockStreamContent,
} = vi.hoisted(() => {
const mockSteamFileTypeResult: Partial<Writable<FileTypeResult> & { useActual: boolean }> = { mime: 'text/plain', ext: 'txt', useActual: false };
let mockStreamContent: Uint8Array<ArrayBuffer> = new Uint8Array(8);
const setMockSteamFileTypeResult = (
fileTypeResult: Partial<Writable<FileTypeResult> & { useActual: boolean }> = { mime: 'text/plain', ext: 'txt', useActual: false },
) => {
mockSteamFileTypeResult.mime = fileTypeResult.mime;
mockSteamFileTypeResult.ext = fileTypeResult.ext;
mockSteamFileTypeResult.useActual = fileTypeResult.useActual;
};
const resetMockSteamFileTypeResult = () => {
setMockSteamFileTypeResult();
};
const setMockStreamContent = (content: Uint8Array<ArrayBuffer>) => {
mockStreamContent = content;
};
const resetMockStreamContent = () => {
setMockStreamContent(new Uint8Array(8));
};
// A real Readable, not a hand-rolled `{ read: () => Promise<bytes> }`. The old
// fake resolved a promise from `read()`, which a Node stream never does — it
// encoded the single-chunk truncation bug and so could never catch it.
const createMockReadStream = () => Readable.from([Buffer.from(new Uint8Array(8))]);
// Helper function to create a mock typed stream
const createMockTypedStream = (fileTypeOptions: Partial<FileTypeResult> = mockSteamFileTypeResult, content: Uint8Array = mockStreamContent) => {
return Object.assign(Readable.from([Buffer.from(content)]), {
fileType: fileTypeOptions,
}) as unknown as ReadableStreamWithFileType;
};
const mockWriteStream = {
write: vi.fn().mockImplementation((chunk, callback) => {
callback?.();
}),
end: vi.fn(),
on: vi.fn().mockImplementation((event, callback) => {
if (event === 'finish') {
callback();
}
}),
pipe: vi.fn().mockReturnThis(),
unpipe: vi.fn(),
cork: vi.fn(),
uncork: vi.fn(),
setDefaultEncoding: vi.fn(),
getDefaultEncoding: vi.fn(),
destroy: vi.fn(),
addListener: vi.fn(),
emit: vi.fn(),
eventNames: vi.fn(),
getMaxListeners: vi.fn(),
listenerCount: vi.fn(),
listeners: vi.fn(),
off: vi.fn(),
once: vi.fn(),
prependListener: vi.fn(),
prependOnceListener: vi.fn(),
rawListeners: vi.fn(),
removeAllListeners: vi.fn(),
removeListener: vi.fn(),
setMaxListeners: vi.fn(),
bytesWritten: 0,
path: '',
pending: false,
writable: true,
writableEnded: false,
writableFinished: false,
writableHighWaterMark: 0,
writableLength: 0,
writableObjectMode: false,
writableCorked: 0,
destroyed: false,
closed: false,
errored: null,
writableNeedDrain: false,
_write: vi.fn(),
_writev: vi.fn(),
_destroy: vi.fn(),
_final: vi.fn(),
} as unknown as fs.WriteStream;
return {
mockSteamFileTypeResult,
setMockSteamFileTypeResult,
createMockReadStream,
createMockTypedStream,
resetMockSteamFileTypeResult,
mockWriteStream,
mockStreamContent,
setMockStreamContent,
resetMockStreamContent,
};
});
// Mock fs
vi.mock('fs', async (importOriginal) => {
const actual = await importOriginal<typeof import('fs')>();
const def = {
createWriteStream: vi.fn(() => mockWriteStream),
createReadStream: actual.createReadStream,
constants: {
...actual.constants,
R_OK: 4,
W_OK: 2,
},
};
Object.defineProperty(def, 'promises', {
value: {
unlink: vi.fn(() => Promise.resolve()),
access: vi.fn(() => Promise.resolve()),
stat: vi.fn(() =>
Promise.resolve({
size: 100,
mtime: new Date('2024-01-01'),
birthtime: new Date('2023-12-31'),
}),
),
appendFile: vi.fn(() => Promise.resolve()),
readFile: vi.fn(() => Promise.resolve(Buffer.from(''))),
writeFile: vi.fn(() => Promise.resolve()),
truncate: vi.fn(() => Promise.resolve()),
},
writable: true,
});
return {
default: def,
...def,
};
});
function createMockFetch() {
// Mock @smooai/fetch
vi.mock('@smooai/fetch', () => ({
default: vi.fn(),
}));
}
type Writable<T> = {
-readonly [P in keyof T]: T[P];
};
// Mock stream-mmmagic
vi.mock('file-type/node', async (importOriginal) => {
const actual = await importOriginal<typeof import('file-type')>();
return {
fileTypeFromFile: vi.fn().mockResolvedValue({ mime: 'text/plain', ext: 'txt' }),
FileTypeParser: vi.fn().mockImplementation(() => ({
toDetectionStream: vi.fn().mockImplementation((...args) => {
if (mockSteamFileTypeResult.useActual) {
return new actual.FileTypeParser({
customDetectors: [detectXml],
}).toDetectionStream(args?.[0], args?.[1]);
}
return createMockTypedStream();
}),
})),
};
});
// Helper function to create a mock S3Client
function createMockS3Client(): S3Client {
return {
send: vi.fn().mockImplementation(async (command: any) => {
if (command instanceof GetObjectCommand) {
return {
Body: createMockReadStream(),
ContentType: 'text/plain',
ContentLength: 1024,
LastModified: new Date('2024-01-01'),
} as GetObjectCommandOutput;
}
return undefined;
}),
config: {},
destroy: vi.fn(),
middlewareStack: { clone: vi.fn(), use: vi.fn(), remove: vi.fn(), addRelativeTo: vi.fn(), resolve: vi.fn() },
} as unknown as S3Client;
}
// Mock AWS SDK
vi.mock('@aws-sdk/client-s3', async (importOriginal) => {
const actual = await importOriginal<typeof import('@aws-sdk/client-s3')>();
const mockS3Client = createMockS3Client();
return {
...actual,
S3Client: vi.fn().mockImplementation(() => mockS3Client),
};
});
// Mock S3 request presigner
vi.mock('@aws-sdk/s3-request-presigner', () => ({
getSignedUrl: vi.mocked(() => Promise.resolve('https://signed-url.com/example.txt')),
}));
function generateMockNodeReadStream(destinationPath: string) {
const mockNodeReadStream = Object.assign(
new Readable({
read() {
this.push(Buffer.from(new Uint8Array(8)));
this.push(null);
},
}),
{
close: vi.fn(),
bytesRead: 8,
path: destinationPath,
pending: false,
},
);
return mockNodeReadStream as unknown as ReturnType<typeof fs.createReadStream>;
}
describe('#File', () => {
beforeEach(() => {
createMockFetch();
vi.mocked(fs.createWriteStream).mockImplementation(() => mockWriteStream);
});
afterEach(() => {
resetMockSteamFileTypeResult();
resetMockStreamContent();
});
it('should return metadata with valid options', async () => {
const response = new Response(new ReadableStream(), {
headers: {
'content-disposition': 'attachment; filename="example.txt"',
'content-type': 'text/plain',
'content-length': '1024',
},
status: 200,
});
const expectedMetadata = {
name: 'example.txt',
mimeType: 'text/plain',
size: 1024,
extension: 'txt',
url: 'https://smoo.ai/example.txt',
hash: undefined,
lastModified: undefined,
createdAt: undefined,
path: undefined,
};
const metadata = await File.getFileMetadata({
fileSource: FileSource.Url,
internalResponse: response,
stream: createMockTypedStream(),
metadataHint: {
url: 'https://smoo.ai/example.txt',
size: 30,
mimeType: 'text/html',
name: 'blah.exe',
},
});
expect(metadata).toEqual(expectedMetadata);
});
it('should return metadata for word document', async () => {
const thisMockTypedStream = createMockTypedStream({
ext: 'docx',
mime: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
});
const response = new Response(new ReadableStream(), {
headers: {
'content-disposition': 'attachment; filename="example.docx"',
'content-type': 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
'content-length': '1024',
},
status: 200,
});
const expectedMetadata = {
name: 'example.docx',
mimeType: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
size: 1024,
extension: 'docx',
url: 'https://smoo.ai/example.docx',
hash: undefined,
lastModified: undefined,
createdAt: undefined,
path: undefined,
};
const metadata = await File.getFileMetadata({
fileSource: FileSource.Url,
internalResponse: response,
stream: thisMockTypedStream,
metadataHint: {
url: 'https://smoo.ai/example.docx',
},
});
expect(metadata).toEqual(expectedMetadata);
});
it('should return empty metadata when options are not provided', async () => {
const metadata = await File.getFileMetadata({ fileSource: FileSource.Url });
expect(metadata.extension).toBeUndefined();
expect(metadata.name).toBeUndefined();
expect(metadata.mimeType).toBeUndefined();
expect(metadata.size).toBeUndefined();
expect(metadata.url).toBeUndefined();
expect(metadata.hash).toBeUndefined();
expect(metadata.lastModified).toBeUndefined();
expect(metadata.createdAt).toBeUndefined();
expect(metadata.path).toBeUndefined();
});
it('should handle missing or invalid headers', async () => {
const thisMockTypedStream = createMockTypedStream({});
const response = new Response(new ReadableStream(), {
headers: {},
status: 200,
});
const metadata = await File.getFileMetadata({
fileSource: FileSource.Url,
internalResponse: response,
stream: thisMockTypedStream,
});
expect(metadata.extension).toBeUndefined();
expect(metadata.name).toBeUndefined();
expect(metadata.mimeType).toBeUndefined();
expect(metadata.size).toBeUndefined();
expect(metadata.url).toBeUndefined();
expect(metadata.hash).toBeUndefined();
expect(metadata.lastModified).toBeUndefined();
expect(metadata.createdAt).toBeUndefined();
expect(metadata.path).toBeUndefined();
});
it('should create file from url', async () => {
setMockSteamFileTypeResult({ mime: 'image/png', ext: 'png' });
const url = 'https://example.com/example.png';
const response = new Response(new ReadableStream(), {
headers: {
'content-disposition': 'attachment; filename="example.png"',
'content-type': 'image/png',
},
});
vi.mocked(fetch).mockResolvedValueOnce(response as unknown as Response & { data?: unknown; isJson: boolean; dataString: string });
const file = await File.createFromUrl(url, { size: 19463 });
expect(file.metadata).toEqual({
name: 'example.png',
mimeType: 'image/png',
size: 19463,
extension: 'png',
url,
hash: undefined,
lastModified: undefined,
createdAt: undefined,
path: undefined,
});
});
describe('file system operations', () => {
it('should save bytes as file to disk', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8), { name: 'example.txt' });
const destinationPath = path.join(__dirname, 'test', '/example-save-to-disk.txt');
const mockWriteStream = {
write: vi.fn().mockImplementation((_chunk, callback) => {
callback?.();
}),
end: vi.fn(),
on: vi.fn().mockImplementation((event, callback) => {
if (event === 'finish') {
callback();
}
}),
pipe: vi.fn().mockReturnThis(),
} as unknown as ReturnType<typeof fs.createWriteStream>;
vi.mocked(fs.createWriteStream).mockReturnValue(mockWriteStream);
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
await file.saveToFile(destinationPath);
});
it('should copy bytes as file to new location', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8), { name: 'example.txt' });
const destinationPath = path.join(__dirname, 'test', '/example-copy.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
await file.saveToFile(destinationPath);
});
it('should move bytes as file to new location', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8), { name: 'example.txt' });
const destinationPath = path.join(__dirname, 'test', '/example-moved.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
await file.saveToFile(destinationPath);
});
it('should copy existing file to new location', async () => {
const sourcePath = path.join(__dirname, 'test', 'example.txt');
const file = await File.createFromFile(sourcePath, { name: 'example.txt' });
const destinationPath = path.join(__dirname, 'test', '/example-copy.txt');
const mockWriteStream = {
write: vi.fn().mockImplementation((_chunk, callback) => {
callback?.();
}),
end: vi.fn(),
on: vi.fn().mockImplementation((event, callback) => {
if (event === 'finish') {
callback();
}
}),
pipe: vi.fn().mockReturnThis(),
} as unknown as ReturnType<typeof fs.createWriteStream>;
vi.mocked(fs.createWriteStream).mockReturnValue(mockWriteStream);
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
await file.saveToFile(destinationPath);
});
it('should move existing file to new location', async () => {
const sourcePath = path.join(__dirname, 'test', 'example.txt');
const file = await File.createFromFile(sourcePath, { name: 'example.txt' });
const destinationPath = path.join(__dirname, 'test', '/example-moved.txt');
const mockWriteStream = {
write: vi.fn().mockImplementation((_chunk, callback) => {
callback?.();
}),
end: vi.fn(),
on: vi.fn().mockImplementation((event, callback) => {
if (event === 'finish') {
callback();
}
}),
pipe: vi.fn().mockReturnThis(),
} as unknown as ReturnType<typeof fs.createWriteStream>;
vi.mocked(fs.createWriteStream).mockReturnValue(mockWriteStream);
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
await file.moveTo(destinationPath);
expect(vi.mocked(fs.promises.unlink)).toHaveBeenCalledWith(sourcePath);
});
it('should delete file', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
await file.delete();
expect(vi.mocked(fs.promises.unlink)).toHaveBeenCalledWith(path.join(__dirname, 'test', 'example.txt'));
});
it('should check if file exists', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
vi.mocked(fs.promises.access).mockResolvedValue(undefined);
const exists = await file.exists();
expect(exists).toBe(true);
});
it('should check if file is readable', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
vi.mocked(fs.promises.access).mockResolvedValue(undefined);
const isReadable = await file.isReadable();
expect(isReadable).toBe(true);
});
it('should check if file is writable', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
vi.mocked(fs.promises.access).mockResolvedValue(undefined);
const isWritable = await file.isWritable();
expect(isWritable).toBe(true);
});
it('should append content to file', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
const content = 'new content';
await file.append(content);
expect(vi.mocked(fs.promises.appendFile)).toHaveBeenCalledWith(path.join(__dirname, 'test', 'example.txt'), Buffer.from(content));
});
it('should prepend content to file', async () => {
setMockStreamContent(new Uint8Array(Buffer.from('existing content')));
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
const content = 'new content';
const existingContent = Buffer.from('existing content');
vi.mocked(fs.promises.readFile).mockResolvedValue(existingContent);
await file.prepend(content);
expect(vi.mocked(fs.promises.writeFile)).toHaveBeenCalledWith(
path.join(__dirname, 'test', 'example.txt'),
Buffer.concat([Buffer.from(content), existingContent]),
);
});
it('should truncate file', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
const size = 100;
await file.truncate(size);
expect(vi.mocked(fs.promises.truncate)).toHaveBeenCalledWith(path.join(__dirname, 'test', 'example.txt'), size);
});
});
describe('stream operations', () => {
it('should pipe to writable stream', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8), { name: 'example.txt' });
const mockWriter = {
write: vi.fn().mockImplementation((chunk, callback) => {
callback?.();
}),
end: vi.fn(),
on: vi.fn().mockImplementation((event, callback) => {
if (event === 'finish') {
callback();
}
}),
} as unknown as NodeJS.WritableStream;
await file.pipeTo(mockWriter);
});
it('should refresh stream for file source', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
await file.readFileBytes();
const destinationPath = path.join(__dirname, 'test', 'example-refreshed.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
// Refresh the stream
await file.saveToFile(destinationPath);
// Verify we can still read from the refreshed stream
const newBytes = await file.readFileBytes();
expect(newBytes).toBeDefined();
});
it('should refresh stream for S3 source', async () => {
const file = await File.createFromS3('test-bucket', 'test-key.txt');
// Refresh the stream
await file.saveToS3('test-bucket', 'test-key-refreshed.txt');
// Verify we can still read from the refreshed stream
const newBytes = await file.readFileBytes();
expect(newBytes).toBeDefined();
});
it('should refresh stream for URL source', async () => {
const response = new Response(new ReadableStream(), {
headers: {
'content-disposition': 'attachment; filename="test.txt"',
'content-type': 'text/plain',
'content-length': '8',
etag: '"abc123"',
'last-modified': '2024-01-01T00:00:00Z',
},
});
vi.mocked(fetch).mockResolvedValueOnce(response as unknown as Response & { data?: unknown; isJson: boolean; dataString: string });
setMockSteamFileTypeResult({ mime: 'text/plain', ext: 'txt' });
const file = await File.createFromUrl('https://example.com/test.txt');
await file.readFileBytes();
const destinationPath = path.join(__dirname, 'test', 'example-refreshed.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
// Refresh the stream
await file.saveToFile(destinationPath);
// Verify we can still read from the refreshed stream
const newBytes = await file.readFileBytes();
expect(newBytes).toBeDefined();
});
it('should refresh stream for bytes source', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8));
// Consume the stream
await file.readFileBytes();
const destinationPath = path.join(__dirname, 'test', 'example-refreshed.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
// Refresh the stream
await file.saveToFile(destinationPath);
// Verify we can still read from the refreshed stream
const newBytes = await file.readFileBytes();
expect(newBytes).toBeDefined();
});
});
describe('file instance operations', () => {
it('should preserve original file instance after saveToFile', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const destinationPath = path.join(__dirname, 'test', 'destination.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
const result = await sourceFile.saveToFile(destinationPath);
expect(result.original).toBe(sourceFile);
expect(result.newFile).toBeInstanceOf(File);
expect(result.newFile.metadata.path).toBe(destinationPath);
// Verify original file is still usable
const originalBytes = await result.original.readFileBytes();
expect(originalBytes).toBeDefined();
expect(originalBytes.byteLength).toBeGreaterThan(0);
});
it('should preserve original file instance after saveToS3', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const bucket = 'test-bucket';
const key = 'test-key.txt';
const result = await sourceFile.saveToS3(bucket, key);
expect(result.original).toBe(sourceFile);
expect(result.newFile).toBeInstanceOf(File);
expect(result.newFile.metadata.url).toBe(`s3://${bucket}/${key}`);
// Verify original file is still usable
const originalBytes = await result.original.readFileBytes();
expect(originalBytes).toBeDefined();
expect(originalBytes.byteLength).toBeGreaterThan(0);
});
it('should return new file instance after moveTo', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const destinationPath = path.join(__dirname, 'test', 'destination.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
const newFile = await sourceFile.moveTo(destinationPath);
expect(newFile).toBeInstanceOf(File);
expect(newFile.metadata.path).toBe(destinationPath);
// Verify source file is deleted
expect(vi.mocked(fs.promises.unlink)).toHaveBeenCalledWith(path.join(__dirname, 'test', 'example.txt'));
});
it('should return new file instance after moveToS3', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const bucket = 'test-bucket';
const key = 'test-key.txt';
const newFile = await sourceFile.moveToS3(bucket, key);
expect(newFile).toBeInstanceOf(File);
expect(newFile.metadata.url).toBe(`s3://${bucket}/${key}`);
// Verify source file is deleted
expect(vi.mocked(fs.promises.unlink)).toHaveBeenCalledWith(path.join(__dirname, 'test', 'example.txt'));
});
});
describe('S3 operations', () => {
it('should upload to S3', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8), {
name: 'example.txt',
mimeType: 'text/plain',
size: 8,
});
const bucket = 'test-bucket';
const key = 'example.txt';
await file.uploadToS3(bucket, key);
const s3Client = new S3Client();
expect(s3Client.send).toHaveBeenCalledWith(
expect.objectContaining({
input: expect.objectContaining({
Bucket: bucket,
Key: key,
ContentType: 'text/plain',
ContentLength: 8,
ContentDisposition: 'attachment; filename="example.txt"',
}),
}),
);
});
it('should move to S3', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), {
name: 'example.txt',
mimeType: 'text/plain',
size: 8,
});
const bucket = 'test-bucket';
const key = 'example.txt';
await file.moveToS3(bucket, key);
expect(vi.mocked(fs.promises.unlink)).toHaveBeenCalledWith(path.join(__dirname, 'test', 'example.txt'));
});
it('should create file from S3', async () => {
const bucket = 'test-bucket';
const key = 'example.txt';
const s3Client = new S3Client();
const file = await File.createFromS3(bucket, key);
expect(file.metadata).toEqual({
name: 'example.txt',
mimeType: 'text/plain',
size: 1024,
extension: 'txt',
url: `s3://${bucket}/${key}`,
hash: undefined,
lastModified: new Date('2024-01-01'),
createdAt: undefined,
path: undefined,
});
expect(s3Client.send).toHaveBeenCalledWith(
expect.objectContaining({
input: expect.objectContaining({
Bucket: bucket,
Key: key,
}),
}),
);
});
it('should throw error when S3 response body is missing', async () => {
const bucket = 'test-bucket';
const key = 'example.txt';
const s3Client = new S3Client();
const mockSend = vi.mocked(s3Client.send);
mockSend.mockImplementationOnce(async (command: any) => {
if (command instanceof GetObjectCommand) {
return {
Body: undefined,
ContentType: 'text/plain',
ContentLength: 1024,
LastModified: new Date('2024-01-01'),
} as GetObjectCommandOutput;
}
return undefined;
});
await expect(File.createFromS3(bucket, key)).rejects.toThrow('Response body is missing');
});
it('should handle S3 errors', async () => {
const bucket = 'test-bucket';
const key = 'example.txt';
const s3Client = new S3Client();
vi.mocked(s3Client.send).mockRejectedValueOnce(new Error('S3 error'));
await expect(File.createFromS3(bucket, key)).rejects.toThrow('S3 error');
});
it('should handle S3 file source', async () => {
const file = await File.createFromS3('test-bucket', 'test-key.txt');
expect(file.source).toBe(FileSource.S3);
expect(file.metadata.url).toBe('s3://test-bucket/test-key.txt');
});
it('should move file and return new file instance', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const destinationPath = path.join(__dirname, 'test', 'destination.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
const newFile = await sourceFile.moveTo(destinationPath);
expect(newFile).toBeInstanceOf(File);
expect(newFile.toString()).toContain(FileSource.File);
expect(newFile.metadata.path).toBe(destinationPath);
expect(newFile.metadata.name).toBe('destination.txt');
});
it('should copy file and return new file instance', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const destinationPath = path.join(__dirname, 'test', 'destination.txt');
vi.spyOn(fs, 'createReadStream').mockImplementationOnce(() => generateMockNodeReadStream(destinationPath));
const result = await sourceFile.saveToFile(destinationPath);
expect(result.original).toBe(sourceFile);
expect(result.newFile).toBeInstanceOf(File);
expect(result.newFile.toString()).toContain(FileSource.File);
expect(result.newFile.metadata.path).toBe(destinationPath);
expect(result.newFile.metadata.name).toBe('destination.txt');
});
it('should move file to S3 and return new S3 file instance', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const bucket = 'test-bucket';
const key = 'test-key.txt';
const newFile = await sourceFile.moveToS3(bucket, key);
expect(newFile).toBeInstanceOf(File);
expect(newFile.toString()).toContain(FileSource.S3);
expect(newFile.metadata.url).toBe(`s3://${bucket}/${key}`);
expect(newFile.metadata.name).toBe('test-key.txt');
});
it('should copy file to S3 and return new S3 file instance', async () => {
const sourceFile = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
const bucket = 'test-bucket';
const key = 'test-key.txt';
const result = await sourceFile.saveToS3(bucket, key);
expect(result.original).toBe(sourceFile);
expect(result.newFile).toBeInstanceOf(File);
expect(result.newFile.toString()).toContain(FileSource.S3);
expect(result.newFile.metadata.url).toBe(`s3://${bucket}/${key}`);
expect(result.newFile.metadata.name).toBe('test-key.txt');
});
it('should get signed URL for S3 file', async () => {
const file = await File.createFromS3('test-bucket', 'test-key.txt');
const signedUrl = await file.getSignedUrl();
expect(signedUrl).toBe('https://signed-url.com/example.txt');
});
it('should throw error when getting signed URL for non-S3 file', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'));
await expect(file.getSignedUrl()).rejects.toThrow('Cannot generate signed URL for non-S3 file');
});
});
describe('metadata operations', () => {
it('should set metadata', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8), { name: 'example.txt' });
const newMetadata = {
name: 'new-name.txt',
mimeType: 'text/plain',
};
await file.setMetadata(newMetadata);
expect(file.metadata.name).toBe('new-name.txt');
expect(file.metadata.mimeType).toBe('text/plain');
});
it('should get file stats', async () => {
const file = await File.createFromFile(path.join(__dirname, 'test', 'example.txt'), { name: 'example.txt' });
const stats = await file.getStats();
expect(stats).toBeDefined();
expect(stats?.size).toBe(100);
expect(stats?.mtime).toEqual(new Date('2024-01-01'));
expect(stats?.birthtime).toEqual(new Date('2023-12-31'));
});
it('should generate checksum', async () => {
const file = await File.createFromBytes(new ArrayBuffer(8), { name: 'example.txt' });
const checksum = await file.getChecksum();
expect(checksum).toBeDefined();
expect(typeof checksum).toBe('string');
expect(checksum.length).toBe(64); // SHA-256 produces 64 hex characters
});
it('should read metadata from PNG file', async () => {
setMockSteamFileTypeResult({ useActual: true });
const file = await File.createFromFile(path.join(__dirname, 'test', '/icon.png'), { name: 'icon.png' });
expect(file.metadata).toEqual({
name: 'icon.png',
mimeType: 'image/png',
size: 100,
extension: 'png',
url: undefined,
hash: undefined,
lastModified: new Date('2024-01-01'),
createdAt: new Date('2023-12-31'),
path: path.join(__dirname, 'test', '/icon.png'),
});
});
it('should read metadata from SVG file', async () => {
setMockSteamFileTypeResult({ useActual: true });
const file = await File.createFromFile(path.join(__dirname, 'test', '/icon.svg'), { name: 'icon.svg' });
expect(file.metadata).toEqual({
name: 'icon.svg',
mimeType: 'image/svg+xml',
size: 100,
extension: 'svg',
url: undefined,
hash: undefined,
lastModified: new Date('2024-01-01'),
createdAt: new Date('2023-12-31'),
path: path.join(__dirname, 'test', '/icon.svg'),
});
});
it('should read metadata from DOCX file', async () => {
setMockSteamFileTypeResult({ useActual: true });
const file = await File.createFromFile(path.join(__dirname, 'test', '/example.docx'), { name: 'example.docx' });
expect(file.metadata).toEqual({
name: 'example.docx',
mimeType: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
size: 100,
extension: 'docx',
url: undefined,
hash: undefined,
lastModified: new Date('2024-01-01'),
createdAt: new Date('2023-12-31'),
path: path.join(__dirname, 'test', '/example.docx'),
});
});
it('should return undefined for missing metadata values', async () => {
setMockSteamFileTypeResult({ mime: undefined, ext: undefined });
const file = await File.createFromBytes(new ArrayBuffer(8));
expect(file.name).toBeUndefined();
expect(file.mimeType).toBeUndefined();
expect(file.size).toBe(8);
expect(file.extension).toBeUndefined();
expect(file.url).toBeUndefined();
expect(file.path).toBeUndefined();
expect(file.hash).toBeUndefined();
expect(file.lastModified).toBeUndefined();
expect(file.createdAt).toBeUndefined();
});
});
describe('metadata getters', () => {
it('should return correct metadata values from URL file', async () => {
const url = 'https://example.com/example.png';