Refactorying the interactor package (#338)

Author: Noah Lee

internal/interactor/deployment.go

@@ -14,11 +14,15 @@ import (
 	"go.uber.org/zap"
 )
 
+type (
+	DeploymentsInteractor service
+)
+
 // IsApproved verifies that the request is approved or not.
 // It is approved if there is an approval of reviews at least, but
 // it is rejected if there is a reject of reviews.
-func (i *Interactor) IsApproved(ctx context.Context, d *ent.Deployment) bool {
-	rvs, _ := i.Store.ListReviews(ctx, d)
+func (i *DeploymentsInteractor) IsApproved(ctx context.Context, d *ent.Deployment) bool {
+	rvs, _ := i.store.ListReviews(ctx, d)
 
 	for _, r := range rvs {
 		if r.Status == review.StatusRejected {
@@ -39,12 +43,12 @@ func (i *Interactor) IsApproved(ctx context.Context, d *ent.Deployment) bool {
 // But if it requires a review, it saves the payload on the DB
 // and waits until reviewed.
 // It returns an error for a undeployable payload.
-func (i *Interactor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*ent.Deployment, error) {
+func (i *DeploymentsInteractor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*ent.Deployment, error) {
 	if err := i.isDeployable(ctx, u, r, d, env); err != nil {
 		return nil, err
 	}
 
-	number, err := i.Store.GetNextDeploymentNumberOfRepo(ctx, r)
+	number, err := i.store.GetNextDeploymentNumberOfRepo(ctx, r)
 	if err != nil {
 		return nil, e.NewError(
 			e.ErrorCodeInternalError,
@@ -66,7 +70,7 @@ func (i *Interactor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *en
 		}
 
 		i.log.Debug("Save the deployment to wait reviews.")
-		d, err = i.Store.CreateDeployment(ctx, d)
+		d, err = i.store.CreateDeployment(ctx, d)
 		if err != nil {
 			return nil, err
 		}
@@ -107,12 +111,12 @@ func (i *Interactor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *en
 	}
 
 	i.log.Debug("Create a new deployment with the payload.", zap.Any("deployment", d))
-	d, err = i.Store.CreateDeployment(ctx, d)
+	d, err = i.store.CreateDeployment(ctx, d)
 	if err != nil {
 		return nil, fmt.Errorf("It failed to save a new deployment.: %w", err)
 	}
 
-	i.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
+	i.store.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
 		Status:       string(deployment.StatusCreated),
 		Description:  "Gitploy starts to deploy.",
 		DeploymentID: d.ID,
@@ -124,7 +128,7 @@ func (i *Interactor) Deploy(ctx context.Context, u *ent.User, r *ent.Repo, d *en
 // DeployToRemote posts a new deployment to SCM with the saved payload
 // after review has finished.
 // It returns an error for a undeployable payload.
-func (i *Interactor) DeployToRemote(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*ent.Deployment, error) {
+func (i *DeploymentsInteractor) DeployToRemote(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*ent.Deployment, error) {
 	if d.Status != deployment.StatusWaiting {
 		return nil, e.NewErrorWithMessage(
 			e.ErrorCodeDeploymentStatusInvalid,
@@ -155,11 +159,11 @@ func (i *Interactor) DeployToRemote(ctx context.Context, u *ent.User, r *ent.Rep
 	d.HTMLURL = rd.HTLMURL
 	d.Status = deployment.StatusCreated
 
-	if d, err = i.UpdateDeployment(ctx, d); err != nil {
+	if d, err = i.store.UpdateDeployment(ctx, d); err != nil {
 		return nil, err
 	}
 
-	i.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
+	i.store.CreateDeploymentStatus(ctx, &ent.DeploymentStatus{
 		Status:       string(deployment.StatusCreated),
 		Description:  "Gitploy creates a new deployment.",
 		DeploymentID: d.ID,
@@ -168,7 +172,7 @@ func (i *Interactor) DeployToRemote(ctx context.Context, u *ent.User, r *ent.Rep
 	return d, nil
 }
 
-func (i *Interactor) createRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*extent.RemoteDeployment, error) {
+func (i *DeploymentsInteractor) createRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) (*extent.RemoteDeployment, error) {
 	// Rollback configures it can deploy the ref without any constraints.
 	// 1) Set auto_merge false to avoid the merge conflict.
 	// 2) Set required_contexts empty to skip the verfication.
@@ -177,10 +181,10 @@ func (i *Interactor) createRemoteDeployment(ctx context.Context, u *ent.User, r
 		env.RequiredContexts = &[]string{}
 	}
 
-	return i.SCM.CreateRemoteDeployment(ctx, u, r, d, env)
+	return i.scm.CreateRemoteDeployment(ctx, u, r, d, env)
 }
 
-func (i *Interactor) isDeployable(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) error {
+func (i *DeploymentsInteractor) isDeployable(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, env *extent.Env) error {
 	// Skip verifications for roll back.
 	if !d.IsRollback {
 		if ok, err := env.IsDeployableRef(d.Ref); !ok {
@@ -191,7 +195,7 @@ func (i *Interactor) isDeployable(ctx context.Context, u *ent.User, r *ent.Repo,
 	}
 
 	// Check that the environment is locked.
-	if locked, err := i.Store.HasLockOfRepoForEnv(ctx, r, d.Env); locked {
+	if locked, err := i.store.HasLockOfRepoForEnv(ctx, r, d.Env); locked {
 		return e.NewError(e.ErrorCodeDeploymentLocked, err)
 	} else if err != nil {
 		return err
@@ -206,7 +210,7 @@ func (i *Interactor) isDeployable(ctx context.Context, u *ent.User, r *ent.Repo,
 	return nil
 }
 
-func (i *Interactor) runClosingInactiveDeployment(stop <-chan struct{}) {
+func (i *DeploymentsInteractor) runClosingInactiveDeployment(stop <-chan struct{}) {
 	ctx := context.Background()
 
 	ticker := time.NewTicker(time.Minute)
@@ -219,7 +223,7 @@ L:
 				break L
 			}
 		case t := <-ticker.C:
-			ds, err := i.ListInactiveDeploymentsLessThanTime(ctx, t.Add(-30*time.Minute).UTC(), 1, 30)
+			ds, err := i.store.ListInactiveDeploymentsLessThanTime(ctx, t.Add(-30*time.Minute).UTC(), 1, 30)
 			if err != nil {
 				i.log.Error("It has failed to read inactive deployments.", zap.Error(err))
 				continue
@@ -235,20 +239,20 @@ L:
 							Description:  "Gitploy cancels the inactive deployment.",
 							DeploymentID: d.ID,
 						}
-						if err := i.SCM.CancelDeployment(ctx, d.Edges.User, d.Edges.Repo, d, s); err != nil {
+						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.store.CreateDeploymentStatus(ctx, s); err != nil {
 							i.log.Error("It has failed to create a new deployment status.", zap.Error(err))
 							continue
 						}
 					}
 				}
 
 				d.Status = deployment.StatusCanceled
-				if _, err := i.UpdateDeployment(ctx, d); err != nil {
+				if _, err := i.store.UpdateDeployment(ctx, d); err != nil {
 					i.log.Error("It has failed to update the deployment canceled.", zap.Error(err))
 				}
 

internal/interactor/deployment_test.go

@@ -17,10 +17,10 @@ import (
 	"github.com/gitploy-io/gitploy/pkg/e"
 )
 
-func newMockInteractor(store Store, scm SCM) *Interactor {
-	return &Interactor{
-		Store: store,
-		SCM:   scm,
+func newMockDeploymentsInteractor(store Store, scm SCM) *DeploymentsInteractor {
+	return &DeploymentsInteractor{
+		store: store,
+		scm:   scm,
 		log:   zap.L(),
 	}
 }
@@ -44,7 +44,7 @@ func TestInteractor_IsApproved(t *testing.T) {
 				},
 			}, nil)
 
-		i := newMockInteractor(store, scm)
+		i := newMockDeploymentsInteractor(store, scm)
 
 		expected := false
 		if ret := i.IsApproved(context.Background(), &ent.Deployment{}); ret != expected {
@@ -75,7 +75,7 @@ func TestInteractor_Deploy(t *testing.T) {
 		store := mock.NewMockStore(ctrl)
 		scm := mock.NewMockSCM(ctrl)
 
-		i := newMockInteractor(store, scm)
+		i := newMockDeploymentsInteractor(store, scm)
 
 		_, err := i.Deploy(context.Background(), &ent.User{}, &ent.Repo{}, input.d, input.e)
 		if !e.HasErrorCode(err, e.ErrorCodeEntityUnprocessable) {
@@ -93,7 +93,7 @@ func TestInteractor_Deploy(t *testing.T) {
 			HasLockOfRepoForEnv(ctx, gomock.AssignableToTypeOf(&ent.Repo{}), "").
 			Return(true, nil)
 
-		i := newMockInteractor(store, scm)
+		i := newMockDeploymentsInteractor(store, scm)
 
 		_, err := i.Deploy(context.Background(), &ent.User{}, &ent.Repo{}, &ent.Deployment{}, &extent.Env{})
 		if !e.HasErrorCode(err, e.ErrorCodeDeploymentLocked) {
@@ -159,7 +159,7 @@ func TestInteractor_Deploy(t *testing.T) {
 			EXPECT().
 			CreateDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
 
-		i := newMockInteractor(store, scm)
+		i := newMockDeploymentsInteractor(store, scm)
 
 		d, err := i.Deploy(context.Background(), &ent.User{}, &ent.Repo{}, input.d, input.e)
 		if err != nil {
@@ -243,7 +243,7 @@ func TestInteractor_Deploy(t *testing.T) {
 			CreateEvent(ctx, gomock.AssignableToTypeOf(&ent.Event{})).
 			Return(&ent.Event{}, nil)
 
-		i := newMockInteractor(store, scm)
+		i := newMockDeploymentsInteractor(store, scm)
 
 		d, err := i.Deploy(context.Background(), &ent.User{}, &ent.Repo{}, input.d, input.e)
 		if err != nil {
@@ -281,7 +281,7 @@ func TestInteractor_DeployToRemote(t *testing.T) {
 		store := mock.NewMockStore(ctrl)
 		scm := mock.NewMockSCM(ctrl)
 
-		i := newMockInteractor(store, scm)
+		i := newMockDeploymentsInteractor(store, scm)
 
 		_, err := i.DeployToRemote(context.Background(), &ent.User{}, &ent.Repo{}, input.d, input.e)
 		if !e.HasErrorCode(err, e.ErrorCodeDeploymentStatusInvalid) {
@@ -345,7 +345,7 @@ func TestInteractor_DeployToRemote(t *testing.T) {
 			EXPECT().
 			CreateDeploymentStatus(ctx, gomock.AssignableToTypeOf(&ent.DeploymentStatus{}))
 
-		i := newMockInteractor(store, scm)
+		i := newMockDeploymentsInteractor(store, scm)
 
 		d, err := i.DeployToRemote(context.Background(), &ent.User{}, &ent.Repo{}, input.d, input.e)
 		if err != nil {

internal/interactor/deploymentstatistics.go

@@ -7,11 +7,15 @@ import (
 	"github.com/gitploy-io/gitploy/model/ent"
 )
 
-func (i *Interactor) ProduceDeploymentStatisticsOfRepo(ctx context.Context, r *ent.Repo, d *ent.Deployment) (*ent.DeploymentStatistics, error) {
-	s, err := i.Store.FindDeploymentStatisticsOfRepoByEnv(ctx, r, d.Env)
+type (
+	DeploymentStatisticsInteractor service
+)
+
+func (i *DeploymentStatisticsInteractor) ProduceDeploymentStatisticsOfRepo(ctx context.Context, r *ent.Repo, d *ent.Deployment) (*ent.DeploymentStatistics, error) {
+	s, err := i.store.FindDeploymentStatisticsOfRepoByEnv(ctx, r, d.Env)
 
 	if ent.IsNotFound(err) {
-		if s, err = i.Store.CreateDeploymentStatistics(ctx, &ent.DeploymentStatistics{
+		if s, err = i.store.CreateDeploymentStatistics(ctx, &ent.DeploymentStatistics{
 			Env:    d.Env,
 			RepoID: r.ID,
 		}); err != nil {
@@ -23,10 +27,10 @@ func (i *Interactor) ProduceDeploymentStatisticsOfRepo(ctx context.Context, r *e
 		return nil, err
 	}
 
-	return i.Store.UpdateDeploymentStatistics(ctx, s)
+	return i.store.UpdateDeploymentStatistics(ctx, s)
 }
 
-func (i *Interactor) produceDeploymentStatisticsOfRepo(ctx context.Context, r *ent.Repo, d *ent.Deployment, s *ent.DeploymentStatistics) (*ent.DeploymentStatistics, error) {
+func (i *DeploymentStatisticsInteractor) produceDeploymentStatisticsOfRepo(ctx context.Context, r *ent.Repo, d *ent.Deployment, s *ent.DeploymentStatistics) (*ent.DeploymentStatistics, error) {
 	{
 		if d.IsRollback {
 			s.RollbackCount = s.RollbackCount + 1
@@ -36,22 +40,22 @@ func (i *Interactor) produceDeploymentStatisticsOfRepo(ctx context.Context, r *e
 	}
 
 	{
-		ld, err := i.Store.FindPrevSuccessDeployment(ctx, d)
+		ld, err := i.store.FindPrevSuccessDeployment(ctx, d)
 		if ent.IsNotFound(err) {
 			return s, nil
 		} else if err != nil {
 			return nil, err
 		}
 
 		if d.Edges.User == nil {
-			if d, err = i.Store.FindDeploymentByID(ctx, d.ID); err != nil {
+			if d, err = i.store.FindDeploymentByID(ctx, d.ID); err != nil {
 				return nil, err
 			} else if d.Edges.User == nil {
 				return nil, fmt.Errorf("The deployer is not found.")
 			}
 		}
 
-		cms, fs, err := i.SCM.CompareCommits(ctx, d.Edges.User, r, ld.Sha, d.Sha, 1, 100)
+		cms, fs, err := i.scm.CompareCommits(ctx, d.Edges.User, r, ld.Sha, d.Sha, 1, 100)
 		if err != nil {
 			return nil, err
 		}

internal/interactor/deploymentstatistics_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/gitploy-io/gitploy/model/ent"
 	"github.com/gitploy-io/gitploy/model/extent"
 	"github.com/golang/mock/gomock"
+	"go.uber.org/zap"
 )
 
 func TestInteractor_ProduceDeploymentStatisticsOfRepo(t *testing.T) {
@@ -55,7 +56,11 @@ func TestInteractor_ProduceDeploymentStatisticsOfRepo(t *testing.T) {
 				return s, nil
 			})
 
-		i := newMockInteractor(store, scm)
+		i := &DeploymentStatisticsInteractor{
+			store: store,
+			scm:   scm,
+			log:   zap.L(),
+		}
 
 		_, err := i.ProduceDeploymentStatisticsOfRepo(context.Background(), input.repo, input.d)
 		if err != nil {
@@ -113,7 +118,11 @@ func TestInteractor_ProduceDeploymentStatisticsOfRepo(t *testing.T) {
 				return s, nil
 			})
 
-		i := newMockInteractor(store, scm)
+		i := &DeploymentStatisticsInteractor{
+			store: store,
+			scm:   scm,
+			log:   zap.L(),
+		}
 
 		_, err := i.ProduceDeploymentStatisticsOfRepo(context.Background(), input.repo, input.d)
 		if err != nil {

internal/interactor/event.go

@@ -4,15 +4,33 @@ import (
 	"context"
 	"time"
 
-	"github.com/gitploy-io/gitploy/model/ent"
+	evbus "github.com/asaskevich/EventBus"
 	"go.uber.org/zap"
+
+	"github.com/gitploy-io/gitploy/model/ent"
 )
 
 const (
 	gitployEvent = "gitploy:event"
 )
 
-func (i *Interactor) runPublishingEvents(stop <-chan struct{}) {
+type (
+	EventsInteractor struct {
+		*service
+
+		events evbus.Bus
+	}
+)
+
+func (i *EventsInteractor) SubscribeEvent(fn func(e *ent.Event)) error {
+	return i.events.SubscribeAsync(gitployEvent, fn, false)
+}
+
+func (i *EventsInteractor) UnsubscribeEvent(fn func(e *ent.Event)) error {
+	return i.events.Unsubscribe(gitployEvent, fn)
+}
+
+func (i *EventsInteractor) runPublishingEvents(stop <-chan struct{}) {
 	ctx := context.Background()
 
 	// Read events periodically and publish to subscribers.
@@ -29,7 +47,7 @@ L:
 			}
 
 		case t := <-ticker.C:
-			es, err := i.ListEventsGreaterThanTime(ctx, t.Add(-period).UTC())
+			es, err := i.store.ListEventsGreaterThanTime(ctx, t.Add(-period).UTC())
 			if err != nil {
 				i.log.Error("It has failed to read events.", zap.Error(err))
 				continue
@@ -42,11 +60,3 @@ L:
 		}
 	}
 }
-
-func (i *Interactor) SubscribeEvent(fn func(e *ent.Event)) error {
-	return i.events.SubscribeAsync(gitployEvent, fn, false)
-}
-
-func (i *Interactor) UnsubscribeEvent(fn func(e *ent.Event)) error {
-	return i.events.Unsubscribe(gitployEvent, fn)
-}