porter/api/server/handlers/datastore/list.go

package datastore

import (
	"context"
	"net/http"
	"time"

	"connectrpc.com/connect"
	porterv1 "github.com/porter-dev/api-contracts/generated/go/porter/v1"
	"github.com/porter-dev/api-contracts/generated/go/porter/v1/porterv1connect"
	"github.com/porter-dev/porter/api/server/authz"
	"github.com/porter-dev/porter/api/server/handlers"
	"github.com/porter-dev/porter/api/server/handlers/cloud_provider"
	"github.com/porter-dev/porter/api/server/shared"
	"github.com/porter-dev/porter/api/server/shared/apierrors"
	"github.com/porter-dev/porter/api/server/shared/config"
	"github.com/porter-dev/porter/api/types"
	"github.com/porter-dev/porter/internal/models"
	"github.com/porter-dev/porter/internal/repository"
	"github.com/porter-dev/porter/internal/telemetry"
)

// ListDatastoresRequest is a struct that represents the various filter options used for
// retrieving the datastores
type ListDatastoresRequest struct {
	// Name is the name of the datastore to filter by
	Name string `schema:"name"`

	// Type is the type of the datastore to filter by
	Type string `schema:"type"`

	// IncludeEnvGroup controls whether to include the datastore env group or not
	IncludeEnvGroup bool `schema:"include_env_group"`

	// IncludeMetadata controls whether to include datastore metadata or not
	IncludeMetadata bool `schema:"include_metadata"`
}

// ListDatastoresResponse describes the list datastores response body
type ListDatastoresResponse struct {
	// Datastores is a list of datastore entries for the http response
	Datastores []Datastore `json:"datastores"`
}

// Datastore describes an outbound datastores response entry
type Datastore struct {
	// Name is the name of the datastore
	Name string `json:"name"`

	// Type is the type of the datastore
	Type string `json:"type"`

	// Engine is the engine of the datastore
	Engine string `json:"engine,omitempty"`

	// Env is the env group for the datastore
	Env *porterv1.EnvGroup `json:"env,omitempty"`

	// Metadata is a list of metadata objects for the datastore
	Metadata []*porterv1.DatastoreMetadata `json:"metadata,omitempty"`

	// Status is the status of the datastore
	Status string `json:"status"`

	// CreatedAtUTC is the time the datastore was created in UTC
	CreatedAtUTC time.Time `json:"created_at"`

	// CloudProvider is the cloud provider associated with the datastore
	CloudProvider string `json:"cloud_provider"`

	// CloudProviderCredentialIdentifier is the cloud provider credential identifier associated with the datastore
	CloudProviderCredentialIdentifier string `json:"cloud_provider_credential_identifier"`
}

// ListDatastoresHandler is a struct for listing all datastores for a given project
type ListDatastoresHandler struct {
	handlers.PorterHandlerReadWriter
	authz.KubernetesAgentGetter
}

// NewListDatastoresHandler constructs a datastore ListDatastoresHandler
func NewListDatastoresHandler(
	config *config.Config,
	decoderValidator shared.RequestDecoderValidator,
	writer shared.ResultWriter,
) *ListDatastoresHandler {
	return &ListDatastoresHandler{
		PorterHandlerReadWriter: handlers.NewDefaultPorterHandler(config, decoderValidator, writer),
		KubernetesAgentGetter:   authz.NewOutOfClusterAgentGetter(config),
	}
}

// ServeHTTP returns a list of datastores associated with the specified project
func (h *ListDatastoresHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	ctx, span := telemetry.NewSpan(r.Context(), "serve-list-datastores")
	defer span.End()

	project, _ := ctx.Value(types.ProjectScope).(*models.Project)

	resp := ListDatastoresResponse{}
	datastoreList := []Datastore{}

	datastores, err := h.Repo().Datastore().ListByProjectID(ctx, project.ID)
	if err != nil {
		err := telemetry.Error(ctx, span, err, "error getting datastores")
		h.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(err, http.StatusInternalServerError))
		return
	}

	for _, datastore := range datastores {
		datastoreList = append(datastoreList, Datastore{
			Name:         datastore.Name,
			Type:         datastore.Type,
			Engine:       datastore.Engine,
			CreatedAtUTC: datastore.CreatedAt,
			Status:       string(datastore.Status),
		})
	}

	resp.Datastores = datastoreList

	h.WriteResult(w, r, resp)
}

// DatastoresInput is the input to the Datastores function
type DatastoresInput struct {
	ProjectID       uint
	CloudProvider   cloud_provider.CloudProvider
	Name            string
	Type            porterv1.EnumDatastore
	IncludeEnvGroup bool
	IncludeMetadata bool

	CCPClient           porterv1connect.ClusterControlPlaneServiceClient
	DatastoreRepository repository.DatastoreRepository
}

// Datastores returns a list of datastores associated with the specified project/cloud-provider
func Datastores(ctx context.Context, inp DatastoresInput) ([]Datastore, error) {
	ctx, span := telemetry.NewSpan(ctx, "datastores-for-cloud-provider")
	defer span.End()

	telemetry.WithAttributes(span,
		telemetry.AttributeKV{Key: "datastore-name", Value: inp.Name},
		telemetry.AttributeKV{Key: "datastore-type", Value: int(inp.Type)},
		telemetry.AttributeKV{Key: "include-env-group", Value: inp.IncludeEnvGroup},
		telemetry.AttributeKV{Key: "include-metadata", Value: inp.IncludeMetadata},
		telemetry.AttributeKV{Key: "cloud-provider-type", Value: int(inp.CloudProvider.Type)},
		telemetry.AttributeKV{Key: "cloud-provider-id", Value: inp.CloudProvider.AccountID},
		telemetry.AttributeKV{Key: "project-id", Value: inp.ProjectID},
	)

	datastores := []Datastore{}

	if inp.ProjectID == 0 {
		return datastores, telemetry.Error(ctx, span, nil, "project id must be specified")
	}
	if inp.CloudProvider.Type == porterv1.EnumCloudProvider_ENUM_CLOUD_PROVIDER_UNSPECIFIED {
		return datastores, telemetry.Error(ctx, span, nil, "cloud provider type must be specified")
	}
	if inp.CloudProvider.AccountID == "" {
		return datastores, telemetry.Error(ctx, span, nil, "cloud provider account id must be specified")
	}

	message := porterv1.ListDatastoresRequest{
		ProjectId:              int64(inp.ProjectID),
		CloudProvider:          inp.CloudProvider.Type,
		CloudProviderAccountId: inp.CloudProvider.AccountID,
		Name:                   inp.Name,
		IncludeEnvGroup:        inp.IncludeEnvGroup,
		IncludeMetadata:        inp.IncludeMetadata,
	}
	if inp.Type != porterv1.EnumDatastore_ENUM_DATASTORE_UNSPECIFIED {
		message.Type = &inp.Type
	}
	req := connect.NewRequest(&message)
	resp, ccpErr := inp.CCPClient.ListDatastores(ctx, req)
	if ccpErr != nil {
		return datastores, telemetry.Error(ctx, span, ccpErr, "error listing datastores from ccp")
	}
	if resp.Msg == nil {
		return datastores, telemetry.Error(ctx, span, nil, "missing response message from ccp")
	}

	for _, datastore := range resp.Msg.Datastores {
		datastoreRecord, err := inp.DatastoreRepository.GetByProjectIDAndName(ctx, inp.ProjectID, datastore.Name)
		if err != nil {
			telemetry.WithAttributes(span, telemetry.AttributeKV{Key: "err-datastore-name", Value: datastore.Name})
			return datastores, telemetry.Error(ctx, span, err, "datastore record not found")
		}

		datastores = append(datastores, Datastore{
			Name:                              datastore.Name,
			Type:                              datastoreRecord.Type,
			Engine:                            datastoreRecord.Engine,
			CreatedAtUTC:                      datastoreRecord.CreatedAt,
			Status:                            string(datastoreRecord.Status),
			Metadata:                          datastore.Metadata,
			Env:                               datastore.Env,
			CloudProvider:                     datastoreRecord.CloudProvider,
			CloudProviderCredentialIdentifier: datastoreRecord.CloudProviderCredentialIdentifier,
		})
	}

	return datastores, nil
}