Enhance the notification message (#414)

* Add the `deployment_status_id` field to event schema

* Move `CreateEvent` into `CreateDeploymentStatus`

* Change the slack message format

* Fix the stream API to support DeploymentStatus

* Add the RepoID field to DeploymentStatus schema

* Fix to add `RepoID` when creating a status

* Subscribe the deployment status event in UI

* Deprecate the deployment event

Author: Noah Lee

go.mod

@@ -80,6 +80,8 @@ require (
 	golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd // indirect
 	golang.org/x/sys v0.0.0-20220114195835-da31bd327af9 // indirect
 	golang.org/x/text v0.3.7 // indirect
+	golang.org/x/tools v0.1.9-0.20211216111533-8d383106f7e7 // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/protobuf v1.26.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect

go.sum

@@ -882,6 +882,7 @@ golang.org/x/tools v0.1.2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.3/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.4/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
+golang.org/x/tools v0.1.9-0.20211216111533-8d383106f7e7 h1:M1gcVrIb2lSn2FIL19DG0+/b8nNVKJ7W7b4WcAGZAYM=
 golang.org/x/tools v0.1.9-0.20211216111533-8d383106f7e7/go.mod h1:nABZi5QlRsZVlzPpHl034qft6wpY4eDcsTt5AaioBiU=
 golang.org/x/xerrors v0.0.0-20190410155217-1f06c39b4373/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20190513163551-3ee3066db522/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

internal/interactor/deployment.go

@@ -121,14 +121,15 @@ 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,
+			RepoID:       r.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 +150,15 @@ 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,
+		RepoID:       r.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,10 +233,11 @@ 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,
+		RepoID:       r.ID,
 	})
 
 	return d, nil
@@ -258,6 +255,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()
 
@@ -289,13 +304,14 @@ L:
 							Status:       "canceled",
 							Description:  "Gitploy cancels the inactive deployment.",
 							DeploymentID: d.ID,
+							RepoID:       d.RepoID,
 						}
 						if err := i.scm.CancelDeployment(ctx, d.Edges.User, d.Edges.Repo, d, s); err != nil {
 							i.log.Error("It has failed to cancel the remote deployment.", zap.Error(err))
 							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

@@ -52,12 +52,13 @@ func TestInteractor_Deploy(t *testing.T) {
 
 		store.
 			EXPECT().
-			CreateEvent(gomock.Any(), gomock.AssignableToTypeOf(&ent.Event{})).
-			Return(&ent.Event{}, nil)
+			CreateEntDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{})).
+			Return(&ent.DeploymentStatus{}, nil)
 
 		store.
 			EXPECT().
-			CreateDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
+			CreateEvent(gomock.Any(), gomock.AssignableToTypeOf(&ent.Event{})).
+			Return(&ent.Event{}, nil)
 
 		it := i.NewInteractor(&i.InteractorConfig{
 			Store: store,
@@ -99,6 +100,11 @@ func TestInteractor_Deploy(t *testing.T) {
 				return d, nil
 			})
 
+		store.
+			EXPECT().
+			CreateEntDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{})).
+			Return(&ent.DeploymentStatus{}, nil)
+
 		store.
 			EXPECT().
 			CreateEvent(gomock.Any(), gomock.AssignableToTypeOf(&ent.Event{})).
@@ -160,7 +166,13 @@ func TestInteractor_DeployToRemote(t *testing.T) {
 
 		store.
 			EXPECT().
-			CreateDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
+			CreateEntDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{})).
+			Return(&ent.DeploymentStatus{}, nil)
+
+		store.
+			EXPECT().
+			CreateEvent(gomock.Any(), gomock.AssignableToTypeOf(&ent.Event{})).
+			Return(&ent.Event{}, nil)
 
 		it := i.NewInteractor(&i.InteractorConfig{
 			Store: store,

internal/interactor/interface.go

@@ -43,8 +43,10 @@ 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)
+		FindDeploymentStatusByID(ctx context.Context, id int) (*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,41 @@ 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().
-		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)
+func (s *Store) FindDeploymentStatusByID(ctx context.Context, id int) (*ent.DeploymentStatus, error) {
+	ds, err := s.c.DeploymentStatus.Query().
+		Where(deploymentstatus.IDEQ(id)).
+		WithDeployment().
+		WithRepo().
+		Only(ctx)
+	if ent.IsNotFound(err) {
+		return nil, e.NewError(e.ErrorCodeEntityNotFound, err)
 	}
 
-	return ret, nil
+	return ds, nil
 }
 
-func (s *Store) SyncDeploymentStatus(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).
-		SetCreatedAt(ds.CreatedAt).
-		SetUpdatedAt(ds.UpdatedAt).
-		Save(ctx)
+		SetRepoID(ds.RepoID)
+
+	if !ds.CreatedAt.IsZero() {
+		qry.SetCreatedAt(ds.CreatedAt.UTC())
+	}
+
+	if !ds.UpdatedAt.IsZero() {
+		qry.SetUpdatedAt(ds.UpdatedAt.UTC())
+	}
+
+	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)