fix: flexistats: Ignore IMDNs

(and other non-urgent priority messages)

(cherry picked from commit 60eb98e)

Author: ThibaultLemaire

src/eventlogs/writers/flexi-stats-event-log-writer.cc

@@ -20,6 +20,7 @@
 #include "flexiapi/schemas/call/terminated.hh"
 #include "flexiapi/schemas/message/message.hh"
 #include "flexisip/logmanager.hh"
+#include "flexisip/sofia-wrapper/msg-sip.hh"
 #include "fork-context/fork-status.hh"
 #include "fork-context/message-kind.hh"
 #include "utils/string-utils.hh"
@@ -91,6 +92,7 @@ void FlexiStatsEventLogWriter::write(const CallEndedEventLog& call) {
 
 void FlexiStatsEventLogWriter::write(const MessageSentEventLog& msg) {
 	const auto& kind = msg.getMessageKind();
+	if (kind.getPriority() == sofiasip::MsgSipPriority::NonUrgent) return; // Ignore IMDNs
 	if (kind.getKind() != MessageKind::Kind::Message) return;
 
 	flexiapi::ToParam recipients{};
@@ -116,7 +118,7 @@ void FlexiStatsEventLogWriter::write(const MessageSentEventLog& msg) {
 
 void FlexiStatsEventLogWriter::write(const MessageResponseFromRecipientEventLog& msg) {
 	const auto& kind = msg.getMessageKind();
-	if (kind.getKind() == MessageKind::Kind::IMDN) return;
+	if (kind.getPriority() == sofiasip::MsgSipPriority::NonUrgent) return; // Ignore IMDNs
 	if (kind.getCardinality() == MessageKind::Cardinality::ToConferenceServer) {
 		// Group chat message. We want the delivery statuses of the participant devices,
 		// not that of the conference server itself

src/fork-context/fork-message-context.cc

@@ -105,7 +105,7 @@ ForkMessageContext::ForkMessageContext(const std::shared_ptr<ModuleRouter>& rout
                       router->mStats.mCountMessageForks,
                       msgPriority,
                       isRestored),
-      mKind(*event->getMsgSip()->getSip()) {
+      mKind(*event->getMsgSip()->getSip(), msgPriority) {
 	LOGD("New ForkMessageContext %p", this);
 	if (!isRestored) {
 		// Start the acceptance timer immediately.

src/fork-context/message-kind.cc

@@ -11,9 +11,9 @@ using namespace std::string_view_literals;
 
 namespace flexisip {
 
-MessageKind::MessageKind(const ::sip_t& event) : mKind(Kind::Message), mCardinality(Cardinality::Direct) {
+MessageKind::MessageKind(const ::sip_t& event, sofiasip::MsgSipPriority priority)
+    : mKind(Kind::Message), mCardinality(Cardinality::Direct), mPriority(priority) {
 	if (event.sip_request->rq_method == sip_method_refer) mKind = Kind::Refer;
-	else if (event.sip_content_type->c_type == "message/imdn+xml"sv) mKind = Kind::IMDN;
 
 	constexpr auto tryExtractConferenceIdFrom = [](const auto& recipient) {
 		return StringUtils::removePrefix(recipient.a_url->url_user, conference::CHATROOM_PREFIX);

src/fork-context/message-kind.hh

@@ -10,13 +10,14 @@
 
 #include "sofia-sip/sip.h"
 
+#include "flexisip/sofia-wrapper/msg-sip.hh"
+
 namespace flexisip {
 
 class MessageKind {
 public:
 	enum class Kind : std::uint8_t {
 		Refer,
-		IMDN,
 		Message,
 	};
 
@@ -27,21 +28,25 @@ public:
 		FromConferenceServer,
 	};
 
-	MessageKind(const ::sip_t&);
+	MessageKind(const ::sip_t&, sofiasip::MsgSipPriority);
 
 	Kind getKind() const {
 		return mKind;
 	}
 	Cardinality getCardinality() const {
 		return mCardinality;
 	}
+	sofiasip::MsgSipPriority getPriority() const {
+		return mPriority;
+	}
 	const std::optional<std::string_view>& getConferenceId() const {
 		return mConferenceId;
 	}
 
 private:
 	Kind mKind;
 	Cardinality mCardinality;
+	sofiasip::MsgSipPriority mPriority;
 	std::optional<std::string_view> mConferenceId;
 };
 

tester/tests/eventlogs/writers/flexi-stats-event-log-writer-tester.cc

@@ -169,11 +169,13 @@ void messageSentAndReceived() {
 	BC_HARD_ASSERT_TRUE(port > -1);
 	agent->setEventLogWriter(std::make_unique<FlexiStatsEventLogWriter>(*agent->getRoot(), "localhost", to_string(port),
 	                                                                    "/api/stats/", "aRandomApiToken"));
-	const auto builder = proxy->clientBuilder();
+	auto builder = proxy->clientBuilder();
 	const string expectedFrom = "[email protected]";
 	const string expectedTo = "[email protected]";
 	const auto tony = builder.build(expectedFrom);
-	const auto mike = builder.build(expectedTo);
+	// Send IMDNs as CPIM so as to camouflage the content type.
+	// The stats writer will have to rely on the priority to determine whether to log the message or not
+	const auto mike = builder.setCpimInBasicChatroom(OnOff::On).build(expectedTo);
 	const auto directChat = tony.chatroomBuilder().build({mike.getMe()});
 	const auto& forkMessageContextsStats =
 	    dynamic_cast<ModuleRouter&>(*agent->findModule("Router")).mStats.mCountMessageForks;

tester/utils/client-builder.cc

@@ -161,6 +161,10 @@ ClientBuilder& ClientBuilder::setIce(OnOff value) {
 	mIce = value;
 	return *this;
 }
+ClientBuilder& ClientBuilder::setCpimInBasicChatroom(OnOff value) {
+	mAccountParams->enableCpimInBasicChatRoom(bool(value));
+	return *this;
+}
 
 ClientBuilder& ClientBuilder::setCustomContact(const std::string& contact) {
 	mAccountParams->setCustomContact(mFactory->createAddress(contact));

tester/utils/client-builder.hh

@@ -45,6 +45,7 @@ public:
 	ClientBuilder& setVideoReceive(OnOff);
 	ClientBuilder& setRtcpSend(OnOff);
 	ClientBuilder& setIce(OnOff);
+	ClientBuilder& setCpimInBasicChatroom(OnOff);
 	ClientBuilder& setConferenceFactoryUri(const std::string&);
 	ClientBuilder& setCustomContact(const std::string& contact);
 	ClientBuilder& setPushParams(const pushnotification::RFC8599PushParams& params);