-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
containerRepository.ts
293 lines (274 loc) · 8.74 KB
/
containerRepository.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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
/// <reference lib="esnext.asynciterable" />
import { OperationOptions } from "@azure/core-client";
import { SpanStatusCode } from "@azure/core-tracing";
import "@azure/core-paging";
import { PageSettings, PagedAsyncIterableIterator } from "@azure/core-paging";
import { GeneratedClient, RepositoryWriteableProperties } from "./generated";
import { createSpan } from "./tracing";
import {
ManifestOrderBy,
ContainerRepositoryProperties,
ArtifactManifestProperties,
ManifestPageResponse
} from "./models";
import { RegistryArtifact, RegistryArtifactImpl } from "./registryArtifact";
import { toArtifactManifestProperties, toServiceManifestOrderBy } from "./transformations";
import { extractNextLink } from "./utils";
/**
* Options for delete repository operation.
*/
export interface DeleteRepositoryOptions extends OperationOptions {}
/**
* Options for the `listRegistryArtifacts` method of `ContainerRepository`.
*/
export interface ListManifestPropertiesOptions extends OperationOptions {
/** orderby query parameter */
orderBy?: ManifestOrderBy;
}
/**
* Options for the `getProperties` method of `ContainerRepository`.
*/
export interface GetRepositoryPropertiesOptions extends OperationOptions {}
/**
* Options for the `setProperties` method of `ContainerRepository`.
*/
export interface UpdateRepositoryPropertiesOptions extends OperationOptions {
/** Delete enabled */
canDelete?: boolean;
/** Write enabled */
canWrite?: boolean;
/** List enabled */
canList?: boolean;
/** Read enabled */
canRead?: boolean;
/** Enables Teleport functionality on new images in the repository improving Container startup performance */
teleportEnabled?: boolean;
}
/**
* The helper used to interact with the Container Registry service.
*/
export interface ContainerRepository {
/**
* The Azure Container Registry endpoint.
*/
readonly registryEndpoint: string;
/**
* Repository name.
*/
readonly name: string;
/**
* Deletes this repository.
*
* @param options - optional configuration for the operation
*/
delete(options?: DeleteRepositoryOptions): Promise<void>;
/**
* Returns an instance of RegistryArtifact.
* @param tagOrDigest - the tag or digest of the artifact
*/
getArtifact(tagOrDigest: string): RegistryArtifact;
/**
* Retrieves properties of this repository.
* @param options -
*/
getProperties(options?: GetRepositoryPropertiesOptions): Promise<ContainerRepositoryProperties>;
/**
* Updates repository attributes.
* @param options -
*/
updateProperties(
options: UpdateRepositoryPropertiesOptions
): Promise<ContainerRepositoryProperties>;
/**
* Iterates manifests.
*
* Example usage:
* ```ts
* const client = new ContainerRegistryClient(url, credentials);
* const repository = client.getRepository(repositoryName)
* for await (const manifest of repository.listManifestProperties()) {
* console.log("manifest: ", manifest);
* }
* ```
* @param options -
*/
listManifestProperties(
options?: ListManifestPropertiesOptions
): PagedAsyncIterableIterator<ArtifactManifestProperties>;
}
/**
* The client class used to interact with the Container Registry service.
* @internal
*/
export class ContainerRepositoryImpl {
private readonly client: GeneratedClient;
/**
* The Azure Container Registry endpoint.
*/
public readonly registryEndpoint: string;
/**
* Repository name.
*/
public readonly name: string;
/**
* Creates an instance of a ContainerRepository.
* @param registryEndpoint - the URL to the Container Registry endpoint
* @param name - the name of the repository
* @param client - the generated client that interacts with service
*/
constructor(registryEndpoint: string, name: string, client: GeneratedClient) {
this.registryEndpoint = registryEndpoint;
this.name = name;
this.client = client;
}
/**
* Deletes this repository.
*
* @param options - optional configuration for the operation
*/
public async delete(options: DeleteRepositoryOptions = {}): Promise<void> {
const { span, updatedOptions } = createSpan("ContainerRepository-delete", options);
try {
await this.client.containerRegistry.deleteRepository(this.name, updatedOptions);
} catch (e) {
span.setStatus({ code: SpanStatusCode.ERROR, message: e.message });
throw e;
} finally {
span.end();
}
}
/**
* Returns an instance of RegistryArtifact.
* @param tagOrDigest - the tag or digest of the artifact
*/
public getArtifact(tagOrDigest: string): RegistryArtifact {
if (!tagOrDigest) {
throw new Error("invalid tagOrDigest");
}
return new RegistryArtifactImpl(this.registryEndpoint, this.name, tagOrDigest, this.client);
}
/**
* Retrieves properties of this repository.
* @param options -
*/
public async getProperties(
options: GetRepositoryPropertiesOptions = {}
): Promise<ContainerRepositoryProperties> {
const { span, updatedOptions } = createSpan("ContainerRepository-getProperties", options);
try {
return await this.client.containerRegistry.getProperties(this.name, updatedOptions);
} catch (e) {
span.setStatus({ code: SpanStatusCode.ERROR, message: e.message });
throw e;
} finally {
span.end();
}
}
/**
* Updates repository attributes.
* @param options -
*/
public async updateProperties(
options: UpdateRepositoryPropertiesOptions
): Promise<ContainerRepositoryProperties> {
const value: RepositoryWriteableProperties = {
canDelete: options.canDelete,
canWrite: options.canWrite,
canList: options.canList,
canRead: options.canRead,
teleportEnabled: options.teleportEnabled
};
const { span, updatedOptions } = createSpan("ContainerRepository-updateProperties", {
...options,
value
});
try {
return await this.client.containerRegistry.updateProperties(this.name, updatedOptions);
} catch (e) {
span.setStatus({ code: SpanStatusCode.ERROR, message: e.message });
throw e;
} finally {
span.end();
}
}
/**
* Iterates manifests.
*
* Example usage:
* ```ts
* const client = new ContainerRegistryClient(url, credentials);
* const repository = client.getRepository(repositoryName)
* for await (const manifest of repository.listManifestProperties()) {
* console.log("manifest: ", manifest);
* }
* ```
* @param options -
*/
public listManifestProperties(
options: ListManifestPropertiesOptions = {}
): PagedAsyncIterableIterator<ArtifactManifestProperties, ManifestPageResponse> {
const iter = this.listManifestsItems(options);
return {
next() {
return iter.next();
},
[Symbol.asyncIterator]() {
return this;
},
byPage: (settings: PageSettings = {}) => this.listManifestsPage(settings, options)
};
}
private async *listManifestsItems(
options: ListManifestPropertiesOptions = {}
): AsyncIterableIterator<ArtifactManifestProperties> {
for await (const page of this.listManifestsPage({}, options)) {
yield* page;
}
}
private async *listManifestsPage(
continuationState: PageSettings,
options: ListManifestPropertiesOptions = {}
): AsyncIterableIterator<ManifestPageResponse> {
const orderby = toServiceManifestOrderBy(options.orderBy);
if (!continuationState.continuationToken) {
const optionsComplete = {
...options,
n: continuationState.maxPageSize,
orderby
};
const currentPage = await this.client.containerRegistry.getManifests(
this.name,
optionsComplete
);
continuationState.continuationToken = extractNextLink(currentPage.link);
if (currentPage.manifests) {
const array = currentPage.manifests.map((t) =>
toArtifactManifestProperties(t, this.name, currentPage.registryLoginServer!)
);
yield Object.defineProperty(array, "continuationToken", {
value: continuationState.continuationToken,
enumerable: true
});
}
}
while (continuationState.continuationToken) {
const currentPage = await this.client.containerRegistry.getManifestsNext(
this.name,
continuationState.continuationToken,
options
);
continuationState.continuationToken = extractNextLink(currentPage.link);
if (currentPage.manifests) {
const array = currentPage.manifests.map((t) =>
toArtifactManifestProperties(t, this.name, currentPage.registryLoginServer!)
);
yield Object.defineProperty(array, "continuationToken", {
value: continuationState.continuationToken,
enumerable: true
});
}
}
}
}