db

type ClickHouseClient struct {
	// contains filtered or unexported fields
}

type ClickHouseClientConfig struct {
	DatabaseHost           string
	DatabasePort           int
	DatabaseName           string
	DatabaseUser           string
	DatabasePassword       string
	DatabaseSSL            bool
	ClusterName            string
	MigrationsTableEngine  string
	ReplicatedTableEngines bool
	ApplyMigrations        bool
	BatchSize              int
	BatchTimeout           time.Duration
	NetworkID              string
	PersistNeighbors       bool
	MeterProvider          metric.MeterProvider
	TracerProvider         trace.TracerProvider
}

type ClickHouseCrawl struct {
	ID              uuid.UUID  `ch:"id"`
	State           string     `ch:"state"`
	FinishedAt      *time.Time `ch:"finished_at"`
	UpdatedAt       time.Time  `ch:"updated_at"`
	CreatedAt       time.Time  `ch:"created_at"`
	CrawledPeers    *int32     `ch:"crawled_peers"`
	DialablePeers   *int32     `ch:"dialable_peers"`
	UndialablePeers *int32     `ch:"undialable_peers"`
	RemainingPeers  *int32     `ch:"remaining_peers"`
	Version         string     `ch:"version"`
	NetworkID       string     `ch:"network_id"`
}

type ClickHouseVisit struct {
	CrawlID        *uuid.UUID      `ch:"crawl_id"`
	PeerID         string          `ch:"peer_id"`
	AgentVersion   *string         `ch:"agent_version"`
	Protocols      []string        `ch:"protocols"`
	DialMaddrs     []string        `ch:"dial_maddrs"`
	FilteredMaddrs []string        `ch:"filtered_maddrs"`
	ExtraMaddrs    []string        `ch:"extra_maddrs"`
	ListenMaddrs   []string        `ch:"listen_maddrs"`
	DialErrors     []string        `ch:"dial_errors"`
	ConnectMaddr   *string         `ch:"connect_maddr"`
	CrawlError     *string         `ch:"crawl_error"`
	VisitStartedAt time.Time       `ch:"visit_started_at"`
	VisitEndedAt   time.Time       `ch:"visit_ended_at"`
	Properties     json.RawMessage `ch:"peer_properties"`
	// contains filtered or unexported fields
}

type ClickhouseDiscoveryIDPrefix struct {
	Prefix uint64 `ch:"discovery_id_prefix"`
	PeerID string `ch:"peer_id"`
}

type ClickhouseNeighbor struct {
	CrawlID        uuid.UUID `ch:"crawl_id"`
	CrawlCreatedAt time.Time `ch:"crawl_created_at"`
	PeerID         uint64    `ch:"peer_discovery_id_prefix"`
	Neighbor       uint64    `ch:"neighbor_discovery_id_prefix"`
	ErrorBits      uint16    `ch:"error_bits"`
	// contains filtered or unexported fields
}

type Client interface {
	io.Closer
	// InitCrawl initializes a new crawl instance in the database.
	// The clients are responsible for tracking the crawl's ID and associate
	// later database queries with it. This is necessary because different
	// database engines have different types of IDs. ClickHouse commonly uses string
	// IDs and Postgres uses integers. Making the [Client] interface generic
	// on that ID would complicate the code a lot, so we require Clients to
	// keep state. This is added complexity traded for code clarity. It's a trade-
	// off and IMO this is less bad.
	InitCrawl(ctx context.Context, version string) error

	// SealCrawl marks the crawl (that the Client tracks internally) as done.
	SealCrawl(ctx context.Context, args *SealCrawlArgs) error

	// QueryBootstrapPeers fetches peers from the database that can be used
	// for bootstrapping into the network. The result will contain from zero up
	// to limit entries.
	QueryBootstrapPeers(ctx context.Context, limit int) ([]peer.AddrInfo, error)

	// InsertVisit TODO
	InsertVisit(ctx context.Context, args *VisitArgs) error

	// InsertCrawlProperties TODO
	InsertCrawlProperties(ctx context.Context, properties map[string]map[string]int) error

	// SelectPeersToProbe TODO
	SelectPeersToProbe(ctx context.Context) ([]peer.AddrInfo, error)

	// Flush instructs the client to write all cached data to the database.
	// Client implementations may cache and batch inserts. Flush tells the
	// client to insert everything that's pending.
	Flush(ctx context.Context) error
}

type CrawlState string

type JSONClient struct {
	// contains filtered or unexported fields
}

type JSONNeighbors struct {
	PeerID      peer.ID
	NeighborIDs []peer.ID
	ErrorBits   string
}

type JSONVisit struct {
	PeerID          peer.ID
	Maddrs          []ma.Multiaddr
	FilteredMaddrs  []ma.Multiaddr
	ListenMaddrs    []ma.Multiaddr
	ConnectMaddr    ma.Multiaddr
	Protocols       []string
	AgentVersion    string
	ConnectDuration string
	CrawlDuration   string
	VisitStartedAt  time.Time
	VisitEndedAt    time.Time
	ConnectErrorStr string
	CrawlErrorStr   string
	Properties      null.JSON
}

type NoopClient struct{}

type PostgresClient struct {
	// contains filtered or unexported fields
}

type PostgresClientConfig struct {
	// Determines the host address of the database.
	DatabaseHost string

	// Determines the port of the database.
	DatabasePort int

	// Determines the name of the database that should be used.
	DatabaseName string

	// Determines the password with which we access the database.
	DatabasePassword string

	// Determines the username with which we access the database.
	DatabaseUser string

	// The database SSL configuration. For Postgres SSL mode should be
	// one of the supported values here: https://www.postgresql.org/docs/current/libpq-ssl.html)
	DatabaseSSL string

	// Whether to apply migrations on startup
	ApplyMigrations bool

	// The cache size to hold agent versions in memory to skip database queries.
	AgentVersionsCacheSize int

	// The cache size to hold protocols in memory to skip database queries.
	ProtocolsCacheSize int

	// The cache size to hold sets of protocols in memory to skip database queries.
	ProtocolsSetCacheSize int

	// Set the maximum idle connections for the database handler.
	MaxIdleConns int

	// Whether to persist the routing tables to disk
	PersistNeighbors bool

	// MeterProvider is the meter provider to use when initialising metric instruments.
	MeterProvider metric.MeterProvider

	// TracerProvider is the tracer provider to use when initialising tracing
	TracerProvider trace.TracerProvider
}

type SealCrawlArgs struct {
	Crawled    int
	Dialable   int
	Undialable int
	Remaining  int
	State      CrawlState
}

type VisitArgs struct {
	PeerID           peer.ID
	DiscoveryPrefix  uint64
	AgentVersion     string
	Protocols        []string
	DialMaddrs       []ma.Multiaddr
	FilteredMaddrs   []ma.Multiaddr
	ExtraMaddrs      []ma.Multiaddr
	ListenMaddrs     []ma.Multiaddr
	DialErrors       []string
	ConnectMaddr     ma.Multiaddr
	DialDuration     time.Duration
	ConnectDuration  time.Duration
	CrawlDuration    time.Duration
	VisitStartedAt   time.Time
	VisitEndedAt     time.Time
	ConnectErrorStr  string
	CrawlErrorStr    string
	VisitType        VisitType
	Neighbors        []peer.ID
	NeighborPrefixes []uint64
	ErrorBits        uint16
	Properties       json.RawMessage
}

type VisitType string