Add VSS Http thin client implementation for get/put/listKeyVersions api's

Author: G8XSU

Cargo.toml

@@ -1,4 +1,18 @@
-[workspace]
-members = [
-    "vss-accessor",
-]
+[package]
+name = "vss-client"
+version = "0.1.0"
+edition = "2021"
+build = "build.rs"
+
+[dependencies]
+prost = "0.11.9"
+reqwest = { version = "0.11.13", features = ["rustls-tls"] }
+
+[dev-dependencies]
+
+[build-dependencies]
+prost-build = { version = "0.11.3" }
+reqwest =  { version = "0.11.13", features = ["blocking"] }
+
+[features]
+genproto = []

vss-accessor/build.rs renamed to build.rs

@@ -1,8 +1,7 @@
+#[cfg(feature = "genproto")]
 extern crate prost_build;
-
-use std::fs::File;
-use std::path::Path;
-use std::{env, fs};
+#[cfg(feature = "genproto")]
+use std::{env, fs, fs::File, path::Path};
 
 /// To generate updated proto objects:
 /// 1. Place `vss.proto` file in `src/proto/`

src/client.rs

@@ -0,0 +1,83 @@
+use std::error::Error;
+
+use ::prost::Message;
+use reqwest;
+use reqwest::Client;
+
+use crate::vss::{
+	GetObjectRequest, GetObjectResponse, ListKeyVersionsRequest, ListKeyVersionsResponse, PutObjectRequest,
+	PutObjectResponse,
+};
+use crate::error::VssError;
+
+/// Thin-client to access a hosted instance of Versioned Storage Service (VSS).
+/// The provided [`VssClient`] API is minimalistic and is congruent to the VSS server-side API.
+pub struct VssClient {
+	base_url: String,
+	client: Client,
+}
+
+impl VssClient {
+	/// Constructs a [`VssClient`] using `base_url` as the VSS server endpoint.
+	pub fn new(base_url: &str) -> Self {
+		let client = Client::new();
+		Self { base_url: String::from(base_url), client }
+	}
+
+	/// Fetches a value against a given `key` in `request`.
+	/// Makes a service call to the `GetObject` endpoint of the VSS server.
+	/// For API contract/usage, refer to docs for [`GetObjectRequest`] and [`GetObjectResponse`].
+	pub async fn get_object(&self, request: &GetObjectRequest) -> Result<GetObjectResponse, VssError> {
+		let url = format!("{}/getObject", self.base_url);
+
+		let raw_response = self.client.post(url).body(request.encode_to_vec()).send().await?;
+		let status = raw_response.status();
+		let payload = raw_response.bytes().await?;
+
+		if status.is_success() {
+			let response = GetObjectResponse::decode(&payload[..])?;
+			Ok(response)
+		} else {
+			Err(VssError::new(status, payload))
+		}
+	}
+
+	/// Writes multiple [`PutObjectRequest::transaction_items`] as part of a single transaction.
+	/// Makes a service call to the `PutObject` endpoint of the VSS server, with multiple items.
+	/// Items in the `request` are written in a single all-or-nothing transaction.
+	/// For API contract/usage, refer to docs for [`PutObjectRequest`] and [`PutObjectResponse`].
+	pub async fn put_object(&self, request: &PutObjectRequest) -> Result<PutObjectResponse, VssError> {
+		let url = format!("{}/putObjects", self.base_url);
+
+		let response_raw = self.client.post(url).body(request.encode_to_vec()).send().await?;
+		let status = response_raw.status();
+		let payload = response_raw.bytes().await?;
+
+		if status.is_success() {
+			let response = PutObjectResponse::decode(&payload[..])?;
+			Ok(response)
+		} else {
+			Err(VssError::new(status, payload))
+		}
+	}
+
+	/// Lists keys and their corresponding version for a given [`ListKeyVersionsRequest::store_id`].
+	/// Makes a service call to the `ListKeyVersions` endpoint of the VSS server.
+	/// For API contract/usage, refer to docs for [`ListKeyVersionsRequest`] and [`ListKeyVersionsResponse`].
+	pub async fn list_key_versions(
+		&self, request: &ListKeyVersionsRequest,
+	) -> Result<ListKeyVersionsResponse, VssError> {
+		let url = format!("{}/listKeyVersions", self.base_url);
+
+		let response_raw = self.client.post(url).body(request.encode_to_vec()).send().await?;
+		let status = response_raw.status();
+		let payload = response_raw.bytes().await?;
+
+		if status.is_success() {
+			let response = ListKeyVersionsResponse::decode(&payload[..])?;
+			Ok(response)
+		} else {
+			Err(VssError::new(status, payload))
+		}
+	}
+}

src/error.rs

@@ -0,0 +1,78 @@
+use crate::vss::{ErrorCode, ErrorResponse};
+use prost::bytes::Bytes;
+use prost::{DecodeError, Message};
+use reqwest::StatusCode;
+use std::error::Error;
+use std::fmt::{Display, Formatter};
+
+/// When there is an error while writing to VSS storage, the response contains a relevant error code.
+/// A mapping from a VSS server error codes. Refer to [`ErrorResponse`] docs for more
+/// information regarding each error code and corresponding use-cases.
+#[derive(Debug)]
+pub enum VssError {
+	InvalidRequestError(String),
+	ConflictError(String),
+	InternalServerError(String),
+	InternalError(String),
+}
+
+impl VssError {
+	/// Create new instance of `VssError`
+	pub fn new(status: StatusCode, payload: Bytes) -> VssError {
+		match ErrorResponse::decode(&payload[..]) {
+			Ok(error_response) => VssError::from(error_response),
+			Err(e) => {
+				let message =
+					format!("Unable to decode ErrorResponse from server, HttpStatusCode: {}, DecodeErr: {}", status, e);
+				VssError::InternalError(message)
+			}
+		}
+	}
+}
+
+impl Display for VssError {
+	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+		match self {
+			VssError::InvalidRequestError(message) => {
+				write!(f, "Request sent to VSS Storage was invalid: {}", message)
+			}
+			VssError::ConflictError(message) => {
+				write!(f, "Potential version conflict in write operation: {}", message)
+			}
+			VssError::InternalServerError(message) => {
+				write!(f, "InternalServerError: {}", message)
+			}
+			VssError::InternalError(message) => {
+				write!(f, "InternalError: {}", message)
+			}
+		}
+	}
+}
+
+impl Error for VssError {}
+
+impl From<ErrorResponse> for VssError {
+	fn from(error_response: ErrorResponse) -> Self {
+		match error_response.error_code() {
+			ErrorCode::InvalidRequestException => VssError::InvalidRequestError(error_response.message),
+			ErrorCode::ConflictException => VssError::ConflictError(error_response.message),
+			ErrorCode::InternalServerException => VssError::InternalServerError(error_response.message),
+			_ => VssError::InternalError(format!(
+				"VSS responded with an unknown error code: {}, message: {}",
+				error_response.error_code, error_response.message
+			)),
+		}
+	}
+}
+
+impl From<DecodeError> for VssError {
+	fn from(err: DecodeError) -> Self {
+		VssError::InternalError(err.to_string())
+	}
+}
+
+impl From<reqwest::Error> for VssError {
+	fn from(err: reqwest::Error) -> Self {
+		VssError::InternalError(err.to_string())
+	}
+}

vss-accessor/src/generated-src/org.vss.rs renamed to src/generated-src/org.vss.rs

@@ -0,0 +1,10 @@
+#![deny(rustdoc::broken_intra_doc_links)]
+#![deny(rustdoc::private_intra_doc_links)]
+
+mod client;
+mod error;
+
+/// Import auto-generated objects from protobuf specification of VSS
+pub mod vss {
+	include!("generated-src/org.vss.rs");
+}