1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package rpc
4
5import (
6 "encoding/base64"
7 "fmt"
8 "slices"
9 "time"
10
11 "google.golang.org/protobuf/types/known/timestamppb"
12
13 pb "bnema.dev/ermite-api/gen/ermite"
14 "bnema.dev/ermite/internal/domain"
15 "bnema.dev/ermite/internal/ports"
16)
17
18// This file maps domain values to the messages of the contract and back.
19// Messages are DTOs: the domain never leaks into them, nor they into the
20// domain.
21
22func timestamp(t time.Time) *timestamppb.Timestamp {
23 if t.IsZero() {
24 return nil
25 }
26 return timestamppb.New(t)
27}
28
29func goTime(ts *timestamppb.Timestamp) time.Time {
30 if ts == nil {
31 return time.Time{}
32 }
33 return ts.AsTime()
34}
35
36func visibilityToPB(v domain.Visibility) pb.Visibility {
37 switch v {
38 case domain.VisibilityPublic:
39 return pb.Visibility_VISIBILITY_PUBLIC
40 case domain.VisibilityPrivate:
41 return pb.Visibility_VISIBILITY_PRIVATE
42 }
43 return pb.Visibility_VISIBILITY_UNSPECIFIED
44}
45
46// visibilityFromPB maps a visibility of a request. Unspecified is the empty
47// domain.Visibility, which the use cases treat as "default".
48func visibilityFromPB(v pb.Visibility) (domain.Visibility, error) {
49 switch v {
50 case pb.Visibility_VISIBILITY_UNSPECIFIED:
51 return "", nil
52 case pb.Visibility_VISIBILITY_PUBLIC:
53 return domain.VisibilityPublic, nil
54 case pb.Visibility_VISIBILITY_PRIVATE:
55 return domain.VisibilityPrivate, nil
56 }
57 return "", fmt.Errorf("%w: %v", domain.ErrInvalidVisibility, v)
58}
59
60func repoToPB(v ports.RepoView) *pb.Repo {
61 settings := v.Settings
62 if settings.IsZero() {
63 settings = domain.DefaultRepoSettings()
64 }
65 return &pb.Repo{
66 Name: v.Name.String(),
67 Description: v.Description,
68 Topics: v.Topics,
69 Visibility: visibilityToPB(v.Visibility),
70 DefaultBranch: v.DefaultBranch,
71 CreatedAt: timestamp(v.CreatedAt),
72 PushedAt: timestamp(v.PushedAt),
73 Settings: settingsToPB(settings),
74 }
75}
76
77func settingsToPB(s domain.RepoSettings) *pb.RepoSettings {
78 out := &pb.RepoSettings{FailingChecksBlock: s.FailingChecksBlock, Issues: issuesModeToPB(s.Issues)}
79 for _, m := range s.AllowedMergeModes {
80 out.AllowedMergeModes = append(out.AllowedMergeModes, mergeModeToPB(m))
81 }
82 return out
83}
84
85func mergeModeToPB(m domain.MergeMode) pb.MergeMode {
86 switch m {
87 case domain.MergeModeFastForward:
88 return pb.MergeMode_MERGE_MODE_FAST_FORWARD
89 case domain.MergeModeSquash:
90 return pb.MergeMode_MERGE_MODE_SQUASH
91 }
92 return pb.MergeMode_MERGE_MODE_UNSPECIFIED
93}
94
95// mergeModeFromPB maps a mode of a merge request: unspecified is the empty
96// domain.MergeMode, which the use case reads as fast-forward.
97func mergeModeFromPB(m pb.MergeMode) (domain.MergeMode, error) {
98 switch m {
99 case pb.MergeMode_MERGE_MODE_UNSPECIFIED:
100 return "", nil
101 case pb.MergeMode_MERGE_MODE_FAST_FORWARD:
102 return domain.MergeModeFastForward, nil
103 case pb.MergeMode_MERGE_MODE_SQUASH:
104 return domain.MergeModeSquash, nil
105 }
106 return "", fmt.Errorf("%w: merge mode %v", domain.ErrInvalid, m)
107}
108
109// mergeModesFromPB maps the allowed modes of the settings, where unspecified
110// is rejected.
111func mergeModesFromPB(in []pb.MergeMode) ([]domain.MergeMode, error) {
112 out := make([]domain.MergeMode, 0, len(in))
113 for _, m := range in {
114 mode, err := mergeModeFromPB(m)
115 if err != nil {
116 return nil, err
117 }
118 if mode == "" {
119 return nil, fmt.Errorf("%w: MERGE_MODE_UNSPECIFIED is not a merge mode", domain.ErrInvalid)
120 }
121 out = append(out, mode)
122 }
123 return out, nil
124}
125
126var scopeToPB = map[domain.Scope]pb.Scope{
127 domain.ScopeMRReview: pb.Scope_SCOPE_MR_REVIEW,
128 domain.ScopeRepoRead: pb.Scope_SCOPE_REPO_READ,
129 domain.ScopeRepoWrite: pb.Scope_SCOPE_REPO_WRITE,
130 domain.ScopeRepoAdmin: pb.Scope_SCOPE_REPO_ADMIN,
131 domain.ScopeMRWrite: pb.Scope_SCOPE_MR_WRITE,
132 domain.ScopeMRMerge: pb.Scope_SCOPE_MR_MERGE,
133 domain.ScopeCIWrite: pb.Scope_SCOPE_CI_WRITE,
134 domain.ScopeSecretsWrite: pb.Scope_SCOPE_SECRETS_WRITE,
135 domain.ScopeRunnerRegister: pb.Scope_SCOPE_RUNNER_REGISTER,
136 domain.ScopeTokenAdmin: pb.Scope_SCOPE_TOKEN_ADMIN,
137 domain.ScopeIssueWrite: pb.Scope_SCOPE_ISSUE_WRITE,
138}
139
140func scopeFromPB(s pb.Scope) (domain.Scope, error) {
141 for d, p := range scopeToPB {
142 if p == s {
143 return d, nil
144 }
145 }
146 return "", fmt.Errorf("%w: %v", domain.ErrInvalidScope, s)
147}
148
149func tokenToPB(t domain.Token) *pb.Token {
150 out := &pb.Token{
151 Id: t.ID,
152 Label: t.Label,
153 ExpiresAt: timestamp(t.ExpiresAt),
154 CreatedAt: timestamp(t.CreatedAt),
155 LastUsedAt: timestamp(t.LastUsedAt),
156 }
157 for _, s := range t.Scopes {
158 out.Scopes = append(out.Scopes, scopeToPB[s])
159 }
160 for _, r := range t.Repos {
161 out.Repos = append(out.Repos, r.String())
162 }
163 out.BranchPrefixes = slices.Clone(t.BranchPrefixes)
164 return out
165}
166
167func refKindToPB(k domain.RefKind) pb.RefKind {
168 switch k {
169 case domain.RefKindBranch:
170 return pb.RefKind_REF_KIND_BRANCH
171 case domain.RefKindTag:
172 return pb.RefKind_REF_KIND_TAG
173 case domain.RefKindHead:
174 return pb.RefKind_REF_KIND_HEAD
175 }
176 return pb.RefKind_REF_KIND_UNSPECIFIED
177}
178
179func refKindFromPB(k pb.RefKind) (domain.RefKind, error) {
180 switch k {
181 case pb.RefKind_REF_KIND_BRANCH:
182 return domain.RefKindBranch, nil
183 case pb.RefKind_REF_KIND_TAG:
184 return domain.RefKindTag, nil
185 case pb.RefKind_REF_KIND_HEAD:
186 return domain.RefKindHead, nil
187 }
188 return "", fmt.Errorf("%w: %v", domain.ErrInvalidRefKind, k)
189}
190
191func refToPB(r domain.Ref) *pb.Ref {
192 return &pb.Ref{
193 Name: r.Name,
194 ShortName: r.ShortName,
195 Kind: refKindToPB(r.Kind),
196 Id: r.ID.String(),
197 CommitId: r.CommitID.String(),
198 }
199}
200
201func entryKindToPB(k domain.EntryKind) pb.EntryKind {
202 switch k {
203 case domain.EntryFile:
204 return pb.EntryKind_ENTRY_KIND_FILE
205 case domain.EntryExecutable:
206 return pb.EntryKind_ENTRY_KIND_EXECUTABLE
207 case domain.EntryDirectory:
208 return pb.EntryKind_ENTRY_KIND_DIRECTORY
209 case domain.EntrySymlink:
210 return pb.EntryKind_ENTRY_KIND_SYMLINK
211 case domain.EntrySubmodule:
212 return pb.EntryKind_ENTRY_KIND_SUBMODULE
213 }
214 return pb.EntryKind_ENTRY_KIND_UNSPECIFIED
215}
216
217func signatureToPB(s domain.Signature) *pb.Signature {
218 return &pb.Signature{Name: s.Name, Email: s.Email, Time: timestamp(s.Time)}
219}
220
221func commitToPB(c domain.Commit) *pb.Commit {
222 out := &pb.Commit{
223 Id: c.ID.String(),
224 Author: signatureToPB(c.Author),
225 Committer: signatureToPB(c.Committer),
226 Summary: c.Summary,
227 Message: c.Message,
228 }
229 for _, p := range c.Parents {
230 out.ParentIds = append(out.ParentIds, p.String())
231 }
232 if c.Verification.Status != domain.StatusUnchecked {
233 out.Verification = verificationToPB(c.Verification)
234 }
235 return out
236}
237
238func verificationToPB(v domain.CommitVerification) *pb.CommitVerification {
239 return &pb.CommitVerification{
240 Format: signatureFormatToPB(v.Format),
241 Status: signatureStatusToPB(v.Status),
242 Fingerprint: v.Fingerprint,
243 KeyId: v.KeyID,
244 KeyTitle: v.KeyTitle,
245 }
246}
247
248func signatureFormatToPB(f domain.SignatureFormat) pb.SignatureFormat {
249 switch f {
250 case domain.FormatSSH:
251 return pb.SignatureFormat_SIGNATURE_FORMAT_SSH
252 case domain.FormatGPG:
253 return pb.SignatureFormat_SIGNATURE_FORMAT_GPG
254 case domain.FormatX509:
255 return pb.SignatureFormat_SIGNATURE_FORMAT_X509
256 case domain.FormatNone:
257 return pb.SignatureFormat_SIGNATURE_FORMAT_UNSPECIFIED
258 }
259 return pb.SignatureFormat_SIGNATURE_FORMAT_UNSPECIFIED
260}
261
262// signatureFormatFromPB maps the format of a key to add: only SSH and GPG keys
263// can be trusted.
264func signatureFormatFromPB(f pb.SignatureFormat) (domain.SignatureFormat, error) {
265 switch f {
266 case pb.SignatureFormat_SIGNATURE_FORMAT_SSH:
267 return domain.FormatSSH, nil
268 case pb.SignatureFormat_SIGNATURE_FORMAT_GPG:
269 return domain.FormatGPG, nil
270 case pb.SignatureFormat_SIGNATURE_FORMAT_UNSPECIFIED, pb.SignatureFormat_SIGNATURE_FORMAT_X509:
271 }
272 return domain.FormatNone, fmt.Errorf("%w: key format must be ssh or gpg", domain.ErrInvalid)
273}
274
275func signatureStatusToPB(s domain.SignatureStatus) pb.SignatureStatus {
276 switch s {
277 case domain.StatusUnsigned:
278 return pb.SignatureStatus_SIGNATURE_STATUS_UNSIGNED
279 case domain.StatusVerified:
280 return pb.SignatureStatus_SIGNATURE_STATUS_VERIFIED
281 case domain.StatusUnknownKey:
282 return pb.SignatureStatus_SIGNATURE_STATUS_UNKNOWN_KEY
283 case domain.StatusBadSignature:
284 return pb.SignatureStatus_SIGNATURE_STATUS_BAD_SIGNATURE
285 case domain.StatusEmailMismatch:
286 return pb.SignatureStatus_SIGNATURE_STATUS_EMAIL_MISMATCH
287 case domain.StatusExpired:
288 return pb.SignatureStatus_SIGNATURE_STATUS_EXPIRED
289 case domain.StatusRevoked:
290 return pb.SignatureStatus_SIGNATURE_STATUS_REVOKED
291 case domain.StatusUnsupported:
292 return pb.SignatureStatus_SIGNATURE_STATUS_UNSUPPORTED
293 case domain.StatusUnchecked:
294 return pb.SignatureStatus_SIGNATURE_STATUS_UNSPECIFIED
295 }
296 return pb.SignatureStatus_SIGNATURE_STATUS_UNSPECIFIED
297}
298
299func trustedKeyToPB(k domain.TrustedKey) *pb.TrustedKey {
300 return &pb.TrustedKey{
301 Id: k.ID,
302 Format: signatureFormatToPB(k.Format),
303 Title: k.Title,
304 PublicKey: k.PublicKey,
305 Emails: slices.Clone(k.Emails),
306 CreatedAt: timestamp(k.CreatedAt),
307 Builtin: k.Builtin,
308 }
309}
310
311func treeEntryToPB(e domain.TreeEntry) *pb.TreeEntry {
312 out := &pb.TreeEntry{
313 Name: e.Name,
314 Path: e.Path,
315 Kind: entryKindToPB(e.Kind),
316 Mode: e.Mode,
317 Id: e.ID.String(),
318 Size: e.Size,
319 }
320 if e.LastCommit != nil {
321 out.LastCommit = commitToPB(*e.LastCommit)
322 }
323 return out
324}
325
326func blobInfoToPB(b domain.BlobInfo) *pb.BlobInfo {
327 return &pb.BlobInfo{
328 Id: b.ID.String(),
329 Path: b.Path,
330 Size: b.Size,
331 Binary: b.Binary,
332 MediaType: b.MediaType,
333 Mode: b.Mode,
334 }
335}
336
337func fileStatusToPB(s domain.FileStatus) pb.FileStatus {
338 switch s {
339 case domain.FileAdded:
340 return pb.FileStatus_FILE_STATUS_ADDED
341 case domain.FileDeleted:
342 return pb.FileStatus_FILE_STATUS_DELETED
343 case domain.FileModified:
344 return pb.FileStatus_FILE_STATUS_MODIFIED
345 case domain.FileRenamed:
346 return pb.FileStatus_FILE_STATUS_RENAMED
347 case domain.FileCopied:
348 return pb.FileStatus_FILE_STATUS_COPIED
349 case domain.FileTypeChanged:
350 return pb.FileStatus_FILE_STATUS_TYPE_CHANGED
351 }
352 return pb.FileStatus_FILE_STATUS_UNSPECIFIED
353}
354
355func lineKindToPB(k domain.LineKind) pb.LineKind {
356 switch k {
357 case domain.LineContext:
358 return pb.LineKind_LINE_KIND_CONTEXT
359 case domain.LineAddition:
360 return pb.LineKind_LINE_KIND_ADDITION
361 case domain.LineDeletion:
362 return pb.LineKind_LINE_KIND_DELETION
363 }
364 return pb.LineKind_LINE_KIND_UNSPECIFIED
365}
366
367func hunkToPB(h domain.Hunk) *pb.Hunk {
368 out := &pb.Hunk{
369 OldStart: int32(h.OldStart), OldLines: int32(h.OldLines),
370 NewStart: int32(h.NewStart), NewLines: int32(h.NewLines),
371 Header: h.Header,
372 Lines: make([]*pb.Line, 0, len(h.Lines)),
373 }
374 for _, l := range h.Lines {
375 out.Lines = append(out.Lines, &pb.Line{
376 Kind: lineKindToPB(l.Kind),
377 OldNumber: int32(l.OldNumber),
378 NewNumber: int32(l.NewNumber),
379 Text: l.Text,
380 NoNewlineAtEof: l.NoNewlineAtEOF,
381 })
382 }
383 return out
384}
385
386func fileDiffToPB(f domain.FileDiff) *pb.FileDiff {
387 out := &pb.FileDiff{
388 OldPath: f.OldPath, NewPath: f.NewPath,
389 Status: fileStatusToPB(f.Status),
390 OldMode: f.OldMode, NewMode: f.NewMode,
391 OldId: f.OldID.String(), NewId: f.NewID.String(),
392 Binary: f.Binary,
393 Additions: int32(f.Additions),
394 Deletions: int32(f.Deletions),
395 Similarity: int32(f.Similarity),
396 Truncated: f.Truncated,
397 }
398 for _, h := range f.Hunks {
399 out.Hunks = append(out.Hunks, hunkToPB(h))
400 }
401 return out
402}
403
404func diffStatsToPB(s domain.DiffStats) *pb.DiffStats {
405 return &pb.DiffStats{
406 FilesChanged: int32(s.FilesChanged),
407 Additions: int32(s.Additions),
408 Deletions: int32(s.Deletions),
409 }
410}
411
412func diffToPB(d domain.Diff) *pb.Diff {
413 out := &pb.Diff{Truncated: d.Truncated}
414 for _, f := range d.Files {
415 out.Files = append(out.Files, fileDiffToPB(f))
416 }
417 return out
418}
419
420func commitDetailToPB(d domain.CommitDetail) *pb.GetCommitResponse {
421 return &pb.GetCommitResponse{
422 Commit: commitToPB(d.Commit),
423 Stats: diffStatsToPB(d.Stats),
424 Diff: diffToPB(d.Diff),
425 }
426}
427
428// oidToPB turns the zero object id of a ref update (no object) into "".
429func oidToPB(oid string) string {
430 if oid == domain.ZeroOID {
431 return ""
432 }
433 return oid
434}
435
436func refUpdatesToPB(updates []domain.RefUpdate) []*pb.RefUpdate {
437 out := make([]*pb.RefUpdate, 0, len(updates))
438 for _, u := range updates {
439 out = append(out, &pb.RefUpdate{Ref: u.Ref, OldId: oidToPB(u.Old), NewId: oidToPB(u.New)})
440 }
441 return out
442}
443
444// watchEventToPB maps one item of a watch; nil when the event has no
445// representation in the contract.
446func watchEventToPB(we ports.WatchEvent) *pb.Event {
447 if we.Gap {
448 return &pb.Event{Kind: &pb.Event_Gap{Gap: &pb.Gap{}}}
449 }
450 out := &pb.Event{Id: we.ID}
451 switch ev := we.Event.(type) {
452 case domain.RepoCreated:
453 out.Time = timestamp(ev.At)
454 out.Kind = &pb.Event_RepoCreated{RepoCreated: &pb.RepoCreated{Repo: repoOrName(we, ev.Repo, ev.Visibility)}}
455 case domain.RepoUpdated:
456 out.Time = timestamp(ev.At)
457 out.Kind = &pb.Event_RepoUpdated{RepoUpdated: &pb.RepoUpdated{Repo: repoOrName(we, ev.Repo, "")}}
458 case domain.RepoDeleted:
459 out.Time = timestamp(ev.At)
460 out.Kind = &pb.Event_RepoDeleted{RepoDeleted: &pb.RepoDeleted{Repo: ev.Repo.String()}}
461 case domain.PushEvent:
462 out.Time = timestamp(ev.At)
463 out.Kind = &pb.Event_Pushed{Pushed: &pb.Pushed{Repo: ev.Repo.String(), RefUpdates: refUpdatesToPB(ev.Updates)}}
464 case domain.MergeRequestOpened:
465 out.Time = timestamp(ev.At)
466 out.Kind = &pb.Event_MergeRequestOpened{MergeRequestOpened: &pb.MergeRequestOpened{MergeRequest: mergeRequestToPB(ev.MergeRequest)}}
467 case domain.MergeRequestMerged:
468 out.Time = timestamp(ev.At)
469 out.Kind = &pb.Event_MergeRequestMerged{MergeRequestMerged: &pb.MergeRequestMerged{MergeRequest: mergeRequestToPB(ev.MergeRequest)}}
470 case domain.MergeRequestClosed:
471 out.Time = timestamp(ev.At)
472 out.Kind = &pb.Event_MergeRequestClosed{MergeRequestClosed: &pb.MergeRequestClosed{MergeRequest: mergeRequestToPB(ev.MergeRequest)}}
473 case domain.CommentAdded:
474 out.Time = timestamp(ev.At)
475 out.Kind = &pb.Event_CommentAdded{CommentAdded: &pb.CommentAdded{Repo: ev.Repo.String(), Number: ev.Number, Comment: commentToPB(ev.Comment)}}
476 case domain.IssueOpened:
477 out.Time = timestamp(ev.At)
478 out.Kind = &pb.Event_IssueOpened{IssueOpened: &pb.IssueOpened{Issue: issueToPB(ev.Issue)}}
479 case domain.IssueClosed:
480 out.Time = timestamp(ev.At)
481 out.Kind = &pb.Event_IssueClosed{IssueClosed: &pb.IssueClosed{Issue: issueToPB(ev.Issue)}}
482 case domain.IssueReopened:
483 out.Time = timestamp(ev.At)
484 out.Kind = &pb.Event_IssueReopened{IssueReopened: &pb.IssueReopened{Issue: issueToPB(ev.Issue)}}
485 case domain.IssueCommented:
486 out.Time = timestamp(ev.At)
487 out.Kind = &pb.Event_IssueCommented{IssueCommented: &pb.IssueCommented{Repo: ev.Repo.String(), Number: ev.Number, Comment: issueCommentToPB(ev.Comment)}}
488 case domain.IssueSubmitted:
489 out.Time = timestamp(ev.At)
490 out.Kind = &pb.Event_IssueSubmitted{IssueSubmitted: &pb.IssueSubmitted{Repo: ev.Repo.String(), Id: ev.ID.String()}}
491 case domain.CommentEdited:
492 out.Time = timestamp(ev.At)
493 out.Kind = &pb.Event_CommentEdited{CommentEdited: &pb.CommentEdited{Repo: ev.Repo.String(), Number: ev.Number, Comment: commentToPB(ev.Comment)}}
494 case domain.CommentDeleted:
495 out.Time = timestamp(ev.At)
496 out.Kind = &pb.Event_CommentDeleted{CommentDeleted: &pb.CommentDeleted{Repo: ev.Repo.String(), Number: ev.Number, Comment: commentToPB(ev.Comment)}}
497 case domain.CommentResolved:
498 out.Time = timestamp(ev.At)
499 out.Kind = &pb.Event_CommentResolved{CommentResolved: &pb.CommentResolved{Repo: ev.Repo.String(), Number: ev.Number, Comment: commentToPB(ev.Comment)}}
500 case domain.RunUpdated:
501 out.Time = timestamp(ev.At)
502 out.Kind = runEventToPB(ev)
503 case domain.JobUpdated:
504 out.Time = timestamp(ev.At)
505 out.Kind = jobEventToPB(ev)
506 default:
507 // Web-only events, such as domain.IssuePendingRemoved (the API has
508 // no message for it; watchers list pending issues on demand).
509 return nil
510 }
511 return out
512}
513
514func repoOrName(we ports.WatchEvent, name domain.RepoName, vis domain.Visibility) *pb.Repo {
515 if we.Repo != nil {
516 return repoToPB(*we.Repo)
517 }
518 return &pb.Repo{Name: name.String(), Visibility: visibilityToPB(vis)}
519}
520
521// passkeysToPB converts passkeys; the credential id is base64url without
522// padding, the form RemovePasskey takes back. Key material never leaves.
523func passkeysToPB(list []domain.Passkey) []*pb.Passkey {
524 out := make([]*pb.Passkey, 0, len(list))
525 for _, p := range list {
526 out = append(out, &pb.Passkey{
527 Id: base64.RawURLEncoding.EncodeToString(p.ID),
528 Name: p.Name,
529 CreatedAt: timestamp(p.CreatedAt),
530 LastUsedAt: timestamp(p.LastUsedAt),
531 Synced: p.BackupState,
532 })
533 }
534 return out
535}