/
defaultResolver.ts
275 lines (238 loc) · 6.87 KB
/
defaultResolver.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
/**
* 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 fs from 'graceful-fs';
import pnpResolver from 'jest-pnp-resolver';
import {AsyncOpts, SyncOpts, sync as resolveSync} from 'resolve';
import type {Config} from '@jest/types';
import {tryRealpath} from 'jest-util';
// QUESTION: What is a better way to import this?
const resolveAsync = require('resolve/lib/async');
export type ResolverOptions = {
basedir: Config.Path;
browser?: boolean;
defaultResolver: typeof defaultResolver;
extensions?: Array<string>;
moduleDirectory?: Array<string>;
paths?: Array<Config.Path>;
rootDir?: Config.Path;
packageFilter?: (pkg: any, pkgfile: string) => any;
};
type ResolverOptionsAsync = Omit<ResolverOptions, 'defaultResolver'> & {
defaultResolver: typeof defaultResolverAsync;
};
// https://github.com/facebook/jest/pull/10617
declare global {
namespace NodeJS {
export interface ProcessVersions {
pnp?: any;
}
}
}
export function defaultResolver(
path: Config.Path,
options: ResolverOptions,
): Config.Path {
// Yarn 2 adds support to `resolve` automatically so the pnpResolver is only
// needed for Yarn 1 which implements version 1 of the pnp spec
if (process.versions.pnp === '1') {
return pnpResolver(path, options);
}
const result = resolveSync(path, getSyncResolveOptions(options));
// Dereference symlinks to ensure we don't create a separate
// module instance depending on how it was referenced.
return realpathSync(result);
}
export async function defaultResolverAsync(
path: Config.Path,
options: ResolverOptionsAsync,
): Promise<Config.Path> {
// Yarn 2 adds support to `resolve` automatically so the pnpResolver is only
// needed for Yarn 1 which implements version 1 of the pnp spec
if (process.versions.pnp === '1') {
// QUESTION: do we need an async version of pnpResolver?
// It seems ugly to require a default sync resolver in the async method,
// just to deal with this.
return Promise.resolve(await pnpResolver(path, options));
}
return new Promise((resolve, reject) => {
function resolveCb(err: Error | null, result?: string) {
if (err) {
reject(err);
}
if (result) {
resolve(realpathSync(result));
}
}
const opts = getAsyncResolveOptions(options);
resolveAsync(path, opts, resolveCb);
});
}
/**
* getBaseResolveOptions returns resolution options that are shared by both the
* synch and async resolution functions.
*/
function getBaseResolveOptions(
options: ResolverOptions | ResolverOptionsAsync,
) {
return {
basedir: options.basedir,
extensions: options.extensions,
moduleDirectory: options.moduleDirectory,
packageFilter: options.packageFilter,
paths: options.paths,
preserveSymlinks: false,
};
}
/**
* getSyncResolveOptions returns resolution options that are used synchronously.
*/
function getSyncResolveOptions(options: ResolverOptions): SyncOpts {
return {
...getBaseResolveOptions(options),
isDirectory: isDirectorySync,
isFile: isFileSync,
readPackageSync,
realpathSync,
};
}
/**
* getAsyncResolveOptions returns resolution options that are used asynchronously.
*/
function getAsyncResolveOptions(options: ResolverOptionsAsync): AsyncOpts {
return {
...getBaseResolveOptions(options),
isDirectory: isDirectoryAsync,
isFile: isFileAsync,
readPackage: readPackageAsync,
realpath: realpathAsync,
};
}
export function clearDefaultResolverCache(): void {
checkedPaths.clear();
checkedRealpathPaths.clear();
packageContents.clear();
}
enum IPathType {
FILE = 1,
DIRECTORY = 2,
OTHER = 3,
}
const checkedPaths = new Map<string, IPathType>();
function statSyncCached(path: string): IPathType {
const result = checkedPaths.get(path);
if (result !== undefined) {
return result;
}
let stat;
try {
stat = fs.statSync(path);
} catch (e) {
if (!(e && (e.code === 'ENOENT' || e.code === 'ENOTDIR'))) {
throw e;
}
}
if (stat) {
if (stat.isFile() || stat.isFIFO()) {
checkedPaths.set(path, IPathType.FILE);
return IPathType.FILE;
} else if (stat.isDirectory()) {
checkedPaths.set(path, IPathType.DIRECTORY);
return IPathType.DIRECTORY;
}
}
checkedPaths.set(path, IPathType.OTHER);
return IPathType.OTHER;
}
const checkedRealpathPaths = new Map<string, string>();
function realpathCached(path: Config.Path): Config.Path {
let result = checkedRealpathPaths.get(path);
if (result !== undefined) {
return result;
}
result = tryRealpath(path);
checkedRealpathPaths.set(path, result);
if (path !== result) {
// also cache the result in case it's ever referenced directly - no reason to `realpath` that as well
checkedRealpathPaths.set(result, result);
}
return result;
}
type PkgJson = Record<string, unknown>;
const packageContents = new Map<string, PkgJson>();
function readPackageCached(path: Config.Path): PkgJson {
let result = packageContents.get(path);
if (result !== undefined) {
return result;
}
result = JSON.parse(fs.readFileSync(path, 'utf8')) as PkgJson;
packageContents.set(path, result);
return result;
}
/*
* helper functions
*/
function isFileSync(file: Config.Path): boolean {
return statSyncCached(file) === IPathType.FILE;
}
function isFileAsync(
file: Config.Path,
cb: (err: Error | null, isFile?: boolean) => void,
): void {
try {
// QUESTION: do we need an async version of statSyncCached?
const isFile = statSyncCached(file) === IPathType.FILE;
cb(null, isFile);
} catch (err) {
cb(err);
}
}
function isDirectorySync(dir: Config.Path): boolean {
return statSyncCached(dir) === IPathType.DIRECTORY;
}
function isDirectoryAsync(
dir: Config.Path,
cb: (err: Error | null, isDir?: boolean) => void,
): void {
try {
// QUESTION: do we need an async version of statSyncCached?
const isDir = statSyncCached(dir) === IPathType.DIRECTORY;
cb(null, isDir);
} catch (err) {
cb(err);
}
}
function realpathSync(file: Config.Path): Config.Path {
return realpathCached(file);
}
function realpathAsync(
file: string,
cb: (err: Error | null, resolved?: string) => void,
): void {
try {
// QUESTION: do we need an async version of realpathCached?
const resolved = realpathCached(file);
cb(null, resolved);
} catch (err) {
cb(err);
}
}
function readPackageSync(_: unknown, file: Config.Path): PkgJson {
return readPackageCached(file);
}
function readPackageAsync(
_: unknown,
pkgfile: string,
cb: (err: Error | null, pkgJson?: Record<string, unknown>) => void,
): void {
try {
// QUESTION: do we need an async version of readPackageCached?
const pkgJson = readPackageCached(pkgfile);
cb(null, pkgJson);
} catch (err) {
cb(err);
}
}