-
Notifications
You must be signed in to change notification settings - Fork 0
/
handler.go
355 lines (297 loc) · 10.4 KB
/
handler.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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
// Copyright Project Harbor 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 (
"encoding/json"
"io/ioutil"
"net/http"
"os"
"strings"
"github.com/gorilla/mux"
"fmt"
"github.com/goharbor/harbor/src/jobservice/common/query"
"github.com/goharbor/harbor/src/jobservice/common/utils"
"github.com/goharbor/harbor/src/jobservice/core"
"github.com/goharbor/harbor/src/jobservice/errs"
"github.com/goharbor/harbor/src/jobservice/job"
"github.com/goharbor/harbor/src/jobservice/logger"
"github.com/pkg/errors"
"strconv"
)
const (
totalHeaderKey = "Total-Count"
nextCursorKey = "Next-Cursor"
)
// Handler defines approaches to handle the http requests.
type Handler interface {
// HandleLaunchJobReq is used to handle the job submission request.
HandleLaunchJobReq(w http.ResponseWriter, req *http.Request)
// HandleGetJobReq is used to handle the job stats query request.
HandleGetJobReq(w http.ResponseWriter, req *http.Request)
// HandleJobActionReq is used to handle the job action requests (stop/retry).
HandleJobActionReq(w http.ResponseWriter, req *http.Request)
// HandleCheckStatusReq is used to handle the job service healthy status checking request.
HandleCheckStatusReq(w http.ResponseWriter, req *http.Request)
// HandleJobLogReq is used to handle the request of getting job logs
HandleJobLogReq(w http.ResponseWriter, req *http.Request)
// HandleJobLogReq is used to handle the request of getting periodic executions
HandlePeriodicExecutions(w http.ResponseWriter, req *http.Request)
// HandleGetJobsReq is used to handle the request of getting jobs
HandleGetJobsReq(w http.ResponseWriter, req *http.Request)
}
// DefaultHandler is the default request handler which implements the Handler interface.
type DefaultHandler struct {
controller core.Interface
}
// NewDefaultHandler is constructor of DefaultHandler.
func NewDefaultHandler(ctl core.Interface) *DefaultHandler {
return &DefaultHandler{
controller: ctl,
}
}
// HandleLaunchJobReq is implementation of method defined in interface 'Handler'
func (dh *DefaultHandler) HandleLaunchJobReq(w http.ResponseWriter, req *http.Request) {
data, err := ioutil.ReadAll(req.Body)
if err != nil {
dh.handleError(w, req, http.StatusInternalServerError, errs.ReadRequestBodyError(err))
return
}
// unmarshal data
jobReq := &job.Request{}
if err = json.Unmarshal(data, jobReq); err != nil {
dh.handleError(w, req, http.StatusInternalServerError, errs.HandleJSONDataError(err))
return
}
// Pass request to the controller for the follow-up.
jobStats, err := dh.controller.LaunchJob(jobReq)
if err != nil {
code := http.StatusInternalServerError
if errs.IsBadRequestError(err) {
// Bad request
code = http.StatusBadRequest
} else if errs.IsConflictError(err) {
// Conflict error
code = http.StatusConflict
} else {
// General error
err = errs.LaunchJobError(err)
}
dh.handleError(w, req, code, err)
return
}
dh.handleJSONData(w, req, http.StatusAccepted, jobStats)
}
// HandleGetJobReq is implementation of method defined in interface 'Handler'
func (dh *DefaultHandler) HandleGetJobReq(w http.ResponseWriter, req *http.Request) {
vars := mux.Vars(req)
jobID := vars["job_id"]
jobStats, err := dh.controller.GetJob(jobID)
if err != nil {
code := http.StatusInternalServerError
if errs.IsObjectNotFoundError(err) {
code = http.StatusNotFound
} else if errs.IsBadRequestError(err) {
code = http.StatusBadRequest
} else {
err = errs.GetJobStatsError(err)
}
dh.handleError(w, req, code, err)
return
}
dh.handleJSONData(w, req, http.StatusOK, jobStats)
}
// HandleJobActionReq is implementation of method defined in interface 'Handler'
func (dh *DefaultHandler) HandleJobActionReq(w http.ResponseWriter, req *http.Request) {
vars := mux.Vars(req)
jobID := vars["job_id"]
data, err := ioutil.ReadAll(req.Body)
if err != nil {
dh.handleError(w, req, http.StatusInternalServerError, errs.ReadRequestBodyError(err))
return
}
// unmarshal data
jobActionReq := &job.ActionRequest{}
if err = json.Unmarshal(data, jobActionReq); err != nil {
dh.handleError(w, req, http.StatusInternalServerError, errs.HandleJSONDataError(err))
return
}
// Only support stop command now
cmd := job.OPCommand(jobActionReq.Action)
if !cmd.IsStop() {
dh.handleError(w, req, http.StatusNotImplemented, errs.UnknownActionNameError(errors.Errorf("command: %s", jobActionReq.Action)))
return
}
// Stop job
if err := dh.controller.StopJob(jobID); err != nil {
code := http.StatusInternalServerError
if errs.IsObjectNotFoundError(err) {
code = http.StatusNotFound
} else if errs.IsBadRequestError(err) {
code = http.StatusBadRequest
} else {
err = errs.StopJobError(err)
}
dh.handleError(w, req, code, err)
return
}
dh.log(req, http.StatusNoContent, string(data))
w.WriteHeader(http.StatusNoContent) // only header, no content returned
}
// HandleCheckStatusReq is implementation of method defined in interface 'Handler'
func (dh *DefaultHandler) HandleCheckStatusReq(w http.ResponseWriter, req *http.Request) {
stats, err := dh.controller.CheckStatus()
if err != nil {
dh.handleError(w, req, http.StatusInternalServerError, errs.CheckStatsError(err))
return
}
dh.handleJSONData(w, req, http.StatusOK, stats)
}
// HandleJobLogReq is implementation of method defined in interface 'Handler'
func (dh *DefaultHandler) HandleJobLogReq(w http.ResponseWriter, req *http.Request) {
vars := mux.Vars(req)
jobID := vars["job_id"]
if strings.Contains(jobID, "..") || strings.ContainsRune(jobID, os.PathSeparator) {
dh.handleError(w, req, http.StatusBadRequest, errors.Errorf("invalid Job ID: %s", jobID))
return
}
logData, err := dh.controller.GetJobLogData(jobID)
if err != nil {
code := http.StatusInternalServerError
if errs.IsObjectNotFoundError(err) {
code = http.StatusNotFound
} else if errs.IsBadRequestError(err) {
code = http.StatusBadRequest
} else {
err = errs.GetJobLogError(err)
}
dh.handleError(w, req, code, err)
return
}
dh.log(req, http.StatusOK, "")
w.WriteHeader(http.StatusOK)
writeDate(w, logData)
}
// HandlePeriodicExecutions is implementation of method defined in interface 'Handler'
func (dh *DefaultHandler) HandlePeriodicExecutions(w http.ResponseWriter, req *http.Request) {
// Get param
vars := mux.Vars(req)
jobID := vars["job_id"]
// Get query params
q := extractQuery(req)
executions, total, err := dh.controller.GetPeriodicExecutions(jobID, q)
if err != nil {
code := http.StatusInternalServerError
if errs.IsObjectNotFoundError(err) {
code = http.StatusNotFound
} else if errs.IsBadRequestError(err) {
code = http.StatusBadRequest
} else {
err = errs.GetPeriodicExecutionError(err)
}
dh.handleError(w, req, code, err)
return
}
w.Header().Add(totalHeaderKey, fmt.Sprintf("%d", total))
dh.handleJSONData(w, req, http.StatusOK, executions)
}
// HandleGetJobsReq is implementation of method defined in interface 'Handler'
func (dh *DefaultHandler) HandleGetJobsReq(w http.ResponseWriter, req *http.Request) {
// Get query parameters
q := extractQuery(req)
jobs, total, err := dh.controller.GetJobs(q)
if err != nil {
dh.handleError(w, req, http.StatusInternalServerError, errs.GetJobsError(q, err))
return
}
key := nextCursorKey
if v, ok := q.Extras.Get(query.ExtraParamKeyKind); ok {
if kind, yes := v.(string); yes && kind == job.KindScheduled {
key = totalHeaderKey
}
}
w.Header().Add(key, fmt.Sprintf("%d", total))
dh.handleJSONData(w, req, http.StatusOK, jobs)
}
func (dh *DefaultHandler) handleJSONData(w http.ResponseWriter, req *http.Request, code int, object interface{}) {
data, err := json.Marshal(object)
if err != nil {
dh.handleError(w, req, http.StatusInternalServerError, errs.HandleJSONDataError(err))
return
}
logger.Debugf("Serve http request '%s %s': %d %s", req.Method, req.URL.String(), code, data)
w.Header().Set(http.CanonicalHeaderKey("Accept"), "application/json")
w.Header().Set(http.CanonicalHeaderKey("content-type"), "application/json")
w.WriteHeader(code)
writeDate(w, data)
}
func (dh *DefaultHandler) handleError(w http.ResponseWriter, req *http.Request, code int, err error) {
// Log all errors
logger.Errorf("Serve http request '%s %s' error: %d %s", req.Method, req.URL.String(), code, err.Error())
w.WriteHeader(code)
writeDate(w, []byte(err.Error()))
}
func (dh *DefaultHandler) log(req *http.Request, code int, text string) {
logger.Debugf("Serve http request '%s %s': %d %s", req.Method, req.URL.String(), code, text)
}
func extractQuery(req *http.Request) *query.Parameter {
q := &query.Parameter{
PageNumber: 1,
PageSize: query.DefaultPageSize,
Extras: make(query.ExtraParameters),
}
queries := req.URL.Query()
// Page number
p := queries.Get(query.ParamKeyPage)
if !utils.IsEmptyStr(p) {
if pv, err := strconv.ParseUint(p, 10, 32); err == nil {
if pv > 1 {
q.PageNumber = uint(pv)
}
}
}
// Page number
size := queries.Get(query.ParamKeyPageSize)
if !utils.IsEmptyStr(size) {
if pz, err := strconv.ParseUint(size, 10, 32); err == nil {
if pz > 0 {
q.PageSize = uint(pz)
}
}
}
// Extra query parameters
nonStoppedOnly := queries.Get(query.ParamKeyNonStoppedOnly)
if !utils.IsEmptyStr(nonStoppedOnly) {
if nonStoppedOnlyV, err := strconv.ParseBool(nonStoppedOnly); err == nil {
q.Extras.Set(query.ExtraParamKeyNonStoppedOnly, nonStoppedOnlyV)
}
}
// Extra job kind query param
jobKind := queries.Get(query.ParamKeyJobKind)
if !utils.IsEmptyStr(jobKind) {
q.Extras.Set(query.ExtraParamKeyKind, jobKind)
}
// Extra query cursor
cursorV := queries.Get(query.ParamKeyCursor)
if !utils.IsEmptyStr(cursorV) {
if cursor, err := strconv.ParseInt(cursorV, 10, 32); err == nil {
q.Extras.Set(query.ExtraParamKeyCursor, cursor)
}
}
return q
}
func writeDate(w http.ResponseWriter, bytes []byte) {
if _, err := w.Write(bytes); err != nil {
logger.Errorf("writer write error: %s", err)
}
}