1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package usecase
4
5import (
6 "context"
7 "errors"
8 "fmt"
9 "unicode"
10 "unicode/utf8"
11
12 "github.com/bnema/zerowrap"
13
14 "bnema.dev/ermite/internal/domain"
15 "bnema.dev/ermite/internal/ports"
16)
17
18// MaxDescriptionLen is the longest repository description, in bytes.
19const MaxDescriptionLen = 500
20
21// validateDescription accepts a one-line description of valid UTF-8.
22func validateDescription(s string) error {
23 if len(s) > MaxDescriptionLen {
24 return fmt.Errorf("%w: description is longer than %d bytes", domain.ErrInvalid, MaxDescriptionLen)
25 }
26 if !utf8.ValidString(s) {
27 return fmt.Errorf("%w: description is not valid UTF-8", domain.ErrInvalid)
28 }
29 for _, c := range s {
30 if unicode.IsControl(c) {
31 return fmt.Errorf("%w: description must be one line without control characters", domain.ErrInvalid)
32 }
33 }
34 return nil
35}
36
37// View adds the default branch to a repository the caller has already been
38// allowed to see. A repository without a directory has no default branch.
39func (r *Repos) View(ctx context.Context, repo domain.Repo) (ports.RepoView, error) {
40 branch, err := r.git.HeadBranch(ctx, repo.Name)
41 if err != nil && !errors.Is(err, domain.ErrNotFound) {
42 return ports.RepoView{}, fmt.Errorf("read default branch of %q: %w", repo.Name, err)
43 }
44 return ports.RepoView{Repo: repo, DefaultBranch: branch}, nil
45}
46
47// Update changes the description, the topics, the visibility, the default branch and the
48// merge settings of a repository, and publishes RepoUpdated. The principal needs repo:admin on it
49// (see adminAccess for what the others learn) and no branch prefixes. At least one field must be set,
50// else domain.ErrInvalid. A default branch that does not exist gives
51// domain.ErrPreconditionFailed; nothing is written before every check passed.
52// The metadata is written first, then HEAD, and RepoUpdated is published after
53// both. When only the HEAD move fails, RepoUpdated is still published for the
54// stored metadata and the HEAD error is returned.
55func (r *Repos) Update(ctx context.Context, p domain.Principal, name domain.RepoName, params ports.UpdateRepoParams) (domain.Repo, error) {
56 repo, err := lookupRepo(ctx, r.meta, name)
57 if err != nil {
58 return domain.Repo{}, err
59 }
60 if err := adminAccess(p, repo); err != nil {
61 return domain.Repo{}, err
62 }
63 before := repo
64 if params.Description == nil && params.Topics == nil && params.Visibility == nil && params.DefaultBranch == nil &&
65 params.AllowedMergeModes == nil && params.FailingChecksBlock == nil && params.Issues == nil {
66 return domain.Repo{}, fmt.Errorf("%w: nothing to update", domain.ErrInvalid)
67 }
68 if params.AllowedMergeModes != nil {
69 modes, err := domain.NormalizeMergeModes(*params.AllowedMergeModes)
70 if err != nil {
71 return domain.Repo{}, err
72 }
73 params.AllowedMergeModes = &modes
74 }
75 if params.Issues != nil {
76 mode, err := domain.ParseIssuesMode(params.Issues.String())
77 if err != nil {
78 return domain.Repo{}, err
79 }
80 params.Issues = &mode
81 }
82 if params.Description != nil {
83 if err := validateDescription(*params.Description); err != nil {
84 return domain.Repo{}, err
85 }
86 }
87 if params.Topics != nil {
88 topics, err := domain.NormalizeTopics(*params.Topics)
89 if err != nil {
90 return domain.Repo{}, err
91 }
92 params.Topics = &topics
93 }
94 if params.Visibility != nil {
95 if _, err := domain.ParseVisibility(params.Visibility.String()); err != nil {
96 return domain.Repo{}, err
97 }
98 }
99 if params.DefaultBranch != nil {
100 if *params.DefaultBranch == "" {
101 return domain.Repo{}, fmt.Errorf("%w: default branch is empty", domain.ErrInvalid)
102 }
103 ok, err := r.git.HasBranch(ctx, name, *params.DefaultBranch)
104 if err != nil {
105 return domain.Repo{}, fmt.Errorf("check branch %q of %q: %w", *params.DefaultBranch, name, err)
106 }
107 if !ok {
108 return domain.Repo{}, fmt.Errorf("%w: branch %q does not exist", domain.ErrPreconditionFailed, *params.DefaultBranch)
109 }
110 }
111
112 // Metadata first, then HEAD. The two writes are not atomic: when moving
113 // HEAD fails after the metadata was stored, the stored change is still
114 // published as RepoUpdated (a repository made private must be withdrawn
115 // from the watchers) and the call then fails with the HEAD error. The
116 // branch was checked above, so the remaining causes are a vanished
117 // repository or an I/O failure.
118 metaDone := false
119 if params.Description != nil || params.Topics != nil || params.Visibility != nil || params.AllowedMergeModes != nil || params.FailingChecksBlock != nil || params.Issues != nil {
120 if repo, err = r.updateMeta(ctx, name, params); err != nil {
121 return domain.Repo{}, err
122 }
123 metaDone = true
124 }
125 var headErr error
126 if params.DefaultBranch != nil {
127 if err := r.git.SetDefaultBranch(ctx, name, *params.DefaultBranch); err != nil {
128 headErr = fmt.Errorf("set default branch of %q: %w", name, err)
129 if !metaDone {
130 return domain.Repo{}, headErr
131 }
132 } else if r.mirror != nil {
133 // The default branch decides which refs are mirrored.
134 r.mirror.OnPush(ctx, name, []domain.RefUpdate{{Ref: "HEAD"}})
135 }
136 }
137
138 log := zerowrap.FromCtx(ctx)
139 log.Info().
140 Str("repo", name.String()).
141 Bool("description", params.Description != nil).
142 Bool("topics", params.Topics != nil).
143 Bool("visibility", params.Visibility != nil).
144 Bool("default_branch", params.DefaultBranch != nil).
145 Bool("settings", params.AllowedMergeModes != nil || params.FailingChecksBlock != nil || params.Issues != nil).
146 Str("principal", p.Label()).Str("token_id", p.TokenID()).
147 Msg("repository updated")
148 r.bus.Publish(ctx, domain.RepoUpdated{
149 Repo: name, At: r.clock.Now().UTC(),
150 Visibility: repo.Visibility, Previous: before.Visibility, CreatedAt: repo.CreatedAt,
151 })
152 if headErr != nil {
153 return domain.Repo{}, headErr
154 }
155 return repo, nil
156}
157
158// updateMeta applies the metadata fields, retrying when a write (a push
159// recording pushed_at) gets in between.
160func (r *Repos) updateMeta(ctx context.Context, name domain.RepoName, params ports.UpdateRepoParams) (domain.Repo, error) {
161 repo, err := r.meta.Mutate(ctx, name, func(repo *domain.Repo) (bool, error) {
162 if params.Description != nil {
163 repo.Description = *params.Description
164 }
165 if params.Topics != nil {
166 repo.Topics = *params.Topics
167 }
168 if params.Visibility != nil {
169 repo.Visibility = *params.Visibility
170 }
171 repo.Settings = repo.EffectiveSettings()
172 if params.AllowedMergeModes != nil {
173 repo.Settings.AllowedMergeModes = *params.AllowedMergeModes
174 }
175 if params.FailingChecksBlock != nil {
176 repo.Settings.FailingChecksBlock = *params.FailingChecksBlock
177 }
178 if params.Issues != nil {
179 repo.Settings.Issues = *params.Issues
180 }
181 return true, nil
182 })
183 if err != nil {
184 return domain.Repo{}, fmt.Errorf("update repository %q: %w", name, err)
185 }
186 return repo, nil
187}
188
189// Delete moves the repository directory to the trash, removes its metadata
190// and publishes RepoDeleted. The principal needs repo:admin on it (see
191// adminAccess) and no branch prefixes. A repository whose directory is already gone, left by a
192// delete that failed half way, loses its metadata.
193func (r *Repos) Delete(ctx context.Context, p domain.Principal, name domain.RepoName) error {
194 repo, err := lookupRepo(ctx, r.meta, name)
195 if err != nil {
196 return err
197 }
198 if err := adminAccess(p, repo); err != nil {
199 return err
200 }
201 log := zerowrap.FromCtx(ctx)
202 switch err := r.git.Trash(ctx, name); {
203 case errors.Is(err, domain.ErrNotFound):
204 log.Warn().Str("repo", name.String()).Msg("repository directory already gone, removing its metadata")
205 case err != nil:
206 return fmt.Errorf("trash repository %q: %w", name, err)
207 }
208 var runIDs []int64
209 if r.ci != nil {
210 // Listed before the records go: the logs are found by run id.
211 if ids, err := r.ci.RunIDs(ctx, name); err == nil {
212 runIDs = ids
213 } else {
214 log.Warn().Err(err).Str("repo", name.String()).Msg("list the CI runs of the repository; their logs are left to the sweep")
215 }
216 }
217 if err := r.meta.Delete(ctx, name); err != nil {
218 return fmt.Errorf("delete metadata of %q: %w", name, err)
219 }
220 if r.ci != nil {
221 r.ci.ForgetRepo(name)
222 }
223 if len(runIDs) > 0 {
224 if err := r.ci.RemoveLogs(context.WithoutCancel(ctx), runIDs); err != nil {
225 log.Warn().Err(err).Str("repo", name.String()).Msg("remove the CI logs of the repository; the sweep will")
226 }
227 }
228 log.Info().Str("repo", name.String()).Str("principal", p.Label()).Str("token_id", p.TokenID()).Msg("repository deleted")
229 r.bus.Publish(ctx, domain.RepoDeleted{Repo: name, Visibility: repo.Visibility, At: r.clock.Now().UTC(), CreatedAt: repo.CreatedAt})
230 return nil
231}