-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
extract.ts
341 lines (314 loc) · 9.73 KB
/
extract.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
import { logger } from '../../../logger';
import type { SkipReason } from '../../../types';
import { coerceArray } from '../../../util/array';
import { findLocalSiblingOrParent, readLocalFile } from '../../../util/fs';
import { parse as parseToml } from '../../../util/toml';
import { CrateDatasource } from '../../datasource/crate';
import { api as versioning } from '../../versioning/cargo';
import type {
ExtractConfig,
PackageDependency,
PackageFileContent,
} from '../types';
import { extractLockFileVersions } from './locked-version';
import type {
CargoConfig,
CargoManifest,
CargoRegistries,
CargoRegistryUrl,
CargoSection,
} from './types';
import { DEFAULT_REGISTRY_URL } from './utils';
const DEFAULT_REGISTRY_ID = 'crates-io';
function getCargoIndexEnv(registryName: string): string | null {
const registry = registryName.toUpperCase().replaceAll('-', '_');
return process.env[`CARGO_REGISTRIES_${registry}_INDEX`] ?? null;
}
function extractFromSection(
parsedContent: CargoSection,
section: keyof CargoSection,
cargoRegistries: CargoRegistries,
target?: string,
depTypeOverride?: string,
): PackageDependency[] {
const deps: PackageDependency[] = [];
const sectionContent = parsedContent[section];
if (!sectionContent) {
return [];
}
Object.keys(sectionContent).forEach((depName) => {
let skipReason: SkipReason | undefined;
let currentValue = sectionContent[depName];
let nestedVersion = false;
let registryUrls: string[] | undefined;
let packageName: string | undefined;
if (typeof currentValue !== 'string') {
const version = currentValue.version;
const path = currentValue.path;
const git = currentValue.git;
const registryName = currentValue.registry;
const workspace = currentValue.workspace;
packageName = currentValue.package;
if (version) {
currentValue = version;
nestedVersion = true;
if (registryName) {
const registryUrl =
getCargoIndexEnv(registryName) ?? cargoRegistries[registryName];
if (registryUrl) {
if (registryUrl !== DEFAULT_REGISTRY_URL) {
registryUrls = [registryUrl];
}
} else {
skipReason = 'unknown-registry';
}
}
if (path) {
skipReason = 'path-dependency';
}
if (git) {
skipReason = 'git-dependency';
}
} else if (path) {
currentValue = '';
skipReason = 'path-dependency';
} else if (git) {
currentValue = '';
skipReason = 'git-dependency';
} else if (workspace) {
currentValue = '';
skipReason = 'inherited-dependency';
} else {
currentValue = '';
skipReason = 'invalid-dependency-specification';
}
}
const dep: PackageDependency = {
depName,
depType: section,
currentValue: currentValue as any,
managerData: { nestedVersion },
datasource: CrateDatasource.id,
};
if (registryUrls) {
dep.registryUrls = registryUrls;
} else {
// if we don't have an explicit registry URL check if the default registry has a non-standard url
if (cargoRegistries[DEFAULT_REGISTRY_ID]) {
if (cargoRegistries[DEFAULT_REGISTRY_ID] !== DEFAULT_REGISTRY_URL) {
dep.registryUrls = [cargoRegistries[DEFAULT_REGISTRY_ID]];
}
} else {
// we always expect to have DEFAULT_REGISTRY_ID set, if it's not it means the config defines an alternative
// registry that we couldn't resolve.
skipReason = 'unknown-registry';
}
}
if (skipReason) {
dep.skipReason = skipReason;
}
if (target) {
dep.target = target;
}
if (packageName) {
dep.packageName = packageName;
}
if (depTypeOverride) {
dep.depType = depTypeOverride;
}
deps.push(dep);
});
return deps;
}
/** Reads `.cargo/config.toml`, or, if not found, `.cargo/config` */
async function readCargoConfig(): Promise<CargoConfig | null> {
for (const configName of ['config.toml', 'config']) {
const path = `.cargo/${configName}`;
const payload = await readLocalFile(path, 'utf8');
if (payload) {
try {
return parseToml(payload) as CargoConfig;
} catch (err) {
logger.debug({ err }, `Error parsing ${path}`);
}
break;
}
}
logger.debug('Neither .cargo/config nor .cargo/config.toml found');
return null;
}
/** Extracts a map of cargo registries from a CargoConfig */
function extractCargoRegistries(config: CargoConfig): CargoRegistries {
const result: CargoRegistries = {};
// check if we're overriding our default registry index
result[DEFAULT_REGISTRY_ID] = resolveRegistryIndex(
DEFAULT_REGISTRY_ID,
config,
);
const registryNames = new Set([
...Object.keys(config.registries ?? {}),
...Object.keys(config.source ?? {}),
]);
for (const registryName of registryNames) {
result[registryName] = resolveRegistryIndex(registryName, config);
}
return result;
}
function resolveRegistryIndex(
registryName: string,
config: CargoConfig,
originalNames: Set<string> = new Set(),
): CargoRegistryUrl {
// if we have a source replacement, follow that.
// https://doc.rust-lang.org/cargo/reference/source-replacement.html
const replacementName = config.source?.[registryName]?.['replace-with'];
if (replacementName) {
logger.debug(
`Replacing index of cargo registry ${registryName} with ${replacementName}`,
);
if (originalNames.has(replacementName)) {
logger.warn(`${registryName} cargo registry resolves to itself`);
return null;
}
return resolveRegistryIndex(
replacementName,
config,
originalNames.add(replacementName),
);
}
const sourceRegistry = config.source?.[registryName]?.registry;
if (sourceRegistry) {
logger.debug(
`Replacing cargo source registry with ${sourceRegistry} for ${registryName}`,
);
return sourceRegistry;
}
const registryIndex = config.registries?.[registryName]?.index;
if (registryIndex) {
return registryIndex;
} else {
// we don't need an explicit index if we're using the default registry
if (registryName === DEFAULT_REGISTRY_ID) {
return DEFAULT_REGISTRY_URL;
} else {
logger.debug(`${registryName} cargo registry is missing index`);
return null;
}
}
}
export async function extractPackageFile(
content: string,
packageFile: string,
_config?: ExtractConfig,
): Promise<PackageFileContent | null> {
logger.trace(`cargo.extractPackageFile(${packageFile})`);
const cargoConfig = (await readCargoConfig()) ?? {};
const cargoRegistries = extractCargoRegistries(cargoConfig);
let cargoManifest: CargoManifest;
try {
cargoManifest = parseToml(content) as CargoManifest;
} catch (err) {
logger.debug({ err, packageFile }, 'Error parsing Cargo.toml file');
return null;
}
/*
There are the following sections in Cargo.toml:
[package]
[dependencies]
[dev-dependencies]
[build-dependencies]
[target.*.dependencies]
[workspace.dependencies]
*/
const targetSection = cargoManifest.target;
// An array of all dependencies in the target section
let targetDeps: PackageDependency[] = [];
if (targetSection) {
const targets = Object.keys(targetSection);
targets.forEach((target) => {
const targetContent = targetSection[target];
// Dependencies for `${target}`
const deps = [
...extractFromSection(
targetContent,
'dependencies',
cargoRegistries,
target,
),
...extractFromSection(
targetContent,
'dev-dependencies',
cargoRegistries,
target,
),
...extractFromSection(
targetContent,
'build-dependencies',
cargoRegistries,
target,
),
];
targetDeps = targetDeps.concat(deps);
});
}
const workspaceSection = cargoManifest.workspace;
let workspaceDeps: PackageDependency[] = [];
if (workspaceSection) {
workspaceDeps = extractFromSection(
workspaceSection,
'dependencies',
cargoRegistries,
undefined,
'workspace.dependencies',
);
}
const deps = [
...extractFromSection(cargoManifest, 'dependencies', cargoRegistries),
...extractFromSection(cargoManifest, 'dev-dependencies', cargoRegistries),
...extractFromSection(cargoManifest, 'build-dependencies', cargoRegistries),
...targetDeps,
...workspaceDeps,
];
if (!deps.length) {
return null;
}
const packageSection = cargoManifest.package;
let version: string | undefined = undefined;
if (packageSection) {
version = packageSection.version;
}
const lockFileName = await findLocalSiblingOrParent(
packageFile,
'Cargo.lock',
);
const res: PackageFileContent = { deps, packageFileVersion: version };
if (lockFileName) {
logger.debug(
`Found lock file ${lockFileName} for packageFile: ${packageFile}`,
);
const versionsByPackage = await extractLockFileVersions(lockFileName);
if (!versionsByPackage) {
logger.debug(
`Could not extract lock file versions from ${lockFileName}.`,
);
return res;
}
res.lockFiles = [lockFileName];
for (const dep of deps) {
const packageName = dep.packageName ?? dep.depName!;
const versions = coerceArray(versionsByPackage.get(packageName));
const lockedVersion = versioning.getSatisfyingVersion(
versions,
dep.currentValue!,
);
if (lockedVersion) {
dep.lockedVersion = lockedVersion;
} else {
logger.debug(
`No locked version found for package ${dep.depName} in the range of ${dep.currentValue}.`,
);
}
}
}
return res;
}