/* Copyright 2022 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 postgres import ( "context" "encoding/json" "errors" "fmt" "reflect" "regexp" "slices" "strconv" "strings" "sync" "sync/atomic" "github.com/google/uuid" "github.com/jackc/pgx/v5" "github.com/jackc/pgx/v5/pgconn" "github.com/jackc/pgx/v5/pgxpool" awsAuth "github.com/dapr/components-contrib/common/authentication/aws" pgauth "github.com/dapr/components-contrib/common/authentication/postgresql" "github.com/dapr/components-contrib/configuration" contribMetadata "github.com/dapr/components-contrib/metadata" "github.com/dapr/kit/logger" ) type ConfigurationStore struct { metadata metadata client *pgxpool.Pool logger logger.Logger configLock sync.RWMutex ActiveSubscriptions map[string]*subscription cancelMap sync.Map wg sync.WaitGroup closed atomic.Bool lock sync.RWMutex enableAzureAD bool enableAWSIAM bool awsAuthProvider awsAuth.Provider } type subscription struct { channel string keys []string } type pgResponse struct { key string item *configuration.Item } const ( payloadDataKey = "data" QueryTableExists = "SELECT EXISTS (SELECT FROM pg_tables where tablename = $1)" maxIdentifierLength = 64 // https://www.postgresql.org/docs/current/limits.html ) var ( allowedChars = regexp.MustCompile(`^[a-zA-Z0-9./_]*$`) allowedTableNameChars = regexp.MustCompile(`^[a-z0-9./_]*$`) ) func NewPostgresConfigurationStore(logger logger.Logger) configuration.Store { return &ConfigurationStore{ logger: logger, } } func (p *ConfigurationStore) Init(ctx context.Context, metadata configuration.Metadata) error { opts := pgauth.InitWithMetadataOpts{ AzureADEnabled: p.enableAzureAD, AWSIAMEnabled: p.enableAWSIAM, } err := p.metadata.InitWithMetadata(metadata.Properties) if err != nil { p.logger.Error(err) return err } p.ActiveSubscriptions = make(map[string]*subscription) config, err := p.metadata.GetPgxPoolConfig() if err != nil { return fmt.Errorf("PostgreSQL configuration store connection error: %s", err) } if opts.AWSIAMEnabled && p.metadata.UseAWSIAM { opts, validateErr := p.metadata.BuildAwsIamOptions(p.logger, metadata.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) } pool, err := pgxpool.NewWithConfig(ctx, config) if err != nil { return fmt.Errorf("PostgreSQL configuration store connection error: %w", err) } err = pool.Ping(ctx) if err != nil { return fmt.Errorf("PostgreSQL configuration store ping error: %w", err) } p.client = pool err = p.client.Ping(ctx) if err != nil { return fmt.Errorf("unable to connect to configuration store: '%w'", err) } // check if table exists exists := false err = p.client.QueryRow(ctx, QueryTableExists, p.metadata.ConfigTable).Scan(&exists) if err != nil { return fmt.Errorf("error in checking if configtable '%s' exists: '%w'", p.metadata.ConfigTable, err) } if !exists { return fmt.Errorf("postgreSQL configuration table '%s' does not exist", p.metadata.ConfigTable) } return nil } // If version is a valid number, return the number // If version is not a valid number, return -1 func getNumericVersion(version string) int { num, err := strconv.Atoi(version) if err != nil { num = -1 } return num } // Returns a map of unique items per key func getUniqueItemPerKey(res []pgResponse) map[string]*configuration.Item { items := make(map[string]*configuration.Item) latestNumericVersion := make(map[string]int) for _, r := range res { if items[r.key] == nil { items[r.key] = r.item latestNumericVersion[r.key] = getNumericVersion(r.item.Version) } else { newNumericVersion := getNumericVersion(r.item.Version) if newNumericVersion > latestNumericVersion[r.key] { items[r.key] = r.item latestNumericVersion[r.key] = newNumericVersion } } } return items } func (p *ConfigurationStore) Get(ctx context.Context, req *configuration.GetRequest) (*configuration.GetResponse, error) { if err := validateInput(req.Keys); err != nil { p.logger.Error(err) return nil, err } query, params, err := buildQuery(req, p.metadata.ConfigTable) if err != nil { p.logger.Error(err) return nil, fmt.Errorf("error in configuration store query: '%w' ", err) } rows, err := p.client.Query(ctx, query, params...) if err != nil { // If no rows exist, return an empty response, otherwise return the error. if errors.Is(err, pgx.ErrNoRows) { return &configuration.GetResponse{}, nil } return nil, fmt.Errorf("error in querying configuration store: '%w'", err) } items, err := pgx.CollectRows(rows, func(row pgx.CollectableRow) (pgResponse, error) { res := pgResponse{ item: new(configuration.Item), } if innerErr := row.Scan(&res.key, &res.item.Value, &res.item.Version, &res.item.Metadata); innerErr != nil { return pgResponse{}, fmt.Errorf("error in reading data from configuration store: '%w'", innerErr) } return res, nil }) if err != nil { return nil, fmt.Errorf("unable to parse response from configuration store - %w", err) } result := getUniqueItemPerKey(items) return &configuration.GetResponse{ Items: result, }, nil } func (p *ConfigurationStore) Subscribe(ctx context.Context, req *configuration.SubscribeRequest, handler configuration.UpdateHandler) (string, error) { p.lock.RLock() defer p.lock.RUnlock() if p.closed.Load() { return "", errors.New("configuration store is closed") } pgNotifyChannel := "" for k, v := range req.Metadata { if strings.ToLower(k) == "pgnotifychannel" { //nolint:gocritic pgNotifyChannel = v break } } if pgNotifyChannel == "" { return "", fmt.Errorf("unable to subscribe to '%s'. pgNotifyChannel attribute cannot be empty", p.metadata.ConfigTable) } return p.subscribeToChannel(ctx, pgNotifyChannel, req, handler) } func (p *ConfigurationStore) Unsubscribe(ctx context.Context, req *configuration.UnsubscribeRequest) error { p.lock.Lock() defer p.lock.Unlock() if p.closed.Load() { return errors.New("configuration store is closed") } p.configLock.Lock() defer p.configLock.Unlock() sub := p.ActiveSubscriptions[req.ID] if sub == nil { return fmt.Errorf("unable to find subscription with ID : %v", req.ID) } if cancelContext, ok := p.cancelMap.Load(req.ID); ok { cancelContext.(context.CancelFunc)() } pgChannel := "UNLISTEN " + sub.channel conn, err := p.client.Acquire(ctx) if err != nil { p.logger.Error("error acquiring connection:", err) return fmt.Errorf("error acquiring connection: %w ", err) } defer conn.Release() _, err = conn.Exec(ctx, pgChannel) if err != nil { p.logger.Error("error un-listening to channel:", err) return fmt.Errorf("error un-listening to channel: %w", err) } return nil } func (p *ConfigurationStore) doSubscribe(ctx context.Context, req *configuration.SubscribeRequest, handler configuration.UpdateHandler, command string, channel string, subscription string) { conn, err := p.client.Acquire(ctx) if err != nil { p.logger.Errorf("error acquiring connection:", err) return } defer conn.Release() if _, err = conn.Exec(ctx, command); err != nil { p.logger.Errorf("error listening to channel:", err) return } for { notification, err := conn.Conn().WaitForNotification(ctx) if err != nil { if !pgconn.Timeout(err) && !errors.Is(err, context.Canceled) { p.logger.Errorf("error waiting for notification:", err) } return } p.handleSubscribedChange(ctx, handler, notification, channel, subscription) } } func (p *ConfigurationStore) handleSubscribedChange(ctx context.Context, handler configuration.UpdateHandler, msg *pgconn.Notification, channel string, subscriptionID string) { payload := make(map[string]interface{}) err := json.Unmarshal([]byte(msg.Payload), &payload) if err != nil { p.logger.Errorf("error in unmarshal: ", err) return } var key, value, version string m := make(map[string]string) // trigger should encapsulate the row in "data" field in the notification row := reflect.ValueOf(payload[payloadDataKey]) if row.Kind() == reflect.Map { for _, k := range row.MapKeys() { v := row.MapIndex(k) strKey := k.Interface().(string) switch strings.ToLower(strKey) { case "key": key = v.Interface().(string) if yes := p.isSubscribed(subscriptionID, channel, key); !yes { p.logger.Debugf("ignoring notification for %v", key) return } case "value": value = v.Interface().(string) case "version": version = v.Interface().(string) case "metadata": if v.Interface() == nil { continue } a := v.Interface().(map[string]interface{}) for k, v := range a { m[k] = v.(string) } } } e := &configuration.UpdateEvent{ Items: map[string]*configuration.Item{ key: { Value: value, Version: version, Metadata: m, }, }, ID: subscriptionID, } err = handler(ctx, e) if err != nil { p.logger.Errorf("failed to call notify event handler : %w", err) } } else { p.logger.Info("unknown format of data received in notify event - '%s'", msg.Payload) } } func buildQuery(req *configuration.GetRequest, configTable string) (string, []interface{}, error) { var query string var params []interface{} if len(req.Keys) == 0 { query = "SELECT * FROM " + configTable } else { var queryBuilder strings.Builder queryBuilder.WriteString("SELECT * FROM " + configTable + " WHERE KEY IN (") var paramWildcard []string paramPosition := 1 for _, v := range req.Keys { paramWildcard = append(paramWildcard, "$"+strconv.Itoa(paramPosition)) params = append(params, v) paramPosition++ } queryBuilder.WriteString(strings.Join(paramWildcard, " , ")) queryBuilder.WriteString(")") query = queryBuilder.String() if len(req.Metadata) > 0 { var s strings.Builder i, j := len(req.Metadata), 0 s.WriteString(" AND ") for k, v := range req.Metadata { temp := "$" + strconv.Itoa(paramPosition) + " = " + "$" + strconv.Itoa(paramPosition+1) s.WriteString(temp) params = append(params, k, v) paramPosition += 2 if j++; j < i { s.WriteString(" AND ") } } query += s.String() } } return query, params, nil } func (p *ConfigurationStore) isSubscribed(subscriptionID string, channel string, key string) bool { p.configLock.RLock() defer p.configLock.RUnlock() val := p.ActiveSubscriptions[subscriptionID] if val != nil && val.channel == channel && (slices.Contains(val.keys, key) || len(val.keys) == 0) { return true } return false } func validateInput(keys []string) error { for _, key := range keys { if !allowedChars.MatchString(key) { return fmt.Errorf("invalid key : '%v'", key) } } return nil } func (p *ConfigurationStore) subscribeToChannel(ctx context.Context, pgNotifyChannel string, req *configuration.SubscribeRequest, handler configuration.UpdateHandler) (string, error) { p.configLock.Lock() defer p.configLock.Unlock() var subscribeID string pgNotifyCmd := "listen " + pgNotifyChannel subscribeUID, err := uuid.NewRandom() if err != nil { return "", fmt.Errorf("unable to generate subscription id - %w", err) } subscribeID = subscribeUID.String() childContext, cancel := context.WithCancel(ctx) p.cancelMap.Store(subscribeID, cancel) p.ActiveSubscriptions[subscribeID] = &subscription{ channel: pgNotifyChannel, keys: req.Keys, } p.wg.Add(1) go func() { p.doSubscribe(childContext, req, handler, pgNotifyCmd, pgNotifyChannel, subscribeID) p.configLock.Lock() delete(p.ActiveSubscriptions, subscribeID) p.configLock.Unlock() p.cancelMap.Delete(subscribeID) p.wg.Done() }() return subscribeID, nil } // GetComponentMetadata returns the metadata of the component. func (p *ConfigurationStore) GetComponentMetadata() (metadataInfo contribMetadata.MetadataMap) { metadataStruct := metadata{} contribMetadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, contribMetadata.ConfigurationStoreType) return } func (p *ConfigurationStore) Close() error { defer p.wg.Wait() p.closed.Store(true) p.lock.Lock() defer p.lock.Unlock() p.cancelMap.Range(func(id any, cancel any) bool { cancel.(context.CancelFunc)() return true }) p.cancelMap.Clear() if p.client != nil { p.client.Close() } errs := make([]error, 1) if p.awsAuthProvider != nil { errs[0] = p.awsAuthProvider.Close() } return errors.Join(errs...) }