/
extract.ts
186 lines (178 loc) · 5.65 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
import is from '@sindresorhus/is';
import * as datasourceGitTags from '../../datasource/git-tags';
import * as datasourcePackagist from '../../datasource/packagist';
import { logger } from '../../logger';
import { SkipReason } from '../../types';
import { readLocalFile } from '../../util/fs';
import { api as semverComposer } from '../../versioning/composer';
import { PackageDependency, PackageFile } from '../common';
interface Repo {
name?: string;
type: 'composer' | 'git' | 'package' | 'vcs';
packagist?: boolean;
'packagist.org'?: boolean;
url: string;
}
interface ComposerConfig {
type?: string;
/**
* A repositories field can be an array of Repo objects or an object of repoName: Repo
* Also it can be a boolean (usually false) to disable packagist.
* (Yes this can be confusing, as it is also not properly documented in the composer docs)
* See https://getcomposer.org/doc/05-repositories.md#disabling-packagist-org
*/
repositories: Record<string, Repo | boolean> | Repo[];
require: Record<string, string>;
'require-dev': Record<string, string>;
}
/**
* Parse the repositories field from a composer.json
*
* Entries with type vcs or git will be added to repositories,
* other entries will be added to registryUrls
*/
function parseRepositories(
repoJson: ComposerConfig['repositories'],
repositories: Record<string, Repo>,
registryUrls: string[]
): void {
try {
let packagist = true;
Object.entries(repoJson).forEach(([key, repo]) => {
if (is.object(repo)) {
const name = is.array(repoJson) ? repo.name : key;
// eslint-disable-next-line default-case
switch (repo.type) {
case 'vcs':
case 'git':
// eslint-disable-next-line no-param-reassign
repositories[name] = repo;
break;
case 'composer':
registryUrls.push(repo.url);
break;
case 'package':
logger.debug(
{ url: repo.url },
'type package is not supported yet'
);
}
if (repo.packagist === false || repo['packagist.org'] === false) {
packagist = false;
}
} else if (
['packagist', 'packagist.org'].includes(key) &&
repo === false
) {
packagist = false;
}
});
if (packagist) {
registryUrls.push('https://packagist.org');
} else {
logger.debug('Disabling packagist.org');
}
} catch (e) /* istanbul ignore next */ {
logger.debug(
{ repositories: repoJson },
'Error parsing composer.json repositories config'
);
}
}
export async function extractPackageFile(
content: string,
fileName: string
): Promise<PackageFile | null> {
logger.trace(`composer.extractPackageFile(${fileName})`);
let composerJson: ComposerConfig;
try {
composerJson = JSON.parse(content);
} catch (err) {
logger.debug({ fileName }, 'Invalid JSON');
return null;
}
const repositories: Record<string, Repo> = {};
const registryUrls: string[] = [];
const res: PackageFile = { deps: [] };
// handle lockfile
const lockfilePath = fileName.replace(/\.json$/, '.lock');
const lockContents = await readLocalFile(lockfilePath, 'utf8');
let lockParsed;
if (lockContents) {
logger.debug({ packageFile: fileName }, 'Found composer lock file');
try {
lockParsed = JSON.parse(lockContents);
} catch (err) /* istanbul ignore next */ {
logger.warn({ err }, 'Error processing composer.lock');
}
}
// handle composer.json repositories
if (composerJson.repositories) {
parseRepositories(composerJson.repositories, repositories, registryUrls);
}
if (registryUrls.length !== 0) {
res.registryUrls = registryUrls;
}
const deps = [];
const depTypes = ['require', 'require-dev'];
for (const depType of depTypes) {
if (composerJson[depType]) {
try {
for (const [depName, version] of Object.entries(
composerJson[depType] as Record<string, string>
)) {
const currentValue = version.trim();
// Default datasource and lookupName
let datasource = datasourcePackagist.id;
let lookupName = depName;
// Check custom repositories by type
if (repositories[depName]) {
// eslint-disable-next-line default-case
switch (repositories[depName].type) {
case 'vcs':
case 'git':
datasource = datasourceGitTags.id;
lookupName = repositories[depName].url;
break;
}
}
const dep: PackageDependency = {
depType,
depName,
currentValue,
datasource,
};
if (depName !== lookupName) {
dep.lookupName = lookupName;
}
if (!depName.includes('/')) {
dep.skipReason = SkipReason.Unsupported;
}
if (currentValue === '*') {
dep.skipReason = SkipReason.AnyVersion;
}
if (lockParsed) {
const lockedDep = lockParsed.packages.find(
(item) => item.name === dep.depName
);
if (lockedDep && semverComposer.isVersion(lockedDep.version)) {
dep.lockedVersion = lockedDep.version.replace(/^v/i, '');
}
}
deps.push(dep);
}
} catch (err) /* istanbul ignore next */ {
logger.debug({ fileName, depType, err }, 'Error parsing composer.json');
return null;
}
}
}
if (!deps.length) {
return null;
}
res.deps = deps;
if (composerJson.type) {
res.managerData = { composerJsonType: composerJson.type };
}
return res;
}