storj/multinode/nodes/nodes.go

// Copyright (C) 2020 Storj Labs, Inc.
// See LICENSE for copying information.

package nodes

import (
	"context"
	"time"

	"github.com/zeebo/errs"

	"storj.io/common/storj"
)

// DB exposes needed by MND NodesDB functionality.
//
// architecture: Database
type DB interface {
	// Get return node from NodesDB by its id.
	Get(ctx context.Context, id storj.NodeID) (Node, error)
	// List returns all connected nodes.
	List(ctx context.Context) ([]Node, error)
	// ListPaged returns paginated nodes list.
	// TODO: rename to ListPaginated, because pagination is to divide up copy into pages,
	// because paging doesn't necessarily mean pagination in computing.
	ListPaged(ctx context.Context, cursor Cursor) (page Page, err error)
	// Add creates new node in NodesDB.
	// TODO: pass Node entity instead of set of a parameters.
	Add(ctx context.Context, id storj.NodeID, apiSecret []byte, publicAddress string) error
	// Remove removed node from NodesDB.
	Remove(ctx context.Context, id storj.NodeID) error
	// UpdateName will update name of the specified node in database.
	UpdateName(ctx context.Context, id storj.NodeID, name string) error
}

var (
	// ErrNoNode is a special error type that indicates about absence of node in NodesDB.
	ErrNoNode = errs.Class("no such node")
)

// Node is a representation of storagenode, that SNO could add to the Multinode Dashboard.
type Node struct {
	ID storj.NodeID `json:"id"`
	// APISecret is a secret issued by storagenode, that will be main auth mechanism in MND <-> SNO api.
	APISecret     []byte `json:"apiSecret"`
	PublicAddress string `json:"publicAddress"`
	Name          string `json:"name"`
}

// Status represents node online status.
type Status string

const (
	// StatusOnline represents online status.
	StatusOnline Status = "online"
	// StatusOffline represents offline status.
	StatusOffline Status = "offline"
	// StatusNotReachable indicates that we could not reach storagenode via drpc request.
	StatusNotReachable Status = "not reachable"
	// StatusUnauthorized indicates that api key is wrong.
	StatusUnauthorized Status = "unauthorized"
	// StatusStorageNodeInternalError indicates storagenode internal error.
	StatusStorageNodeInternalError Status = "storagenode internal error"
)

// NodeInfo contains basic node internal state.
type NodeInfo struct {
	ID            storj.NodeID `json:"id"`
	Name          string       `json:"name"`
	Version       string       `json:"version"`
	LastContact   time.Time    `json:"lastContact"`
	DiskSpaceUsed int64        `json:"diskSpaceUsed"`
	DiskSpaceLeft int64        `json:"diskSpaceLeft"`
	BandwidthUsed int64        `json:"bandwidthUsed"`
	TotalEarned   int64        `json:"totalEarned"`
	Status        Status       `json:"status"`
}

// NodeInfoSatellite contains satellite specific node internal state.
type NodeInfoSatellite struct {
	ID              storj.NodeID `json:"id"`
	Name            string       `json:"name"`
	Version         string       `json:"version"`
	LastContact     time.Time    `json:"lastContact"`
	OnlineScore     float64      `json:"onlineScore"`
	AuditScore      float64      `json:"auditScore"`
	SuspensionScore float64      `json:"suspensionScore"`
	TotalEarned     int64        `json:"totalEarned"`
	Status          Status       `json:"status"`
}

// TODO: separate common types and logic from nodes and operators and place it in private/pkg.

// Cursor holds cursor entity which is used to create listed page.
type Cursor struct {
	Limit int64
	Page  int64
}

// Page holds nodes page entity which is used to show listed page of nodes.
type Page struct {
	Nodes       []Node
	Limit       int64
	Offset      int64
	PageCount   int64
	CurrentPage int64
	TotalCount  int64
}