• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

Permify / permify / 10924599407

18 Sep 2024 02:46PM UTC coverage: 79.95% (+0.3%) from 79.691%
10924599407

Pull #1603

github

tolgaOzen
feat: add scope of entityIds to lookup-entity api filter
Pull Request #1603: feat: add scope of entityIds to lookup-entity api filter

379 of 478 new or added lines in 13 files covered. (79.29%)

31 existing lines in 4 files now uncovered.

7991 of 9995 relevant lines covered (79.95%)

119.29 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.51
/internal/storage/postgres/dataReader.go
1
package postgres
2

3
import (
4
        "context"
5
        "errors"
6
        "log/slog"
7
        "strconv"
8
        "strings"
9

10
        "github.com/jackc/pgx/v5"
11

12
        "github.com/Masterminds/squirrel"
13
        "github.com/golang/protobuf/jsonpb"
14
        "google.golang.org/protobuf/types/known/anypb"
15

16
        "github.com/Permify/permify/internal/storage"
17
        "github.com/Permify/permify/internal/storage/postgres/snapshot"
18
        "github.com/Permify/permify/internal/storage/postgres/types"
19
        "github.com/Permify/permify/internal/storage/postgres/utils"
20
        "github.com/Permify/permify/pkg/database"
21
        db "github.com/Permify/permify/pkg/database/postgres"
22
        base "github.com/Permify/permify/pkg/pb/base/v1"
23
        "github.com/Permify/permify/pkg/token"
24
)
25

26
// DataReader is a struct which holds a reference to the database, transaction options and a logger.
27
// It is responsible for reading data from the database.
28
type DataReader struct {
29
        database  *db.Postgres  // database is an instance of the PostgreSQL database
30
        txOptions pgx.TxOptions // txOptions specifies the isolation level for database transaction and sets it as read only
31
}
32

33
// NewDataReader is a constructor function for DataReader.
34
// It initializes a new DataReader with a given database, a logger, and sets transaction options to be read-only with Repeatable Read isolation level.
35
func NewDataReader(database *db.Postgres) *DataReader {
13✔
36
        return &DataReader{
13✔
37
                database:  database,                                                             // Set the database to the passed in PostgreSQL instance
13✔
38
                txOptions: pgx.TxOptions{IsoLevel: pgx.ReadCommitted, AccessMode: pgx.ReadOnly}, // Set the transaction options
13✔
39
        }
13✔
40
}
13✔
41

42
// QueryRelationships reads relation tuples from the storage based on the given filter.
43
func (r *DataReader) QueryRelationships(ctx context.Context, tenantID string, filter *base.TupleFilter, snap string, pagination database.CursorPagination) (it *database.TupleIterator, err error) {
2✔
44
        // Start a new trace span and end it when the function exits.
2✔
45
        ctx, span := tracer.Start(ctx, "data-reader.query-relationships")
2✔
46
        defer span.End()
2✔
47

2✔
48
        slog.DebugContext(ctx, "querying relationships for tenant_id", slog.String("tenant_id", tenantID))
2✔
49

2✔
50
        // Decode the snapshot value.
2✔
51
        var st token.SnapToken
2✔
52
        st, err = snapshot.EncodedToken{Value: snap}.Decode()
2✔
53
        if err != nil {
2✔
54
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
55
        }
×
56

57
        // Build the relationships query based on the provided filter and snapshot value.
58
        var args []interface{}
2✔
59
        builder := r.database.Builder.Select("entity_type, entity_id, relation, subject_type, subject_id, subject_relation").From(RelationTuplesTable).Where(squirrel.Eq{"tenant_id": tenantID})
2✔
60
        builder = utils.TuplesFilterQueryForSelectBuilder(builder, filter)
2✔
61
        builder = utils.SnapshotQuery(builder, st.(snapshot.Token).Value.Uint)
2✔
62

2✔
63
        if pagination.Cursor() != "" {
2✔
64
                var t database.ContinuousToken
×
65
                t, err = utils.EncodedContinuousToken{Value: pagination.Cursor()}.Decode()
×
66
                if err != nil {
×
67
                        return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INVALID_CONTINUOUS_TOKEN)
×
68
                }
×
69
                builder = builder.Where(squirrel.GtOrEq{pagination.Sort(): t.(utils.ContinuousToken).Value})
×
70
        }
71

72
        if pagination.Sort() != "" {
2✔
73
                builder = builder.OrderBy(pagination.Sort())
×
74
        }
×
75

76
        // Generate the SQL query and arguments.
77
        var query string
2✔
78
        query, args, err = builder.ToSql()
2✔
79
        if err != nil {
2✔
80
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SQL_BUILDER)
×
81
        }
×
82

83
        slog.DebugContext(ctx, "generated sql query", slog.String("query", query), "with args", slog.Any("arguments", args))
2✔
84

2✔
85
        // Execute the SQL query and retrieve the result rows.
2✔
86
        var rows pgx.Rows
2✔
87
        rows, err = r.database.ReadPool.Query(ctx, query, args...)
2✔
88
        if err != nil {
2✔
89
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_EXECUTION)
×
90
        }
×
91
        defer rows.Close()
2✔
92

2✔
93
        // Process the result rows and store the relationships in a TupleCollection.
2✔
94
        collection := database.NewTupleCollection()
2✔
95
        for rows.Next() {
5✔
96
                rt := storage.RelationTuple{}
3✔
97
                err = rows.Scan(&rt.EntityType, &rt.EntityID, &rt.Relation, &rt.SubjectType, &rt.SubjectID, &rt.SubjectRelation)
3✔
98
                if err != nil {
3✔
99
                        return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
100
                }
×
101
                collection.Add(rt.ToTuple())
3✔
102
        }
103
        if err = rows.Err(); err != nil {
2✔
104
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
105
        }
×
106

107
        slog.DebugContext(ctx, "successfully retrieved relation tuples from the database")
2✔
108

2✔
109
        // Return a TupleIterator created from the TupleCollection.
2✔
110
        return collection.CreateTupleIterator(), nil
2✔
111
}
112

113
// ReadRelationships reads relation tuples from the storage based on the given filter and pagination.
114
func (r *DataReader) ReadRelationships(ctx context.Context, tenantID string, filter *base.TupleFilter, snap string, pagination database.Pagination) (collection *database.TupleCollection, ct database.EncodedContinuousToken, err error) {
10✔
115
        // Start a new trace span and end it when the function exits.
10✔
116
        ctx, span := tracer.Start(ctx, "data-reader.read-relationships")
10✔
117
        defer span.End()
10✔
118

10✔
119
        slog.DebugContext(ctx, "reading relationships for tenant_id", slog.String("tenant_id", tenantID))
10✔
120

10✔
121
        // Decode the snapshot value.
10✔
122
        var st token.SnapToken
10✔
123
        st, err = snapshot.EncodedToken{Value: snap}.Decode()
10✔
124
        if err != nil {
10✔
125
                return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
126
        }
×
127

128
        // Build the relationships query based on the provided filter, snapshot value, and pagination settings.
129
        builder := r.database.Builder.Select("id, entity_type, entity_id, relation, subject_type, subject_id, subject_relation").From(RelationTuplesTable).Where(squirrel.Eq{"tenant_id": tenantID})
10✔
130
        builder = utils.TuplesFilterQueryForSelectBuilder(builder, filter)
10✔
131
        builder = utils.SnapshotQuery(builder, st.(snapshot.Token).Value.Uint)
10✔
132

10✔
133
        // Apply the pagination token and limit to the query.
10✔
134
        if pagination.Token() != "" {
11✔
135
                var t database.ContinuousToken
1✔
136
                t, err = utils.EncodedContinuousToken{Value: pagination.Token()}.Decode()
1✔
137
                if err != nil {
1✔
138
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INVALID_CONTINUOUS_TOKEN)
×
139
                }
×
140
                var v uint64
1✔
141
                v, err = strconv.ParseUint(t.(utils.ContinuousToken).Value, 10, 64)
1✔
142
                if err != nil {
1✔
143
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INVALID_CONTINUOUS_TOKEN)
×
144
                }
×
145
                builder = builder.Where(squirrel.GtOrEq{"id": v})
1✔
146
        }
147

148
        builder = builder.OrderBy("id")
10✔
149

10✔
150
        if pagination.PageSize() != 0 {
20✔
151
                builder = builder.Limit(uint64(pagination.PageSize() + 1))
10✔
152
        }
10✔
153

154
        // Generate the SQL query and arguments.
155
        var query string
10✔
156
        var args []interface{}
10✔
157
        query, args, err = builder.ToSql()
10✔
158
        if err != nil {
10✔
159
                return nil, database.NewNoopContinuousToken().Encode(), utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SQL_BUILDER)
×
160
        }
×
161

162
        slog.DebugContext(ctx, "generated sql query", slog.String("query", query), "with args", slog.Any("arguments", args))
10✔
163

10✔
164
        // Execute the query and retrieve the rows.
10✔
165
        var rows pgx.Rows
10✔
166
        rows, err = r.database.ReadPool.Query(ctx, query, args...)
10✔
167
        if err != nil {
10✔
168
                return nil, database.NewNoopContinuousToken().Encode(), utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_EXECUTION)
×
169
        }
×
170
        defer rows.Close()
10✔
171

10✔
172
        var lastID uint64
10✔
173

10✔
174
        // Iterate through the rows and scan the result into a RelationTuple struct.
10✔
175
        tuples := make([]*base.Tuple, 0, pagination.PageSize()+1)
10✔
176
        for rows.Next() {
38✔
177
                rt := storage.RelationTuple{}
28✔
178
                err = rows.Scan(&rt.ID, &rt.EntityType, &rt.EntityID, &rt.Relation, &rt.SubjectType, &rt.SubjectID, &rt.SubjectRelation)
28✔
179
                if err != nil {
28✔
180
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
181
                }
×
182
                lastID = rt.ID
28✔
183
                tuples = append(tuples, rt.ToTuple())
28✔
184
        }
185
        // Check for any errors during iteration.
186
        if err = rows.Err(); err != nil {
10✔
187
                return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
188
        }
×
189

190
        slog.DebugContext(ctx, "successfully read relation tuples from database")
10✔
191

10✔
192
        // Return the results and encoded continuous token for pagination.
10✔
193
        if pagination.PageSize() != 0 && len(tuples) > int(pagination.PageSize()) {
11✔
194
                return database.NewTupleCollection(tuples[:pagination.PageSize()]...), utils.NewContinuousToken(strconv.FormatUint(lastID, 10)).Encode(), nil
1✔
195
        }
1✔
196

197
        return database.NewTupleCollection(tuples...), database.NewNoopContinuousToken().Encode(), nil
9✔
198
}
199

200
// QuerySingleAttribute retrieves a single attribute from the storage based on the given filter.
201
func (r *DataReader) QuerySingleAttribute(ctx context.Context, tenantID string, filter *base.AttributeFilter, snap string) (attribute *base.Attribute, err error) {
4✔
202
        // Start a new trace span and end it when the function exits.
4✔
203
        ctx, span := tracer.Start(ctx, "data-reader.query-single-attribute")
4✔
204
        defer span.End()
4✔
205

4✔
206
        slog.DebugContext(ctx, "querying single attribute for tenant_id", slog.String("tenant_id", tenantID))
4✔
207

4✔
208
        // Decode the snapshot value.
4✔
209
        var st token.SnapToken
4✔
210
        st, err = snapshot.EncodedToken{Value: snap}.Decode()
4✔
211
        if err != nil {
4✔
212
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
213
        }
×
214

215
        // Build the relationships query based on the provided filter and snapshot value.
216
        var args []interface{}
4✔
217
        builder := r.database.Builder.Select("entity_type, entity_id, attribute, value").From(AttributesTable).Where(squirrel.Eq{"tenant_id": tenantID})
4✔
218
        builder = utils.AttributesFilterQueryForSelectBuilder(builder, filter)
4✔
219
        builder = utils.SnapshotQuery(builder, st.(snapshot.Token).Value.Uint)
4✔
220

4✔
221
        // Generate the SQL query and arguments.
4✔
222
        var query string
4✔
223
        query, args, err = builder.ToSql()
4✔
224
        if err != nil {
4✔
225
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SQL_BUILDER)
×
226
        }
×
227

228
        slog.DebugContext(ctx, "generated sql query", slog.String("query", query), "with args", slog.Any("arguments", args))
4✔
229

4✔
230
        row := r.database.ReadPool.QueryRow(ctx, query, args...)
4✔
231

4✔
232
        rt := storage.Attribute{}
4✔
233

4✔
234
        // Suppose you have a struct `rt` with a field `Value` of type `*anypb.Any`.
4✔
235
        var valueStr string
4✔
236

4✔
237
        // Scan the row from the database into the fields of `rt` and `valueStr`.
4✔
238
        err = row.Scan(&rt.EntityType, &rt.EntityID, &rt.Attribute, &valueStr)
4✔
239
        if err != nil {
5✔
240
                if errors.Is(err, pgx.ErrNoRows) {
2✔
241
                        return nil, nil
1✔
242
                } else {
1✔
243
                        return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
244
                }
×
245
        }
246

247
        // Unmarshal the JSON data from `valueStr` into `rt.Value`.
248
        rt.Value = &anypb.Any{}
3✔
249
        unmarshaler := &jsonpb.Unmarshaler{}
3✔
250
        err = unmarshaler.Unmarshal(strings.NewReader(valueStr), rt.Value)
3✔
251
        if err != nil {
3✔
252
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
253
        }
×
254

255
        slog.DebugContext(ctx, "successfully retrieved Single attribute from the database")
3✔
256

3✔
257
        return rt.ToAttribute(), nil
3✔
258
}
259

260
// QueryAttributes reads multiple attributes from the storage based on the given filter.
261
func (r *DataReader) QueryAttributes(ctx context.Context, tenantID string, filter *base.AttributeFilter, snap string, pagination database.CursorPagination) (it *database.AttributeIterator, err error) {
2✔
262
        // Start a new trace span and end it when the function exits.
2✔
263
        ctx, span := tracer.Start(ctx, "data-reader.query-attributes")
2✔
264
        defer span.End()
2✔
265

2✔
266
        slog.DebugContext(ctx, "querying Attributes for tenant_id", slog.String("tenant_id", tenantID))
2✔
267

2✔
268
        // Decode the snapshot value.
2✔
269
        var st token.SnapToken
2✔
270
        st, err = snapshot.EncodedToken{Value: snap}.Decode()
2✔
271
        if err != nil {
2✔
272
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
273
        }
×
274

275
        // Build the relationships query based on the provided filter and snapshot value.
276
        var args []interface{}
2✔
277
        builder := r.database.Builder.Select("entity_type, entity_id, attribute, value").From(AttributesTable).Where(squirrel.Eq{"tenant_id": tenantID})
2✔
278
        builder = utils.AttributesFilterQueryForSelectBuilder(builder, filter)
2✔
279
        builder = utils.SnapshotQuery(builder, st.(snapshot.Token).Value.Uint)
2✔
280

2✔
281
        if pagination.Cursor() != "" {
2✔
NEW
282
                var t database.ContinuousToken
×
NEW
283
                t, err = utils.EncodedContinuousToken{Value: pagination.Cursor()}.Decode()
×
NEW
284
                if err != nil {
×
NEW
285
                        return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INVALID_CONTINUOUS_TOKEN)
×
NEW
286
                }
×
NEW
287
                builder = builder.Where(squirrel.GtOrEq{pagination.Sort(): t.(utils.ContinuousToken).Value})
×
288
        }
289

290
        if pagination.Sort() != "" {
2✔
NEW
291
                builder = builder.OrderBy(pagination.Sort())
×
NEW
292
        }
×
293

294
        // Generate the SQL query and arguments.
295
        var query string
2✔
296
        query, args, err = builder.ToSql()
2✔
297
        if err != nil {
2✔
298
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SQL_BUILDER)
×
299
        }
×
300

301
        slog.DebugContext(ctx, "generated sql query", slog.String("query", query), "with args", slog.Any("arguments", args))
2✔
302

2✔
303
        // Execute the SQL query and retrieve the result rows.
2✔
304
        var rows pgx.Rows
2✔
305
        rows, err = r.database.ReadPool.Query(ctx, query, args...)
2✔
306
        if err != nil {
2✔
307
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_EXECUTION)
×
308
        }
×
309
        defer rows.Close()
2✔
310

2✔
311
        // Process the result rows and store the relationships in a TupleCollection.
2✔
312
        collection := database.NewAttributeCollection()
2✔
313
        for rows.Next() {
5✔
314
                rt := storage.Attribute{}
3✔
315

3✔
316
                // Suppose you have a struct `rt` with a field `Value` of type `*anypb.Any`.
3✔
317
                var valueStr string
3✔
318

3✔
319
                // Scan the row from the database into the fields of `rt` and `valueStr`.
3✔
320
                err := rows.Scan(&rt.EntityType, &rt.EntityID, &rt.Attribute, &valueStr)
3✔
321
                if err != nil {
3✔
322
                        return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
323
                }
×
324

325
                // Unmarshal the JSON data from `valueStr` into `rt.Value`.
326
                rt.Value = &anypb.Any{}
3✔
327
                unmarshaler := &jsonpb.Unmarshaler{}
3✔
328
                err = unmarshaler.Unmarshal(strings.NewReader(valueStr), rt.Value)
3✔
329
                if err != nil {
3✔
330
                        return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
331
                }
×
332

333
                collection.Add(rt.ToAttribute())
3✔
334
        }
335
        if err = rows.Err(); err != nil {
2✔
336
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
337
        }
×
338

339
        slog.DebugContext(ctx, "successfully retrieved attributes tuples from the database")
2✔
340

2✔
341
        // Return a TupleIterator created from the TupleCollection.
2✔
342
        return collection.CreateAttributeIterator(), nil
2✔
343
}
344

345
// ReadAttributes reads multiple attributes from the storage based on the given filter and pagination.
346
func (r *DataReader) ReadAttributes(ctx context.Context, tenantID string, filter *base.AttributeFilter, snap string, pagination database.Pagination) (collection *database.AttributeCollection, ct database.EncodedContinuousToken, err error) {
10✔
347
        // Start a new trace span and end it when the function exits.
10✔
348
        ctx, span := tracer.Start(ctx, "data-reader.read-attributes")
10✔
349
        defer span.End()
10✔
350

10✔
351
        slog.DebugContext(ctx, "reading attributes for tenant_id", slog.String("tenant_id", tenantID))
10✔
352

10✔
353
        // Decode the snapshot value.
10✔
354
        var st token.SnapToken
10✔
355
        st, err = snapshot.EncodedToken{Value: snap}.Decode()
10✔
356
        if err != nil {
10✔
357
                return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
358
        }
×
359

360
        // Build the relationships query based on the provided filter, snapshot value, and pagination settings.
361
        builder := r.database.Builder.Select("id, entity_type, entity_id, attribute, value").From(AttributesTable).Where(squirrel.Eq{"tenant_id": tenantID})
10✔
362
        builder = utils.AttributesFilterQueryForSelectBuilder(builder, filter)
10✔
363
        builder = utils.SnapshotQuery(builder, st.(snapshot.Token).Value.Uint)
10✔
364

10✔
365
        // Apply the pagination token and limit to the query.
10✔
366
        if pagination.Token() != "" {
11✔
367
                var t database.ContinuousToken
1✔
368
                t, err = utils.EncodedContinuousToken{Value: pagination.Token()}.Decode()
1✔
369
                if err != nil {
1✔
370
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INVALID_CONTINUOUS_TOKEN)
×
371
                }
×
372
                var v uint64
1✔
373
                v, err = strconv.ParseUint(t.(utils.ContinuousToken).Value, 10, 64)
1✔
374
                if err != nil {
1✔
375
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INVALID_CONTINUOUS_TOKEN)
×
376
                }
×
377
                builder = builder.Where(squirrel.GtOrEq{"id": v})
1✔
378
        }
379

380
        builder = builder.OrderBy("id")
10✔
381

10✔
382
        if pagination.PageSize() != 0 {
20✔
383
                builder = builder.Limit(uint64(pagination.PageSize() + 1))
10✔
384
        }
10✔
385

386
        // Generate the SQL query and arguments.
387
        var query string
10✔
388
        var args []interface{}
10✔
389
        query, args, err = builder.ToSql()
10✔
390
        if err != nil {
10✔
391
                return nil, database.NewNoopContinuousToken().Encode(), utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SQL_BUILDER)
×
392
        }
×
393

394
        slog.DebugContext(ctx, "generated sql query", slog.String("query", query), "with args", slog.Any("arguments", args))
10✔
395

10✔
396
        // Execute the query and retrieve the rows.
10✔
397
        var rows pgx.Rows
10✔
398
        rows, err = r.database.ReadPool.Query(ctx, query, args...)
10✔
399
        if err != nil {
10✔
400
                return nil, database.NewNoopContinuousToken().Encode(), utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_EXECUTION)
×
401
        }
×
402
        defer rows.Close()
10✔
403

10✔
404
        var lastID uint64
10✔
405

10✔
406
        // Iterate through the rows and scan the result into a RelationTuple struct.
10✔
407
        attributes := make([]*base.Attribute, 0, pagination.PageSize()+1)
10✔
408
        for rows.Next() {
31✔
409
                rt := storage.Attribute{}
21✔
410

21✔
411
                // Suppose you have a struct `rt` with a field `Value` of type `*anypb.Any`.
21✔
412
                var valueStr string
21✔
413

21✔
414
                // Scan the row from the database into the fields of `rt` and `valueStr`.
21✔
415
                err := rows.Scan(&rt.ID, &rt.EntityType, &rt.EntityID, &rt.Attribute, &valueStr)
21✔
416
                if err != nil {
21✔
417
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
418
                }
×
419
                lastID = rt.ID
21✔
420

21✔
421
                // Unmarshal the JSON data from `valueStr` into `rt.Value`.
21✔
422
                rt.Value = &anypb.Any{}
21✔
423
                unmarshaler := &jsonpb.Unmarshaler{}
21✔
424
                err = unmarshaler.Unmarshal(strings.NewReader(valueStr), rt.Value)
21✔
425
                if err != nil {
21✔
426
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
427
                }
×
428

429
                attributes = append(attributes, rt.ToAttribute())
21✔
430
        }
431
        // Check for any errors during iteration.
432
        if err = rows.Err(); err != nil {
10✔
433
                return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
434
        }
×
435

436
        slog.DebugContext(ctx, "successfully read attributes from the database")
10✔
437

10✔
438
        // Return the results and encoded continuous token for pagination.
10✔
439
        if len(attributes) > int(pagination.PageSize()) {
11✔
440
                return database.NewAttributeCollection(attributes[:pagination.PageSize()]...), utils.NewContinuousToken(strconv.FormatUint(lastID, 10)).Encode(), nil
1✔
441
        }
1✔
442

443
        return database.NewAttributeCollection(attributes...), database.NewNoopContinuousToken().Encode(), nil
9✔
444
}
445

446
// QueryUniqueSubjectReferences reads unique subject references from the storage based on the given filter and pagination.
447
func (r *DataReader) QueryUniqueSubjectReferences(ctx context.Context, tenantID string, subjectReference *base.RelationReference, snap string, pagination database.Pagination) (ids []string, ct database.EncodedContinuousToken, err error) {
4✔
448
        // Start a new trace span and end it when the function exits.
4✔
449
        ctx, span := tracer.Start(ctx, "data-reader.query-unique-subject-reference")
4✔
450
        defer span.End()
4✔
451

4✔
452
        slog.DebugContext(ctx, "querying unique subject references for tenant_id", slog.String("tenant_id", tenantID))
4✔
453

4✔
454
        // Decode the snapshot value.
4✔
455
        var st token.SnapToken
4✔
456
        st, err = snapshot.EncodedToken{Value: snap}.Decode()
4✔
457
        if err != nil {
4✔
458
                return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
459
        }
×
460

461
        // Build the relationships query based on the provided filter, snapshot value, and pagination settings.
462
        builder := r.database.Builder.
4✔
463
                Select("subject_id"). // This will pick the smallest `id` for each unique `subject_id`.
4✔
464
                From(RelationTuplesTable).
4✔
465
                Where(squirrel.Eq{"tenant_id": tenantID}).
4✔
466
                GroupBy("subject_id")
4✔
467
        builder = utils.TuplesFilterQueryForSelectBuilder(builder, &base.TupleFilter{Subject: &base.SubjectFilter{Type: subjectReference.GetType(), Relation: subjectReference.GetRelation()}})
4✔
468
        builder = utils.SnapshotQuery(builder, st.(snapshot.Token).Value.Uint)
4✔
469

4✔
470
        // Apply the pagination token and limit to the query.
4✔
471
        if pagination.Token() != "" {
5✔
472
                var t database.ContinuousToken
1✔
473
                t, err = utils.EncodedContinuousToken{Value: pagination.Token()}.Decode()
1✔
474
                if err != nil {
1✔
475
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INVALID_CONTINUOUS_TOKEN)
×
476
                }
×
477
                builder = builder.Where(squirrel.GtOrEq{"subject_id": t.(utils.ContinuousToken).Value})
1✔
478
        }
479

480
        builder = builder.OrderBy("subject_id")
4✔
481

4✔
482
        if pagination.PageSize() != 0 {
8✔
483
                builder = builder.Limit(uint64(pagination.PageSize() + 1))
4✔
484
        }
4✔
485

486
        // Generate the SQL query and arguments.
487
        var query string
4✔
488
        var args []interface{}
4✔
489
        query, args, err = builder.ToSql()
4✔
490
        if err != nil {
4✔
491
                return nil, database.NewNoopContinuousToken().Encode(), utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SQL_BUILDER)
×
492
        }
×
493

494
        slog.DebugContext(ctx, "generated sql query", slog.String("query", query), "with args", slog.Any("arguments", args))
4✔
495

4✔
496
        // Execute the query and retrieve the rows.
4✔
497
        var rows pgx.Rows
4✔
498
        rows, err = r.database.ReadPool.Query(ctx, query, args...)
4✔
499
        if err != nil {
4✔
500
                return nil, database.NewNoopContinuousToken().Encode(), utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_EXECUTION)
×
501
        }
×
502
        defer rows.Close()
4✔
503

4✔
504
        var lastID string
4✔
505

4✔
506
        // Iterate through the rows and scan the result into a RelationTuple struct.
4✔
507
        subjectIDs := make([]string, 0, pagination.PageSize()+1)
4✔
508
        for rows.Next() {
14✔
509
                var subjectID string
10✔
510
                err = rows.Scan(&subjectID)
10✔
511
                if err != nil {
10✔
512
                        return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_INTERNAL)
×
513
                }
×
514

515
                subjectIDs = append(subjectIDs, subjectID)
10✔
516
                lastID = subjectID
10✔
517
        }
518
        // Check for any errors during iteration.
519
        if err = rows.Err(); err != nil {
4✔
520
                return nil, nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
521
        }
×
522

523
        slog.DebugContext(ctx, "successfully retrieved unique subject references from the database")
4✔
524

4✔
525
        // Return the results and encoded continuous token for pagination.
4✔
526
        if pagination.PageSize() != 0 && len(subjectIDs) > int(pagination.PageSize()) {
5✔
527
                return subjectIDs[:pagination.PageSize()], utils.NewContinuousToken(lastID).Encode(), nil
1✔
528
        }
1✔
529

530
        return subjectIDs, database.NewNoopContinuousToken().Encode(), nil
3✔
531
}
532

533
// HeadSnapshot retrieves the latest snapshot token associated with the tenant.
534
func (r *DataReader) HeadSnapshot(ctx context.Context, tenantID string) (token.SnapToken, error) {
1✔
535
        // Start a new trace span and end it when the function exits.
1✔
536
        ctx, span := tracer.Start(ctx, "data-reader.head-snapshot")
1✔
537
        defer span.End()
1✔
538

1✔
539
        slog.DebugContext(ctx, "getting head snapshot for tenant_id", slog.String("tenant_id", tenantID))
1✔
540

1✔
541
        var xid types.XID8
1✔
542

1✔
543
        // Build the query to find the highest transaction ID associated with the tenant.
1✔
544
        builder := r.database.Builder.Select("id").From(TransactionsTable).Where(squirrel.Eq{"tenant_id": tenantID}).OrderBy("id DESC").Limit(1)
1✔
545
        query, args, err := builder.ToSql()
1✔
546
        if err != nil {
1✔
547
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SQL_BUILDER)
×
548
        }
×
549

550
        // Execute the query and retrieve the highest transaction ID.
551
        err = r.database.ReadPool.QueryRow(ctx, query, args...).Scan(&xid)
1✔
552
        if err != nil {
1✔
553
                // If no rows are found, return a snapshot token with a value of 0.
×
554
                if errors.Is(err, pgx.ErrNoRows) {
×
555
                        return snapshot.Token{Value: types.XID8{Uint: 0}}, nil
×
556
                }
×
557
                return nil, utils.HandleError(ctx, span, err, base.ErrorCode_ERROR_CODE_SCAN)
×
558
        }
559

560
        slog.DebugContext(ctx, "successfully retrieved latest snapshot token")
1✔
561

1✔
562
        // Return the latest snapshot token associated with the tenant.
1✔
563
        return snapshot.Token{Value: xid}, nil
1✔
564
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc