willow.sh
forked from
tangled.org/core
Monorepo for Tangled
27 kB
929 lines
1package spindle
2
3import (
4 "context"
5 "database/sql"
6 _ "embed"
7 "encoding/json"
8 "errors"
9 "fmt"
10 "log/slog"
11 "maps"
12 "net/http"
13 "path/filepath"
14 "sync"
15 "time"
16
17 "github.com/bluesky-social/indigo/atproto/syntax"
18 indigoxrpc "github.com/bluesky-social/indigo/xrpc"
19 "github.com/go-chi/chi/v5"
20 "github.com/go-git/go-git/v5/plumbing/object"
21 "github.com/hashicorp/go-version"
22 "tangled.org/core/api/tangled"
23 "tangled.org/core/eventconsumer"
24 "tangled.org/core/eventconsumer/cursor"
25 "tangled.org/core/eventstream"
26 "tangled.org/core/idresolver"
27 "tangled.org/core/jetstream"
28 knotdb "tangled.org/core/knotserver/db"
29 kgit "tangled.org/core/knotserver/git"
30 "tangled.org/core/log"
31 "tangled.org/core/notifier"
32 "tangled.org/core/rbac"
33 "tangled.org/core/repoident"
34 "tangled.org/core/repoverify"
35 "tangled.org/core/spindle/config"
36 "tangled.org/core/spindle/db"
37 "tangled.org/core/spindle/engine"
38 "tangled.org/core/spindle/engines/dummy"
39 "tangled.org/core/spindle/engines/microvm"
40 "tangled.org/core/spindle/engines/nixery"
41 "tangled.org/core/spindle/git"
42 "tangled.org/core/spindle/models"
43 "tangled.org/core/spindle/queue"
44 "tangled.org/core/spindle/secrets"
45 "tangled.org/core/spindle/xrpc"
46 "tangled.org/core/tid"
47 "tangled.org/core/workflow"
48 "tangled.org/core/xrpc/serviceauth"
49)
50
51//go:embed motd
52var defaultMotd []byte
53
54const (
55 rbacDomain = "thisserver"
56)
57
58type Spindle struct {
59 jc *jetstream.JetstreamClient
60 tap *Tap
61 embedTap *embeddedTap
62 db *db.DB
63 e *rbac.Enforcer
64 l *slog.Logger
65 n *notifier.Notifier
66 engs map[string]models.Engine
67 jq *queue.Queue
68 cfg *config.Config
69 ks *eventconsumer.Consumer
70 res *idresolver.Resolver
71 verify repoverify.Verifier
72 vault secrets.Manager
73 motd []byte
74 motdMu sync.RWMutex
75 rootCtx context.Context
76}
77
78// New creates a new Spindle server with the provided configuration and engines.
79func New(ctx context.Context, cfg *config.Config, d *db.DB, engines map[string]models.Engine) (*Spindle, error) {
80 logger := log.FromContext(ctx)
81
82 e, err := rbac.NewEnforcer(cfg.Server.DBPath)
83 if err != nil {
84 return nil, fmt.Errorf("failed to setup rbac enforcer: %w", err)
85 }
86 e.E.EnableAutoSave(true)
87
88 n := notifier.New()
89
90 var vault secrets.Manager
91 switch cfg.Server.Secrets.Provider {
92 case "openbao":
93 if cfg.Server.Secrets.OpenBao.ProxyAddr == "" {
94 return nil, fmt.Errorf("openbao proxy address is required when using openbao secrets provider")
95 }
96 vault, err = secrets.NewOpenBaoManager(
97 cfg.Server.Secrets.OpenBao.ProxyAddr,
98 logger,
99 secrets.WithMountPath(cfg.Server.Secrets.OpenBao.Mount),
100 )
101 if err != nil {
102 return nil, fmt.Errorf("failed to setup openbao secrets provider: %w", err)
103 }
104 logger.Info("using openbao secrets provider", "proxy_address", cfg.Server.Secrets.OpenBao.ProxyAddr, "mount", cfg.Server.Secrets.OpenBao.Mount)
105 case "sqlite", "":
106 vault, err = secrets.NewSQLiteManager(cfg.Server.DBPath, secrets.WithTableName("secrets"))
107 if err != nil {
108 return nil, fmt.Errorf("failed to setup sqlite secrets provider: %w", err)
109 }
110 logger.Info("using sqlite secrets provider", "path", cfg.Server.DBPath)
111 default:
112 return nil, fmt.Errorf("unknown secrets provider: %s", cfg.Server.Secrets.Provider)
113 }
114
115 if err := runStartupMigrations(ctx, d, cfg.Server.Tap.Embed, cfg.Server.Tap.DBPath, logger); err != nil {
116 return nil, fmt.Errorf("failed to run startup migrations: %w", err)
117 }
118
119 jq := queue.NewQueue(cfg.Server.QueueSize, cfg.Server.MaxJobCount)
120 logger.Info("initialized queue", "queueSize", cfg.Server.QueueSize, "numWorkers", cfg.Server.MaxJobCount)
121
122 collections := []string{
123 tangled.SpindleMemberNSID,
124 tangled.RepoNSID,
125 tangled.RepoCollaboratorNSID,
126 tangled.RepoPullNSID,
127 }
128 jc, err := jetstream.NewJetstreamClient(cfg.Server.JetstreamEndpoint, "spindle", collections, nil, log.SubLogger(logger, "jetstream"), d, true, true)
129 if err != nil {
130 return nil, fmt.Errorf("failed to setup jetstream client: %w", err)
131 }
132 jc.AddDid(cfg.Server.Owner)
133 // pull records are created by arbitrary users too, same hack as in tap
134 jc.ExemptCollection(tangled.RepoPullNSID)
135
136 // Check if the spindle knows about any Dids;
137 dids, err := d.GetAllDids()
138 if err != nil {
139 return nil, fmt.Errorf("failed to get all dids: %w", err)
140 }
141 for _, d := range dids {
142 jc.AddDid(d)
143 }
144
145 knownRepos, err := d.AllRepos()
146 if err != nil {
147 return nil, fmt.Errorf("failed to get known repos: %w", err)
148 }
149 for _, r := range knownRepos {
150 if r.Owner != "" {
151 jc.AddDid(r.Owner.String())
152 }
153 }
154
155 resolver := idresolver.DefaultResolver(cfg.Server.PlcUrl)
156
157 spindle := &Spindle{
158 jc: jc,
159 e: e,
160 db: d,
161 l: logger,
162 n: &n,
163 engs: engines,
164 jq: jq,
165 cfg: cfg,
166 res: resolver,
167 verify: repoverify.New(resolver, cfg.Server.Dev),
168 vault: vault,
169 motd: defaultMotd,
170 rootCtx: ctx,
171 }
172
173 err = e.AddSpindle(rbacDomain)
174 if err != nil {
175 return nil, fmt.Errorf("failed to set rbac domain: %w", err)
176 }
177 err = spindle.configureOwner()
178 if err != nil {
179 return nil, err
180 }
181 logger.Info("owner set", "did", cfg.Server.Owner)
182
183 cursorStore, err := cursor.NewSQLiteStore(cfg.Server.DBPath)
184 if err != nil {
185 return nil, fmt.Errorf("failed to setup sqlite3 cursor store: %w", err)
186 }
187
188 err = jc.StartJetstream(ctx, spindle.ingest())
189 if err != nil {
190 return nil, fmt.Errorf("failed to start jetstream consumer: %w", err)
191 }
192
193 // spindle listen to knot stream for sh.tangled.git.refUpdate
194 // which will sync the local workflow files in spindle and enqueues the
195 // pipeline job for on-push workflows
196 ccfg := eventconsumer.NewConsumerConfig()
197 ccfg.Logger = log.SubLogger(logger, "eventconsumer")
198 ccfg.ProcessFunc = spindle.processKnotStream
199 ccfg.CursorStore = cursorStore
200 ccfg.WorkerCount = 16
201 ccfg.QueueSize = 200
202 if cfg.Server.Dev {
203 ccfg.RetryInterval = 5 * time.Second
204 ccfg.MaxRetryInterval = 10 * time.Second
205 } else {
206 ccfg.RetryInterval = 1 * time.Minute
207 ccfg.MaxRetryInterval = 10 * time.Minute
208 }
209 knownKnots, err := d.Knots()
210 if err != nil {
211 return nil, err
212 }
213 for _, knot := range knownKnots {
214 logger.Info("adding source start", "knot", knot)
215 src := eventconsumer.NewKnotSource(knot)
216 eventconsumer.MigrateLegacyCursor(cursorStore, src)
217 ccfg.Sources[src] = struct{}{}
218 }
219 spindle.ks = eventconsumer.NewConsumer(*ccfg)
220
221 if cfg.Server.Tap.Embed {
222 pw, err := randomAdminPassword()
223 if err != nil {
224 return nil, err
225 }
226 cfg.Server.Tap.AdminPassword = pw
227 logger.Info("embedded tap: using random admin password")
228 }
229 spindle.tap = NewTapClient(spindle)
230
231 return spindle, nil
232}
233
234// DB returns the database instance.
235func (s *Spindle) DB() *db.DB {
236 return s.db
237}
238
239// Queue returns the job queue instance.
240func (s *Spindle) Queue() *queue.Queue {
241 return s.jq
242}
243
244// Engines returns the map of available engines.
245func (s *Spindle) Engines() map[string]models.Engine {
246 return s.engs
247}
248
249// Vault returns the secrets manager instance.
250func (s *Spindle) Vault() secrets.Manager {
251 return s.vault
252}
253
254// Notifier returns the notifier instance.
255func (s *Spindle) Notifier() *notifier.Notifier {
256 return s.n
257}
258
259// Enforcer returns the RBAC enforcer instance.
260func (s *Spindle) Enforcer() *rbac.Enforcer {
261 return s.e
262}
263
264// SetMotdContent sets custom MOTD content, replacing the embedded default.
265func (s *Spindle) SetMotdContent(content []byte) {
266 s.motdMu.Lock()
267 defer s.motdMu.Unlock()
268 s.motd = content
269}
270
271// GetMotdContent returns the current MOTD content.
272func (s *Spindle) GetMotdContent() []byte {
273 s.motdMu.RLock()
274 defer s.motdMu.RUnlock()
275 return s.motd
276}
277
278// Start starts the Spindle server (blocking).
279func (s *Spindle) Start(ctx context.Context) error {
280 // starts a job queue runner in the background
281 s.jq.Start()
282 defer s.jq.Stop()
283
284 // Stop vault token renewal if it implements Stopper
285 if stopper, ok := s.vault.(secrets.Stopper); ok {
286 defer stopper.Stop()
287 }
288
289 tapCtx, tapCancel := context.WithCancel(ctx)
290
291 if s.cfg.Server.Tap.Embed {
292 emb, err := startEmbeddedTap(tapCtx, s.cfg, log.SubLogger(s.l, "embedtap"))
293 if err != nil {
294 tapCancel()
295 return fmt.Errorf("starting embedded tap: %w", err)
296 }
297 s.embedTap = emb
298 defer func() {
299 tapCancel()
300 s.embedTap.Shutdown()
301 }()
302
303 go s.watchTapDrain(tapCtx, tapCancel)
304 } else {
305 defer tapCancel()
306 }
307
308 go func() {
309 s.l.Info("starting knot event consumer")
310 s.ks.Start(ctx)
311 }()
312
313 s.l.Info("starting tap client", "url", s.cfg.Server.Tap.Url)
314 s.tap.Start(tapCtx)
315
316 s.l.Info("starting spindle server", "address", s.cfg.Server.ListenAddr)
317 return http.ListenAndServe(s.cfg.Server.ListenAddr, s.Router())
318}
319
320func (s *Spindle) declareTapInterest(ctx context.Context) {
321 repos, err := s.db.AllRepos()
322 if err != nil {
323 s.l.Warn("tap declare: failed to load known repos", "err", err)
324 return
325 }
326 seen := make(map[syntax.DID]struct{}, len(repos))
327 dids := make([]syntax.DID, 0, len(repos))
328 for _, r := range repos {
329 if r.Owner == "" {
330 continue
331 }
332 if _, ok := seen[r.Owner]; ok {
333 continue
334 }
335 seen[r.Owner] = struct{}{}
336 dids = append(dids, r.Owner)
337 }
338 if err := s.tap.AddOwnerDIDs(ctx, dids); err != nil {
339 s.l.Warn("tap declare: AddRepos rejected", "count", len(dids), "err", err)
340 return
341 }
342 s.l.Info("tap declare: known owner DIDs registered", "count", len(dids))
343}
344
345func Run(ctx context.Context) error {
346 cfg, err := config.Load(ctx)
347 if err != nil {
348 return fmt.Errorf("failed to load config: %w", err)
349 }
350
351 if err := ensureGitVersion(); err != nil {
352 return fmt.Errorf("ensuring git version: %w", err)
353 }
354
355 d, err := db.Make(ctx, cfg.Server.DBPath)
356 if err != nil {
357 return fmt.Errorf("failed to setup db: %w", err)
358 }
359
360 nixeryEng, err := nixery.New(ctx, cfg)
361 if err != nil {
362 return err
363 }
364
365 microvmEng, err := microvm.New(ctx, cfg, d)
366 if err != nil {
367 return err
368 }
369
370 s, err := New(ctx, cfg, d, map[string]models.Engine{
371 "nixery": nixeryEng,
372 "microvm": microvmEng,
373 "dummy": dummy.New(log.FromContext(ctx)),
374 })
375 if err != nil {
376 return err
377 }
378
379 return s.Start(ctx)
380}
381
382func (s *Spindle) Router() http.Handler {
383 mux := chi.NewRouter()
384
385 mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
386 w.Write(s.GetMotdContent())
387 })
388 mux.HandleFunc("/events", s.Events)
389 mux.HandleFunc("/logs/{knot}/{rkey}/{name}", s.Logs)
390
391 mux.Mount("/xrpc", s.XrpcRouter())
392 return mux
393}
394
395func (s *Spindle) XrpcRouter() http.Handler {
396 serviceAuth := serviceauth.NewServiceAuth(s.l, s.res.Directory(), s.cfg.Server.Did().String())
397
398 l := log.SubLogger(s.l, "xrpc")
399
400 x := xrpc.Xrpc{
401 Logger: l,
402 Db: s.db,
403 Enforcer: s.e,
404 Engines: s.engs,
405 Config: s.cfg,
406 Resolver: s.res,
407 Vault: s.vault,
408 Notifier: s.Notifier(),
409 ServiceAuth: serviceAuth,
410 Trigger: s,
411 }
412
413 return x.Router()
414}
415
416func (s *Spindle) processKnotStream(ctx context.Context, src eventconsumer.Source, msg eventstream.Event) error {
417 l := log.FromContext(ctx).With("handler", "processKnotStream")
418 l = l.With("src", src.Key(), "msg.Nsid", msg.Nsid, "msg.Rkey", msg.Rkey)
419 if msg.Nsid == knotdb.RepoCollaboratorUpdateNSID {
420 return s.ingestKnotCollaborator(ctx, l, src, msg)
421 }
422 if msg.Nsid == tangled.GitRefUpdateNSID {
423 event := tangled.GitRefUpdate{}
424 if err := json.Unmarshal(msg.EventJson, &event); err != nil {
425 l.Error("error unmarshalling", "err", err)
426 return err
427 }
428 l = l.With("repo", event.Repo, "ref", event.Ref, "newSha", event.NewSha)
429 l.Debug("debug")
430
431 repoDid := syntax.DID(event.Repo)
432 repo, err := s.db.GetRepoByDid(repoDid)
433 if err != nil {
434 return fmt.Errorf("unknown repoDid %s: %w", repoDid, err)
435 }
436
437 if src.Host != repo.Knot {
438 return fmt.Errorf("repo knot does not match event source: %s != %s", src.Host, repo.Knot)
439 }
440
441 if kgit.HasSkipCIPushOption(event.PushOptions) {
442 l.Info("push event requested ci skip, skipping the event")
443 return nil
444 }
445
446 // NOTE: we are blindly trusting the knot that it will return only repos it own
447 repoCloneUri := s.newRepoCloneUrl(src.Host, repoDid)
448 repoPath := s.newRepoPath(repoDid)
449
450 triggerRepo, err := s.buildTriggerRepo(ctx, repo)
451 if err != nil {
452 return fmt.Errorf("building trigger repo: %w", err)
453 }
454
455 trigger := tangled.Pipeline_TriggerMetadata{
456 Kind: string(workflow.TriggerKindPush),
457 Push: &tangled.Pipeline_PushTriggerData{
458 Ref: event.Ref,
459 OldSha: event.OldSha,
460 NewSha: event.NewSha,
461 },
462 Repo: triggerRepo,
463 }
464
465 pipelineId, err := s.runPipeline(ctx, repoDid, trigger, event.ChangedFiles, repoCloneUri, repoPath, event.NewSha, nil, triggerRepo)
466 if err != nil {
467 return err
468 }
469 if pipelineId.Rkey == "" {
470 l.Info("no workflow matched 'push' trigger, skipping the event")
471 return nil
472 }
473 l.Info("pipeline triggered", "pipeline", pipelineId.AtUri())
474 }
475
476 return nil
477}
478
479func (s *Spindle) ingestKnotCollaborator(ctx context.Context, l *slog.Logger, src eventconsumer.Source, msg eventstream.Event) error {
480 var rec knotdb.RepoCollaboratorUpdate
481 if err := json.Unmarshal(msg.EventJson, &rec); err != nil {
482 l.Error("error unmarshalling collaboratorUpdate", "err", err)
483 return err
484 }
485
486 subject, err := syntax.ParseDID(rec.Subject)
487 if err != nil {
488 l.Info("skipping collaboratorUpdate with malformed subject", "subject", rec.Subject, "err", err)
489 return nil
490 }
491 repoDid, err := syntax.ParseDID(rec.Repo)
492 if err != nil {
493 l.Info("skipping collaboratorUpdate with malformed repo", "repo", rec.Repo, "err", err)
494 return nil
495 }
496
497 repo, err := s.db.GetRepoByDid(repoDid)
498 if errors.Is(err, sql.ErrNoRows) {
499 l.Info("skipping collaboratorUpdate for unknown repo", "repo", repoDid)
500 return nil
501 }
502 if err != nil {
503 return fmt.Errorf("lookup repo %s: %w", repoDid, err)
504 }
505 if src.Host != repo.Knot {
506 l.Warn("dropping collaboratorUpdate from non-owning knot", "src", src.Host, "repoKnot", repo.Knot)
507 return nil
508 }
509
510 switch rec.Op {
511 case knotdb.AclOpAdd:
512 if err := s.e.AddCollaborator(subject.String(), rbac.ThisServer, repoDid.String()); err != nil {
513 return fmt.Errorf("add collaborator policy: %w", err)
514 }
515 if err := s.db.AddKnotCollaborator(repoDid, subject); err != nil {
516 return fmt.Errorf("track collaborator: %w", err)
517 }
518 l.Info("added knot-managed collaborator", "subject", subject, "repo", repoDid)
519 case knotdb.AclOpRemove:
520 if err := s.e.RemoveCollaborator(subject.String(), rbac.ThisServer, repoDid.String()); err != nil {
521 return fmt.Errorf("remove collaborator policy: %w", err)
522 }
523 if err := s.db.DeleteRepoCollaboratorBySubjectRepo(subject, repoDid); err != nil {
524 return fmt.Errorf("delete collaborator row: %w", err)
525 }
526 l.Info("removed knot-managed collaborator", "subject", subject, "repo", repoDid)
527 default:
528 return fmt.Errorf("collaboratorUpdate unknown op %q", rec.Op)
529 }
530 return nil
531}
532
533// buildTriggerRepo gathers trigger metadata, resolving default branch from the knot
534func (s *Spindle) buildTriggerRepo(ctx context.Context, repo *db.Repo) (*tangled.Pipeline_TriggerRepo, error) {
535 rkey := string(repo.Rkey)
536 repoDid := repo.RepoDid.String()
537 return s.buildTriggerRepoFrom(ctx, repo.Knot, repo.Owner.String(), rkey, repoDid), nil
538}
539
540func (s *Spindle) buildTriggerRepoFrom(ctx context.Context, knot, did, rkey, repoDid string) *tangled.Pipeline_TriggerRepo {
541 scheme := "https"
542 if s.cfg.Server.Dev {
543 scheme = "http"
544 }
545 client := &indigoxrpc.Client{Host: fmt.Sprintf("%s://%s", scheme, knot)}
546
547 // this should maybe (?) be in the refUpdate event itself to save a roundtrip
548 defaultBranch := ""
549 if out, err := tangled.RepoGetDefaultBranch(ctx, client, repoDid); err == nil {
550 defaultBranch = out.Name
551 }
552
553 var rkeyPtr *string
554 if rkey != "" {
555 rkeyPtr = &rkey
556 }
557 return &tangled.Pipeline_TriggerRepo{
558 Did: did,
559 Knot: knot,
560 Repo: rkeyPtr,
561 RepoDid: &repoDid,
562 DefaultBranch: defaultBranch,
563 }
564}
565
566func (s *Spindle) resolvePipelineSourceRepo(ctx context.Context, trigger *tangled.Pipeline_TriggerMetadata) (*tangled.Pipeline_TriggerRepo, error) {
567 if trigger == nil {
568 return nil, nil
569 }
570 if trigger.SourceRepo == nil || *trigger.SourceRepo == "" {
571 return trigger.Repo, nil
572 }
573 repoDid, err := syntax.ParseDID(*trigger.SourceRepo)
574 if err != nil {
575 return nil, fmt.Errorf("parse sourceRepo %s: %w", *trigger.SourceRepo, err)
576 }
577 return s.resolveSourceRepoInfo(ctx, repoDid)
578}
579
580// resolveSourceRepoInfo resolves trigger-repo metadata for a source repo DID.
581func (s *Spindle) resolveSourceRepoInfo(ctx context.Context, repoDid syntax.DID) (*tangled.Pipeline_TriggerRepo, error) {
582 repo, err := s.db.GetRepoByDid(repoDid)
583 if err == nil {
584 return s.buildTriggerRepo(ctx, repo)
585 }
586
587 // verify repo, we don't want git sync to point to arbitrary endpoints
588 res, err := s.verify(ctx, repoident.RepoDid(repoDid))
589 if err != nil {
590 return nil, fmt.Errorf("verify sourceRepo %s: %w", repoDid, err)
591 }
592 return s.buildTriggerRepoFrom(ctx, res.KnotURL.Host, res.OwnerDid.String(), res.Rkey, repoDid.String()), nil
593}
594
595// runPipeline compiles and enqueues the pipeline for the given revision.
596// sourceRepo is the resolved repo the code was checked out from, forwarded to
597// processPipeline for env vars.
598func (s *Spindle) runPipeline(ctx context.Context, repoDid syntax.DID, trigger tangled.Pipeline_TriggerMetadata, changedFiles []string, repoCloneUri, repoPath, rev string, only []string, sourceRepo *tangled.Pipeline_TriggerRepo) (models.PipelineId, error) {
599 l := log.FromContext(ctx)
600
601 compiler := workflow.Compiler{
602 ChangedFiles: changedFiles,
603 Trigger: trigger,
604 }
605
606 rawPipeline, err := s.loadPipeline(ctx, repoCloneUri, repoPath, rev)
607 if err != nil {
608 return models.PipelineId{}, fmt.Errorf("loading pipeline: %w", err)
609 }
610 if len(rawPipeline) == 0 {
611 return models.PipelineId{}, nil
612 }
613
614 tpl := compiler.Compile(compiler.Parse(rawPipeline))
615 // todo(dawn): pass compile error to workflow log
616 for _, w := range compiler.Diagnostics.Errors {
617 l.Error(w.String())
618 }
619 for _, w := range compiler.Diagnostics.Warnings {
620 l.Warn(w.String())
621 }
622
623 if len(only) > 0 {
624 tpl.Workflows = filterWorkflows(tpl.Workflows, only)
625 }
626 if len(tpl.Workflows) == 0 {
627 return models.PipelineId{}, nil
628 }
629
630 pipelineId := models.PipelineId{
631 Knot: trigger.Repo.Knot,
632 Rkey: tid.TID(),
633 }
634 if err := s.db.CreatePipelineEvent(pipelineId.Rkey, tpl, s.n); err != nil {
635 return models.PipelineId{}, fmt.Errorf("creating pipeline event: %w", err)
636 }
637 err = s.processPipeline(repoDid, tpl, pipelineId, sourceRepo)
638 return pipelineId, err
639}
640
641// filterWorkflows filters workflows to the requested names
642func filterWorkflows(workflows []*tangled.Pipeline_Workflow, only []string) []*tangled.Pipeline_Workflow {
643 allowed := make(map[string]struct{}, len(only))
644 for _, n := range only {
645 allowed[n] = struct{}{}
646 }
647 var filtered []*tangled.Pipeline_Workflow
648 for _, w := range workflows {
649 if w == nil {
650 continue
651 }
652 if _, ok := allowed[w.Name]; ok {
653 filtered = append(filtered, w)
654 }
655 }
656 return filtered
657}
658
659// TriggerManual dispatches a pipeline at sha, authorized against and recorded
660// under repoDid. sourceRepo, pull, and inputs are optional trigger payload.
661func (s *Spindle) TriggerManual(ctx context.Context, repoDid syntax.DID, sha, ref string, workflows []string, sourceRepo syntax.DID, pull xrpc.PullContext, inputs []*tangled.Pipeline_Pair) (syntax.ATURI, error) {
662 repo, err := s.db.GetRepoByDid(repoDid)
663 if err != nil {
664 return "", fmt.Errorf("unknown repoDid %s: %w", repoDid, err)
665 }
666
667 triggerRepo, err := s.buildTriggerRepo(ctx, repo)
668 if err != nil {
669 return "", fmt.Errorf("building trigger repo: %w", err)
670 }
671
672 trigger := tangled.Pipeline_TriggerMetadata{Repo: triggerRepo}
673 if pull.IsPullRequest {
674 var pullAt *string
675 if pull.Pull != "" {
676 pullAtStr := pull.Pull.String()
677 pullAt = &pullAtStr
678 }
679 trigger.Kind = string(workflow.TriggerKindPullRequest)
680 trigger.PullRequest = &tangled.Pipeline_PullRequestTriggerData{
681 SourceBranch: pull.SourceBranch,
682 TargetBranch: pull.TargetBranch,
683 SourceSha: sha,
684 Pull: pullAt,
685 }
686 } else {
687 var refPtr *string
688 if ref != "" {
689 refPtr = &ref
690 }
691 trigger.Kind = string(workflow.TriggerKindManual)
692 trigger.Manual = &tangled.Pipeline_ManualTriggerData{
693 Sha: sha,
694 Ref: refPtr,
695 Inputs: inputs,
696 }
697 }
698
699 repoCloneUri := s.newRepoCloneUrl(repo.Knot, repoDid)
700 repoPath := s.newRepoPath(repoDid)
701 sourceInfo := triggerRepo // default: code comes from the repo itself
702 if sourceRepo != "" && sourceRepo != repoDid {
703 sourceInfo, err = s.resolveSourceRepoInfo(ctx, sourceRepo)
704 if err != nil {
705 return "", err
706 }
707 sourceRepoStr := sourceRepo.String()
708 trigger.SourceRepo = &sourceRepoStr
709 repoCloneUri = models.BuildRepoURL(sourceInfo)
710 repoPath = s.newRepoPath(sourceRepo)
711 }
712
713 pipelineId, err := s.runPipeline(ctx, repoDid, trigger, nil, repoCloneUri, repoPath, sha, workflows, sourceInfo)
714 if err != nil {
715 return "", err
716 }
717 if pipelineId.Rkey == "" {
718 return "", xrpc.ErrNoMatchingWorkflows
719 }
720 return pipelineId.AtUri(), nil
721}
722
723func (s *Spindle) loadPipeline(ctx context.Context, repoUri, repoPath, rev string) (workflow.RawPipeline, error) {
724 if err := git.SparseSyncGitRepo(ctx, repoUri, repoPath, rev); err != nil {
725 return nil, fmt.Errorf("syncing git repo: %w", err)
726 }
727 gr, err := kgit.Open(repoPath, rev)
728 if err != nil {
729 return nil, fmt.Errorf("opening git repo: %w", err)
730 }
731
732 workflowDir, err := gr.FileTree(ctx, workflow.WorkflowDir)
733 if errors.Is(err, object.ErrDirectoryNotFound) {
734 // return empty RawPipeline when directory doesn't exist
735 return nil, nil
736 } else if err != nil {
737 return nil, fmt.Errorf("loading file tree: %w", err)
738 }
739
740 var rawPipeline workflow.RawPipeline
741 for _, e := range workflowDir {
742 if !e.IsFile() {
743 continue
744 }
745
746 fpath := filepath.Join(workflow.WorkflowDir, e.Name)
747 contents, err := gr.RawContent(fpath)
748 if err != nil {
749 return nil, fmt.Errorf("reading raw content of '%s': %w", fpath, err)
750 }
751
752 rawPipeline = append(rawPipeline, workflow.RawWorkflow{
753 Name: e.Name,
754 Contents: contents,
755 })
756 }
757
758 return rawPipeline, nil
759}
760
761// processPipeline enqueues the workflows in tpl.
762func (s *Spindle) processPipeline(repoDid syntax.DID, tpl tangled.Pipeline, pipelineId models.PipelineId, sourceRepo *tangled.Pipeline_TriggerRepo) error {
763 // derive security-relevant things like whether this run is trusted and can be passed
764 // secrets to from the original metadata.
765 pipelineEnv := models.PipelineEnvVarsForSource(tpl.TriggerMetadata, pipelineId, sourceRepo)
766 trustedSource := true
767 if tm := tpl.TriggerMetadata; tm != nil && tm.SourceRepo != nil &&
768 *tm.SourceRepo != "" && *tm.SourceRepo != repoDid.String() {
769 trustedSource = false
770 }
771
772 // swap the repo with our sourceRepo if we are running a pipeline on a fork.
773 // the metadata stays the same. we check whether the repo is trusted above,
774 // so this only affects the clone URL.
775 initTpl := tpl
776 if sourceRepo != nil && tpl.TriggerMetadata != nil {
777 tm := *tpl.TriggerMetadata
778 tm.Repo = sourceRepo
779 initTpl.TriggerMetadata = &tm
780 }
781
782 // filter & init workflows
783 workflows := make(map[models.Engine][]models.Workflow)
784 for _, w := range tpl.Workflows {
785 if w == nil {
786 continue
787 }
788 eng, ok := s.engs[w.Engine]
789 if !ok {
790 err := s.db.StatusFailed(models.WorkflowId{
791 PipelineId: pipelineId,
792 Name: w.Name,
793 }, fmt.Sprintf("unknown engine %#v", w.Engine), -1, s.n)
794 if err != nil {
795 return fmt.Errorf("db.StatusFailed: %w", err)
796 }
797
798 continue
799 }
800
801 ewf, err := eng.InitWorkflow(*w, initTpl)
802 if err != nil {
803 err = s.db.StatusFailed(models.WorkflowId{
804 PipelineId: pipelineId,
805 Name: w.Name,
806 }, fmt.Sprintf("init workflow: %s", err), -1, s.n)
807 if err != nil {
808 return fmt.Errorf("db.StatusFailed: %w", err)
809 }
810
811 continue
812 }
813
814 // inject TANGLED_* env vars after InitWorkflow
815 // This prevents user-defined env vars from overriding them
816 if ewf.Environment == nil {
817 ewf.Environment = make(map[string]string)
818 }
819 maps.Copy(ewf.Environment, pipelineEnv)
820
821 workflows[eng] = append(workflows[eng], *ewf)
822 }
823
824 // enqueue pipeline
825 ok := s.jq.Enqueue(repoDid, queue.Job{
826 Run: func() error {
827 engine.StartWorkflows(log.SubLogger(s.l, "engine"), s.vault, s.cfg, s.db, s.n, s.rootCtx, &models.Pipeline{
828 RepoDid: repoDid,
829 Workflows: workflows,
830 TrustedSource: trustedSource,
831 }, pipelineId)
832 return nil
833 },
834 OnFail: func(jobError error) {
835 s.l.Error("pipeline run failed", "error", jobError)
836 },
837 })
838 if !ok {
839 return fmt.Errorf("failed to enqueue pipeline: queue is full")
840 }
841 s.l.Info("pipeline enqueued successfully", "id", pipelineId)
842
843 // after successful enqueue, emit StatusPending for all workflows
844 for _, ewfs := range workflows {
845 for _, ewf := range ewfs {
846 err := s.db.StatusPending(models.WorkflowId{
847 PipelineId: pipelineId,
848 Name: ewf.Name,
849 }, s.n)
850 if err != nil {
851 return fmt.Errorf("db.StatusPending: %w", err)
852 }
853 }
854 }
855 return nil
856}
857
858// newRepoPath creates a path to store repository by its did and rkey.
859// The path format would be: `/data/repos/did:plc:foo/sh.tangled.repo/repo-rkey
860func (s *Spindle) newRepoPath(repo syntax.DID) string {
861 return filepath.Join(s.cfg.Server.RepoDir, repo.String())
862}
863
864func (s *Spindle) newRepoCloneUrl(knot string, did syntax.DID) string {
865 scheme := "https://"
866 if s.cfg.Server.Dev {
867 scheme = "http://"
868 }
869 return fmt.Sprintf("%s%s/%s", scheme, knot, did)
870}
871
872const RequiredVersion = "2.49.0"
873
874func ensureGitVersion() error {
875 v, err := git.Version()
876 if err != nil {
877 return fmt.Errorf("fetching git version: %w", err)
878 }
879 if v.LessThan(version.Must(version.NewVersion(RequiredVersion))) {
880 return fmt.Errorf("installed git version %q is not supported, Spindle requires git version >= %q", v, RequiredVersion)
881 }
882 return nil
883}
884
885func (s *Spindle) resolvePipelineRepoDid(repo *tangled.Pipeline_TriggerRepo) (syntax.DID, error) {
886 if repo.RepoDid == nil || *repo.RepoDid == "" {
887 return "", fmt.Errorf("pipeline trigger missing repoDid")
888 }
889 repoDid, err := syntax.ParseDID(*repo.RepoDid)
890 if err != nil {
891 return "", fmt.Errorf("parse repoDid %s: %w", *repo.RepoDid, err)
892 }
893 if _, err := s.db.GetRepoByDid(repoDid); err != nil {
894 return "", fmt.Errorf("unknown repoDid %s: %w", repoDid, err)
895 }
896 return repoDid, nil
897}
898
899func (s *Spindle) configureOwner() error {
900 cfgOwner := s.cfg.Server.Owner
901
902 existing, err := s.e.GetSpindleUsersByRole("server:owner", rbacDomain)
903 if err != nil {
904 return err
905 }
906
907 switch len(existing) {
908 case 0:
909 // no owner configured, continue
910 case 1:
911 // find existing owner
912 existingOwner := existing[0]
913
914 // no ownership change, this is okay
915 if existingOwner == s.cfg.Server.Owner {
916 break
917 }
918
919 // remove existing owner
920 err = s.e.RemoveSpindleOwner(rbacDomain, existingOwner)
921 if err != nil {
922 return nil
923 }
924 default:
925 return fmt.Errorf("more than one owner in DB, try deleting %q and starting over", s.cfg.Server.DBPath)
926 }
927
928 return s.e.AddSpindleOwner(rbacDomain, cfgOwner)
929}