-
Notifications
You must be signed in to change notification settings - Fork 28
/
base_controller.go
239 lines (206 loc) · 6.88 KB
/
base_controller.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/*
* Copyright 2018 The Service Manager Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package api
import (
"context"
"fmt"
"net/http"
"time"
"github.com/tidwall/sjson"
"github.com/gofrs/uuid"
"github.com/Peripli/service-manager/storage"
"github.com/Peripli/service-manager/pkg/log"
"github.com/Peripli/service-manager/pkg/query"
"github.com/Peripli/service-manager/pkg/types"
"github.com/Peripli/service-manager/pkg/util"
"github.com/Peripli/service-manager/pkg/web"
)
const PathParamID = "id"
// BaseController provides common CRUD handlers for all object types in the service manager
type BaseController struct {
resourceBaseURL string
objectType types.ObjectType
repository storage.Repository
objectBlueprint func() types.Object
}
// NewController returns a new base controller
func NewController(repository storage.Repository, resourceBaseURL string, objectType types.ObjectType, objectBlueprint func() types.Object) *BaseController {
return &BaseController{
repository: repository,
resourceBaseURL: resourceBaseURL,
objectBlueprint: objectBlueprint,
objectType: objectType,
}
}
// Routes returns the common set of routes for all objects
func (c *BaseController) Routes() []web.Route {
return []web.Route{
{
Endpoint: web.Endpoint{
Method: http.MethodPost,
Path: c.resourceBaseURL,
},
Handler: c.CreateObject,
},
{
Endpoint: web.Endpoint{
Method: http.MethodGet,
Path: fmt.Sprintf("%s/{%s}", c.resourceBaseURL, PathParamID),
},
Handler: c.GetSingleObject,
},
{
Endpoint: web.Endpoint{
Method: http.MethodGet,
Path: c.resourceBaseURL,
},
Handler: c.ListObjects,
},
{
Endpoint: web.Endpoint{
Method: http.MethodDelete,
Path: c.resourceBaseURL,
},
Handler: c.DeleteObjects,
},
{
Endpoint: web.Endpoint{
Method: http.MethodDelete,
Path: fmt.Sprintf("%s/{%s}", c.resourceBaseURL, PathParamID),
},
Handler: c.DeleteSingleObject,
},
{
Endpoint: web.Endpoint{
Method: http.MethodPatch,
Path: fmt.Sprintf("%s/{%s}", c.resourceBaseURL, PathParamID),
},
Handler: c.PatchObject,
},
}
}
// CreateObject handles the creation of a new object
func (c *BaseController) CreateObject(r *web.Request) (*web.Response, error) {
ctx := r.Context()
log.C(ctx).Debugf("Creating new %s", c.objectType)
result := c.objectBlueprint()
if err := util.BytesToObject(r.Body, result); err != nil {
return nil, err
}
if result.GetID() == "" {
UUID, err := uuid.NewV4()
if err != nil {
return nil, fmt.Errorf("could not generate GUID for %s: %s", c.objectType, err)
}
result.SetID(UUID.String())
}
currentTime := time.Now().UTC()
result.SetCreatedAt(currentTime)
result.SetUpdatedAt(currentTime)
id, err := c.repository.Create(ctx, result)
if err != nil {
return nil, util.HandleStorageError(err, string(c.objectType))
}
result.SetID(id)
return util.NewJSONResponse(http.StatusCreated, result)
}
// DeleteObjects handles the deletion of the objects specified in the request
func (c *BaseController) DeleteObjects(r *web.Request) (*web.Response, error) {
ctx := r.Context()
log.C(ctx).Debugf("Deleting %ss...", c.objectType)
criteria := query.CriteriaForContext(ctx)
if _, err := c.repository.Delete(ctx, c.objectType, criteria...); err != nil {
return nil, util.HandleStorageError(err, string(c.objectType))
}
return util.NewJSONResponse(http.StatusOK, map[string]string{})
}
// DeleteSingleObject handles the deletion of the object with the id specified in the request
func (c *BaseController) DeleteSingleObject(r *web.Request) (*web.Response, error) {
objectID := r.PathParams[PathParamID]
ctx := r.Context()
log.C(ctx).Debugf("Deleting %s with id %s", c.objectType, objectID)
byID := query.ByField(query.EqualsOperator, "id", objectID)
ctx, err := query.AddCriteria(ctx, byID)
if err != nil {
return nil, err
}
r.Request = r.WithContext(ctx)
return c.DeleteObjects(r)
}
// GetSingleObject handles the fetching of a single object with the id specified in the request
func (c *BaseController) GetSingleObject(r *web.Request) (*web.Response, error) {
objectID := r.PathParams[PathParamID]
ctx := r.Context()
log.C(ctx).Debugf("Getting %s with id %s", c.objectType, objectID)
object, err := c.repository.Get(ctx, c.objectType, objectID)
if err != nil {
return nil, util.HandleStorageError(err, string(c.objectType))
}
stripCredentials(ctx, object)
return util.NewJSONResponse(http.StatusOK, object)
}
// ListObjects handles the fetching of all objects
func (c *BaseController) ListObjects(r *web.Request) (*web.Response, error) {
ctx := r.Context()
log.C(ctx).Debugf("Getting all %ss", c.objectType)
objectList, err := c.repository.List(ctx, c.objectType, query.CriteriaForContext(ctx)...)
if err != nil {
return nil, util.HandleStorageError(err, string(c.objectType))
}
for i := 0; i < objectList.Len(); i++ {
obj := objectList.ItemAt(i)
stripCredentials(ctx, obj)
}
return util.NewJSONResponse(http.StatusOK, objectList)
}
// PatchObject handles the update of the object with the id specified in the request
func (c *BaseController) PatchObject(r *web.Request) (*web.Response, error) {
objectID := r.PathParams[PathParamID]
ctx := r.Context()
log.C(ctx).Debugf("Updating %s with id %s", c.objectType, objectID)
labelChanges, err := query.LabelChangesFromJSON(r.Body)
if err != nil {
return nil, err
}
if r.Body, err = sjson.DeleteBytes(r.Body, "labels"); err != nil {
return nil, err
}
objFromDB, err := c.repository.Get(ctx, c.objectType, objectID)
if err != nil {
return nil, util.HandleStorageError(err, string(c.objectType))
}
createdAt := objFromDB.GetCreatedAt()
updatedAt := objFromDB.GetUpdatedAt()
if err := util.BytesToObject(r.Body, objFromDB); err != nil {
return nil, err
}
objFromDB.SetID(objectID)
objFromDB.SetCreatedAt(createdAt)
objFromDB.SetUpdatedAt(updatedAt)
object, err := c.repository.Update(ctx, objFromDB, labelChanges...)
if err != nil {
return nil, util.HandleStorageError(err, string(c.objectType))
}
stripCredentials(ctx, object)
return util.NewJSONResponse(http.StatusOK, object)
}
func stripCredentials(ctx context.Context, object types.Object) {
if secured, ok := object.(types.Secured); ok {
secured.SetCredentials(nil)
} else {
log.C(ctx).Debugf("Object of type %s with id %s is not secured, so no credentials are cleaned up on response", object.GetType(), object.GetID())
}
}