Skip to content

Commit

Permalink
Merge pull request #5099 from systeminit/nick/f68aecc
Browse files Browse the repository at this point in the history 
Split core si-id macro into multiple macros
  • Loading branch information
@nickgerace
nickgerace authored Dec 10, 2024
2 parents 5047f92 + a98e85d commit 730ca7d
Show file tree
Hide file tree
Showing 4 changed files with 385 additions and 217 deletions.
25 changes: 25 additions & 0 deletions lib/si-id/src/conversions.rs
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
use crate::{AttributeValueId, PropId, PropertyEditorPropId, PropertyEditorValueId};

impl From<PropId> for PropertyEditorPropId {
fn from(prop_id: PropId) -> Self {
Self::from(::ulid::Ulid::from(prop_id))
}
}

impl From<PropertyEditorPropId> for PropId {
fn from(property_editor_prop_id: PropertyEditorPropId) -> Self {
Self::from(::ulid::Ulid::from(property_editor_prop_id))
}
}

impl From<AttributeValueId> for PropertyEditorValueId {
fn from(id: AttributeValueId) -> Self {
Self::from(::ulid::Ulid::from(id))
}
}

impl From<PropertyEditorValueId> for AttributeValueId {
fn from(id: PropertyEditorValueId) -> Self {
Self::from(::ulid::Ulid::from(id))
}
}
267 changes: 50 additions & 217 deletions lib/si-id/src/lib.rs
View file
Original file line number Diff line number Diff line change
@@ -1,242 +1,75 @@
//! Provides a centralized location for constructing identifiers for SI.
#![warn(
bad_style,
clippy::missing_panics_doc,
clippy::panic,
clippy::panic_in_result_fn,
clippy::unwrap_in_result,
clippy::unwrap_used,
dead_code,
improper_ctypes,
missing_debug_implementations,
missing_docs,
no_mangle_generic_items,
non_shorthand_field_patterns,
overflowing_literals,
path_statements,
patterns_in_fns_without_body,
unconditional_recursion,
unreachable_pub,
unused,
unused_allocation,
unused_comparisons,
unused_parens,
while_true
)]

#[macro_use]
pub(crate) mod macros;
pub(crate) mod conversions;
pub mod ulid;

macro_rules! id {
(
$(#[$($attrss:tt)*])*
$name:ident
) => {
$(#[$($attrss)*])*
#[allow(missing_docs)]
#[derive(
Eq,
PartialEq,
PartialOrd,
Ord,
Copy,
Clone,
Hash,
derive_more::From,
derive_more::Into,
derive_more::Display,
serde::Serialize,
serde::Deserialize,
)]
pub struct $name(::ulid::Ulid);

impl std::fmt::Debug for $name {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_tuple(stringify!($name)).field(&self.0.to_string()).finish()
}
}

// TODO(nick): destroy this with fire.
impl Default for $name {
fn default() -> Self {
Self::NONE
}
}

impl $name {
// TODO(nick): destroy this with fire.
pub const NONE: Self = Self(::ulid::Ulid::nil());

/// Length of a string-encoded ID in bytes.
pub const ID_LEN: usize = ::ulid::ULID_LEN;

/// Generates a new key which is virtually guaranteed to be unique.
pub fn generate() -> Self {
Self(::ulid::Ulid::new())
}

/// Calls [`Self::generate`].
pub fn new() -> Self {
Self::generate()
}

/// Converts type into inner [`Ulid`](::ulid::Ulid).
pub fn into_inner(self) -> ::ulid::Ulid {
self.0
}

/// Creates a Crockford Base32 encoded string that represents this Ulid.
pub fn array_to_str<'buf>(&self, buf: &'buf mut [u8; ::ulid::ULID_LEN]) -> &'buf mut str {
self.0.array_to_str(buf)
}

pub fn array_to_str_buf() -> [u8; ::ulid::ULID_LEN] {
[0; ::ulid::ULID_LEN]
}

/// Constructs a new instance of Self from the given raw identifier.
///
/// This function is typically used to consume ownership of the specified identifier.
pub fn from_raw_id(value: ::ulid::Ulid) -> Self {
Self(value)
}

/// Extracts the raw identifier.
///
/// This function is typically used to borrow an owned idenfier.
pub fn as_raw_id(&self) -> ::ulid::Ulid {
self.0
}

/// Consumes this object, returning the raw underlying identifier.
///
/// This function is typically used to transfer ownership of the underlying identifier
/// to the caller.
pub fn into_raw_id(self) -> ::ulid::Ulid {
self.0
}
}

impl From<$name> for String {
fn from(id: $name) -> Self {
::ulid::Ulid::from(id.0).into()
}
}

impl<'a> From<&'a $name> for ::ulid::Ulid {
fn from(id: &'a $name) -> Self {
id.0
}
}

impl From<$name> for crate::ulid::Ulid {
fn from(id: $name) -> Self {
id.0.into()
}
}

impl<'a> From<&'a $name> for crate::ulid::Ulid {
fn from(id: &'a $name) -> Self {
id.0.into()
}
}

impl From<crate::ulid::Ulid> for $name {
fn from(ulid: crate::ulid::Ulid) -> Self {
ulid.inner().into()
}
}

impl<'a> From<&'a $name> for $name {
fn from(id: &'a $name) -> Self {
*id
}
}

impl std::str::FromStr for $name {
type Err = ::ulid::DecodeError;

fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(Self(::ulid::Ulid::from_string(s)?))
}
}

impl<'a> postgres_types::FromSql<'a> for $name {
fn from_sql(
ty: &postgres_types::Type,
raw: &'a [u8],
) -> Result<Self, Box<dyn std::error::Error + Sync + Send>> {
let id: String = postgres_types::FromSql::from_sql(ty, raw)?;
Ok(Self(::ulid::Ulid::from_string(&id)?))
}

fn accepts(ty: &postgres_types::Type) -> bool {
ty == &postgres_types::Type::BPCHAR
|| ty.kind() == &postgres_types::Kind::Domain(postgres_types::Type::BPCHAR)
}
}

impl postgres_types::ToSql for $name {
fn to_sql(
&self,
ty: &postgres_types::Type,
out: &mut postgres_types::private::BytesMut,
) -> Result<postgres_types::IsNull, Box<dyn std::error::Error + Sync + Send>>
where
Self: Sized,
{
postgres_types::ToSql::to_sql(&self.0.to_string(), ty, out)
}

fn accepts(ty: &postgres_types::Type) -> bool
where
Self: Sized,
{
ty == &postgres_types::Type::BPCHAR
|| ty.kind() == &postgres_types::Kind::Domain(postgres_types::Type::BPCHAR)
}

fn to_sql_checked(
&self,
ty: &postgres_types::Type,
out: &mut postgres_types::private::BytesMut,
) -> Result<postgres_types::IsNull, Box<dyn std::error::Error + Sync + Send>> {
postgres_types::ToSql::to_sql(&self.0.to_string(), ty, out)
}
}
};
}

impl From<PropId> for PropertyEditorPropId {
fn from(prop_id: PropId) -> Self {
Self::from(::ulid::Ulid::from(prop_id))
}
}

impl From<PropertyEditorPropId> for PropId {
fn from(property_editor_prop_id: PropertyEditorPropId) -> Self {
Self::from(::ulid::Ulid::from(property_editor_prop_id))
}
}

impl From<AttributeValueId> for PropertyEditorValueId {
fn from(id: AttributeValueId) -> Self {
Self::from(::ulid::Ulid::from(id))
}
}

impl From<PropertyEditorValueId> for AttributeValueId {
fn from(id: PropertyEditorValueId) -> Self {
Self::from(::ulid::Ulid::from(id))
}
}

id!(ActionId);
// Please keep these alphabetically sorted!
id!(ActionPrototypeId);
id!(AttributePrototypeArgumentId);
id!(AttributePrototypeId);
id!(AttributeValueId);
id!(AuthenticationPrototypeId);
id!(CachedModuleId);
id!(ChangeSetId);
id!(ComponentId);
id!(DeprecatedVectorClockId);
id!(EventSessionId);
id!(FuncArgumentId);
id!(FuncExecutionPk);
id!(FuncId);
id!(FuncRunId);
id!(GeometryId);
id!(HistoryEventPk);
id!(InputSocketId);
id!(KeyPairPk);
id!(ManagementPrototypeId);
id!(ModuleId);
id!(NaxumApiTypesRequestId);
id!(OutputSocketId);
id!(PropId);
id!(PropertyEditorPropId);
id!(PropertyEditorValueId);
id!(SchemaId);
id!(SchemaVariantId);
id!(SecretId);
id!(StaticArgumentValueId);
id!(UserPk);
id!(ValidationOutputId);
id!(ViewId);
id!(WorkspaceId);
id!(WorkspacePk);
id!(WorkspaceSnapshotNodeId);

// Please keep these alphabetically sorted!
id_with_pg_types!(ActionId);
id_with_pg_types!(CachedModuleId);
id_with_pg_types!(ChangeSetId);
id_with_pg_types!(ComponentId);
id_with_pg_types!(FuncId);
id_with_pg_types!(FuncRunId);
id_with_pg_types!(SchemaId);
id_with_pg_types!(UserPk);

// Please keep these alphabetically sorted!
id_with_none!(SchemaVariantId);

// Please keep these alphabetically sorted!
id_with_none_and_pg_types!(AttributeValueId);
id_with_none_and_pg_types!(KeyPairPk);
id_with_none_and_pg_types!(WorkspacePk);
id_with_none_and_pg_types!(WorkspaceId);
Loading

0 comments on commit 730ca7d

Please sign in to comment.