drone/app/store/database/gitspace_event.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"

	"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/Masterminds/squirrel"
	"github.com/jmoiron/sqlx"
)

var _ store.GitspaceEventStore = (*gitspaceEventStore)(nil)

const (
	gitspaceEventIDColumn = `geven_id`
	gitspaceEventsColumns = `
		geven_event,
		geven_created,
		geven_entity_type,
		geven_query_key,
		geven_entity_id,
		geven_timestamp
	`
	gitspaceEventsColumnsWithID = gitspaceEventIDColumn + `,
		` + gitspaceEventsColumns
	gitspaceEventsTable = `gitspace_events`
)

type gitspaceEventStore struct {
	db *sqlx.DB
}

type gitspaceEvent struct {
	ID         int64                   `db:"geven_id"`
	Event      enum.GitspaceEventType  `db:"geven_event"`
	Created    int64                   `db:"geven_created"`
	EntityType enum.GitspaceEntityType `db:"geven_entity_type"`
	QueryKey   string                  `db:"geven_query_key"`
	EntityID   int64                   `db:"geven_entity_id"`
	Timestamp  int64                   `db:"geven_timestamp"`
}

func NewGitspaceEventStore(db *sqlx.DB) store.GitspaceEventStore {
	return &gitspaceEventStore{
		db: db,
	}
}

func (g gitspaceEventStore) FindLatestByTypeAndGitspaceConfigID(
	ctx context.Context,
	eventType enum.GitspaceEventType,
	gitspaceConfigID int64,
) (*types.GitspaceEvent, error) {
	stmt := database.Builder.
		Select(gitspaceEventsColumnsWithID).
		From(gitspaceEventsTable).
		Where("geven_event = $1", eventType).
		Where("geven_entity_id = $2", gitspaceConfigID).
		OrderBy("geven_timestamp DESC")
	sql, args, err := stmt.ToSql()
	if err != nil {
		return nil, fmt.Errorf("failed to convert squirrel builder to sql: %w", err)
	}
	db := dbtx.GetAccessor(ctx, g.db)
	gitspaceEventEntity := new(gitspaceEvent)
	if err = db.GetContext(ctx, gitspaceEventEntity, sql, args...); err != nil {
		return nil, database.ProcessSQLErrorf(ctx, err, "Failed to find gitspace event for %d", gitspaceConfigID)
	}
	return g.mapGitspaceEvent(gitspaceEventEntity), nil
}

func (g gitspaceEventStore) Create(ctx context.Context, gitspaceEvent *types.GitspaceEvent) error {
	stmt := database.Builder.
		Insert(gitspaceEventsTable).
		Columns(gitspaceEventsColumns).
		Values(
			gitspaceEvent.Event,
			gitspaceEvent.Created,
			gitspaceEvent.EntityType,
			gitspaceEvent.QueryKey,
			gitspaceEvent.EntityID,
			gitspaceEvent.Timestamp,
		).
		Suffix("RETURNING " + gitspaceEventIDColumn)
	db := dbtx.GetAccessor(ctx, g.db)
	sql, args, err := stmt.ToSql()
	if err != nil {
		return fmt.Errorf("failed to convert squirrel builder to sql: %w", err)
	}
	if err = db.QueryRowContext(ctx, sql, args...).Scan(&gitspaceEvent.ID); err != nil {
		return database.ProcessSQLErrorf(
			ctx, err, "failed to create gitspace event for %s", gitspaceEvent.QueryKey)
	}
	return nil
}

func (g gitspaceEventStore) List(
	ctx context.Context,
	filter *types.GitspaceEventFilter,
) ([]*types.GitspaceEvent, int, error) {
	queryStmt := database.Builder.
		Select(gitspaceEventsColumnsWithID).
		From(gitspaceEventsTable)
	queryStmt = g.setQueryFilter(queryStmt, filter)

	queryStmt = g.setSortFilter(queryStmt, filter)

	queryStmt = g.setPaginationFilter(queryStmt, filter)

	sql, args, err := queryStmt.ToSql()
	if err != nil {
		return nil, 0, fmt.Errorf("failed to convert squirrel builder to sql: %w", err)
	}

	db := dbtx.GetAccessor(ctx, g.db)

	var gitspaceEventEntities []*gitspaceEvent
	if err = db.SelectContext(ctx, &gitspaceEventEntities, sql, args...); err != nil {
		return nil, 0, database.ProcessSQLErrorf(ctx, err, "Failed to list gitspace event")
	}

	countStmt := database.Builder.
		Select("count(*)").
		From(gitspaceEventsTable)

	countStmt = g.setQueryFilter(countStmt, filter)

	sql, args, err = countStmt.ToSql()
	if err != nil {
		return nil, 0, fmt.Errorf("failed to convert squirrel builder to sql: %w", err)
	}

	var count int
	err = db.QueryRowContext(ctx, sql, args...).Scan(&count)
	if err != nil {
		return nil, 0, database.ProcessSQLErrorf(ctx, err, "Failed executing custom count query")
	}

	gitspaceEvents := g.mapGitspaceEvents(gitspaceEventEntities)

	return gitspaceEvents, count, nil
}

func (g gitspaceEventStore) setQueryFilter(
	stmt squirrel.SelectBuilder,
	filter *types.GitspaceEventFilter,
) squirrel.SelectBuilder {
	if filter.QueryKey != "" {
		stmt = stmt.Where(squirrel.Eq{"geven_query_key": filter.QueryKey})
	}
	if filter.EntityType != "" {
		stmt = stmt.Where(squirrel.Eq{"geven_entity_type": filter.EntityType})
	}
	if filter.EntityID != 0 {
		stmt = stmt.Where(squirrel.Eq{"geven_entity_id": filter.EntityID})
	}
	return stmt
}

func (g gitspaceEventStore) setSortFilter(
	stmt squirrel.SelectBuilder,
	_ *types.GitspaceEventFilter,
) squirrel.SelectBuilder {
	return stmt.OrderBy("geven_timestamp DESC")
}

func (g gitspaceEventStore) setPaginationFilter(
	stmt squirrel.SelectBuilder,
	filter *types.GitspaceEventFilter,
) squirrel.SelectBuilder {
	offset := (filter.Page - 1) * filter.Size
	stmt = stmt.Offset(uint64(offset)).Limit(uint64(filter.Size))
	return stmt
}

func (g gitspaceEventStore) mapGitspaceEvents(gitspaceEventEntities []*gitspaceEvent) []*types.GitspaceEvent {
	gitspaceEvents := make([]*types.GitspaceEvent, len(gitspaceEventEntities))
	for index, gitspaceEventEntity := range gitspaceEventEntities {
		currentEntity := gitspaceEventEntity
		gitspaceEvents[index] = g.mapGitspaceEvent(currentEntity)
	}
	return gitspaceEvents
}

func (g gitspaceEventStore) mapGitspaceEvent(event *gitspaceEvent) *types.GitspaceEvent {
	return &types.GitspaceEvent{
		Event:      event.Event,
		Created:    event.Created,
		EntityType: event.EntityType,
		QueryKey:   event.QueryKey,
		EntityID:   event.EntityID,
		Timestamp:  event.Timestamp,
	}
}