features.go RawHistoryFolder

1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package client
4
5import "slices"
6
7// Contract features this client relies on, as listed by
8// ServerService.GetVersion. A server without one still works for everything
9// else: the CLI warns instead of failing.
10const (
11	// FeatureRepoUpdate is RepoService.UpdateRepo (`ermite repo edit`).
12	FeatureRepoUpdate = "repo.update"
13	// FeatureEventsResume is EventService.Watch with resume_after, which
14	// `ermite watch` uses to continue after a reconnection.
15	FeatureEventsResume = "events.resume"
16	// FeatureMergeRequests is MergeRequestService (`ermite mr`).
17	FeatureMergeRequests = "merge_requests"
18	// FeatureMergeDeleteBranch is MergeMergeRequest with delete_source_branch
19	// (`ermite mr merge --delete-branch`).
20	FeatureMergeDeleteBranch = "merge_requests.delete_branch"
21	// FeatureSigningKey is ServerService.GetSigningKey (`ermite signing-key`).
22	FeatureSigningKey = "signing_key"
23	// FeatureSession is SessionService (`ermite web login`, `web logout`).
24	FeatureSession = "session"
25)
26
27// UsedFeatures lists the features the CLI uses, in the order they are reported.
28func UsedFeatures() []string {
29	return []string{FeatureRepoUpdate, FeatureEventsResume, FeatureMergeRequests, FeatureMergeDeleteBranch, FeatureSigningKey, FeatureSession}
30}
31
32// MissingFeatures returns the features the CLI uses that have is lacking.
33func MissingFeatures(have []string) []string {
34	var missing []string
35	for _, f := range UsedFeatures() {
36		if !slices.Contains(have, f) {
37			missing = append(missing, f)
38		}
39	}
40	return missing
41}