This repository was archived by the owner on Sep 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathset-jest-version.ts
More file actions
334 lines (308 loc) · 9.13 KB
/
set-jest-version.ts
File metadata and controls
334 lines (308 loc) · 9.13 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
// Copyright (c) 2022-2023 Developer Innovations, LLC
import { execSync, spawnSync } from "child_process";
import * as fs from "fs";
import * as yaml from "js-yaml";
import * as semver from "semver";
import _debug from "debug";
const debug = _debug("set-jest-version");
const printUsageAndExit = (): never => {
console.error(
`Usage: ${process.argv[1]} <target-major-minor-version (e.g., 27.5)>`
);
process.exit(1);
};
type PackageSpec = {
version: string;
};
type Lockfile = { [key in string]: PackageSpec };
const getYarnPath = (): string =>
execSync("yarn config get yarnPath").toString().trimEnd();
const setYarnResolution = (
yarnPath: string,
descriptor: string,
resolution: string
): void => {
debug(`Setting yarn resolution \`${descriptor}\` to ${resolution}`);
const outcome = spawnSync(
"node",
// For some reason, yarn.cmd doesn't update the lockfile on Windows, but running node explicitly
// with the path to yarn does.
[yarnPath, "set", "resolution", descriptor, resolution],
{ stdio: "inherit" }
);
if (outcome.error !== undefined) {
console.error("ERROR: Failed to run yarn: %o", outcome.error);
process.exit(1);
} else if (outcome.status !== 0) {
console.error("ERROR: Exiting due to yarn error");
process.exit(1);
}
};
// Some packages were never released with matching major/minor version numbers matching the
// desired Jest version. We map missing minor versions to earlier releases below, or null if there
// were no earlier releases.
const PACKAGE_VERSION_MAP = {
"@jest/console": {
"26.3 - 26.4": "~26.3",
"27.0 - 27.1": "~27.0",
"27.2 - 27.3": "~27.2",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
},
"@jest/environment": {
"26.3 - 26.4": "~26.3",
},
"@jest/expect": {
"<28": null,
},
"@jest/expect-utils": {
"<28": null,
},
"@jest/fake-timers": {
"26.3 - 26.4": "~26.3",
},
"@jest/globals": {
"<25.5": null,
},
"@jest/schemas": {
"25 - 27": null,
"29.0 - 29.3": "~29.0",
"29.4 - 29.5": "~29.4",
},
"@jest/source-map": {
"25.2 - 25.4": "~25.2",
"26.1 - 26.2": "~26.1",
"26.3 - 26.4": "~26.3",
"27.0 - 27.3": "~27.0",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
"29.4 - 29.5": "~29.4",
},
"@jest/test-result": {
"26.3 - 26.4": "~26.3",
},
"@jest/transform": {
"26.3 - 26.4": "~26.3",
},
"@jest/types": {
"26.3 - 26.4": "~26.3",
"27.2 - 27.3": "~27.2",
},
"babel-jest": {
"26.3 - 26.4": "~26.3",
},
"babel-plugin-jest-hoist": {
"25.2 - 25.3": "~25.2",
"26.2 - 26.4": "~26.2",
"27.0 - 27.1": "~27.0",
"27.2 - 27.3": "~27.2",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
"29.5 - 29.6": "~29.5",
},
"babel-preset-jest": {
"26.3 - 26.4": "~26.3",
"27.0 - 27.1": "~27.0",
"27.2 - 27.3": "~27.2",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
"29.5 - 29.6": "~29.5",
},
"jest-changed-files": {
"26.3 - 26.4": "~26.3",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
"29.5 - 29.6": "~29.5",
},
"jest-docblock": {
"^25.3": "~25.3",
"^26": "~26.0",
"27.0 - 27.3": "~27.0",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
"29.4 - 29.6": "~29.4",
},
"jest-environment-jsdom": {
"26.3 - 26.4": "~26.3",
},
"jest-environment-node": {
"26.3 - 26.4": "~26.3",
},
"jest-get-type": {
"^25.2.0": "~25.2",
"26.0 - 26.2": "~26.0",
"^26.3": "~26.3",
"27.0 - 27.2": "~27.0",
"^28": "~28.0",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
"29.4 - 29.6": "~29.4",
},
"jest-haste-map": {
"26.3 - 26.4": "~26.3",
},
"jest-message-util": {
"26.3 - 26.4": "~26.3",
},
"jest-mock": {
"26.3 - 26.4": "~26.3",
},
"jest-regex-util": {
"^25.2": "~25.2",
"^26": "~26.0",
"27.0 - 27.3": "~27.0",
"^28": "~28.0",
"29.0 - 29.1": "~29.0",
"29.2 - 29.3": "~29.2",
"29.4 - 29.6": "~29.4",
},
"jest-serializer": {
"25.2 - 25.4": "~25.2",
"26.3 - 26.4": "~26.3",
"27.0 - 27.3": "~27.0",
">=28": null,
},
"jest-util": {
"26.3 - 26.4": "~26.3",
},
"jest-watcher": {
"26.3 - 26.4": "~26.3",
},
"jest-worker": {
"25.2 - 25.3": "~25.2",
"26.3 - 26.4": "~26.3",
},
};
const packageTargetSemVerMap: {
[p: string]: {
targetRange: semver.Range;
// null means no compatible version exists and that we shouldn't set a resolution. The
// unsupported entry should hopefully disappear from yarn.lock once we've set the resolutions
// higher up in the dependency chain.
resolution: semver.Range | null;
}[];
} = Object.fromEntries(
Object.entries(PACKAGE_VERSION_MAP).map(
([packageName, packageVersionMap]) => [
packageName,
Object.entries(packageVersionMap).map(([targetRange, resolution]) => ({
targetRange: new semver.Range(targetRange),
resolution: resolution !== null ? new semver.Range(resolution) : null,
})),
]
)
);
const getPackageTargetSemVerRange = (
packageName: string,
targetSemVerRange: semver.Range
): semver.Range | null => {
const resolution = (packageTargetSemVerMap[packageName] ?? []).find(
({ targetRange }) => semver.intersects(targetSemVerRange, targetRange)
)?.resolution;
return resolution !== undefined ? resolution : targetSemVerRange;
};
const main = (): never => {
const targetVersion = process.argv[2];
if (targetVersion === undefined) {
printUsageAndExit();
}
const targetSemVerRange = ((): semver.Range => {
try {
return new semver.Range(`~${targetVersion}`);
} catch (e) {
console.error(`ERROR: Invalid SemVer range: %o`, e);
return printUsageAndExit();
}
})();
const targetSemVerMinVersion = semver.minVersion(targetSemVerRange);
if (targetSemVerMinVersion === null) {
throw new Error(
`Failed to get SemVer min version from range ${targetSemVerRange.raw}`
);
}
const yarnPath = getYarnPath();
const maxIterations = 10;
// The jest TS types aren't released very frequently and mostly correspond to major versions, so
// we just install the latest available with the corresponding major version.
if (
targetSemVerMinVersion.major >= 25 &&
targetSemVerMinVersion.major <= 29
) {
setYarnResolution(
yarnPath,
"@types/jest@npm:25.1.0 - 29",
targetSemVerMinVersion.major.toString()
);
} else {
console.error(`ERROR: Unsupported jest version ${targetVersion}`);
process.exit(1);
}
for (let i = 0; i < maxIterations; i++) {
const lockfile = yaml.load(
fs.readFileSync("yarn.lock", "utf8")
) as Lockfile;
let done = true;
Object.entries(lockfile).forEach(([pkg, spec]) => {
if (
pkg.startsWith("babel-jest") ||
pkg.startsWith("babel-plugin-jest-hoist") ||
pkg.startsWith("babel-preset-jest") ||
pkg.startsWith("expect@") ||
pkg.startsWith("@jest/") ||
pkg.startsWith("jest@") ||
(pkg.startsWith("jest-") &&
!pkg.startsWith("jest-integration") &&
!pkg.startsWith("jest-pnp-resolver@")) ||
pkg.startsWith("pretty-format")
) {
const descriptors = pkg.split(", ");
descriptors.forEach((descriptor) => {
const [packageName, descriptorVersion] = descriptor.split("@npm:");
const descriptorSemVerRange = new semver.Range(descriptorVersion);
// If the package descriptor version range doesn't include the target version range, we
// can't set the resolution to the target range. This arises for transitive dependencies
// for which we haven't yet updated the resolution higher up in the tree, and for package
// requirements unrelated to the Jest plugin integration tests.
if (!semver.intersects(descriptorSemVerRange, targetSemVerRange)) {
debug(
`Range \`${descriptorSemVerRange.raw}\` does not intersect with range \`${targetSemVerRange.raw}\` for package ${packageName}`
);
return;
}
const packageTargetSemVerRange = getPackageTargetSemVerRange(
packageName,
targetSemVerRange
);
if (packageTargetSemVerRange === null) {
debug(
`Package ${packageName} has no versions satisfying ${targetSemVerRange.raw}`
);
return;
}
if (semver.satisfies(spec.version, packageTargetSemVerRange)) {
debug(
`Version ${spec.version} of package ${packageName} matches expected range ${packageTargetSemVerRange.raw}`
);
return;
}
debug(
`Version ${spec.version} of package ${packageName} does NOT match expected range ${packageTargetSemVerRange.raw}`
);
done = false;
setYarnResolution(yarnPath, descriptor, packageTargetSemVerRange.raw);
});
}
});
if (done) {
console.log(
`Done installing Jest ${targetVersion} after ${i + 1} iteration(s).`
);
process.exit(0);
}
}
console.error(
`ERROR: Yarn lockfile did not converge after ${maxIterations} iterations`
);
process.exit(1);
};
main();