-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathaggregateFiles.test.ts
More file actions
559 lines (477 loc) · 16.6 KB
/
aggregateFiles.test.ts
File metadata and controls
559 lines (477 loc) · 16.6 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
import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
import { aggregateFiles } from '../aggregateFiles.js';
import { logger } from '../../../console/logger.js';
import { readFile, getRelative } from '../../../fs/findFilepath.js';
import { parseJson } from '../../json/parseJson.js';
import parseYaml from '../../yaml/parseYaml.js';
import sanitizeFileContent from '../../../utils/sanitizeFileContent.js';
import { determineLibrary } from '../../../fs/determineFramework.js';
import { isValidMdx } from '../../../utils/validateMdx.js';
vi.mock('../../../console/logger.js', () => ({
logger: {
warn: vi.fn(),
error: vi.fn(),
},
}));
vi.mock('../../../fs/findFilepath.js');
vi.mock('../../json/parseJson.js');
vi.mock('../../yaml/parseYaml.js');
vi.mock('../../../utils/sanitizeFileContent.js');
vi.mock('../../../fs/determineFramework.js');
vi.mock('../../../utils/validateMdx.js');
const mockLogWarning = vi.mocked(logger.warn);
const mockReadFile = vi.mocked(readFile);
const mockGetRelative = vi.mocked(getRelative);
const mockParseJson = vi.mocked(parseJson);
const mockParseYaml = vi.mocked(parseYaml);
const mockSanitizeFileContent = vi.mocked(sanitizeFileContent);
const mockDetermineLibrary = vi.mocked(determineLibrary);
const mockIsValidMdx = vi.mocked(isValidMdx);
describe('aggregateFiles - Empty File Handling', () => {
beforeEach(() => {
vi.clearAllMocks();
// Default mocks
mockGetRelative.mockImplementation((path) =>
path.replace('/full/path/', '')
);
mockDetermineLibrary.mockReturnValue({
library: 'next-intl',
additionalModules: [],
});
// Mock parseJson to return empty string for empty/null content, valid content otherwise
mockParseJson.mockImplementation((content) => {
if (!content || !content.trim()) {
return ''; // Empty files result in empty parsed content
}
return 'parsed-json-content';
});
// Mock parseYaml to return empty string for empty/null content, valid content otherwise
mockParseYaml.mockImplementation((content) => {
if (!content || !content.trim()) {
return { content: '', fileFormat: 'YAML' }; // Empty files result in empty parsed content
}
return {
content: 'parsed-yaml-content',
fileFormat: 'YAML',
};
});
mockSanitizeFileContent.mockImplementation((content) => content);
mockIsValidMdx.mockReset();
mockIsValidMdx.mockReturnValue({ isValid: true });
});
afterEach(() => {
vi.clearAllMocks();
});
describe('JSON files', () => {
it('should skip empty JSON files and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
json: ['/full/path/empty.json', '/full/path/valid.json'],
},
placeholderPaths: {},
},
options: {},
defaultLocale: 'en',
};
mockReadFile
.mockReturnValueOnce('') // empty file
.mockReturnValueOnce('{"key": "value"}'); // valid file
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping empty.json: JSON file is not parsable'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.json');
});
it('should skip JSON files with only whitespace and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
json: ['/full/path/whitespace.json', '/full/path/valid.json'],
},
placeholderPaths: {},
},
options: {},
defaultLocale: 'en',
};
mockReadFile
.mockReturnValueOnce(' \n\t ') // whitespace only
.mockReturnValueOnce('{"key": "value"}'); // valid file
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping whitespace.json: JSON file is not parsable'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.json');
});
it('should allow invalid JSON when validation is skipped', async () => {
const settings = {
files: {
resolvedPaths: {
json: ['/full/path/invalid.json'],
},
placeholderPaths: {},
},
options: {
skipFileValidation: {
json: true,
},
},
defaultLocale: 'en',
};
mockReadFile.mockReturnValueOnce('{ invalid json');
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).not.toHaveBeenCalled();
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('invalid.json');
});
it('should skip JSON files that return null content and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
json: ['/full/path/null.json', '/full/path/valid.json'],
},
placeholderPaths: {},
},
options: {},
defaultLocale: 'en',
};
mockReadFile
.mockReturnValueOnce(null as any) // null content
.mockReturnValueOnce('{"key": "value"}'); // valid file
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping null.json: JSON file is empty'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.json');
});
});
describe('YAML files', () => {
it('should skip empty YAML files and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
yaml: ['/full/path/empty.yaml', '/full/path/valid.yaml'],
},
placeholderPaths: {},
},
options: {},
};
mockReadFile
.mockReturnValueOnce('') // empty file
.mockReturnValueOnce('key: value'); // valid file
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping empty.yaml: YAML file is empty'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.yaml');
});
it('should skip YAML files with only whitespace and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
yaml: ['/full/path/whitespace.yml', '/full/path/valid.yml'],
},
placeholderPaths: {},
},
options: {},
};
mockReadFile
.mockReturnValueOnce(' \n\t ') // whitespace only
.mockReturnValueOnce('key: value'); // valid file
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping whitespace.yml: YAML file is empty'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.yml');
});
});
describe('Other file types (MDX, MD, TS, etc.)', () => {
it('should skip empty MDX files and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
mdx: ['/full/path/empty.mdx', '/full/path/valid.mdx'],
},
placeholderPaths: {},
},
options: {},
};
mockReadFile
.mockReturnValueOnce('') // empty file
.mockReturnValueOnce('# Valid MDX'); // valid file
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping empty.mdx: File is empty after sanitization'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.mdx');
});
it('should skip MDX validation when configured', async () => {
const settings = {
files: {
resolvedPaths: {
mdx: ['/full/path/invalid.mdx'],
},
placeholderPaths: {},
},
options: {
skipFileValidation: {
mdx: true,
},
},
};
mockReadFile.mockReturnValueOnce('<>Invalid mdx');
mockIsValidMdx.mockReturnValueOnce({
isValid: false,
error: 'bad',
});
const result = await aggregateFiles(settings as any);
expect(mockIsValidMdx).not.toHaveBeenCalled();
expect(mockLogWarning).not.toHaveBeenCalled();
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('invalid.mdx');
});
it('should infer mintlify title from filename when missing', async () => {
const settings = {
files: {
resolvedPaths: {
mdx: ['/full/path/my-file.mdx'],
},
placeholderPaths: {},
},
defaultLocale: 'en',
framework: 'mintlify',
options: {
mintlify: {
inferTitleFromFilename: true,
},
},
};
mockReadFile.mockReturnValueOnce(
'---\nsummary: "Hello"\n---\n\n# Content'
);
const result = await aggregateFiles(settings as any);
expect(result).toHaveLength(1);
expect(result[0].content).toMatch(/title:\s*"?My File"?/);
});
it('should not change mintlify frontmatter when title is present', async () => {
const settings = {
files: {
resolvedPaths: {
mdx: ['/full/path/assistant.mdx'],
},
placeholderPaths: {},
},
defaultLocale: 'en',
framework: 'mintlify',
options: {
mintlify: {
inferTitleFromFilename: true,
},
},
};
const content =
'---\n' +
'title: Assistant\n' +
'description: "Test"\n' +
'---\n\n' +
'# Content';
mockReadFile.mockReturnValueOnce(content);
const result = await aggregateFiles(settings as any);
expect(result).toHaveLength(1);
expect(result[0].content).toBe(content);
});
it('should infer title from parent directory for index files', async () => {
const settings = {
files: {
resolvedPaths: {
mdx: ['/full/path/docs/getting-started/index.mdx'],
},
placeholderPaths: {},
},
defaultLocale: 'en',
framework: 'mintlify',
options: {
mintlify: {
inferTitleFromFilename: true,
},
},
};
mockReadFile.mockReturnValueOnce(
'---\nsummary: "Hello"\n---\n\n# Content'
);
const result = await aggregateFiles(settings as any);
expect(result).toHaveLength(1);
expect(result[0].content).toMatch(/title:\s*"?Getting Started"?/);
});
it('should use Index for default locale index files', async () => {
const settings = {
files: {
resolvedPaths: {
mdx: ['/full/path/es/index.mdx'],
},
placeholderPaths: {},
},
defaultLocale: 'es',
framework: 'mintlify',
options: {
mintlify: {
inferTitleFromFilename: true,
},
},
};
mockReadFile.mockReturnValueOnce(
'---\nsummary: "Hello"\n---\n\n# Content'
);
const result = await aggregateFiles(settings as any);
expect(result).toHaveLength(1);
expect(result[0].content).toMatch(/title:\s*"?Index"?/);
});
it('should skip files that are empty after sanitization and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
md: ['/full/path/sanitized-empty.md', '/full/path/valid.md'],
},
placeholderPaths: {},
},
options: {},
};
mockReadFile
.mockReturnValueOnce('<!-- only comments -->') // content that becomes empty after sanitization
.mockReturnValueOnce('# Valid content'); // valid file
mockSanitizeFileContent
.mockReturnValueOnce('') // empty after sanitization
.mockReturnValueOnce('# Valid content'); // valid after sanitization
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping sanitized-empty.md: File is empty after sanitization'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.md');
});
it('should skip files that have only whitespace after sanitization and log warning', async () => {
const settings = {
files: {
resolvedPaths: {
ts: [
'/full/path/whitespace-after-sanitization.ts',
'/full/path/valid.ts',
],
},
placeholderPaths: {},
},
options: {},
};
mockReadFile
.mockReturnValueOnce('some content') // file content before sanitization
.mockReturnValueOnce('export const Component = () => "Hello"'); // valid file
mockSanitizeFileContent
.mockReturnValueOnce(' \n\t ') // whitespace only after sanitization
.mockReturnValueOnce('export const Component = () => "Hello"'); // valid after sanitization
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping whitespace-after-sanitization.ts: File is empty after sanitization'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.ts');
});
});
describe('Mixed file types with empty files', () => {
it('should skip empty files across all file types and process valid ones', async () => {
const settings = {
files: {
resolvedPaths: {
json: ['/full/path/empty.json', '/full/path/valid.json'],
yaml: ['/full/path/empty.yaml'],
md: ['/full/path/valid.md'],
},
placeholderPaths: {},
},
options: {},
defaultLocale: 'en',
};
mockReadFile
.mockReturnValueOnce('') // empty JSON
.mockReturnValueOnce('{"key": "value"}') // valid JSON
.mockReturnValueOnce('') // empty YAML
.mockReturnValueOnce('# Valid markdown'); // valid MD
const result = await aggregateFiles(settings as any);
// Check that warnings were logged for empty files
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping empty.json: JSON file is not parsable'
);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping empty.yaml: YAML file is empty'
);
// Should have 2 valid files
expect(result).toHaveLength(2);
// Check the file names are correct (JSON processed first, then MD after YAML)
const fileNames = result.map((f) => f.fileName);
expect(fileNames).toContain('valid.json');
expect(fileNames).toContain('valid.md');
});
});
describe('Filter behavior', () => {
it('should filter out files that return null from map function', async () => {
const settings = {
files: {
resolvedPaths: {
json: [
'/full/path/empty1.json',
'/full/path/empty2.json',
'/full/path/valid.json',
],
},
placeholderPaths: {},
},
options: {},
defaultLocale: 'en',
};
// Both empty files should be skipped, only valid file should remain
mockReadFile
.mockReturnValueOnce('') // empty file 1 - will return null from map
.mockReturnValueOnce('') // empty file 2 - will return null from map
.mockReturnValueOnce('{"key": "value"}'); // valid file
const result = await aggregateFiles(settings as any);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping empty1.json: JSON file is not parsable'
);
expect(mockLogWarning).toHaveBeenCalledWith(
'Skipping empty2.json: JSON file is not parsable'
);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.json');
});
it('should filter out files where parsed content is empty', async () => {
const settings = {
files: {
resolvedPaths: {
json: [
'/full/path/valid-input-empty-output.json',
'/full/path/valid.json',
],
},
placeholderPaths: {},
},
options: {},
defaultLocale: 'en',
};
mockReadFile
.mockReturnValueOnce('{"some": "input"}') // valid input
.mockReturnValueOnce('{"key": "value"}'); // valid file
mockParseJson
.mockReturnValueOnce('') // empty after parsing - gets filtered out
.mockReturnValueOnce('parsed content'); // valid after parsing
const result = await aggregateFiles(settings as any);
expect(result).toHaveLength(1);
expect(result[0].fileName).toBe('valid.json');
expect(result[0].content).toBe('parsed content');
});
});
});