9975333611

Committed 17 Jul 2024 01:39PM UTC coverage: 80.108%. Remained the same

Build # 9975333611

Build Type

Pull #1365

github

Committed by

web-flow

Commit Message

fix: update sdk-generator.yml

-add release version to sdk commit message

Pull Request Pull Request #1365: fix: update sdk-generator.yml

Run Details

7732 of 9652 relevant lines covered (80.11%)

49.07 hits per line

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

62.61

/internal/storage/postgres/utils/common.go

package utils

import (
        "context"
        "errors"
        "fmt"
        "log/slog"
        "math"
        "strings"
        "time"

        "go.opentelemetry.io/otel/codes"
        "golang.org/x/exp/rand"

        "go.opentelemetry.io/otel/trace"

        "github.com/Masterminds/squirrel"

        base "github.com/Permify/permify/pkg/pb/base/v1"
)

const (
        BulkEntityFilterTemplate = `
    WITH entities AS (
        (SELECT id, entity_id, entity_type, tenant_id, created_tx_id, expired_tx_id FROM relation_tuples)
        UNION ALL
        (SELECT id, entity_id, entity_type, tenant_id, created_tx_id, expired_tx_id FROM attributes)
    ), filtered_entities AS (
        SELECT DISTINCT ON (entity_id) id, entity_id
        FROM entities
        WHERE tenant_id = '%s'
        AND entity_type = '%s'
        AND %s
        AND %s
    )
    SELECT id, entity_id
    FROM filtered_entities`

        TransactionTemplate  = `INSERT INTO transactions (tenant_id) VALUES ($1) RETURNING id`
        InsertTenantTemplate = `INSERT INTO tenants (id, name) VALUES ($1, $2) RETURNING created_at`
        DeleteTenantTemplate = `DELETE FROM tenants WHERE id = $1 RETURNING name, created_at`
)

// SnapshotQuery adds conditions to a SELECT query for checking transaction visibility based on created and expired transaction IDs.
// The query checks if transactions are visible in a snapshot associated with the provided value.
func SnapshotQuery(sl squirrel.SelectBuilder, value uint64) squirrel.SelectBuilder {
        // Convert the value to a string once to reduce redundant calls to fmt.Sprintf.
        valStr := fmt.Sprintf("'%v'::xid8", value)

        // Create a subquery for the snapshot associated with the provided value.
        snapshotQuery := fmt.Sprintf("(select snapshot from transactions where id = %s)", valStr)

        // Create an expression to check if a transaction with a specific created_tx_id is visible in the snapshot.
        visibilityExpr := squirrel.Expr(fmt.Sprintf("pg_visible_in_snapshot(created_tx_id, %s) = true", snapshotQuery))
        // Create an expression to check if the created_tx_id is equal to the provided value.
        createdExpr := squirrel.Expr(fmt.Sprintf("created_tx_id = %s", valStr))
        // Use OR condition for the created expressions.
        createdWhere := squirrel.Or{visibilityExpr, createdExpr}

        // Create an expression to check if a transaction with a specific expired_tx_id is not visible in the snapshot.
        expiredVisibilityExpr := squirrel.Expr(fmt.Sprintf("pg_visible_in_snapshot(expired_tx_id, %s) = false", snapshotQuery))
        // Create an expression to check if the expired_tx_id is equal to zero.
        expiredZeroExpr := squirrel.Expr("expired_tx_id = '0'::xid8")
        // Create an expression to check if the expired_tx_id is not equal to the provided value.
        expiredNotExpr := squirrel.Expr(fmt.Sprintf("expired_tx_id <> %s", valStr))
        // Use AND condition for the expired expressions, checking both visibility and non-equality with value.
        expiredWhere := squirrel.And{squirrel.Or{expiredVisibilityExpr, expiredZeroExpr}, expiredNotExpr}

        // Add the created and expired conditions to the SELECT query.
        return sl.Where(createdWhere).Where(expiredWhere)
}

// snapshotQuery function generates two strings representing conditions to be applied in a SQL query to filter data based on visibility of transactions.
func snapshotQuery(value uint64) (string, string) {
        // Convert the provided value into a string format suitable for our SQL query, formatted as a transaction ID.
        valStr := fmt.Sprintf("'%v'::xid8", value)

        // Create a subquery that fetches the snapshot associated with the transaction ID.
        snapshotQ := fmt.Sprintf("(SELECT snapshot FROM transactions WHERE id = %s)", valStr)

        // Create an expression that checks whether a transaction (represented by 'created_tx_id') is visible in the snapshot.
        visibilityExpr := fmt.Sprintf("pg_visible_in_snapshot(created_tx_id, %s) = true", snapshotQ)
        // Create an expression that checks if the 'created_tx_id' is the same as our transaction ID.
        createdExpr := fmt.Sprintf("created_tx_id = %s", valStr)
        // Combine these expressions to form a condition. A row will satisfy this condition if either of the expressions are true.
        createdWhere := fmt.Sprintf("(%s OR %s)", visibilityExpr, createdExpr)

        // Create an expression that checks whether a transaction (represented by 'expired_tx_id') is not visible in the snapshot.
        expiredVisibilityExpr := fmt.Sprintf("pg_visible_in_snapshot(expired_tx_id, %s) = false", snapshotQ)
        // Create an expression that checks if the 'expired_tx_id' is zero. This handles cases where the transaction hasn't expired.
        expiredZeroExpr := "expired_tx_id = '0'::xid8"
        // Create an expression that checks if the 'expired_tx_id' is not the same as our transaction ID.
        expiredNotExpr := fmt.Sprintf("expired_tx_id <> %s", valStr)
        // Combine these expressions to form a condition. A row will satisfy this condition if the first set of expressions are true (either the transaction hasn't expired, or if it has, it's not visible in the snapshot) and the second expression is also true (the 'expired_tx_id' is not the same as our transaction ID).
        expiredWhere := fmt.Sprintf("(%s AND %s)", fmt.Sprintf("(%s OR %s)", expiredVisibilityExpr, expiredZeroExpr), expiredNotExpr)

        // Return the conditions for both 'created' and 'expired' transactions. These can be used in a WHERE clause of a SQL query to filter results.
        return createdWhere, expiredWhere
}

// BulkEntityFilterQuery -
func BulkEntityFilterQuery(tenantID, entityType string, snap uint64) string {
        createdWhere, expiredWhere := snapshotQuery(snap)
        return fmt.Sprintf(BulkEntityFilterTemplate, tenantID, entityType, createdWhere, expiredWhere)
}

// GenerateGCQuery generates a Squirrel DELETE query builder for garbage collection.
// It constructs a query to delete expired records from the specified table
// based on the provided value, which represents a transaction ID.
func GenerateGCQuery(table string, value uint64) squirrel.DeleteBuilder {
        // Convert the provided value into a string format suitable for our SQL query, formatted as a transaction ID.
        valStr := fmt.Sprintf("'%v'::xid8", value)

        // Create a Squirrel DELETE builder for the specified table.
        deleteBuilder := squirrel.Delete(table)

        // Create an expression to check if 'expired_tx_id' is not equal to '0' (not expired).
        expiredZeroExpr := squirrel.Expr("expired_tx_id <> '0'::xid8")

        // Create an expression to check if 'expired_tx_id' is less than the provided value (before the cutoff).
        beforeExpr := squirrel.Expr(fmt.Sprintf("expired_tx_id < %s", valStr))

        // Add the WHERE clauses to the DELETE query builder to filter and delete expired data.
        return deleteBuilder.Where(expiredZeroExpr).Where(beforeExpr)
}

// HandleError records an error in the given span, logs the error, and returns a standardized error.
// This function is used for consistent error handling across different parts of the application.
func HandleError(ctx context.Context, span trace.Span, err error, errorCode base.ErrorCode) error {
        // Check if the error is context-related
        if IsContextRelatedError(ctx, err) {
                slog.DebugContext(ctx, "A context-related error occurred",
                        slog.String("error", err.Error()))
                return errors.New(base.ErrorCode_ERROR_CODE_CANCELLED.String())
        }

        // Check if the error is serialization-related
        if IsSerializationRelatedError(err) {
                slog.DebugContext(ctx, "A serialization-related error occurred",
                        slog.String("error", err.Error()))
                return errors.New(base.ErrorCode_ERROR_CODE_SERIALIZATION.String())
        }

        // For all other types of errors, log them at the error level and record them in the span
        slog.ErrorContext(ctx, "An operational error occurred",
                slog.Any("error", err))
        span.RecordError(err)
        span.SetStatus(codes.Error, err.Error())

        // Return a new error with the standard error code provided
        return errors.New(errorCode.String())
}

// IsContextRelatedError checks if the error is due to context cancellation, deadline exceedance, or closed connection
func IsContextRelatedError(ctx context.Context, err error) bool {
        if errors.Is(ctx.Err(), context.Canceled) || errors.Is(ctx.Err(), context.DeadlineExceeded) {
                return true
        }
        if errors.Is(err, context.Canceled) ||
                errors.Is(err, context.DeadlineExceeded) ||
                strings.Contains(err.Error(), "conn closed") {
                return true
        }
        return false
}

// IsSerializationRelatedError checks if the error is a serialization failure, typically in database transactions.
func IsSerializationRelatedError(err error) bool {
        if strings.Contains(err.Error(), "could not serialize") ||
                strings.Contains(err.Error(), "duplicate key value") {
                return true
        }
        return false
}

// WaitWithBackoff implements an exponential backoff strategy with jitter for retries.
// It waits for a calculated duration or until the context is cancelled, whichever comes first.
func WaitWithBackoff(ctx context.Context, tenantID string, retries int) {
        backoff := time.Duration(math.Min(float64(20*time.Millisecond)*math.Pow(2, float64(retries)), float64(1*time.Second)))
        jitter := time.Duration(rand.Float64() * float64(backoff) * 0.5)
        nextBackoff := backoff + jitter
        slog.WarnContext(ctx, "waiting before retry", slog.String("tenant_id", tenantID), slog.Int64("backoff_duration", nextBackoff.Milliseconds()))
        select {
        case <-time.After(nextBackoff):
        case <-ctx.Done():
        }
}

1	package utils
2
3	import (
4	"context"
5	"errors"
6	"fmt"
7	"log/slog"
8	"math"
9	"strings"
10	"time"
11
12	"go.opentelemetry.io/otel/codes"
13	"golang.org/x/exp/rand"
14
15	"go.opentelemetry.io/otel/trace"
16
17	"github.com/Masterminds/squirrel"
18
19	base "github.com/Permify/permify/pkg/pb/base/v1"
20	)
21
22	const (
23	BulkEntityFilterTemplate = `
24	WITH entities AS (
25	(SELECT id, entity_id, entity_type, tenant_id, created_tx_id, expired_tx_id FROM relation_tuples)
26	UNION ALL
27	(SELECT id, entity_id, entity_type, tenant_id, created_tx_id, expired_tx_id FROM attributes)
28	), filtered_entities AS (
29	SELECT DISTINCT ON (entity_id) id, entity_id
30	FROM entities
31	WHERE tenant_id = '%s'
32	AND entity_type = '%s'
33	AND %s
34	AND %s
35	)
36	SELECT id, entity_id
37	FROM filtered_entities`
38
39	TransactionTemplate = `INSERT INTO transactions (tenant_id) VALUES ($1) RETURNING id`
40	InsertTenantTemplate = `INSERT INTO tenants (id, name) VALUES ($1, $2) RETURNING created_at`
41	DeleteTenantTemplate = `DELETE FROM tenants WHERE id = $1 RETURNING name, created_at`
42	)
43
44	// SnapshotQuery adds conditions to a SELECT query for checking transaction visibility based on created and expired transaction IDs.
45	// The query checks if transactions are visible in a snapshot associated with the provided value.
46	func SnapshotQuery(sl squirrel.SelectBuilder, value uint64) squirrel.SelectBuilder {	1✔
47	// Convert the value to a string once to reduce redundant calls to fmt.Sprintf.	1✔
48	valStr := fmt.Sprintf("'%v'::xid8", value)	1✔
49		1✔
50	// Create a subquery for the snapshot associated with the provided value.	1✔
51	snapshotQuery := fmt.Sprintf("(select snapshot from transactions where id = %s)", valStr)	1✔
52		1✔
53	// Create an expression to check if a transaction with a specific created_tx_id is visible in the snapshot.	1✔
54	visibilityExpr := squirrel.Expr(fmt.Sprintf("pg_visible_in_snapshot(created_tx_id, %s) = true", snapshotQuery))	1✔
55	// Create an expression to check if the created_tx_id is equal to the provided value.	1✔
56	createdExpr := squirrel.Expr(fmt.Sprintf("created_tx_id = %s", valStr))	1✔
57	// Use OR condition for the created expressions.	1✔
58	createdWhere := squirrel.Or{visibilityExpr, createdExpr}	1✔
59		1✔
60	// Create an expression to check if a transaction with a specific expired_tx_id is not visible in the snapshot.	1✔
61	expiredVisibilityExpr := squirrel.Expr(fmt.Sprintf("pg_visible_in_snapshot(expired_tx_id, %s) = false", snapshotQuery))	1✔
62	// Create an expression to check if the expired_tx_id is equal to zero.	1✔
63	expiredZeroExpr := squirrel.Expr("expired_tx_id = '0'::xid8")	1✔
64	// Create an expression to check if the expired_tx_id is not equal to the provided value.	1✔
65	expiredNotExpr := squirrel.Expr(fmt.Sprintf("expired_tx_id <> %s", valStr))	1✔
66	// Use AND condition for the expired expressions, checking both visibility and non-equality with value.	1✔
67	expiredWhere := squirrel.And{squirrel.Or{expiredVisibilityExpr, expiredZeroExpr}, expiredNotExpr}	1✔
68		1✔
69	// Add the created and expired conditions to the SELECT query.	1✔
70	return sl.Where(createdWhere).Where(expiredWhere)	1✔
71	}	1✔
72
73	// snapshotQuery function generates two strings representing conditions to be applied in a SQL query to filter data based on visibility of transactions.
74	func snapshotQuery(value uint64) (string, string) {	1✔
75	// Convert the provided value into a string format suitable for our SQL query, formatted as a transaction ID.	1✔
76	valStr := fmt.Sprintf("'%v'::xid8", value)	1✔
77		1✔
78	// Create a subquery that fetches the snapshot associated with the transaction ID.	1✔
79	snapshotQ := fmt.Sprintf("(SELECT snapshot FROM transactions WHERE id = %s)", valStr)	1✔
80		1✔
81	// Create an expression that checks whether a transaction (represented by 'created_tx_id') is visible in the snapshot.	1✔
82	visibilityExpr := fmt.Sprintf("pg_visible_in_snapshot(created_tx_id, %s) = true", snapshotQ)	1✔
83	// Create an expression that checks if the 'created_tx_id' is the same as our transaction ID.	1✔
84	createdExpr := fmt.Sprintf("created_tx_id = %s", valStr)	1✔
85	// Combine these expressions to form a condition. A row will satisfy this condition if either of the expressions are true.	1✔
86	createdWhere := fmt.Sprintf("(%s OR %s)", visibilityExpr, createdExpr)	1✔
87		1✔
88	// Create an expression that checks whether a transaction (represented by 'expired_tx_id') is not visible in the snapshot.	1✔
89	expiredVisibilityExpr := fmt.Sprintf("pg_visible_in_snapshot(expired_tx_id, %s) = false", snapshotQ)	1✔
90	// Create an expression that checks if the 'expired_tx_id' is zero. This handles cases where the transaction hasn't expired.	1✔
91	expiredZeroExpr := "expired_tx_id = '0'::xid8"	1✔
92	// Create an expression that checks if the 'expired_tx_id' is not the same as our transaction ID.	1✔
93	expiredNotExpr := fmt.Sprintf("expired_tx_id <> %s", valStr)	1✔
94	// Combine these expressions to form a condition. A row will satisfy this condition if the first set of expressions are true (either the transaction hasn't expired, or if it has, it's not visible in the snapshot) and the second expression is also true (the 'expired_tx_id' is not the same as our transaction ID).	1✔
95	expiredWhere := fmt.Sprintf("(%s AND %s)", fmt.Sprintf("(%s OR %s)", expiredVisibilityExpr, expiredZeroExpr), expiredNotExpr)	1✔
96		1✔
97	// Return the conditions for both 'created' and 'expired' transactions. These can be used in a WHERE clause of a SQL query to filter results.	1✔
98	return createdWhere, expiredWhere	1✔
99	}	1✔
100
101	// BulkEntityFilterQuery -
102	func BulkEntityFilterQuery(tenantID, entityType string, snap uint64) string {	1✔
103	createdWhere, expiredWhere := snapshotQuery(snap)	1✔
104	return fmt.Sprintf(BulkEntityFilterTemplate, tenantID, entityType, createdWhere, expiredWhere)	1✔
105	}	1✔
106
107	// GenerateGCQuery generates a Squirrel DELETE query builder for garbage collection.
108	// It constructs a query to delete expired records from the specified table
109	// based on the provided value, which represents a transaction ID.
110	func GenerateGCQuery(table string, value uint64) squirrel.DeleteBuilder {	1✔
111	// Convert the provided value into a string format suitable for our SQL query, formatted as a transaction ID.	1✔
112	valStr := fmt.Sprintf("'%v'::xid8", value)	1✔
113		1✔
114	// Create a Squirrel DELETE builder for the specified table.	1✔
115	deleteBuilder := squirrel.Delete(table)	1✔
116		1✔
117	// Create an expression to check if 'expired_tx_id' is not equal to '0' (not expired).	1✔
118	expiredZeroExpr := squirrel.Expr("expired_tx_id <> '0'::xid8")	1✔
119		1✔
120	// Create an expression to check if 'expired_tx_id' is less than the provided value (before the cutoff).	1✔
121	beforeExpr := squirrel.Expr(fmt.Sprintf("expired_tx_id < %s", valStr))	1✔
122		1✔
123	// Add the WHERE clauses to the DELETE query builder to filter and delete expired data.	1✔
124	return deleteBuilder.Where(expiredZeroExpr).Where(beforeExpr)	1✔
125	}	1✔
126
127	// HandleError records an error in the given span, logs the error, and returns a standardized error.
128	// This function is used for consistent error handling across different parts of the application.
129	func HandleError(ctx context.Context, span trace.Span, err error, errorCode base.ErrorCode) error {	×
130	// Check if the error is context-related	×
131	if IsContextRelatedError(ctx, err) {	×
132	slog.DebugContext(ctx, "A context-related error occurred",	×
133	slog.String("error", err.Error()))	×
134	return errors.New(base.ErrorCode_ERROR_CODE_CANCELLED.String())	×
135	}	×
136
137	// Check if the error is serialization-related
138	if IsSerializationRelatedError(err) {	×
139	slog.DebugContext(ctx, "A serialization-related error occurred",	×
140	slog.String("error", err.Error()))	×
141	return errors.New(base.ErrorCode_ERROR_CODE_SERIALIZATION.String())	×
142	}	×
143
144	// For all other types of errors, log them at the error level and record them in the span
145	slog.ErrorContext(ctx, "An operational error occurred",	×
146	slog.Any("error", err))	×
147	span.RecordError(err)	×
148	span.SetStatus(codes.Error, err.Error())	×
149		×
150	// Return a new error with the standard error code provided	×
151	return errors.New(errorCode.String())	×
152	}
153
154	// IsContextRelatedError checks if the error is due to context cancellation, deadline exceedance, or closed connection
155	func IsContextRelatedError(ctx context.Context, err error) bool {	×
156	if errors.Is(ctx.Err(), context.Canceled) \|\| errors.Is(ctx.Err(), context.DeadlineExceeded) {	×
157	return true	×
158	}	×
159	if errors.Is(err, context.Canceled) \|\|	×
160	errors.Is(err, context.DeadlineExceeded) \|\|	×
161	strings.Contains(err.Error(), "conn closed") {	×
162	return true	×
163	}	×
164	return false	×
165	}
166
167	// IsSerializationRelatedError checks if the error is a serialization failure, typically in database transactions.
168	func IsSerializationRelatedError(err error) bool {	×
169	if strings.Contains(err.Error(), "could not serialize") \|\|	×
170	strings.Contains(err.Error(), "duplicate key value") {	×
171	return true	×
172	}	×
173	return false	×
174	}
175
176	// WaitWithBackoff implements an exponential backoff strategy with jitter for retries.
177	// It waits for a calculated duration or until the context is cancelled, whichever comes first.
178	func WaitWithBackoff(ctx context.Context, tenantID string, retries int) {	×
179	backoff := time.Duration(math.Min(float64(20time.Millisecond)math.Pow(2, float64(retries)), float64(1*time.Second)))	×
180	jitter := time.Duration(rand.Float64() * float64(backoff) * 0.5)	×
181	nextBackoff := backoff + jitter	×
182	slog.WarnContext(ctx, "waiting before retry", slog.String("tenant_id", tenantID), slog.Int64("backoff_duration", nextBackoff.Milliseconds()))	×
183	select {	×
184	case <-time.After(nextBackoff):	×
185	case <-ctx.Done():	×
186	}
187	}

Permify / permify / 9975333611

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

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