-
Notifications
You must be signed in to change notification settings - Fork 302
/
client_store.go
207 lines (194 loc) · 6.99 KB
/
client_store.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
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// 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 store
import (
"context"
"fmt"
"reflect"
"runtime/trace"
"strings"
pbtypes "github.com/gogo/protobuf/types"
"github.com/jinzhu/gorm"
"go.thethings.network/lorawan-stack/v3/pkg/rpcmiddleware/warning"
"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
)
// GetClientStore returns an ClientStore on the given db (or transaction).
func GetClientStore(db *gorm.DB) ClientStore {
return &clientStore{store: newStore(db)}
}
type clientStore struct {
*store
}
// selectClientFields selects relevant fields (based on fieldMask) and preloads details if needed.
func selectClientFields(ctx context.Context, query *gorm.DB, fieldMask *pbtypes.FieldMask) *gorm.DB {
if len(fieldMask.GetPaths()) == 0 {
return query.Preload("Attributes")
}
var clientColumns []string
var notFoundPaths []string
for _, path := range ttnpb.TopLevelFields(fieldMask.GetPaths()) {
switch path {
case "ids", "created_at", "updated_at", "deleted_at":
// always selected
case attributesField:
query = query.Preload("Attributes")
case administrativeContactField:
clientColumns = append(clientColumns, clientColumnNames[path]...)
query = query.Preload("AdministrativeContact")
case technicalContactField:
clientColumns = append(clientColumns, clientColumnNames[path]...)
query = query.Preload("TechnicalContact")
default:
if columns, ok := clientColumnNames[path]; ok {
clientColumns = append(clientColumns, columns...)
} else {
notFoundPaths = append(notFoundPaths, path)
}
}
}
if len(notFoundPaths) > 0 {
warning.Add(ctx, fmt.Sprintf("unsupported field mask paths: %s", strings.Join(notFoundPaths, ", ")))
}
return query.Select(cleanFields(append(append(modelColumns, "deleted_at", "client_id"), clientColumns...)...))
}
func (s *clientStore) CreateClient(ctx context.Context, cli *ttnpb.Client) (*ttnpb.Client, error) {
defer trace.StartRegion(ctx, "create client").End()
cliModel := Client{
ClientID: cli.GetIds().GetClientId(), // The ID is not mutated by fromPB.
}
cliModel.fromPB(cli, nil)
var err error
cliModel.AdministrativeContactID, err = s.loadContact(ctx, cliModel.AdministrativeContact)
if err != nil {
return nil, err
}
cliModel.TechnicalContactID, err = s.loadContact(ctx, cliModel.TechnicalContact)
if err != nil {
return nil, err
}
if err := s.createEntity(ctx, &cliModel); err != nil {
return nil, err
}
var cliProto ttnpb.Client
cliModel.toPB(&cliProto, nil)
return &cliProto, nil
}
func (s *clientStore) FindClients(ctx context.Context, ids []*ttnpb.ClientIdentifiers, fieldMask *pbtypes.FieldMask) ([]*ttnpb.Client, error) {
defer trace.StartRegion(ctx, "find clients").End()
idStrings := make([]string, len(ids))
for i, id := range ids {
idStrings[i] = id.GetClientId()
}
query := s.query(ctx, Client{}, withClientID(idStrings...))
query = selectClientFields(ctx, query, fieldMask)
query = query.Order(orderFromContext(ctx, "clients", "client_id", "ASC"))
if limit, offset := limitAndOffsetFromContext(ctx); limit != 0 {
countTotal(ctx, query.Model(Client{}))
query = query.Limit(limit).Offset(offset)
}
if onlyExpired, expireThreshold := expiredFromContext(ctx); onlyExpired {
query = query.Scopes(withExpiredEntities(expireThreshold))
}
var cliModels []Client
query = query.Find(&cliModels)
setTotal(ctx, uint64(len(cliModels)))
if query.Error != nil {
return nil, query.Error
}
cliProtos := make([]*ttnpb.Client, len(cliModels))
for i, cliModel := range cliModels {
cliProto := &ttnpb.Client{}
cliModel.toPB(cliProto, fieldMask)
cliProtos[i] = cliProto
}
return cliProtos, nil
}
func (s *clientStore) GetClient(ctx context.Context, id *ttnpb.ClientIdentifiers, fieldMask *pbtypes.FieldMask) (*ttnpb.Client, error) {
defer trace.StartRegion(ctx, "get client").End()
query := s.query(ctx, Client{}, withClientID(id.GetClientId()))
query = selectClientFields(ctx, query, fieldMask)
var cliModel Client
if err := query.First(&cliModel).Error; err != nil {
if gorm.IsRecordNotFoundError(err) {
return nil, errNotFoundForID(id)
}
return nil, err
}
cliProto := &ttnpb.Client{}
cliModel.toPB(cliProto, fieldMask)
return cliProto, nil
}
func (s *clientStore) UpdateClient(ctx context.Context, cli *ttnpb.Client, fieldMask *pbtypes.FieldMask) (updated *ttnpb.Client, err error) {
defer trace.StartRegion(ctx, "update client").End()
query := s.query(ctx, Client{}, withClientID(cli.GetIds().GetClientId()))
query = selectClientFields(ctx, query, fieldMask)
var cliModel Client
if err = query.First(&cliModel).Error; err != nil {
if gorm.IsRecordNotFoundError(err) {
return nil, errNotFoundForID(cli.GetIds())
}
return nil, err
}
if err := ctx.Err(); err != nil { // Early exit if context canceled
return nil, err
}
oldAttributes := cliModel.Attributes
columns := cliModel.fromPB(cli, fieldMask)
cliModel.AdministrativeContactID, err = s.loadContact(ctx, cliModel.AdministrativeContact)
if err != nil {
return nil, err
}
cliModel.TechnicalContactID, err = s.loadContact(ctx, cliModel.TechnicalContact)
if err != nil {
return nil, err
}
if err = s.updateEntity(ctx, &cliModel, columns...); err != nil {
return nil, err
}
if !reflect.DeepEqual(oldAttributes, cliModel.Attributes) {
if err = s.replaceAttributes(ctx, "client", cliModel.ID, oldAttributes, cliModel.Attributes); err != nil {
return nil, err
}
}
updated = &ttnpb.Client{}
cliModel.toPB(updated, fieldMask)
return updated, nil
}
func (s *clientStore) DeleteClient(ctx context.Context, id *ttnpb.ClientIdentifiers) error {
defer trace.StartRegion(ctx, "delete client").End()
return s.deleteEntity(ctx, id)
}
func (s *clientStore) RestoreClient(ctx context.Context, id *ttnpb.ClientIdentifiers) error {
defer trace.StartRegion(ctx, "restore client").End()
return s.restoreEntity(ctx, id)
}
func (s *clientStore) PurgeClient(ctx context.Context, id *ttnpb.ClientIdentifiers) error {
defer trace.StartRegion(ctx, "purge client").End()
query := s.query(ctx, Client{}, withSoftDeleted(), withClientID(id.GetClientId()))
query = selectClientFields(ctx, query, nil)
var cliModel Client
if err := query.First(&cliModel).Error; err != nil {
if gorm.IsRecordNotFoundError(err) {
return errNotFoundForID(id)
}
return err
}
// delete client attributes before purging
if len(cliModel.Attributes) > 0 {
if err := s.replaceAttributes(ctx, "gateway", cliModel.ID, cliModel.Attributes, nil); err != nil {
return err
}
}
return s.purgeEntity(ctx, id)
}