-
Notifications
You must be signed in to change notification settings - Fork 10
/
attribute_fqn.go
212 lines (193 loc) · 6.96 KB
/
attribute_fqn.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
package db
import (
"context"
"errors"
"fmt"
"log/slog"
"strings"
"github.com/Masterminds/squirrel"
"github.com/opentdf/platform/protocol/go/policy"
"github.com/opentdf/platform/protocol/go/policy/attributes"
"github.com/opentdf/platform/service/pkg/db"
)
// These values are optional, but at least one must be set. The other values will be derived from
// the set values.
type attrFqnUpsertOptions struct {
namespaceID string
attributeID string
valueID string
}
// This logic is a bit complex. What we are trying to achieve is to upsert the fqn based on the
// combination of namespaceId, attributeId, and valueId. However, instead of requiring all three
// we want to support partial attribute FQNs. This means that we need to support the following
// combinations:
// 1. namespaceId
// 2. namespaceId, attributeId
// 3. namespaceId, attributeId, valueId
func upsertAttrFqnSQL(namespaceID string, attributeID string, valueID string) (string, []interface{}, error) {
t := Tables.AttrFqn
nT := Tables.Namespaces
adT := Tables.Attributes
avT := Tables.AttributeValues
sb := db.NewStatementBuilder()
var subQ squirrel.SelectBuilder
// Since we are creating relationships we don't need to know the namespaceId when given the
// valueId. This is because the valueId is unique across all namespaces.
switch {
case valueID != "":
subQ = sb.Select("n.id", "ad.id", "av.id", "CONCAT('https://', n.name, '/attr/', ad.name, '/value/', av.value) AS fqn").
From(nT.Name()+" n").
Join(adT.Name()+" ad ON ad.namespace_id = n.id").
Join(avT.Name()+" av ON av.attribute_definition_id = ad.id").
Where("av.id = ?", valueID)
case attributeID != "":
subQ = sb.Select("n.id", "ad.id", "NULL", "CONCAT('https://', n.name, '/attr/', ad.name) AS fqn").
From(nT.Name()+" n").
Join(adT.Name()+" ad ON ad.namespace_id = n.id").
Where("ad.id = ?", attributeID)
case namespaceID != "":
subQ = sb.Select("n.id", "NULL", "NULL", "CONCAT('https://', n.name) AS fqn").
From(nT.Name()+" n").
Where("n.id = ?", namespaceID)
default:
return "", nil, fmt.Errorf("at least one of namespaceId, attributeId, or valueId must be set")
}
return db.NewStatementBuilder().
Insert(t.Name()).
Columns("namespace_id", "attribute_id", "value_id", "fqn").
Select(subQ).
Suffix("ON CONFLICT (namespace_id, attribute_id, value_id) DO UPDATE SET fqn = EXCLUDED.fqn" +
" RETURNING fqn").
ToSql()
}
// This is a side effect -- errors will be swallowed and the fqn will be returned as an empty string
func (c *PolicyDBClient) upsertAttrFqn(ctx context.Context, opts attrFqnUpsertOptions) string {
sql, args, err := upsertAttrFqnSQL(opts.namespaceID, opts.attributeID, opts.valueID)
if err != nil {
c.logger.Error("could not update FQN", slog.Any("opts", opts), slog.String("error", err.Error()))
return ""
}
r, err := c.QueryRow(ctx, sql, args)
if err != nil {
c.logger.Error("could not update FQN", slog.Any("opts", opts), slog.String("error", err.Error()))
return ""
}
var fqn string
if err := r.Scan(&fqn); err != nil {
c.logger.Error("could not update FQN", slog.Any("opts", opts), slog.String("error", err.Error()))
return ""
}
c.logger.Debug("updated FQN", slog.String("fqn", fqn), slog.Any("opts", opts))
return fqn
}
// AttrFqnReindex will reindex all namespace, attribute, and attribute_value FQNs
func (c *PolicyDBClient) AttrFqnReindex() (res struct { //nolint:nonamedreturns // Used to initialize an anonymous struct
Namespaces []struct {
ID string
Fqn string
}
Attributes []struct {
ID string
Fqn string
}
Values []struct {
ID string
Fqn string
}
},
) {
// Get all namespaces
ns, err := c.ListNamespaces(context.Background(), StateAny)
if err != nil {
panic(fmt.Errorf("could not get namespaces: %w", err))
}
// Get all attributes
attrs, err := c.ListAllAttributesWithout(context.Background(), StateAny)
if err != nil {
panic(fmt.Errorf("could not get attributes: %w", err))
}
// Get all attribute values
values, err := c.ListAllAttributeValues(context.Background(), StateAny)
if err != nil {
panic(fmt.Errorf("could not get attribute values: %w", err))
}
// Reindex all namespaces
for _, n := range ns {
res.Namespaces = append(res.Namespaces, struct {
ID string
Fqn string
}{ID: n.GetId(), Fqn: c.upsertAttrFqn(context.Background(), attrFqnUpsertOptions{namespaceID: n.GetId()})})
}
// Reindex all attributes
for _, a := range attrs {
res.Attributes = append(res.Attributes, struct {
ID string
Fqn string
}{ID: a.GetId(), Fqn: c.upsertAttrFqn(context.Background(), attrFqnUpsertOptions{attributeID: a.GetId()})})
}
// Reindex all attribute values
for _, av := range values {
res.Values = append(res.Values, struct {
ID string
Fqn string
}{ID: av.GetId(), Fqn: c.upsertAttrFqn(context.Background(), attrFqnUpsertOptions{valueID: av.GetId()})})
}
return res
}
func prepareValues(values []*policy.Value, fqn string) ([]*policy.Value, *policy.Value) {
split := strings.Split(fqn, "/value/")
val := split[1]
attrFqn := split[0]
var unaltered *policy.Value
for i, v := range values {
if v.GetValue() == val {
unaltered = &policy.Value{
Id: v.GetId(),
Value: v.GetValue(),
//nolint:staticcheck // SA1019: removing all references to members in later release
Members: v.GetMembers(),
Grants: v.GetGrants(),
Fqn: fqn,
Active: v.GetActive(),
SubjectMappings: v.GetSubjectMappings(),
Metadata: v.GetMetadata(),
}
values[i].SubjectMappings = nil
}
// ensure all values have FQNs
if values[i].GetFqn() == "" {
values[i].Fqn = attrFqn + "/value/" + v.GetValue()
}
}
return values, unaltered
}
func (c *PolicyDBClient) GetAttributesByValueFqns(ctx context.Context, r *attributes.GetAttributeValuesByFqnsRequest) (map[string]*attributes.GetAttributeValuesByFqnsResponse_AttributeAndValue, error) {
if r.Fqns == nil || r.GetWithValue() == nil {
return nil, errors.Join(db.ErrMissingValue, errors.New("error: one or more FQNs and a WithValue selector must be provided"))
}
list := make(map[string]*attributes.GetAttributeValuesByFqnsResponse_AttributeAndValue, len(r.GetFqns()))
for _, fqn := range r.GetFqns() {
// normalize to lower case
fqn = strings.ToLower(fqn)
// ensure the FQN corresponds to an attribute value and not a definition or namespace alone
if !strings.Contains(fqn, "/value/") {
return nil, db.ErrFqnMissingValue
}
attr, err := c.GetAttributeByFqn(ctx, fqn)
if err != nil {
c.logger.Error("could not get attribute by FQN", slog.String("fqn", fqn), slog.String("error", err.Error()))
return nil, err
}
filtered, selected := prepareValues(attr.GetValues(), fqn)
if selected == nil {
c.logger.Error("could not find value for FQN", slog.String("fqn", fqn))
return nil, fmt.Errorf("could not find value for FQN [%s] %w", fqn, db.ErrNotFound)
}
attr.Values = filtered
list[fqn] = &attributes.GetAttributeValuesByFqnsResponse_AttributeAndValue{
Attribute: attr,
Value: selected,
}
}
return list, nil
}