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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
mod args;
mod client;
pub mod config;
mod factory;
mod print;
use std::fs::{read_to_string, File};
use std::io::Write;
use std::io::{self, stdout};
use std::net::{Ipv4Addr, SocketAddr};
use std::rc::Rc;
use anyhow::{anyhow, Context, Result};
pub use args::{Args, Command, DeployArgs, InitArgs, ProjectArgs, RunArgs};
use args::{AuthArgs, LoginArgs};
use cargo::core::compiler::CompileMode;
use cargo::core::resolver::CliFeatures;
use cargo::core::Workspace;
use cargo::ops::{CompileOptions, NewOptions, PackageOpts, Packages, TestOptions};
use cargo_edit::{find, get_latest_dependency, registry_url};
use colored::Colorize;
use config::RequestContext;
use factory::LocalFactory;
use futures::future::TryFutureExt;
use semver::{Version, VersionReq};
use shuttle_service::loader::{build_crate, Loader};
use tokio::sync::mpsc;
use toml_edit::{value, Array, Document, Item, Table, Value};
use uuid::Uuid;
#[macro_use]
extern crate log;
pub struct Shuttle {
ctx: RequestContext,
}
impl Default for Shuttle {
fn default() -> Self {
Self::new()
}
}
impl Shuttle {
pub fn new() -> Self {
let ctx = RequestContext::load_global().unwrap();
Self { ctx }
}
pub async fn run(mut self, args: Args) -> Result<()> {
trace!("running local client");
if matches!(
args.cmd,
Command::Deploy(..)
| Command::Delete
| Command::Status
| Command::Logs
| Command::Run(..)
) {
self.load_project(&args.project_args)?;
}
self.ctx.set_api_url(args.api_url);
match args.cmd {
Command::Deploy(deploy_args) => {
self.check_lib_version(args.project_args).await?;
self.deploy(deploy_args).await
}
Command::Init(init_args) => self.init(init_args).await,
Command::Status => self.status().await,
Command::Logs => self.logs().await,
Command::Delete => self.delete().await,
Command::Auth(auth_args) => self.auth(auth_args).await,
Command::Login(login_args) => self.login(login_args).await,
Command::Run(run_args) => self.local_run(run_args).await,
}
}
async fn init(&self, args: InitArgs) -> Result<()> {
let opts = NewOptions::new(None, false, true, args.path.clone(), None, None, None)?;
let cargo_config = cargo::util::config::Config::default()?;
let init_result = cargo::ops::init(&opts, &cargo_config)?;
cargo_config
.shell()
.status("Created", format!("{} (shuttle) package", init_result))?;
let cargo_path = args.path.join("Cargo.toml");
let mut cargo_doc = read_to_string(cargo_path.clone())?.parse::<Document>()?;
cargo_doc.remove("dependencies");
let crate_type_array = Array::from_iter(["cdylib"].into_iter());
let mut lib_table = Table::new();
lib_table["crate-type"] = Item::Value(Value::Array(crate_type_array));
cargo_doc["lib"] = Item::Table(lib_table);
let manifest_path = find(Some(&args.path)).unwrap();
let url = registry_url(manifest_path.as_path(), None).expect("Could not find registry URL");
let latest_shuttle_service =
get_latest_dependency("shuttle-service", false, &manifest_path, Some(&url))
.expect("Could not query the latest version of shuttle-service");
let shuttle_version = latest_shuttle_service
.version()
.expect("No latest shuttle-service version available");
let mut dep_table = Table::new();
dep_table["shuttle-service"]["version"] = value(shuttle_version);
cargo_doc["dependencies"] = Item::Table(dep_table);
let mut cargo_toml = File::create(cargo_path)?;
cargo_toml.write_all(cargo_doc.to_string().as_bytes())?;
Ok(())
}
pub fn load_project(&mut self, project_args: &ProjectArgs) -> Result<()> {
trace!("loading project arguments: {project_args:?}");
self.ctx.load_local(project_args)
}
async fn login(&mut self, login_args: LoginArgs) -> Result<()> {
let api_key_str = login_args.api_key.unwrap_or_else(|| {
let url = "https://shuttle.rs/login";
let _ = webbrowser::open(url);
println!("If your browser did not automatically open, go to {url}");
print!("Enter Api Key: ");
io::stdout().flush().unwrap();
let mut input = String::new();
io::stdin().read_line(&mut input).unwrap();
input
});
let api_key = api_key_str.trim().parse()?;
self.ctx.set_api_key(api_key)?;
Ok(())
}
async fn auth(&mut self, auth_args: AuthArgs) -> Result<()> {
let api_key = client::auth(self.ctx.api_url(), auth_args.username)
.await
.context("failed to retrieve api key")?;
self.ctx.set_api_key(api_key)?;
Ok(())
}
async fn delete(&self) -> Result<()> {
client::delete(
self.ctx.api_url(),
self.ctx.api_key()?,
self.ctx.project_name(),
)
.await
.context("failed to delete deployment")
}
async fn status(&self) -> Result<()> {
client::status(
self.ctx.api_url(),
self.ctx.api_key()?,
self.ctx.project_name(),
)
.await
.context("failed to get status of deployment")
}
async fn logs(&self) -> Result<()> {
client::logs(
self.ctx.api_url(),
self.ctx.api_key()?,
self.ctx.project_name(),
)
.await
.context("failed to get logs of deployment")
}
async fn local_run(&self, run_args: RunArgs) -> Result<()> {
trace!("starting a local run for a service: {run_args:?}");
let buf = Box::new(stdout());
let working_directory = self.ctx.working_directory();
trace!("building project");
println!(
"{:>12} {}",
"Building".bold().green(),
working_directory.display()
);
let so_path = build_crate(working_directory, buf)?;
let loader = Loader::from_so_file(so_path)?;
let mut factory = LocalFactory::new(self.ctx.project_name().clone())?;
let addr = SocketAddr::new(Ipv4Addr::LOCALHOST.into(), run_args.port);
let deployment_id = Uuid::new_v4();
let (tx, mut rx) = mpsc::unbounded_channel();
trace!("loading project");
println!(
"\n{:>12} {} on http://{}",
"Starting".bold().green(),
self.ctx.project_name(),
addr
);
let (handle, so) = loader.load(&mut factory, addr, tx, deployment_id).await?;
tokio::spawn(async move {
while let Some(log) = rx.recv().await {
print::log(log.datetime, log.item);
}
});
handle.await??;
tokio::spawn(async move {
trace!("closing so file");
so.close().unwrap();
});
Ok(())
}
async fn deploy(&self, args: DeployArgs) -> Result<()> {
self.run_tests(args.no_test)?;
let package_file = self
.run_cargo_package(args.allow_dirty)
.context("failed to package cargo project")?;
let key = self.ctx.api_key()?;
client::deploy(
package_file,
self.ctx.api_url(),
key,
self.ctx.project_name(),
)
.and_then(|_| {
client::secrets(
self.ctx.api_url(),
key,
self.ctx.project_name(),
self.ctx.secrets(),
)
})
.await
.context("failed to deploy cargo project")
}
async fn check_lib_version(&self, project_args: ProjectArgs) -> Result<()> {
let cargo_path = project_args.working_directory.join("Cargo.toml");
let cargo_doc = read_to_string(cargo_path.clone())?.parse::<Document>()?;
let current_shuttle_version = &cargo_doc["dependencies"]["shuttle-service"]["version"];
let service_semver = Version::parse(current_shuttle_version.as_str().unwrap())?;
let server_version = client::shuttle_version(self.ctx.api_url()).await?;
let server_version = Version::parse(&server_version)?;
let version_required = format!("{}.{}", server_version.major, server_version.minor);
let server_semver = VersionReq::parse(&version_required)?;
if server_semver.matches(&service_semver) {
Ok(())
} else {
Err(anyhow!(
"Your shuttle_service version is outdated. Update your shuttle_service version to {} and try to deploy again",
&server_version,
))
}
}
fn run_cargo_package(&self, allow_dirty: bool) -> Result<File> {
let config = cargo::util::config::Config::default()?;
let working_directory = self.ctx.working_directory();
let path = working_directory.join("Cargo.toml");
let ws = Workspace::new(&path, &config)?;
let opts = PackageOpts {
config: &config,
list: false,
check_metadata: true,
allow_dirty,
keep_going: false,
verify: false,
jobs: None,
to_package: Packages::Default,
targets: vec![],
cli_features: CliFeatures {
features: Rc::new(Default::default()),
all_features: false,
uses_default_features: true,
},
};
let locks = cargo::ops::package(&ws, &opts)?.expect("unwrap ok here");
let owned = locks.get(0).unwrap().file().try_clone()?;
Ok(owned)
}
fn run_tests(&self, no_test: bool) -> Result<()> {
if no_test {
return Ok(());
}
let config = cargo::util::config::Config::default()?;
let working_directory = self.ctx.working_directory();
let path = working_directory.join("Cargo.toml");
let compile_options = CompileOptions::new(&config, CompileMode::Test).unwrap();
let ws = Workspace::new(&path, &config)?;
let opts = TestOptions {
compile_opts: compile_options,
no_run: false,
no_fail_fast: false,
};
let test_failures = cargo::ops::run_tests(&ws, &opts, &[])?;
match test_failures {
None => Ok(()),
Some(_) => Err(anyhow!(
"Some tests failed. To ignore all tests, pass the `--no-test` flag"
)),
}
}
}