Skip to content

Fix notification manager implementation and req traces #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion up-subscription/src/configuration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ use up_rust::{
LocalUriProvider, UUri,
};

/// What uSubscription service uses as the resource ID for LocalUriProvider::get_source_uri()
pub(crate) const SOURCE_URI_RESOURCE_ID: u16 = 0x00FF;

/// Default subscription and notification command channel buffer size
pub(crate) const DEFAULT_COMMAND_BUFFER_SIZE: usize = 1024;

Expand Down Expand Up @@ -128,7 +131,7 @@ impl LocalUriProvider for USubscriptionConfiguration {
&self.authority_name,
USUBSCRIPTION_TYPE_ID,
USUBSCRIPTION_VERSION_MAJOR,
0x0,
SOURCE_URI_RESOURCE_ID,
)
.expect("Error constructing usubscription UUri")
}
Expand Down
7 changes: 6 additions & 1 deletion up-subscription/src/handlers/reset.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ mod tests {
use super::*;
use tokio::sync::mpsc::{self};

use up_rust::UUri;

use crate::{helpers, tests::test_lib};

// [utest->dsn~usubscription-reset-protobuf~1]
Expand Down Expand Up @@ -254,9 +256,12 @@ mod tests {
helpers::init_once();

// create request and other required object(s)
let bad_source =
UUri::try_from("up://LOCAL/1000/1/F").expect("Error during test case setup");

let request_payload = UPayload::try_from_protobuf(ResetRequest::default()).unwrap();
let message_attributes = UAttributes {
source: Some(test_lib::helpers::subscriber_uri1()).into(),
source: Some(bad_source).into(),
..Default::default()
};

Expand Down
4 changes: 3 additions & 1 deletion up-subscription/src/handlers/unregister_for_notifications.rs
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ impl RequestHandler for UnregisterNotificationsRequestHandler {
// Interact with notification manager backend
let se = NotificationEvent::RemoveNotifyee {
subscriber: source.clone(),
topic: topic.clone(),
};

if let Err(e) = self.notification_sender.send(se).await {
Expand Down Expand Up @@ -139,8 +140,9 @@ mod tests {
// validate subscription manager interaction
let notification_event = notification_receiver.recv().await.unwrap();
match notification_event {
NotificationEvent::RemoveNotifyee { subscriber } => {
NotificationEvent::RemoveNotifyee { subscriber, topic } => {
assert_eq!(subscriber, test_lib::helpers::subscriber_uri1());
assert_eq!(topic, test_lib::helpers::local_topic1_uri());
}
_ => panic!("Wrong event type"),
}
Expand Down
58 changes: 32 additions & 26 deletions up-subscription/src/notification_manager.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
********************************************************************************/

use log::*;
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::{mpsc::Receiver, mpsc::Sender, oneshot, Notify};

Expand All @@ -21,7 +20,7 @@ use up_rust::{
usubscription_uri, SubscriberInfo, SubscriptionStatus, Update,
RESOURCE_ID_SUBSCRIPTION_CHANGE,
},
UMessageBuilder, UTransport, UUID,
LocalUriProvider, UMessageBuilder, UTransport, UUID,
};

use crate::{
Expand All @@ -44,6 +43,7 @@ pub(crate) enum NotificationEvent {
},
RemoveNotifyee {
subscriber: SubscriberUUri,
topic: TopicUUri,
},
StateChange {
subscriber: Option<SubscriberUUri>,
Expand All @@ -55,12 +55,12 @@ pub(crate) enum NotificationEvent {
respond_to: oneshot::Sender<Result<(), PersistencyError>>,
},
GetNotificationTopics {
respond_to: oneshot::Sender<HashMap<SubscriberUUri, TopicUUri>>,
respond_to: oneshot::Sender<Vec<(SubscriberUUri, TopicUUri)>>,
},
// Purely for use during testing: force-set new notifyees ledger
#[cfg(test)]
SetNotificationTopics {
notification_topics_replacement: HashMap<SubscriberUUri, TopicUUri>,
notification_topics_replacement: Vec<(SubscriberUUri, TopicUUri)>,
respond_to: oneshot::Sender<()>,
},
}
Expand Down Expand Up @@ -93,9 +93,15 @@ impl PartialEq for NotificationEvent {
},
) => s1 == s2 && t1 == t2,
(
NotificationEvent::RemoveNotifyee { subscriber: s1 },
NotificationEvent::RemoveNotifyee { subscriber: s2 },
) => s1 == s2,
NotificationEvent::RemoveNotifyee {
subscriber: s1,
topic: t1,
},
NotificationEvent::RemoveNotifyee {
subscriber: s2,
topic: t2,
},
) => s1 == s2 && t1 == t2,
// Don't care about the test-only variants
_ => false,
}
Expand Down Expand Up @@ -129,6 +135,7 @@ pub(crate) async fn notification_engine(
},
};
match event {
// [impl->req~usubscription-register-notifications~1]
NotificationEvent::AddNotifyee { subscriber, topic } => {
if !topic.is_event() {
error!("Topic UUri is not a valid event target");
Expand All @@ -142,8 +149,9 @@ pub(crate) async fn notification_engine(
}
};
}
NotificationEvent::RemoveNotifyee { subscriber } => {
match notifications.remove_notifyee(&subscriber) {
// [impl->req~usubscription-unregister-notifications~1]
NotificationEvent::RemoveNotifyee { subscriber, topic } => {
match notifications.remove_notifyee(&subscriber, &topic) {
Ok(_) => {}
Err(e) => {
error!("Persistency failure {e}")
Expand All @@ -158,7 +166,7 @@ pub(crate) async fn notification_engine(
} => {
// [impl->dsn~usubscription-change-notification-type~1]
let update = Update {
topic: Some(topic).into(),
topic: Some(topic.clone()).into(),
subscriber: Some(SubscriberInfo {
uri: subscriber.into(),
..Default::default()
Expand Down Expand Up @@ -188,29 +196,27 @@ pub(crate) async fn notification_engine(
}
}

// Send Update message to any dedicated registered notification-subscribers
// Send Update notification message to any dedicated registered notification-subscribers
// [impl->req~usubscription-register-notifications~1]
if let Ok(topics) = notifications.get_topics() {
for topic_entry in topics {
if let Ok(subscribers) = notifications.get_subscribers_registered_for_topic(&topic)
{
for subscribers_entry in subscribers {
debug!(
"Sending notification to ({}): topic {}, subscriber {}, status {}",
topic_entry.to_uri(INCLUDE_SCHEMA),
"Sending notification to ({}), about topic {} changing state to {}",
subscribers_entry.to_uri(INCLUDE_SCHEMA),
update
.topic
.as_ref()
.unwrap_or_default()
.to_uri(INCLUDE_SCHEMA),
update
.subscriber
.uri
.as_ref()
.unwrap_or_default()
.to_uri(INCLUDE_SCHEMA),
update.status.as_ref().unwrap_or_default()
);

match UMessageBuilder::publish(topic_entry.clone())
.build_with_protobuf_payload(&update)
match UMessageBuilder::notification(
configuration.get_source_uri(),
subscribers_entry.clone(),
)
.build_with_protobuf_payload(&update)
{
Ok(update_msg) => {
let _r = up_transport.send(update_msg).await.inspect_err(|e|
Expand Down Expand Up @@ -254,7 +260,7 @@ pub(crate) async fn notification_engine(

// Convenience wrapper for sending state change notification messages
// `susbcriber` is an Option, because in the case ob remote subscription state changes, there is no subscriber (other than local usubscription service)
pub(crate) async fn notify(
pub(crate) async fn notify_state_change(
notification_sender: Sender<NotificationEvent>,
subscriber: Option<SubscriberUUri>,
topic: TopicUUri,
Expand Down Expand Up @@ -282,9 +288,9 @@ pub(crate) async fn notify(
// Might return an empty list if data retrieval fails for some reason, but will perform the reset in any case.
pub(crate) async fn reset(
notification_sender: Sender<NotificationEvent>,
) -> Result<HashMap<SubscriberUUri, TopicUUri>, Box<dyn std::error::Error>> {
) -> Result<Vec<(SubscriberUUri, TopicUUri)>, Box<dyn std::error::Error>> {
// Get current notification registrations
let (respond_to, receive_from) = oneshot::channel::<HashMap<SubscriberUUri, TopicUUri>>();
let (respond_to, receive_from) = oneshot::channel::<Vec<(SubscriberUUri, TopicUUri)>>();
notification_sender
.send(NotificationEvent::GetNotificationTopics { respond_to })
.await?;
Expand Down
Loading