Signed-off-by: Francesco Guardiani <francescoguard@gmail.com>
This commit is contained in:
slinkydeveloper 2021-04-29 14:39:12 +02:00 committed by Francesco Guardiani
parent 589db8e5be
commit ee7d5f779a
15 changed files with 202 additions and 138 deletions

View File

@ -67,6 +67,22 @@ jobs:
toolchain: ${{ matrix.toolchain }}
args: --target ${{ matrix.target }} --all-features
# If glibc, compile and test only the core module with no_std
- uses: actions-rs/cargo@v1
name: "Build"
if: matrix.target == 'x86_64-unknown-linux-gnu'
with:
command: build
toolchain: ${{ matrix.toolchain }}
args: --target ${{ matrix.target }} --package cloudevents-sdk --workspace --no-default-features
- uses: actions-rs/cargo@v1
name: "Test"
if: matrix.target == 'x86_64-unknown-linux-gnu'
with:
command: test
toolchain: ${{ matrix.toolchain }}
args: --target ${{ matrix.target }} --package cloudevents-sdk --workspace --no-default-features
# If musl, compile and test all
- uses: actions-rs/cargo@v1
name: "Build"

View File

@ -11,7 +11,7 @@ repository = "https://github.com/cloudevents/sdk-rust"
exclude = [
".github/*"
]
categories = ["web-programming", "encoding", "data-structures"]
categories = ["web-programming", "encoding", "data-structures", "no_std"]
[lib]
name = "cloudevents"
@ -28,9 +28,15 @@ serde_json = "^1.0"
chrono = { version = "^0.4", features = ["serde"] }
delegate-attr = "^0.2"
base64 = "^0.12"
url = { version = "^2.1", features = ["serde"] }
snafu = "^0.6"
snafu = { version = "^0.6", default-features = false}
bitflags = "^1.2"
url = { version = "^2.1", features = ["serde"], optional = true }
[features]
# Without default features, the package acts as no_std
default = ["std"]
std = ["snafu/std", "url"]
# runtime optional deps
actix-web = { version = "^3", default-features = false, optional = true }
@ -49,7 +55,7 @@ hostname = "^0.3"
uuid = { version = "^0.8", features = ["v4"] }
[target.'cfg(target_arch = "wasm32")'.dependencies]
web-sys = { version = "^0.3", features = ["Window", "Location"] }
web-sys = { version = "^0.3", default-features = false, features = ["Window", "Location"] }
uuid = { version = "^0.8", features = ["v4", "wasm-bindgen"] }
[dev-dependencies]

View File

@ -1,11 +1,11 @@
use super::{
AttributesIntoIteratorV03, AttributesIntoIteratorV10, AttributesV03, AttributesV10,
ExtensionValue, SpecVersion, UriReference,
ExtensionValue, SpecVersion,
types::*
};
use chrono::{DateTime, Utc};
use serde::Serializer;
use std::fmt;
use url::Url;
/// Enum representing a borrowed value of a CloudEvent attribute.
/// This represents the types defined in the [CloudEvent spec type system](https://github.com/cloudevents/spec/blob/v1.0/spec.md#type-system)
@ -13,7 +13,7 @@ use url::Url;
pub enum AttributeValue<'a> {
SpecVersion(SpecVersion),
String(&'a str),
URI(&'a Url),
URI(&'a Uri),
URIRef(&'a UriReference),
Boolean(&'a bool),
Integer(&'a i64),
@ -57,7 +57,7 @@ pub trait AttributesReader {
/// Get the [datacontenttype](https://github.com/cloudevents/spec/blob/master/spec.md#datacontenttype).
fn datacontenttype(&self) -> Option<&str>;
/// Get the [dataschema](https://github.com/cloudevents/spec/blob/master/spec.md#dataschema).
fn dataschema(&self) -> Option<&Url>;
fn dataschema(&self) -> Option<&Uri>;
/// Get the [subject](https://github.com/cloudevents/spec/blob/master/spec.md#subject).
fn subject(&self) -> Option<&str>;
/// Get the [time](https://github.com/cloudevents/spec/blob/master/spec.md#time).
@ -87,7 +87,7 @@ pub trait AttributesWriter {
-> Option<String>;
/// Set the [dataschema](https://github.com/cloudevents/spec/blob/master/spec.md#dataschema).
/// Returns the previous value.
fn set_dataschema(&mut self, dataschema: Option<impl Into<Url>>) -> Option<Url>;
fn set_dataschema(&mut self, dataschema: Option<impl Into<Uri>>) -> Option<Uri>;
}
pub(crate) trait AttributesConverter {
@ -154,7 +154,7 @@ impl AttributesReader for Attributes {
}
}
fn dataschema(&self) -> Option<&Url> {
fn dataschema(&self) -> Option<&Uri> {
match self {
Attributes::V03(a) => a.dataschema(),
Attributes::V10(a) => a.dataschema(),
@ -222,7 +222,7 @@ impl AttributesWriter for Attributes {
}
}
fn set_dataschema(&mut self, dataschema: Option<impl Into<Url>>) -> Option<Url> {
fn set_dataschema(&mut self, dataschema: Option<impl Into<Uri>>) -> Option<Uri> {
match self {
Attributes::V03(a) => a.set_dataschema(dataschema),
Attributes::V10(a) => a.set_dataschema(dataschema),
@ -253,8 +253,7 @@ impl Attributes {
}
#[cfg(not(target_arch = "wasm32"))]
pub(crate) fn default_hostname() -> Url {
Url::parse(
pub(crate) fn default_hostname() -> Uri {
format!(
"http://{}",
hostname::get()
@ -263,21 +262,18 @@ pub(crate) fn default_hostname() -> Url {
.flatten()
.unwrap_or_else(|| "localhost".to_string())
)
.as_ref(),
)
.into_uri()
.unwrap()
}
#[cfg(target_arch = "wasm32")]
pub(crate) fn default_hostname() -> Url {
pub(crate) fn default_hostname() -> Uri {
use std::str::FromStr;
Url::from_str(
web_sys::window()
.map(|w| w.location().host().ok())
.flatten()
.unwrap_or(String::from("http://localhost"))
.as_str(),
)
.into_uri()
.unwrap()
}

View File

@ -1,11 +1,11 @@
use super::Event;
use snafu::Snafu;
use super::Event;
use super::types;
/// Trait to implement a builder for [`Event`]:
/// ```
/// use cloudevents::event::{EventBuilderV10, EventBuilder};
/// use chrono::Utc;
/// use url::Url;
///
/// let event = EventBuilderV10::new()
/// .id("my_event.my_application")
@ -48,9 +48,9 @@ pub enum Error {
attribute_name,
source
))]
ParseUrlError {
ParseUriError {
attribute_name: &'static str,
source: url::ParseError,
source: types::ParseUriError,
},
#[snafu(display(
"Invalid value setting attribute '{}' with uriref type",

View File

@ -8,7 +8,7 @@ mod extensions;
mod format;
mod message;
mod spec_version;
mod types;
pub mod types;
pub use attributes::Attributes;
pub use attributes::{AttributeValue, AttributesReader, AttributesWriter};
@ -20,7 +20,6 @@ pub(crate) use message::EventBinarySerializer;
pub(crate) use message::EventStructuredSerializer;
pub use spec_version::SpecVersion;
pub use spec_version::UnknownSpecVersion;
pub use types::{TryIntoTime, TryIntoUrl, UriReference};
mod v03;
@ -38,11 +37,10 @@ pub use v10::EventBuilder as EventBuilderV10;
pub(crate) use v10::EventFormatDeserializer as EventFormatDeserializerV10;
pub(crate) use v10::EventFormatSerializer as EventFormatSerializerV10;
use chrono::{DateTime, Utc};
use delegate_attr::delegate;
use std::collections::HashMap;
use std::fmt;
use url::Url;
use types::*;
/// Data structure that represents a [CloudEvent](https://github.com/cloudevents/spec/blob/master/spec.md).
/// It provides methods to get the attributes through [`AttributesReader`]
@ -89,7 +87,7 @@ impl AttributesReader for Event {
fn specversion(&self) -> SpecVersion;
fn ty(&self) -> &str;
fn datacontenttype(&self) -> Option<&str>;
fn dataschema(&self) -> Option<&Url>;
fn dataschema(&self) -> Option<&Uri>;
fn subject(&self) -> Option<&str>;
fn time(&self) -> Option<&DateTime<Utc>>;
}
@ -103,7 +101,7 @@ impl AttributesWriter for Event {
fn set_time(&mut self, time: Option<impl Into<DateTime<Utc>>>) -> Option<DateTime<Utc>>;
fn set_datacontenttype(&mut self, datacontenttype: Option<impl Into<String>>)
-> Option<String>;
fn set_dataschema(&mut self, dataschema: Option<impl Into<Url>>) -> Option<Url>;
fn set_dataschema(&mut self, dataschema: Option<impl Into<Uri>>) -> Option<Uri>;
}
impl Default for Event {
@ -165,10 +163,10 @@ impl Event {
///
/// let (datacontenttype, dataschema, data) = e.take_data();
/// ```
pub fn take_data(&mut self) -> (Option<String>, Option<Url>, Option<Data>) {
pub fn take_data(&mut self) -> (Option<String>, Option<Uri>, Option<Data>) {
(
self.attributes.set_datacontenttype(None as Option<String>),
self.attributes.set_dataschema(None as Option<Url>),
self.attributes.set_dataschema(None as Option<Uri>),
self.data.take(),
)
}

View File

@ -1,60 +1,108 @@
use chrono::{DateTime, Utc};
use url::Url;
pub use self::uri::Uri;
pub use self::uri::ParseUriError;
pub use self::uri::TryIntoUri;
/// Trait to define conversion to [`Url`]
pub trait TryIntoUrl {
fn into_url(self) -> Result<Url, url::ParseError>;
}
pub use urireference::UriReference;
impl TryIntoUrl for Url {
fn into_url(self) -> Result<Url, url::ParseError> {
pub use chrono::{DateTime, Utc};
pub use time::TryIntoTime;
mod uri {
#[cfg(feature = "std")]
pub use url::Url as Uri;
#[cfg(not(feature = "std"))]
pub use String as Uri;
#[cfg(feature = "std")]
pub use url::ParseError as ParseUriError;
#[cfg(not(feature = "std"))]
pub use None as ParseUriError;
/// Trait to define conversion to [`Uri`]
pub trait TryIntoUri {
fn into_uri(self) -> Result<Uri, ParseUriError>;
}
#[cfg(feature = "std")]
impl TryIntoUri for Uri {
fn into_uri(self) -> Result<Uri, ParseUriError> {
Ok(self)
}
}
}
impl TryIntoUrl for &str {
fn into_url(self) -> Result<Url, url::ParseError> {
Url::parse(self)
#[cfg(feature = "std")]
impl TryIntoUri for &str {
fn into_uri(self) -> Result<Uri, ParseUriError> {
url::Url::parse(self)
}
}
#[cfg(feature = "std")]
impl TryIntoUri for String {
fn into_uri(self) -> Result<Uri, ParseUriError> {
self.as_str().into_uri()
}
}
#[cfg(not(feature = "std"))]
impl TryIntoUri for Uri {
fn into_uri(self) -> Result<Uri, ParseUriError> {
Ok(self)
}
}
#[cfg(not(feature = "std"))]
impl TryIntoUri for &str {
fn into_uri(self) -> Result<Uri, ParseUriError> {
Ok(String::from(self))
}
}
#[cfg(not(feature = "std"))]
impl TryIntoUri for String {
fn into_uri(self) -> Result<Uri, ParseUriError> {
Ok(self)
}
}
}
impl TryIntoUrl for String {
fn into_url(self) -> Result<Url, url::ParseError> {
self.as_str().into_url()
}
mod urireference {
/// The URI-reference type.
///
/// The URI reference can be a URI, or just a relative path.
///
/// As the [`types::Url`] type can only represent an absolute URL, we are falling back to a string
/// here.
///
/// Also see:
/// * <https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#type-system>
/// * <https://tools.ietf.org/html/rfc3986#section-4.1>
pub type UriReference = String;
}
/// Trait to define conversion to [`DateTime`]
pub trait TryIntoTime {
mod time {
use chrono::{DateTime, Utc};
/// Trait to define conversion to [`DateTime`]
pub trait TryIntoTime {
fn into_time(self) -> Result<DateTime<Utc>, chrono::ParseError>;
}
}
impl TryIntoTime for DateTime<Utc> {
impl TryIntoTime for DateTime<Utc> {
fn into_time(self) -> Result<DateTime<Utc>, chrono::ParseError> {
Ok(self)
}
}
}
impl TryIntoTime for &str {
impl TryIntoTime for &str {
fn into_time(self) -> Result<DateTime<Utc>, chrono::ParseError> {
Ok(DateTime::<Utc>::from(DateTime::parse_from_rfc3339(self)?))
}
}
}
impl TryIntoTime for String {
impl TryIntoTime for String {
fn into_time(self) -> Result<DateTime<Utc>, chrono::ParseError> {
self.as_str().into_time()
}
}
}
/// The URI-reference type.
///
/// The URI reference can be a URI, or just a relative path.
///
/// As the [`url::Url`] type can only represent an absolute URL, we are falling back to a string
/// here.
///
/// Also see:
/// * <https://github.com/cloudevents/spec/blob/v1.0.1/spec.md#type-system>
/// * <https://tools.ietf.org/html/rfc3986#section-4.1>
pub type UriReference = String;

View File

@ -1,8 +1,7 @@
use crate::event::attributes::{default_hostname, AttributeValue, AttributesConverter};
use crate::event::{AttributesReader, AttributesV10, AttributesWriter, SpecVersion, UriReference};
use crate::event::{AttributesReader, AttributesV10, AttributesWriter, SpecVersion};
use crate::message::{BinarySerializer, MessageAttributeValue};
use chrono::{DateTime, Utc};
use url::Url;
use crate::event::types::*;
use uuid::Uuid;
pub(crate) const ATTRIBUTE_NAMES: [&str; 8] = [
@ -23,7 +22,7 @@ pub struct Attributes {
pub(crate) ty: String,
pub(crate) source: UriReference,
pub(crate) datacontenttype: Option<String>,
pub(crate) schemaurl: Option<Url>,
pub(crate) schemaurl: Option<Uri>,
pub(crate) subject: Option<String>,
pub(crate) time: Option<DateTime<Utc>>,
}
@ -105,7 +104,7 @@ impl AttributesReader for Attributes {
self.datacontenttype.as_deref()
}
fn dataschema(&self) -> Option<&Url> {
fn dataschema(&self) -> Option<&Uri> {
self.schemaurl.as_ref()
}
@ -146,7 +145,7 @@ impl AttributesWriter for Attributes {
std::mem::replace(&mut self.datacontenttype, datacontenttype.map(Into::into))
}
fn set_dataschema(&mut self, dataschema: Option<impl Into<Url>>) -> Option<Url> {
fn set_dataschema(&mut self, dataschema: Option<impl Into<Uri>>) -> Option<Uri> {
std::mem::replace(&mut self.schemaurl, dataschema.map(Into::into))
}
}

View File

@ -1,13 +1,11 @@
use super::Attributes as AttributesV03;
use crate::event::{
Attributes, Data, Event, EventBuilderError, ExtensionValue, TryIntoTime, TryIntoUrl,
UriReference,
Attributes, Data, Event, EventBuilderError, ExtensionValue
};
use crate::message::MessageAttributeValue;
use chrono::{DateTime, Utc};
use crate::event::types::*;
use std::collections::HashMap;
use std::convert::TryInto;
use url::Url;
/// Builder to create a CloudEvent V0.3
#[derive(Clone, Debug)]
@ -16,7 +14,7 @@ pub struct EventBuilder {
ty: Option<String>,
source: Option<UriReference>,
datacontenttype: Option<String>,
schemaurl: Option<Url>,
schemaurl: Option<Uri>,
subject: Option<String>,
time: Option<DateTime<Utc>>,
data: Option<Data>,
@ -89,14 +87,14 @@ impl EventBuilder {
pub fn data_with_schema(
mut self,
datacontenttype: impl Into<String>,
schemaurl: impl TryIntoUrl,
schemaurl: impl TryIntoUri,
data: impl Into<Data>,
) -> Self {
self.datacontenttype = Some(datacontenttype.into());
match schemaurl.into_url() {
match schemaurl.into_uri() {
Ok(u) => self.schemaurl = Some(u),
Err(e) => {
self.error = Some(EventBuilderError::ParseUrlError {
self.error = Some(EventBuilderError::ParseUriError {
attribute_name: "schemaurl",
source: e,
})

View File

@ -1,13 +1,12 @@
use super::Attributes;
use crate::event::data::is_json_content_type;
use crate::event::{Data, ExtensionValue};
use chrono::{DateTime, Utc};
use crate::event::types::*;
use serde::de::IntoDeserializer;
use serde::ser::SerializeMap;
use serde::{Deserialize, Serializer};
use serde_json::{Map, Value};
use std::collections::HashMap;
use url::Url;
pub(crate) struct EventFormatDeserializer {}
@ -21,7 +20,7 @@ impl crate::event::format::EventFormatDeserializer for EventFormatDeserializer {
source: extract_field!(map, "source", String, E)?,
datacontenttype: extract_optional_field!(map, "datacontenttype", String, E)?,
schemaurl: extract_optional_field!(map, "schemaurl", String, E, |s: String| {
Url::parse(&s)
s.into_uri()
})?,
subject: extract_optional_field!(map, "subject", String, E)?,
time: extract_optional_field!(map, "time", String, E, |s: String| {

View File

@ -1,9 +1,8 @@
use crate::event::attributes::{default_hostname, AttributeValue, AttributesConverter};
use crate::event::{AttributesReader, AttributesV03, AttributesWriter, SpecVersion, UriReference};
use crate::message::{BinarySerializer, MessageAttributeValue};
use chrono::{DateTime, Utc};
use crate::event::types::*;
use core::fmt::Debug;
use url::Url;
use uuid::Uuid;
pub(crate) const ATTRIBUTE_NAMES: [&str; 8] = [
@ -24,7 +23,7 @@ pub struct Attributes {
pub(crate) ty: String,
pub(crate) source: UriReference,
pub(crate) datacontenttype: Option<String>,
pub(crate) dataschema: Option<Url>,
pub(crate) dataschema: Option<Uri>,
pub(crate) subject: Option<String>,
pub(crate) time: Option<DateTime<Utc>>,
}
@ -106,7 +105,7 @@ impl AttributesReader for Attributes {
self.datacontenttype.as_deref()
}
fn dataschema(&self) -> Option<&Url> {
fn dataschema(&self) -> Option<&Uri> {
self.dataschema.as_ref()
}
@ -147,7 +146,7 @@ impl AttributesWriter for Attributes {
std::mem::replace(&mut self.datacontenttype, datacontenttype.map(Into::into))
}
fn set_dataschema(&mut self, dataschema: Option<impl Into<Url>>) -> Option<Url> {
fn set_dataschema(&mut self, dataschema: Option<impl Into<Uri>>) -> Option<Uri> {
std::mem::replace(&mut self.dataschema, dataschema.map(Into::into))
}
}

View File

@ -1,13 +1,12 @@
use super::Attributes as AttributesV10;
use crate::event::{
Attributes, Data, Event, EventBuilderError, ExtensionValue, TryIntoTime, TryIntoUrl,
Attributes, Data, Event, EventBuilderError, ExtensionValue, TryIntoTime, TryIntoUri,
UriReference,
};
use crate::message::MessageAttributeValue;
use chrono::{DateTime, Utc};
use crate::event::types::*;
use std::collections::HashMap;
use std::convert::TryInto;
use url::Url;
/// Builder to create a CloudEvent V1.0
#[derive(Clone, Debug)]
@ -16,7 +15,7 @@ pub struct EventBuilder {
ty: Option<String>,
source: Option<UriReference>,
datacontenttype: Option<String>,
dataschema: Option<Url>,
dataschema: Option<Uri>,
subject: Option<String>,
time: Option<DateTime<Utc>>,
data: Option<Data>,
@ -89,14 +88,14 @@ impl EventBuilder {
pub fn data_with_schema(
mut self,
datacontenttype: impl Into<String>,
schemaurl: impl TryIntoUrl,
schemaurl: impl TryIntoUri,
data: impl Into<Data>,
) -> Self {
self.datacontenttype = Some(datacontenttype.into());
match schemaurl.into_url() {
match schemaurl.into_uri() {
Ok(u) => self.dataschema = Some(u),
Err(e) => {
self.error = Some(EventBuilderError::ParseUrlError {
self.error = Some(EventBuilderError::ParseUriError {
attribute_name: "dataschema",
source: e,
})

View File

@ -1,13 +1,12 @@
use super::Attributes;
use crate::event::data::is_json_content_type;
use crate::event::{Data, ExtensionValue};
use chrono::{DateTime, Utc};
use crate::event::types::*;
use serde::de::IntoDeserializer;
use serde::ser::SerializeMap;
use serde::{Deserialize, Serializer};
use serde_json::{Map, Value};
use std::collections::HashMap;
use url::Url;
pub(crate) struct EventFormatDeserializer {}
@ -21,7 +20,7 @@ impl crate::event::format::EventFormatDeserializer for EventFormatDeserializer {
source: extract_field!(map, "source", String, E)?,
datacontenttype: extract_optional_field!(map, "datacontenttype", String, E)?,
dataschema: extract_optional_field!(map, "dataschema", String, E, |s: String| {
Url::parse(&s)
s.into_uri()
})?,
subject: extract_optional_field!(map, "subject", String, E)?,
time: extract_optional_field!(map, "time", String, E, |s: String| {

View File

@ -4,8 +4,7 @@
//! # use std::error::Error;
//! # fn main() -> Result<(), Box<dyn Error>> {
//! use cloudevents::{EventBuilder, AttributesReader, EventBuilderV10};
//! use chrono::{Utc, DateTime};
//! use url::Url;
//! use chrono::Utc;
//!
//! let event = EventBuilderV10::new()
//! .id("my_event.my_application")
@ -54,6 +53,14 @@
//! [Responders]: https://actix.rs/docs/handlers/
#![deny(broken_intra_doc_links)]
#![cfg_attr(not(any(feature = "std", test)), no_std)]
#[cfg(feature = "alloc")]
extern crate alloc;
#[cfg(all(feature = "std", not(feature = "alloc")))]
extern crate std as alloc;
#[cfg(any(feature = "std", test))]
extern crate std as core;
pub mod binding;
pub mod event;

View File

@ -1,4 +1,5 @@
use snafu::Snafu;
use crate::event::types;
/// Represents an error during serialization/deserialization process
#[derive(Debug, Snafu)]
@ -22,7 +23,7 @@ pub enum Error {
ParseTimeError { source: chrono::ParseError },
#[snafu(display("Error while parsing a url: {}", source))]
#[snafu(context(false))]
ParseUrlError { source: url::ParseError },
ParseUrlError { source: types::ParseUriError },
#[snafu(display("Error while decoding base64: {}", source))]
#[snafu(context(false))]
Base64DecodingError { source: base64::DecodeError },

View File

@ -1,8 +1,7 @@
use crate::event::{ExtensionValue, UriReference};
use chrono::{DateTime, Utc};
use crate::event::ExtensionValue;
use std::convert::TryInto;
use std::fmt;
use url::Url;
use crate::event::types::*;
/// Union type representing a [CloudEvent context attribute type](https://github.com/cloudevents/spec/blob/v1.0/spec.md#type-system).
#[derive(PartialEq, Eq, Debug, Clone)]
@ -11,7 +10,7 @@ pub enum MessageAttributeValue {
Integer(i64),
String(String),
Binary(Vec<u8>),
Uri(Url),
Uri(Uri),
UriRef(UriReference),
DateTime(DateTime<Utc>),
}
@ -29,13 +28,13 @@ impl TryInto<DateTime<Utc>> for MessageAttributeValue {
}
}
impl TryInto<Url> for MessageAttributeValue {
impl TryInto<Uri> for MessageAttributeValue {
type Error = super::Error;
fn try_into(self) -> Result<Url, Self::Error> {
fn try_into(self) -> Result<Uri, Self::Error> {
match self {
MessageAttributeValue::Uri(u) => Ok(u),
v => Ok(Url::parse(v.to_string().as_ref())?),
v => Ok(v.to_string().into_uri()?),
}
}
}