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

	"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.PrincipalInfoView = (*PrincipalInfoView)(nil)

// NewPrincipalInfoView returns a new PrincipalInfoView.
// It's used by the principal info cache.
func NewPrincipalInfoView(db *sqlx.DB) *PrincipalInfoView {
	return &PrincipalInfoView{
		db: db,
	}
}

type PrincipalInfoView struct {
	db *sqlx.DB
}

const (
	principalInfoCommonColumns = `
		 principal_id
		,principal_uid
		,principal_email
		,principal_display_name
		,principal_type
		,principal_created
		,principal_updated`
)

type principalInfo struct {
	ID          int64              `db:"principal_id"`
	UID         string             `db:"principal_uid"`
	DisplayName string             `db:"principal_display_name"`
	Email       string             `db:"principal_email"`
	Type        enum.PrincipalType `db:"principal_type"`
	Created     int64              `db:"principal_created"`
	Updated     int64              `db:"principal_updated"`
}

// Find returns a single principal info object by id from the `principals` database table.
func (s *PrincipalInfoView) Find(ctx context.Context, id int64) (*types.PrincipalInfo, error) {
	const sqlQuery = `
		SELECT ` + principalInfoCommonColumns + `
		FROM principals
		WHERE principal_id = $1`

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

	v := db.QueryRowContext(ctx, sqlQuery, id)
	if err := v.Err(); err != nil {
		return nil, database.ProcessSQLErrorf(ctx, err, "failed to find principal info")
	}

	info := &types.PrincipalInfo{}

	if err := v.Scan(&info.ID, &info.UID, &info.Email, &info.DisplayName,
		&info.Type, &info.Created, &info.Updated); err != nil {
		return nil, database.ProcessSQLErrorf(ctx, err, "failed to scan principal info")
	}

	return info, nil
}

// FindMany returns a several principal info objects by id from the `principals` database table.
func (s *PrincipalInfoView) FindMany(ctx context.Context, ids []int64) ([]*types.PrincipalInfo, error) {
	db := dbtx.GetAccessor(ctx, s.db)

	stmt := database.Builder.
		Select(principalInfoCommonColumns).
		From("principals").
		Where(squirrel.Eq{"principal_id": ids})

	sqlQuery, params, err := stmt.ToSql()
	if err != nil {
		return nil, database.ProcessSQLErrorf(ctx, err, "failed to generate find many principal info SQL query")
	}

	rows, err := db.QueryContext(ctx, sqlQuery, params...)
	if err != nil {
		return nil, database.ProcessSQLErrorf(ctx, err, "failed to query find many principal info")
	}
	defer func() {
		_ = rows.Close()
	}()

	result := make([]*types.PrincipalInfo, 0, len(ids))

	for rows.Next() {
		info := &types.PrincipalInfo{}
		err = rows.Scan(&info.ID, &info.UID, &info.Email, &info.DisplayName,
			&info.Type, &info.Created, &info.Updated)
		if err != nil {
			return nil, database.ProcessSQLErrorf(ctx, err, "failed to scan principal info")
		}

		result = append(result, info)
	}

	err = rows.Err()
	if err != nil {
		return nil, database.ProcessSQLErrorf(ctx, err, "failed to read principal info data")
	}

	return result, nil
}

func mapToPrincipalInfo(p *principalInfo) types.PrincipalInfo {
	return types.PrincipalInfo{
		ID:          p.ID,
		UID:         p.UID,
		DisplayName: p.DisplayName,
		Email:       p.Email,
		Type:        p.Type,
		Created:     p.Created,
		Updated:     p.Updated,
	}
}