/** * Copyright 2023 actions-toolkit authors * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import * as core from '@actions/core'; import * as httpm from '@actions/http-client'; import {HttpCodes} from '@actions/http-client'; import {RepositoryRequest, RepositoryResponse, RepositoryTagsRequest, RepositoryTagsResponse, TokenRequest, TokenResponse, UpdateRepoDescriptionRequest} from './types/dockerhub'; export interface DockerHubOpts { credentials: TokenRequest; } const apiBaseURL = 'https://hub.docker.com'; const loginURL = `${apiBaseURL}/v2/users/login?refresh_token=true`; const repositoriesURL = `${apiBaseURL}/v2/repositories/`; export class DockerHub { private readonly opts: DockerHubOpts; private readonly httpc: httpm.HttpClient; private constructor(opts: DockerHubOpts, httpc: httpm.HttpClient) { this.opts = opts; this.httpc = httpc; } public static async build(opts: DockerHubOpts): Promise { return new DockerHub( opts, new httpm.HttpClient('docker-actions-toolkit', [], { headers: { Authorization: `JWT ${await DockerHub.login(opts.credentials)}`, 'Content-Type': 'application/json' } }) ); } public async getRepositoryTags(req: RepositoryTagsRequest): Promise { const url = new URL(`${repositoriesURL}${req.namespace}/${req.name}/tags`); if (req.page) { url.searchParams.append('page', req.page.toString()); } if (req.page_size) { url.searchParams.append('page_size', req.page_size.toString()); } const resp: httpm.HttpClientResponse = await this.httpc.get(url.toString()); return JSON.parse(await DockerHub.handleResponse(resp)); } public async getRepositoryAllTags(req: RepositoryTagsRequest): Promise { const tags: RepositoryTagsResponse = await this.getRepositoryTags(req); while (tags.next) { const nextURL = new URL(tags.next); const pageNumber = Number(nextURL.searchParams.get('page')); const pageSize = Number(nextURL.searchParams.get('page_size')) || undefined; const nextTags = await this.getRepositoryTags({ namespace: req.namespace, name: req.name, page: pageNumber, page_size: pageSize || req.page_size } as RepositoryTagsRequest); tags.results.push(...nextTags.results); tags.next = nextTags.next; } return tags; } public async getRepository(req: RepositoryRequest): Promise { const resp: httpm.HttpClientResponse = await this.httpc.get(`${repositoriesURL}${req.namespace}/${req.name}`); return JSON.parse(await DockerHub.handleResponse(resp)); } public async updateRepoDescription(req: UpdateRepoDescriptionRequest): Promise { const body = { full_description: req.full_description }; if (req.description) { body['description'] = req.description; } const resp: httpm.HttpClientResponse = await this.httpc.patch(`${repositoriesURL}${req.namespace}/${req.name}`, JSON.stringify(body)); return JSON.parse(await DockerHub.handleResponse(resp)); } private static async login(req: TokenRequest): Promise { const http: httpm.HttpClient = new httpm.HttpClient('docker-actions-toolkit', [], { headers: { 'Content-Type': 'application/json' } }); const resp: httpm.HttpClientResponse = await http.post(loginURL, JSON.stringify(req)); const tokenResp = JSON.parse(await DockerHub.handleResponse(resp)); core.setSecret(`${tokenResp.token}`); return `${tokenResp.token}`; } private static async handleResponse(resp: httpm.HttpClientResponse): Promise { const body = await resp.readBody(); resp.message.statusCode = resp.message.statusCode || HttpCodes.InternalServerError; if (resp.message.statusCode < 200 || resp.message.statusCode >= 300) { if (resp.message.statusCode == HttpCodes.Unauthorized) { throw new Error(`Docker Hub API: operation not permitted`); } const errResp = >JSON.parse(body); for (const k of ['message', 'detail', 'error']) { if (errResp[k]) { throw new Error(`Docker Hub API: bad status code ${resp.message.statusCode}: ${errResp[k]}`); } } throw new Error(`Docker Hub API: bad status code ${resp.message.statusCode}`); } return body; } }