database

type AppDatabase interface {
	// UpsertUser takes an OIDC subject and upserts the user into the database
	// and returns the users default project.
	UpsertUser(ctx context.Context, subject string) ([]types.Project, error)

	// CreateProject takes an OIDC subject and the project details and creates a new project.
	CreateProject(ctx context.Context, subject, name, description string) (types.Project, error)

	// GetUserProjects takes an OIDC subject returns all the projects the user is a member of.
	GetUserProjects(ctx context.Context, subject string) ([]types.Project, error)

	// CanAccessProject returns true if an OIDC subject and access a specific project ID. This
	// is helpful for determining if a user has the authorization to access a project.
	CanAccessProject(ctx context.Context, subject, projectId string) (bool, error)

	// ListProjectHosts returns all the hosts in a project with the given project ID.
	ListProjectHosts(ctx context.Context, projectId string) ([]types.Host, error)

	// GetHost returns the host with the given host ID and project ID.
	GetHost(ctx context.Context, hostId, projectId string) (types.Host, error)

	// GetEventLogsByHost returns the events logs for the host with the given host ID.
	GetEventLogsByHost(ctx context.Context, hostId string, limit int) (out []types.AgentEventLog, err error)

	// GetProjectMetrics returns the dashboard metrics for the given project ID.
	GetProjectMetrics(ctx context.Context, projectId string) (*types.ProjectMetrics, error)

	// GeneratePreSharedKey generates a new pre-shared key for the given project ID.
	GeneratePreSharedKey(ctx context.Context, projectId string, exp time.Time) (string, error)

	// CreateHostGroup creates a new host group with the given project ID, name, and description.
	// Host groups allow hosts to be logically grouped together for other operations.
	CreateHostGroup(ctx context.Context, projectId, name, description string) (string, error)
}

type Database interface {
	Migrate(ctx context.Context) error

	// AuthenticateAgent accepts the agent metadata and the authentication pre-shared key
	// and returns the agent ID if the agent is authenticated. This function will upsert
	// the agent, the host, and add the agent to the appropriate groups.
	AuthenticateAgent(ctx context.Context, psk string, md *rpc.SystemMetadata) (string, error)

	// Heartbeat updates the last heartbeat timestamp for the agent with the given agent ID.
	Heartbeat(ctx context.Context, agentID string) error

	// AgentShutdown sets an agent as offline. This is used to handle specific cases where an agent
	// receives a signal to shut down, and we want to mark it as offline.
	AgentShutdown(ctx context.Context, agentID string) error

	// AgentStartup sets an agent as online.
	AgentStartup(ctx context.Context, agentID string) error

	AppDatabase
}