-
Notifications
You must be signed in to change notification settings - Fork 0
/
platforms.go
258 lines (235 loc) · 8.01 KB
/
platforms.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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
// Copyright 2017 The LUCI Authors.
//
// 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 model
import (
"context"
"go.chromium.org/luci/common/errors"
"go.chromium.org/luci/common/logging"
"go.chromium.org/luci/machine-db/api/config/v1"
"go.chromium.org/luci/machine-db/appengine/database"
)
// Platform represents a row in the platforms table.
type Platform struct {
config.Platform
Id int64
}
// PlatformsTable represents the table of platforms in the database.
type PlatformsTable struct {
// current is the slice of platforms in the database.
current []*Platform
// additions is a slice of platforms pending addition to the database.
additions []*Platform
// removals is a slice of platforms pending removal from the database.
removals []*Platform
// updates is a slice of platforms pending update in the database.
updates []*Platform
}
// fetch fetches the platforms from the database.
func (t *PlatformsTable) fetch(c context.Context) error {
db := database.Get(c)
rows, err := db.QueryContext(c, `
SELECT id, name, description, manufacturer
FROM platforms
`)
if err != nil {
return errors.Annotate(err, "failed to select platforms").Err()
}
defer rows.Close()
for rows.Next() {
p := &Platform{}
if err := rows.Scan(&p.Id, &p.Name, &p.Description, &p.Manufacturer); err != nil {
return errors.Annotate(err, "failed to scan platform").Err()
}
t.current = append(t.current, p)
}
return nil
}
// needsUpdate returns true if the given row needs to be updated to match the given config.
func (*PlatformsTable) needsUpdate(row, cfg *Platform) bool {
return row.Description != cfg.Description || row.Manufacturer != cfg.Manufacturer
}
// computeChanges computes the changes that need to be made to the platforms in the database.
func (t *PlatformsTable) computeChanges(c context.Context, platforms []*config.Platform) {
cfgs := make(map[string]*Platform, len(platforms))
for _, cfg := range platforms {
cfgs[cfg.Name] = &Platform{
Platform: config.Platform{
Name: cfg.Name,
Description: cfg.Description,
Manufacturer: cfg.Manufacturer,
},
}
}
for _, p := range t.current {
if cfg, ok := cfgs[p.Name]; ok {
// Platform found in the config.
if t.needsUpdate(p, cfg) {
// Platform doesn't match the config.
cfg.Id = p.Id
t.updates = append(t.updates, cfg)
}
// Record that the platform config has been seen.
delete(cfgs, cfg.Name)
} else {
// Platform not found in the config.
t.removals = append(t.removals, p)
}
}
// Platforms remaining in the map are present in the config but not the database.
// Iterate deterministically over the slice to determine which platforms need to be added.
for _, cfg := range platforms {
if p, ok := cfgs[cfg.Name]; ok {
t.additions = append(t.additions, p)
}
}
}
// add adds all platforms pending addition to the database, clearing pending additions.
// No-op unless computeChanges was called first. Idempotent until computeChanges is called again.
func (t *PlatformsTable) add(c context.Context) error {
// Avoid using the database connection to prepare unnecessary statements.
if len(t.additions) == 0 {
return nil
}
db := database.Get(c)
stmt, err := db.PrepareContext(c, `
INSERT INTO platforms (name, description, manufacturer)
VALUES (?, ?, ?)
`)
if err != nil {
return errors.Annotate(err, "failed to prepare statement").Err()
}
defer stmt.Close()
// Add each platform to the database, and update the slice of platforms with each addition.
for len(t.additions) > 0 {
p := t.additions[0]
result, err := stmt.ExecContext(c, p.Name, p.Description, p.Manufacturer)
if err != nil {
return errors.Annotate(err, "failed to add platform %q", p.Name).Err()
}
t.current = append(t.current, p)
t.additions = t.additions[1:]
logging.Infof(c, "Added platform %q", p.Name)
p.Id, err = result.LastInsertId()
if err != nil {
return errors.Annotate(err, "failed to get platform ID %q", p.Name).Err()
}
}
return nil
}
// remove removes all platforms pending removal from the database, clearing pending removals.
// No-op unless computeChanges was called first. Idempotent until computeChanges is called again.
func (t *PlatformsTable) remove(c context.Context) error {
// Avoid using the database connection to prepare unnecessary statements.
if len(t.removals) == 0 {
return nil
}
db := database.Get(c)
stmt, err := db.PrepareContext(c, `
DELETE FROM platforms
WHERE id = ?
`)
if err != nil {
return errors.Annotate(err, "failed to prepare statement").Err()
}
defer stmt.Close()
// Remove each platform from the table. It's more efficient to update the slice of
// platforms once at the end rather than for each removal, so use a defer.
removed := make(map[int64]struct{}, len(t.removals))
defer func() {
var platforms []*Platform
for _, p := range t.current {
if _, ok := removed[p.Id]; !ok {
platforms = append(platforms, p)
}
}
t.current = platforms
}()
for len(t.removals) > 0 {
p := t.removals[0]
if _, err := stmt.ExecContext(c, p.Id); err != nil {
// Defer ensures the slice of platforms is updated even if we exit early.
return errors.Annotate(err, "failed to remove platform %q", p.Name).Err()
}
removed[p.Id] = struct{}{}
t.removals = t.removals[1:]
logging.Infof(c, "Removed platform %q", p.Name)
}
return nil
}
// update updates all platforms pending update in the database, clearing pending updates.
// No-op unless computeChanges was called first. Idempotent until computeChanges is called again.
func (t *PlatformsTable) update(c context.Context) error {
// Avoid using the database connection to prepare unnecessary statements.
if len(t.updates) == 0 {
return nil
}
db := database.Get(c)
stmt, err := db.PrepareContext(c, `
UPDATE platforms
SET description = ?, manufacturer = ?
WHERE id = ?
`)
if err != nil {
return errors.Annotate(err, "failed to prepare statement").Err()
}
defer stmt.Close()
// Update each platform in the table. It's more efficient to update the slice of
// platforms once at the end rather than for each update, so use a defer.
updated := make(map[int64]*Platform, len(t.updates))
defer func() {
for _, p := range t.current {
if u, ok := updated[p.Id]; ok {
p.Description = u.Description
p.Manufacturer = u.Manufacturer
}
}
}()
for len(t.updates) > 0 {
p := t.updates[0]
if _, err := stmt.ExecContext(c, p.Description, p.Manufacturer, p.Id); err != nil {
return errors.Annotate(err, "failed to update platform %q", p.Name).Err()
}
updated[p.Id] = p
t.updates = t.updates[1:]
logging.Infof(c, "Updated platform %q", p.Name)
}
return nil
}
// ids returns a map of platform names to IDs.
func (t *PlatformsTable) ids(c context.Context) map[string]int64 {
platforms := make(map[string]int64, len(t.current))
for _, p := range t.current {
platforms[p.Name] = p.Id
}
return platforms
}
// EnsurePlatforms ensures the database contains exactly the given platforms.
// Returns a map of platform names to IDs.
func EnsurePlatforms(c context.Context, cfgs []*config.Platform) (map[string]int64, error) {
t := &PlatformsTable{}
if err := t.fetch(c); err != nil {
return nil, errors.Annotate(err, "failed to fetch platforms").Err()
}
t.computeChanges(c, cfgs)
if err := t.add(c); err != nil {
return nil, errors.Annotate(err, "failed to add platforms").Err()
}
if err := t.remove(c); err != nil {
return nil, errors.Annotate(err, "failed to remove platforms").Err()
}
if err := t.update(c); err != nil {
return nil, errors.Annotate(err, "failed to update platforms").Err()
}
return t.ids(c), nil
}