Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update beta logs logic #1775

Merged
merged 3 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions cargo-shuttle/src/args.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ use clap::{
use clap_complete::Shell;
use shuttle_common::constants::{DEFAULT_IDLE_MINUTES, EXAMPLES_REPO};
use shuttle_common::resource;
use uuid::Uuid;

#[derive(Parser)]
#[command(
Expand Down Expand Up @@ -411,7 +410,7 @@ impl InitTemplateArg {
#[derive(Parser, Clone, Debug, Default)]
pub struct LogsArgs {
/// Deployment ID to get logs for. Defaults to currently running deployment
pub id: Option<Uuid>,
pub id: Option<String>,
#[arg(short, long)]
/// View logs from the most recent deployment (which is not always the latest running one)
pub latest: bool,
Expand All @@ -430,6 +429,9 @@ pub struct LogsArgs {
/// View all log lines
#[arg(long, group = "output_mode")]
pub all: bool,
/// Get logs from all deployments instead of one deployment
#[arg(long)]
pub all_deployments: bool,
}

/// Helper function to parse and return the absolute path
Expand Down
42 changes: 33 additions & 9 deletions cargo-shuttle/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ use reqwest::header::HeaderMap;
use reqwest::{RequestBuilder, Response};
use serde::{Deserialize, Serialize};
use shuttle_common::constants::headers::X_CARGO_SHUTTLE_VERSION;
use shuttle_common::log::LogsRange;
use shuttle_common::log::{LogsRange, LogsResponseBeta};
use shuttle_common::models::deployment::{DeploymentRequest, DeploymentRequestBeta};
use shuttle_common::models::team;
use shuttle_common::models::{deployment, project, service, ToJson};
Expand Down Expand Up @@ -250,7 +250,7 @@ impl ShuttleApiClient {
pub async fn get_logs(
&self,
project: &str,
deployment_id: &Uuid,
deployment_id: &str,
range: LogsRange,
) -> Result<Vec<LogItem>> {
let mut path = format!("/projects/{project}/deployments/{deployment_id}/logs");
Expand All @@ -260,11 +260,25 @@ impl ShuttleApiClient {
.await
.context("Failed parsing logs. Is your cargo-shuttle outdated?")
}
pub async fn get_deployment_logs_beta(
&self,
project: &str,
deployment_id: &str,
) -> Result<LogsResponseBeta> {
let path = format!("/projects/{project}/deployments/{deployment_id}/logs");

self.get(path).await.context("Failed parsing logs.")
}
pub async fn get_project_logs_beta(&self, project: &str) -> Result<LogsResponseBeta> {
let path = format!("/projects/{project}/logs");

self.get(path).await.context("Failed parsing logs.")
}

pub async fn get_logs_ws(
&self,
project: &str,
deployment_id: &Uuid,
deployment_id: &str,
range: LogsRange,
) -> Result<WebSocketStream<MaybeTlsStream<TcpStream>>> {
let mut path = format!("/projects/{project}/ws/deployments/{deployment_id}/logs");
Expand All @@ -287,12 +301,6 @@ impl ShuttleApiClient {
};
}

pub async fn deployments_beta(&self, project: &str) -> Result<Vec<deployment::EcsResponse>> {
let path = format!("/projects/{project}/deployments",);

self.get(path).await
}

pub async fn get_deployments(
&self,
project: &str,
Expand All @@ -307,6 +315,22 @@ impl ShuttleApiClient {

self.get(path).await
}
pub async fn get_deployments_beta(
&self,
project: &str,
) -> Result<Vec<deployment::EcsResponse>> {
let path = format!("/projects/{project}/deployments");

self.get(path).await
}
pub async fn _get_current_deployment_beta(
&self,
project: &str,
) -> Result<deployment::EcsResponse> {
let path = format!("/projects/{project}/deployments/current");

self.get(path).await
}

pub async fn deployment_status(
&self,
Expand Down
60 changes: 30 additions & 30 deletions cargo-shuttle/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -850,31 +850,23 @@ impl Shuttle {

async fn logs_beta(&self, args: LogsArgs) -> Result<CommandOutcome> {
let client = self.client.as_ref().unwrap();
let mut stream = client
// TODO: use something else than a fake Uuid
.get_logs_ws(self.ctx.project_name(), &Uuid::new_v4(), LogsRange::All)
.await
.map_err(|err| {
suggestions::logs::get_logs_failure(err, "Connecting to the logs stream failed")
})?;

while let Some(Ok(msg)) = stream.next().await {
if let tokio_tungstenite::tungstenite::Message::Text(line) = msg {
match serde_json::from_str::<shuttle_common::LogItemBeta>(&line) {
Ok(log) => {
if args.raw {
println!("{}", log.line);
} else {
println!("{log}");
}
}
Err(err) => {
// TODO better handle logs, by returning a different type than the log line
// if an error happened.
bail!(err);
}
}
}
let proj_name = self.ctx.project_name();
let logs = if args.all_deployments {
client.get_project_logs_beta(proj_name).await?.logs
} else {
// TODO:
// let depl = client.get_current_deployment_beta(proj_name).await?;
let depls = client.get_deployments_beta(proj_name).await?;
let depl = depls
.first()
.expect("at least one deployment in this project");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion(non-blocking): we might want to return a proper error to the user instead of panicking. Can be done in an other PR.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah fixing the "current deployment" endpoint is probably what we want.

client
.get_deployment_logs_beta(proj_name, &depl.id)
.await?
.logs
};
for log in logs {
println!("{}", log);
}

Ok(CommandOutcome::Ok)
Expand Down Expand Up @@ -908,10 +900,10 @@ impl Shuttle {
"Could not find any deployments for '{proj_name}'. Try passing a deployment ID manually",
))?;

most_recent.id
most_recent.id.to_string()
} else if let Some(deployment) = client.get_service(proj_name).await?.deployment {
// Active deployment
deployment.id
deployment.id.to_string()
} else {
bail!(
"Could not find a running deployment for '{proj_name}'. \
Expand Down Expand Up @@ -984,7 +976,7 @@ impl Shuttle {

let deployments_len = if self.beta {
let deployments = client
.deployments_beta(proj_name)
.get_deployments_beta(proj_name)
.await
.map_err(suggestions::deployment::get_deployments_list_failure)?;
let table = deployments_table_beta(&deployments, proj_name, raw);
Expand Down Expand Up @@ -1862,7 +1854,11 @@ impl Shuttle {
.map_err(suggestions::deploy::deploy_request_failure)?;

let mut stream = client
.get_logs_ws(self.ctx.project_name(), &deployment.id, LogsRange::All)
.get_logs_ws(
self.ctx.project_name(),
&deployment.id.to_string(),
LogsRange::All,
)
.await
.map_err(|err| {
suggestions::deploy::deployment_setup_failure(
Expand Down Expand Up @@ -1982,7 +1978,11 @@ impl Shuttle {
// the terminal isn't completely spammed
sleep(Duration::from_millis(100)).await;
stream = client
.get_logs_ws(self.ctx.project_name(), &deployment.id, LogsRange::All)
.get_logs_ws(
self.ctx.project_name(),
&deployment.id.to_string(),
LogsRange::All,
)
.await
.map_err(|err| {
suggestions::deploy::deployment_setup_failure(
Expand Down
5 changes: 5 additions & 0 deletions common/src/log.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ impl std::fmt::Display for LogItemBeta {
}
}

#[derive(Debug, Serialize, Deserialize)]
pub struct LogsResponseBeta {
pub logs: Vec<LogItemBeta>,
}

const LOGLINE_MAX_CHARS: usize = 2048;
const TRUNC_MSG: &str = "... (truncated)";

Expand Down