Monorepo for Tangled
tangled.org
1package xrpc
2
3import (
4 "bytes"
5 "encoding/json"
6 "errors"
7 "log/slog"
8 "net/http"
9 "os"
10 "path/filepath"
11 "strings"
12
13 securejoin "github.com/cyphar/filepath-securejoin"
14 "github.com/go-chi/chi/v5"
15 "tangled.org/core/api/tangled"
16 "tangled.org/core/idresolver"
17 "tangled.org/core/jetstream"
18 "tangled.org/core/knotserver/config"
19 "tangled.org/core/knotserver/db"
20 "tangled.org/core/notifier"
21 "tangled.org/core/rbac"
22 xrpcerr "tangled.org/core/xrpc/errors"
23 "tangled.org/core/xrpc/serviceauth"
24)
25
26type Xrpc struct {
27 Config *config.Config
28 Db *db.DB
29 Ingester *jetstream.JetstreamClient
30 Enforcer *rbac.Enforcer
31 Logger *slog.Logger
32 Notifier *notifier.Notifier
33 Resolver *idresolver.Resolver
34 ServiceAuth *serviceauth.ServiceAuth
35}
36
37func (x *Xrpc) Router() http.Handler {
38 r := chi.NewRouter()
39
40 r.Group(func(r chi.Router) {
41 r.Use(x.ServiceAuth.VerifyServiceAuth)
42
43 r.Post("/"+tangled.RepoSetDefaultBranchNSID, x.SetDefaultBranch)
44 r.Post("/"+tangled.RepoDeleteBranchNSID, x.DeleteBranch)
45 r.Post("/"+tangled.RepoCreateNSID, x.CreateRepo)
46 r.Post("/"+tangled.RepoDeleteNSID, x.DeleteRepo)
47 r.Post("/"+tangled.RepoForkStatusNSID, x.ForkStatus)
48 r.Post("/"+tangled.RepoForkSyncNSID, x.ForkSync)
49 r.Post("/"+tangled.RepoHiddenRefNSID, x.HiddenRef)
50 r.Post("/"+tangled.RepoMergeNSID, x.Merge)
51 })
52
53 // merge check is an open endpoint
54 //
55 // TODO: should we constrain this more?
56 // - we can calculate on PR submit/resubmit/gitRefUpdate etc.
57 // - use ETags on clients to keep requests to a minimum
58 r.Post("/"+tangled.RepoMergeCheckNSID, x.MergeCheck)
59
60 // repo query endpoints (no auth required)
61 r.Get("/"+tangled.RepoTreeNSID, x.RepoTree)
62 r.Get("/"+tangled.RepoLogNSID, x.RepoLog)
63 r.Get("/"+tangled.RepoBranchesNSID, x.RepoBranches)
64 r.Get("/"+tangled.RepoTagsNSID, x.RepoTags)
65 r.Get("/"+tangled.RepoTagNSID, x.RepoTag)
66 r.Get("/"+tangled.RepoBlobNSID, x.RepoBlob)
67 r.Get("/"+tangled.RepoDiffNSID, x.RepoDiff)
68 r.Get("/"+tangled.RepoCompareNSID, x.RepoCompare)
69 r.Get("/"+tangled.RepoGetDefaultBranchNSID, x.RepoGetDefaultBranch)
70 r.Get("/"+tangled.RepoDescribeRepoNSID, x.RepoDescribeRepo)
71 r.Get("/"+tangled.RepoBranchNSID, x.RepoBranch)
72 r.Get("/"+tangled.RepoArchiveNSID, x.RepoArchive)
73 r.Get("/"+tangled.RepoLanguagesNSID, x.RepoLanguages)
74
75 // knot query endpoints (no auth required)
76 r.Get("/"+tangled.KnotListKeysNSID, x.ListKeys)
77 r.Get("/"+tangled.KnotVersionNSID, x.Version)
78
79 // service query endpoints (no auth required)
80 r.Get("/"+tangled.OwnerNSID, x.Owner)
81
82 return r
83}
84
85func (x *Xrpc) parseRepoParam(repo string) (string, error) {
86 if repo == "" || !strings.HasPrefix(repo, "did:") {
87 return "", xrpcerr.NewXrpcError(
88 xrpcerr.WithTag("InvalidRequest"),
89 xrpcerr.WithMessage("missing or invalid repo parameter, expected a repo DID"),
90 )
91 }
92
93 if !strings.Contains(repo, "/") {
94 repoPath, _, _, err := x.Db.ResolveRepoDIDOnDisk(x.Config.Repo.ScanPath, repo)
95 if err != nil {
96 return "", xrpcerr.RepoNotFoundError
97 }
98 return repoPath, nil
99 }
100
101 parts := strings.SplitN(repo, "/", 2)
102 ownerDid, repoName := parts[0], parts[1]
103
104 repoDid, err := x.Db.GetRepoDid(ownerDid, repoName)
105 if err == nil {
106 repoPath, _, _, resolveErr := x.Db.ResolveRepoDIDOnDisk(x.Config.Repo.ScanPath, repoDid)
107 if resolveErr == nil {
108 return repoPath, nil
109 }
110 }
111
112 repoPath, joinErr := securejoin.SecureJoin(x.Config.Repo.ScanPath, filepath.Join(ownerDid, repoName))
113 if joinErr != nil {
114 return "", xrpcerr.RepoNotFoundError
115 }
116 if _, statErr := os.Stat(repoPath); statErr != nil {
117 return "", xrpcerr.RepoNotFoundError
118 }
119 return repoPath, nil
120}
121
122func writeError(w http.ResponseWriter, e xrpcerr.XrpcError, status int) {
123 w.Header().Set("Content-Type", "application/json")
124 w.WriteHeader(status)
125 json.NewEncoder(w).Encode(e)
126}
127
128type limitWriter struct {
129 buf bytes.Buffer
130 limit int
131 written int
132}
133
134var errResponseTooLarge = errors.New("response too large")
135
136func (lw *limitWriter) Write(p []byte) (int, error) {
137 if lw.written+len(p) > lw.limit {
138 return 0, errResponseTooLarge
139 }
140 n, err := lw.buf.Write(p)
141 lw.written += n
142 return n, err
143}
144
145func (x *Xrpc) writeJson(w http.ResponseWriter, response any) {
146 lw := &limitWriter{limit: x.Config.Server.MaxResponseKB * 1024}
147 if err := json.NewEncoder(lw).Encode(response); err != nil {
148 if errors.Is(err, errResponseTooLarge) {
149 writeError(w, xrpcerr.RequestTooLargeError, http.StatusRequestEntityTooLarge)
150 } else {
151 writeError(w, xrpcerr.GenericError(err), http.StatusInternalServerError)
152 }
153 return
154 }
155 w.Header().Set("Content-Type", "application/json")
156 w.Write(lw.buf.Bytes())
157}