-
-
Notifications
You must be signed in to change notification settings - Fork 345
/
test.js
582 lines (515 loc) · 14.2 KB
/
test.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
import process from 'node:process';
import {Buffer} from 'node:buffer';
import path from 'node:path';
import {fileURLToPath} from 'node:url';
import fs from 'node:fs';
import stream from 'node:stream';
import test from 'ava';
import {readableNoopStream} from 'noop-stream';
import {
fileTypeFromBuffer,
fileTypeFromStream,
fileTypeFromFile,
fileTypeStream,
supportedExtensions,
supportedMimeTypes,
} from './index.js';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const missingTests = new Set([
'mpc',
]);
const types = [...supportedExtensions].filter(ext => !missingTests.has(ext));
// Define an entry here only if the fixture has a different
// name than `fixture` or if you want multiple fixtures
const names = {
aac: [
'fixture-adts-mpeg2',
'fixture-adts-mpeg4',
'fixture-adts-mpeg4-2',
'fixture-id3v2',
],
asar: [
'fixture',
'fixture2',
],
arw: [
'fixture-sony-zv-e10',
],
cr3: [
'fixture',
],
dng: [
'fixture-Leica-M10',
],
nef: [
'fixture',
'fixture2',
'fixture3',
'fixture4',
],
'3gp': [
'fixture',
'fixture2',
],
woff2: [
'fixture',
'fixture-otto',
],
woff: [
'fixture',
'fixture-otto',
],
eot: [
'fixture',
'fixture-0x20001',
],
mov: [
'fixture',
'fixture-mjpeg',
'fixture-moov',
],
mp2: [
'fixture',
'fixture-mpa',
],
mp3: [
'fixture',
'fixture-mp2l3',
'fixture-ffe3',
],
mp4: [
'fixture-imovie',
'fixture-isom',
'fixture-isomv2',
'fixture-mp4v2',
'fixture-dash',
],
mts: [
'fixture-raw',
'fixture-bdav',
],
tif: [
'fixture-big-endian',
'fixture-little-endian',
],
gz: [
'fixture.tar',
],
xz: [
'fixture.tar',
],
lz: [
'fixture.tar',
],
Z: [
'fixture.tar',
],
zst: [
'fixture.tar',
],
mkv: [
'fixture',
'fixture2',
],
mpg: [
'fixture',
'fixture2',
'fixture.ps',
'fixture.sub',
],
heic: [
'fixture-mif1',
'fixture-msf1',
'fixture-heic',
],
ape: [
'fixture-monkeysaudio',
],
mpc: [
'fixture-sv7',
'fixture-sv8',
],
pcap: [
'fixture-big-endian',
'fixture-little-endian',
],
png: [
'fixture',
'fixture-itxt',
],
tar: [
'fixture',
'fixture-v7',
'fixture-spaces',
],
mie: [
'fixture-big-endian',
'fixture-little-endian',
],
m4a: [
'fixture-babys-songbook.m4b', // Actually it's an `.m4b`
],
flac: [
'fixture',
'fixture-id3v2', // FLAC prefixed with ID3v2 header
],
docx: [
'fixture',
'fixture2',
'fixture-office365',
],
pptx: [
'fixture',
'fixture2',
'fixture-office365',
],
xlsx: [
'fixture',
'fixture2',
'fixture-office365',
],
ogx: [
'fixture-unknown-ogg', // Manipulated fixture to unrecognized Ogg based file
],
avif: [
'fixture-yuv420-8bit', // Multiple bit-depths and/or subsamplings
'fixture-sequence',
],
eps: [
'fixture',
'fixture2',
],
cfb: [
'fixture.msi',
'fixture.xls',
'fixture.doc',
'fixture.ppt',
'fixture-2.doc',
],
asf: [
'fixture',
'fixture.wma',
'fixture.wmv',
],
ai: [
'fixture-normal', // Normal AI
'fixture-without-pdf-compatibility', // AI without the PDF compatibility (cannot be opened by PDF viewers I guess)
],
jxl: [
'fixture', // Image data stored within JXL container
'fixture2', // Bare image data with no container
],
pdf: [
'fixture',
'fixture-adobe-illustrator', // PDF saved from Adobe Illustrator, using the default "[Illustrator Default]" preset
'fixture-smallest', // PDF saved from Adobe Illustrator, using the preset "smallest PDF"
'fixture-fast-web', // PDF saved from Adobe Illustrator, using the default "[Illustrator Default"] preset, but enabling "Optimize for Fast Web View"
'fixture-printed', // PDF printed from Adobe Illustrator, but with a PDF printer.
],
webm: [
'fixture-null', // EBML DocType with trailing null character
],
xml: [
'fixture',
'fixture-utf8-bom', // UTF-8 with BOM
'fixture-utf16-be-bom', // UTF-16 little endian encoded XML, with BOM
'fixture-utf16-le-bom', // UTF-16 big endian encoded XML, with BOM
],
};
// Define an entry here only if the file type has potential
// for false-positives
const falsePositives = {
png: [
'fixture-corrupt',
],
};
// Known failing fixture
const failingFixture = new Set([
]);
async function checkBufferLike(t, type, bufferLike) {
const {ext, mime} = await fileTypeFromBuffer(bufferLike) || {};
t.is(ext, type);
t.is(typeof mime, 'string');
}
async function checkFile(t, type, filePath) {
const {ext, mime} = await fileTypeFromFile(filePath) || {};
t.is(ext, type);
t.is(typeof mime, 'string');
}
async function testFromFile(t, ext, name) {
const file = path.join(__dirname, 'fixture', `${(name || 'fixture')}.${ext}`);
return checkFile(t, ext, file);
}
async function testFromBuffer(t, ext, name) {
const fixtureName = `${(name || 'fixture')}.${ext}`;
const file = path.join(__dirname, 'fixture', fixtureName);
const chunk = fs.readFileSync(file);
await checkBufferLike(t, ext, chunk);
await checkBufferLike(t, ext, new Uint8Array(chunk));
await checkBufferLike(t, ext, chunk.buffer.slice(chunk.byteOffset, chunk.byteOffset + chunk.byteLength));
}
async function testFalsePositive(t, ext, name) {
const file = path.join(__dirname, 'fixture', `${name}.${ext}`);
await t.is(await fileTypeFromFile(file), undefined);
const chunk = fs.readFileSync(file);
t.is(await fileTypeFromBuffer(chunk), undefined);
t.is(await fileTypeFromBuffer(new Uint8Array(chunk)), undefined);
t.is(await fileTypeFromBuffer(chunk.buffer), undefined);
}
async function testFileFromStream(t, ext, name) {
const filename = `${(name || 'fixture')}.${ext}`;
const file = path.join(__dirname, 'fixture', filename);
const fileType = await fileTypeFromStream(fs.createReadStream(file));
t.truthy(fileType, `identify ${filename}`);
t.is(fileType.ext, ext, 'fileType.ext');
t.is(typeof fileType.mime, 'string', 'fileType.mime');
}
async function loadEntireFile(readable) {
const buffer = [];
for await (const chunk of readable) {
buffer.push(Buffer.from(chunk));
}
return Buffer.concat(buffer);
}
async function testStream(t, ext, name) {
const fixtureName = `${(name || 'fixture')}.${ext}`;
const file = path.join(__dirname, 'fixture', fixtureName);
const readableStream = await fileTypeStream(fs.createReadStream(file));
const fileStream = fs.createReadStream(file);
const [bufferA, bufferB] = await Promise.all([loadEntireFile(readableStream), loadEntireFile(fileStream)]);
t.true(bufferA.equals(bufferB));
}
let i = 0;
for (const type of types) {
if (Object.prototype.hasOwnProperty.call(names, type)) {
for (const name of names[type]) {
const fixtureName = `${name}.${type}`;
const _test = failingFixture.has(fixtureName) ? test.failing : test;
_test(`${name}.${type} ${i++} .fromFile() method - same fileType`, testFromFile, type, name);
_test(`${name}.${type} ${i++} .fromBuffer() method - same fileType`, testFromBuffer, type, name);
_test(`${name}.${type} ${i++} .fromStream() method - same fileType`, testFileFromStream, type, name);
test(`${name}.${type} ${i++} .stream() - identical streams`, testStream, type, name);
}
} else {
const fixtureName = `fixture.${type}`;
const _test = failingFixture.has(fixtureName) ? test.failing : test;
_test(`${type} ${i++} .fromFile()`, testFromFile, type);
_test(`${type} ${i++} .fromBuffer()`, testFromBuffer, type);
_test(`${type} ${i++} .fromStream()`, testFileFromStream, type);
test(`${type} ${i++} .stream() - identical streams`, testStream, type);
}
if (Object.prototype.hasOwnProperty.call(falsePositives, type)) {
for (const falsePositiveFile of falsePositives[type]) {
test(`false positive - ${type} ${i++}`, testFalsePositive, type, falsePositiveFile);
}
}
}
test('.stream() method - empty stream', async t => {
const newStream = await fileTypeStream(readableNoopStream());
t.is(newStream.fileType, undefined);
});
test('.stream() method - short stream', async t => {
const bufferA = Buffer.from([0, 1, 0, 1]);
class MyStream extends stream.Readable {
_read() {
this.push(bufferA);
this.push(null);
}
}
// Test filetype detection
const shortStream = new MyStream();
const newStream = await fileTypeStream(shortStream);
t.is(newStream.fileType, undefined);
// Test usability of returned stream
const bufferB = await loadEntireFile(newStream);
t.deepEqual(bufferA, bufferB);
});
test('.stream() method - no end-of-stream errors', async t => {
const file = path.join(__dirname, 'fixture', 'fixture.ogm');
const stream = await fileTypeStream(fs.createReadStream(file), {sampleSize: 30});
t.is(stream.fileType, undefined);
});
test('.stream() method - error event', async t => {
const errorMessage = 'Fixture';
const readableStream = new stream.Readable({
read() {
process.nextTick(() => {
this.emit('error', new Error(errorMessage));
});
},
});
await t.throwsAsync(fileTypeStream(readableStream), {message: errorMessage});
});
test('.stream() method - sampleSize option', async t => {
const file = path.join(__dirname, 'fixture', 'fixture.ogm');
let stream = await fileTypeStream(fs.createReadStream(file), {sampleSize: 30});
t.is(typeof (stream.fileType), 'undefined', 'file-type cannot be determined with a sampleSize of 30');
stream = await fileTypeStream(fs.createReadStream(file), {sampleSize: 4100});
t.is(typeof (stream.fileType), 'object', 'file-type can be determined with a sampleSize of 4100');
t.is(stream.fileType.mime, 'video/ogg');
});
test('supportedExtensions.has', t => {
t.true(supportedExtensions.has('jpg'));
t.false(supportedExtensions.has('blah'));
});
test('supportedMimeTypes.has', t => {
t.true(supportedMimeTypes.has('video/mpeg'));
t.false(supportedMimeTypes.has('video/blah'));
});
test('validate the input argument type', async t => {
await t.throwsAsync(fileTypeFromBuffer('x'), {
message: /Expected the `input` argument to be of type `Uint8Array`/,
});
await t.notThrowsAsync(fileTypeFromBuffer(Buffer.from('x')));
await t.notThrowsAsync(fileTypeFromBuffer(new Uint8Array()));
await t.notThrowsAsync(fileTypeFromBuffer(new ArrayBuffer()));
});
test('validate the repo has all extensions and mimes in sync', t => {
// File: core.js (base truth)
function readIndexJS() {
const core = fs.readFileSync('core.js', {encoding: 'utf8'});
const extArray = core.match(/(?<=ext:\s')(.*)(?=',)/g);
const mimeArray = core.match(/(?<=mime:\s')(.*)(?=')/g);
const exts = new Set(extArray);
const mimes = new Set(mimeArray);
return {
exts,
mimes,
};
}
// File: core.d.ts
function readIndexDTS() {
const core = fs.readFileSync('core.d.ts', {encoding: 'utf8'});
const matches = core.match(/(?<=\|\s')(.*)(?=')/g);
const extArray = [];
const mimeArray = [];
for (const match of matches) {
if (match.includes('/')) {
mimeArray.push(match);
} else {
extArray.push(match);
}
}
return {
extArray,
mimeArray,
};
}
// File: package.json
function readPackageJSON() {
const packageJson = fs.readFileSync('package.json', {encoding: 'utf8'});
const {keywords} = JSON.parse(packageJson);
const allowedExtras = new Set([
'mime',
'file',
'type',
'magic',
'archive',
'image',
'img',
'pic',
'picture',
'flash',
'photo',
'video',
'detect',
'check',
'is',
'exif',
'binary',
'buffer',
'uint8array',
'webassembly',
]);
const extArray = keywords.filter(keyword => !allowedExtras.has(keyword));
return extArray;
}
// File: readme.md
function readReadmeMD() {
const index = fs.readFileSync('readme.md', {encoding: 'utf8'});
const extArray = index.match(/(?<=-\s\[`)(.*)(?=`)/g);
return extArray;
}
// Helpers
// Find extensions/mimes that are defined twice in a file
function findDuplicates(input) {
// TODO: Fix this.
// eslint-disable-next-line unicorn/no-array-reduce
return input.reduce((accumulator, element, index, array) => {
if (array.indexOf(element) !== index && !accumulator.includes(element)) {
accumulator.push(element);
}
return accumulator;
}, []);
}
// Find extensions/mimes that are in another file but not in `core.js`
function findExtras(array, set) {
return array.filter(element => !set.has(element));
}
// Find extensions/mimes that are in `core.js` but missing from another file
function findMissing(array, set) {
const missing = [];
const other = new Set(array);
for (const elemenet of set) {
if (!other.has(elemenet)) {
missing.push(elemenet);
}
}
return missing;
}
// Test runner
function validate(found, baseTruth, fileName, extOrMime) {
const duplicates = findDuplicates(found);
const extras = findExtras(found, baseTruth);
const missing = findMissing(found, baseTruth);
t.is(duplicates.length, 0, `Found duplicate ${extOrMime}: ${duplicates} in ${fileName}.`);
t.is(extras.length, 0, `Extra ${extOrMime}: ${extras} in ${fileName}.`);
t.is(missing.length, 0, `Missing ${extOrMime}: ${missing} in ${fileName}.`);
}
// Get the base truth of extensions and mimes supported from core.js
const {exts, mimes} = readIndexJS();
// Validate all extensions
const filesWithExtensions = {
'core.d.ts': readIndexDTS().extArray,
'supported.js': [...supportedExtensions],
'package.json': readPackageJSON(),
'readme.md': readReadmeMD(),
};
for (const fileName in filesWithExtensions) {
if (filesWithExtensions[fileName]) {
const foundExtensions = filesWithExtensions[fileName];
validate(foundExtensions, exts, fileName, 'extensions');
}
}
// Validate all mimes
const filesWithMimeTypes = {
'core.d.ts': readIndexDTS().mimeArray,
'supported.js': [...supportedMimeTypes],
};
for (const fileName in filesWithMimeTypes) {
if (filesWithMimeTypes[fileName]) {
const foundMimeTypes = filesWithMimeTypes[fileName];
validate(foundMimeTypes, mimes, fileName, 'mimes');
}
}
});
class BufferedStream extends stream.Readable {
constructor(buffer) {
super();
this.push(buffer);
this.push(null);
}
_read() {}
}
test('odd file sizes', async t => {
const oddFileSizes = [1, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 255, 256, 257, 511, 512, 513];
for (const size of oddFileSizes) {
const buffer = Buffer.alloc(size);
await t.notThrowsAsync(fileTypeFromBuffer(buffer), `fromBuffer: File size: ${size} bytes`);
}
for (const size of oddFileSizes) {
const buffer = Buffer.alloc(size);
const stream = new BufferedStream(buffer);
await t.notThrowsAsync(fileTypeFromStream(stream), `fromStream: File size: ${size} bytes`);
}
});