Skip to content
This repository was archived by the owner on May 30, 2024. It is now read-only.

Commit ca735a5

Browse files
author
Noah Lee
authored
Refactoring the DeploymentInteractor (#346)
1 parent bb28840 commit ca735a5

File tree

12 files changed

+172
-103
lines changed

12 files changed

+172
-103
lines changed

‎internal/interactor/_mock.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ mockgen \
22
-aux_files \
33
github.com/gitploy-io/gitploy/internal/interactor=user.go\
44
,github.com/gitploy-io/gitploy/internal/interactor=repo.go\
5+
,github.com/gitploy-io/gitploy/internal/interactor=deployment.go\
56
-source ./interface.go \
67
-package mock \
78
-destination ./mock/pkg.go

‎internal/interactor/deployment.go‎

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,60 @@ import (
1515
)
1616

1717
type (
18+
// DeploymentInteractor provides application logic for interacting with deployments.
1819
DeploymentInteractor service
20+
21+
// DeploymentStore defines operations for working with deployments.
22+
DeploymentStore interface {
23+
CountDeployments(ctx context.Context) (int, error)
24+
SearchDeploymentsOfUser(ctx context.Context, u *ent.User, opt *SearchDeploymentsOfUserOptions) ([]*ent.Deployment, error)
25+
ListInactiveDeploymentsLessThanTime(ctx context.Context, opt *ListInactiveDeploymentsLessThanTimeOptions) ([]*ent.Deployment, error)
26+
ListDeploymentsOfRepo(ctx context.Context, r *ent.Repo, opt *ListDeploymentsOfRepoOptions) ([]*ent.Deployment, error)
27+
FindDeploymentByID(ctx context.Context, id int) (*ent.Deployment, error)
28+
FindDeploymentByUID(ctx context.Context, uid int64) (*ent.Deployment, error)
29+
FindDeploymentOfRepoByNumber(ctx context.Context, r *ent.Repo, number int) (*ent.Deployment, error)
30+
FindPrevSuccessDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
31+
GetNextDeploymentNumberOfRepo(ctx context.Context, r *ent.Repo) (int, error)
32+
CreateDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
33+
UpdateDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
34+
}
35+
36+
// SearchDeploymentsOfUserOptions specifies the optional parameters that
37+
// search deployments.
38+
SearchDeploymentsOfUserOptions struct {
39+
ListOptions
40+
41+
Statuses []deployment.Status
42+
Owned bool
43+
From time.Time
44+
To time.Time
45+
}
46+
47+
// ListInactiveDeploymentsLessThanTimeOptions specifies the optional parameters that
48+
// get inactive deployments.
49+
ListInactiveDeploymentsLessThanTimeOptions struct {
50+
ListOptions
51+
52+
Less time.Time
53+
}
54+
55+
ListDeploymentsOfRepoOptions struct {
56+
ListOptions
57+
58+
Env string
59+
Status string
60+
}
61+
62+
// DeploymentSCM defines operations for working with remote users.
63+
DeploymentSCM interface {
64+
// SCM returns the deployment with UID and SHA.
65+
CreateRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, e *extent.Env) (*extent.RemoteDeployment, error)
66+
CancelDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, s *ent.DeploymentStatus) error
67+
68+
GetConfig(ctx context.Context, u *ent.User, r *ent.Repo) (*extent.Config, error)
69+
GetConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
70+
GetNewConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
71+
}
1972
)
2073

2174
// IsApproved verifies that the request is approved or not.
@@ -223,7 +276,10 @@ L:
223276
break L
224277
}
225278
case t := <-ticker.C:
226-
ds, err := i.store.ListInactiveDeploymentsLessThanTime(ctx, t.Add(-30*time.Minute).UTC(), 1, 30)
279+
ds, err := i.store.ListInactiveDeploymentsLessThanTime(ctx, &ListInactiveDeploymentsLessThanTimeOptions{
280+
ListOptions: ListOptions{Page: 1, PerPage: 30},
281+
Less: t.Add(-30 * time.Minute).UTC(),
282+
})
227283
if err != nil {
228284
i.log.Error("It has failed to read inactive deployments.", zap.Error(err))
229285
continue

‎internal/interactor/interface.go‎

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import (
77
"time"
88

99
"github.com/gitploy-io/gitploy/model/ent"
10-
"github.com/gitploy-io/gitploy/model/ent/deployment"
1110
"github.com/gitploy-io/gitploy/model/extent"
1211
)
1312

@@ -17,22 +16,8 @@ type (
1716
ChatUserStore
1817
RepoStore
1918
PermStore
20-
21-
CountDeployments(ctx context.Context) (int, error)
22-
SearchDeployments(ctx context.Context, u *ent.User, s []deployment.Status, owned bool, from time.Time, to time.Time, page, perPage int) ([]*ent.Deployment, error)
23-
ListInactiveDeploymentsLessThanTime(ctx context.Context, t time.Time, page, perPage int) ([]*ent.Deployment, error)
24-
ListDeploymentsOfRepo(ctx context.Context, r *ent.Repo, env string, status string, page, perPage int) ([]*ent.Deployment, error)
25-
FindDeploymentByID(ctx context.Context, id int) (*ent.Deployment, error)
26-
FindDeploymentByUID(ctx context.Context, uid int64) (*ent.Deployment, error)
27-
FindDeploymentOfRepoByNumber(ctx context.Context, r *ent.Repo, number int) (*ent.Deployment, error)
28-
FindPrevSuccessDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
29-
GetNextDeploymentNumberOfRepo(ctx context.Context, r *ent.Repo) (int, error)
30-
CreateDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
31-
UpdateDeployment(ctx context.Context, d *ent.Deployment) (*ent.Deployment, error)
32-
33-
ListDeploymentStatuses(ctx context.Context, d *ent.Deployment) ([]*ent.DeploymentStatus, error)
34-
CreateDeploymentStatus(ctx context.Context, s *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
35-
SyncDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
19+
DeploymentStore
20+
DeploymentStatusStore
3621

3722
FindDeploymentStatisticsOfRepoByEnv(ctx context.Context, r *ent.Repo, env string) (*ent.DeploymentStatistics, error)
3823
CreateDeploymentStatistics(ctx context.Context, s *ent.DeploymentStatistics) (*ent.DeploymentStatistics, error)
@@ -78,23 +63,20 @@ type (
7863
Query string
7964
}
8065

66+
// PermStore defines operations for working with deployment_statuses.
67+
DeploymentStatusStore interface {
68+
ListDeploymentStatuses(ctx context.Context, d *ent.Deployment) ([]*ent.DeploymentStatus, error)
69+
CreateDeploymentStatus(ctx context.Context, s *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
70+
SyncDeploymentStatus(ctx context.Context, ds *ent.DeploymentStatus) (*ent.DeploymentStatus, error)
71+
}
72+
8173
SCM interface {
8274
UserSCM
8375
RepoSCM
84-
85-
GetConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
86-
GetNewConfigRedirectURL(ctx context.Context, u *ent.User, r *ent.Repo) (string, error)
87-
88-
// SCM returns the deployment with UID and SHA.
89-
CreateRemoteDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, e *extent.Env) (*extent.RemoteDeployment, error)
90-
CancelDeployment(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, s *ent.DeploymentStatus) error
91-
GetConfig(ctx context.Context, u *ent.User, r *ent.Repo) (*extent.Config, error)
76+
DeploymentSCM
9277

9378
CreateRemoteDeploymentStatus(ctx context.Context, u *ent.User, r *ent.Repo, d *ent.Deployment, ds *extent.RemoteDeploymentStatus) (*extent.RemoteDeploymentStatus, error)
9479

95-
CreateWebhook(ctx context.Context, u *ent.User, r *ent.Repo, c *extent.WebhookConfig) (int64, error)
96-
DeleteWebhook(ctx context.Context, u *ent.User, r *ent.Repo, id int64) error
97-
9880
ListCommits(ctx context.Context, u *ent.User, r *ent.Repo, branch string, page, perPage int) ([]*extent.Commit, error)
9981
CompareCommits(ctx context.Context, u *ent.User, r *ent.Repo, base, head string, page, perPage int) ([]*extent.Commit, []*extent.CommitFile, error)
10082
GetCommit(ctx context.Context, u *ent.User, r *ent.Repo, sha string) (*extent.Commit, error)

‎internal/interactor/mock/pkg.go‎

Lines changed: 14 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎internal/interactor/repo.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ type (
5353
// RepoSCM defines operations for working with remote repos.
5454
RepoSCM interface {
5555
ListRemoteRepos(ctx context.Context, u *ent.User) ([]*extent.RemoteRepo, error)
56+
CreateWebhook(ctx context.Context, u *ent.User, r *ent.Repo, c *extent.WebhookConfig) (int64, error)
57+
DeleteWebhook(ctx context.Context, u *ent.User, r *ent.Repo, id int64) error
5658
}
5759
)
5860

‎internal/pkg/store/deployment.go‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ package store
33
import (
44
"context"
55
"fmt"
6-
"time"
76

87
"entgo.io/ent/dialect/sql"
8+
i "github.com/gitploy-io/gitploy/internal/interactor"
99
"github.com/gitploy-io/gitploy/model/ent"
1010
"github.com/gitploy-io/gitploy/model/ent/deployment"
1111
"github.com/gitploy-io/gitploy/model/ent/perm"
@@ -24,7 +24,7 @@ func (s *Store) CountDeployments(ctx context.Context) (int, error) {
2424
return cnt, nil
2525
}
2626

27-
func (s *Store) SearchDeployments(ctx context.Context, u *ent.User, ss []deployment.Status, owned bool, from time.Time, to time.Time, page, perPage int) ([]*ent.Deployment, error) {
27+
func (s *Store) SearchDeploymentsOfUser(ctx context.Context, u *ent.User, opt *i.SearchDeploymentsOfUserOptions) ([]*ent.Deployment, error) {
2828
statusIn := func(ss []deployment.Status) predicate.Deployment {
2929
if len(ss) == 0 {
3030
// if not status were provided,
@@ -35,22 +35,22 @@ func (s *Store) SearchDeployments(ctx context.Context, u *ent.User, ss []deploym
3535
return deployment.StatusIn(ss...)
3636
}
3737

38-
if owned {
38+
if opt.Owned {
3939
return s.c.Deployment.
4040
Query().
4141
Where(
4242
deployment.And(
4343
deployment.UserIDEQ(u.ID),
44-
statusIn(ss),
45-
deployment.CreatedAtGTE(from),
46-
deployment.CreatedAtLT(to),
44+
statusIn(opt.Statuses),
45+
deployment.CreatedAtGTE(opt.From),
46+
deployment.CreatedAtLT(opt.To),
4747
),
4848
).
4949
WithRepo().
5050
WithUser().
5151
Order(ent.Desc(deployment.FieldCreatedAt)).
52-
Offset(offset(page, perPage)).
53-
Limit(perPage).
52+
Offset(offset(opt.Page, opt.PerPage)).
53+
Limit(opt.PerPage).
5454
All(ctx)
5555
}
5656

@@ -74,50 +74,50 @@ func (s *Store) SearchDeployments(ctx context.Context, u *ent.User, ss []deploym
7474
}).
7575
Where(
7676
deployment.And(
77-
statusIn(ss),
78-
deployment.CreatedAtGTE(from),
79-
deployment.CreatedAtLT(to),
77+
statusIn(opt.Statuses),
78+
deployment.CreatedAtGTE(opt.From),
79+
deployment.CreatedAtLT(opt.To),
8080
),
8181
).
8282
WithRepo().
8383
WithUser().
8484
Order(ent.Desc(deployment.FieldCreatedAt)).
85-
Offset(offset(page, perPage)).
86-
Limit(perPage).
85+
Offset(offset(opt.Page, opt.PerPage)).
86+
Limit(opt.PerPage).
8787
All(ctx)
8888
}
8989

90-
func (s *Store) ListInactiveDeploymentsLessThanTime(ctx context.Context, t time.Time, page, perPage int) ([]*ent.Deployment, error) {
90+
func (s *Store) ListInactiveDeploymentsLessThanTime(ctx context.Context, opt *i.ListInactiveDeploymentsLessThanTimeOptions) ([]*ent.Deployment, error) {
9191
return s.c.Deployment.
9292
Query().
9393
Where(
9494
deployment.And(
9595
deployment.StatusIn(deployment.StatusWaiting, deployment.StatusCreated),
96-
deployment.CreatedAtLT(t),
96+
deployment.CreatedAtLT(opt.Less),
9797
),
9898
).
9999
WithRepo().
100100
WithUser().
101-
Limit(perPage).
102-
Offset(offset(page, perPage)).
101+
Limit(opt.PerPage).
102+
Offset(offset(opt.Page, opt.PerPage)).
103103
All(ctx)
104104
}
105105

106-
func (s *Store) ListDeploymentsOfRepo(ctx context.Context, r *ent.Repo, env string, status string, page, perPage int) ([]*ent.Deployment, error) {
106+
func (s *Store) ListDeploymentsOfRepo(ctx context.Context, r *ent.Repo, opt *i.ListDeploymentsOfRepoOptions) ([]*ent.Deployment, error) {
107107
q := s.c.Deployment.
108108
Query()
109109

110110
q = q.Where(
111111
deployment.RepoIDEQ(r.ID),
112112
)
113113

114-
if env != "" {
114+
if env := opt.Env; env != "" {
115115
q = q.Where(
116116
deployment.EnvEQ(env),
117117
)
118118
}
119119

120-
if status != "" {
120+
if status := opt.Status; status != "" {
121121
q = q.Where(
122122
deployment.StatusEQ(deployment.Status(status)),
123123
)
@@ -130,8 +130,8 @@ func (s *Store) ListDeploymentsOfRepo(ctx context.Context, r *ent.Repo, env stri
130130
uq.Select("id", "login", "avatar", "created_at", "updated_at")
131131
}).
132132
WithRepo().
133-
Limit(perPage).
134-
Offset(offset(page, perPage)).
133+
Limit(opt.PerPage).
134+
Offset(offset(opt.Page, opt.PerPage)).
135135
All(ctx)
136136
}
137137

0 commit comments

Comments
 (0)