-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
index.ts
202 lines (183 loc) · 5.87 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
import { logger } from '../../../logger';
import { cache } from '../../../util/cache/package/decorator';
import { regEx } from '../../../util/regex';
import { coerceString } from '../../../util/string';
import { validateUrl } from '../../../util/url';
import * as hashicorpVersioning from '../../versioning/hashicorp';
import type { GetReleasesConfig, ReleaseResult } from '../types';
import { TerraformDatasource } from './base';
import type {
RegistryRepository,
ServiceDiscoveryResult,
TerraformModuleVersions,
TerraformRelease,
} from './types';
import { createSDBackendURL } from './utils';
export class TerraformModuleDatasource extends TerraformDatasource {
static override readonly id = 'terraform-module';
constructor() {
super(TerraformModuleDatasource.id);
}
override readonly defaultRegistryUrls = ['https://registry.terraform.io'];
override readonly defaultVersioning = hashicorpVersioning.id;
readonly extendedApiRegistryUrls = [
'https://registry.terraform.io',
'https://app.terraform.io',
];
/**
* This function will fetch a package from the specified Terraform registry and return all semver versions.
* - `sourceUrl` is supported of "source" field is set
* - `homepage` is set to the Terraform registry's page if it's on the official main registry
*/
@cache({
namespace: `datasource-${TerraformModuleDatasource.id}`,
key: (getReleasesConfig: GetReleasesConfig) =>
TerraformModuleDatasource.getCacheKey(getReleasesConfig),
})
async getReleases({
packageName,
registryUrl,
}: GetReleasesConfig): Promise<ReleaseResult | null> {
// istanbul ignore if
if (!registryUrl) {
return null;
}
const { registry: registryUrlNormalized, repository } =
TerraformModuleDatasource.getRegistryRepository(packageName, registryUrl);
logger.trace(
{ registryUrlNormalized, terraformRepository: repository },
'terraform-module.getReleases()'
);
const serviceDiscovery = await this.getTerraformServiceDiscoveryResult(
registryUrlNormalized
);
if (this.extendedApiRegistryUrls.includes(registryUrlNormalized)) {
return await this.queryRegistryExtendedApi(
serviceDiscovery,
registryUrlNormalized,
repository
);
}
return await this.queryRegistryVersions(
serviceDiscovery,
registryUrlNormalized,
repository
);
}
/**
* this uses the api that terraform registry has in addition to the base api
* this endpoint provides more information, such as release date
* https://www.terraform.io/registry/api-docs#latest-version-for-a-specific-module-provider
*/
private async queryRegistryExtendedApi(
serviceDiscovery: ServiceDiscoveryResult,
registryUrl: string,
repository: string
): Promise<ReleaseResult | null> {
let res: TerraformRelease;
let pkgUrl: string;
try {
// TODO: types (#22198)
pkgUrl = createSDBackendURL(
registryUrl,
'modules.v1',
serviceDiscovery,
repository
);
res = (await this.http.getJson<TerraformRelease>(pkgUrl)).body;
const returnedName = res.namespace + '/' + res.name + '/' + res.provider;
if (returnedName !== repository) {
logger.warn({ pkgUrl }, 'Terraform registry result mismatch');
return null;
}
} catch (err) {
this.handleGenericErrors(err);
}
// Simplify response before caching and returning
const dep: ReleaseResult = {
releases: res.versions.map((version) => ({
version,
})),
};
if (res.source) {
dep.sourceUrl = res.source;
}
dep.homepage = `${registryUrl}/modules/${repository}`;
// set published date for latest release
const latestVersion = dep.releases.find(
(release) => res.version === release.version
);
if (latestVersion) {
latestVersion.releaseTimestamp = res.published_at;
}
return dep;
}
/**
* this version uses the Module Registry Protocol that all registries are required to implement
* https://www.terraform.io/internals/module-registry-protocol
*/
private async queryRegistryVersions(
serviceDiscovery: ServiceDiscoveryResult,
registryUrl: string,
repository: string
): Promise<ReleaseResult | null> {
let res: TerraformModuleVersions;
let pkgUrl: string;
try {
// TODO: types (#22198)
pkgUrl = createSDBackendURL(
registryUrl,
'modules.v1',
serviceDiscovery,
`${repository}/versions`
);
res = (await this.http.getJson<TerraformModuleVersions>(pkgUrl)).body;
if (res.modules.length < 1) {
logger.warn({ pkgUrl }, 'Terraform registry result mismatch');
return null;
}
} catch (err) {
this.handleGenericErrors(err);
}
// Simplify response before caching and returning
const dep: ReleaseResult = {
releases: res.modules[0].versions.map(({ version }) => ({
version,
})),
};
// Add the source URL if given
if (validateUrl(res.modules[0].source)) {
dep.sourceUrl = res.modules[0].source;
}
return dep;
}
private static getRegistryRepository(
packageName: string,
registryUrl: string | undefined
): RegistryRepository {
let registry: string;
const split = packageName.split('/');
if (split.length > 3 && split[0].includes('.')) {
[registry] = split;
split.shift();
} else {
registry = coerceString(registryUrl);
}
if (!regEx(/^https?:\/\//).test(registry)) {
registry = `https://${registry}`;
}
const repository = split.join('/');
return {
registry,
repository,
};
}
private static getCacheKey({
packageName,
registryUrl,
}: GetReleasesConfig): string {
const { registry, repository } =
TerraformModuleDatasource.getRegistryRepository(packageName, registryUrl);
return `${registry}/${repository}`;
}
}