rust/lettre
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #439 from paolobarbolini/async-01

Browse Source 
Refactor async-std support to prepare for more async runtimes
This commit is contained in:
Alexis Mousset
2020-07-26 14:44:44 +02:00
committed by GitHub
parent b3ad137691 213fe1dc4e
commit 598abcc589
9 changed files with 104 additions and 126 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/test.yml vendored
View File

@@ -38,7 +38,7 @@ jobs:
- uses: actions-rs/cargo@v1
with:
command: test
args: --features=async
args: --features=async-std1
check:
name: Check

5
Cargo.toml
View File

@@ -53,7 +53,7 @@ harness = false
name = "transport_smtp"
[features]
async = ["async-std", "async-trait", "async-attributes"]
async-std1 = ["async-std", "async-trait", "async-attributes"]
builder = ["mime", "base64", "hyperx", "rand", "quoted_printable"]
default = ["file-transport", "smtp-transport", "native-tls", "hostname", "r2d2", "sendmail-transport", "builder"]
file-transport = ["serde", "serde_json"]
@@ -62,6 +62,9 @@ sendmail-transport = []
smtp-transport = ["bufstream", "base64", "nom"]
unstable = []
[package.metadata.docs.rs]
features = ["async-std1"]
[[example]]
name = "smtp"
required-features = ["smtp-transport"]

43
src/lib.rs
View File

@@ -55,6 +55,8 @@ pub use crate::transport::smtp::r2d2::SmtpConnectionManager;
#[cfg(feature = "smtp-transport")]
pub use crate::transport::smtp::{SmtpTransport, Tls};
pub use crate::{address::Address, transport::stub::StubTransport};
#[cfg(feature = "async-std1")]
use async_trait::async_trait;
#[cfg(feature = "builder")]
use std::convert::TryFrom;
use std::{error::Error as StdError, fmt};
@@ -151,33 +153,24 @@ pub trait Transport {
fn send_raw(&self, envelope: &Envelope, email: &[u8]) -> Result<Self::Ok, Self::Error>;
}
#[cfg(feature = "async")]
pub mod r#async {
/// Async Transport method for emails
#[cfg(feature = "async-std1")]
#[async_trait]
pub trait AsyncStd1Transport {
/// Result types for the transport
type Ok: fmt::Debug;
type Error: StdError;
use super::*;
use async_trait::async_trait;
#[async_trait]
pub trait Transport {
/// Result types for the transport
type Ok: fmt::Debug;
type Error: StdError;
/// Sends the email
#[cfg(feature = "builder")]
// TODO take &Message
async fn send(&self, message: Message) -> Result<Self::Ok, Self::Error> {
let raw = message.formatted();
let envelope = message.envelope();
self.send_raw(&envelope, &raw).await
}
async fn send_raw(
&self,
envelope: &Envelope,
email: &[u8],
) -> Result<Self::Ok, Self::Error>;
/// Sends the email
#[cfg(feature = "builder")]
// TODO take &Message
async fn send(&self, message: Message) -> Result<Self::Ok, Self::Error> {
let raw = message.formatted();
let envelope = message.envelope();
self.send_raw(&envelope, &raw).await
}
async fn send_raw(&self, envelope: &Envelope, email: &[u8]) -> Result<Self::Ok, Self::Error>;
}
#[cfg(test)]

84
src/transport/file/mod.rs
View File

@@ -35,10 +35,12 @@
//! TODO
//! ```
#[cfg(feature = "async-std1")]
use crate::AsyncStd1Transport;
use crate::{transport::file::error::Error, Envelope, Transport};
#[cfg(feature = "async-std1")]
use async_trait::async_trait;
use std::{
fs::File,
io::prelude::*,
path::{Path, PathBuf},
str,
};
@@ -72,11 +74,12 @@ struct SerializableEmail<'a> {
message: Option<&'a str>,
}
impl Transport for FileTransport {
type Ok = Id;
type Error = Error;
fn send_raw(&self, envelope: &Envelope, email: &[u8]) -> Result<Self::Ok, Self::Error> {
impl FileTransport {
fn send_raw_impl(
&self,
envelope: &Envelope,
email: &[u8],
) -> Result<(Uuid, PathBuf, String), serde_json::Error> {
let email_id = Uuid::new_v4();
let file = self.path.join(format!("{}.json", email_id));
@@ -94,51 +97,40 @@ impl Transport for FileTransport {
}),
}?;
File::create(file.as_path())?.write_all(serialized.as_bytes())?;
Ok((email_id, file, serialized))
}
}
impl Transport for FileTransport {
type Ok = Id;
type Error = Error;
fn send_raw(&self, envelope: &Envelope, email: &[u8]) -> Result<Self::Ok, Self::Error> {
use std::fs::File;
use std::io::Write;
let (email_id, file, serialized) = self.send_raw_impl(envelope, email)?;
let mut file = File::create(file)?;
file.write_all(serialized.as_bytes())?;
Ok(email_id.to_string())
}
}
#[cfg(feature = "async")]
pub mod r#async {
use super::{FileTransport, Id, SerializableEmail};
use crate::{r#async::Transport, transport::file::error::Error, Envelope};
use async_std::fs::File;
use async_std::prelude::*;
use async_trait::async_trait;
use std::str;
use uuid::Uuid;
#[cfg(feature = "async-std1")]
#[async_trait]
impl AsyncStd1Transport for FileTransport {
type Ok = Id;
type Error = Error;
#[async_trait]
impl Transport for FileTransport {
type Ok = Id;
type Error = Error;
async fn send_raw(&self, envelope: &Envelope, email: &[u8]) -> Result<Self::Ok, Self::Error> {
use async_std::fs::File;
use async_std::io::prelude::WriteExt;
async fn send_raw(
&self,
envelope: &Envelope,
email: &[u8],
) -> Result<Self::Ok, Self::Error> {
let email_id = Uuid::new_v4();
let file = self.path.join(format!("{}.json", email_id));
let (email_id, file, serialized) = self.send_raw_impl(envelope, email)?;
let serialized = match str::from_utf8(email) {
// Serialize as UTF-8 string if possible
Ok(m) => serde_json::to_string(&SerializableEmail {
envelope: envelope.clone(),
message: Some(m),
raw_message: None,
}),
Err(_) => serde_json::to_string(&SerializableEmail {
envelope: envelope.clone(),
message: None,
raw_message: Some(email),
}),
}?;
let mut file = File::create(file.as_path()).await?;
file.write_all(serialized.as_bytes()).await?;
Ok(email_id.to_string())
}
let mut file = File::create(file).await?;
file.write_all(serialized.as_bytes()).await?;
Ok(email_id.to_string())
}
}

53
src/transport/sendmail/mod.rs
View File

@@ -23,7 +23,11 @@
//! # }
//! ```
#[cfg(feature = "async-std1")]
use crate::AsyncStd1Transport;
use crate::{transport::sendmail::error::Error, Envelope, Transport};
#[cfg(feature = "async-std1")]
use async_trait::async_trait;
use std::{
convert::AsRef,
ffi::OsString,
@@ -88,41 +92,30 @@ impl Transport for SendmailTransport {
}
}
#[cfg(feature = "async")]
pub mod r#async {
use super::SendmailTransport;
use crate::{r#async::Transport, transport::sendmail::error::Error, Envelope};
use async_trait::async_trait;
use std::io::Write;
#[cfg(feature = "async-std1")]
#[async_trait]
impl AsyncStd1Transport for SendmailTransport {
type Ok = ();
type Error = Error;
#[async_trait]
impl Transport for SendmailTransport {
type Ok = ();
type Error = Error;
async fn send_raw(&self, envelope: &Envelope, email: &[u8]) -> Result<Self::Ok, Self::Error> {
let mut command = self.command(envelope);
let email = email.to_vec();
// TODO: Convert to real async, once async-std has a process implementation.
async fn send_raw(
&self,
envelope: &Envelope,
email: &[u8],
) -> Result<Self::Ok, Self::Error> {
let mut command = self.command(envelope);
let email = email.to_vec();
let output = async_std::task::spawn_blocking(move || {
// Spawn the sendmail command
let mut process = command.spawn()?;
let output = async_std::task::spawn_blocking(move || {
// Spawn the sendmail command
let mut process = command.spawn()?;
process.stdin.as_mut().unwrap().write_all(&email)?;
process.wait_with_output()
})
.await?;
process.stdin.as_mut().unwrap().write_all(&email)?;
process.wait_with_output()
})
.await?;
if output.status.success() {
Ok(())
} else {
Err(Error::Client(String::from_utf8(output.stderr)?))
}
if output.status.success() {
Ok(())
} else {
Err(Error::Client(String::from_utf8(output.stderr)?))
}
}
}

28
src/transport/stub/mod.rs
View File

@@ -22,7 +22,11 @@
//! assert!(result.is_ok());
//! ```
#[cfg(feature = "async-std1")]
use crate::AsyncStd1Transport;
use crate::{Envelope, Transport};
#[cfg(feature = "async-std1")]
use async_trait::async_trait;
use std::{error::Error as StdError, fmt};
#[derive(Debug, Copy, Clone)]
@@ -74,23 +78,13 @@ impl Transport for StubTransport {
}
}
#[cfg(feature = "async")]
pub mod r#async {
use super::StubTransport;
use crate::{r#async::Transport, transport::stub::Error, Envelope};
use async_trait::async_trait;
#[cfg(feature = "async-std1")]
#[async_trait]
impl AsyncStd1Transport for StubTransport {
type Ok = ();
type Error = Error;
#[async_trait]
impl Transport for StubTransport {
type Ok = ();
type Error = Error;
async fn send_raw(
&self,
_envelope: &Envelope,
_email: &[u8],
) -> Result<Self::Ok, Self::Error> {
self.response
}
async fn send_raw(&self, _envelope: &Envelope, _email: &[u8]) -> Result<Self::Ok, Self::Error> {
self.response
}
}

5
tests/transport_file.rs
View File

@@ -35,10 +35,11 @@ mod test {
remove_file(file).unwrap();
}
#[cfg(feature = "async")]
#[cfg(feature = "async-std1")]
#[async_attributes::test]
async fn file_transport_async() {
use lettre::r#async::Transport;
use lettre::AsyncStd1Transport;
let sender = FileTransport::new(temp_dir());
let email = Message::builder()
.from("NoBody <nobody@domain.tld>".parse().unwrap())

5
tests/transport_sendmail.rs
View File

@@ -20,10 +20,11 @@ mod test {
assert!(result.is_ok());
}
#[cfg(feature = "async")]
#[cfg(feature = "async-std1")]
#[async_attributes::test]
async fn sendmail_transport_async() {
use lettre::r#async::Transport;
use lettre::AsyncStd1Transport;
let sender = SendmailTransport::new();
let email = Message::builder()
.from("NoBody <nobody@domain.tld>".parse().unwrap())

5
tests/transport_stub.rs
View File

@@ -17,10 +17,11 @@ fn stub_transport() {
sender_ko.send(&email).unwrap_err();
}
#[cfg(feature = "async")]
#[cfg(feature = "async-std1")]
#[async_attributes::test]
async fn stub_transport_async() {
use lettre::r#async::Transport;
use lettre::AsyncStd1Transport;
let sender_ok = StubTransport::new_ok();
let sender_ko = StubTransport::new_error();
let email = Message::builder()