BlueGit

timfa bluegit

Files

bluegit / internal / store / runners.go

runners.go

runners.go 14.2 KiB Download Raw
1package store
2
3import (
4 "context"
5 "database/sql"
6 "errors"
7 "strings"
8 "time"
9)
10
11// Runner is een aparte bluegit-runner op een eigen machine, gekoppeld aan
12// een account (owner_kind user) of een groep (owner_kind group).
13type Runner struct {
14 ID int64
15 OwnerKind string
16 OwnerID int64
17 Name string
18 CreatedAt time.Time
19 LastSeen time.Time
20 Version string
21 Revoked bool
22 Paused bool
23 // Draining: de runner zelf staat lokaal op pauze (drain); lopende jobs lopen af.
24 Draining bool
25}
26
27// RunnerOnlineWindow: zo lang na de laatste heartbeat telt een runner als online.
28const RunnerOnlineWindow = 90 * time.Second
29
30// Online zegt of de runner recent contact had.
31func (r Runner) Online(now time.Time) bool {
32 return !r.Revoked && !r.LastSeen.IsZero() && now.Sub(r.LastSeen) < RunnerOnlineWindow
33}
34
35// Runner-voorkeuren van een account.
36const (
37 RunnerPrefOwnFirst = "own_first"
38 RunnerPrefBuiltinFirst = "builtin_first"
39)
40
41// ErrRegToken is een onbekend, gebruikt of verlopen registratietoken.
42var ErrRegToken = errors.New("registration token invalid or expired")
43
44// CreateRunnerRegToken maakt een eenmalig registratietoken (24 uur geldig).
45func (s *Store) CreateRunnerRegToken(ctx context.Context, ownerKind string, ownerID, by int64) (string, error) {
46 plain, err := newToken("bgrr_")
47 if err != nil {
48 return "", err
49 }
50 exp := time.Now().Add(24 * time.Hour).UTC().Format(time.RFC3339)
51 _, err = s.db.ExecContext(ctx, `INSERT INTO runner_reg_tokens (owner_kind, owner_id, token_hash, created_by, expires_at) VALUES (?, ?, ?, ?, ?)`,
52 ownerKind, ownerID, hashToken(plain), by, exp)
53 return plain, err
54}
55
56// RegisterRunner wisselt een registratietoken in voor een runner en zijn
57// eigen runner-token (bgr_). Alleen de hash wordt bewaard.
58func (s *Store) RegisterRunner(ctx context.Context, regToken, name, version string) (Runner, string, error) {
59 tx, err := s.db.BeginTx(ctx, nil)
60 if err != nil {
61 return Runner{}, "", err
62 }
63 defer func() { _ = tx.Rollback() }()
64 var id, ownerID, by int64
65 var kind, exp string
66 err = tx.QueryRowContext(ctx, `SELECT id, owner_kind, owner_id, created_by, expires_at FROM runner_reg_tokens WHERE token_hash = ? AND used = 0`, hashToken(regToken)).Scan(&id, &kind, &ownerID, &by, &exp)
67 if err != nil || parseTime(exp).Before(time.Now()) {
68 return Runner{}, "", ErrRegToken
69 }
70 if _, err := tx.ExecContext(ctx, `UPDATE runner_reg_tokens SET used = 1 WHERE id = ?`, id); err != nil {
71 return Runner{}, "", err
72 }
73 plain, err := newToken("bgr_")
74 if err != nil {
75 return Runner{}, "", err
76 }
77 name = strings.TrimSpace(name)
78 if name == "" {
79 name = "runner"
80 }
81 if len(name) > 80 {
82 name = name[:80]
83 }
84 at := now()
85 res, err := tx.ExecContext(ctx, `INSERT INTO runners (owner_kind, owner_id, name, token_hash, created_by, created_at, last_seen, version) VALUES (?, ?, ?, ?, ?, ?, ?, ?)`,
86 kind, ownerID, name, hashToken(plain), by, at, at, version)
87 if err != nil {
88 return Runner{}, "", err
89 }
90 rid, _ := res.LastInsertId()
91 if err := tx.Commit(); err != nil {
92 return Runner{}, "", err
93 }
94 return Runner{ID: rid, OwnerKind: kind, OwnerID: ownerID, Name: name, CreatedAt: parseTime(at), LastSeen: parseTime(at), Version: version}, plain, nil
95}
96
97const runnerCols = `id, owner_kind, owner_id, name, created_at, last_seen, version, revoked, paused, draining`
98
99func scanRunner(sc interface{ Scan(...any) error }) (Runner, error) {
100 var r Runner
101 var created, seen string
102 var revoked, paused, draining int
103 if err := sc.Scan(&r.ID, &r.OwnerKind, &r.OwnerID, &r.Name, &created, &seen, &r.Version, &revoked, &paused, &draining); err != nil {
104 return Runner{}, err
105 }
106 r.CreatedAt, r.LastSeen, r.Revoked, r.Paused, r.Draining = parseTime(created), parseTime(seen), revoked == 1, paused == 1, draining == 1
107 return r, nil
108}
109
110// RunnerByToken geeft de runner bij een bgr_-token. Ingetrokken telt niet.
111func (s *Store) RunnerByToken(ctx context.Context, token string) (Runner, error) {
112 if !strings.HasPrefix(token, "bgr_") {
113 return Runner{}, errNotFound
114 }
115 r, err := scanRunner(s.db.QueryRowContext(ctx, `SELECT `+runnerCols+` FROM runners WHERE token_hash = ? AND revoked = 0`, hashToken(token)))
116 if errors.Is(err, sql.ErrNoRows) {
117 return Runner{}, errNotFound
118 }
119 return r, err
120}
121
122// RunnerByID geeft één runner.
123func (s *Store) RunnerByID(ctx context.Context, id int64) (Runner, error) {
124 r, err := scanRunner(s.db.QueryRowContext(ctx, `SELECT `+runnerCols+` FROM runners WHERE id = ?`, id))
125 if errors.Is(err, sql.ErrNoRows) {
126 return Runner{}, errNotFound
127 }
128 return r, err
129}
130
131// TouchRunner is de heartbeat.
132func (s *Store) TouchRunner(ctx context.Context, id int64, version string) error {
133 _, err := s.db.ExecContext(ctx, `UPDATE runners SET last_seen = ?, version = CASE WHEN ? = '' THEN version ELSE ? END WHERE id = ?`, now(), version, version, id)
134 return err
135}
136
137// SetRunnerDraining slaat de lokale pauze van de runner op (uit de heartbeat).
138func (s *Store) SetRunnerDraining(ctx context.Context, id int64, draining bool) error {
139 v := 0
140 if draining {
141 v = 1
142 }
143 _, err := s.db.ExecContext(ctx, `UPDATE runners SET draining = ? WHERE id = ?`, v, id)
144 return err
145}
146
147// ListRunners geeft de niet-ingetrokken runners van een eigenaar.
148func (s *Store) ListRunners(ctx context.Context, ownerKind string, ownerID int64) ([]Runner, error) {
149 rows, err := s.db.QueryContext(ctx, `SELECT `+runnerCols+` FROM runners WHERE owner_kind = ? AND owner_id = ? AND revoked = 0 ORDER BY id`, ownerKind, ownerID)
150 if err != nil {
151 return nil, err
152 }
153 defer rows.Close()
154 var out []Runner
155 for rows.Next() {
156 r, err := scanRunner(rows)
157 if err != nil {
158 return nil, err
159 }
160 out = append(out, r)
161 }
162 return out, rows.Err()
163}
164
165// RevokeRunner trekt een runner in; zijn token werkt daarna niet meer.
166func (s *Store) RevokeRunner(ctx context.Context, ownerKind string, ownerID, id int64) error {
167 res, err := s.db.ExecContext(ctx, `UPDATE runners SET revoked = 1 WHERE id = ? AND owner_kind = ? AND owner_id = ?`, id, ownerKind, ownerID)
168 if err != nil {
169 return err
170 }
171 if n, _ := res.RowsAffected(); n == 0 {
172 return errNotFound
173 }
174 return nil
175}
176
177// UserRunnerPref is own_first of builtin_first.
178func (s *Store) UserRunnerPref(ctx context.Context, userID int64) string {
179 var p string
180 if err := s.db.QueryRowContext(ctx, `SELECT runner_pref FROM users WHERE id = ?`, userID).Scan(&p); err != nil || p != RunnerPrefOwnFirst {
181 return RunnerPrefBuiltinFirst
182 }
183 return p
184}
185
186// SetUserRunnerPref bewaart de voorkeur.
187func (s *Store) SetUserRunnerPref(ctx context.Context, userID int64, pref string) error {
188 if pref != RunnerPrefOwnFirst {
189 pref = RunnerPrefBuiltinFirst
190 }
191 _, err := s.db.ExecContext(ctx, `UPDATE users SET runner_pref = ? WHERE id = ?`, pref, userID)
192 return err
193}
194
195// GroupBuiltinFirst: "Probeer BlueGit runner eerst".
196func (s *Store) GroupBuiltinFirst(ctx context.Context, groupID int64) bool {
197 var v int
198 _ = s.db.QueryRowContext(ctx, `SELECT builtin_first FROM groups WHERE id = ?`, groupID).Scan(&v)
199 return v == 1
200}
201
202// SetGroupBuiltinFirst zet de groepsinstelling.
203func (s *Store) SetGroupBuiltinFirst(ctx context.Context, groupID int64, on bool) error {
204 v := 0
205 if on {
206 v = 1
207 }
208 _, err := s.db.ExecContext(ctx, `UPDATE groups SET builtin_first = ? WHERE id = ?`, v, groupID)
209 return err
210}
211
212// SetRunnerOptIn: maintainer userID staat zijn account-runners toe voor de groep.
213func (s *Store) SetRunnerOptIn(ctx context.Context, groupID, userID int64, on bool) error {
214 if on {
215 _, err := s.db.ExecContext(ctx, `INSERT OR IGNORE INTO group_runner_optin (group_id, user_id) VALUES (?, ?)`, groupID, userID)
216 return err
217 }
218 _, err := s.db.ExecContext(ctx, `DELETE FROM group_runner_optin WHERE group_id = ? AND user_id = ?`, groupID, userID)
219 return err
220}
221
222// RunnerOptIns zijn de gebruikers die hun runners voor de groep toestaan.
223func (s *Store) RunnerOptIns(ctx context.Context, groupID int64) ([]int64, error) {
224 rows, err := s.db.QueryContext(ctx, `SELECT user_id FROM group_runner_optin WHERE group_id = ? ORDER BY user_id`, groupID)
225 if err != nil {
226 return nil, err
227 }
228 defer rows.Close()
229 var out []int64
230 for rows.Next() {
231 var id int64
232 if err := rows.Scan(&id); err != nil {
233 return nil, err
234 }
235 out = append(out, id)
236 }
237 return out, rows.Err()
238}
239
240// JobRun is de runner-administratie van één job.
241type JobRun struct {
242 RunnerID int64
243 RunnerName string
244 OfferTier int
245 OfferAt time.Time
246}
247
248// JobRun leest de administratie; een lege JobRun als er niets is.
249func (s *Store) JobRun(ctx context.Context, jobID int64) JobRun {
250 var jr JobRun
251 var at string
252 if err := s.db.QueryRowContext(ctx, `SELECT runner_id, runner_name, offer_tier, offer_at FROM job_runs WHERE job_id = ?`, jobID).Scan(&jr.RunnerID, &jr.RunnerName, &jr.OfferTier, &at); err != nil {
253 return JobRun{}
254 }
255 jr.OfferAt = parseTime(at)
256 return jr
257}
258
259// SetJobOffer zet de huidige trede in de runnervolgorde.
260func (s *Store) SetJobOffer(ctx context.Context, jobID int64, tier int, at time.Time) error {
261 _, err := s.db.ExecContext(ctx, `INSERT INTO job_runs (job_id, offer_tier, offer_at) VALUES (?, ?, ?)
262 ON CONFLICT(job_id) DO UPDATE SET offer_tier = excluded.offer_tier, offer_at = excluded.offer_at`, jobID, tier, at.UTC().Format(time.RFC3339Nano))
263 return err
264}
265
266// ClearJobOffer haalt het aanbod weg (bijvoorbeeld bij een retry).
267func (s *Store) ClearJobOffer(ctx context.Context, jobID int64) error {
268 _, err := s.db.ExecContext(ctx, `UPDATE job_runs SET offer_at = '', offer_tier = 0 WHERE job_id = ?`, jobID)
269 return err
270}
271
272// SetJobRunner noteert wie de job draait.
273func (s *Store) SetJobRunner(ctx context.Context, jobID, runnerID int64, name string) error {
274 _, err := s.db.ExecContext(ctx, `INSERT INTO job_runs (job_id, runner_id, runner_name) VALUES (?, ?, ?)
275 ON CONFLICT(job_id) DO UPDATE SET runner_id = excluded.runner_id, runner_name = excluded.runner_name`, jobID, runnerID, name)
276 return err
277}
278
279// OfferedJobs zijn wachtende jobs met een actief aanbod.
280func (s *Store) OfferedJobs(ctx context.Context) ([]Job, map[int64]JobRun, error) {
281 rows, err := s.db.QueryContext(ctx, jobSelect+` JOIN job_runs r ON r.job_id = j.id WHERE j.status = 'queued' AND r.offer_at != '' ORDER BY j.id`)
282 if err != nil {
283 return nil, nil, err
284 }
285 var out []Job
286 for rows.Next() {
287 j, err := scanJob(rows)
288 if err != nil {
289 rows.Close()
290 return nil, nil, err
291 }
292 out = append(out, j)
293 }
294 rows.Close()
295 runs := map[int64]JobRun{}
296 for _, j := range out {
297 runs[j.ID] = s.JobRun(ctx, j.ID)
298 }
299 return out, runs, nil
300}
301
302// ClaimJob zet een wachtende job op running voor een runner. false als
303// iemand anders hem al had.
304func (s *Store) ClaimJob(ctx context.Context, jobID, runnerID int64, name string) (bool, error) {
305 ok, err := s.MarkJobRunning(ctx, jobID)
306 if err != nil || !ok {
307 return false, err
308 }
309 if err := s.SetJobRunner(ctx, jobID, runnerID, name); err != nil {
310 return true, err
311 }
312 _, err = s.db.ExecContext(ctx, `UPDATE job_runs SET offer_at = '' WHERE job_id = ?`, jobID)
313 return true, err
314}
315
316// RemoteJob is een lopende job op een aparte runner.
317type RemoteJob struct {
318 Job Job
319 RunnerID int64
320}
321
322// RemoteRunningJobs geeft lopende jobs die een aparte runner heeft.
323func (s *Store) RemoteRunningJobs(ctx context.Context) ([]RemoteJob, error) {
324 rows, err := s.db.QueryContext(ctx, jobSelect+` JOIN job_runs r ON r.job_id = j.id WHERE j.status = 'running' AND r.runner_id > 0 ORDER BY j.id`)
325 if err != nil {
326 return nil, err
327 }
328 var out []RemoteJob
329 for rows.Next() {
330 j, err := scanJob(rows)
331 if err != nil {
332 rows.Close()
333 return nil, err
334 }
335 out = append(out, RemoteJob{Job: j})
336 }
337 rows.Close()
338 for i := range out {
339 out[i].RunnerID = s.JobRun(ctx, out[i].Job.ID).RunnerID
340 }
341 return out, nil
342}
343
344// JobForRunner geeft een job als die bij runnerID hoort (en loopt of net klaar is).
345func (s *Store) JobForRunner(ctx context.Context, runnerID, jobID int64) (Job, error) {
346 if s.JobRun(ctx, jobID).RunnerID != runnerID || runnerID == 0 {
347 return Job{}, errNotFound
348 }
349 rows, err := s.db.QueryContext(ctx, jobSelect+` WHERE j.id = ?`, jobID)
350 if err != nil {
351 return Job{}, err
352 }
353 defer rows.Close()
354 if !rows.Next() {
355 return Job{}, errNotFound
356 }
357 return scanJob(rows)
358}
359
360// RunnerRunsRepo zegt of de runner nu een job van de repo draait.
361func (s *Store) RunnerRunsRepo(ctx context.Context, runnerID, repoID int64) bool {
362 var n int
363 _ = s.db.QueryRowContext(ctx, `SELECT COUNT(*) FROM jobs j JOIN job_runs r ON r.job_id = j.id WHERE r.runner_id = ? AND j.repo_id = ? AND j.status = 'running'`, runnerID, repoID).Scan(&n)
364 return n > 0 && runnerID > 0
365}
366
367// UpdateRunner hernoemt en/of pauzeert een runner van deze eigenaar.
368func (s *Store) UpdateRunner(ctx context.Context, ownerKind string, ownerID, id int64, name *string, paused *bool) (Runner, error) {
369 r, err := s.RunnerByID(ctx, id)
370 if err != nil || r.Revoked || r.OwnerKind != ownerKind || r.OwnerID != ownerID {
371 return Runner{}, errNotFound
372 }
373 if name != nil {
374 n := strings.TrimSpace(*name)
375 if n == "" || len(n) > 80 {
376 return Runner{}, errors.New("runner name must be 1-80 characters")
377 }
378 if _, err := s.db.ExecContext(ctx, `UPDATE runners SET name = ? WHERE id = ?`, n, id); err != nil {
379 return Runner{}, err
380 }
381 }
382 if paused != nil {
383 v := 0
384 if *paused {
385 v = 1
386 }
387 if _, err := s.db.ExecContext(ctx, `UPDATE runners SET paused = ? WHERE id = ?`, v, id); err != nil {
388 return Runner{}, err
389 }
390 }
391 return s.RunnerByID(ctx, id)
392}
393
394// RunnerJob is een recente job van een runner.
395type RunnerJob struct {
396 JobID int64
397 PipelineID int64
398 RepoID int64
399 Name string
400 Status string
401 StartedAt time.Time
402 FinishedAt time.Time
403}
404
405// RunnerJobs geeft de recentste jobs van een runner.
406func (s *Store) RunnerJobs(ctx context.Context, runnerID int64, limit int) ([]RunnerJob, error) {
407 if limit <= 0 || limit > 100 {
408 limit = 20
409 }
410 rows, err := s.db.QueryContext(ctx, `SELECT j.id, j.pipeline_id, j.repo_id, j.name, j.status, COALESCE(j.started_at, ''), COALESCE(j.finished_at, '')
411 FROM job_runs r JOIN jobs j ON j.id = r.job_id WHERE r.runner_id = ? ORDER BY j.id DESC LIMIT ?`, runnerID, limit)
412 if err != nil {
413 return nil, err
414 }
415 defer rows.Close()
416 var out []RunnerJob
417 for rows.Next() {
418 var j RunnerJob
419 var st, fin string
420 if err := rows.Scan(&j.JobID, &j.PipelineID, &j.RepoID, &j.Name, &j.Status, &st, &fin); err != nil {
421 return nil, err
422 }
423 j.StartedAt, j.FinishedAt = parseTime(st), parseTime(fin)
424 out = append(out, j)
425 }
426 return out, rows.Err()
427}