Remove errors of 'vo' package (#192)

* Remove errors of vo

* Fix the schema of error

Author: Noah Hanjun Lee

internal/pkg/github/repos.go

@@ -8,6 +8,7 @@ import (
 	graphql "github.com/shurcooL/githubv4"
 
 	"github.com/gitploy-io/gitploy/ent"
+	"github.com/gitploy-io/gitploy/pkg/e"
 	"github.com/gitploy-io/gitploy/vo"
 )
 
@@ -72,12 +73,15 @@ func (g *Github) GetCommit(ctx context.Context, u *ent.User, r *ent.Repo, sha st
 		GetCommit(ctx, r.Namespace, r.Name, sha)
 	// Github returns Unprocessable entity if the commit is not found.
 	if res.StatusCode == http.StatusNotFound || res.StatusCode == http.StatusUnprocessableEntity {
-		return nil, &vo.RefNotFoundError{
-			Ref: sha,
-		}
-	}
-	if err != nil {
-		return nil, err
+		return nil, e.NewError(
+			e.ErrorCodeRefNotFound,
+			err,
+		)
+	} else if err != nil {
+		return nil, e.NewError(
+			e.ErrorCodeInternalError,
+			err,
+		)
 	}
 
 	return mapGithubCommitToCommit(cm), nil
@@ -93,7 +97,10 @@ func (g *Github) ListCommitStatuses(ctx context.Context, u *ent.User, r *ent.Rep
 		PerPage: 100,
 	})
 	if err != nil {
-		return nil, err
+		return nil, e.NewError(
+			e.ErrorCodeInternalError,
+			err,
+		)
 	}
 
 	for _, rs := range cs.Statuses {
@@ -108,12 +115,15 @@ func (g *Github) ListCommitStatuses(ctx context.Context, u *ent.User, r *ent.Rep
 	})
 	// check-runs secures the commit is exist.
 	if res.StatusCode == http.StatusUnprocessableEntity {
-		return nil, &vo.RefNotFoundError{
-			Ref: sha,
-		}
-	}
-	if err != nil {
-		return nil, err
+		return nil, e.NewError(
+			e.ErrorCodeRefNotFound,
+			err,
+		)
+	} else if err != nil {
+		return nil, e.NewError(
+			e.ErrorCodeInternalError,
+			err,
+		)
 	}
 
 	for _, c := range result.CheckRuns {
@@ -133,7 +143,10 @@ func (g *Github) ListBranches(ctx context.Context, u *ent.User, r *ent.Repo, pag
 			},
 		})
 	if err != nil {
-		return nil, err
+		return nil, e.NewError(
+			e.ErrorCodeInternalError,
+			err,
+		)
 	}
 
 	branches := []*vo.Branch{}
@@ -149,12 +162,15 @@ func (g *Github) GetBranch(ctx context.Context, u *ent.User, r *ent.Repo, branch
 		Repositories.
 		GetBranch(ctx, r.Namespace, r.Name, branch)
 	if res.StatusCode == http.StatusNotFound {
-		return nil, &vo.RefNotFoundError{
-			Ref: branch,
-		}
-	}
-	if err != nil {
-		return nil, err
+		return nil, e.NewError(
+			e.ErrorCodeRefNotFound,
+			err,
+		)
+	} else if err != nil {
+		return nil, e.NewError(
+			e.ErrorCodeInternalError,
+			err,
+		)
 	}
 
 	return mapGithubBranchToBranch(b), nil
@@ -226,13 +242,17 @@ func (g *Github) GetTag(ctx context.Context, u *ent.User, r *ent.Repo, tag strin
 		"tag":       graphql.String(tag),
 	}
 	if err := client.Query(ctx, &q, v); err != nil {
-		return nil, err
+		return nil, e.NewError(
+			e.ErrorCodeInternalError,
+			err,
+		)
 	}
 
 	if q.Repository.Refs.TotalCount == 0 {
-		return nil, &vo.RefNotFoundError{
-			Ref: tag,
-		}
+		return nil, e.NewError(
+			e.ErrorCodeRefNotFound,
+			nil,
+		)
 	}
 
 	n := q.Repository.Refs.Nodes[0]

internal/server/api/v1/repos/branch.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/gitploy-io/gitploy/ent"
 	gb "github.com/gitploy-io/gitploy/internal/server/global"
-	"github.com/gitploy-io/gitploy/vo"
 )
 
 func (r *Repo) ListBranches(c *gin.Context) {
@@ -47,13 +46,9 @@ func (r *Repo) GetBranch(c *gin.Context) {
 	repo := rv.(*ent.Repo)
 
 	b, err := r.i.GetBranch(ctx, u, repo, branch)
-	if vo.IsRefNotFoundError(err) {
-		r.log.Warn("The branch is not found.", zap.String("repo", repo.Name), zap.String("branch", branch), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusNotFound, "The branch is not found.")
-		return
-	} else if err != nil {
-		r.log.Error("failed to get the branch.", zap.String("repo", repo.Name), zap.String("branch", branch), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the branch.")
+	if err != nil {
+		r.log.Error("It has failed to get the branch.", zap.Error(err))
+		gb.ResponseWithError(c, err)
 		return
 	}
 

internal/server/api/v1/repos/commit.go

@@ -49,13 +49,9 @@ func (r *Repo) GetCommit(c *gin.Context) {
 	repo := rv.(*ent.Repo)
 
 	commit, err := r.i.GetCommit(ctx, u, repo, sha)
-	if vo.IsRefNotFoundError(err) {
-		r.log.Warn("The commit is not found.", zap.String("repo", repo.Name), zap.String("sha", sha), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusNotFound, "The commit is not found.")
-		return
-	} else if err != nil {
-		r.log.Error("failed to get the commit.", zap.String("repo", repo.Name), zap.String("sha", sha), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the commit.")
+	if err != nil {
+		r.log.Error("It has failed to get the commit.", zap.Error(err))
+		gb.ResponseWithError(c, err)
 		return
 	}
 
@@ -76,13 +72,9 @@ func (r *Repo) ListStatuses(c *gin.Context) {
 	repo := rv.(*ent.Repo)
 
 	ss, err := r.i.ListCommitStatuses(ctx, u, repo, sha)
-	if vo.IsRefNotFoundError(err) {
-		r.log.Warn("The commit is not found.", zap.String("repo", repo.Name), zap.String("sha", sha), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusNotFound, "The commit is not found.")
-		return
-	} else if err != nil {
-		r.log.Error("failed to get the commit status.", zap.String("repo", repo.Name), zap.String("sha", sha), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the commit.")
+	if err != nil {
+		r.log.Error("It has failed to list commit statuses.", zap.Error(err))
+		gb.ResponseWithError(c, err)
 		return
 	}
 

internal/server/api/v1/repos/deployment.go

@@ -335,13 +335,9 @@ func (r *Repo) ListDeploymentChanges(c *gin.Context) {
 	sha := d.Sha
 	if sha == "" {
 		sha, err = r.getCommitSha(ctx, u, re, d.Type, d.Ref)
-		if vo.IsRefNotFoundError(err) {
-			r.log.Warn("The REF is not found.", zap.Error(err))
-			gb.Response(c, http.StatusOK, nil)
-			return
-		} else if err != nil {
-			r.log.Error("It has failed to get the SHA of deployment.", zap.Error(err))
-			gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the SHA of deployment.")
+		if err != nil {
+			r.log.Error("It has failed to get the commit SHA.", zap.Error(err))
+			gb.ResponseWithError(c, err)
 			return
 		}
 	}

internal/server/api/v1/repos/lock.go

@@ -20,7 +20,7 @@ import (
 	"github.com/gitploy-io/gitploy/ent"
 	"github.com/gitploy-io/gitploy/internal/server/global"
 	gb "github.com/gitploy-io/gitploy/internal/server/global"
-	"github.com/gitploy-io/gitploy/vo"
+	"github.com/gitploy-io/gitploy/pkg/e"
 )
 
 type (
@@ -79,15 +79,15 @@ func (r *Repo) CreateLock(c *gin.Context) {
 	vu, _ := c.Get(global.KeyUser)
 	u := vu.(*ent.User)
 
-	// Validate the payload, it check whether the env exist or not in deploy.yml.
 	cfg, err := r.i.GetConfig(ctx, u, re)
-	if vo.IsConfigNotFoundError(err) || vo.IsConfigParseError(err) {
-		r.log.Warn("The config is invalid.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusUnprocessableEntity, "The config is invalid.")
+	if e.HasErrorCode(err, e.ErrorCodeConfigNotFound) {
+		r.log.Error("The configuration file is not found.", zap.Error(err))
+		// To override the HTTP status 422.
+		gb.ResponseWithStatusAndError(c, http.StatusUnprocessableEntity, err)
 		return
 	} else if err != nil {
-		r.log.Error("It has failed to get the config file.", zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the config file.")
+		r.log.Error("It has failed to get the configuration.")
+		gb.ResponseWithError(c, err)
 		return
 	}
 

internal/server/api/v1/repos/tag.go

@@ -8,7 +8,6 @@ import (
 
 	"github.com/gitploy-io/gitploy/ent"
 	gb "github.com/gitploy-io/gitploy/internal/server/global"
-	"github.com/gitploy-io/gitploy/vo"
 )
 
 func (r *Repo) ListTags(c *gin.Context) {
@@ -47,13 +46,9 @@ func (r *Repo) GetTag(c *gin.Context) {
 	repo := rv.(*ent.Repo)
 
 	t, err := r.i.GetTag(ctx, u, repo, tag)
-	if vo.IsRefNotFoundError(err) {
-		r.log.Warn("the tag is not found.", zap.String("repo", repo.Name), zap.String("tag", tag), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusNotFound, "the tag is not found.")
-		return
-	} else if err != nil {
-		r.log.Error("failed to get the tag.", zap.String("repo", repo.Name), zap.String("tag", tag), zap.Error(err))
-		gb.ErrorResponse(c, http.StatusInternalServerError, "It has failed to get the tag.")
+	if err != nil {
+		r.log.Error("It has failed to get the tag.", zap.Error(err))
+		gb.ResponseWithError(c, err)
 		return
 	}
 

internal/server/slack/deploy.go

@@ -15,6 +15,7 @@ import (
 	"github.com/gitploy-io/gitploy/ent/callback"
 	"github.com/gitploy-io/gitploy/ent/deployment"
 	"github.com/gitploy-io/gitploy/ent/event"
+	"github.com/gitploy-io/gitploy/pkg/e"
 	"github.com/gitploy-io/gitploy/vo"
 )
 
@@ -261,7 +262,7 @@ func (s *Slack) interactDeploy(c *gin.Context) {
 
 	// Validate the entity is processible.
 	_, err := s.getCommitSha(ctx, cu.Edges.User, cb.Edges.Repo, sm.Type, sm.Ref)
-	if vo.IsRefNotFoundError(err) {
+	if e.HasErrorCode(err, e.ErrorCodeRefNotFound) {
 		c.JSON(http.StatusOK, buildErrorsPayload(map[string]string{
 			blockRef: "The reference is not found.",
 		}))

internal/server/slack/lock.go

@@ -57,14 +57,10 @@ func (s *Slack) handleLockCmd(c *gin.Context) {
 
 	// Build the modal with unlocked envs.
 	config, err := s.i.GetConfig(ctx, cu.Edges.User, r)
-	if vo.IsConfigNotFoundError(err) || vo.IsConfigParseError(err) {
-		postResponseMessage(cmd.ChannelID, cmd.ResponseURL, "The config is invalid.")
+	if err != nil {
+		postMessageWithError(cu, err)
 		c.Status(http.StatusOK)
 		return
-	} else if err != nil {
-		s.log.Error("It has failed to get the config file.", zap.Error(err))
-		c.Status(http.StatusInternalServerError)
-		return
 	}
 
 	locks, err := s.i.ListLocksOfRepo(ctx, r)

openapi/v1.yaml

@@ -1981,6 +1981,8 @@ components:
     Error:
       type: object
       properties:
+        code:
+          type: string
         message: 
           type: string
       required:

pkg/e/code.go

@@ -25,6 +25,9 @@ const (
 	// ErrorCodeLicenseDecode is that the license.
 	ErrorCodeLicenseDecode ErrorCode = "license_decode"
 
+	// ErrorCodeRefNotFound is that the ref is not found.
+	ErrorCodeRefNotFound ErrorCode = "ref_not_found"
+
 	ErrorCodeInternalError ErrorCode = "internal_error"
 )