network

type Access interface {
	// ListEnabledNodesByScope lists the enabled nodes, with their servers,
	// that a plan scope selects (an explicit node id or any of the tags) in
	// sort order. An empty scope selects every enabled node.
	ListEnabledNodesByScope(ctx context.Context, nodeIDs []int64, tags []string) ([]*node.Node, error)
	// ListEnabledNodes lists up to limit enabled nodes, with their servers,
	// in sort order.
	ListEnabledNodes(ctx context.Context, limit int) ([]*node.Node, error)
	// SubscriptionTrafficLogs pages the traffic records of a user's
	// subscription and counts them.
	SubscriptionTrafficLogs(ctx context.Context, userID, subscribeID int64, page, size int) ([]*traffic.TrafficLog, int64, error)
	// ClearServerCachesByNodeScope drops the node-facing caches (user lists
	// and configs) of every server carrying a node the scope selects, an
	// explicit node id or any of the tags, enabled or not. An empty scope
	// clears nothing.
	ClearServerCachesByNodeScope(ctx context.Context, nodeIDs []int64, tags []string) error
}

type Accounts interface {
	edge.AccountStateReader
	serverapi.AccountReader
}

type Deps struct {
	Store        Store
	TrafficUsage subscription.TrafficUsage
	// Subscription is the subscription read port (the subscription facade).
	Subscription SubscriptionReader
	Redis        *redis.Client
	// Config snapshots the runtime-mutable settings per request.
	Config func() Snapshot
	// Multiplier returns the node traffic multiplier in effect at the given
	// time; nil means no multiplier is configured.
	Multiplier func(at time.Time) float32
	// Accounts reads the subscription owners' account state from the
	// identity domain.
	Accounts Accounts
	// Logs is the platform's system log, where the daily traffic statistics
	// are recorded.
	Logs repository.LogRepo
}

type MultiplierManager = multiplier.Manager

type MultiplierPeriod = multiplier.TimePeriod

type RequestMeta = serverapi.RequestMeta

type ResponseMeta = serverapi.ResponseMeta

type Service interface {
	// Admin-side server and node management.
	CreateServer(ctx context.Context, req *dto.CreateServerRequest) error
	UpdateServer(ctx context.Context, req *dto.UpdateServerRequest) error
	DeleteServer(ctx context.Context, req *dto.DeleteServerRequest) error
	FilterServerList(ctx context.Context, req *dto.FilterServerListRequest) (*dto.FilterServerListResponse, error)
	ResetSortWithServer(ctx context.Context, req *dto.ResetSortRequest) error
	GetServerProtocols(ctx context.Context, req *dto.GetServerProtocolsRequest) (*dto.GetServerProtocolsResponse, error)
	GetServerNodeConfig(ctx context.Context, req *dto.GetServerNodeConfigRequest) (*dto.GetServerNodeConfigResponse, error)
	UpdateServerNodeConfig(ctx context.Context, req *dto.UpdateServerNodeConfigRequest) error
	CreateNode(ctx context.Context, req *dto.CreateNodeRequest) error
	UpdateNode(ctx context.Context, req *dto.UpdateNodeRequest) error
	DeleteNode(ctx context.Context, req *dto.DeleteNodeRequest) error
	FilterNodeList(ctx context.Context, req *dto.FilterNodeListRequest) (*dto.FilterNodeListResponse, error)
	ToggleNodeStatus(ctx context.Context, req *dto.ToggleNodeStatusRequest) error
	ResetSortWithNode(ctx context.Context, req *dto.ResetSortRequest) error
	QueryNodeTag(ctx context.Context) (*dto.QueryNodeTagResponse, error)

	// Statistics serves the platform's reads of the node and traffic
	// figures.
	Statistics

	// The node-facing server API. The ETag negotiation flows through
	// RequestMeta/ResponseMeta; node authentication stays in the handlers.
	GetServerConfig(ctx context.Context, req *dto.GetServerConfigRequest, meta RequestMeta) (*dto.GetServerConfigResponse, ResponseMeta, error)
	GetServerUserList(ctx context.Context, req *dto.GetServerUserListRequest, meta RequestMeta) (*dto.GetServerUserListResponse, ResponseMeta, error)
	QueryServerProtocolConfig(ctx context.Context, req *dto.QueryServerConfigRequest) (*dto.QueryServerConfigResponse, error)
	PushOnlineUsers(ctx context.Context, req *dto.OnlineUsersRequest) error
	ServerPushStatus(ctx context.Context, req *dto.ServerPushStatusRequest) error
	ServerPushUserTraffic(ctx context.Context, req *dto.ServerPushUserTrafficRequest) error

	// EdgeManifest serves the token-authenticated edge client manifest.
	EdgeManifest(ctx context.Context, token string) (*dto.EdgeManifestResponse, error)

	// RecordDailyTrafficStatistics records the previous day's traffic
	// statistics in the system log, once per day however often it runs.
	RecordDailyTrafficStatistics(ctx context.Context) error
	// PruneTrafficLogs deletes the raw traffic log older than before and
	// returns how many rows it deleted.
	PruneTrafficLogs(ctx context.Context, before time.Time) (int64, error)

	// Access serves the other modules' reads and cache invalidation (see
	// access.go).
	Access
}

type Snapshot struct {
	Node      config.NodeConfig
	Subscribe config.SubscribeConfig
}

type Statistics interface {
	// CountEnabledNodes counts the enabled nodes.
	CountEnabledNodes(ctx context.Context) (int64, error)
	// ListServerAddresses returns the address of every server.
	ListServerAddresses(ctx context.Context) ([]string, error)
	// ListEnabledNodeProtocols returns the protocol of every enabled node.
	ListEnabledNodeProtocols(ctx context.Context) ([]string, error)
	// CountServersByReportStatus counts the servers that reported after
	// cutoff (online) and the others (offline).
	CountServersByReportStatus(ctx context.Context, cutoff time.Time) (online, offline int64, err error)
	// CountOnlineUsers counts the subscriptions online on any server.
	CountOnlineUsers(ctx context.Context) (int64, error)
	// FindServers returns the servers among ids that exist.
	FindServers(ctx context.Context, ids []int64) ([]*node.Server, error)

	// TrafficSummary sums the traffic logged in [start, end).
	TrafficSummary(ctx context.Context, start, end time.Time) (*traffic.TotalTraffic, error)
	// TopServersTrafficByDay and TopUsersTrafficByDay rank the servers and
	// the subscriptions by the traffic of date's day, at most limit of them.
	TopServersTrafficByDay(ctx context.Context, date time.Time, limit int) ([]traffic.ServerTrafficRanking, error)
	TopUsersTrafficByDay(ctx context.Context, date time.Time, limit int) ([]traffic.UserTrafficRanking, error)
	// ServerTrafficRanking and UserTrafficRanking rank every server and every
	// subscription by its traffic in [start, end).
	ServerTrafficRanking(ctx context.Context, start, end time.Time) ([]traffic.ServerTrafficRanking, error)
	UserTrafficRanking(ctx context.Context, start, end time.Time) ([]traffic.UserTrafficRanking, error)
	// TrafficLogDetails pages the traffic log entries filter selects.
	TrafficLogDetails(ctx context.Context, filter *traffic.TrafficLogDetailsFilter) ([]*traffic.TrafficLog, int64, error)
}

type Store interface {
	adminserver.Store
	edge.Store
	// TrafficLog serves the traffic-log reads of the other modules.
	TrafficLog() repository.TrafficRepo
}

type SubscriptionReader interface {
	adminserver.OnlineSubscriptionReader
	serverapi.SubscriptionReader
	edge.SubscriptionReader
}

type TrafficAggregator = trafficagg.Aggregator

type TrafficAggregatorAppStore = trafficagg.AppStore

type TrafficAggregatorDeps = trafficagg.Deps

type TrafficAggregatorStore = trafficagg.Store

type UserTraffic = trafficagg.UserTraffic