/
index.ts
307 lines (290 loc) · 8.66 KB
/
index.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
import URL from 'url';
import pAll from 'p-all';
import { logger } from '../../logger';
import { ExternalHostError } from '../../types/errors/external-host-error';
import * as memCache from '../../util/cache/memory';
import * as packageCache from '../../util/cache/package';
import * as hostRules from '../../util/host-rules';
import { Http, HttpOptions } from '../../util/http';
import * as composerVersioning from '../../versioning/composer';
import type { GetReleasesConfig, ReleaseResult } from '../types';
export const id = 'packagist';
export const customRegistrySupport = true;
export const defaultRegistryUrls = ['https://packagist.org'];
export const defaultVersioning = composerVersioning.id;
export const registryStrategy = 'hunt';
const http = new Http(id);
// We calculate auth at this datasource layer so that we can know whether it's safe to cache or not
function getHostOpts(url: string): HttpOptions {
let opts: HttpOptions = {};
const { username, password } = hostRules.find({
hostType: id,
url,
});
if (username && password) {
opts = { ...opts, username, password };
}
return opts;
}
interface PackageMeta {
includes?: Record<string, { sha256: string }>;
packages: Record<string, RegistryFile>;
'provider-includes': Record<string, { sha256: string }>;
providers: Record<string, { sha256: string }>;
'providers-url'?: string;
}
interface RegistryFile {
key: string;
sha256: string;
}
interface RegistryMeta {
files?: RegistryFile[];
providerPackages: Record<string, string>;
providersUrl?: string;
providersLazyUrl?: string;
includesFiles?: RegistryFile[];
packages?: Record<string, RegistryFile>;
}
async function getRegistryMeta(regUrl: string): Promise<RegistryMeta | null> {
const url = URL.resolve(regUrl.replace(/\/?$/, '/'), 'packages.json');
const opts = getHostOpts(url);
const res = (await http.getJson<PackageMeta>(url, opts)).body;
const meta: RegistryMeta = {
providerPackages: {},
};
meta.packages = res.packages;
if (res.includes) {
meta.includesFiles = [];
for (const [name, val] of Object.entries(res.includes)) {
const file = {
key: name.replace(val.sha256, '%hash%'),
sha256: val.sha256,
};
meta.includesFiles.push(file);
}
}
if (res['providers-url']) {
meta.providersUrl = res['providers-url'];
}
if (res['providers-lazy-url']) {
meta.providersLazyUrl = res['providers-lazy-url'];
}
if (res['provider-includes']) {
meta.files = [];
for (const [key, val] of Object.entries(res['provider-includes'])) {
const file = {
key,
sha256: val.sha256,
};
meta.files.push(file);
}
}
if (res.providers) {
for (const [key, val] of Object.entries(res.providers)) {
meta.providerPackages[key] = val.sha256;
}
}
return meta;
}
interface PackagistFile {
providers: Record<string, RegistryFile>;
packages?: Record<string, RegistryFile>;
}
async function getPackagistFile(
regUrl: string,
file: RegistryFile
): Promise<PackagistFile> {
const { key, sha256 } = file;
const fileName = key.replace('%hash%', sha256);
const opts = getHostOpts(regUrl);
if (opts.password || opts.headers?.authorization) {
return (await http.getJson<PackagistFile>(regUrl + '/' + fileName, opts))
.body;
}
const cacheNamespace = 'datasource-packagist-files';
const cacheKey = regUrl + key;
// Check the persistent cache for public registries
const cachedResult = await packageCache.get(cacheNamespace, cacheKey);
// istanbul ignore if
if (cachedResult && cachedResult.sha256 === sha256) {
return cachedResult.res as Promise<PackagistFile>;
}
const res = (await http.getJson<PackagistFile>(regUrl + '/' + fileName, opts))
.body;
const cacheMinutes = 1440; // 1 day
await packageCache.set(
cacheNamespace,
cacheKey,
{ res, sha256 },
cacheMinutes
);
return res;
}
function extractDepReleases(versions: RegistryFile): ReleaseResult {
const dep: ReleaseResult = { releases: null };
// istanbul ignore if
if (!versions) {
dep.releases = [];
return dep;
}
dep.releases = Object.keys(versions).map((version) => {
const release = versions[version];
dep.homepage = release.homepage || dep.homepage;
if (release.source?.url) {
dep.sourceUrl = release.source.url;
}
return {
version: version.replace(/^v/, ''),
gitRef: version,
releaseTimestamp: release.time,
};
});
return dep;
}
interface AllPackages {
packages: Record<string, RegistryFile>;
providersUrl: string;
providersLazyUrl: string;
providerPackages: Record<string, string>;
includesPackages: Record<string, ReleaseResult>;
}
async function getAllPackages(regUrl: string): Promise<AllPackages | null> {
const registryMeta = await getRegistryMeta(regUrl);
const {
packages,
providersUrl,
providersLazyUrl,
files,
includesFiles,
providerPackages,
} = registryMeta;
if (files) {
const queue = files.map((file) => (): Promise<PackagistFile> =>
getPackagistFile(regUrl, file)
);
const resolvedFiles = await pAll(queue, { concurrency: 5 });
for (const res of resolvedFiles) {
for (const [name, val] of Object.entries(res.providers)) {
providerPackages[name] = val.sha256;
}
}
}
const includesPackages: Record<string, ReleaseResult> = {};
if (includesFiles) {
for (const file of includesFiles) {
const res = await getPackagistFile(regUrl, file);
if (res.packages) {
for (const [key, val] of Object.entries(res.packages)) {
const dep = extractDepReleases(val);
includesPackages[key] = dep;
}
}
}
}
const allPackages: AllPackages = {
packages,
providersUrl,
providersLazyUrl,
providerPackages,
includesPackages,
};
return allPackages;
}
function getAllCachedPackages(regUrl: string): Promise<AllPackages | null> {
const cacheKey = `packagist-${regUrl}`;
const cachedResult = memCache.get<Promise<AllPackages | null>>(cacheKey);
// istanbul ignore if
if (cachedResult !== undefined) {
return cachedResult;
}
const promisedRes = getAllPackages(regUrl);
memCache.set(cacheKey, promisedRes);
return promisedRes;
}
async function packagistOrgLookup(name: string): Promise<ReleaseResult> {
const cacheNamespace = 'datasource-packagist-org';
const cachedResult = await packageCache.get<ReleaseResult>(
cacheNamespace,
name
);
// istanbul ignore if
if (cachedResult) {
return cachedResult;
}
let dep: ReleaseResult = null;
const regUrl = 'https://packagist.org';
const pkgUrl = URL.resolve(regUrl, `/p/${name}.json`);
// TODO: fix types (#9610)
const res = (await http.getJson<any>(pkgUrl)).body.packages[name];
if (res) {
dep = extractDepReleases(res);
logger.trace({ dep }, 'dep');
}
const cacheMinutes = 10;
await packageCache.set(cacheNamespace, name, dep, cacheMinutes);
return dep;
}
async function packageLookup(
regUrl: string,
name: string
): Promise<ReleaseResult | null> {
try {
if (regUrl === 'https://packagist.org') {
const packagistResult = await packagistOrgLookup(name);
return packagistResult;
}
const allPackages = await getAllCachedPackages(regUrl);
const {
packages,
providersUrl,
providersLazyUrl,
providerPackages,
includesPackages,
} = allPackages;
if (packages?.[name]) {
const dep = extractDepReleases(packages[name]);
return dep;
}
if (includesPackages?.[name]) {
return includesPackages[name];
}
let pkgUrl;
if (providerPackages?.[name]) {
pkgUrl = URL.resolve(
regUrl,
providersUrl
.replace('%package%', name)
.replace('%hash%', providerPackages[name])
);
} else if (providersLazyUrl) {
pkgUrl = URL.resolve(regUrl, providersLazyUrl.replace('%package%', name));
} else {
return null;
}
const opts = getHostOpts(regUrl);
// TODO: fix types (#9610)
const versions = (await http.getJson<any>(pkgUrl, opts)).body.packages[
name
];
const dep = extractDepReleases(versions);
logger.trace({ dep }, 'dep');
return dep;
} catch (err) /* istanbul ignore next */ {
if (err.host === 'packagist.org') {
if (err.code === 'ECONNRESET' || err.code === 'ETIMEDOUT') {
throw new ExternalHostError(err);
}
if (err.statusCode && err.statusCode >= 500 && err.statusCode < 600) {
throw new ExternalHostError(err);
}
}
throw err;
}
}
export function getReleases({
lookupName,
registryUrl,
}: GetReleasesConfig): Promise<ReleaseResult> {
logger.trace(`getReleases(${lookupName})`);
return packageLookup(registryUrl, lookupName);
}