net.nemerosa.ontrack.kdsl.spec.extension.notifications.webhooks.WebhooksMgt.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontrack-kdsl Show documentation
Ontrack module: ontrack-kdsl
There is a newer version: 4.4.5
package net.nemerosa.ontrack.kdsl.spec.extension.notifications.webhooks

import com.apollographql.apollo.api.Input
import net.nemerosa.ontrack.json.asJson
import net.nemerosa.ontrack.kdsl.connector.Connected
import net.nemerosa.ontrack.kdsl.connector.Connector
import net.nemerosa.ontrack.kdsl.connector.graphql.convert
import net.nemerosa.ontrack.kdsl.connector.graphql.paginate
import net.nemerosa.ontrack.kdsl.connector.graphql.schema.CreateWebhookMutation
import net.nemerosa.ontrack.kdsl.connector.graphql.schema.FindWebhookByNameQuery
import net.nemerosa.ontrack.kdsl.connector.graphql.schema.WebhookDeliveriesQuery
import net.nemerosa.ontrack.kdsl.connector.graphqlConnector
import net.nemerosa.ontrack.kdsl.connector.support.PaginatedList
import net.nemerosa.ontrack.kdsl.connector.support.emptyPaginatedList
import java.time.Duration

/**
 * Interface for the management of webhooks in Ontrack.
 */
class WebhooksMgt(connector: Connector) : Connected(connector) {

    /**
     * Registers a webhook.
     *
     * @param name Unique name for the webhook
     * @param enabled If the webhook is enabled
     * @param url Endpoint URL for the webhook
     * @param timeout Timeout for the webhook execution
     * @param authenticationType Authentication type
     * @param authenticationConfig Authentication configuration
     */
    fun createWebhook(
        name: String,
        enabled: Boolean,
        url: String,
        timeout: Duration,
        authenticationType: String,
        authenticationConfig: Any,
    ) {
        graphqlConnector.mutate(
            CreateWebhookMutation(
                name,
                enabled,
                url,
                timeout.toSeconds(),
                authenticationType,
                authenticationConfig.asJson(),
            )
        ) {
            it?.createWebhook()?.fragments()?.payloadUserErrors()?.convert()
        }
    }

    /**
     * Pings an existing webhook
     */
    fun ping(name: String) {
        connector.post("/extension/notifications/webhook/$name/ping")
    }

    /**
     * Gets the deliveries for the webhooks.
     *
     * @param offset Offset in the list
     * @param size Size of a page
     * @param webhook Filter on the name of the webhook
     */
    fun getDeliveries(
        offset: Int = 0,
        size: Int = 10,
        webhook: String,
    ): PaginatedList =
        graphqlConnector.query(
            WebhookDeliveriesQuery(
                Input.fromNullable(offset),
                Input.fromNullable(size),
                webhook
            )
        )?.paginate(
            pageInfo = { it.webhooks().firstOrNull()?.exchanges()?.pageInfo()?.fragments()?.pageInfoContent() },
            pageItems = { it.webhooks().firstOrNull()?.exchanges()?.pageItems() }
        )?.map {
            WebhookDelivery(
                uuid = it.uuid(),
                webhook = it.webhook(),
                request = WebhookRequest(
                    timestamp = it.request().timestamp(),
                    type = it.request().type(),
                    payload = it.request().payload(),
                ),
                response = it.response()?.run {
                    WebhookResponse(
                        timestamp = timestamp(),
                        code = code(),
                        payload = payload(),
                    )
                },
                stack = it.stack(),
            )
        } ?: emptyPaginatedList()

    /**
     * Internal endpoint
     */
    val internalEndpoint: InternalEndpointMgt by lazy {
        InternalEndpointMgt(connector)
    }

    /**
     * Gets a webhook by name
     */
    fun findWebhookByName(name: String): Webhook? =
        graphqlConnector.query(
            FindWebhookByNameQuery(name)
        )?.webhooks()?.firstOrNull()?.fragments()?.webhookFragment()?.run {
            Webhook(
                name = name(),
                enabled = enabled(),
                url = url(),
                timeoutSeconds = timeoutSeconds(),
                authenticationType = authenticationType(),
            )
        }

}