-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
/
resolve.test.ts
528 lines (467 loc) · 17 KB
/
resolve.test.ts
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
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/
import * as path from 'path';
import * as fs from 'graceful-fs';
import resolveAsync = require('resolve');
import {ModuleMap} from 'jest-haste-map';
import userResolver from '../__mocks__/userResolver';
import userResolverAsync from '../__mocks__/userResolverAsync';
import {defaultResolver, defaultResolverAsync} from '../defaultResolver';
import nodeModulesPaths from '../nodeModulesPaths';
import Resolver from '../resolver';
import type {ResolverConfig} from '../types';
jest.mock('../__mocks__/userResolver');
jest.mock('../__mocks__/userResolverAsync');
// Do not fully mock `resolve` because it is used by Jest. Doing it will crash
// in very strange ways. Instead just spy on it and its `sync` method.
jest.mock('resolve', () => {
const originalModule = jest.requireActual('resolve');
return {
...originalModule,
sync: jest.spyOn(originalModule, 'sync'),
};
});
const mockResolveSync = <
jest.Mock<
ReturnType<typeof resolveAsync.sync>,
Parameters<typeof resolveAsync.sync>
>
>resolveAsync.sync;
beforeEach(() => {
userResolver.mockClear();
userResolverAsync.async.mockClear();
mockResolveSync.mockClear();
});
describe('isCoreModule', () => {
it('returns false if `hasCoreModules` is false.', () => {
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {
hasCoreModules: false,
} as ResolverConfig);
const isCore = resolver.isCoreModule('assert');
expect(isCore).toEqual(false);
});
it('returns true if `hasCoreModules` is true and `moduleName` is a core module.', () => {
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {} as ResolverConfig);
const isCore = resolver.isCoreModule('assert');
expect(isCore).toEqual(true);
});
it('returns false if `hasCoreModules` is true and `moduleName` is not a core module.', () => {
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {} as ResolverConfig);
const isCore = resolver.isCoreModule('not-a-core-module');
expect(isCore).toEqual(false);
});
it('returns false if `hasCoreModules` is true and `moduleNameMapper` alias a module same name with core module', () => {
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {
moduleNameMapper: [
{
moduleName: '$1',
regex: /^constants$/,
},
],
} as ResolverConfig);
const isCore = resolver.isCoreModule('constants');
expect(isCore).toEqual(false);
});
it('returns true if using `node:` URLs and `moduleName` is a core module.', () => {
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {} as ResolverConfig);
const isCore = resolver.isCoreModule('node:assert');
expect(isCore).toEqual(true);
});
it('returns false if using `node:` URLs and `moduleName` is not a core module.', () => {
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {} as ResolverConfig);
const isCore = resolver.isCoreModule('node:not-a-core-module');
expect(isCore).toEqual(false);
});
});
describe('findNodeModule', () => {
it('is possible to override the default resolver', () => {
const cwd = process.cwd();
const resolvedCwd = fs.realpathSync(cwd) || cwd;
const nodePaths = process.env.NODE_PATH
? process.env.NODE_PATH.split(path.delimiter)
.filter(Boolean)
.map(p => path.resolve(resolvedCwd, p))
: null;
userResolver.mockImplementation(() => 'module');
const newPath = Resolver.findNodeModule('test', {
basedir: '/',
browser: true,
extensions: ['js'],
moduleDirectory: ['node_modules'],
paths: ['/something'],
resolver: require.resolve('../__mocks__/userResolver'),
});
expect(newPath).toBe('module');
expect(userResolver.mock.calls[0][0]).toBe('test');
expect(userResolver.mock.calls[0][1]).toStrictEqual({
basedir: '/',
browser: true,
defaultResolver,
extensions: ['js'],
moduleDirectory: ['node_modules'],
paths: (nodePaths || []).concat(['/something']),
rootDir: undefined,
});
});
it('passes packageFilter to the resolve module when using the default resolver', () => {
const packageFilter = jest.fn();
// A resolver that delegates to defaultResolver with a packageFilter implementation
userResolver.mockImplementation((request, opts) =>
opts.defaultResolver(request, {...opts, packageFilter}),
);
Resolver.findNodeModule('test', {
basedir: '/',
resolver: require.resolve('../__mocks__/userResolver'),
});
expect(mockResolveSync).toHaveBeenCalledWith(
'test',
expect.objectContaining({
packageFilter,
}),
);
});
});
describe('findNodeModuleAsync', () => {
it('is possible to override the default resolver', async () => {
const cwd = process.cwd();
const resolvedCwd = fs.realpathSync(cwd) || cwd;
const nodePaths = process.env.NODE_PATH
? process.env.NODE_PATH.split(path.delimiter)
.filter(Boolean)
.map(p => path.resolve(resolvedCwd, p))
: null;
userResolverAsync.async.mockImplementation(() => Promise.resolve('module'));
const newPath = await Resolver.findNodeModuleAsync('test', {
basedir: '/',
browser: true,
extensions: ['js'],
moduleDirectory: ['node_modules'],
paths: ['/something'],
resolver: require.resolve('../__mocks__/userResolverAsync'),
});
expect(newPath).toBe('module');
expect(userResolverAsync.async.mock.calls[0][0]).toBe('test');
expect(userResolverAsync.async.mock.calls[0][1]).toStrictEqual({
basedir: '/',
browser: true,
defaultResolver: defaultResolverAsync,
extensions: ['js'],
moduleDirectory: ['node_modules'],
paths: (nodePaths || []).concat(['/something']),
rootDir: undefined,
});
});
it('passes packageFilter to the resolve module when using the default resolver', async () => {
const packageFilter = jest.fn();
// A resolver that delegates to defaultResolver with a packageFilter implementation
userResolverAsync.async.mockImplementation((request, opts) =>
Promise.resolve(opts.defaultResolver(request, {...opts, packageFilter})),
);
await Resolver.findNodeModuleAsync('test', {
basedir: '/',
resolver: require.resolve('../__mocks__/userResolverAsync'),
});
// Question, if we can't mock resolve (async), how do we test this?
// expect(mockResolveSync).toHaveBeenCalledWith(
// 'test',
// expect.objectContaining({
// packageFilter,
// }),
// );
});
});
describe('resolveModule', () => {
let moduleMap: ModuleMap;
beforeEach(() => {
moduleMap = ModuleMap.create('/');
});
it('is possible to resolve node modules', () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const src = require.resolve('../');
const resolved = resolver.resolveModule(
src,
'./__mocks__/mockJsDependency',
);
expect(resolved).toBe(require.resolve('../__mocks__/mockJsDependency.js'));
});
it('is possible to resolve node modules with custom extensions', () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js', '.jsx'],
} as ResolverConfig);
const src = require.resolve('../');
const resolvedJsx = resolver.resolveModule(
src,
'./__mocks__/mockJsxDependency',
);
expect(resolvedJsx).toBe(
require.resolve('../__mocks__/mockJsxDependency.jsx'),
);
});
it('is possible to resolve node modules with custom extensions and platforms', () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js', '.jsx'],
platforms: ['native'],
} as ResolverConfig);
const src = require.resolve('../');
const resolvedJsx = resolver.resolveModule(
src,
'./__mocks__/mockJsxDependency',
);
expect(resolvedJsx).toBe(
require.resolve('../__mocks__/mockJsxDependency.native.jsx'),
);
});
it('is possible to resolve node modules by resolving their realpath', () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const src = path.join(
path.resolve(__dirname, '../../src/__mocks__/bar/node_modules/'),
'foo/index.js',
);
const resolved = resolver.resolveModule(src, 'dep');
expect(resolved).toBe(
require.resolve('../../src/__mocks__/foo/node_modules/dep/index.js'),
);
});
it('is possible to specify custom resolve paths', () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const src = require.resolve('../');
const resolved = resolver.resolveModule(src, 'mockJsDependency', {
paths: [
path.resolve(__dirname, '../../src/__tests__'),
path.resolve(__dirname, '../../src/__mocks__'),
],
});
expect(resolved).toBe(require.resolve('../__mocks__/mockJsDependency.js'));
});
it('does not confuse directories with files', () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const mocksDirectory = path.resolve(__dirname, '../__mocks__');
const fooSlashFoo = path.join(mocksDirectory, 'foo/foo.js');
const fooSlashIndex = path.join(mocksDirectory, 'foo/index.js');
const resolvedWithSlash = resolver.resolveModule(fooSlashFoo, './');
const resolvedWithDot = resolver.resolveModule(fooSlashFoo, '.');
expect(resolvedWithSlash).toBe(fooSlashIndex);
expect(resolvedWithSlash).toBe(resolvedWithDot);
});
});
describe('resolveModuleAsync', () => {
let moduleMap: ModuleMap;
beforeEach(() => {
moduleMap = ModuleMap.create('/');
});
it('is possible to resolve node modules', async () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const src = require.resolve('../');
const resolved = await resolver.resolveModuleAsync(
src,
'./__mocks__/mockJsDependency',
);
expect(resolved).toBe(require.resolve('../__mocks__/mockJsDependency.js'));
});
it('is possible to resolve node modules with custom extensions', async () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js', '.jsx'],
} as ResolverConfig);
const src = require.resolve('../');
const resolvedJsx = await resolver.resolveModuleAsync(
src,
'./__mocks__/mockJsxDependency',
);
expect(resolvedJsx).toBe(
require.resolve('../__mocks__/mockJsxDependency.jsx'),
);
});
it('is possible to resolve node modules with custom extensions and platforms', async () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js', '.jsx'],
platforms: ['native'],
} as ResolverConfig);
const src = require.resolve('../');
const resolvedJsx = await resolver.resolveModuleAsync(
src,
'./__mocks__/mockJsxDependency',
);
expect(resolvedJsx).toBe(
require.resolve('../__mocks__/mockJsxDependency.native.jsx'),
);
});
it('is possible to resolve node modules by resolving their realpath', async () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const src = path.join(
path.resolve(__dirname, '../../src/__mocks__/bar/node_modules/'),
'foo/index.js',
);
const resolved = await resolver.resolveModuleAsync(src, 'dep');
expect(resolved).toBe(
require.resolve('../../src/__mocks__/foo/node_modules/dep/index.js'),
);
});
it('is possible to specify custom resolve paths', async () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const src = require.resolve('../');
const resolved = await resolver.resolveModuleAsync(
src,
'mockJsDependency',
{
paths: [
path.resolve(__dirname, '../../src/__tests__'),
path.resolve(__dirname, '../../src/__mocks__'),
],
},
);
expect(resolved).toBe(require.resolve('../__mocks__/mockJsDependency.js'));
});
it('does not confuse directories with files', async () => {
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
} as ResolverConfig);
const mocksDirectory = path.resolve(__dirname, '../__mocks__');
const fooSlashFoo = path.join(mocksDirectory, 'foo/foo.js');
const fooSlashIndex = path.join(mocksDirectory, 'foo/index.js');
const resolvedWithSlash = await resolver.resolveModuleAsync(
fooSlashFoo,
'./',
);
const resolvedWithDot = await resolver.resolveModuleAsync(fooSlashFoo, '.');
expect(resolvedWithSlash).toBe(fooSlashIndex);
expect(resolvedWithSlash).toBe(resolvedWithDot);
});
});
describe('getMockModule', () => {
it('is possible to use custom resolver to resolve deps inside mock modules with moduleNameMapper', () => {
userResolver.mockImplementation(() => 'module');
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
moduleNameMapper: [
{
moduleName: '$1',
regex: /(.*)/,
},
],
resolver: require.resolve('../__mocks__/userResolver'),
} as ResolverConfig);
const src = require.resolve('../');
resolver.getMockModule(src, 'dependentModule');
expect(userResolver).toHaveBeenCalled();
expect(userResolver.mock.calls[0][0]).toBe('dependentModule');
expect(userResolver.mock.calls[0][1]).toHaveProperty(
'basedir',
path.dirname(src),
);
});
});
describe('getMockModuleAsync', () => {
it('is possible to use custom resolver to resolve deps inside mock modules with moduleNameMapper', async () => {
userResolverAsync.async.mockImplementation(() => Promise.resolve('module'));
const moduleMap = ModuleMap.create('/');
const resolver = new Resolver(moduleMap, {
extensions: ['.js'],
moduleNameMapper: [
{
moduleName: '$1',
regex: /(.*)/,
},
],
resolver: require.resolve('../__mocks__/userResolverAsync'),
} as ResolverConfig);
const src = require.resolve('../');
await resolver.resolveModuleAsync(src, 'dependentModule');
expect(userResolverAsync.async).toHaveBeenCalled();
expect(userResolverAsync.async.mock.calls[0][0]).toBe('dependentModule');
expect(userResolverAsync.async.mock.calls[0][1]).toHaveProperty(
'basedir',
path.dirname(src),
);
});
});
describe('nodeModulesPaths', () => {
it('provides custom module paths after node_modules', () => {
const src = require.resolve('../');
const result = nodeModulesPaths(src, {paths: ['./customFolder']});
expect(result[result.length - 1]).toBe('./customFolder');
});
});
describe('Resolver.getModulePaths() -> nodeModulesPaths()', () => {
const _path = path;
let moduleMap: ModuleMap;
beforeEach(() => {
jest.resetModules();
moduleMap = ModuleMap.create('/');
// Mocking realpath to function the old way, where it just looks at
// pathstrings instead of actually trying to access the physical directory.
// This test suite won't work otherwise, since we cannot make assumptions
// about the test environment when it comes to absolute paths.
jest.doMock('graceful-fs', () => ({
...jest.requireActual('graceful-fs'),
realPathSync: {
native: (dirInput: string) => dirInput,
},
}));
});
afterAll(() => {
jest.resetModules();
jest.dontMock('path');
});
it('can resolve node modules relative to absolute paths in "moduleDirectories" on Windows platforms', () => {
jest.doMock('path', () => _path.win32);
const path = require('path');
const Resolver = require('../').default;
const cwd = 'D:\\temp\\project';
const src = 'C:\\path\\to\\node_modules';
const resolver = new Resolver(moduleMap, {
moduleDirectories: [src, 'node_modules'],
});
const dirs_expected = [
src,
cwd + '\\node_modules',
path.dirname(cwd) + '\\node_modules',
'D:\\node_modules',
];
const dirs_actual = resolver.getModulePaths(cwd);
expect(dirs_actual).toEqual(expect.arrayContaining(dirs_expected));
});
it('can resolve node modules relative to absolute paths in "moduleDirectories" on Posix platforms', () => {
jest.doMock('path', () => _path.posix);
const path = require('path');
const Resolver = require('../').default;
const cwd = '/temp/project';
const src = '/path/to/node_modules';
const resolver = new Resolver(moduleMap, {
moduleDirectories: [src, 'node_modules'],
});
const dirs_expected = [
src,
cwd + '/node_modules',
path.dirname(cwd) + '/node_modules',
'/node_modules',
];
const dirs_actual = resolver.getModulePaths(cwd);
expect(dirs_actual).toEqual(expect.arrayContaining(dirs_expected));
});
});