orbit-types 0.1.0

Shared types for Orbit.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

#![warn(clippy::all, clippy::pedantic, clippy::nursery)]

use serde::{Deserialize, Serialize};

/// A progress update for a deployment.
pub enum Progress {
	Log(Log),
	Stage(Stage),
}

/// A log message.
#[derive(Debug, Serialize, Deserialize)]
#[serde(tag = "type", content = "log")]
pub enum Log {
	Info(String),
	Error(String),
}

/// The stage of the deployment.
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Stage {
	/// The deployment has been started.
	Starting,
	/// The current deployment has been downloaded.
	Downloaded,
	/// Dependencies for the current deployment have been installed.
	DepsInstalled,
	/// The current deployment has been migrated.
	Migrated,
	/// The current deployment has been optimized.
	Optimized,
	/// The deployment is now live.
	Deployed,
}

#[derive(Debug, thiserror::Error, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Error {
	/// Failed to boorstrap the project.
	#[error("Failed to bootstrap the project.")]
	Bootstrap,

	/// Failed to clone the repository.
	#[error("Failed to clone the repository.")]
	Download,

	/// Failed to extract the repository contents.
	#[error("Failed to extract the repository contents.")]
	Extraction,

	/// Failed to configure the deployment.
	#[error("Failed to configure the deployment.")]
	Configure,

	/// Failed to install dependencies.
	#[error("Failed to install dependencies.")]
	InstallDeps,

	/// Failed to run definded commands.
	#[error("Failed to run defined commands.")]
	RunCommands,

	#[error("Failed to optimize the deployment.")]
	Optimize,

	/// Failed to build the deployment.
	#[error("Failed to cleanup old deployments.")]
	Cleanup,

	/// Failed to build the deployment.
	#[error("Failed to publish the new deployment.")]
	Publish,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ErrorResponse {
	pub error: Error,
	pub message: String,
}

impl From<Error> for ErrorResponse {
	fn from(error: Error) -> Self {
		Self {
			message: error.to_string(),
			error,
		}
	}
}

impl From<Stage> for Progress {
	fn from(value: Stage) -> Self {
		Self::Stage(value)
	}
}