-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
PackageUtilities.js
300 lines (264 loc) · 9.07 KB
/
PackageUtilities.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
import log from "npmlog";
import path from "path";
// tightly-coupled modules; TODO: decouple
import Package from "../src/Package";
import Repository from "../src/Repository";
// helpers
import initFixture from "./helpers/initFixture";
// file under test
import PackageUtilities from "../src/PackageUtilities";
// silence logs
log.level = "silent";
describe("PackageUtilities", () => {
describe(".getPackages()", () => {
it("should collect all the packages from the given packages directory", async () => {
const testDir = await initFixture("PackageUtilities/basic");
const result = PackageUtilities.getPackages(new Repository(testDir));
expect(result).toHaveLength(4);
const pkgOne = result[0];
expect(pkgOne).toBeInstanceOf(Package);
expect(pkgOne.name).toBe("package-1");
expect(pkgOne.version).toBe("1.0.0");
expect(pkgOne.location).toBe(path.join(testDir, "packages", "package-1"));
});
it("finds nested packages with globstar", async () => {
const testDir = await initFixture("PackageUtilities/globstar");
const result = PackageUtilities.getPackages(new Repository(testDir));
expect(result.map((pkg) => pkg.name)).toEqual([
"globstar-monorepo",
"package-2",
"package-4",
"package-1",
"package-3",
"package-5",
]);
});
it("does not ignore explicit node_modules in packages config", async () => {
const testDir = await initFixture("PackageUtilities/explicit-node-modules");
const result = PackageUtilities.getPackages(new Repository(testDir));
expect(result.map((pkg) => pkg.name)).toEqual([
"alle-pattern-monorepo",
"package-1",
"package-2",
"package-3",
"package-4",
"@scoped/package-5",
]);
});
it("throws an error when globstars and explicit node_modules configs are mixed", async () => {
const testDir = await initFixture("PackageUtilities/mixed-globstar");
try {
PackageUtilities.getPackages(new Repository(testDir));
} catch (err) {
expect(err.message).toMatch("An explicit node_modules package path does not allow globstars");
}
});
});
describe(".filterPackages()", () => {
let packages;
beforeAll(() => initFixture("PackageUtilities/filtering").then((testDir) => {
packages = PackageUtilities.getPackages(new Repository(testDir));
}));
it("includes all packages when --scope is omitted", () => {
const flags = {
// scope: undefined
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-3", "package-4", "package-a-1", "package-a-2"]
);
});
it("includes all packages when --scope is boolean", () => {
const flags = {
scope: true, // --scope
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-3", "package-4", "package-a-1", "package-a-2"]
);
});
it("includes packages when --scope is a package name", () => {
const flags = {
scope: "package-3",
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-3"]
);
});
it("excludes packages when --ignore is a package name", () => {
const flags = {
ignore: "package-3",
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-4", "package-a-1", "package-a-2"]
);
});
it("includes packages when --scope is a glob", () => {
const flags = {
scope: "package-a-*",
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-a-1", "package-a-2"]
);
});
it("excludes packages when --ignore is a glob", () => {
const flags = {
ignore: "package-@(2|3|4)",
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-a-1", "package-a-2"]
);
});
it("excludes packages when --ignore is a brace-expanded list", () => {
/* NOTE: ignore value is array at this point if option is "package-{3,4}" */
const flags = {
ignore: ["package-3", "package-4"],
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-a-1", "package-a-2"]
);
});
it("filters packages when both --scope and --ignore are passed", () => {
const flags = {
scope: "package-a-*",
ignore: "package-a-2",
};
const result = PackageUtilities.filterPackages(packages, flags);
expect(result.map((pkg) => pkg.name)).toEqual(
["package-a-1"]
);
});
it("should throw when --scope glob excludes all packages", () => {
const flags = {
scope: "no-package-*",
};
expect(() => {
PackageUtilities.filterPackages(packages, flags);
}).toThrow();
});
it("should throw when --ignore glob excludes all packages", () => {
const flags = {
ignore: "package-*",
};
expect(() => {
PackageUtilities.filterPackages(packages, flags);
}).toThrow();
});
it("should throw when --scope and --ignore globs exclude all packages", () => {
const flags = {
scope: "package-a-*",
ignore: "package-a-@(1|2)",
};
expect(() => {
PackageUtilities.filterPackages(packages, flags);
}).toThrow();
});
});
describe(".filterPackagesThatAreNotUpdated()", () => {
it("should return an empty array when there are no packages to filter", () => {
const packagesToFilter = [];
const packageUpdates = [
{ package: { name: "ghi" } },
{ package: { name: "xyz" } },
];
const updatedPackages = PackageUtilities.filterPackagesThatAreNotUpdated(
packagesToFilter,
packageUpdates
);
expect(updatedPackages).toHaveLength(0);
});
it("should return an empty array when there are no packages that have been updated", () => {
const packagesToFilter = [
{ name: "abc" },
{ name: "def" },
{ name: "ghi" },
{ name: "jkl" },
];
const packageUpdates = [];
const updatedPackages = PackageUtilities.filterPackagesThatAreNotUpdated(
packagesToFilter,
packageUpdates
);
expect(updatedPackages).toHaveLength(0);
});
it("should return only packages that are to be filtered and have been updated", () => {
const packagesToFilter = [
{ name: "abc" },
{ name: "def" },
{ name: "ghi" },
{ name: "jkl" },
];
const packageUpdates = [
{ package: { name: "ghi" } },
{ package: { name: "xyz" } },
];
const updatedPackages = PackageUtilities.filterPackagesThatAreNotUpdated(
packagesToFilter,
packageUpdates
);
expect(updatedPackages).toHaveLength(1);
expect(updatedPackages).toEqual([{ name: "ghi" }]);
});
});
describe(".topologicallyBatchPackages()", () => {
let packages;
beforeEach(() => initFixture("PackageUtilities/toposort").then((testDir) => {
packages = PackageUtilities.getPackages(new Repository(testDir));
}));
it("should batch roots, then internal/leaf nodes, then cycles", () => {
let warnedCycle;
log.once("log.warn", () => {
warnedCycle = true;
});
const batchedPackages = PackageUtilities.topologicallyBatchPackages(packages);
expect(warnedCycle).toBe(true);
expect(batchedPackages.map((batch) => batch.map((pkg) => pkg.name))).toEqual(
[
["package-dag-1", "package-standalone"],
["package-dag-2a", "package-dag-2b"],
["package-dag-3"],
["package-cycle-1"],
["package-cycle-2", "package-cycle-extraneous"]
]
);
});
});
describe(".runParallelBatches()", () => {
// Array#sort sorts numbers lexicographically by default!
function numericalSort(a, b) {
return a - b;
}
it("should run batches serially", (done) => {
const batches = [
[ 1 ],
[ 2, 3 ],
[ 4, 5, 6 ],
[ 7, 8, 9, 10 ]
];
const taskOrdering = [];
PackageUtilities.runParallelBatches(batches, (n) => (cb) => {
taskOrdering.push(n);
cb();
}, 1, (err) => {
if (err) return done.fail(err);
try {
expect(taskOrdering).toHaveLength(10);
expect([
taskOrdering.slice(0, 1).sort(numericalSort),
taskOrdering.slice(1, 3).sort(numericalSort),
taskOrdering.slice(3, 6).sort(numericalSort),
taskOrdering.slice(6, 10).sort(numericalSort)
]).toEqual(batches);
done();
} catch (ex) {
done.fail(ex);
}
});
});
});
});