/* Copyright 2021 The Dapr Authors 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 postgresql import ( "context" "encoding/base64" "encoding/json" "errors" "fmt" "reflect" "strconv" "time" "github.com/jackc/pgx/v5" "github.com/jackc/pgx/v5/pgconn" "github.com/jackc/pgx/v5/pgtype" "github.com/jackc/pgx/v5/pgxpool" awsAuth "github.com/dapr/components-contrib/common/authentication/aws" pgauth "github.com/dapr/components-contrib/common/authentication/postgresql" pginterfaces "github.com/dapr/components-contrib/common/component/postgresql/interfaces" pgtransactions "github.com/dapr/components-contrib/common/component/postgresql/transactions" commonsql "github.com/dapr/components-contrib/common/component/sql" "github.com/dapr/components-contrib/metadata" "github.com/dapr/components-contrib/state" stateutils "github.com/dapr/components-contrib/state/utils" "github.com/dapr/kit/logger" "github.com/dapr/kit/ptr" ) // PostgreSQL state store. type PostgreSQL struct { state.BulkStore logger logger.Logger metadata pgMetadata db pginterfaces.PGXPoolConn gc commonsql.GarbageCollector migrateFn func(context.Context, pginterfaces.PGXPoolConn, MigrateOptions) error setQueryFn func(*state.SetRequest, SetQueryOptions) string etagColumn string enableAzureAD bool enableAWSIAM bool awsAuthProvider awsAuth.Provider } type Options struct { MigrateFn func(context.Context, pginterfaces.PGXPoolConn, MigrateOptions) error SetQueryFn func(*state.SetRequest, SetQueryOptions) string ETagColumn string EnableAzureAD bool EnableAWSIAM bool } type MigrateOptions struct { Logger logger.Logger StateTableName string MetadataTableName string } type SetQueryOptions struct { TableName string ExpireDateValue string } // NewPostgreSQLStateStore creates a new instance of PostgreSQL state store. func NewPostgreSQLStateStore(logger logger.Logger, opts Options) state.Store { s := &PostgreSQL{ logger: logger, migrateFn: opts.MigrateFn, setQueryFn: opts.SetQueryFn, etagColumn: opts.ETagColumn, enableAzureAD: opts.EnableAzureAD, enableAWSIAM: opts.EnableAWSIAM, } s.BulkStore = state.NewDefaultBulkStore(s) return s } // Init sets up Postgres connection and performs migrations. func (p *PostgreSQL) Init(ctx context.Context, meta state.Metadata) error { opts := pgauth.InitWithMetadataOpts{ AzureADEnabled: p.enableAzureAD, AWSIAMEnabled: p.enableAWSIAM, } if err := p.metadata.InitWithMetadata(meta, opts); err != nil { return fmt.Errorf("failed to parse metadata: %w", err) } var err error config, err := p.metadata.GetPgxPoolConfig() if err != nil { return err } if opts.AWSIAMEnabled && p.metadata.UseAWSIAM { opts, validateErr := p.metadata.BuildAwsIamOptions(p.logger, meta.Properties) if validateErr != nil { return fmt.Errorf("failed to validate AWS IAM authentication fields: %w", validateErr) } var provider awsAuth.Provider provider, err = awsAuth.NewProvider(ctx, *opts, awsAuth.GetConfig(*opts)) if err != nil { return err } p.awsAuthProvider = provider p.awsAuthProvider.UpdatePostgres(ctx, config) } connCtx, connCancel := context.WithTimeout(ctx, p.metadata.Timeout) p.db, err = pgxpool.NewWithConfig(connCtx, config) connCancel() if err != nil { return fmt.Errorf("failed to connect to the database: %w", err) } pingCtx, pingCancel := context.WithTimeout(ctx, p.metadata.Timeout) err = p.db.Ping(pingCtx) pingCancel() if err != nil { return fmt.Errorf("failed to ping the database: %w", err) } err = p.migrateFn(ctx, p.db, MigrateOptions{ Logger: p.logger, StateTableName: p.metadata.TableName, MetadataTableName: p.metadata.MetadataTableName, }) if err != nil { return err } if p.metadata.CleanupInterval != nil { gc, err := commonsql.ScheduleGarbageCollector(commonsql.GCOptions{ Logger: p.logger, UpdateLastCleanupQuery: func(arg any) (string, any) { return fmt.Sprintf( `INSERT INTO %[1]s (key, value) VALUES ('last-cleanup', now()::text) ON CONFLICT (key) DO UPDATE SET value = now()::text WHERE (EXTRACT('epoch' FROM now() - %[1]s.value::timestamp with time zone) * 1000)::bigint > $1`, p.metadata.MetadataTableName, ), arg }, DeleteExpiredValuesQuery: fmt.Sprintf( `DELETE FROM %s WHERE expiredate IS NOT NULL AND expiredate < now()`, p.metadata.TableName, ), CleanupInterval: *p.metadata.CleanupInterval, DB: commonsql.AdaptPgxConn(p.db), }) if err != nil { return err } p.gc = gc } return nil } // Features returns the features available in this state store. func (p *PostgreSQL) Features() []state.Feature { return []state.Feature{ state.FeatureETag, state.FeatureTransactional, state.FeatureTTL, } } func (p *PostgreSQL) GetDB() *pgxpool.Pool { // We can safely cast to *pgxpool.Pool because this method is never used in unit tests where we mock the DB return p.db.(*pgxpool.Pool) } // Set makes an insert or update to the database. func (p *PostgreSQL) Set(ctx context.Context, req *state.SetRequest) error { return p.doSet(ctx, p.db, req) } func (p *PostgreSQL) doSet(parentCtx context.Context, db pginterfaces.DBQuerier, req *state.SetRequest) error { err := state.CheckRequestOptions(req.Options) if err != nil { return err } if req.Key == "" { return errors.New("missing key in set operation") } v := req.Value byteArray, isBinary := req.Value.([]uint8) if isBinary { v = base64.StdEncoding.EncodeToString(byteArray) } // Convert to json string bt, _ := stateutils.Marshal(v, json.Marshal) value := string(bt) // TTL var ttlSeconds int ttl, ttlerr := stateutils.ParseTTL(req.Metadata) if ttlerr != nil { return fmt.Errorf("error parsing TTL: %w", ttlerr) } if ttl != nil { ttlSeconds = *ttl } var ( queryExpiredate string params []any ) if !req.HasETag() { params = []any{req.Key, value, isBinary} } else { var etag64 uint64 etag64, err = strconv.ParseUint(*req.ETag, 10, 32) if err != nil { return state.NewETagError(state.ETagInvalid, err) } params = []any{req.Key, value, isBinary, uint32(etag64)} } if ttlSeconds > 0 { queryExpiredate = "CURRENT_TIMESTAMP + interval '" + strconv.Itoa(ttlSeconds) + " seconds'" } else { queryExpiredate = "NULL" } query := p.setQueryFn(req, SetQueryOptions{ TableName: p.metadata.TableName, ExpireDateValue: queryExpiredate, }) result, err := db.Exec(parentCtx, query, params...) if err != nil { return err } if result.RowsAffected() != 1 { if req.HasETag() { return state.NewETagError(state.ETagMismatch, nil) } return errors.New("no item was updated") } return nil } // Get returns data from the database. If data does not exist for the key an empty state.GetResponse will be returned. func (p *PostgreSQL) Get(parentCtx context.Context, req *state.GetRequest) (*state.GetResponse, error) { if req.Key == "" { return nil, errors.New("missing key in get operation") } query := `SELECT key, value, isbinary, ` + p.etagColumn + ` AS etag, expiredate FROM ` + p.metadata.TableName + ` WHERE key = $1 AND (expiredate IS NULL OR expiredate >= CURRENT_TIMESTAMP)` ctx, cancel := context.WithTimeout(parentCtx, p.metadata.Timeout) defer cancel() row := p.db.QueryRow(ctx, query, req.Key) _, value, etag, expireTime, err := readRow(row) if err != nil { // If no rows exist, return an empty response, otherwise return the error. if errors.Is(err, pgx.ErrNoRows) { return &state.GetResponse{}, nil } return nil, err } resp := &state.GetResponse{ Data: value, ETag: etag, } if expireTime != nil { resp.Metadata = map[string]string{ state.GetRespMetaKeyTTLExpireTime: expireTime.UTC().Format(time.RFC3339), } } return resp, nil } func (p *PostgreSQL) BulkGet(parentCtx context.Context, req []state.GetRequest, _ state.BulkGetOpts) ([]state.BulkGetResponse, error) { if len(req) == 0 { return []state.BulkGetResponse{}, nil } // Get all keys keys := make([]string, len(req)) for i, r := range req { keys[i] = r.Key } // Execute the query query := `SELECT key, value, isbinary, ` + p.etagColumn + ` AS etag, expiredate FROM ` + p.metadata.TableName + ` WHERE key = ANY($1) AND (expiredate IS NULL OR expiredate >= CURRENT_TIMESTAMP)` ctx, cancel := context.WithTimeout(parentCtx, p.metadata.Timeout) defer cancel() rows, err := p.db.Query(ctx, query, keys) if err != nil { // If no rows exist, return an empty response, otherwise return the error. if errors.Is(err, pgx.ErrNoRows) { return []state.BulkGetResponse{}, nil } return nil, err } // Scan all rows var n int res := make([]state.BulkGetResponse, len(req)) foundKeys := make(map[string]struct{}, len(req)) for ; rows.Next(); n++ { if n >= len(req) { // Sanity check to prevent panics, which should never happen return nil, fmt.Errorf("query returned more records than expected (expected %d)", len(req)) } r := state.BulkGetResponse{} var expireTime *time.Time r.Key, r.Data, r.ETag, expireTime, err = readRow(rows) if err != nil { r.Error = err.Error() } if expireTime != nil { r.Metadata = map[string]string{ state.GetRespMetaKeyTTLExpireTime: expireTime.UTC().Format(time.RFC3339), } } res[n] = r foundKeys[r.Key] = struct{}{} } // Populate missing keys with empty values // This is to ensure consistency with the other state stores that implement BulkGet as a loop over Get, and with the Get method if len(foundKeys) < len(req) { var ok bool for _, r := range req { _, ok = foundKeys[r.Key] if !ok { if n >= len(req) { // Sanity check to prevent panics, which should never happen return nil, fmt.Errorf("query returned more records than expected (expected %d)", len(req)) } res[n] = state.BulkGetResponse{ Key: r.Key, } n++ } } } return res[:n], nil } func readRow(row pgx.Row) (key string, value []byte, etagS *string, expireTime *time.Time, err error) { var ( isBinary bool etag pgtype.Int8 expT pgtype.Timestamp ) err = row.Scan(&key, &value, &isBinary, &etag, &expT) if err != nil { return key, nil, nil, nil, err } if etag.Valid { etagS = ptr.Of(strconv.FormatInt(etag.Int64, 10)) } if expT.Valid { expireTime = &expT.Time } if isBinary { var ( s string data []byte ) err = json.Unmarshal(value, &s) if err != nil { return key, nil, nil, nil, fmt.Errorf("failed to unmarshal JSON data: %w", err) } data, err = base64.StdEncoding.DecodeString(s) if err != nil { return key, nil, nil, nil, fmt.Errorf("failed to decode base64 data: %w", err) } return key, data, etagS, expireTime, nil } return key, value, etagS, expireTime, nil } // Delete removes an item from the state store. func (p *PostgreSQL) Delete(ctx context.Context, req *state.DeleteRequest) (err error) { return p.doDelete(ctx, p.db, req) } func (p *PostgreSQL) doDelete(parentCtx context.Context, db pginterfaces.DBQuerier, req *state.DeleteRequest) (err error) { if req.Key == "" { return errors.New("missing key in delete operation") } ctx, cancel := context.WithTimeout(parentCtx, p.metadata.Timeout) defer cancel() var result pgconn.CommandTag if !req.HasETag() { result, err = db.Exec(ctx, "DELETE FROM "+p.metadata.TableName+" WHERE key = $1", req.Key) } else { // Convert req.ETag to uint32 for postgres XID compatibility var etag64 uint64 etag64, err = strconv.ParseUint(*req.ETag, 10, 32) if err != nil { return state.NewETagError(state.ETagInvalid, err) } result, err = db.Exec(ctx, "DELETE FROM "+p.metadata.TableName+" WHERE key = $1 AND $2 = "+p.etagColumn, req.Key, uint32(etag64)) } if err != nil { return err } rows := result.RowsAffected() if rows != 1 && req.ETag != nil && *req.ETag != "" { return state.NewETagError(state.ETagMismatch, nil) } return nil } func (p *PostgreSQL) Multi(parentCtx context.Context, request *state.TransactionalStateRequest) error { if request == nil { return nil } // If there's only 1 operation, skip starting a transaction switch len(request.Operations) { case 0: return nil case 1: return p.execMultiOperation(parentCtx, request.Operations[0], p.db) default: _, err := pgtransactions.ExecuteInTransaction[struct{}](parentCtx, p.logger, p.db, p.metadata.Timeout, func(ctx context.Context, tx pgx.Tx) (res struct{}, err error) { for _, op := range request.Operations { err = p.execMultiOperation(ctx, op, tx) if err != nil { return res, err } } return res, nil }) return err } } func (p *PostgreSQL) execMultiOperation(ctx context.Context, op state.TransactionalStateOperation, db pginterfaces.DBQuerier) error { switch x := op.(type) { case state.SetRequest: return p.doSet(ctx, db, &x) case state.DeleteRequest: return p.doDelete(ctx, db, &x) default: return fmt.Errorf("unsupported operation: %s", op.Operation()) } } func (p *PostgreSQL) CleanupExpired() error { if p.gc != nil { return p.gc.CleanupExpired() } return nil } // Close implements io.Close. func (p *PostgreSQL) Close() error { if p.db != nil { p.db.Close() p.db = nil } errs := make([]error, 2) if p.gc != nil { errs[0] = p.gc.Close() } if p.awsAuthProvider != nil { errs[1] = p.awsAuthProvider.Close() } return errors.Join(errs...) } // GetCleanupInterval returns the cleanupInterval property. // This is primarily used for tests. func (p *PostgreSQL) GetCleanupInterval() *time.Duration { return p.metadata.CleanupInterval } func (p *PostgreSQL) GetComponentMetadata() (metadataInfo metadata.MetadataMap) { metadataStruct := pgMetadata{} metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.StateStoreType) return }