-
-
Notifications
You must be signed in to change notification settings - Fork 87
/
Copy pathtest.spec.js
1000 lines (866 loc) · 34.3 KB
/
test.spec.js
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
const { Readable } = require('stream');
const config = require('config');
const S3Adapter = require('../index');
const optionsFromArguments = require('../lib/optionsFromArguments');
const { GetObjectCommand, PutObjectCommand, HeadBucketCommand, CreateBucketCommand } = require('@aws-sdk/client-s3');
const { getMockS3Adapter } = require('./mocks/s3adapter');
const rewire = require('rewire');
describe('S3Adapter tests', () => {
beforeEach(() => {
delete process.env.S3_BUCKET;
delete process.env.S3_REGION;
spyOn(console, 'warn').and.returnValue();
});
it('should throw when not initialized properly', () => {
expect(() => {
new S3Adapter();
}).toThrow(new Error("S3Adapter requires option 'bucket' or env. variable S3_BUCKET"));
expect(() => {
new S3Adapter('accessKey', 'secretKey', {});
}).toThrow(new Error("Failed to configure S3Adapter. Arguments don't make sense"));
expect(() => {
new S3Adapter({ accessKey: 'accessKey', secretKey: 'secretKey' });
}).toThrow(new Error("S3Adapter requires option 'bucket' or env. variable S3_BUCKET"));
});
it('should not throw when initialized properly', () => {
expect(() => {
new S3Adapter('bucket');
}).not.toThrow();
expect(() => {
new S3Adapter({ bucket: 'bucket' });
}).not.toThrow();
expect(() => {
new S3Adapter({}, { params: { Bucket: 'bucket' } });
}).not.toThrow();
});
it('should accept environment for required', () => {
const TEST_BUCKET = 'testBucket';
process.env.S3_BUCKET = TEST_BUCKET;
const s3 = new S3Adapter();
expect(s3._bucket).toBe(TEST_BUCKET);
});
describe('bucket operations', () => {
let s3, s3ClientMock;
beforeEach(() => {
const options = {
bucket: 'bucket-1',
bucketPrefix: 'test/',
};
s3ClientMock = jasmine.createSpyObj('S3Client', ['send']);
s3ClientMock.send.and.returnValue(Promise.resolve());
s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
});
it('should return early if _hasBucket is true', async () => {
s3._hasBucket = true;
await s3.createBucket();
expect(s3ClientMock.send).not.toHaveBeenCalled();
});
it('should set _hasBucket to true if bucket exists', async () => {
s3ClientMock.send.and.returnValue(Promise.resolve({}));
await s3.createBucket();
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(HeadBucketCommand));
expect(s3._hasBucket).toBe(true);
});
it('should attempt to create bucket if NotFound error occurs', async () => {
const notFoundError = { name: 'NotFound' };
s3ClientMock.send.and.returnValues(
Promise.reject(notFoundError),
Promise.resolve({})
);
await s3.createBucket();
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(HeadBucketCommand));
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(CreateBucketCommand));
expect(s3._hasBucket).toBe(true);
});
it('should handle BucketAlreadyExists error during creation', async () => {
const notFoundError = { name: 'NotFound' };
const bucketExistsError = { name: 'BucketAlreadyExists' };
s3ClientMock.send.and.returnValues(
Promise.reject(notFoundError),
Promise.reject(bucketExistsError)
);
await s3.createBucket();
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(HeadBucketCommand));
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(CreateBucketCommand));
expect(s3._hasBucket).toBe(true);
});
it('should handle BucketAlreadyOwnedByYou error during creation', async () => {
const notFoundError = { name: 'NotFound' };
const bucketOwnedError = { name: 'BucketAlreadyOwnedByYou' };
s3ClientMock.send.and.returnValues(
Promise.reject(notFoundError),
Promise.reject(bucketOwnedError)
);
await s3.createBucket();
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(HeadBucketCommand));
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(CreateBucketCommand));
expect(s3._hasBucket).toBe(true);
});
it('should throw non-NotFound errors during check', async () => {
const otherError = { name: 'SomeOtherError' };
s3ClientMock.send.and.returnValue(Promise.reject(otherError));
await expectAsync(s3.createBucket())
.toBeRejectedWith(otherError);
expect(s3._hasBucket).toBe(false);
});
it('should throw unexpected errors during creation', async () => {
const notFoundError = { name: 'NotFound' };
const creationError = { name: 'CreationError' };
s3ClientMock.send.and.returnValues(
Promise.reject(notFoundError),
Promise.reject(creationError)
);
await expectAsync(s3.createBucket())
.toBeRejectedWith(creationError);
expect(s3._hasBucket).toBe(false);
});
})
describe('configured with immutable values', () => {
describe('not initialized properly', () => {
it('should fail with two string arguments', () => {
expect(() => {
new S3Adapter(config.get('accessKey'), config.get('secretKey'), {});
}).toThrow(new Error('Failed to configure S3Adapter. Arguments don\'t make sense'));
});
it('should fail when passed an object without a bucket', () => {
expect(() => {
new S3Adapter(config.get('insufficientOptions'));
}).toThrow(new Error("S3Adapter requires option 'bucket' or env. variable S3_BUCKET"));
});
});
describe('should not throw when initialized properly', () => {
it('should accept a string bucket', () => {
expect(() => {
new S3Adapter(config.get('bucket'));
}).not.toThrow();
});
it('should accept an object with a bucket', () => {
expect(() => {
new S3Adapter(config.get('objectWithBucket'));
}).not.toThrow();
});
it('should accept a second argument of object with a params object with a bucket', () => {
expect(() => {
new S3Adapter(config.get('emptyObject'), config.get('paramsObjectWBucket'));
}).not.toThrow();
});
it('should accept environment over default', () => {
const TEST_REGION = 'test';
process.env.S3_REGION = TEST_REGION;
const s3 = new S3Adapter(config.get('bucket'));
expect(s3._region).toBe(TEST_REGION);
});
});
});
describe('to find the right arg in the right place', () => {
it('should accept just bucket as first string arg', () => {
const args = ['bucket'];
const options = optionsFromArguments(args);
expect(options.bucket).toEqual('bucket');
});
it('should accept bucket and options', () => {
const confObj = { bucketPrefix: 'test/' };
const args = ['bucket', confObj];
const options = optionsFromArguments(args);
expect(options.bucket).toEqual('bucket');
expect(options.bucketPrefix).toEqual('test/');
});
it('should accept key, secret, and bucket as args', () => {
const args = ['key', 'secret', 'bucket'];
const options = optionsFromArguments(args);
expect(options.accessKey).toEqual('key');
expect(options.secretKey).toEqual('secret');
expect(options.bucket).toEqual('bucket');
});
it('should accept key, secret, bucket, and options object as args', () => {
const confObj = { bucketPrefix: 'test/' };
const args = ['key', 'secret', 'bucket', confObj];
const options = optionsFromArguments(args);
expect(options.accessKey).toEqual('key');
expect(options.secretKey).toEqual('secret');
expect(options.bucket).toEqual('bucket');
expect(options.bucketPrefix).toEqual('test/');
});
it('should use credentials when provided', async () => {
const mockCredentials = {
accessKeyId: 'mockAccessKeyId',
secretAccessKey: 'mockSecretAccessKey',
sessionToken: 'mockSessionToken',
};
const options = {
bucket: 'bucket-1',
credentials: mockCredentials
};
const adapter = new S3Adapter(options);
const credentials = await adapter._s3Client.config.credentials();
expect(credentials.accessKeyId).toEqual(mockCredentials.accessKeyId);
expect(credentials.secretAccessKey).toEqual(mockCredentials.secretAccessKey);
expect(credentials.sessionToken).toEqual(mockCredentials.sessionToken);
});
it('should accept options and overrides as an option in args', () => {
const confObj = {
bucketPrefix: 'test/',
bucket: 'bucket-1',
secretKey: 'secret-1',
accessKey: 'key-1',
s3overrides: {
secretAccessKey: 'secret-2',
accessKeyId: 'key-2',
params: { Bucket: 'bucket-2' },
},
};
const s3 = new S3Adapter(confObj);
expect(s3._s3Client.config.accessKeyId).toEqual('key-2');
expect(s3._s3Client.config.secretAccessKey).toEqual('secret-2');
expect(s3._s3Client.config.params.Bucket).toEqual('bucket-2');
expect(s3._bucketPrefix).toEqual('test/');
});
it('should accept endpoint as an override option in args', async () => {
const otherEndpoint = 'https://example.com:8080/path?foo=bar';
const confObj = {
bucketPrefix: 'test/',
bucket: 'bucket-1',
secretKey: 'secret-1',
accessKey: 'key-1',
s3overrides: { endpoint: otherEndpoint },
};
const s3 = new S3Adapter(confObj);
expect(s3._endpoint).toEqual(otherEndpoint);
const endpointFromConfig = await s3._s3Client.config.endpoint();
expect(endpointFromConfig.protocol).toEqual('https:');
expect(endpointFromConfig.path).toEqual('/path');
expect(endpointFromConfig.port).toEqual(8080);
expect(endpointFromConfig.hostname).toEqual('example.com');
expect(endpointFromConfig.query.foo).toEqual('bar');
});
it("should have undefined endpoint if no custom endpoint is provided", async () => {
const confObj = {
bucketPrefix: 'test/',
bucket: 'bucket-1',
secretKey: 'secret-1',
accessKey: 'key-1',
};
const s3 = new S3Adapter(confObj);
const endpoint = await s3._s3Client.config.endpoint?.();
expect(endpoint).toBeUndefined();
});
it('should accept options and overrides as args', () => {
const confObj = {
bucketPrefix: 'test/',
bucket: 'bucket-1',
secretKey: 'secret-1',
accessKey: 'key-1',
};
const overridesObj = {
secretAccessKey: 'secret-2',
accessKeyId: 'key-2',
params: { Bucket: 'bucket-2' },
};
const s3 = new S3Adapter(confObj, overridesObj);
expect(s3._s3Client.config.accessKeyId).toEqual('key-2');
expect(s3._s3Client.config.secretAccessKey).toEqual('secret-2');
expect(s3._s3Client.config.params.Bucket).toEqual('bucket-2');
expect(s3._bucketPrefix).toEqual('test/');
});
it('should accept overrides without params', () => {
const confObj = {
bucketPrefix: 'test/',
bucket: 'bucket-1',
secretKey: 'secret-1',
accessKey: 'key-1',
};
const overridesObj = { secretAccessKey: 'secret-2' };
const s3 = new S3Adapter(confObj, overridesObj);
expect(s3._s3Client.config.accessKeyId).toEqual('key-1');
expect(s3._s3Client.config.secretAccessKey).toEqual('secret-2');
expect(s3._s3Client.config.params.Bucket).toEqual('bucket-1');
expect(s3._bucketPrefix).toEqual('test/');
});
});
describe('getFileStream', () => {
it('should handle range bytes', () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket');
const s3ClientMock = jasmine.createSpyObj('S3Client', ['send']);
const stream = new Readable();
stream.push('hello world');
stream.push(null);
s3ClientMock.send.and.returnValue(Promise.resolve({ Body: stream }));
s3._s3Client = s3ClientMock;
const req = {
get: () => 'bytes=0-1',
};
const resp = {
writeHead: jasmine.createSpy('writeHead'),
write: jasmine.createSpy('write'),
end: jasmine.createSpy('end'),
};
s3.handleFileStream('test.mov', req, resp).then(data => {
expect(data.toString('utf8')).toBe('hello world');
expect(resp.writeHead).toHaveBeenCalled();
expect(resp.write).toHaveBeenCalled();
expect(resp.end).toHaveBeenCalled();
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
const commands = s3ClientMock.send.calls.all();
expect(commands[0].args[0]).toBeInstanceOf(HeadBucketCommand);
const commandArg = commands[1].args[0];
expect(commandArg).toBeInstanceOf(GetObjectCommand);
expect(commandArg.input.Range).toBe('bytes=0-1');
});
});
it('should handle range bytes error', () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket');
const s3ClientMock = jasmine.createSpyObj('S3Client', ['send']);
s3ClientMock.send.and.returnValue(Promise.reject('FileNotFound'));
s3._s3Client = s3ClientMock;
const req = {
get: () => 'bytes=0-1',
};
const resp = {
writeHead: jasmine.createSpy('writeHead'),
write: jasmine.createSpy('write'),
end: jasmine.createSpy('end'),
};
s3.handleFileStream('test.mov', req, resp).catch(error => {
expect(error).toBe('FileNotFound');
expect(resp.writeHead).not.toHaveBeenCalled();
expect(resp.write).not.toHaveBeenCalled();
expect(resp.end).not.toHaveBeenCalled();
});
});
it('should handle range bytes no data', () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket');
const s3ClientMock = jasmine.createSpyObj('S3Client', ['send']);
s3ClientMock.send.and.returnValue(Promise.resolve({}));
s3._s3Client = s3ClientMock;
const req = {
get: () => 'bytes=0-1',
};
const resp = {
writeHead: jasmine.createSpy('writeHead'),
write: jasmine.createSpy('write'),
end: jasmine.createSpy('end'),
};
s3.handleFileStream('test.mov', req, resp).catch(error => {
expect(error.message).toBe('S3 object body is missing.');
expect(resp.writeHead).not.toHaveBeenCalled();
expect(resp.write).not.toHaveBeenCalled();
expect(resp.end).not.toHaveBeenCalled();
});
});
it('should handle stream errors', async () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket');
const s3ClientMock = jasmine.createSpyObj('S3Client', ['send']);
const mockStream = {
on: (event, callback) => {
if (event === 'error') {
callback(new Error('Mock S3 Body error'));
}
},
};
s3ClientMock.send.and.returnValue(Promise.resolve({
Body: mockStream,
AcceptRanges: 'bytes',
ContentLength: 1024,
ContentRange: 'bytes 0-1024/2048',
ContentType: 'application/octet-stream',
}));
s3._s3Client = s3ClientMock;
const mockReq = {
get: () => 'bytes=0-1024',
};
const mockRes = {
status: jasmine.createSpy('status'),
send: jasmine.createSpy('send'),
writeHead: jasmine.createSpy('writeHead'),
write: jasmine.createSpy('write'),
end: jasmine.createSpy('end'),
};
s3.handleFileStream('test.mov', mockReq, mockRes).catch(() => {
expect(mockRes.status).toHaveBeenCalledWith(404);
expect(mockRes.send).toHaveBeenCalledWith('Mock S3 Body error');
});
});
});
describe('getFileLocation with directAccess', () => {
const testConfig = {
mount: 'http://my.server.com/parse',
applicationId: 'xxxx',
};
let options;
beforeEach(() => {
options = {
directAccess: true,
bucketPrefix: 'foo/bar/',
baseUrl: 'http://example.com/files',
};
});
it('should get using the baseUrl', async () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://example.com/files/foo/bar/test.png'
);
});
it('should get direct to baseUrl', async () => {
options.baseUrlDirect = true;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://example.com/files/test.png'
);
});
it('should get without directAccess', async () => {
options.directAccess = false;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://my.server.com/parse/files/xxxx/test.png'
);
});
it('should go directly to amazon', async () => {
delete options.baseUrl;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'https://my-bucket.s3.amazonaws.com/foo/bar/test.png'
);
});
});
describe('getFileLocation with baseUrl', () => {
const testConfig = {
mount: 'http://my.server.com/parse',
applicationId: 'xxxx',
};
let options;
beforeEach(() => {
options = {
directAccess: true,
bucketPrefix: 'foo/bar/',
baseUrl: (fileconfig, filename) => {
if (filename.length > 12) {
return 'http://example.com/files';
}
return 'http://example.com/files';
},
};
});
it('should get using the baseUrl', async () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://example.com/files/foo/bar/test.png'
);
});
it('should get direct to baseUrl', async () => {
options.baseUrlDirect = true;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://example.com/files/test.png'
);
});
it('should get without directAccess', async () => {
options.directAccess = false;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://my.server.com/parse/files/xxxx/test.png'
);
});
it('should go directly to amazon', async () => {
delete options.baseUrl;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'https://my-bucket.s3.amazonaws.com/foo/bar/test.png'
);
});
});
describe('getFileLocation with presignedUrl', () => {
const testConfig = {
mount: 'http://my.server.com/parse',
applicationId: 'xxxx',
};
let options;
beforeEach(() => {
options = {
presignedUrl: false,
directAccess: true,
bucketPrefix: 'foo/bar/',
baseUrl: 'http://example.com/files',
};
});
it('should get using the baseUrl', async () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://example.com/files/foo/bar/test.png'
);
});
it('when use presigned URL should use S3 \'getObject\' operation', async () => {
options.presignedUrl = true;
const s3 = getMockS3Adapter(options);
let getSignedUrlCommand = '';
s3.getFileSignedUrl = (_, command) => {
getSignedUrlCommand = command;
};
await s3.getFileLocation(testConfig, 'test.png');
expect(getSignedUrlCommand).toBeInstanceOf(GetObjectCommand);
});
it('should get using the baseUrl and amazon using presigned URL', async () => {
options.presignedUrl = true;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
const fileLocation = await s3.getFileLocation(testConfig, 'test.png');
expect(fileLocation).toMatch(/^http:\/\/example.com\/files\/foo\/bar\/test.png\?/);
expect(fileLocation).toMatch(
/X-Amz-Credential=accessKey%2F\d{8}%2F\w{2}-\w{1,9}-\d%2Fs3%2Faws4_request/
);
expect(fileLocation).toMatch(/X-Amz-Date=\d{8}T\d{6}Z/);
expect(fileLocation).toMatch(/X-Amz-Signature=.{64}/);
expect(fileLocation).toMatch(/X-Amz-Expires=\d{1,6}/);
expect(fileLocation).toContain('X-Amz-Algorithm=AWS4-HMAC-SHA256');
expect(fileLocation).toContain('X-Amz-SignedHeaders=host');
});
it('should get direct to baseUrl', async () => {
options.baseUrlDirect = true;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://example.com/files/test.png'
);
});
it('should get without directAccess', async () => {
options.directAccess = false;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'http://my.server.com/parse/files/xxxx/test.png'
);
});
it('should go directly to amazon', async () => {
delete options.baseUrl;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
await expectAsync(s3.getFileLocation(testConfig, 'test.png')).toBeResolvedTo(
'https://my-bucket.s3.amazonaws.com/foo/bar/test.png'
);
});
it('should go directly to amazon using presigned URL', async () => {
delete options.baseUrl;
options.presignedUrl = true;
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
const fileLocation = await s3.getFileLocation(testConfig, 'test.png');
expect(fileLocation).toMatch(
/^https:\/\/my-bucket.s3.us-east-1.amazonaws.com\/foo\/bar\/test.png\?/
);
expect(fileLocation).toMatch(
/X-Amz-Credential=accessKey%2F\d{8}%2Fus-east-1%2Fs3%2Faws4_request/
);
expect(fileLocation).toMatch(/X-Amz-Date=\d{8}T\d{6}Z/);
expect(fileLocation).toMatch(/X-Amz-Signature=.{64}/);
expect(fileLocation).toMatch(/X-Amz-Expires=\d{1,6}/);
expect(fileLocation).toContain('X-Amz-Algorithm=AWS4-HMAC-SHA256');
expect(fileLocation).toContain('X-Amz-SignedHeaders=host');
});
});
describe('validateFilename', () => {
let options;
beforeEach(() => {
options = {
validateFilename: null,
};
});
it('should be null by default', () => {
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
expect(s3.validateFilename === null).toBe(true);
});
it('should not allow directories when overridden', () => {
options.validateFilename = filename => {
if (filename.indexOf('/') !== -1) {
return new Parse.Error(
Parse.Error.INVALID_FILE_NAME,
'Filename contains invalid characters.'
);
}
return null;
};
const s3 = new S3Adapter('accessKey', 'secretKey', 'my-bucket', options);
expect(s3.validateFilename('foo/bar') instanceof Parse.Error).toBe(true);
});
});
describe('generateKey', () => {
let options;
const promises = [];
beforeEach(() => {
options = {
bucketPrefix: 'test/',
generateKey: filename => {
let key = '';
const lastSlash = filename.lastIndexOf('/');
const prefix = `${Date.now()}_`;
if (lastSlash > 0) {
// put the prefix before the last component of the filename
key +=
filename.substring(0, lastSlash + 1) + prefix + filename.substring(lastSlash + 1);
} else {
key += prefix + filename;
}
return key;
},
};
});
it('should return a file with a date stamp inserted in the path', () => {
const s3 = getMockS3Adapter(options);
const fileName = 'randomFileName.txt';
const response = s3.createFile(fileName, 'hello world', 'text/utf8').then(value => {
const url = new URL(value.location);
expect(url.pathname.indexOf(fileName) > 13).toBe(true);
});
promises.push(response);
});
it('should do nothing when null', () => {
options.generateKey = null;
const s3 = getMockS3Adapter(options);
const fileName = 'foo/randomFileName.txt';
const response = s3.createFile(fileName, 'hello world', 'text/utf8').then(value => {
const url = new URL(value.location);
expect(url.pathname.substring(1)).toEqual(options.bucketPrefix + fileName);
});
promises.push(response);
});
it('should add unique timestamp to the file name after the last directory when there is a path', () => {
const s3 = getMockS3Adapter(options);
const fileName = 'foo/randomFileName.txt';
const response = s3.createFile(fileName, 'hello world', 'text/utf8').then(value => {
const url = new URL(value.location);
expect(url.pathname.indexOf('foo/')).toEqual(6);
expect(url.pathname.indexOf('random') > 13).toBe(true);
});
promises.push(response);
});
afterAll(() => Promise.all(promises));
});
describe('createFile', () => {
let options, s3ClientMock;
beforeEach(() => {
options = {
bucket: 'bucket-1',
bucketPrefix: 'test/',
};
s3ClientMock = jasmine.createSpyObj('S3Client', ['send']);
s3ClientMock.send.and.returnValue(Promise.resolve());
});
it('should save a file with right command', async () => {
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
await s3.createFile('file.txt', 'hello world', 'text/utf8', {});
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(HeadBucketCommand));
expect(s3ClientMock.send).toHaveBeenCalledWith(jasmine.any(PutObjectCommand));
});
it('should save a file with metadata added', async () => {
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
const metadata = { foo: 'bar' };
await s3.createFile('file.txt', 'hello world', 'text/utf8', { metadata });
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
const commands = s3ClientMock.send.calls.all();
expect(commands[0].args[0]).toBeInstanceOf(HeadBucketCommand);
const commandArg = commands[1].args[0];
expect(commandArg).toBeInstanceOf(PutObjectCommand);
expect(commandArg.input.Metadata).toEqual({ foo: 'bar' });
});
it('should save a file with tags added', async () => {
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
const tags = { foo: 'bar', baz: 'bin' };
await s3.createFile('file.txt', 'hello world', 'text/utf8', { tags });
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
const commands = s3ClientMock.send.calls.all();
expect(commands[0].args[0]).toBeInstanceOf(HeadBucketCommand);
const commandArg = commands[1].args[0];
expect(commandArg).toBeInstanceOf(PutObjectCommand);
expect(commandArg.input.Tagging).toBe('foo=bar&baz=bin');
});
it('should save a file with proper ACL with direct access', async () => {
options.directAccess = true;
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
await s3.createFile('file.txt', 'hello world', 'text/utf8', {});
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
const commands = s3ClientMock.send.calls.all();
expect(commands[0].args[0]).toBeInstanceOf(HeadBucketCommand);
const commandArg = commands[1].args[0];
expect(commandArg).toBeInstanceOf(PutObjectCommand);
expect(commandArg.input.ACL).toBe('public-read');
});
it('should save a file with proper ACL without direct access', async () => {
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
await s3.createFile('file.txt', 'hello world', 'text/utf8', {});
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
const commands = s3ClientMock.send.calls.all();
expect(commands[0].args[0]).toBeInstanceOf(HeadBucketCommand);
const commandArg = commands[1].args[0];
expect(commandArg).toBeInstanceOf(PutObjectCommand);
expect(commandArg.input.ACL).toBeUndefined();
});
it('should save a file and override ACL with direct access', async () => {
options.directAccess = true;
options.fileAcl = 'private';
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
await s3.createFile('file.txt', 'hello world', 'text/utf8', {});
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
const commands = s3ClientMock.send.calls.all();
expect(commands[0].args[0]).toBeInstanceOf(HeadBucketCommand);
const commandArg = commands[1].args[0];
expect(commandArg).toBeInstanceOf(PutObjectCommand);
expect(commandArg.input.ACL).toBe('private');
});
it('should save a file and remove ACL with direct access', async () => {
// Create adapter
options.directAccess = true;
options.fileAcl = 'none';
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
await s3.createFile('file.txt', 'hello world', 'text/utf8', {});
expect(s3ClientMock.send).toHaveBeenCalledTimes(2);
const commands = s3ClientMock.send.calls.all();
expect(commands[0].args[0]).toBeInstanceOf(HeadBucketCommand);
const commandArg = commands[1].args[0];
expect(commandArg).toBeInstanceOf(PutObjectCommand);
expect(commandArg.input.ACL).toBeUndefined();
});
it('should return url when config is provided', async () => {
const options = {
bucket: 'bucket-1',
presignedUrl: true
};
const s3 = new S3Adapter(options);
const mockS3Response = {
ETag: '"mock-etag"',
VersionId: 'mock-version',
Location: 'mock-location'
};
s3ClientMock.send.and.returnValue(Promise.resolve(mockS3Response));
s3._s3Client = s3ClientMock;
// Mock getFileLocation to return a presigned URL
spyOn(s3, 'getFileLocation').and.returnValue(Promise.resolve('https://presigned-url.com/file.txt'));
const result = await s3.createFile(
'file.txt',
'hello world',
'text/utf8',
{},
{ mount: 'http://example.com', applicationId: 'test123' }
);
expect(result).toEqual({
location: jasmine.any(String),
name: 'file.txt',
s3_response: jasmine.any(Object),
url: 'https://presigned-url.com/file.txt'
});
});
it('should handle generateKey function errors', async () => {
const options = {
bucket: 'bucket-1',
generateKey: () => {
throw 'Generate key failed';
}
};
const s3 = new S3Adapter(options);
s3._s3Client = s3ClientMock;
await expectAsync(
s3.createFile('file.txt', 'hello world', 'text/utf8', {})
).toBeRejectedWithError('Generate key failed');
});
});
describe('handleFileStream', () => {
const filename = 'file.txt';
let s3;
beforeAll(async () => {
s3 = getMockS3Adapter({ bucketPrefix: 'test-prefix/' });
const testFileContent = 'hello world! This is a test file for S3 streaming.';
await s3.createFile(filename, testFileContent, 'text/plain', {});
});
afterAll(async () => {
await s3.deleteFile(filename);
});
it('should get stream bytes correctly', async () => {
const req = {
get: jasmine.createSpy('get').and.callFake(header => {
if (header === 'Range') { return 'bytes=0-10'; }
return null;
}),
};
const res = {
writeHead: jasmine.createSpy('writeHead'),
write: jasmine.createSpy('write'),
end: jasmine.createSpy('end'),
};
const data = await s3.handleFileStream(filename, req, res);
expect(data.toString('utf8')).toBe('hello world');
expect(res.writeHead).toHaveBeenCalled();
expect(res.write).toHaveBeenCalled();
expect(res.end).toHaveBeenCalled();
});
});
describe('credentials', () => {
let s3ClientMock, S3Adapter;
beforeEach(() => {
S3Adapter = rewire("../index");
s3ClientMock = jasmine.createSpy("S3Client").and.callFake(function (config) {
this.config = config;
});
S3Adapter.__set__("S3Client", s3ClientMock);
});
it('should use direct credentials', async () => {
const options = {
bucket: 'bucket-1',
accessKey: 'access-key',
secretKey: 'secret-key'
};
const s3 = new S3Adapter(options);
expect(s3._s3Client.config.credentials).toEqual({
accessKeyId: 'access-key',
secretAccessKey: 'secret-key'
});
});
it('should use credentials', async () => {
const options = {
bucket: 'bucket-1',
credentials: {
accessKeyId: 'access-key',
secretAccessKey: 'secret-key'
}
};
const s3 = new S3Adapter(options);
expect(s3._s3Client.config.credentials).toEqual({
accessKeyId: 'access-key',
secretAccessKey: 'secret-key'
});
});
it('should use s3overrides credentials', async () => {
const options = {
bucket: 'bucket-1',
s3overrides: {
credentials: {
accessKeyId: 'access-key',
secretAccessKey: 'secret-key'
}
}
};
const s3 = new S3Adapter(options);
expect(s3._s3Client.config.credentials).toEqual({
accessKeyId: 'access-key',
secretAccessKey: 'secret-key'
});
});
it('should handle custom credential provider', async () => {
const customCredentials = {
getCredentials: () => Promise.resolve({
accessKeyId: 'custom-key',
secretAccessKey: 'custom-secret'
})
};
const options = {
bucket: 'bucket-1',
credentials: customCredentials
};
const s3 = new S3Adapter(options);
expect(s3._s3Client.config.credentials).toBe(customCredentials);
});
});
});