parties.go

// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package sqlstore

import (
	"context"
	"fmt"

	"code.vegaprotocol.io/vega/datanode/entities"
	"code.vegaprotocol.io/vega/datanode/metrics"
	v2 "code.vegaprotocol.io/vega/protos/data-node/api/v2"

	"github.com/georgysavva/scany/pgxscan"
)

var (
	partiesOrdering = TableOrdering{
		ColumnOrdering{Name: "vega_time", Sorting: ASC},
		ColumnOrdering{Name: "id", Sorting: ASC},
	}

	partiesProfilesOrdering = TableOrdering{
		ColumnOrdering{Name: "id", Sorting: ASC},
	}
)

type Parties struct {
	*ConnectionSource
}

func NewParties(connectionSource *ConnectionSource) *Parties {
	ps := &Parties{
		ConnectionSource: connectionSource,
	}
	return ps
}

// Initialise adds the built-in 'network' party which is never explicitly sent on the event
// bus, but nonetheless is necessary.
func (ps *Parties) Initialise(ctx context.Context) {
	defer metrics.StartSQLQuery("Parties", "Initialise")()
	_, err := ps.Connection.Exec(ctx,
		`INSERT INTO parties(id, tx_hash, alias) VALUES ($1, $2, $3) ON CONFLICT (id) DO NOTHING`,
		entities.PartyID("network"), entities.TxHash("01"), "network")
	if err != nil {
		panic(fmt.Errorf("unable to add built-in network party: %w", err))
	}
}

func (ps *Parties) Add(ctx context.Context, p entities.Party) error {
	defer metrics.StartSQLQuery("Parties", "Add")()
	_, err := ps.Connection.Exec(ctx,
		`INSERT INTO parties(id, tx_hash, vega_time)
		 VALUES ($1, $2, $3)
		 ON CONFLICT (id) DO NOTHING`,
		p.ID,
		p.TxHash,
		p.VegaTime,
	)
	return err
}

func (ps *Parties) UpdateProfile(ctx context.Context, p *entities.PartyProfile) error {
	defer metrics.StartSQLQuery("Parties", "Add")()
	_, err := ps.Connection.Exec(ctx,
		`UPDATE parties SET alias = $1, metadata = $2  WHERE id = $3`,
		p.Alias,
		p.Metadata,
		p.PartyID,
	)
	return err
}

func (ps *Parties) ListProfiles(ctx context.Context, ids []string, pagination entities.CursorPagination) ([]entities.PartyProfile, entities.PageInfo, error) {
	defer metrics.StartSQLQuery("Parties", "ListProfiles")()

	profiles := make([]entities.PartyProfile, 0)
	args := make([]interface{}, 0)

	whereClause := ""
	if len(ids) > 0 {
		partyIDs := make([][]byte, len(ids))
		for i, id := range ids {
			partyID := entities.PartyID(id)
			partyIDBytes, err := partyID.Bytes()
			if err != nil {
				return nil, entities.PageInfo{}, fmt.Errorf("invalid party ID found: %w", err)
			}
			partyIDs[i] = partyIDBytes
		}
		whereClause = fmt.Sprintf(" where id = ANY(%s)", nextBindVar(&args, partyIDs))
	}

	query := `SELECT id AS party_id, alias, metadata FROM parties` + whereClause

	var pageInfo entities.PageInfo

	query, args, err := PaginateQuery[entities.PartyProfile](query, args, partiesProfilesOrdering, pagination)
	if err != nil {
		return nil, pageInfo, err
	}

	if err := pgxscan.Select(ctx, ps.Connection, &profiles, query, args...); err != nil {
		return nil, pageInfo, err
	}

	profiles, pageInfo = entities.PageEntities[*v2.PartyProfileEdge](profiles, pagination)
	return profiles, pageInfo, nil
}

func (ps *Parties) GetByID(ctx context.Context, id string) (entities.Party, error) {
	a := entities.Party{}
	defer metrics.StartSQLQuery("Parties", "GetByID")()
	err := pgxscan.Get(ctx, ps.Connection, &a,
		`SELECT id, tx_hash, vega_time
		 FROM parties WHERE id=$1`,
		entities.PartyID(id))

	return a, ps.wrapE(err)
}

func (ps *Parties) GetByTxHash(ctx context.Context, txHash entities.TxHash) ([]entities.Party, error) {
	defer metrics.StartSQLQuery("Parties", "GetByTxHash")()

	var parties []entities.Party
	err := pgxscan.Select(ctx, ps.Connection, &parties, `SELECT id, tx_hash, vega_time FROM parties WHERE tx_hash=$1`, txHash)
	if err != nil {
		return nil, ps.wrapE(err)
	}

	return parties, nil
}

func (ps *Parties) GetAll(ctx context.Context) ([]entities.Party, error) {
	parties := []entities.Party{}
	defer metrics.StartSQLQuery("Parties", "GetAll")()
	err := pgxscan.Select(ctx, ps.Connection, &parties, `
		SELECT id, tx_hash, vega_time
		FROM parties`)
	return parties, err
}

func (ps *Parties) GetAllPaged(ctx context.Context, partyID string, pagination entities.CursorPagination) ([]entities.Party, entities.PageInfo, error) {
	if partyID != "" {
		party, err := ps.GetByID(ctx, partyID)
		if err != nil {
			return nil, entities.PageInfo{}, err
		}

		return []entities.Party{party}, entities.PageInfo{
			HasNextPage:     false,
			HasPreviousPage: false,
			StartCursor:     party.Cursor().Encode(),
			EndCursor:       party.Cursor().Encode(),
		}, nil
	}

	parties := make([]entities.Party, 0)
	args := make([]interface{}, 0)

	query := `
		SELECT id, tx_hash, vega_time
		FROM parties
	`

	var pageInfo entities.PageInfo

	query, args, err := PaginateQuery[entities.Party](query, args, partiesOrdering, pagination)
	if err != nil {
		return nil, pageInfo, err
	}

	if err := pgxscan.Select(ctx, ps.Connection, &parties, query, args...); err != nil {
		return nil, pageInfo, err
	}

	parties, pageInfo = entities.PageEntities[*v2.PartyEdge](parties, pagination)
	return parties, pageInfo, nil
}