Page MenuHomePhabricator
Differential D6792

[keyserver] Removing `.gitignore` from rust-node-addon
ClosedPublic
Actions

Authored by • max on Feb 20 2023, 3:52 PM.
Tags
None
Referenced Files
F6179172: D6792.diff
Wed, Apr 23, 5:00 AM
Unknown Object (File)
Thu, Apr 17, 12:18 PM
Unknown Object (File)
Thu, Apr 17, 12:18 PM
Unknown Object (File)
Thu, Apr 17, 11:02 AM
Unknown Object (File)
Thu, Apr 17, 4:31 AM
Unknown Object (File)
Wed, Apr 16, 8:04 PM
Unknown Object (File)
Wed, Apr 16, 9:08 AM
Unknown Object (File)
Sat, Apr 12, 6:00 PM
View All Files
Subscribers
ashoat
atul
tomek

Details

Reviewers
varun
• jon
tomek
ashoat
Commits
rCOMMf1bc99677895: [keyserver] Removing `.gitignore` from rust-node-addon
Summary

This diff removes .gitignore file from the rust-node-addon and adds ignoring directories to the global .gitignore file at the root of the project. It makes sense to use a root gitignore file to ignore these two directories.

Linear task: ENG-3048

Test Plan

Running yarn clieaninstall will build the rust-node-addon as a dependency. The building process produces files in the target and napi subdirectories which are ignored.

Diff Detail

Repository
rCOMM Comm
Branch
remove-gitingore
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

• max created this revision.Feb 20 2023, 3:52 PM
• max held this revision as a draft.
Herald added subscribers: atul, tomek, ashoat. · View Herald TranscriptFeb 20 2023, 3:52 PM
• max published this revision for review.Feb 20 2023, 3:57 PM
• max edited the summary of this revision. (Show Details)
• max edited the test plan for this revision. (Show Details)
• max added reviewers: varun, • jon, tomek.
• max added a parent revision: D6791: [keyserver] Removing from the rust-node-addon gitignore and populate it.
• max retitled this revision from [keyserver] Removing in rust-node-addon to [keyserver] Removing `.gitignore` in rust-node-addon.
Harbormaster completed remote builds in B16649: Diff 22776.Feb 20 2023, 4:07 PM
• jon accepted this revision.Feb 20 2023, 6:08 PM
varun accepted this revision.Feb 20 2023, 8:50 PM

i actually prefer having separate .gitignore files at the cargo project level but it’s not a strong opinion. just think it makes the files more readable. also we already have other .gitignore files in the repo I think

This revision is now accepted and ready to land.Feb 20 2023, 8:50 PM
• max added a comment.Feb 21 2023, 5:52 AM
In D6792#202240, @varun wrote:

i actually prefer having separate .gitignore files at the cargo project level but it’s not a strong opinion. just think it makes the files more readable. also we already have other .gitignore files in the repo I think

I'm not insisting to remove this gitignore as well, but from my perspective, we should use the project root and second-level (keyserver's) gitignoring as preferred. cc to @ashoat for a final decision.

• max added a reviewer: ashoat.Feb 21 2023, 5:52 AM
This revision now requires review to proceed.Feb 21 2023, 5:52 AM
• max retitled this revision from [keyserver] Removing `.gitignore` in rust-node-addon to [keyserver] Removing `.gitignore` from rust-node-addon.Feb 21 2023, 6:08 AM
• max edited the summary of this revision. (Show Details)
ashoat accepted this revision.Feb 21 2023, 6:18 AM

I don't have an opinion

This revision is now accepted and ready to land.Feb 21 2023, 6:18 AM
Closed by commit rCOMMf1bc99677895: [keyserver] Removing `.gitignore` from rust-node-addon (authored by • max). · Explain WhyFeb 21 2023, 6:46 AM
This revision was automatically updated to reflect the committed changes.
• max added a commit: rCOMMf1bc99677895: [keyserver] Removing `.gitignore` from rust-node-addon.

Revision Contents
Changeset List

PathSize
2 lines
keyserver/
addons/
rust-node-addon/

Diff 22776

View Options

.gitignore

use derive_more::{Display, Error, From}; use derive_more::{Display, Error, From};
use futures_core::Stream; use futures_core::Stream;
use futures_util::StreamExt; use futures_util::{StreamExt, TryStreamExt};
use reqwest::Url; use reqwest::{
multipart::{Form, Part},
Body, Url,
};
use tracing::{debug, trace, warn}; use tracing::{debug, trace, warn};
// publicly re-export some reqwest types // publicly re-export some reqwest types
pub use reqwest::Error as ReqwestError; pub use reqwest::Error as ReqwestError;
pub use reqwest::StatusCode; pub use reqwest::StatusCode;
#[derive(From, Error, Debug, Display)] #[derive(From, Error, Debug, Display)]
pub enum BlobServiceError { pub enum BlobServiceError {
▲ Show 20 Lines • Show All 91 Lines • ▼ Show 20 Lines ) -> BlobResult<impl Stream<Item = BlobResult<Vec<u8>>>> {
} }
let error = handle_http_error(response.status()); let error = handle_http_error(response.status());
if let Ok(message) = response.text().await { if let Ok(message) = response.text().await {
trace!("Error response message: {}", message); trace!("Error response message: {}", message);
} }
Err(error) Err(error)
} }
/// Uploads a blob. Returns `BlobServiceError::AlreadyExists` if blob with given hash
/// already exists.
///
/// # Example
/// ```rust
/// use std::io::{Error, ErrorKind};
///
/// let client =
/// BlobServiceClient::new("http://localhost:50053".parse()?);
///
/// let stream = async_stream::stream! {
/// yield Ok(vec![1, 2, 3]);
/// yield Ok(vec![4, 5, 6]);
/// yield Err(Error::new(ErrorKind::Other, "Oops"));
/// };
/// client.upload_blob(&blob_hash, stream).await?;
/// ```
pub async fn upload_blob<H, S>(
&self,
blob_hash: H,
data_stream: S,
) -> BlobResult<()>
where
H: Into<String>,
S: futures_core::stream::TryStream + Send + Sync + 'static,
S::Error: Into<Box<dyn std::error::Error + Send + Sync>>,
Vec<u8>: From<S::Ok>,
bartekAuthorUnsubmitted
Done
Inline Actions

Requirements of the reqwest body stream:
A stream of Result<impl Into<Vec<u8>>, impl Into<Box<dyn Error>>>

bartek: Requirements of the reqwest body stream: A stream of `Result<impl Into<Vec<u8>>, impl…
{
debug!("Revoke holder request");
michalUnsubmitted
Not Done
Inline Actions

Wrong message?

michal: Wrong message?
let url = self.get_blob_url(None)?;
let stream = data_stream.map_ok(Vec::from);
let streaming_body = Body::wrap_stream(stream);
let form = Form::new()
.text("blob_hash", blob_hash.into())
.part("blob_data", Part::stream(streaming_body));
let response = self.http_client.put(url).multipart(form).send().await?;
debug!("Response status: {}", response.status());
if response.status().is_success() {
trace!("Blob upload successful");
return Ok(());
}
let error = handle_http_error(response.status());
if let Ok(message) = response.text().await {
trace!("Error response message: {}", message);
}
Err(error)
}
} }
// private helper methods // private helper methods
impl BlobServiceClient { impl BlobServiceClient {
fn get_blob_url( fn get_blob_url(
&self, &self,
blob_hash: Option<&str>, blob_hash: Option<&str>,
) -> Result<Url, BlobServiceError> { ) -> Result<Url, BlobServiceError> {
Show All 24 Lines
View Options

keyserver/addons/rust-node-addon/.gitignore

use derive_more::{Display, Error, From}; use derive_more::{Display, Error, From};
use futures_core::Stream; use futures_core::Stream;
use futures_util::StreamExt; use futures_util::{StreamExt, TryStreamExt};
use reqwest::Url; use reqwest::{
multipart::{Form, Part},
Body, Url,
};
use tracing::{debug, trace, warn}; use tracing::{debug, trace, warn};
// publicly re-export some reqwest types // publicly re-export some reqwest types
pub use reqwest::Error as ReqwestError; pub use reqwest::Error as ReqwestError;
pub use reqwest::StatusCode; pub use reqwest::StatusCode;
#[derive(From, Error, Debug, Display)] #[derive(From, Error, Debug, Display)]
pub enum BlobServiceError { pub enum BlobServiceError {
▲ Show 20 Lines • Show All 91 Lines • ▼ Show 20 Lines ) -> BlobResult<impl Stream<Item = BlobResult<Vec<u8>>>> {
} }
let error = handle_http_error(response.status()); let error = handle_http_error(response.status());
if let Ok(message) = response.text().await { if let Ok(message) = response.text().await {
trace!("Error response message: {}", message); trace!("Error response message: {}", message);
} }
Err(error) Err(error)
} }
/// Uploads a blob. Returns `BlobServiceError::AlreadyExists` if blob with given hash
/// already exists.
///
/// # Example
/// ```rust
/// use std::io::{Error, ErrorKind};
///
/// let client =
/// BlobServiceClient::new("http://localhost:50053".parse()?);
///
/// let stream = async_stream::stream! {
/// yield Ok(vec![1, 2, 3]);
/// yield Ok(vec![4, 5, 6]);
/// yield Err(Error::new(ErrorKind::Other, "Oops"));
/// };
/// client.upload_blob(&blob_hash, stream).await?;
/// ```
pub async fn upload_blob<H, S>(
&self,
blob_hash: H,
data_stream: S,
) -> BlobResult<()>
where
H: Into<String>,
S: futures_core::stream::TryStream + Send + Sync + 'static,
S::Error: Into<Box<dyn std::error::Error + Send + Sync>>,
Vec<u8>: From<S::Ok>,
bartekAuthorUnsubmitted
Done
Inline Actions

Requirements of the reqwest body stream:
A stream of Result<impl Into<Vec<u8>>, impl Into<Box<dyn Error>>>

bartek: Requirements of the reqwest body stream: A stream of `Result<impl Into<Vec<u8>>, impl…
{
debug!("Revoke holder request");
michalUnsubmitted
Not Done
Inline Actions

Wrong message?

michal: Wrong message?
let url = self.get_blob_url(None)?;
let stream = data_stream.map_ok(Vec::from);
let streaming_body = Body::wrap_stream(stream);
let form = Form::new()
.text("blob_hash", blob_hash.into())
.part("blob_data", Part::stream(streaming_body));
let response = self.http_client.put(url).multipart(form).send().await?;
debug!("Response status: {}", response.status());
if response.status().is_success() {
trace!("Blob upload successful");
return Ok(());
}
let error = handle_http_error(response.status());
if let Ok(message) = response.text().await {
trace!("Error response message: {}", message);
}
Err(error)
}
} }
// private helper methods // private helper methods
impl BlobServiceClient { impl BlobServiceClient {
fn get_blob_url( fn get_blob_url(
&self, &self,
blob_hash: Option<&str>, blob_hash: Option<&str>,
) -> Result<Url, BlobServiceError> { ) -> Result<Url, BlobServiceError> {
Show All 24 Lines