/
buildable-libs-utils.ts
439 lines (401 loc) · 12.3 KB
/
buildable-libs-utils.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
import { dirname, join, relative } from 'path';
import { directoryExists, fileExists } from './fileutils';
import type { ProjectGraph, ProjectGraphProjectNode } from '@nrwl/devkit';
import {
getOutputsForTargetAndConfiguration,
ProjectGraphExternalNode,
readJsonFile,
stripIndents,
writeJsonFile,
} from '@nrwl/devkit';
import * as ts from 'typescript';
import { unlinkSync } from 'fs';
import { output } from './output';
import { isNpmProject } from 'nx/src/project-graph/operators';
function isBuildable(target: string, node: ProjectGraphProjectNode): boolean {
return (
node.data.targets &&
node.data.targets[target] &&
node.data.targets[target].executor !== ''
);
}
export type DependentBuildableProjectNode = {
name: string;
outputs: string[];
node: ProjectGraphProjectNode | ProjectGraphExternalNode;
};
export function calculateProjectDependencies(
projGraph: ProjectGraph,
root: string,
projectName: string,
targetName: string,
configurationName: string,
shallow?: boolean
): {
target: ProjectGraphProjectNode;
dependencies: DependentBuildableProjectNode[];
nonBuildableDependencies: string[];
topLevelDependencies: DependentBuildableProjectNode[];
} {
const target = projGraph.nodes[projectName];
// gather the library dependencies
const nonBuildableDependencies = [];
const topLevelDependencies: DependentBuildableProjectNode[] = [];
const collectedDeps = collectDependencies(
projectName,
projGraph,
[],
shallow
);
const missing = collectedDeps.reduce(
(missing: string[] | undefined, { name: dep }) => {
const depNode = projGraph.nodes[dep] || projGraph.externalNodes[dep];
if (!depNode) {
missing = missing || [];
missing.push(dep);
}
return missing;
},
null
);
if (missing) {
throw new Error(`Unable to find ${missing.join(', ')} in project graph.`);
}
const dependencies = collectedDeps
.map(({ name: dep, isTopLevel }) => {
let project: DependentBuildableProjectNode = null;
const depNode = projGraph.nodes[dep] || projGraph.externalNodes[dep];
if (depNode.type === 'lib') {
if (isBuildable(targetName, depNode)) {
const libPackageJsonPath = join(
root,
depNode.data.root,
'package.json'
);
project = {
name: fileExists(libPackageJsonPath)
? readJsonFile(libPackageJsonPath).name // i.e. @workspace/mylib
: dep,
outputs: getOutputsForTargetAndConfiguration(
{
overrides: {},
target: {
project: projectName,
target: targetName,
configuration: configurationName,
},
},
depNode
),
node: depNode,
};
} else {
nonBuildableDependencies.push(dep);
}
} else if (depNode.type === 'npm') {
project = {
name: depNode.data.packageName,
outputs: [],
node: depNode,
};
}
if (project && isTopLevel) {
topLevelDependencies.push(project);
}
return project;
})
.filter((x) => !!x);
return {
target,
dependencies,
nonBuildableDependencies,
topLevelDependencies,
};
}
function collectDependencies(
project: string,
projGraph: ProjectGraph,
acc: { name: string; isTopLevel: boolean }[],
shallow?: boolean,
areTopLevelDeps = true
): { name: string; isTopLevel: boolean }[] {
(projGraph.dependencies[project] || []).forEach((dependency) => {
if (!acc.some((dep) => dep.name === dependency.target)) {
// Temporary skip this. Currently the set of external nodes is built from package.json, not lock file.
// As a result, some nodes might be missing. This should not cause any issues, we can just skip them.
if (
dependency.target.startsWith('npm:') &&
!projGraph.externalNodes[dependency.target]
)
return;
acc.push({ name: dependency.target, isTopLevel: areTopLevelDeps });
if (!shallow) {
collectDependencies(dependency.target, projGraph, acc, shallow, false);
}
}
});
return acc;
}
function readTsConfigWithRemappedPaths(
tsConfig: string,
generatedTsConfigPath: string,
dependencies: DependentBuildableProjectNode[]
) {
const generatedTsConfig: any = { compilerOptions: {} };
generatedTsConfig.extends = relative(
dirname(generatedTsConfigPath),
tsConfig
);
generatedTsConfig.compilerOptions.paths = computeCompilerOptionsPaths(
tsConfig,
dependencies
);
if (process.env.NX_VERBOSE_LOGGING_PATH_MAPPINGS === 'true') {
output.log({
title: 'TypeScript path mappings have been rewritten.',
});
console.log(
JSON.stringify(generatedTsConfig.compilerOptions.paths, null, 2)
);
}
return generatedTsConfig;
}
/**
* Util function to create tsconfig compilerOptions object with support for workspace libs paths.
*
* @param tsConfig String of config path or object parsed via ts.parseJsonConfigFileContent.
* @param dependencies Dependencies calculated by Nx.
*/
export function computeCompilerOptionsPaths(
tsConfig: string | ts.ParsedCommandLine,
dependencies: DependentBuildableProjectNode[]
) {
const paths = readPaths(tsConfig) || {};
updatePaths(dependencies, paths);
return paths;
}
function readPaths(tsConfig: string | ts.ParsedCommandLine) {
try {
let config: ts.ParsedCommandLine;
if (typeof tsConfig === 'string') {
const configFile = ts.readConfigFile(tsConfig, ts.sys.readFile);
config = ts.parseJsonConfigFileContent(
configFile.config,
ts.sys,
dirname(tsConfig)
);
} else {
config = tsConfig;
}
if (config.options?.paths) {
return config.options.paths;
} else {
return null;
}
} catch (e) {
return null;
}
}
export function createTmpTsConfig(
tsconfigPath: string,
workspaceRoot: string,
projectRoot: string,
dependencies: DependentBuildableProjectNode[]
) {
const tmpTsConfigPath = join(
workspaceRoot,
'tmp',
projectRoot,
'tsconfig.generated.json'
);
const parsedTSConfig = readTsConfigWithRemappedPaths(
tsconfigPath,
tmpTsConfigPath,
dependencies
);
process.on('exit', () => cleanupTmpTsConfigFile(tmpTsConfigPath));
writeJsonFile(tmpTsConfigPath, parsedTSConfig);
return join(tmpTsConfigPath);
}
function cleanupTmpTsConfigFile(tmpTsConfigPath) {
try {
if (tmpTsConfigPath) {
unlinkSync(tmpTsConfigPath);
}
} catch (e) {}
}
export function checkDependentProjectsHaveBeenBuilt(
root: string,
projectName: string,
targetName: string,
projectDependencies: DependentBuildableProjectNode[]
): boolean {
const missing = findMissingBuildDependencies(
root,
projectName,
targetName,
projectDependencies
);
if (missing.length > 0) {
console.error(stripIndents`
It looks like all of ${projectName}'s dependencies have not been built yet:
${missing.map((x) => ` - ${x.node.name}`).join('\n')}
You might be missing a "targetDefaults" configuration in your root nx.json (https://nx.dev/reference/project-configuration#target-defaults),
or "dependsOn" configured in ${projectName}'s project.json (https://nx.dev/reference/project-configuration#dependson)
`);
return false;
} else {
return true;
}
}
export function findMissingBuildDependencies(
root: string,
projectName: string,
targetName: string,
projectDependencies: DependentBuildableProjectNode[]
): DependentBuildableProjectNode[] {
const depLibsToBuildFirst: DependentBuildableProjectNode[] = [];
// verify whether all dependent libraries have been built
projectDependencies.forEach((dep) => {
if (dep.node.type !== 'lib') {
return;
}
const paths = dep.outputs.map((p) => join(root, p));
if (!paths.some(directoryExists)) {
depLibsToBuildFirst.push(dep);
}
});
return depLibsToBuildFirst;
}
export function updatePaths(
dependencies: DependentBuildableProjectNode[],
paths: Record<string, string[]>
) {
const pathsKeys = Object.keys(paths);
// For each registered dependency
dependencies.forEach((dep) => {
// If there are outputs
if (dep.outputs && dep.outputs.length > 0) {
// Directly map the dependency name to the output paths (dist/packages/..., etc.)
paths[dep.name] = dep.outputs;
// check for secondary entrypoints
// For each registered path
for (const path of pathsKeys) {
const nestedName = `${dep.name}/`;
// If the path points to the current dependency and is nested (/)
if (path.startsWith(nestedName)) {
const nestedPart = path.slice(nestedName.length);
// Bind secondary endpoints for ng-packagr projects
let mappedPaths = dep.outputs.map(
(output) => `${output}/${nestedPart}`
);
// Get the dependency's package name
const { root } = dep.node?.data || {};
if (root) {
// Update nested mappings to point to the dependency's output paths
mappedPaths = mappedPaths.concat(
paths[path].flatMap((path) =>
dep.outputs.map((output) => path.replace(root, output))
)
);
}
paths[path] = mappedPaths;
}
}
}
});
}
/**
* Updates the peerDependencies section in the `dist/lib/xyz/package.json` with
* the proper dependency and version
*/
export function updateBuildableProjectPackageJsonDependencies(
root: string,
projectName: string,
targetName: string,
configurationName: string,
node: ProjectGraphProjectNode,
dependencies: DependentBuildableProjectNode[],
typeOfDependency: 'dependencies' | 'peerDependencies' = 'dependencies'
) {
const outputs = getOutputsForTargetAndConfiguration(
{
overrides: {},
target: {
project: projectName,
target: targetName,
configuration: configurationName,
},
},
node
);
const packageJsonPath = `${outputs[0]}/package.json`;
let packageJson;
let workspacePackageJson;
try {
packageJson = readJsonFile(packageJsonPath);
workspacePackageJson = readJsonFile(`${root}/package.json`);
} catch (e) {
// cannot find or invalid package.json
return;
}
packageJson.dependencies = packageJson.dependencies || {};
packageJson.peerDependencies = packageJson.peerDependencies || {};
let updatePackageJson = false;
dependencies.forEach((entry) => {
const packageName = isNpmProject(entry.node)
? entry.node.data.packageName
: entry.name;
if (
!hasDependency(packageJson, 'dependencies', packageName) &&
!hasDependency(packageJson, 'devDependencies', packageName) &&
!hasDependency(packageJson, 'peerDependencies', packageName)
) {
try {
let depVersion;
if (entry.node.type === 'lib') {
const outputs = getOutputsForTargetAndConfiguration(
{
overrides: {},
target: {
project: projectName,
target: targetName,
configuration: configurationName,
},
},
entry.node
);
const depPackageJsonPath = join(root, outputs[0], 'package.json');
depVersion = readJsonFile(depPackageJsonPath).version;
packageJson[typeOfDependency][packageName] = depVersion;
} else if (isNpmProject(entry.node)) {
// If an npm dep is part of the workspace devDependencies, do not include it the library
if (
!!workspacePackageJson.devDependencies?.[
entry.node.data.packageName
]
) {
return;
}
depVersion = entry.node.data.version;
packageJson[typeOfDependency][entry.node.data.packageName] =
depVersion;
}
updatePackageJson = true;
} catch (e) {
// skip if cannot find package.json
}
}
});
if (updatePackageJson) {
writeJsonFile(packageJsonPath, packageJson);
}
}
// verify whether the package.json already specifies the dep
function hasDependency(outputJson, depConfigName: string, packageName: string) {
if (outputJson[depConfigName]) {
return outputJson[depConfigName][packageName];
} else {
return false;
}
}