-
Notifications
You must be signed in to change notification settings - Fork 4
/
namespaces.go
336 lines (279 loc) · 7.97 KB
/
namespaces.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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
package db
import (
"context"
"database/sql"
"log/slog"
"strings"
sq "github.com/Masterminds/squirrel"
"github.com/jackc/pgx/v5"
"github.com/opentdf/platform/protocol/go/common"
"github.com/opentdf/platform/protocol/go/policy"
"github.com/opentdf/platform/protocol/go/policy/namespaces"
"github.com/opentdf/platform/service/pkg/db"
"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/types/known/wrapperspb"
)
type namespaceSelectOptions struct {
withFqn bool
state string
}
func hydrateNamespaceItem(row pgx.Row, opts namespaceSelectOptions) (*policy.Namespace, error) {
var (
id string
name string
active bool
metadataJSON []byte
fqn sql.NullString
)
fields := []interface{}{&id, &name, &active, &metadataJSON}
if opts.withFqn {
fields = append(fields, &fqn)
}
if err := row.Scan(fields...); err != nil {
return nil, db.WrapIfKnownInvalidQueryErr(err)
}
m := &common.Metadata{}
if metadataJSON != nil {
if err := protojson.Unmarshal(metadataJSON, m); err != nil {
slog.Error("could not unmarshal metadata", slog.String("error", err.Error()))
return nil, err
}
}
return &policy.Namespace{
Id: id,
Name: name,
Active: &wrapperspb.BoolValue{Value: active},
Metadata: m,
Fqn: fqn.String,
}, nil
}
func hydrateNamespaceItems(rows pgx.Rows, opts namespaceSelectOptions) ([]*policy.Namespace, error) {
var list []*policy.Namespace
for rows.Next() {
n, err := hydrateNamespaceItem(rows, opts)
if err != nil {
return nil, err
}
list = append(list, n)
}
return list, nil
}
func getNamespaceSQL(id string, opts namespaceSelectOptions) (string, []interface{}, error) {
t := Tables.Namespaces
fqnT := Tables.AttrFqn
fields := []string{
t.Field("id"),
t.Field("name"),
t.Field("active"),
constructMetadata("", false),
}
if opts.withFqn {
fields = append(fields, fqnT.Field("fqn"))
}
sb := db.NewStatementBuilder().
Select(fields...).
From(t.Name())
if opts.withFqn {
sb = sb.LeftJoin(fqnT.Name() + " ON " + fqnT.Field("namespace_id") + " = " + t.Field("id") +
" AND " + fqnT.Field("attribute_id") + " IS NULL")
}
return sb.
Where(sq.Eq{t.Field("id"): id}).
ToSql()
}
func (c PolicyDBClient) GetNamespace(ctx context.Context, id string) (*policy.Namespace, error) {
opts := namespaceSelectOptions{withFqn: true}
sql, args, err := getNamespaceSQL(id, opts)
if err != nil {
return nil, err
}
row, err := c.QueryRow(ctx, sql, args)
if err != nil {
return nil, err
}
n, err := hydrateNamespaceItem(row, opts)
if err != nil {
return nil, err
}
return n, nil
}
func listNamespacesSQL(opts namespaceSelectOptions) (string, []interface{}, error) {
t := Tables.Namespaces
fqnT := Tables.AttrFqn
fields := []string{
t.Field("id"),
t.Field("name"),
t.Field("active"),
constructMetadata("", false),
}
if opts.withFqn {
fields = append(fields, fqnT.Field("fqn"))
}
sb := db.NewStatementBuilder().
Select(fields...).
From(t.Name())
if opts.withFqn {
sb = sb.LeftJoin(fqnT.Name() + " ON " + fqnT.Field("namespace_id") + " = " + t.Field("id") +
" AND " + fqnT.Field("attribute_id") + " IS NULL")
}
if opts.state != "" && opts.state != StateAny {
sb = sb.Where(sq.Eq{t.Field("active"): opts.state == StateActive})
}
return sb.ToSql()
}
func (c PolicyDBClient) ListNamespaces(ctx context.Context, state string) ([]*policy.Namespace, error) {
opts := namespaceSelectOptions{withFqn: true, state: state}
sql, args, err := listNamespacesSQL(opts)
if err != nil {
slog.Error("error listing namespaces", slog.String("error", err.Error()))
return nil, err
}
rows, err := c.Query(ctx, sql, args)
if err != nil {
slog.Error("error listing namespaces", slog.String("sql", sql), slog.String("error", err.Error()))
return nil, err
}
defer rows.Close()
list, err := hydrateNamespaceItems(rows, opts)
if err != nil {
slog.Error("error hydrating namespace items", slog.String("sql", sql), slog.String("error", err.Error()))
return nil, err
}
return list, nil
}
func createNamespaceSQL(name string, metadata []byte) (string, []interface{}, error) {
t := Tables.Namespaces
return db.NewStatementBuilder().
Insert(t.Name()).
Columns("name", "metadata").
Values(name, metadata).
Suffix(createSuffix).
ToSql()
}
func (c PolicyDBClient) CreateNamespace(ctx context.Context, r *namespaces.CreateNamespaceRequest) (*policy.Namespace, error) {
metadataJSON, m, err := db.MarshalCreateMetadata(r.GetMetadata())
if err != nil {
return nil, err
}
name := strings.ToLower(r.GetName())
sql, args, err := createNamespaceSQL(name, metadataJSON)
if err != nil {
return nil, err
}
var id string
if r, e := c.QueryRow(ctx, sql, args); e != nil {
return nil, e
} else if e = r.Scan(&id, &metadataJSON); e != nil {
return nil, db.WrapIfKnownInvalidQueryErr(e)
}
if err = unmarshalMetadata(metadataJSON, m); err != nil {
return nil, err
}
// Update FQN
c.upsertAttrFqn(ctx, attrFqnUpsertOptions{namespaceID: id})
return &policy.Namespace{
Id: id,
Name: name,
Active: &wrapperspb.BoolValue{Value: true},
Metadata: m,
}, nil
}
func updateNamespaceSQL(id string, metadata []byte) (string, []interface{}, error) {
t := Tables.Namespaces
sb := db.NewStatementBuilder().Update(t.Name())
if metadata != nil {
sb = sb.Set("metadata", metadata)
}
return sb.Where(sq.Eq{t.Field("id"): id}).ToSql()
}
func (c PolicyDBClient) UpdateNamespace(ctx context.Context, id string, r *namespaces.UpdateNamespaceRequest) (*policy.Namespace, error) {
// if extend we need to merge the metadata
metadataJSON, _, err := db.MarshalUpdateMetadata(r.GetMetadata(), r.GetMetadataUpdateBehavior(), func() (*common.Metadata, error) {
n, err := c.GetNamespace(ctx, id)
if err != nil {
return nil, err
}
if n.GetMetadata() == nil {
return nil, nil //nolint:nilnil // no metadata does not mean no error
}
return n.GetMetadata(), nil
})
if err != nil {
return nil, err
}
sql, args, err := updateNamespaceSQL(id, metadataJSON)
if db.IsQueryBuilderSetClauseError(err) {
return &policy.Namespace{
Id: id,
}, nil
}
if err != nil {
return nil, err
}
if err := c.Exec(ctx, sql, args); err != nil {
return nil, err
}
// Update FQN
c.upsertAttrFqn(ctx, attrFqnUpsertOptions{namespaceID: id})
return &policy.Namespace{
Id: id,
}, nil
}
func deactivateNamespaceSQL(id string) (string, []interface{}, error) {
t := Tables.Namespaces
return db.NewStatementBuilder().
Update(t.Name()).
Set("active", false).
Where(sq.Eq{t.Field("id"): id}).
Suffix("RETURNING \"id\"").
ToSql()
}
func (c PolicyDBClient) DeactivateNamespace(ctx context.Context, id string) (*policy.Namespace, error) {
attrs, err := c.GetAttributesByNamespace(ctx, id)
if err != nil {
return nil, err
}
allAttrsDeactivated := true
for _, attr := range attrs {
if attr.GetActive().GetValue() {
allAttrsDeactivated = false
break
}
}
if !allAttrsDeactivated {
slog.Warn("deactivating the namespace with existed attributes can affect access to related data. Please be aware and proceed accordingly.")
}
sql, args, err := deactivateNamespaceSQL(id)
if err != nil {
return nil, err
}
if e := c.Exec(ctx, sql, args); e != nil {
return nil, e
}
return c.GetNamespace(ctx, id)
}
func deleteNamespaceSQL(id string) (string, []interface{}, error) {
t := Tables.Namespaces
// TODO: handle delete cascade, dangerous deletion via special rpc [https://github.com/opentdf/platform/issues/115]
return db.NewStatementBuilder().
Delete(t.Name()).
Where(sq.Eq{t.Field("id"): id}).
Suffix("RETURNING \"id\"").
ToSql()
}
func (c PolicyDBClient) DeleteNamespace(ctx context.Context, id string) (*policy.Namespace, error) {
// get a namespace before deleting
ns, err := c.GetNamespace(ctx, id)
if err != nil {
return nil, err
}
sql, args, err := deleteNamespaceSQL(id)
if err != nil {
return nil, err
}
if err := c.Exec(ctx, sql, args); err != nil {
return nil, err
}
// return the namespace before it was deleted
return ns, nil
}