Merge pull request 'v0.4.8 better errors' (#9) from staging into master

Reviewed-on: StrafesNET/asset-tool#9

Cargo.toml

@@ -1,7 +1,7 @@
 workspace = { members = ["rbx_asset", "rox_compiler"] }
 [package]
 name = "asset-tool"
-version = "0.4.6"
+version = "0.4.8"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

rbx_asset/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rbx_asset"
-version = "0.2.3"
+version = "0.2.5"
 edition = "2021"
 publish = ["strafesnet"]
 repository = "https://git.itzana.me/StrafesNET/asset-tool"

rbx_asset/src/cloud.rs

@@ -1,3 +1,5 @@
+use crate::ResponseError;
+
 #[derive(Debug,serde::Deserialize,serde::Serialize)]
 #[allow(nonstandard_style,dead_code)]
 pub enum AssetType{
@@ -40,6 +42,7 @@ impl AssetOperation{
 #[derive(Debug)]
 pub enum CreateError{
 	Parse(url::ParseError),
+	Response(ResponseError),
 	Serialize(serde_json::Error),
 	Reqwest(reqwest::Error),
 }
@@ -102,6 +105,7 @@ pub struct UpdatePlaceResponse{
 #[derive(Debug)]
 pub enum UpdateError{
 	ParseError(url::ParseError),
+	Response(ResponseError),
 	SerializeError(serde_json::Error),
 	Reqwest(reqwest::Error),
 }
@@ -167,6 +171,7 @@ pub struct GetAssetRequest{
 #[derive(Debug)]
 pub enum GetError{
 	ParseError(url::ParseError),
+	Response(ResponseError),
 	Reqwest(reqwest::Error),
 	IO(std::io::Error)
 }
@@ -203,6 +208,7 @@ pub struct AssetVersionsResponse{
 #[derive(Debug)]
 pub enum AssetVersionsError{
 	ParseError(url::ParseError),
+	Response(ResponseError),
 	Reqwest(reqwest::Error),
 }
 impl std::fmt::Display for AssetVersionsError{
@@ -238,6 +244,7 @@ pub struct InventoryPageResponse{
 #[derive(Debug)]
 pub enum InventoryPageError{
 	ParseError(url::ParseError),
+	Response(ResponseError),
 	Reqwest(reqwest::Error),
 }
 impl std::fmt::Display for InventoryPageError{
@@ -368,9 +375,9 @@ impl CloudContext{
 		.text("request",request_config)
 		.part("fileContent",part);
 
-		let operation=self.post_form(url,form).await
-		.map_err(CreateError::Reqwest)?
-		.error_for_status().map_err(CreateError::Reqwest)?
+		let operation=crate::response_ok(
+			self.post_form(url,form).await.map_err(CreateError::Reqwest)?
+		).await.map_err(CreateError::Response)?
 		.json::<RobloxOperation>().await.map_err(CreateError::Reqwest)?;
 
 		Ok(AssetOperation{
@@ -387,10 +394,9 @@ impl CloudContext{
 		.text("request",request_config)
 		.part("fileContent",reqwest::multipart::Part::bytes(body));
 
-		let operation=self.patch_form(url,form).await
-		.map_err(UpdateError::Reqwest)?
-		//roblox api documentation is very poor, just give the status code and drop the json
-		.error_for_status().map_err(UpdateError::Reqwest)?
+		let operation=crate::response_ok(
+			self.patch_form(url,form).await.map_err(UpdateError::Reqwest)?
+		).await.map_err(UpdateError::Response)?
 		.json::<RobloxOperation>().await.map_err(UpdateError::Reqwest)?;
 
 		Ok(AssetOperation{
@@ -401,24 +407,27 @@ impl CloudContext{
 		let raw_url=format!("https://apis.roblox.com/assets/v1/operations/{}",config.operation_id);
 		let url=reqwest::Url::parse(raw_url.as_str()).map_err(GetError::ParseError)?;
 
-		self.get(url).await.map_err(GetError::Reqwest)?
-		.error_for_status().map_err(GetError::Reqwest)?
+		crate::response_ok(
+			self.get(url).await.map_err(GetError::Reqwest)?
+		).await.map_err(GetError::Response)?
 		.json::<RobloxOperation>().await.map_err(GetError::Reqwest)
 	}
 	pub async fn get_asset_info(&self,config:GetAssetInfoRequest)->Result<AssetResponse,GetError>{
 		let raw_url=format!("https://apis.roblox.com/assets/v1/assets/{}",config.asset_id);
 		let url=reqwest::Url::parse(raw_url.as_str()).map_err(GetError::ParseError)?;
 
-		self.get(url).await.map_err(GetError::Reqwest)?
-		.error_for_status().map_err(GetError::Reqwest)?
+		crate::response_ok(
+			self.get(url).await.map_err(GetError::Reqwest)?
+		).await.map_err(GetError::Response)?
 		.json::<AssetResponse>().await.map_err(GetError::Reqwest)
 	}
 	pub async fn get_asset_version(&self,config:GetAssetVersionRequest)->Result<Vec<u8>,GetError>{
 		let raw_url=format!("https://apis.roblox.com/assets/v1/assets/{}/versions/{}",config.asset_id,config.version);
 		let url=reqwest::Url::parse(raw_url.as_str()).map_err(GetError::ParseError)?;
 
-		let body=self.get(url).await.map_err(GetError::Reqwest)?
-		.error_for_status().map_err(GetError::Reqwest)?
+		let body=crate::response_ok(
+			self.get(url).await.map_err(GetError::Reqwest)?
+		).await.map_err(GetError::Response)?
 		.bytes().await.map_err(GetError::Reqwest)?;
 
 		match maybe_gzip_decode(&mut std::io::Cursor::new(body)){
@@ -441,8 +450,9 @@ impl CloudContext{
 		let raw_url=format!("https://apis.roblox.com/assets/v1/assets/{}/versions",config.asset_id);
 		let url=reqwest::Url::parse(raw_url.as_str()).map_err(AssetVersionsError::ParseError)?;
 
-		self.get(url).await.map_err(AssetVersionsError::Reqwest)?
-		.error_for_status().map_err(AssetVersionsError::Reqwest)?
+		crate::response_ok(
+			self.get(url).await.map_err(AssetVersionsError::Reqwest)?
+		).await.map_err(AssetVersionsError::Response)?
 		.json::<AssetVersionsResponse>().await.map_err(AssetVersionsError::Reqwest)
 	}
 	pub async fn inventory_page(&self,config:InventoryPageRequest)->Result<InventoryPageResponse,InventoryPageError>{
@@ -455,8 +465,9 @@ impl CloudContext{
 			}
 		}
 
-		self.get(url).await.map_err(InventoryPageError::Reqwest)?
-		.error_for_status().map_err(InventoryPageError::Reqwest)?
+		crate::response_ok(
+			self.get(url).await.map_err(InventoryPageError::Reqwest)?
+		).await.map_err(InventoryPageError::Response)?
 		.json::<InventoryPageResponse>().await.map_err(InventoryPageError::Reqwest)
 	}
 	pub async fn update_place(&self,config:UpdatePlaceRequest,body:impl Into<reqwest::Body>+Clone)->Result<UpdatePlaceResponse,UpdateError>{
@@ -468,8 +479,9 @@ impl CloudContext{
 			query.append_pair("versionType","Published");
 		}
 
-		self.post(url,body).await.map_err(UpdateError::Reqwest)?
-		.error_for_status().map_err(UpdateError::Reqwest)?
+		crate::response_ok(
+			self.post(url,body).await.map_err(UpdateError::Reqwest)?
+		).await.map_err(UpdateError::Response)?
 		.json::<UpdatePlaceResponse>().await.map_err(UpdateError::Reqwest)
 	}
 }

rbx_asset/src/cookie.rs

@@ -1,3 +1,5 @@
+use crate::ResponseError;
+
 #[derive(Debug)]
 pub enum PostError{
 	Reqwest(reqwest::Error),
@@ -23,6 +25,7 @@ pub struct CreateRequest{
 pub enum CreateError{
 	ParseError(url::ParseError),
 	PostError(PostError),
+	Response(ResponseError),
 	Reqwest(reqwest::Error),
 }
 impl std::fmt::Display for CreateError{
@@ -46,6 +49,7 @@ pub enum UploadError{
 	ParseError(url::ParseError),
 	PostError(PostError),
 	Reqwest(reqwest::Error),
+	Response(ResponseError),
 	AssetIdIsZero,
 }
 impl std::fmt::Display for UploadError{
@@ -54,11 +58,11 @@ impl std::fmt::Display for UploadError{
 	}
 }
 impl std::error::Error for UploadError{}
+type RobloxUploadResponse=u64;
 #[derive(Debug,serde::Deserialize,serde::Serialize)]
 #[allow(nonstandard_style,dead_code)]
 pub struct UploadResponse{
 	pub AssetId:u64,
-	pub AssetVersionId:u64,
 }
 
 #[allow(nonstandard_style,dead_code)]
@@ -69,6 +73,7 @@ pub struct GetAssetRequest{
 #[derive(Debug)]
 pub enum GetError{
 	ParseError(url::ParseError),
+	Response(ResponseError),
 	Reqwest(reqwest::Error),
 	IO(std::io::Error)
 }
@@ -105,6 +110,7 @@ pub struct AssetVersionsPageResponse{
 #[derive(Debug)]
 pub enum PageError{
 	ParseError(url::ParseError),
+	Response(ResponseError),
 	Reqwest(reqwest::Error),
 }
 impl std::fmt::Display for PageError{
@@ -204,8 +210,9 @@ fn read_readable(mut readable:impl std::io::Read)->std::io::Result<Vec<u8>>{
 #[derive(Clone)]
 pub struct Cookie(String);
 impl Cookie{
+	/// cookie is prepended with ".ROBLOSECURITY=" by this function
 	pub fn new(cookie:String)->Self{
-		Self(cookie)
+		Self(format!(".ROBLOSECURITY={cookie}"))
 	}
 	pub fn get(self)->String{
 		self.0
@@ -265,10 +272,14 @@ impl CookieContext{
 				query.append_pair("groupId",group_id.to_string().as_str());
 			}
 		}
+		let asset_id=crate::response_ok(
+			self.post(url,body).await.map_err(CreateError::PostError)?
+		).await.map_err(CreateError::Response)?
+		.json::<RobloxUploadResponse>().await.map_err(CreateError::Reqwest)?;
 
-		self.post(url,body).await.map_err(CreateError::PostError)?
-		.error_for_status().map_err(CreateError::Reqwest)?
-		.json::<UploadResponse>().await.map_err(CreateError::Reqwest)
+		Ok(UploadResponse{
+			AssetId:asset_id,
+		})
 	}
 	pub async fn upload(&self,config:UploadRequest,body:impl Into<reqwest::Body>+Clone)->Result<UploadResponse,UploadError>{
 		let mut url=reqwest::Url::parse("https://data.roblox.com/Data/Upload.ashx?json=1&type=Model&genreTypeId=1").map_err(UploadError::ParseError)?;
@@ -296,10 +307,14 @@ impl CookieContext{
 				query.append_pair("groupId",group_id.to_string().as_str());
 			}
 		}
+		let asset_id=crate::response_ok(
+			self.post(url,body).await.map_err(UploadError::PostError)?
+		).await.map_err(UploadError::Response)?
+		.json::<RobloxUploadResponse>().await.map_err(UploadError::Reqwest)?;
 
-		self.post(url,body).await.map_err(UploadError::PostError)?
-		.error_for_status().map_err(UploadError::Reqwest)?
-		.json::<UploadResponse>().await.map_err(UploadError::Reqwest)
+		Ok(UploadResponse{
+			AssetId:asset_id,
+		})
 	}
 	pub async fn get_asset(&self,config:GetAssetRequest)->Result<Vec<u8>,GetError>{
 		let mut url=reqwest::Url::parse("https://assetdelivery.roblox.com/v1/asset/").map_err(GetError::ParseError)?;
@@ -311,8 +326,9 @@ impl CookieContext{
 				query.append_pair("version",version.to_string().as_str());
 			}
 		}
-		let body=self.get(url).await.map_err(GetError::Reqwest)?
-		.error_for_status().map_err(GetError::Reqwest)?
+		let body=crate::response_ok(
+			self.get(url).await.map_err(GetError::Reqwest)?
+		).await.map_err(GetError::Response)?
 		.bytes().await.map_err(GetError::Reqwest)?;
 
 		match maybe_gzip_decode(&mut std::io::Cursor::new(body)){
@@ -333,9 +349,9 @@ impl CookieContext{
 				query.append_pair("cursor",cursor);
 			}
 		}
-
-		self.get(url).await.map_err(PageError::Reqwest)?
-		.error_for_status().map_err(PageError::Reqwest)?
+		crate::response_ok(
+			self.get(url).await.map_err(PageError::Reqwest)?
+		).await.map_err(PageError::Response)?
 		.json::<AssetVersionsPageResponse>().await.map_err(PageError::Reqwest)
 	}
 	pub async fn get_creations_page(&self,config:&CreationsPageRequest)->Result<CreationsPageResponse,PageError>{
@@ -348,9 +364,9 @@ impl CookieContext{
 				query.append_pair("cursor",cursor);
 			}
 		}
-
-		self.get(url).await.map_err(PageError::Reqwest)?
-		.error_for_status().map_err(PageError::Reqwest)?
+		crate::response_ok(
+			self.get(url).await.map_err(PageError::Reqwest)?
+		).await.map_err(PageError::Response)?
 		.json::<CreationsPageResponse>().await.map_err(PageError::Reqwest)
 	}
 	pub async fn get_user_inventory_page(&self,config:&UserInventoryPageRequest)->Result<UserInventoryPageResponse,PageError>{
@@ -362,9 +378,9 @@ impl CookieContext{
 				query.append_pair("cursor",cursor);
 			}
 		}
-
-		self.get(url).await.map_err(PageError::Reqwest)?
-		.error_for_status().map_err(PageError::Reqwest)?
+		crate::response_ok(
+			self.get(url).await.map_err(PageError::Reqwest)?
+		).await.map_err(PageError::Response)?
 		.json::<UserInventoryPageResponse>().await.map_err(PageError::Reqwest)
 	}
 }

rbx_asset/src/lib.rs

@@ -1,2 +1,37 @@
 pub mod cloud;
 pub mod cookie;
+
+#[allow(dead_code)]
+#[derive(Debug)]
+pub struct StatusCodeWithUrlAndBody{
+	pub status_code:reqwest::StatusCode,
+	pub url:url::Url,
+	pub body:String,
+}
+#[derive(Debug)]
+pub enum ResponseError{
+	Reqwest(reqwest::Error),
+	StatusCodeWithUrlAndBody(StatusCodeWithUrlAndBody),
+}
+impl std::fmt::Display for ResponseError{
+	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+		write!(f,"{self:?}")
+	}
+}
+impl std::error::Error for ResponseError{}
+// lazy function to draw out meaningful info from http response on failure
+pub async fn response_ok(response:reqwest::Response)->Result<reqwest::Response,ResponseError>{
+	let status_code=response.status();
+	if status_code.is_success(){
+		Ok(response)
+	}else{
+		let url=response.url().to_owned();
+		let bytes=response.bytes().await.map_err(ResponseError::Reqwest)?;
+		let body=String::from_utf8_lossy(&bytes).to_string();
+		Err(ResponseError::StatusCodeWithUrlAndBody(StatusCodeWithUrlAndBody{
+			status_code,
+			url,
+			body,
+		}))
+	}
+}

src/main.rs

@@ -325,8 +325,8 @@ struct DownloadDecompileSubcommand{
 struct DecompileHistoryIntoGitSubcommand{
 	#[arg(long)]
 	input_folder:PathBuf,
-	//currently output folder must be the current folder due to git2 limitations
-	//output_folder:cli.output.unwrap(),
+	#[arg(long)]
+	output_folder:Option<PathBuf>,
 	#[arg(long)]
 	style:Style,
 	#[arg(long)]
@@ -351,8 +351,8 @@ struct DownloadAndDecompileHistoryIntoGitSubcommand{
 	cookie_envvar:Option<String>,
 	#[arg(long,group="cookie",required=true)]
 	cookie_file:Option<PathBuf>,
-	//currently output folder must be the current folder due to git2 limitations
-	//output_folder:cli.output.unwrap(),
+	#[arg(long)]
+	output_folder:Option<PathBuf>,
 	#[arg(long)]
 	style:Style,
 	#[arg(long)]
@@ -590,7 +590,7 @@ async fn main()->AResult<()>{
 			git_committer_name:subcommand.git_committer_name,
 			git_committer_email:subcommand.git_committer_email,
 			input_folder:subcommand.input_folder,
-			output_folder:std::env::current_dir()?,
+			output_folder:subcommand.output_folder.unwrap_or_else(||std::env::current_dir().unwrap()),
 			style:subcommand.style.rox(),
 			write_template:subcommand.write_template.unwrap_or(false),
 			write_models:subcommand.write_models.unwrap_or(false),
@@ -605,7 +605,7 @@ async fn main()->AResult<()>{
 				subcommand.cookie_file,
 			).await?,
 			asset_id:subcommand.asset_id,
-			output_folder:std::env::current_dir()?,
+			output_folder:subcommand.output_folder.unwrap_or_else(||std::env::current_dir().unwrap()),
 			style:subcommand.style.rox(),
 			write_template:subcommand.write_template.unwrap_or(false),
 			write_models:subcommand.write_models.unwrap_or(false),
@@ -621,7 +621,7 @@ async fn cookie_from_args(literal:Option<String>,environment:Option<String>,file
 		(None,None,Some(cookie_file))=>tokio::fs::read_to_string(cookie_file).await?,
 		_=>Err(anyhow::Error::msg("Illegal cookie argument triple"))?,
 	};
-	Ok(Cookie::new(format!(".ROBLOSECURITY={cookie}")))
+	Ok(Cookie::new(cookie))
 }
 async fn api_key_from_args(literal:Option<String>,environment:Option<String>,file:Option<PathBuf>)->AResult<ApiKey>{
 	let api_key=match (literal,environment,file){
@@ -1266,11 +1266,11 @@ async fn write_commit(config:WriteCommitConfig,b:Result<AResult<(AssetVersion,ro
 	let sig=git2::Signature::new(config.git_committer_name.as_str(),config.git_committer_email.as_str(),&git2::Time::new(date.timestamp(),0)).unwrap();
 	let tree_id={
 		let mut tree_index = repo.index()?;
-		match tree_index.add_all(std::iter::once(config.output_folder.as_path()),git2::IndexAddOption::DEFAULT,None){
+		match tree_index.add_all(std::iter::once("*"),git2::IndexAddOption::DEFAULT,None){
 			Ok(_)=>(),
 			Err(e)=>println!("tree_index.add_all error: {}",e),
 		}
-		match tree_index.update_all(std::iter::once(config.output_folder.as_path()),None){
+		match tree_index.update_all(std::iter::once("*"),None){
 			Ok(_)=>(),
 			Err(e)=>println!("tree_index.update_all error: {}",e),
 		}