porter/api/server/handlers/handler.go

package handlers

import (
	"context"
	"fmt"
	"net/http"

	"github.com/porter-dev/porter/internal/telemetry"

	"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"
)

type PorterHandler interface {
	Config() *config.Config
	Repo() repository.Repository
	HandleAPIError(w http.ResponseWriter, r *http.Request, err apierrors.RequestError)
	HandleAPIErrorNoWrite(w http.ResponseWriter, r *http.Request, err apierrors.RequestError)
	PopulateOAuthSession(
		ctx context.Context,
		w http.ResponseWriter,
		r *http.Request,
		state string,
		isProject, isUser bool,
		integrationClient types.OAuthIntegrationClient,
		integrationID uint,
	) error
}

type PorterHandlerWriter interface {
	PorterHandler
	shared.ResultWriter
}

type PorterHandlerReader interface {
	PorterHandler
	shared.RequestDecoderValidator
}

type PorterHandlerReadWriter interface {
	PorterHandlerWriter
	PorterHandlerReader
}

type DefaultPorterHandler struct {
	config           *config.Config
	decoderValidator shared.RequestDecoderValidator
	writer           shared.ResultWriter
}

func NewDefaultPorterHandler(
	config *config.Config,
	decoderValidator shared.RequestDecoderValidator,
	writer shared.ResultWriter,
) PorterHandlerReadWriter {
	return &DefaultPorterHandler{config, decoderValidator, writer}
}

func (d *DefaultPorterHandler) Config() *config.Config {
	return d.config
}

func (d *DefaultPorterHandler) Repo() repository.Repository {
	return d.config.Repo
}

func (d *DefaultPorterHandler) HandleAPIError(w http.ResponseWriter, r *http.Request, err apierrors.RequestError) {
	apierrors.HandleAPIError(d.Config().Logger, d.Config().Alerter, w, r, err, true)
}

func (d *DefaultPorterHandler) HandleAPIErrorNoWrite(w http.ResponseWriter, r *http.Request, err apierrors.RequestError) {
	apierrors.HandleAPIError(d.Config().Logger, d.Config().Alerter, w, r, err, false)
}

func (d *DefaultPorterHandler) WriteResult(w http.ResponseWriter, r *http.Request, v interface{}) {
	d.writer.WriteResult(w, r, v)
}

func (d *DefaultPorterHandler) DecodeAndValidate(w http.ResponseWriter, r *http.Request, v interface{}) bool {
	return d.decoderValidator.DecodeAndValidate(w, r, v)
}

func (d *DefaultPorterHandler) DecodeAndValidateNoWrite(r *http.Request, v interface{}) error {
	return d.decoderValidator.DecodeAndValidateNoWrite(r, v)
}

func IgnoreAPIError(w http.ResponseWriter, r *http.Request, err apierrors.RequestError) {
	return
}

func (d *DefaultPorterHandler) PopulateOAuthSession(
	ctx context.Context,
	w http.ResponseWriter,
	r *http.Request,
	state string,
	isProject, isUser bool,
	integrationClient types.OAuthIntegrationClient,
	integrationID uint,
) error {
	ctx, span := telemetry.NewSpan(ctx, "handler-populate-oauth-session")
	defer span.End()

	session, err := d.Config().Store.Get(r, d.Config().ServerConf.CookieName)
	if err != nil {
		return telemetry.Error(ctx, span, err, "could not get session")
	}

	// need state parameter to validate when redirected
	session.Values["state"] = state

	// check if redirect uri is populated, then overwrite
	if redirect := r.URL.Query().Get("redirect_uri"); redirect != "" {
		session.Values["redirect_uri"] = redirect
	}

	if isProject {
		project, _ := r.Context().Value(types.ProjectScope).(*models.Project)
		if project == nil {
			return telemetry.Error(ctx, span, nil, "could not read project")
		}

		session.Values["project_id"] = project.ID
	}

	if isUser {
		user, _ := r.Context().Value(types.UserScope).(*models.User)
		if user == nil {
			return telemetry.Error(ctx, span, nil, "could not read user")
		}

		session.Values["user_id"] = user.ID
	}

	if integrationID != 0 && len(integrationClient) > 0 {
		session.Values["integration_id"] = integrationID
		session.Values["integration_client"] = string(integrationClient)
	}

	if err := session.Save(r, w); err != nil {
		return telemetry.Error(ctx, span, err, "could not save session")
	}

	return nil
}

type Unavailable struct {
	config    *config.Config
	handlerID string
}

func NewUnavailable(config *config.Config, handlerID string) *Unavailable {
	return &Unavailable{config, handlerID}
}

func (u *Unavailable) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	apierrors.HandleAPIError(u.config.Logger, u.config.Alerter, w, r, apierrors.NewErrPassThroughToClient(
		fmt.Errorf("%s not available in community edition", u.handlerID),
		http.StatusBadRequest,
	), true, apierrors.ErrorOpts{
		Code: types.ErrCodeUnavailable,
	})
}