ame-bus 1.0.6

Modern microservices framework based on NATS.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

use crate::NatsMessage;
use std::sync::Arc;

#[async_trait::async_trait]
/// # NATS JetStream Meta
///
/// Specify the JetStream using of the struct. Usually used for a consumer or message in JetStream.
///
/// Usually implemented by [jetstream](macro@crate::jetstream) attribute.
pub trait NatsJetStreamMeta: Send + Sync {
    /// A name for the Stream. Must not have spaces, tabs or period . characters
    const STREAM_NAME: &'static str;

    /// Get or create the JetStream stream.
    async fn get_or_create_stream(
        &self,
        js: &async_nats::jetstream::Context,
    ) -> anyhow::Result<async_nats::jetstream::stream::Stream> {
        let stream = js
            .get_or_create_stream(async_nats::jetstream::stream::Config {
                name: Self::STREAM_NAME.to_owned(),
                max_messages: 100_000,
                ..Default::default()
            })
            .await?;
        Ok(stream)
    }
}

#[async_trait::async_trait]
/// # NATS JetStream Consumer Meta
///
/// Configure the JetStream consumer.
///
/// Must implement [NatsJetStreamMeta] trait first.
///
/// Usually implemented by [jetstream_consumer](crate::jetstream_consumer) attribute.
pub trait NatsJetStreamConsumerMeta: Send + Sync + NatsJetStreamMeta {
    /// Consumer configuration type.
    ///
    /// Usually is [jetstream::consumer::pull::Config](async_nats::jetstream::consumer::pull::Config)
    /// or [jetstream::consumer::push::Config](async_nats::jetstream::consumer::push::Config).
    type ConsumerConfig: async_nats::jetstream::consumer::IntoConsumerConfig;

    /// Consumer name.
    ///
    /// If the consumer is durable, it will also be the durable name.
    const CONSUMER_NAME: &'static str;

    /// Get or create the JetStream consumer.
    async fn get_or_create_consumer(
        stream: async_nats::jetstream::stream::Stream,
    ) -> anyhow::Result<async_nats::jetstream::consumer::Consumer<Self::ConsumerConfig>>;
}

#[async_trait::async_trait]
/// # Subscribed JetStream Event
///
/// Implement this trait to subscribe to JetStream events.
///
/// ## Example
///
/// ```rust
/// # #[cfg(feature = "jetstream")]
/// # use ame_bus::jetstream::SubscribeJetStreamEvent;
/// # #[cfg(feature = "jetstream")]
/// # use ame_bus_macros::{jetstream, jetstream_consumer, NatsJsonMessage};
/// # #[cfg(feature = "jetstream")]
/// #[jetstream(name = "user")]
/// #[jetstream_consumer(durable)]
/// struct UserSuccessfulRegisteredConsumer {
///     database_connection: (),    // use `()` for example, should be a real connection
/// }
///
/// # #[cfg(feature = "jetstream")]
/// #[derive(serde::Serialize, serde::Deserialize, NatsJsonMessage)]
/// struct UserSuccessfulRegistered {
///     user_id: String,
///     email: String,
/// }
///
/// # #[cfg(feature = "jetstream")]
/// #[async_trait::async_trait]
/// impl SubscribeJetStreamEvent for UserSuccessfulRegistered {
///     type EventConsumer = UserSuccessfulRegisteredConsumer;
///     async fn emit(consumer: std::sync::Arc<Self::EventConsumer>, event: Self) -> anyhow::Result<()> {
///         // process the event
///         Ok(())
///     }
/// }
/// ```
pub trait SubscribeJetStreamEvent: NatsMessage {
    /// The stateful consumer.
    ///
    /// The consumer should have everything needed to process the event.
    /// Like database connection, `async_nats::jetstream::Context`, etc.
    type EventConsumer: NatsJetStreamConsumerMeta;

    /// Emit the event.
    async fn emit(consumer: Arc<Self::EventConsumer>, event: Self) -> anyhow::Result<()>;
}