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

Commit bb22d1a

Browse files
author
Noah Lee
authored
Fix to handle the error that the webhook is not found when an user deactivates (#254)
* Fix the location of entity error * Fix to handle the webhook is not found * Add unit test for github
1 parent 87f6cfc commit bb22d1a

File tree

8 files changed

+134
-18
lines changed

8 files changed

+134
-18
lines changed

‎go.mod‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,6 @@ require (
3232
go.uber.org/zap v1.19.1
3333
golang.org/x/net v0.0.0-20210525063256-abc453219eb5 // indirect
3434
golang.org/x/oauth2 v0.0.0-20210514164344-f6687ab2804c
35+
gopkg.in/h2non/gock.v1 v1.1.2 // indirect
3536
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
3637
)

‎go.sum‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,8 @@ github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/ad
206206
github.com/grpc-ecosystem/go-grpc-middleware v1.0.0/go.mod h1:FiyG127CGDf3tlThmgyCl78X/SZQqEOJBCDaAfeWzPs=
207207
github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0/go.mod h1:8NvIoxWQoOIhqOTXgfV/d3M/q6VIi02HzZEHgUlZvzk=
208208
github.com/grpc-ecosystem/grpc-gateway v1.9.0/go.mod h1:vNeuVxBJEsws4ogUvrchl83t/GYV9WGTSLVdBhOQFDY=
209+
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
210+
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
209211
github.com/hashicorp/consul/api v1.1.0/go.mod h1:VmuI/Lkw1nC05EYQWNKwWGbkg+FbDBtguAZLlVdkD9Q=
210212
github.com/hashicorp/consul/sdk v0.1.1/go.mod h1:VKf9jXwCTEY1QZP2MOLRhb5i/I/ssyNV1vwHyQBF0x8=
211213
github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4=
@@ -348,6 +350,7 @@ github.com/modern-go/reflect2 v1.0.1 h1:9f412s+6RmYXLWZSEzVVgPGK7C2PphHj5RJrvfx9
348350
github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
349351
github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
350352
github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
353+
github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms=
351354
github.com/nleeper/goment v1.4.2 h1:r4c8KkCrsBJUnVi/IJ5HEqev5QY8aCWOXQtu+eYXtnI=
352355
github.com/nleeper/goment v1.4.2/go.mod h1:zDl5bAyDhqxwQKAvkSXMRLOdCowrdZz53ofRJc4VhTo=
353356
github.com/oklog/ulid v1.3.1/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=
@@ -778,6 +781,8 @@ gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8
778781
gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI=
779782
gopkg.in/go-playground/assert.v1 v1.2.1/go.mod h1:9RXL0bg/zibRAgZUYszZSwO/z8Y/a8bDuhia5mkpMnE=
780783
gopkg.in/go-playground/validator.v9 v9.29.1/go.mod h1:+c9/zcJMFNgbLvly1L1V+PpxWdVbfP1avr/N00E2vyQ=
784+
gopkg.in/h2non/gock.v1 v1.1.2 h1:jBbHXgGBK/AoPVfJh5x4r/WxIrElvbLel8TCZkkZJoY=
785+
gopkg.in/h2non/gock.v1 v1.1.2/go.mod h1:n7UGz/ckNChHiK05rDoiC4MYSunEC/lyaUm2WWaDva0=
781786
gopkg.in/inconshreveable/log15.v2 v2.0.0-20180818164646-67afb5ed74ec/go.mod h1:aPpfJ7XW+gOuirDoZ8gHhLh3kZ1B08FtV2bbmy7Jv3s=
782787
gopkg.in/ini.v1 v1.51.0/go.mod h1:pNLf8WUiyNEtQjuu5G5vTm06TEv9tsIgeAvK8hOrP4k=
783788
gopkg.in/resty.v1 v1.12.0/go.mod h1:mDo4pnntr5jdWRML875a/NmxYqAlA73dVijT2AXvQQo=

‎internal/interactor/repo.go‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ import (
55
"fmt"
66

77
"github.com/gitploy-io/gitploy/ent"
8+
"github.com/gitploy-io/gitploy/pkg/e"
89
"github.com/gitploy-io/gitploy/vo"
10+
"go.uber.org/zap"
911
)
1012

1113
func (i *Interactor) ActivateRepo(ctx context.Context, u *ent.User, r *ent.Repo, c *vo.WebhookConfig) (*ent.Repo, error) {
@@ -27,13 +29,15 @@ func (i *Interactor) ActivateRepo(ctx context.Context, u *ent.User, r *ent.Repo,
2729

2830
func (i *Interactor) DeactivateRepo(ctx context.Context, u *ent.User, r *ent.Repo) (*ent.Repo, error) {
2931
err := i.SCM.DeleteWebhook(ctx, u, r, r.WebhookID)
30-
if err != nil {
31-
return nil, fmt.Errorf("failed to delete the webhook: %w", err)
32+
if e.HasErrorCode(err, e.ErrorCodeEntityNotFound) {
33+
i.log.Info("The webhook is not found, skip to delete the webhook.", zap.Int64("id", r.WebhookID))
34+
} else if err != nil {
35+
return nil, err
3236
}
3337

3438
r, err = i.Store.Deactivate(ctx, r)
3539
if err != nil {
36-
return nil, fmt.Errorf("failed to deactivate the webhook: %w", err)
40+
return nil, err
3741
}
3842

3943
return r, nil

‎internal/interactor/repo_test.go‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package interactor
2+
3+
import (
4+
"context"
5+
"testing"
6+
7+
"github.com/golang/mock/gomock"
8+
9+
"github.com/gitploy-io/gitploy/ent"
10+
"github.com/gitploy-io/gitploy/internal/interactor/mock"
11+
"github.com/gitploy-io/gitploy/pkg/e"
12+
)
13+
14+
func TestInteractor_DeactivateRepo(t *testing.T) {
15+
t.Run("Deactivate successfully even if the webhook is not found.", func(t *testing.T) {
16+
ctrl := gomock.NewController(t)
17+
store := mock.NewMockStore(ctrl)
18+
scm := mock.NewMockSCM(ctrl)
19+
20+
t.Log("Mocking DeleteWebhook to return an EntityNotFound error.")
21+
scm.
22+
EXPECT().
23+
DeleteWebhook(gomock.Any(), gomock.AssignableToTypeOf(&ent.User{}), gomock.AssignableToTypeOf(&ent.Repo{}), gomock.Any()).
24+
Return(e.NewError(e.ErrorCodeEntityNotFound, nil))
25+
26+
store.
27+
EXPECT().
28+
Deactivate(gomock.Any(), gomock.AssignableToTypeOf(&ent.Repo{})).
29+
Return(&ent.Repo{}, nil)
30+
31+
i := newMockInteractor(store, scm)
32+
33+
_, err := i.DeactivateRepo(context.Background(), &ent.User{}, &ent.Repo{})
34+
if err != nil {
35+
t.Fatalf("DeactivateRepo returns an error: %v", err)
36+
}
37+
})
38+
}

‎internal/pkg/github/repos.go‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,8 +261,13 @@ func (g *Github) CreateWebhook(ctx context.Context, u *ent.User, r *ent.Repo, c
261261
}
262262

263263
func (g *Github) DeleteWebhook(ctx context.Context, u *ent.User, r *ent.Repo, id int64) error {
264-
_, err := g.Client(ctx, u.Token).
264+
res, err := g.Client(ctx, u.Token).
265265
Repositories.
266266
DeleteHook(ctx, r.Namespace, r.Name, id)
267+
// https://docs.github.com/en/rest/reference/repos#delete-a-repository-webhook
268+
if res.StatusCode == http.StatusNotFound {
269+
return e.NewErrorWithMessage(e.ErrorCodeEntityNotFound, "The webhook is not found.", err)
270+
}
271+
267272
return err
268273
}

‎internal/pkg/github/repos_test.go‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
package github
2+
3+
import (
4+
"context"
5+
"testing"
6+
7+
"github.com/gitploy-io/gitploy/ent"
8+
"github.com/gitploy-io/gitploy/pkg/e"
9+
"gopkg.in/h2non/gock.v1"
10+
)
11+
12+
func TestGithub_DeleteWebhook(t *testing.T) {
13+
t.Run("Return the ErrorCodeEntityNotFound error when the webhook is not found.", func(t *testing.T) {
14+
t.Log("Mocking the delete webhook API")
15+
gock.New("https://api.github.com").
16+
Delete("/repos/gitploy-io/gitploy/hooks/1").
17+
Reply(404)
18+
19+
g := NewGithub(&GithubConfig{})
20+
21+
const hookID = 1
22+
23+
err := g.DeleteWebhook(
24+
context.Background(),
25+
&ent.User{},
26+
&ent.Repo{
27+
Namespace: "gitploy-io",
28+
Name: "gitploy",
29+
},
30+
hookID,
31+
)
32+
33+
if !e.HasErrorCode(err, e.ErrorCodeEntityNotFound) {
34+
t.Fatalf("DeleteWebhook doesn't returns an ErrorCodeEntityNotFound error: %v", err)
35+
}
36+
})
37+
38+
t.Run("Delete the webhook.", func(t *testing.T) {
39+
t.Log("Mocking the delete webhook API")
40+
gock.New("https://api.github.com").
41+
Delete("/repos/gitploy-io/gitploy/hooks/1").
42+
Reply(200)
43+
44+
g := NewGithub(&GithubConfig{})
45+
46+
const hookID = 1
47+
48+
err := g.DeleteWebhook(
49+
context.Background(),
50+
&ent.User{},
51+
&ent.Repo{
52+
Namespace: "gitploy-io",
53+
Name: "gitploy",
54+
},
55+
hookID,
56+
)
57+
58+
if err != nil {
59+
t.Fatalf("DeleteWebhook returns an error: %v", err)
60+
}
61+
})
62+
}

‎pkg/e/code.go‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ const (
2424
// ErrorCodeDeploymentStatusNotWaiting is the status must be 'waiting' to create a remote deployment.
2525
ErrorCodeDeploymentStatusInvalid ErrorCode = "deployment_status_invalid"
2626

27+
// ErrorCodeEntityNotFound is the entity is not found.
28+
// Entity is a resource of store or scm.
29+
ErrorCodeEntityNotFound ErrorCode = "entity_not_found"
30+
// ErrorCodeEntityUnprocessable is the entity is unprocessable.
31+
ErrorCodeEntityUnprocessable ErrorCode = "entity_unprocessable"
32+
33+
// ErrorCodeInternalError is the internal error couldn't be handled.
34+
ErrorCodeInternalError ErrorCode = "internal_error"
35+
2736
// ErrorCodeLockAlreadyExist is that the environment is already locked.
2837
ErrorCodeLockAlreadyExist ErrorCode = "lock_already_exist"
2938

@@ -32,19 +41,11 @@ const (
3241
// ErrorCodeLicenseRequired is that the license is required.
3342
ErrorCodeLicenseRequired ErrorCode = "license_required"
3443

35-
// ErrorCodeEntityNotFound is the entity is not found.
36-
ErrorCodeEntityNotFound ErrorCode = "entity_not_found"
37-
// ErrorCodeEntityUnprocessable is the entity is unprocessable.
38-
ErrorCodeEntityUnprocessable ErrorCode = "entity_unprocessable"
39-
4044
// ErrorCodeParameterInvalid is a parameter of a request is invalid.
4145
ErrorCodeParameterInvalid ErrorCode = "parameter_invalid"
4246

4347
// ErrorPermissionRequired is the permission is required to access.
4448
ErrorPermissionRequired ErrorCode = "permission_required"
45-
46-
// ErrorCodeInternalError is the internal error couldn't be handled.
47-
ErrorCodeInternalError ErrorCode = "internal_error"
4849
)
4950

5051
type (

‎pkg/e/trans.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ var messages = map[ErrorCode]string{
1111
ErrorCodeDeploymentLocked: "The environment is locked.",
1212
ErrorCodeDeploymentNotApproved: "The deployment is not approved",
1313
ErrorCodeDeploymentStatusInvalid: "The deployment status is invalid",
14+
ErrorCodeEntityNotFound: "It is not found.",
15+
ErrorCodeEntityUnprocessable: "Invalid request payload.",
16+
ErrorCodeInternalError: "Server internal error.",
1417
ErrorCodeLockAlreadyExist: "The environment is already locked",
1518
ErrorCodeLicenseDecode: "Decoding the license is failed.",
1619
ErrorCodeLicenseRequired: "The license is required.",
17-
ErrorCodeEntityNotFound: "It is not found.",
18-
ErrorCodeEntityUnprocessable: "Invalid request payload.",
1920
ErrorCodeParameterInvalid: "Invalid request parameter.",
2021
ErrorPermissionRequired: "The permission is required",
21-
ErrorCodeInternalError: "Server internal error.",
2222
}
2323

2424
func GetMessage(code ErrorCode) string {
@@ -39,14 +39,14 @@ var httpCodes = map[ErrorCode]int{
3939
ErrorCodeDeploymentLocked: http.StatusUnprocessableEntity,
4040
ErrorCodeDeploymentNotApproved: http.StatusUnprocessableEntity,
4141
ErrorCodeDeploymentStatusInvalid: http.StatusUnprocessableEntity,
42+
ErrorCodeEntityNotFound: http.StatusNotFound,
43+
ErrorCodeEntityUnprocessable: http.StatusUnprocessableEntity,
44+
ErrorCodeInternalError: http.StatusInternalServerError,
4245
ErrorCodeLockAlreadyExist: http.StatusUnprocessableEntity,
4346
ErrorCodeLicenseDecode: http.StatusUnprocessableEntity,
4447
ErrorCodeLicenseRequired: http.StatusPaymentRequired,
45-
ErrorCodeEntityNotFound: http.StatusNotFound,
46-
ErrorCodeEntityUnprocessable: http.StatusUnprocessableEntity,
4748
ErrorCodeParameterInvalid: http.StatusBadRequest,
4849
ErrorPermissionRequired: http.StatusForbidden,
49-
ErrorCodeInternalError: http.StatusInternalServerError,
5050
}
5151

5252
func GetHttpCode(code ErrorCode) int {

0 commit comments

Comments
 (0)