-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
schema.ts
359 lines (318 loc) · 9.63 KB
/
schema.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
import { z } from 'zod';
import { logger } from '../../../logger';
import { readLocalFile } from '../../../util/fs';
import { regEx } from '../../../util/regex';
import { Json, LooseArray, LooseRecord } from '../../../util/schema-utils';
import { BitbucketTagsDatasource } from '../../datasource/bitbucket-tags';
import { GitTagsDatasource } from '../../datasource/git-tags';
import { GithubTagsDatasource } from '../../datasource/github-tags';
import { PackagistDatasource } from '../../datasource/packagist';
import { api as semverComposer } from '../../versioning/composer';
import type { PackageDependency, PackageFileContent } from '../types';
import type { ComposerManagerData } from './types';
export const ComposerRepo = z.object({
type: z.literal('composer'),
/**
* The regUrl is expected to be a base URL. GitLab composer repository installation guide specifies
* to use a base URL containing packages.json. Composer still works in this scenario by determining
* whether to add / remove packages.json from the URL.
*
* See https://github.com/composer/composer/blob/750a92b4b7aecda0e5b2f9b963f1cb1421900675/src/Composer/Repository/ComposerRepository.php#L815
*/
url: z.string().transform((url) => url.replace(/\/packages\.json$/, '')),
});
export type ComposerRepo = z.infer<typeof ComposerRepo>;
export const GitRepo = z.object({
type: z.enum(['vcs', 'git']).transform(() => 'git' as const),
url: z.string(),
name: z.string().optional(),
});
export type GitRepo = z.infer<typeof GitRepo>;
export const PathRepo = z.object({
type: z.literal('path'),
url: z.string(),
name: z.string().optional(),
});
export type PathRepo = z.infer<typeof PathRepo>;
export const PackageRepo = z.object({
type: z.literal('package'),
});
export const Repo = z.discriminatedUnion('type', [
ComposerRepo,
GitRepo,
PathRepo,
PackageRepo,
]);
export type Repo = z.infer<typeof ComposerRepo>;
export const NamedRepo = z.discriminatedUnion('type', [
ComposerRepo,
GitRepo.extend({ name: z.string() }),
PathRepo.extend({ name: z.string() }),
PackageRepo,
]);
export type NamedRepo = z.infer<typeof NamedRepo>;
const DisablePackagist = z.object({ type: z.literal('disable-packagist') });
export type DisablePackagist = z.infer<typeof DisablePackagist>;
const bitbucketUrlRegex = regEx(
/^(?:https:\/\/|git@)bitbucket\.org[/:](?<packageName>[^/]+\/[^/]+?)(?:\.git)?$/,
);
export const ReposRecord = LooseRecord(z.union([Repo, z.literal(false)]), {
onError: ({ error: err }) => {
logger.debug({ err }, 'Composer: error parsing repositories object');
},
}).transform((repos) => {
const result: (NamedRepo | DisablePackagist)[] = [];
for (const [name, repo] of Object.entries(repos)) {
if (repo === false) {
if (name === 'packagist' || name === 'packagist.org') {
result.push({ type: 'disable-packagist' });
}
continue;
}
if (repo.type === 'path' || repo.type === 'git') {
result.push({ name, ...repo });
continue;
}
if (repo.type === 'composer') {
result.push(repo);
continue;
}
}
return result;
});
export type ReposRecord = z.infer<typeof ReposRecord>;
export const ReposArray = LooseArray(
z.union([
Repo,
z
.union([
z.object({ packagist: z.literal(false) }),
z.object({ 'packagist.org': z.literal(false) }),
])
.transform((): DisablePackagist => ({ type: 'disable-packagist' })),
]),
{
onError: ({ error: err }) => {
logger.debug({ err }, 'Composer: error parsing repositories array');
},
},
).transform((repos) => {
const result: (NamedRepo | DisablePackagist)[] = [];
for (let idx = 0; idx < repos.length; idx++) {
const repo = repos[idx];
if (repo.type === 'path' || repo.type === 'git') {
result.push({ name: `__${idx}`, ...repo });
} else {
result.push(repo);
}
}
return result;
});
export type ReposArray = z.infer<typeof ReposArray>;
export const Repos = z
.union([ReposRecord, ReposArray])
.default([]) // Prevents warnings for packages without repositories field
.catch(({ error: err }) => {
logger.debug({ err }, 'Composer: invalid "repositories" field');
return [];
})
.transform((repos) => {
let packagist = true;
const repoUrls: string[] = [];
const gitRepos: Record<string, GitRepo> = {};
const pathRepos: Record<string, PathRepo> = {};
for (const repo of repos) {
if (repo.type === 'composer') {
repoUrls.push(repo.url);
} else if (repo.type === 'git') {
gitRepos[repo.name] = repo;
} else if (repo.type === 'path') {
pathRepos[repo.name] = repo;
} else if (repo.type === 'disable-packagist') {
packagist = false;
}
}
if (packagist && repoUrls.length) {
repoUrls.push('https://packagist.org');
}
const registryUrls = repoUrls.length ? repoUrls : null;
return { registryUrls, gitRepos, pathRepos };
});
export type Repos = z.infer<typeof Repos>;
const RequireDefs = LooseRecord(z.string().transform((x) => x.trim())).catch(
{},
);
export const PackageFile = z
.object({
type: z.string().optional(),
config: z
.object({
platform: z.object({
php: z.string(),
}),
})
.nullable()
.catch(null),
repositories: Repos,
require: RequireDefs,
'require-dev': RequireDefs,
})
.transform(
({
type: composerJsonType,
config,
repositories,
require,
'require-dev': requireDev,
}) => ({
composerJsonType,
config,
repositories,
require,
requireDev,
}),
);
export type PackageFile = z.infer<typeof PackageFile>;
const LockedPackage = z.object({
name: z.string(),
version: z.string(),
});
type LockedPackage = z.infer<typeof LockedPackage>;
export const Lockfile = z
.object({
'plugin-api-version': z.string().optional(),
packages: LooseArray(LockedPackage).catch([]),
'packages-dev': LooseArray(LockedPackage).catch([]),
})
.transform(
({
'plugin-api-version': pluginApiVersion,
packages,
'packages-dev': packagesDev,
}) => ({ pluginApiVersion, packages, packagesDev }),
);
export type Lockfile = z.infer<typeof Lockfile>;
export const ComposerExtract = z
.object({
content: z.string(),
fileName: z.string(),
})
.transform(({ content, fileName }) => {
const lockfileName = fileName.replace(/\.json$/, '.lock');
return {
file: content,
lockfileName,
lockfile: lockfileName,
};
})
.pipe(
z.object({
file: Json.pipe(PackageFile),
lockfileName: z.string(),
lockfile: z
.string()
.transform((lockfileName) => readLocalFile(lockfileName, 'utf8'))
.pipe(
z.union([
z.null(),
z
.string()
.pipe(Json)
.pipe(Lockfile)
.nullable()
.catch(({ error: err }) => {
logger.debug({ err }, 'Composer: lockfile parsing error');
return null;
}),
]),
),
}),
)
.transform(({ file, lockfile, lockfileName }) => {
const { composerJsonType, require, requireDev } = file;
const { registryUrls, gitRepos, pathRepos } = file.repositories;
const deps: PackageDependency[] = [];
const profiles = [
{
depType: 'require',
req: require,
locked: lockfile?.packages ?? [],
},
{
depType: 'require-dev',
req: requireDev,
locked: lockfile?.packagesDev ?? [],
},
];
for (const { depType, req, locked } of profiles) {
for (const [depName, currentValue] of Object.entries(req)) {
if (depName === 'php') {
deps.push({
depType,
depName,
currentValue,
datasource: GithubTagsDatasource.id,
packageName: 'containerbase/php-prebuild',
});
continue;
}
if (pathRepos[depName]) {
deps.push({
depType,
depName,
currentValue,
skipReason: 'path-dependency',
});
continue;
}
const dep: PackageDependency = {
depType,
depName,
currentValue,
};
if (!depName.includes('/')) {
dep.skipReason = 'unsupported';
}
const lockedDep = locked.find((item) => item.name === depName);
if (lockedDep && semverComposer.isVersion(lockedDep.version)) {
dep.lockedVersion = lockedDep.version.replace(regEx(/^v/i), '');
}
const gitRepo = gitRepos[depName];
if (gitRepo) {
const bitbucketMatchGroups = bitbucketUrlRegex.exec(
gitRepo.url,
)?.groups;
if (bitbucketMatchGroups) {
dep.datasource = BitbucketTagsDatasource.id;
dep.packageName = bitbucketMatchGroups.packageName;
deps.push(dep);
continue;
}
dep.datasource = GitTagsDatasource.id;
dep.packageName = gitRepo.url;
deps.push(dep);
continue;
}
dep.datasource = PackagistDatasource.id;
if (registryUrls) {
dep.registryUrls = registryUrls;
}
deps.push(dep);
}
}
if (!deps.length) {
return null;
}
const res: PackageFileContent<ComposerManagerData> = { deps };
if (composerJsonType) {
res.managerData = { composerJsonType };
}
if (require.php) {
res.extractedConstraints = { php: require.php };
}
if (lockfile) {
res.lockFiles = [lockfileName];
}
return res;
});
export type ComposerExtract = z.infer<typeof ComposerExtract>;