drone/app/store/database/webhook_execution.go

313 lines
11 KiB
Go

// Copyright 2023 Harness, 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.
package database
import (
"context"
"fmt"
"time"
"github.com/harness/gitness/app/store"
"github.com/harness/gitness/store/database"
"github.com/harness/gitness/store/database/dbtx"
"github.com/harness/gitness/types"
"github.com/harness/gitness/types/enum"
"github.com/guregu/null"
"github.com/jmoiron/sqlx"
)
var _ store.WebhookExecutionStore = (*WebhookExecutionStore)(nil)
// NewWebhookExecutionStore returns a new WebhookExecutionStore.
func NewWebhookExecutionStore(db *sqlx.DB) *WebhookExecutionStore {
return &WebhookExecutionStore{
db: db,
}
}
// WebhookExecutionStore implements store.WebhookExecution backed by a relational database.
type WebhookExecutionStore struct {
db *sqlx.DB
}
// webhookExecution is used to store executions of webhooks
// The object should be later re-packed into a different struct to return it as an API response.
type webhookExecution struct {
ID int64 `db:"webhook_execution_id"`
RetriggerOf null.Int `db:"webhook_execution_retrigger_of"`
Retriggerable bool `db:"webhook_execution_retriggerable"`
WebhookID int64 `db:"webhook_execution_webhook_id"`
TriggerType enum.WebhookTrigger `db:"webhook_execution_trigger_type"`
TriggerID string `db:"webhook_execution_trigger_id"`
Result enum.WebhookExecutionResult `db:"webhook_execution_result"`
Created int64 `db:"webhook_execution_created"`
Duration int64 `db:"webhook_execution_duration"`
Error string `db:"webhook_execution_error"`
RequestURL string `db:"webhook_execution_request_url"`
RequestHeaders string `db:"webhook_execution_request_headers"`
RequestBody string `db:"webhook_execution_request_body"`
ResponseStatusCode int `db:"webhook_execution_response_status_code"`
ResponseStatus string `db:"webhook_execution_response_status"`
ResponseHeaders string `db:"webhook_execution_response_headers"`
ResponseBody string `db:"webhook_execution_response_body"`
}
const (
webhookExecutionColumns = `
webhook_execution_id
,webhook_execution_retrigger_of
,webhook_execution_retriggerable
,webhook_execution_webhook_id
,webhook_execution_trigger_type
,webhook_execution_trigger_id
,webhook_execution_result
,webhook_execution_created
,webhook_execution_duration
,webhook_execution_error
,webhook_execution_request_url
,webhook_execution_request_headers
,webhook_execution_request_body
,webhook_execution_response_status_code
,webhook_execution_response_status
,webhook_execution_response_headers
,webhook_execution_response_body`
webhookExecutionSelectBase = `
SELECT` + webhookExecutionColumns + `
FROM webhook_executions`
)
// Find finds the webhook execution by id.
func (s *WebhookExecutionStore) Find(ctx context.Context, id int64) (*types.WebhookExecution, error) {
const sqlQuery = webhookExecutionSelectBase + `
WHERE webhook_execution_id = $1`
db := dbtx.GetAccessor(ctx, s.db)
dst := &webhookExecution{}
if err := db.GetContext(ctx, dst, sqlQuery, id); err != nil {
return nil, database.ProcessSQLErrorf(ctx, err, "Select query failed")
}
return mapToWebhookExecution(dst), nil
}
// Create creates a new webhook execution entry.
func (s *WebhookExecutionStore) Create(ctx context.Context, execution *types.WebhookExecution) error {
const sqlQuery = `
INSERT INTO webhook_executions (
webhook_execution_retrigger_of
,webhook_execution_retriggerable
,webhook_execution_webhook_id
,webhook_execution_trigger_type
,webhook_execution_trigger_id
,webhook_execution_result
,webhook_execution_created
,webhook_execution_duration
,webhook_execution_error
,webhook_execution_request_url
,webhook_execution_request_headers
,webhook_execution_request_body
,webhook_execution_response_status_code
,webhook_execution_response_status
,webhook_execution_response_headers
,webhook_execution_response_body
) values (
:webhook_execution_retrigger_of
,:webhook_execution_retriggerable
,:webhook_execution_webhook_id
,:webhook_execution_trigger_type
,:webhook_execution_trigger_id
,:webhook_execution_result
,:webhook_execution_created
,:webhook_execution_duration
,:webhook_execution_error
,:webhook_execution_request_url
,:webhook_execution_request_headers
,:webhook_execution_request_body
,:webhook_execution_response_status_code
,:webhook_execution_response_status
,:webhook_execution_response_headers
,:webhook_execution_response_body
) RETURNING webhook_execution_id`
db := dbtx.GetAccessor(ctx, s.db)
query, arg, err := db.BindNamed(sqlQuery, mapToInternalWebhookExecution(execution))
if err != nil {
return database.ProcessSQLErrorf(ctx, err, "Failed to bind webhook execution object")
}
if err = db.QueryRowContext(ctx, query, arg...).Scan(&execution.ID); err != nil {
return database.ProcessSQLErrorf(ctx, err, "Insert query failed")
}
return nil
}
// DeleteOld removes all executions that are older than the provided time.
func (s *WebhookExecutionStore) DeleteOld(ctx context.Context, olderThan time.Time) (int64, error) {
stmt := database.Builder.
Delete("webhook_executions").
Where("webhook_execution_created < ?", olderThan.UnixMilli())
sql, args, err := stmt.ToSql()
if err != nil {
return 0, fmt.Errorf("failed to convert delete executions query to sql: %w", err)
}
db := dbtx.GetAccessor(ctx, s.db)
result, err := db.ExecContext(ctx, sql, args...)
if err != nil {
return 0, database.ProcessSQLErrorf(ctx, err, "failed to execute delete executions query")
}
n, err := result.RowsAffected()
if err != nil {
return 0, database.ProcessSQLErrorf(ctx, err, "failed to get number of deleted executions")
}
return n, nil
}
// ListForWebhook lists the webhook executions for a given webhook id.
func (s *WebhookExecutionStore) ListForWebhook(ctx context.Context, webhookID int64,
opts *types.WebhookExecutionFilter) ([]*types.WebhookExecution, error) {
stmt := database.Builder.
Select(webhookExecutionColumns).
From("webhook_executions").
Where("webhook_execution_webhook_id = ?", webhookID)
stmt = stmt.Limit(database.Limit(opts.Size))
stmt = stmt.Offset(database.Offset(opts.Page, opts.Size))
// fixed ordering by desc id (new ones first) - add customized ordering if deemed necessary.
stmt = stmt.OrderBy("webhook_execution_id DESC")
sql, args, err := stmt.ToSql()
if err != nil {
return nil, fmt.Errorf("failed to convert query to sql: %w", err)
}
db := dbtx.GetAccessor(ctx, s.db)
dst := []*webhookExecution{}
if err = db.SelectContext(ctx, &dst, sql, args...); err != nil {
return nil, database.ProcessSQLErrorf(ctx, err, "Select query failed")
}
return mapToWebhookExecutions(dst), nil
}
// CountForWebhook counts the total number of webhook executions for a given webhook ID.
func (s *WebhookExecutionStore) CountForWebhook(
ctx context.Context,
webhookID int64,
) (int64, error) {
stmt := database.Builder.
Select("COUNT(*)").
From("webhook_executions").
Where("webhook_execution_webhook_id = ?", webhookID)
sql, args, err := stmt.ToSql()
if err != nil {
return 0, fmt.Errorf("failed to convert query to sql: %w", err)
}
db := dbtx.GetAccessor(ctx, s.db)
var count int64
if err = db.GetContext(ctx, &count, sql, args...); err != nil {
return 0, database.ProcessSQLErrorf(ctx, err, "Count query failed")
}
return count, nil
}
// ListForTrigger lists the webhook executions for a given trigger id.
func (s *WebhookExecutionStore) ListForTrigger(ctx context.Context,
triggerID string) ([]*types.WebhookExecution, error) {
const sqlQuery = webhookExecutionSelectBase + `
WHERE webhook_execution_trigger_id = $1`
db := dbtx.GetAccessor(ctx, s.db)
dst := []*webhookExecution{}
if err := db.SelectContext(ctx, &dst, sqlQuery, triggerID); err != nil {
return nil, database.ProcessSQLErrorf(ctx, err, "Select query failed")
}
return mapToWebhookExecutions(dst), nil
}
func mapToWebhookExecution(execution *webhookExecution) *types.WebhookExecution {
return &types.WebhookExecution{
ID: execution.ID,
RetriggerOf: execution.RetriggerOf.Ptr(),
Retriggerable: execution.Retriggerable,
Created: execution.Created,
WebhookID: execution.WebhookID,
TriggerType: execution.TriggerType,
TriggerID: execution.TriggerID,
Result: execution.Result,
Error: execution.Error,
Duration: execution.Duration,
Request: types.WebhookExecutionRequest{
URL: execution.RequestURL,
Headers: execution.RequestHeaders,
Body: execution.RequestBody,
},
Response: types.WebhookExecutionResponse{
StatusCode: execution.ResponseStatusCode,
Status: execution.ResponseStatus,
Headers: execution.ResponseHeaders,
Body: execution.ResponseBody,
},
}
}
func mapToInternalWebhookExecution(execution *types.WebhookExecution) *webhookExecution {
return &webhookExecution{
ID: execution.ID,
RetriggerOf: null.IntFromPtr(execution.RetriggerOf),
Retriggerable: execution.Retriggerable,
Created: execution.Created,
WebhookID: execution.WebhookID,
TriggerType: execution.TriggerType,
TriggerID: execution.TriggerID,
Result: execution.Result,
Error: execution.Error,
Duration: execution.Duration,
RequestURL: execution.Request.URL,
RequestHeaders: execution.Request.Headers,
RequestBody: execution.Request.Body,
ResponseStatusCode: execution.Response.StatusCode,
ResponseStatus: execution.Response.Status,
ResponseHeaders: execution.Response.Headers,
ResponseBody: execution.Response.Body,
}
}
func mapToWebhookExecutions(executions []*webhookExecution) []*types.WebhookExecution {
m := make([]*types.WebhookExecution, len(executions))
for i, hook := range executions {
m[i] = mapToWebhookExecution(hook)
}
return m
}