Move CreateEvent into CreateDeploymentStatus

Author: noah

internal/interactor/deployment.go

@@ -121,14 +121,14 @@ func (i *DeploymentInteractor) Deploy(ctx context.Context, u *ent.User, r *ent.R
 			i.log.Error("Failed to request a review.", zap.Errors("errs", errs))
 		}
 
-		i.log.Debug("Dispatch a event.")
-		if _, err := i.store.CreateEvent(ctx, &ent.Event{
-			Kind:         event.KindDeployment,
-			Type:         event.TypeCreated,
+		if _, err := i.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
+			Status:       string(deployment.StatusWaiting),
+			Description:  "Gitploy waits the reviews.",
 			DeploymentID: d.ID,
 		}); err != nil {
-			i.log.Error("Failed to create the event.", zap.Error(err))
+			i.log.Error("Failed to create a deployment status.", zap.Error(err))
 		}
+
 		return d, nil
 	}
 
@@ -149,20 +149,14 @@ func (i *DeploymentInteractor) Deploy(ctx context.Context, u *ent.User, r *ent.R
 		return nil, fmt.Errorf("It failed to save a new deployment.: %w", err)
 	}
 
-	i.store.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
+	if _, err := i.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
 		Status:       string(deployment.StatusCreated),
 		Description:  "Gitploy starts to deploy.",
 		DeploymentID: d.ID,
-	})
-
-	i.log.Debug("Dispatch a event.")
-	if _, err := i.store.CreateEvent(ctx, &ent.Event{
-		Kind:         event.KindDeployment,
-		Type:         event.TypeCreated,
-		DeploymentID: d.ID,
 	}); err != nil {
-		i.log.Error("Failed to create the event.", zap.Error(err))
+		i.log.Error("Failed to create a deployment status.", zap.Error(err))
 	}
+
 	return d, nil
 }
 
@@ -237,9 +231,9 @@ func (i *DeploymentInteractor) DeployToRemote(ctx context.Context, u *ent.User,
 		return nil, err
 	}
 
-	i.store.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
+	i.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
 		Status:       string(deployment.StatusCreated),
-		Description:  "Gitploy creates a new deployment.",
+		Description:  "Gitploy start to deploy.",
 		DeploymentID: d.ID,
 	})
 
@@ -258,6 +252,24 @@ func (i *DeploymentInteractor) createRemoteDeployment(ctx context.Context, u *en
 	return i.scm.CreateRemoteDeployment(ctx, u, r, d, env)
 }
 
+// CreateDeploymentStatus create a DeploymentStatus and dispatch the event.
+func (i *DeploymentInteractor) CreateDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error) {
+	ds, err := i.store.CreateEntDeploymentStatus(ctx, ds)
+	if err != nil {
+		return nil, err
+	}
+
+	if _, err := i.store.CreateEvent(ctx, &ent.Event{
+		Kind:               event.KindDeploymentStatus,
+		Type:               event.TypeCreated,
+		DeploymentStatusID: ds.ID,
+	}); err != nil {
+		i.log.Error("Failed to dispatch the event.", zap.Error(err))
+	}
+
+	return ds, nil
+}
+
 func (i *DeploymentInteractor) runClosingInactiveDeployment(stop <-chan struct{}) {
 	ctx := context.Background()
 
@@ -295,7 +307,7 @@ L:
 							continue
 						}
 
-						if _, err := i.store.CreateDeploymentStatus(ctx, s); err != nil {
+						if _, err := i.CreateDeploymentStatus(ctx, s); err != nil {
 							i.log.Error("It has failed to create a new deployment status.", zap.Error(err))
 							continue
 						}

internal/interactor/deployment_test.go

@@ -57,7 +57,7 @@ func TestInteractor_Deploy(t *testing.T) {
 
 		store.
 			EXPECT().
-			CreateDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
+			CreateEntDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
 
 		it := i.NewInteractor(&i.InteractorConfig{
 			Store: store,
@@ -160,7 +160,7 @@ func TestInteractor_DeployToRemote(t *testing.T) {
 
 		store.
 			EXPECT().
-			CreateDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
+			CreateEntDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
 
 		it := i.NewInteractor(&i.InteractorConfig{
 			Store: store,

internal/interactor/interface.go

@@ -43,8 +43,9 @@ type (
 	// PermStore defines operations for working with deployment_statuses.
 	DeploymentStatusStore interface {
 		ListDeploymentStatuses(ctx context.Context, d *ent.Deployment) ([]*ent.DeploymentStatus, error)
-		CreateDeploymentStatus(ctx context.Context, s *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
-		SyncDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
+		// CreateEntDeploymentStatus create a DeploymentStatus entity to the store.
+		// Ent is appended to distinguish it from the interactor.
+		CreateEntDeploymentStatus(ctx context.Context, s *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
 	}
 
 	SCM interface {

internal/interactor/mock/pkg.go

@@ -21,40 +21,27 @@ func (s *Store) ListDeploymentStatuses(ctx context.Context, d *ent.Deployment) (
 	return dss, nil
 }
 
-func (s *Store) CreateDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error) {
-	ret, err := s.c.DeploymentStatus.
-		Create().
+func (s *Store) CreateEntDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error) {
+	// Build the query creating a deployment status.
+	qry := s.c.DeploymentStatus.Create().
 		SetStatus(ds.Status).
 		SetDescription(ds.Description).
 		SetLogURL(ds.LogURL).
-		SetDeploymentID(ds.DeploymentID).
-		Save(ctx)
-	if ent.IsConstraintError(err) {
-		return nil, e.NewErrorWithMessage(
-			e.ErrorCodeEntityUnprocessable,
-			fmt.Sprintf("Failed to create a deployment status. The value of \"%s\" field is invalid.", err.(*ent.ValidationError).Name),
-			err)
-	} else if err != nil {
-		return nil, e.NewError(e.ErrorCodeInternalError, err)
+		SetDeploymentID(ds.DeploymentID)
+
+	if !ds.CreatedAt.IsZero() {
+		qry.SetCreatedAt(ds.CreatedAt.UTC())
 	}
 
-	return ret, nil
-}
+	if !ds.UpdatedAt.IsZero() {
+		qry.SetUpdatedAt(ds.UpdatedAt.UTC())
+	}
 
-func (s *Store) SyncDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error) {
-	ret, err := s.c.DeploymentStatus.
-		Create().
-		SetStatus(ds.Status).
-		SetDescription(ds.Description).
-		SetLogURL(ds.LogURL).
-		SetDeploymentID(ds.DeploymentID).
-		SetCreatedAt(ds.CreatedAt).
-		SetUpdatedAt(ds.UpdatedAt).
-		Save(ctx)
+	ret, err := qry.Save(ctx)
 	if ent.IsConstraintError(err) {
 		return nil, e.NewErrorWithMessage(
 			e.ErrorCodeEntityUnprocessable,
-			fmt.Sprintf("Failed to sync the deployment status. The value of \"%s\" field is invalid.", err.(*ent.ValidationError).Name),
+			fmt.Sprintf("Failed to create a deployment status. The value of \"%s\" field is invalid.", err.(*ent.ValidationError).Name),
 			err)
 	} else if err != nil {
 		return nil, e.NewError(e.ErrorCodeInternalError, err)

internal/pkg/store/deploymentstatus.go

@@ -48,8 +48,6 @@ type (
 		UpdateLock(ctx context.Context, l *ent.Lock) (*ent.Lock, error)
 		DeleteLock(ctx context.Context, l *ent.Lock) error
 
-		CreateEvent(ctx context.Context, e *ent.Event) (*ent.Event, error)
-
 		ListCommits(ctx context.Context, u *ent.User, r *ent.Repo, branch string, opt *i.ListOptions) ([]*extent.Commit, error)
 		CompareCommits(ctx context.Context, u *ent.User, r *ent.Repo, base, head string, opt *i.ListOptions) ([]*extent.Commit, []*extent.CommitFile, error)
 		GetCommit(ctx context.Context, u *ent.User, r *ent.Repo, sha string) (*extent.Commit, error)

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

@@ -12,7 +12,6 @@ import (
 	gb "github.com/gitploy-io/gitploy/internal/server/global"
 	"github.com/gitploy-io/gitploy/model/ent"
 	"github.com/gitploy-io/gitploy/model/ent/deployment"
-	"github.com/gitploy-io/gitploy/model/ent/event"
 	"github.com/gitploy-io/gitploy/model/extent"
 	"github.com/gitploy-io/gitploy/pkg/e"
 )
@@ -118,7 +117,7 @@ func (h *Hooks) handleGithubDeploymentEvent(c *gin.Context) {
 	}
 
 	ds.DeploymentID = d.ID
-	if ds, err = h.i.SyncDeploymentStatus(ctx, ds); err != nil {
+	if ds, err = h.i.CreateDeploymentStatus(ctx, ds); err != nil {
 		h.log.Check(gb.GetZapLogLevel(err), "Failed to create a new the deployment status.").Write(zap.Error(err))
 		gb.ResponseWithError(c, err)
 		return
@@ -131,14 +130,6 @@ func (h *Hooks) handleGithubDeploymentEvent(c *gin.Context) {
 		return
 	}
 
-	if _, err := h.i.CreateEvent(ctx, &ent.Event{
-		Kind:         event.KindDeployment,
-		Type:         event.TypeUpdated,
-		DeploymentID: d.ID,
-	}); err != nil {
-		h.log.Error("It has failed to create the event.", zap.Error(err))
-	}
-
 	// Produce statistics when the deployment is success, and production environment.
 	if d.Status == deployment.StatusSuccess &&
 		d.ProductionEnvironment &&

internal/server/api/v1/repos/mock/interactor.go

@@ -46,7 +46,7 @@ func TestHook_HandleHook(t *testing.T) {
 
 		m.
 			EXPECT().
-			SyncDeploymentStatus(gomock.Any(), gomock.Eq(&ent.DeploymentStatus{
+			CreateDeploymentStatus(gomock.Any(), gomock.Eq(&ent.DeploymentStatus{
 				Status:       *e.DeploymentStatus.State,
 				Description:  *e.DeploymentStatus.Description,
 				CreatedAt:    e.DeploymentStatus.CreatedAt.Time.UTC(),
@@ -75,11 +75,6 @@ func TestHook_HandleHook(t *testing.T) {
 				Status: deployment.StatusSuccess,
 			}, nil)
 
-		m.
-			EXPECT().
-			CreateEvent(gomock.Any(), gomock.Any()).
-			Return(&ent.Event{}, nil)
-
 		h := NewHooks(&ConfigHooks{}, m)
 		r := gin.New()
 		r.POST("/hooks", h.HandleHook)

internal/server/hooks/hook.go

@@ -13,11 +13,10 @@ type (
 	Interactor interface {
 		FindRepoByID(ctx context.Context, id int64) (*ent.Repo, error)
 		FindDeploymentByUID(ctx context.Context, uid int64) (*ent.Deployment, error)
-		SyncDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
 		Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*ent.Deployment, error)
 		UpdateDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
+		CreateDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
 		ProduceDeploymentStatisticsOfRepo(ctx context.Context, r *ent.Repo, d *ent.Deployment) (*ent.DeploymentStatistics, error)
-		CreateEvent(ctx context.Context, e *ent.Event) (*ent.Event, error)
 		GetEvaluatedConfig(ctx context.Context, u *ent.User, r *ent.Repo, v *extent.EvalValues) (*extent.Config, error)
 	}
 )