porter/api/server/handlers/environment/finalize_deployment_with_errors.go

package environment

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

	"github.com/google/go-github/v41/github"
	"github.com/porter-dev/porter/api/server/handlers"
	"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/commonutils"
	"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/models/integrations"
	"gorm.io/gorm"
)

type FinalizeDeploymentWithErrorsHandler struct {
	handlers.PorterHandlerReadWriter
}

func NewFinalizeDeploymentWithErrorsHandler(
	config *config.Config,
	decoderValidator shared.RequestDecoderValidator,
	writer shared.ResultWriter,
) *FinalizeDeploymentWithErrorsHandler {
	return &FinalizeDeploymentWithErrorsHandler{
		PorterHandlerReadWriter: handlers.NewDefaultPorterHandler(config, decoderValidator, writer),
	}
}

func (c *FinalizeDeploymentWithErrorsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	ga, _ := r.Context().Value(types.GitInstallationScope).(*integrations.GithubAppInstallation)
	project, _ := r.Context().Value(types.ProjectScope).(*models.Project)
	cluster, _ := r.Context().Value(types.ClusterScope).(*models.Cluster)

	owner, name, ok := commonutils.GetOwnerAndNameParams(c, w, r)

	if !ok {
		return
	}

	request := &types.FinalizeDeploymentWithErrorsRequest{}

	if ok := c.DecodeAndValidate(w, r, request); !ok {
		return
	}

	if len(request.Errors) == 0 {
		c.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(
			fmt.Errorf("at least one error is required to report"), http.StatusPreconditionFailed,
		))
		return
	}

	// read the environment to get the environment id
	env, err := c.Repo().Environment().ReadEnvironment(project.ID, cluster.ID, uint(ga.InstallationID), owner, name)

	if err != nil {
		if errors.Is(err, gorm.ErrRecordNotFound) {
			c.HandleAPIError(w, r, apierrors.NewErrNotFound(fmt.Errorf("no environment found")))
			return
		}

		c.HandleAPIError(w, r, apierrors.NewErrInternal(err))
		return
	}

	// read the deployment
	depl, err := c.Repo().Environment().ReadDeployment(env.ID, request.Namespace)

	if err != nil {
		if errors.Is(err, gorm.ErrRecordNotFound) {
			c.HandleAPIError(w, r, apierrors.NewErrNotFound(fmt.Errorf("no deployment found for environment ID: %d, namespace: %s", env.ID, request.Namespace)))
			return
		}

		c.HandleAPIError(w, r, apierrors.NewErrInternal(err))
		return
	}

	client, err := getGithubClientFromEnvironment(c.Config(), env)

	if err != nil {
		c.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(
			fmt.Errorf("unable to get github client: %w", err), http.StatusConflict,
		))
		return
	}

	// add a check for the PR to be open before creating a comment
	prClosed, err := isGithubPRClosed(client, owner, name, int(depl.PullRequestID))

	if err != nil {
		c.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(
			fmt.Errorf("error fetching details of github PR for deployment ID: %d. Error: %w",
				depl.ID, err), http.StatusConflict,
		))
		return
	}

	if prClosed {
		c.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(fmt.Errorf("Github PR has been closed"),
			http.StatusConflict))
		return
	}

	depl.Status = types.DeploymentStatusFailed

	// we do not care of the error in this case because the list deployments endpoint
	// talks to the github API to fetch the deployment status correctly
	c.Repo().Environment().UpdateDeployment(depl)

	// FIXME: ignore the status of this API call for now
	client.Repositories.CreateDeploymentStatus(
		context.Background(), owner, name, depl.GHDeploymentID, &github.DeploymentStatusRequest{
			State:       github.String("failure"),
			Description: github.String("one or more resources failed to build"),
		},
	)

	workflowRun, err := commonutils.GetLatestWorkflowRun(client, depl.RepoOwner, depl.RepoName,
		fmt.Sprintf("porter_%s_env.yml", env.Name), depl.PRBranchFrom)

	if err != nil {
		c.HandleAPIError(w, r, apierrors.NewErrInternal(err))
		return
	}

	commentBody := fmt.Sprintf(
		"## Porter Preview Environments\n"+
			"❌ Errors encountered while deploying the changes\n"+
			"||Deployment Information|\n"+
			"|-|-|\n"+
			"| Latest SHA | [`%s`](https://github.com/%s/%s/commit/%s) |\n"+
			"| Build Logs | %s |\n",
		depl.CommitSHA, depl.RepoOwner, depl.RepoName, depl.CommitSHA, workflowRun.GetHTMLURL(),
	)

	if len(request.SuccessfulResources) > 0 {
		commentBody += "#### Successfully deployed resources\n"

		for _, res := range request.SuccessfulResources {
			if res.ReleaseType == "job" {
				commentBody += fmt.Sprintf("- [`%s`](%s/jobs/%s/%s/%s?project_id=%d)\n",
					res.ReleaseName, c.Config().ServerConf.ServerURL, cluster.Name, depl.Namespace,
					res.ReleaseName, project.ID)
			} else {
				commentBody += fmt.Sprintf("- [`%s`](%s/applications/%s/%s/%s?project_id=%d)\n",
					res.ReleaseName, c.Config().ServerConf.ServerURL, cluster.Name, depl.Namespace,
					res.ReleaseName, project.ID)
			}
		}
	}

	commentBody += "#### Failed resources\n"

	for res, err := range request.Errors {
		commentBody += fmt.Sprintf("<details>\n  <summary><code>%s</code></summary>\n\n  **Error:** %s\n</details>\n", res, err)
	}

	_, _, err = client.Issues.CreateComment(
		context.Background(),
		env.GitRepoOwner,
		env.GitRepoName,
		int(depl.PullRequestID),
		&github.IssueComment{
			Body: github.String(commentBody),
		},
	)

	if err != nil {
		c.HandleAPIError(w, r, apierrors.NewErrPassThroughToClient(
			fmt.Errorf("error creating github comment: %w", err), http.StatusConflict,
		))
		return
	}

	c.WriteResult(w, r, depl.ToDeploymentType())
}