/
state.go
102 lines (85 loc) · 2.56 KB
/
state.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
// Copyright 2021 FerretDB Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package state stores FerretDB process state.
package state
import (
"time"
"github.com/AlekSi/pointer"
"github.com/google/uuid"
)
// State represents FerretDB process state.
type State struct {
UUID string `json:"uuid"`
Telemetry *bool `json:"telemetry,omitempty"` // nil for undecided
// all following fields are never persisted
TelemetryLocked bool `json:"-"`
Start time.Time `json:"-"`
// may be empty if FerretDB did not connect to the backend yet
BackendName string `json:"-"`
BackendVersion string `json:"-"`
// as reported by beacon, if known
LatestVersion string `json:"-"`
UpdateInfo string `json:"-"`
UpdateAvailable bool `json:"-"`
}
// TelemetryString returns "enabled", "disabled" or "undecided".
func (s *State) TelemetryString() string {
if s.Telemetry == nil {
return "undecided"
}
if *s.Telemetry {
return "enabled"
}
return "disabled"
}
// DisableTelemetry disables telemetry.
//
// It also resets other telemetry fields to avoid stale values when telemetry is re-enabled.
func (s *State) DisableTelemetry() {
s.Telemetry = pointer.ToBool(false)
s.LatestVersion = ""
s.UpdateInfo = ""
s.UpdateAvailable = false
}
// EnableTelemetry enables telemetry.
func (s *State) EnableTelemetry() {
s.Telemetry = pointer.ToBool(true)
}
// fill replaces all unset or invalid values with default.
func (s *State) fill() {
if _, err := uuid.Parse(s.UUID); err != nil {
s.UUID = uuid.NewString()
}
if s.Start.IsZero() {
s.Start = time.Now()
}
}
// deepCopy returns a deep copy of the state.
func (s *State) deepCopy() *State {
var telemetry *bool
if s.Telemetry != nil {
telemetry = pointer.ToBool(*s.Telemetry)
}
return &State{
UUID: s.UUID,
Telemetry: telemetry,
TelemetryLocked: s.TelemetryLocked,
Start: s.Start,
BackendName: s.BackendName,
BackendVersion: s.BackendVersion,
LatestVersion: s.LatestVersion,
UpdateInfo: s.UpdateInfo,
UpdateAvailable: s.UpdateAvailable,
}
}