entity

type ArtifactdRepository struct {
	URL string `json:"url"`       // in case external
	Ns  string `json:"namespace"` // in case external
	ID  string `json:"id"`
}

type BoundAddress struct {
	Host string `json:"host"`
	Port int    `json:"port"`
}

type BuildArtifact struct {
	Ns           string          `json:"namespace" ch:"namespace"`
	Id           string          `json:"id"`
	Name         string          `json:"name" ch:"name"`
	CommitID     string          `json:"commit_id" ch:"commit_id"`
	Branch       string          `json:"branch,omitempty" ch:"branch"`
	Actor        string          `json:"actor" ch:"actor"`
	Tag          string          `json:"tag,omitempty" ch:"tag"`
	Data         json.RawMessage `json:"data" ch:"data"`
	PublishedAt  time.Time       `json:"published_at" ch:"published_at"`
	Source       string          `json:"source" ch:"source"`
	RepositoryID string          `json:"repository_id"`
	URLx         string          `json:"url"`
	OsArch       []string        `json:"os_arch" ch:"os_arch"`
	Archive      []*entity.File  `json:"archive"`
}

type CancelJobRequest struct {
	Ns      string `json:"namespace"`
	Id      string `json:"id"`
	Service string `json:"service"`
}

type ClickHouseStorageConfig struct {
	Address string `json:"address"`
}

type CloudflareConfig struct {
	TunnelToken string `json:"tunnel_token"`
}

type ClusterConfiguration struct {
	OS      string `json:"os"`
	Arch    string `json:"arch"`
	RaftDir string `json:"raft_dir"`
}

type ConfigureHostJob struct {
	Status map[string]HostConfigurationState `json:"status"`
}

type ConfirmDeployment struct {
	Message        string
	CTAButtonLabel string
}

type ContinueDeployment struct {
	Message    string
	TargetHost string
}

type DeploymentJob struct {
	Ns string `json:"namespace"`
	Id string `json:"id"`

	// main status / DAG
	Status            DeploymentJobStatus `json:"status"`
	RestartServiceJob RestartServiceJob   `json:"restart_service_job"`
	ConfigureHostJob  ConfigureHostJob    `json:"configure_host_job"`

	// The request; when displaying can be omitted
	Request *SubmitDeploymentJobRequest `json:"request,omitempty"`

	// The target host in which we will deploy our service to;
	// In dragonboat lingo, this would be the Nodes, as opossed to NonVotings, Witnesses, Removed member type.
	// able to be omitted for display
	Target []Host `json:"target,omitempty"`

	RaftConfig *RaftConfig `json:"raft_config,omitempty"`

	PendingUserAction *PendingUserAction `json:"pending_user_action,omitempty"`

	Url         string     `json:"url"`
	PublishedAt time.Time  `json:"published_at"`
	FinishedAt  *time.Time `json:"finished_at,omitempty"`
}

type DeploymentJobByService struct {
	*DeploymentJob
}

type DeploymentJobStatus string

type Env struct {
	KV
}

type Host struct {
	Ns   string `json:"namespace"`
	Host string `json:"host"`

	Architecture string `json:"architecture"`
	OS           string `json:"os"`
	FQDN         string `json:"fqdn"`

	RaftConfig RaftHostConfig `json:"raft_config"`

	PublishedAt time.Time `json:"published_at"`
	URLx        string    `json:"url"`
}

type HostConfigurationState struct {
	ErrorMessage *string                 `json:"error_message,omitempty"`
	Status       HostConfigurationStatus `json:"status"`
	URL          string                  `json:"url,omitempty"` // url with job id to stream log from
	JobID        string                  `json:"job_id,omitempty"`
}

type HostConfigurationStatus string

type HostDeploymentJob struct {
	*DeploymentJob
	Status HostRestartServiceStatus `json:"status"`
}

type HostRestartServiceState struct {
	ErrorMessage *string                  `json:"error_message,omitempty"`
	Status       HostRestartServiceStatus `json:"status"`
	URL          string                   `json:"url,omitempty"` // url with job id to stream log from
	JobID        string                   `json:"job_id,omitempty"`
}

type HostRestartServiceStatus string

type KV struct {
	Ns      string `json:"namespace"`
	Service string `json:"service"`

	Version string `json:"version"`

	Value map[string]string `json:"value"`

	PublishedAt time.Time `json:"published_at" ch:"published_at"`
	URLx        string    `json:"url"`
}

type PendingUserAction struct {
	// after configuration finish
	ConfirmDeployment  *ConfirmDeployment  `json:"confirm_deployment,omitempty"`
	ContinueDeployment *ContinueDeployment `json:"continue_deployment,omitempty"`
}

type RaftConfig struct {
	Service map[string]RaftServiceConfig `json:"service,omitempty"`
	Shards  map[uint64]RaftShardConfig   `json:"shards,omitempty"`
}

type RaftHost struct {
	Id        string `json:"id,omitempty"`
	Ns        string `json:"namespace" ch:"namespace"`
	ServiceID string `json:"service_id"`

	ReplicaID      uint64 `json:"replica_id"`
	RaftAdress     string `json:"raft_address"`
	WALDir         string `json:"wal_dir"`
	NodeHostDir    string `json:"node_host_dir"`
	RTTMillisecond uint64 `json:"rtt_millisecond"`
	DeploymentID   uint64 `json:"deployment_id"`

	PublishedAt time.Time `json:"published_at" ch:"published_at"`
	URLx        string    `json:"url"`
}

type RaftHostConfig struct {
	ReplicaID       uint64 `json:"replica_id"`
	BaseWALDir      string `json:"base_wal_dir"`
	BaseNodeHostDir string `json:"base_node_host_dir"`
	RTTMillisecond  uint64 `json:"rtt_millisecond"`
}

type RaftReplica struct {
	Id        string `json:"id,omitempty"`
	Ns        string `json:"namespace" ch:"namespace"`
	ServiceID string `json:"service_id"`

	ReplicaConfig map[uint64]ReplicaConfig `json:"replica_config"`

	PublishedAt time.Time `json:"published_at" ch:"published_at"`
	URLx        string    `json:"url"`
}

type RaftServiceConfig struct {
	ReplicaID    uint64 `json:"replica_id"` // convenience from host
	DeploymentID uint64 `json:"deployment_id"`
	RaftAddress  string `json:"raft_address"`
}

type RaftShardConfig struct {
	BootstrapHost string `json:"bootstrap_host"` // overwritten in http integration
	ShardID       uint64 `json:"shard_id"`
	ID            string `json:"id"`
	Type          string `json:"type"`
	Description   string `json:"description"`
}

type ReplicaConfig struct {
	ID          string          `json:"id"`
	ReplicaID   uint64          `json:"replica_id"`
	Alias       string          `json:"alias"`
	Description string          `json:"description"`
	Type        string          `json:"type"`
	Config      json.RawMessage `json:"config"`
}

type Repository struct {
	Id          string    `json:"id"`
	Ns          string    `json:"namespace"`
	Name        string    `json:"name"`
	Source      string    `json:"source"`
	PublishedAt time.Time `json:"published_at"`
	URLx        string    `json:"url"`
}

type RestartServiceJob struct {
	ConfirmedBy  string                             `json:"confirmed_by,omitempty"`
	CurrentOrder *uint                              `json:"current_order,omitempty"`
	HostOrder    []string                           `json:"host_order"`
	Status       map[string]HostRestartServiceState `json:"status"`
	ConfirmedAt  *time.Time                         `json:"confirmed_at,omitempty"`
}

type Routing struct {
	Ns      string `json:"namespace"`
	Service string `json:"service"`
	Version string `json:"version"`

	CloudflareConfig *CloudflareConfig `json:"cloudflare_config,omitempty"`

	PublishedAt time.Time `json:"published_at"`
	URLx        string    `json:"url"`
}

type Secret struct {
	KV
}

type ServiceDefinition struct {
	Ns string `json:"namespace"`
	Id string `json:"id"`

	Name        string `json:"name"`
	Description string `json:"description"`

	Repository     ArtifactdRepository `json:"repository"`
	ExecutablePath string              `json:"executable_path"` // todo add validation

	BoundAddresses []BoundAddress `json:"bound_addresses"`

	PublishedAt time.Time `json:"published_at"`
	URLx        string    `json:"url"`
}

type ServiceInstanceHost struct {
	Ns      string `json:"namespace"`
	Service string `json:"service"` // service
	Host    string `json:"host"`    // where is this deployed, the ID

	RaftConfig *RaftConfig `json:"raft_config,omitempty"`

	// current on progress deployment (if any)
	ActiveDeployment *HostDeploymentJob `json:"active_deployment,omitempty"`
	LatestDeployment *HostDeploymentJob `json:"latest_deployment,omitempty"`

	PublishedAt time.Time `json:"published_at"`
	URLx        string    `json:"url"`
}

type StorageConfiguration struct {
	Clickhouse ClickHouseStorageConfig `json:"clickhouse"`
}

type SubmitDeploymentJobRequest struct {
	Ns      string            `json:"namespace"`
	Service ServiceDefinition `json:"service"`
	Id      string            `json:"id"`

	BuildVersion  uint64 `json:"build_version"`
	SecretVersion uint64 `json:"secret_version"`
	EnvVersion    uint64 `json:"env_version"`

	// optional: lookup configure cloudflare routing
	RoutingVersion *uint64 `json:"routing_version,omitempty"`

	// TODO: List of hosts to deploy to; for first time deployment
	TargetHosts []Host `json:"target_hosts,omitempty"`

	// Register (new) replica at the deployment time.
	RaftShard        map[uint64]RaftShardConfig `json:"raft_shard,omitempty"`
	RaftPort         uint16                     `json:"raft_port"`
	RaftPortMapping  map[string]uint16          `json:"raft_port_mapping,omitempty"` // optional if at each host, the port is different
	RaftDeploymentID uint64                     `json:"raft_deployment_id"`

	ModifyKey *string `json:"-"` // hidden; TODO: to be nice, to lock, only the one who have this key can modify the state.

	TimeoutSeconds *uint32 `json:"timeout_seconds,omitempty"`

	IsBelieve   bool      `json:"is_believe"`
	Url         string    `json:"url"`
	PublishedAt time.Time `json:"published_at"`
}