@atomist/sdm/src/lib/core/util/webhook/ImageLink.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2020 Atomist, Inc.
 *
 * 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 { configurationValue } from "@atomist/automation-client/lib/configuration";
import {
    defaultHttpClientFactory,
    HttpMethod,
} from "@atomist/automation-client/lib/spi/http/httpClient";
import { logger } from "@atomist/automation-client/lib/util/logger";
import { RetryOptions } from "@atomist/automation-client/lib/util/retry";

export interface AtomistBuildRepository {
    owner_name: string;
    name: string;
}

export type AtomistBuildType = "cron" | "pull_request" | "push" | "tag" | "manual";

export type AtomistBuildStatus = "started" | "failed" | "error" | "passed" | "canceled";

export interface AtomistBuild {
    repository: AtomistBuildRepository;
    number?: number;
    name?: string;
    compare_url?: string;
    type: AtomistBuildType;
    pull_request_number?: number;
    build_url?: string;
    status: AtomistBuildStatus;
    id?: string;
    commit: string;
    tag?: string;
    branch?: string;
    provider?: string;
}

export type AtomistWebhookType = "application" | "build" | "link-image";

const DefaultRetryOptions = {
    retries: 10,
    factor: 2,
    minTimeout: 1 * 500,
    maxTimeout: 5 * 1000,
    randomize: true,
};

/**
 * Post to the Atomist generic build webhook URL.  It creates the payload
 * then uses postWebhook.
 *
 * @param owner repository owner, i.e., user or organization
 * @param repo name of repository
 * @param branch commit branch
 * @param commit commit SHA
 * @param status "start", "success", or "fail"
 * @param teamId Atomist team ID
 * @param retryOptions change default retry options
 * @return true if successful, false on failure after retries
 */
export function postBuildWebhook(
    owner: string,
    repo: string,
    branch: string,
    commit: string,
    status: AtomistBuildStatus,
    teamId: string,
    retryOptions: RetryOptions = DefaultRetryOptions,
): Promise<boolean> {

    const payload: AtomistBuild = {
        repository: { owner_name: owner, name: repo },
        type: "push",
        status,
        commit,
        branch,
        provider: "GoogleContainerBuilder",
    };
    return postWebhook("build", payload, teamId, retryOptions);
}

export interface AtomistLinkImageGit {
    owner: string;
    repo: string;
    sha: string;
}

export interface AtomistLinkImageDocker {
    image: string;
}

export interface AtomistLinkImage {
    git: AtomistLinkImageGit;
    docker: AtomistLinkImageDocker;
    type: "link-image";
}

/**
 * Post payload to the Atomist webhook URL.  It will retry
 * several times.
 *
 * @param webhook type of webhook
 * @param payload object to post
 * @param teamId Atomist team ID
 * @param retryOptions change default retry options
 * @return true if successful, false on failure after retries
 */
export async function postWebhook(
    webhook: AtomistWebhookType,
    payload: any,
    teamId: string,
    retryOptions: RetryOptions = DefaultRetryOptions,
): Promise<boolean> {
    logger.debug("Posting webhook: %j", payload);

    const baseUrl = process.env.ATOMIST_WEBHOOK_BASEURL || "https://webhook.atomist.com";
    const url = `${baseUrl}/atomist/${webhook}/teams/${teamId}`;

    const httpClient = configurationValue("http.client.factory", defaultHttpClientFactory()).create(url);

    try {
        await httpClient.exchange(
            url,
            {
                method: HttpMethod.Post,
                body: payload,
                options: {
                    retry: retryOptions,
                },
            });
        return true;
    } catch (e) {
        return false;
    }
}